Documentation

Overview

    Package migrationhubconfig provides the API client, operations, and parameter types for AWS Migration Hub Config.

    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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2019-06-30"
    View Source
    const ServiceID = "MigrationHub Config"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Migration Hub Config.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CreateHomeRegionControl

                func (c *Client) CreateHomeRegionControl(ctx context.Context, params *CreateHomeRegionControlInput, optFns ...func(*Options)) (*CreateHomeRegionControlOutput, error)

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

                  func (*Client) DescribeHomeRegionControls

                  func (c *Client) DescribeHomeRegionControls(ctx context.Context, params *DescribeHomeRegionControlsInput, optFns ...func(*Options)) (*DescribeHomeRegionControlsOutput, error)

                    This API permits filtering on the ControlId and HomeRegion fields.

                    func (*Client) GetHomeRegion

                    func (c *Client) GetHomeRegion(ctx context.Context, params *GetHomeRegionInput, optFns ...func(*Options)) (*GetHomeRegionOutput, error)

                      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.

                      type CreateHomeRegionControlInput

                      type CreateHomeRegionControlInput struct {
                      
                      	// The name of the home region of the calling account.
                      	//
                      	// This member is required.
                      	HomeRegion *string
                      
                      	// The account for which this command sets up a home region control. The Target is
                      	// always of type ACCOUNT.
                      	//
                      	// This member is required.
                      	Target *types.Target
                      
                      	// Optional Boolean flag to indicate whether any effect should take place. It tests
                      	// whether the caller has permission to make the call.
                      	DryRun bool
                      }

                      type CreateHomeRegionControlOutput

                      type CreateHomeRegionControlOutput struct {
                      
                      	// This object is the HomeRegionControl object that's returned by a successful call
                      	// to CreateHomeRegionControl.
                      	HomeRegionControl *types.HomeRegionControl
                      
                      	// Metadata pertaining to the operation's result.
                      	ResultMetadata middleware.Metadata
                      }

                      type DescribeHomeRegionControlsAPIClient

                      type DescribeHomeRegionControlsAPIClient interface {
                      	DescribeHomeRegionControls(context.Context, *DescribeHomeRegionControlsInput, ...func(*Options)) (*DescribeHomeRegionControlsOutput, error)
                      }

                        DescribeHomeRegionControlsAPIClient is a client that implements the DescribeHomeRegionControls operation.

                        type DescribeHomeRegionControlsInput

                        type DescribeHomeRegionControlsInput struct {
                        
                        	// The ControlID is a unique identifier string of your HomeRegionControl object.
                        	ControlId *string
                        
                        	// The name of the home region you'd like to view.
                        	HomeRegion *string
                        
                        	// The maximum number of filtering results to display per page.
                        	MaxResults *int32
                        
                        	// If a NextToken was returned by a previous call, more results are available. To
                        	// retrieve the next page of results, make the call again using the returned token
                        	// in NextToken.
                        	NextToken *string
                        
                        	// The target parameter specifies the identifier to which the home region is
                        	// applied, which is always of type ACCOUNT. It applies the home region to the
                        	// current ACCOUNT.
                        	Target *types.Target
                        }

                        type DescribeHomeRegionControlsOutput

                        type DescribeHomeRegionControlsOutput struct {
                        
                        	// An array that contains your HomeRegionControl objects.
                        	HomeRegionControls []types.HomeRegionControl
                        
                        	// If a NextToken was returned by a previous call, more results are available. To
                        	// retrieve the next page of results, make the call again using the returned token
                        	// in NextToken.
                        	NextToken *string
                        
                        	// Metadata pertaining to the operation's result.
                        	ResultMetadata middleware.Metadata
                        }

                        type DescribeHomeRegionControlsPaginator

                        type DescribeHomeRegionControlsPaginator struct {
                        	// contains filtered or unexported fields
                        }

                          DescribeHomeRegionControlsPaginator is a paginator for DescribeHomeRegionControls

                          func NewDescribeHomeRegionControlsPaginator

                            NewDescribeHomeRegionControlsPaginator returns a new DescribeHomeRegionControlsPaginator

                            func (*DescribeHomeRegionControlsPaginator) HasMorePages

                            func (p *DescribeHomeRegionControlsPaginator) HasMorePages() bool

                              HasMorePages returns a boolean indicating whether more pages are available

                              func (*DescribeHomeRegionControlsPaginator) NextPage

                                NextPage retrieves the next DescribeHomeRegionControls page.

                                type DescribeHomeRegionControlsPaginatorOptions

                                type DescribeHomeRegionControlsPaginatorOptions struct {
                                	// The maximum number of filtering results to display per page.
                                	Limit int32
                                
                                	// Set to true if pagination should stop if the service returns a pagination token
                                	// that matches the most recent token provided to the service.
                                	StopOnDuplicateToken bool
                                }

                                  DescribeHomeRegionControlsPaginatorOptions is the paginator options for DescribeHomeRegionControls

                                  type EndpointResolver

                                  type EndpointResolver interface {
                                  	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                  }

                                    EndpointResolver interface for resolving service endpoints.

                                    func EndpointResolverFromURL

                                    func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                      EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                      type EndpointResolverFunc

                                      type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                        EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                        func (EndpointResolverFunc) ResolveEndpoint

                                        func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                        type EndpointResolverOptions

                                        type EndpointResolverOptions = internalendpoints.Options

                                          EndpointResolverOptions is the service endpoint resolver options

                                          type GetHomeRegionInput

                                          type GetHomeRegionInput struct {
                                          }

                                          type GetHomeRegionOutput

                                          type GetHomeRegionOutput struct {
                                          
                                          	// The name of the home region of the calling account.
                                          	HomeRegion *string
                                          
                                          	// Metadata pertaining to the operation's result.
                                          	ResultMetadata middleware.Metadata
                                          }

                                          type HTTPClient

                                          type HTTPClient interface {
                                          	Do(*http.Request) (*http.Response, error)
                                          }

                                          type HTTPSignerV4

                                          type HTTPSignerV4 interface {
                                          	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                          }

                                          type Options

                                          type Options struct {
                                          	// Set of options to modify how an operation is invoked. These apply to all
                                          	// operations invoked for this client. Use functional options on operation call to
                                          	// modify this list for per operation behavior.
                                          	APIOptions []func(*middleware.Stack) error
                                          
                                          	// Configures the events that will be sent to the configured logger.
                                          	ClientLogMode aws.ClientLogMode
                                          
                                          	// The credentials object to use when signing requests.
                                          	Credentials aws.CredentialsProvider
                                          
                                          	// The endpoint options to be used when attempting to resolve an endpoint.
                                          	EndpointOptions EndpointResolverOptions
                                          
                                          	// The service endpoint resolver.
                                          	EndpointResolver EndpointResolver
                                          
                                          	// Signature Version 4 (SigV4) Signer
                                          	HTTPSignerV4 HTTPSignerV4
                                          
                                          	// The logger writer interface to write logging messages to.
                                          	Logger logging.Logger
                                          
                                          	// The region to send requests to. (Required)
                                          	Region string
                                          
                                          	// Retryer guides how HTTP requests should be retried in case of recoverable
                                          	// failures. When nil the API client will use a default retryer.
                                          	Retryer aws.Retryer
                                          
                                          	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                          	// implementation if nil.
                                          	HTTPClient HTTPClient
                                          }

                                          func (Options) Copy

                                          func (o Options) Copy() Options

                                            Copy creates a clone where the APIOptions list is deep copied.

                                            type ResolveEndpoint

                                            type ResolveEndpoint struct {
                                            	Resolver EndpointResolver
                                            	Options  EndpointResolverOptions
                                            }

                                            func (*ResolveEndpoint) HandleSerialize

                                            func (*ResolveEndpoint) ID

                                            func (*ResolveEndpoint) ID() string

                                            Directories

                                            Path Synopsis
                                            internal