Documentation

Overview

Package migrationhubconfig provides the client and types for making API requests to 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.

See https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config-2019-06-30 for more information on this service.

See migrationhubconfig package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/migrationhubconfig/

Using the Client

To contact AWS Migration Hub Config with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Migration Hub Config client MigrationHubConfig for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/migrationhubconfig/#New

Index

Constants

View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeDryRunOperation for service response error code
	// "DryRunOperation".
	//
	// Exception raised to indicate that authorization of an action was successful,
	// when the DryRun flag is set to true.
	ErrCodeDryRunOperation = "DryRunOperation"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// Exception raised when an internal, configuration, or dependency error is
	// encountered.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidInputException for service response error code
	// "InvalidInputException".
	//
	// Exception raised when the provided input violates a policy constraint or
	// is entered in the wrong format or data type.
	ErrCodeInvalidInputException = "InvalidInputException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// Exception raised when a request fails due to temporary unavailability of
	// the service.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"
)
View Source
const (
	ServiceName = "MigrationHub Config" // Name of service.
	EndpointsID = "migrationhub-config" // ID to lookup a service endpoint with.
	ServiceID   = "MigrationHub Config" // ServiceID is a unique identifier of a specific service.
)

    Service information constants

    View Source
    const (
    	// TargetTypeAccount is a TargetType enum value
    	TargetTypeAccount = "ACCOUNT"
    )

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type AccessDeniedException

    type AccessDeniedException struct {
    	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
    
    	Message_ *string `locationName:"Message" type:"string"`
    	// contains filtered or unexported fields
    }

      You do not have sufficient access to perform this action.

      func (*AccessDeniedException) Code

      func (s *AccessDeniedException) Code() string

        Code returns the exception type name.

        func (*AccessDeniedException) Error

        func (s *AccessDeniedException) Error() string

        func (AccessDeniedException) GoString

        func (s AccessDeniedException) GoString() string

          GoString returns the string representation

          func (*AccessDeniedException) Message

          func (s *AccessDeniedException) Message() string

            Message returns the exception's message.

            func (*AccessDeniedException) OrigErr

            func (s *AccessDeniedException) OrigErr() error

              OrigErr always returns nil, satisfies awserr.Error interface.

              func (*AccessDeniedException) RequestID

              func (s *AccessDeniedException) RequestID() string

                RequestID returns the service's response RequestID for request.

                func (*AccessDeniedException) StatusCode

                func (s *AccessDeniedException) StatusCode() int

                  Status code returns the HTTP status code for the request's response error.

                  func (AccessDeniedException) String

                  func (s AccessDeniedException) String() string

                    String returns the string representation

                    type CreateHomeRegionControlInput

                    type CreateHomeRegionControlInput struct {
                    
                    	// 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:"boolean"`
                    
                    	// The name of the home region of the calling account.
                    	//
                    	// HomeRegion is a required field
                    	HomeRegion *string `min:"1" type:"string" required:"true"`
                    
                    	// The account for which this command sets up a home region control. The Target
                    	// is always of type ACCOUNT.
                    	//
                    	// Target is a required field
                    	Target *Target `type:"structure" required:"true"`
                    	// contains filtered or unexported fields
                    }

                    func (CreateHomeRegionControlInput) GoString

                    func (s CreateHomeRegionControlInput) GoString() string

                      GoString returns the string representation

                      func (*CreateHomeRegionControlInput) SetDryRun

                        SetDryRun sets the DryRun field's value.

                        func (*CreateHomeRegionControlInput) SetHomeRegion

                          SetHomeRegion sets the HomeRegion field's value.

                          func (*CreateHomeRegionControlInput) SetTarget

                            SetTarget sets the Target field's value.

                            func (CreateHomeRegionControlInput) String

                              String returns the string representation

                              func (*CreateHomeRegionControlInput) Validate

                              func (s *CreateHomeRegionControlInput) Validate() error

                                Validate inspects the fields of the type to determine if they are valid.

                                type CreateHomeRegionControlOutput

                                type CreateHomeRegionControlOutput struct {
                                
                                	// This object is the HomeRegionControl object that's returned by a successful
                                	// call to CreateHomeRegionControl.
                                	HomeRegionControl *HomeRegionControl `type:"structure"`
                                	// contains filtered or unexported fields
                                }

                                func (CreateHomeRegionControlOutput) GoString

                                  GoString returns the string representation

                                  func (*CreateHomeRegionControlOutput) SetHomeRegionControl

                                    SetHomeRegionControl sets the HomeRegionControl field's value.

                                    func (CreateHomeRegionControlOutput) String

                                      String returns the string representation

                                      type DescribeHomeRegionControlsInput

                                      type DescribeHomeRegionControlsInput struct {
                                      
                                      	// The ControlID is a unique identifier string of your HomeRegionControl object.
                                      	ControlId *string `min:"1" type:"string"`
                                      
                                      	// The name of the home region you'd like to view.
                                      	HomeRegion *string `min:"1" type:"string"`
                                      
                                      	// The maximum number of filtering results to display per page.
                                      	MaxResults *int64 `min:"1" type:"integer"`
                                      
                                      	// 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 `type:"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 *Target `type:"structure"`
                                      	// contains filtered or unexported fields
                                      }

                                      func (DescribeHomeRegionControlsInput) GoString

                                        GoString returns the string representation

                                        func (*DescribeHomeRegionControlsInput) SetControlId

                                          SetControlId sets the ControlId field's value.

                                          func (*DescribeHomeRegionControlsInput) SetHomeRegion

                                            SetHomeRegion sets the HomeRegion field's value.

                                            func (*DescribeHomeRegionControlsInput) SetMaxResults

                                              SetMaxResults sets the MaxResults field's value.

                                              func (*DescribeHomeRegionControlsInput) SetNextToken

                                                SetNextToken sets the NextToken field's value.

                                                func (*DescribeHomeRegionControlsInput) SetTarget

                                                  SetTarget sets the Target field's value.

                                                  func (DescribeHomeRegionControlsInput) String

                                                    String returns the string representation

                                                    func (*DescribeHomeRegionControlsInput) Validate

                                                    func (s *DescribeHomeRegionControlsInput) Validate() error

                                                      Validate inspects the fields of the type to determine if they are valid.

                                                      type DescribeHomeRegionControlsOutput

                                                      type DescribeHomeRegionControlsOutput struct {
                                                      
                                                      	// An array that contains your HomeRegionControl objects.
                                                      	HomeRegionControls []*HomeRegionControl `type:"list"`
                                                      
                                                      	// 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 `type:"string"`
                                                      	// contains filtered or unexported fields
                                                      }

                                                      func (DescribeHomeRegionControlsOutput) GoString

                                                        GoString returns the string representation

                                                        func (*DescribeHomeRegionControlsOutput) SetHomeRegionControls

                                                          SetHomeRegionControls sets the HomeRegionControls field's value.

                                                          func (*DescribeHomeRegionControlsOutput) SetNextToken

                                                            SetNextToken sets the NextToken field's value.

                                                            func (DescribeHomeRegionControlsOutput) String

                                                              String returns the string representation

                                                              type DryRunOperation

                                                              type DryRunOperation struct {
                                                              	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                              
                                                              	Message_ *string `locationName:"Message" type:"string"`
                                                              	// contains filtered or unexported fields
                                                              }

                                                                Exception raised to indicate that authorization of an action was successful, when the DryRun flag is set to true.

                                                                func (*DryRunOperation) Code

                                                                func (s *DryRunOperation) Code() string

                                                                  Code returns the exception type name.

                                                                  func (*DryRunOperation) Error

                                                                  func (s *DryRunOperation) Error() string

                                                                  func (DryRunOperation) GoString

                                                                  func (s DryRunOperation) GoString() string

                                                                    GoString returns the string representation

                                                                    func (*DryRunOperation) Message

                                                                    func (s *DryRunOperation) Message() string

                                                                      Message returns the exception's message.

                                                                      func (*DryRunOperation) OrigErr

                                                                      func (s *DryRunOperation) OrigErr() error

                                                                        OrigErr always returns nil, satisfies awserr.Error interface.

                                                                        func (*DryRunOperation) RequestID

                                                                        func (s *DryRunOperation) RequestID() string

                                                                          RequestID returns the service's response RequestID for request.

                                                                          func (*DryRunOperation) StatusCode

                                                                          func (s *DryRunOperation) StatusCode() int

                                                                            Status code returns the HTTP status code for the request's response error.

                                                                            func (DryRunOperation) String

                                                                            func (s DryRunOperation) String() string

                                                                              String returns the string representation

                                                                              type GetHomeRegionInput

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

                                                                              func (GetHomeRegionInput) GoString

                                                                              func (s GetHomeRegionInput) GoString() string

                                                                                GoString returns the string representation

                                                                                func (GetHomeRegionInput) String

                                                                                func (s GetHomeRegionInput) String() string

                                                                                  String returns the string representation

                                                                                  type GetHomeRegionOutput

                                                                                  type GetHomeRegionOutput struct {
                                                                                  
                                                                                  	// The name of the home region of the calling account.
                                                                                  	HomeRegion *string `min:"1" type:"string"`
                                                                                  	// contains filtered or unexported fields
                                                                                  }

                                                                                  func (GetHomeRegionOutput) GoString

                                                                                  func (s GetHomeRegionOutput) GoString() string

                                                                                    GoString returns the string representation

                                                                                    func (*GetHomeRegionOutput) SetHomeRegion

                                                                                    func (s *GetHomeRegionOutput) SetHomeRegion(v string) *GetHomeRegionOutput

                                                                                      SetHomeRegion sets the HomeRegion field's value.

                                                                                      func (GetHomeRegionOutput) String

                                                                                      func (s GetHomeRegionOutput) String() string

                                                                                        String returns the string representation

                                                                                        type HomeRegionControl

                                                                                        type HomeRegionControl struct {
                                                                                        
                                                                                        	// A unique identifier that's generated for each home region control. It's always
                                                                                        	// a string that begins with "hrc-" followed by 12 lowercase letters and numbers.
                                                                                        	ControlId *string `min:"1" type:"string"`
                                                                                        
                                                                                        	// The AWS Region that's been set as home region. For example, "us-west-2" or
                                                                                        	// "eu-central-1" are valid home regions.
                                                                                        	HomeRegion *string `min:"1" type:"string"`
                                                                                        
                                                                                        	// A timestamp representing the time when the customer called CreateHomeregionControl
                                                                                        	// and set the home region for the account.
                                                                                        	RequestedTime *time.Time `type:"timestamp"`
                                                                                        
                                                                                        	// The target parameter specifies the identifier to which the home region is
                                                                                        	// applied, which is always an ACCOUNT. It applies the home region to the current
                                                                                        	// ACCOUNT.
                                                                                        	Target *Target `type:"structure"`
                                                                                        	// contains filtered or unexported fields
                                                                                        }

                                                                                          A home region control is an object that specifies the home region for an account, with some additional information. It contains a target (always of type ACCOUNT), an ID, and a time at which the home region was set.

                                                                                          func (HomeRegionControl) GoString

                                                                                          func (s HomeRegionControl) GoString() string

                                                                                            GoString returns the string representation

                                                                                            func (*HomeRegionControl) SetControlId

                                                                                            func (s *HomeRegionControl) SetControlId(v string) *HomeRegionControl

                                                                                              SetControlId sets the ControlId field's value.

                                                                                              func (*HomeRegionControl) SetHomeRegion

                                                                                              func (s *HomeRegionControl) SetHomeRegion(v string) *HomeRegionControl

                                                                                                SetHomeRegion sets the HomeRegion field's value.

                                                                                                func (*HomeRegionControl) SetRequestedTime

                                                                                                func (s *HomeRegionControl) SetRequestedTime(v time.Time) *HomeRegionControl

                                                                                                  SetRequestedTime sets the RequestedTime field's value.

                                                                                                  func (*HomeRegionControl) SetTarget

                                                                                                  func (s *HomeRegionControl) SetTarget(v *Target) *HomeRegionControl

                                                                                                    SetTarget sets the Target field's value.

                                                                                                    func (HomeRegionControl) String

                                                                                                    func (s HomeRegionControl) String() string

                                                                                                      String returns the string representation

                                                                                                      type InternalServerError

                                                                                                      type InternalServerError struct {
                                                                                                      	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                                                                      
                                                                                                      	Message_ *string `locationName:"Message" type:"string"`
                                                                                                      	// contains filtered or unexported fields
                                                                                                      }

                                                                                                        Exception raised when an internal, configuration, or dependency error is encountered.

                                                                                                        func (*InternalServerError) Code

                                                                                                        func (s *InternalServerError) Code() string

                                                                                                          Code returns the exception type name.

                                                                                                          func (*InternalServerError) Error

                                                                                                          func (s *InternalServerError) Error() string

                                                                                                          func (InternalServerError) GoString

                                                                                                          func (s InternalServerError) GoString() string

                                                                                                            GoString returns the string representation

                                                                                                            func (*InternalServerError) Message

                                                                                                            func (s *InternalServerError) Message() string

                                                                                                              Message returns the exception's message.

                                                                                                              func (*InternalServerError) OrigErr

                                                                                                              func (s *InternalServerError) OrigErr() error

                                                                                                                OrigErr always returns nil, satisfies awserr.Error interface.

                                                                                                                func (*InternalServerError) RequestID

                                                                                                                func (s *InternalServerError) RequestID() string

                                                                                                                  RequestID returns the service's response RequestID for request.

                                                                                                                  func (*InternalServerError) StatusCode

                                                                                                                  func (s *InternalServerError) StatusCode() int

                                                                                                                    Status code returns the HTTP status code for the request's response error.

                                                                                                                    func (InternalServerError) String

                                                                                                                    func (s InternalServerError) String() string

                                                                                                                      String returns the string representation

                                                                                                                      type InvalidInputException

                                                                                                                      type InvalidInputException struct {
                                                                                                                      	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                                                                                      
                                                                                                                      	Message_ *string `locationName:"Message" type:"string"`
                                                                                                                      	// contains filtered or unexported fields
                                                                                                                      }

                                                                                                                        Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

                                                                                                                        func (*InvalidInputException) Code

                                                                                                                        func (s *InvalidInputException) Code() string

                                                                                                                          Code returns the exception type name.

                                                                                                                          func (*InvalidInputException) Error

                                                                                                                          func (s *InvalidInputException) Error() string

                                                                                                                          func (InvalidInputException) GoString

                                                                                                                          func (s InvalidInputException) GoString() string

                                                                                                                            GoString returns the string representation

                                                                                                                            func (*InvalidInputException) Message

                                                                                                                            func (s *InvalidInputException) Message() string

                                                                                                                              Message returns the exception's message.

                                                                                                                              func (*InvalidInputException) OrigErr

                                                                                                                              func (s *InvalidInputException) OrigErr() error

                                                                                                                                OrigErr always returns nil, satisfies awserr.Error interface.

                                                                                                                                func (*InvalidInputException) RequestID

                                                                                                                                func (s *InvalidInputException) RequestID() string

                                                                                                                                  RequestID returns the service's response RequestID for request.

                                                                                                                                  func (*InvalidInputException) StatusCode

                                                                                                                                  func (s *InvalidInputException) StatusCode() int

                                                                                                                                    Status code returns the HTTP status code for the request's response error.

                                                                                                                                    func (InvalidInputException) String

                                                                                                                                    func (s InvalidInputException) String() string

                                                                                                                                      String returns the string representation

                                                                                                                                      type MigrationHubConfig

                                                                                                                                      type MigrationHubConfig struct {
                                                                                                                                      	*client.Client
                                                                                                                                      }

                                                                                                                                        MigrationHubConfig provides the API operation methods for making requests to AWS Migration Hub Config. See this package's package overview docs for details on the service.

                                                                                                                                        MigrationHubConfig methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

                                                                                                                                        func New

                                                                                                                                          New creates a new instance of the MigrationHubConfig client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

                                                                                                                                          Example:

                                                                                                                                          mySession := session.Must(session.NewSession())
                                                                                                                                          
                                                                                                                                          // Create a MigrationHubConfig client from just a session.
                                                                                                                                          svc := migrationhubconfig.New(mySession)
                                                                                                                                          
                                                                                                                                          // Create a MigrationHubConfig client with additional configuration
                                                                                                                                          svc := migrationhubconfig.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
                                                                                                                                          

                                                                                                                                          func (*MigrationHubConfig) CreateHomeRegionControl

                                                                                                                                            CreateHomeRegionControl API operation for AWS Migration Hub Config.

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

                                                                                                                                            Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

                                                                                                                                            See the AWS API reference guide for AWS Migration Hub Config's API operation CreateHomeRegionControl for usage and error information.

                                                                                                                                            Returned Error Types:

                                                                                                                                            * InternalServerError
                                                                                                                                            Exception raised when an internal, configuration, or dependency error is
                                                                                                                                            encountered.
                                                                                                                                            
                                                                                                                                            * ServiceUnavailableException
                                                                                                                                            Exception raised when a request fails due to temporary unavailability of
                                                                                                                                            the service.
                                                                                                                                            
                                                                                                                                            * AccessDeniedException
                                                                                                                                            You do not have sufficient access to perform this action.
                                                                                                                                            
                                                                                                                                            * ThrottlingException
                                                                                                                                            The request was denied due to request throttling.
                                                                                                                                            
                                                                                                                                            * DryRunOperation
                                                                                                                                            Exception raised to indicate that authorization of an action was successful,
                                                                                                                                            when the DryRun flag is set to true.
                                                                                                                                            
                                                                                                                                            * InvalidInputException
                                                                                                                                            Exception raised when the provided input violates a policy constraint or
                                                                                                                                            is entered in the wrong format or data type.
                                                                                                                                            

                                                                                                                                            See also, https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config-2019-06-30/CreateHomeRegionControl

                                                                                                                                            func (*MigrationHubConfig) CreateHomeRegionControlRequest

                                                                                                                                            func (c *MigrationHubConfig) CreateHomeRegionControlRequest(input *CreateHomeRegionControlInput) (req *request.Request, output *CreateHomeRegionControlOutput)

                                                                                                                                              CreateHomeRegionControlRequest generates a "aws/request.Request" representing the client's request for the CreateHomeRegionControl operation. The "output" return value will be populated with the request's response once the request completes successfully.

                                                                                                                                              Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

                                                                                                                                              See CreateHomeRegionControl for more information on using the CreateHomeRegionControl API call, and error handling.

                                                                                                                                              This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

                                                                                                                                              // Example sending a request using the CreateHomeRegionControlRequest method.
                                                                                                                                              req, resp := client.CreateHomeRegionControlRequest(params)
                                                                                                                                              
                                                                                                                                              err := req.Send()
                                                                                                                                              if err == nil { // resp is now filled
                                                                                                                                                  fmt.Println(resp)
                                                                                                                                              }
                                                                                                                                              

                                                                                                                                              See also, https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config-2019-06-30/CreateHomeRegionControl

                                                                                                                                              func (*MigrationHubConfig) CreateHomeRegionControlWithContext

                                                                                                                                              func (c *MigrationHubConfig) CreateHomeRegionControlWithContext(ctx aws.Context, input *CreateHomeRegionControlInput, opts ...request.Option) (*CreateHomeRegionControlOutput, error)

                                                                                                                                                CreateHomeRegionControlWithContext is the same as CreateHomeRegionControl with the addition of the ability to pass a context and additional request options.

                                                                                                                                                See CreateHomeRegionControl for details on how to use this API operation.

                                                                                                                                                The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

                                                                                                                                                func (*MigrationHubConfig) DescribeHomeRegionControls

                                                                                                                                                  DescribeHomeRegionControls API operation for AWS Migration Hub Config.

                                                                                                                                                  This API permits filtering on the ControlId and HomeRegion fields.

                                                                                                                                                  Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

                                                                                                                                                  See the AWS API reference guide for AWS Migration Hub Config's API operation DescribeHomeRegionControls for usage and error information.

                                                                                                                                                  Returned Error Types:

                                                                                                                                                  * InternalServerError
                                                                                                                                                  Exception raised when an internal, configuration, or dependency error is
                                                                                                                                                  encountered.
                                                                                                                                                  
                                                                                                                                                  * ServiceUnavailableException
                                                                                                                                                  Exception raised when a request fails due to temporary unavailability of
                                                                                                                                                  the service.
                                                                                                                                                  
                                                                                                                                                  * AccessDeniedException
                                                                                                                                                  You do not have sufficient access to perform this action.
                                                                                                                                                  
                                                                                                                                                  * ThrottlingException
                                                                                                                                                  The request was denied due to request throttling.
                                                                                                                                                  
                                                                                                                                                  * InvalidInputException
                                                                                                                                                  Exception raised when the provided input violates a policy constraint or
                                                                                                                                                  is entered in the wrong format or data type.
                                                                                                                                                  

                                                                                                                                                  See also, https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config-2019-06-30/DescribeHomeRegionControls

                                                                                                                                                  func (*MigrationHubConfig) DescribeHomeRegionControlsPages

                                                                                                                                                  func (c *MigrationHubConfig) DescribeHomeRegionControlsPages(input *DescribeHomeRegionControlsInput, fn func(*DescribeHomeRegionControlsOutput, bool) bool) error

                                                                                                                                                    DescribeHomeRegionControlsPages iterates over the pages of a DescribeHomeRegionControls operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

                                                                                                                                                    See DescribeHomeRegionControls method for more information on how to use this operation.

                                                                                                                                                    Note: This operation can generate multiple requests to a service.

                                                                                                                                                    // Example iterating over at most 3 pages of a DescribeHomeRegionControls operation.
                                                                                                                                                    pageNum := 0
                                                                                                                                                    err := client.DescribeHomeRegionControlsPages(params,
                                                                                                                                                        func(page *migrationhubconfig.DescribeHomeRegionControlsOutput, lastPage bool) bool {
                                                                                                                                                            pageNum++
                                                                                                                                                            fmt.Println(page)
                                                                                                                                                            return pageNum <= 3
                                                                                                                                                        })
                                                                                                                                                    

                                                                                                                                                    func (*MigrationHubConfig) DescribeHomeRegionControlsPagesWithContext

                                                                                                                                                    func (c *MigrationHubConfig) DescribeHomeRegionControlsPagesWithContext(ctx aws.Context, input *DescribeHomeRegionControlsInput, fn func(*DescribeHomeRegionControlsOutput, bool) bool, opts ...request.Option) error

                                                                                                                                                      DescribeHomeRegionControlsPagesWithContext same as DescribeHomeRegionControlsPages except it takes a Context and allows setting request options on the pages.

                                                                                                                                                      The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

                                                                                                                                                      func (*MigrationHubConfig) DescribeHomeRegionControlsRequest

                                                                                                                                                      func (c *MigrationHubConfig) DescribeHomeRegionControlsRequest(input *DescribeHomeRegionControlsInput) (req *request.Request, output *DescribeHomeRegionControlsOutput)

                                                                                                                                                        DescribeHomeRegionControlsRequest generates a "aws/request.Request" representing the client's request for the DescribeHomeRegionControls operation. The "output" return value will be populated with the request's response once the request completes successfully.

                                                                                                                                                        Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

                                                                                                                                                        See DescribeHomeRegionControls for more information on using the DescribeHomeRegionControls API call, and error handling.

                                                                                                                                                        This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

                                                                                                                                                        // Example sending a request using the DescribeHomeRegionControlsRequest method.
                                                                                                                                                        req, resp := client.DescribeHomeRegionControlsRequest(params)
                                                                                                                                                        
                                                                                                                                                        err := req.Send()
                                                                                                                                                        if err == nil { // resp is now filled
                                                                                                                                                            fmt.Println(resp)
                                                                                                                                                        }
                                                                                                                                                        

                                                                                                                                                        See also, https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config-2019-06-30/DescribeHomeRegionControls

                                                                                                                                                        func (*MigrationHubConfig) DescribeHomeRegionControlsWithContext

                                                                                                                                                        func (c *MigrationHubConfig) DescribeHomeRegionControlsWithContext(ctx aws.Context, input *DescribeHomeRegionControlsInput, opts ...request.Option) (*DescribeHomeRegionControlsOutput, error)

                                                                                                                                                          DescribeHomeRegionControlsWithContext is the same as DescribeHomeRegionControls with the addition of the ability to pass a context and additional request options.

                                                                                                                                                          See DescribeHomeRegionControls for details on how to use this API operation.

                                                                                                                                                          The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

                                                                                                                                                          func (*MigrationHubConfig) GetHomeRegion

                                                                                                                                                          func (c *MigrationHubConfig) GetHomeRegion(input *GetHomeRegionInput) (*GetHomeRegionOutput, error)

                                                                                                                                                            GetHomeRegion API operation for AWS Migration Hub Config.

                                                                                                                                                            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.

                                                                                                                                                            Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

                                                                                                                                                            See the AWS API reference guide for AWS Migration Hub Config's API operation GetHomeRegion for usage and error information.

                                                                                                                                                            Returned Error Types:

                                                                                                                                                            * InternalServerError
                                                                                                                                                            Exception raised when an internal, configuration, or dependency error is
                                                                                                                                                            encountered.
                                                                                                                                                            
                                                                                                                                                            * ServiceUnavailableException
                                                                                                                                                            Exception raised when a request fails due to temporary unavailability of
                                                                                                                                                            the service.
                                                                                                                                                            
                                                                                                                                                            * AccessDeniedException
                                                                                                                                                            You do not have sufficient access to perform this action.
                                                                                                                                                            
                                                                                                                                                            * ThrottlingException
                                                                                                                                                            The request was denied due to request throttling.
                                                                                                                                                            
                                                                                                                                                            * InvalidInputException
                                                                                                                                                            Exception raised when the provided input violates a policy constraint or
                                                                                                                                                            is entered in the wrong format or data type.
                                                                                                                                                            

                                                                                                                                                            See also, https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config-2019-06-30/GetHomeRegion

                                                                                                                                                            func (*MigrationHubConfig) GetHomeRegionRequest

                                                                                                                                                            func (c *MigrationHubConfig) GetHomeRegionRequest(input *GetHomeRegionInput) (req *request.Request, output *GetHomeRegionOutput)

                                                                                                                                                              GetHomeRegionRequest generates a "aws/request.Request" representing the client's request for the GetHomeRegion operation. The "output" return value will be populated with the request's response once the request completes successfully.

                                                                                                                                                              Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

                                                                                                                                                              See GetHomeRegion for more information on using the GetHomeRegion API call, and error handling.

                                                                                                                                                              This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

                                                                                                                                                              // Example sending a request using the GetHomeRegionRequest method.
                                                                                                                                                              req, resp := client.GetHomeRegionRequest(params)
                                                                                                                                                              
                                                                                                                                                              err := req.Send()
                                                                                                                                                              if err == nil { // resp is now filled
                                                                                                                                                                  fmt.Println(resp)
                                                                                                                                                              }
                                                                                                                                                              

                                                                                                                                                              See also, https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config-2019-06-30/GetHomeRegion

                                                                                                                                                              func (*MigrationHubConfig) GetHomeRegionWithContext

                                                                                                                                                              func (c *MigrationHubConfig) GetHomeRegionWithContext(ctx aws.Context, input *GetHomeRegionInput, opts ...request.Option) (*GetHomeRegionOutput, error)

                                                                                                                                                                GetHomeRegionWithContext is the same as GetHomeRegion with the addition of the ability to pass a context and additional request options.

                                                                                                                                                                See GetHomeRegion for details on how to use this API operation.

                                                                                                                                                                The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

                                                                                                                                                                type ServiceUnavailableException

                                                                                                                                                                type ServiceUnavailableException struct {
                                                                                                                                                                	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                                                                                                                                
                                                                                                                                                                	Message_ *string `locationName:"Message" type:"string"`
                                                                                                                                                                	// contains filtered or unexported fields
                                                                                                                                                                }

                                                                                                                                                                  Exception raised when a request fails due to temporary unavailability of the service.

                                                                                                                                                                  func (*ServiceUnavailableException) Code

                                                                                                                                                                    Code returns the exception type name.

                                                                                                                                                                    func (*ServiceUnavailableException) Error

                                                                                                                                                                    func (ServiceUnavailableException) GoString

                                                                                                                                                                    func (s ServiceUnavailableException) GoString() string

                                                                                                                                                                      GoString returns the string representation

                                                                                                                                                                      func (*ServiceUnavailableException) Message

                                                                                                                                                                      func (s *ServiceUnavailableException) Message() string

                                                                                                                                                                        Message returns the exception's message.

                                                                                                                                                                        func (*ServiceUnavailableException) OrigErr

                                                                                                                                                                        func (s *ServiceUnavailableException) OrigErr() error

                                                                                                                                                                          OrigErr always returns nil, satisfies awserr.Error interface.

                                                                                                                                                                          func (*ServiceUnavailableException) RequestID

                                                                                                                                                                          func (s *ServiceUnavailableException) RequestID() string

                                                                                                                                                                            RequestID returns the service's response RequestID for request.

                                                                                                                                                                            func (*ServiceUnavailableException) StatusCode

                                                                                                                                                                            func (s *ServiceUnavailableException) StatusCode() int

                                                                                                                                                                              Status code returns the HTTP status code for the request's response error.

                                                                                                                                                                              func (ServiceUnavailableException) String

                                                                                                                                                                                String returns the string representation

                                                                                                                                                                                type Target

                                                                                                                                                                                type Target struct {
                                                                                                                                                                                
                                                                                                                                                                                	// The TargetID is a 12-character identifier of the ACCOUNT for which the control
                                                                                                                                                                                	// was created. (This must be the current account.)
                                                                                                                                                                                	Id *string `min:"12" type:"string"`
                                                                                                                                                                                
                                                                                                                                                                                	// The target type is always an ACCOUNT.
                                                                                                                                                                                	//
                                                                                                                                                                                	// Type is a required field
                                                                                                                                                                                	Type *string `type:"string" required:"true" enum:"TargetType"`
                                                                                                                                                                                	// contains filtered or unexported fields
                                                                                                                                                                                }

                                                                                                                                                                                  The target parameter specifies the identifier to which the home region is applied, which is always an ACCOUNT. It applies the home region to the current ACCOUNT.

                                                                                                                                                                                  func (Target) GoString

                                                                                                                                                                                  func (s Target) GoString() string

                                                                                                                                                                                    GoString returns the string representation

                                                                                                                                                                                    func (*Target) SetId

                                                                                                                                                                                    func (s *Target) SetId(v string) *Target

                                                                                                                                                                                      SetId sets the Id field's value.

                                                                                                                                                                                      func (*Target) SetType

                                                                                                                                                                                      func (s *Target) SetType(v string) *Target

                                                                                                                                                                                        SetType sets the Type field's value.

                                                                                                                                                                                        func (Target) String

                                                                                                                                                                                        func (s Target) String() string

                                                                                                                                                                                          String returns the string representation

                                                                                                                                                                                          func (*Target) Validate

                                                                                                                                                                                          func (s *Target) Validate() error

                                                                                                                                                                                            Validate inspects the fields of the type to determine if they are valid.

                                                                                                                                                                                            type ThrottlingException

                                                                                                                                                                                            type ThrottlingException struct {
                                                                                                                                                                                            	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
                                                                                                                                                                                            
                                                                                                                                                                                            	Message_ *string `locationName:"Message" type:"string"`
                                                                                                                                                                                            
                                                                                                                                                                                            	// The number of seconds the caller should wait before retrying.
                                                                                                                                                                                            	RetryAfterSeconds *int64 `type:"integer"`
                                                                                                                                                                                            	// contains filtered or unexported fields
                                                                                                                                                                                            }

                                                                                                                                                                                              The request was denied due to request throttling.

                                                                                                                                                                                              func (*ThrottlingException) Code

                                                                                                                                                                                              func (s *ThrottlingException) Code() string

                                                                                                                                                                                                Code returns the exception type name.

                                                                                                                                                                                                func (*ThrottlingException) Error

                                                                                                                                                                                                func (s *ThrottlingException) Error() string

                                                                                                                                                                                                func (ThrottlingException) GoString

                                                                                                                                                                                                func (s ThrottlingException) GoString() string

                                                                                                                                                                                                  GoString returns the string representation

                                                                                                                                                                                                  func (*ThrottlingException) Message

                                                                                                                                                                                                  func (s *ThrottlingException) Message() string

                                                                                                                                                                                                    Message returns the exception's message.

                                                                                                                                                                                                    func (*ThrottlingException) OrigErr

                                                                                                                                                                                                    func (s *ThrottlingException) OrigErr() error

                                                                                                                                                                                                      OrigErr always returns nil, satisfies awserr.Error interface.

                                                                                                                                                                                                      func (*ThrottlingException) RequestID

                                                                                                                                                                                                      func (s *ThrottlingException) RequestID() string

                                                                                                                                                                                                        RequestID returns the service's response RequestID for request.

                                                                                                                                                                                                        func (*ThrottlingException) StatusCode

                                                                                                                                                                                                        func (s *ThrottlingException) StatusCode() int

                                                                                                                                                                                                          Status code returns the HTTP status code for the request's response error.

                                                                                                                                                                                                          func (ThrottlingException) String

                                                                                                                                                                                                          func (s ThrottlingException) String() string

                                                                                                                                                                                                            String returns the string representation

                                                                                                                                                                                                            Directories

                                                                                                                                                                                                            Path Synopsis
                                                                                                                                                                                                            Package migrationhubconfigiface provides an interface to enable mocking the AWS Migration Hub Config service client for testing your code.
                                                                                                                                                                                                            Package migrationhubconfigiface provides an interface to enable mocking the AWS Migration Hub Config service client for testing your code.