MigrationHubConfig

public struct MigrationHubConfig

Client object for interacting with AWS MigrationHubConfig service.

The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region. You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a HomeRegionNotSetException error is returned. API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region. If you call a write API outside the home region, an InvalidInputException is returned. You can call GetHomeRegion action to obtain the account’s Migration Hub home region. For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.

Member variables

client
Undocumented
Declaration
Swift

public let client: AWSClient

Initialization


                    
                    
                    init(accessKeyId:secretAccessKey:sessionToken:region:endpoint:middlewares:eventLoopGroupProvider:)

Initialize the MigrationHubConfig client

Declaration

Swift

public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

Parameters

`accessKeyId`	Public access key provided by AWS
`secretAccessKey`	Private access key provided by AWS
`sessionToken`	Token provided by STS.AssumeRole() which allows access to another AWS account
`region`	Region of server you want to communicate with
`endpoint`	Custom endpoint URL to use instead of standard AWS servers
`middlewares`	Array of middlewares to apply to requests and responses
`eventLoopGroupProvider`	EventLoopGroup to use. Use `useAWSClientShared` if the client shall manage its own EventLoopGroup.

API Calls


                    
                    
                    createHomeRegionControl(_:)

This API sets up the home region for the calling account only.

Declaration

Swift

public func createHomeRegionControl(_ input: CreateHomeRegionControlRequest) -> EventLoopFuture<CreateHomeRegionControlResult>


                    
                    
                    describeHomeRegionControls(_:)

This API permits filtering on the ControlId and HomeRegion fields.

Declaration

Swift

public func describeHomeRegionControls(_ input: DescribeHomeRegionControlsRequest) -> EventLoopFuture<DescribeHomeRegionControlsResult>

getHomeRegion(_:)
Returns the calling account’s home region, if configured. This API is used by other AWS services to determine the regional endpoint for calling AWS Application Discovery Service and Migration Hub. You must call GetHomeRegion at least once before you call any other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account’s Migration Hub home region.
Declaration
Swift

public func getHomeRegion(_ input: GetHomeRegionRequest) -> EventLoopFuture<GetHomeRegionResult>

Paginators


                    
                    
                    describeHomeRegionControlsPaginator(_:onPage:)

This API permits filtering on the ControlId and HomeRegion fields.

Declaration

Swift

public func describeHomeRegionControlsPaginator(_ input: DescribeHomeRegionControlsRequest, onPage: @escaping (DescribeHomeRegionControlsResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes


                    
                    
                    DescribeHomeRegionControlsRequest

Undocumented

Declaration

Swift

public struct DescribeHomeRegionControlsRequest : AWSShape

extension MigrationHubConfig.DescribeHomeRegionControlsRequest: AWSPaginateStringToken

CreateHomeRegionControlRequest
Undocumented
See more
Declaration
Swift

public struct CreateHomeRegionControlRequest : AWSShape
CreateHomeRegionControlResult
Undocumented
See more
Declaration
Swift

public struct CreateHomeRegionControlResult : AWSShape
DescribeHomeRegionControlsResult
Undocumented
See more
Declaration
Swift

public struct DescribeHomeRegionControlsResult : AWSShape
GetHomeRegionRequest
Undocumented
See more
Declaration
Swift

public struct GetHomeRegionRequest : AWSShape
GetHomeRegionResult
Undocumented
See more
Declaration
Swift

public struct GetHomeRegionResult : AWSShape
HomeRegionControl
Undocumented
See more
Declaration
Swift

public struct HomeRegionControl : AWSShape
Target
Undocumented
See more
Declaration
Swift

public struct Target : AWSShape

Enums


                    
                    
                    TargetType

Undocumented

Declaration

Swift

public enum TargetType : String, CustomStringConvertible, Codable