Documentation ¶
Overview ¶
Package account provides the client and types for making API requests to AWS Account.
Operations for Amazon Web Services Account Management ¶
See https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01 for more information on this service.
See account package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/account/
Using the Client ¶
To contact AWS Account 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 Account client Account for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/account/#New
Index ¶
- Constants
- func AlternateContactType_Values() []string
- func PrimaryEmailUpdateStatus_Values() []string
- func RegionOptStatus_Values() []string
- func ValidationExceptionReason_Values() []string
- type AcceptPrimaryEmailUpdateInput
- func (s AcceptPrimaryEmailUpdateInput) GoString() string
- func (s *AcceptPrimaryEmailUpdateInput) SetAccountId(v string) *AcceptPrimaryEmailUpdateInput
- func (s *AcceptPrimaryEmailUpdateInput) SetOtp(v string) *AcceptPrimaryEmailUpdateInput
- func (s *AcceptPrimaryEmailUpdateInput) SetPrimaryEmail(v string) *AcceptPrimaryEmailUpdateInput
- func (s AcceptPrimaryEmailUpdateInput) String() string
- func (s *AcceptPrimaryEmailUpdateInput) Validate() error
- type AcceptPrimaryEmailUpdateOutput
- type AccessDeniedException
- func (s *AccessDeniedException) Code() string
- func (s *AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s *AccessDeniedException) Message() string
- func (s *AccessDeniedException) OrigErr() error
- func (s *AccessDeniedException) RequestID() string
- func (s *AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type Account
- func (c *Account) AcceptPrimaryEmailUpdate(input *AcceptPrimaryEmailUpdateInput) (*AcceptPrimaryEmailUpdateOutput, error)
- func (c *Account) AcceptPrimaryEmailUpdateRequest(input *AcceptPrimaryEmailUpdateInput) (req *request.Request, output *AcceptPrimaryEmailUpdateOutput)
- func (c *Account) AcceptPrimaryEmailUpdateWithContext(ctx aws.Context, input *AcceptPrimaryEmailUpdateInput, opts ...request.Option) (*AcceptPrimaryEmailUpdateOutput, error)
- func (c *Account) DeleteAlternateContact(input *DeleteAlternateContactInput) (*DeleteAlternateContactOutput, error)
- func (c *Account) DeleteAlternateContactRequest(input *DeleteAlternateContactInput) (req *request.Request, output *DeleteAlternateContactOutput)
- func (c *Account) DeleteAlternateContactWithContext(ctx aws.Context, input *DeleteAlternateContactInput, opts ...request.Option) (*DeleteAlternateContactOutput, error)
- func (c *Account) DisableRegion(input *DisableRegionInput) (*DisableRegionOutput, error)
- func (c *Account) DisableRegionRequest(input *DisableRegionInput) (req *request.Request, output *DisableRegionOutput)
- func (c *Account) DisableRegionWithContext(ctx aws.Context, input *DisableRegionInput, opts ...request.Option) (*DisableRegionOutput, error)
- func (c *Account) EnableRegion(input *EnableRegionInput) (*EnableRegionOutput, error)
- func (c *Account) EnableRegionRequest(input *EnableRegionInput) (req *request.Request, output *EnableRegionOutput)
- func (c *Account) EnableRegionWithContext(ctx aws.Context, input *EnableRegionInput, opts ...request.Option) (*EnableRegionOutput, error)
- func (c *Account) GetAlternateContact(input *GetAlternateContactInput) (*GetAlternateContactOutput, error)
- func (c *Account) GetAlternateContactRequest(input *GetAlternateContactInput) (req *request.Request, output *GetAlternateContactOutput)
- func (c *Account) GetAlternateContactWithContext(ctx aws.Context, input *GetAlternateContactInput, opts ...request.Option) (*GetAlternateContactOutput, error)
- func (c *Account) GetContactInformation(input *GetContactInformationInput) (*GetContactInformationOutput, error)
- func (c *Account) GetContactInformationRequest(input *GetContactInformationInput) (req *request.Request, output *GetContactInformationOutput)
- func (c *Account) GetContactInformationWithContext(ctx aws.Context, input *GetContactInformationInput, opts ...request.Option) (*GetContactInformationOutput, error)
- func (c *Account) GetPrimaryEmail(input *GetPrimaryEmailInput) (*GetPrimaryEmailOutput, error)
- func (c *Account) GetPrimaryEmailRequest(input *GetPrimaryEmailInput) (req *request.Request, output *GetPrimaryEmailOutput)
- func (c *Account) GetPrimaryEmailWithContext(ctx aws.Context, input *GetPrimaryEmailInput, opts ...request.Option) (*GetPrimaryEmailOutput, error)
- func (c *Account) GetRegionOptStatus(input *GetRegionOptStatusInput) (*GetRegionOptStatusOutput, error)
- func (c *Account) GetRegionOptStatusRequest(input *GetRegionOptStatusInput) (req *request.Request, output *GetRegionOptStatusOutput)
- func (c *Account) GetRegionOptStatusWithContext(ctx aws.Context, input *GetRegionOptStatusInput, opts ...request.Option) (*GetRegionOptStatusOutput, error)
- func (c *Account) ListRegions(input *ListRegionsInput) (*ListRegionsOutput, error)
- func (c *Account) ListRegionsPages(input *ListRegionsInput, fn func(*ListRegionsOutput, bool) bool) error
- func (c *Account) ListRegionsPagesWithContext(ctx aws.Context, input *ListRegionsInput, ...) error
- func (c *Account) ListRegionsRequest(input *ListRegionsInput) (req *request.Request, output *ListRegionsOutput)
- func (c *Account) ListRegionsWithContext(ctx aws.Context, input *ListRegionsInput, opts ...request.Option) (*ListRegionsOutput, error)
- func (c *Account) PutAlternateContact(input *PutAlternateContactInput) (*PutAlternateContactOutput, error)
- func (c *Account) PutAlternateContactRequest(input *PutAlternateContactInput) (req *request.Request, output *PutAlternateContactOutput)
- func (c *Account) PutAlternateContactWithContext(ctx aws.Context, input *PutAlternateContactInput, opts ...request.Option) (*PutAlternateContactOutput, error)
- func (c *Account) PutContactInformation(input *PutContactInformationInput) (*PutContactInformationOutput, error)
- func (c *Account) PutContactInformationRequest(input *PutContactInformationInput) (req *request.Request, output *PutContactInformationOutput)
- func (c *Account) PutContactInformationWithContext(ctx aws.Context, input *PutContactInformationInput, opts ...request.Option) (*PutContactInformationOutput, error)
- func (c *Account) StartPrimaryEmailUpdate(input *StartPrimaryEmailUpdateInput) (*StartPrimaryEmailUpdateOutput, error)
- func (c *Account) StartPrimaryEmailUpdateRequest(input *StartPrimaryEmailUpdateInput) (req *request.Request, output *StartPrimaryEmailUpdateOutput)
- func (c *Account) StartPrimaryEmailUpdateWithContext(ctx aws.Context, input *StartPrimaryEmailUpdateInput, opts ...request.Option) (*StartPrimaryEmailUpdateOutput, error)
- type AlternateContact
- func (s AlternateContact) GoString() string
- func (s *AlternateContact) SetAlternateContactType(v string) *AlternateContact
- func (s *AlternateContact) SetEmailAddress(v string) *AlternateContact
- func (s *AlternateContact) SetName(v string) *AlternateContact
- func (s *AlternateContact) SetPhoneNumber(v string) *AlternateContact
- func (s *AlternateContact) SetTitle(v string) *AlternateContact
- func (s AlternateContact) String() string
- type ConflictException
- func (s *ConflictException) Code() string
- func (s *ConflictException) Error() string
- func (s ConflictException) GoString() string
- func (s *ConflictException) Message() string
- func (s *ConflictException) OrigErr() error
- func (s *ConflictException) RequestID() string
- func (s *ConflictException) StatusCode() int
- func (s ConflictException) String() string
- type ContactInformation
- func (s ContactInformation) GoString() string
- func (s *ContactInformation) SetAddressLine1(v string) *ContactInformation
- func (s *ContactInformation) SetAddressLine2(v string) *ContactInformation
- func (s *ContactInformation) SetAddressLine3(v string) *ContactInformation
- func (s *ContactInformation) SetCity(v string) *ContactInformation
- func (s *ContactInformation) SetCompanyName(v string) *ContactInformation
- func (s *ContactInformation) SetCountryCode(v string) *ContactInformation
- func (s *ContactInformation) SetDistrictOrCounty(v string) *ContactInformation
- func (s *ContactInformation) SetFullName(v string) *ContactInformation
- func (s *ContactInformation) SetPhoneNumber(v string) *ContactInformation
- func (s *ContactInformation) SetPostalCode(v string) *ContactInformation
- func (s *ContactInformation) SetStateOrRegion(v string) *ContactInformation
- func (s *ContactInformation) SetWebsiteUrl(v string) *ContactInformation
- func (s ContactInformation) String() string
- func (s *ContactInformation) Validate() error
- type DeleteAlternateContactInput
- func (s DeleteAlternateContactInput) GoString() string
- func (s *DeleteAlternateContactInput) SetAccountId(v string) *DeleteAlternateContactInput
- func (s *DeleteAlternateContactInput) SetAlternateContactType(v string) *DeleteAlternateContactInput
- func (s DeleteAlternateContactInput) String() string
- func (s *DeleteAlternateContactInput) Validate() error
- type DeleteAlternateContactOutput
- type DisableRegionInput
- type DisableRegionOutput
- type EnableRegionInput
- type EnableRegionOutput
- type GetAlternateContactInput
- func (s GetAlternateContactInput) GoString() string
- func (s *GetAlternateContactInput) SetAccountId(v string) *GetAlternateContactInput
- func (s *GetAlternateContactInput) SetAlternateContactType(v string) *GetAlternateContactInput
- func (s GetAlternateContactInput) String() string
- func (s *GetAlternateContactInput) Validate() error
- type GetAlternateContactOutput
- type GetContactInformationInput
- type GetContactInformationOutput
- type GetPrimaryEmailInput
- type GetPrimaryEmailOutput
- type GetRegionOptStatusInput
- func (s GetRegionOptStatusInput) GoString() string
- func (s *GetRegionOptStatusInput) SetAccountId(v string) *GetRegionOptStatusInput
- func (s *GetRegionOptStatusInput) SetRegionName(v string) *GetRegionOptStatusInput
- func (s GetRegionOptStatusInput) String() string
- func (s *GetRegionOptStatusInput) Validate() error
- type GetRegionOptStatusOutput
- type InternalServerException
- func (s *InternalServerException) Code() string
- func (s *InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s *InternalServerException) Message() string
- func (s *InternalServerException) OrigErr() error
- func (s *InternalServerException) RequestID() string
- func (s *InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type ListRegionsInput
- func (s ListRegionsInput) GoString() string
- func (s *ListRegionsInput) SetAccountId(v string) *ListRegionsInput
- func (s *ListRegionsInput) SetMaxResults(v int64) *ListRegionsInput
- func (s *ListRegionsInput) SetNextToken(v string) *ListRegionsInput
- func (s *ListRegionsInput) SetRegionOptStatusContains(v []*string) *ListRegionsInput
- func (s ListRegionsInput) String() string
- func (s *ListRegionsInput) Validate() error
- type ListRegionsOutput
- type PutAlternateContactInput
- func (s PutAlternateContactInput) GoString() string
- func (s *PutAlternateContactInput) SetAccountId(v string) *PutAlternateContactInput
- func (s *PutAlternateContactInput) SetAlternateContactType(v string) *PutAlternateContactInput
- func (s *PutAlternateContactInput) SetEmailAddress(v string) *PutAlternateContactInput
- func (s *PutAlternateContactInput) SetName(v string) *PutAlternateContactInput
- func (s *PutAlternateContactInput) SetPhoneNumber(v string) *PutAlternateContactInput
- func (s *PutAlternateContactInput) SetTitle(v string) *PutAlternateContactInput
- func (s PutAlternateContactInput) String() string
- func (s *PutAlternateContactInput) Validate() error
- type PutAlternateContactOutput
- type PutContactInformationInput
- func (s PutContactInformationInput) GoString() string
- func (s *PutContactInformationInput) SetAccountId(v string) *PutContactInformationInput
- func (s *PutContactInformationInput) SetContactInformation(v *ContactInformation) *PutContactInformationInput
- func (s PutContactInformationInput) String() string
- func (s *PutContactInformationInput) Validate() error
- type PutContactInformationOutput
- type Region
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type StartPrimaryEmailUpdateInput
- func (s StartPrimaryEmailUpdateInput) GoString() string
- func (s *StartPrimaryEmailUpdateInput) SetAccountId(v string) *StartPrimaryEmailUpdateInput
- func (s *StartPrimaryEmailUpdateInput) SetPrimaryEmail(v string) *StartPrimaryEmailUpdateInput
- func (s StartPrimaryEmailUpdateInput) String() string
- func (s *StartPrimaryEmailUpdateInput) Validate() error
- type StartPrimaryEmailUpdateOutput
- type TooManyRequestsException
- func (s *TooManyRequestsException) Code() string
- func (s *TooManyRequestsException) Error() string
- func (s TooManyRequestsException) GoString() string
- func (s *TooManyRequestsException) Message() string
- func (s *TooManyRequestsException) OrigErr() error
- func (s *TooManyRequestsException) RequestID() string
- func (s *TooManyRequestsException) StatusCode() int
- func (s TooManyRequestsException) String() string
- type ValidationException
- func (s *ValidationException) Code() string
- func (s *ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s *ValidationException) Message() string
- func (s *ValidationException) OrigErr() error
- func (s *ValidationException) RequestID() string
- func (s *ValidationException) StatusCode() int
- func (s ValidationException) String() string
- type ValidationExceptionField
Constants ¶
const ( // AlternateContactTypeBilling is a AlternateContactType enum value AlternateContactTypeBilling = "BILLING" // AlternateContactTypeOperations is a AlternateContactType enum value AlternateContactTypeOperations = "OPERATIONS" // AlternateContactTypeSecurity is a AlternateContactType enum value AlternateContactTypeSecurity = "SECURITY" )
const ( // PrimaryEmailUpdateStatusPending is a PrimaryEmailUpdateStatus enum value PrimaryEmailUpdateStatusPending = "PENDING" // PrimaryEmailUpdateStatusAccepted is a PrimaryEmailUpdateStatus enum value PrimaryEmailUpdateStatusAccepted = "ACCEPTED" )
const ( // RegionOptStatusEnabled is a RegionOptStatus enum value RegionOptStatusEnabled = "ENABLED" // RegionOptStatusEnabling is a RegionOptStatus enum value RegionOptStatusEnabling = "ENABLING" // RegionOptStatusDisabling is a RegionOptStatus enum value RegionOptStatusDisabling = "DISABLING" // RegionOptStatusDisabled is a RegionOptStatus enum value RegionOptStatusDisabled = "DISABLED" // RegionOptStatusEnabledByDefault is a RegionOptStatus enum value RegionOptStatusEnabledByDefault = "ENABLED_BY_DEFAULT" )
const ( // ValidationExceptionReasonInvalidRegionOptTarget is a ValidationExceptionReason enum value ValidationExceptionReasonInvalidRegionOptTarget = "invalidRegionOptTarget" // ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value ValidationExceptionReasonFieldValidationFailed = "fieldValidationFailed" )
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // The operation failed because the calling identity doesn't have the minimum // required permissions. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". // // The request could not be processed because of a conflict in the current status // of the resource. For example, this happens if you try to enable a Region // that is currently being disabled (in a status of DISABLING). ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // The operation failed because of an error internal to Amazon Web Services. // Try your operation again later. ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The operation failed because it specified a resource that can't be found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". // // The operation failed because it was called too frequently and exceeded a // throttle limit. ErrCodeTooManyRequestsException = "TooManyRequestsException" // ErrCodeValidationException for service response error code // "ValidationException". // // The operation failed because one of the input parameters was invalid. ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "Account" // Name of service. EndpointsID = "account" // ID to lookup a service endpoint with. ServiceID = "Account" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
func AlternateContactType_Values ¶
func AlternateContactType_Values() []string
AlternateContactType_Values returns all elements of the AlternateContactType enum
func PrimaryEmailUpdateStatus_Values ¶ added in v1.53.18
func PrimaryEmailUpdateStatus_Values() []string
PrimaryEmailUpdateStatus_Values returns all elements of the PrimaryEmailUpdateStatus enum
func RegionOptStatus_Values ¶ added in v1.44.200
func RegionOptStatus_Values() []string
RegionOptStatus_Values returns all elements of the RegionOptStatus enum
func ValidationExceptionReason_Values ¶ added in v1.44.200
func ValidationExceptionReason_Values() []string
ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum
Types ¶
type AcceptPrimaryEmailUpdateInput ¶ added in v1.53.18
type AcceptPrimaryEmailUpdateInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. To use this parameter, // the caller must be an identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // This operation can only be called from the management account or the delegated // administrator account of an organization for a member account. // // The management account can't specify its own AccountId. // // AccountId is a required field AccountId *string `type:"string" required:"true"` // The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate // API call. // // Otp is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AcceptPrimaryEmailUpdateInput's // String and GoString methods. // // Otp is a required field Otp *string `type:"string" required:"true" sensitive:"true"` // The new primary email address for use with the specified account. This must // match the PrimaryEmail from the StartPrimaryEmailUpdate API call. // // PrimaryEmail is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AcceptPrimaryEmailUpdateInput's // String and GoString methods. // // PrimaryEmail is a required field PrimaryEmail *string `min:"5" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (AcceptPrimaryEmailUpdateInput) GoString ¶ added in v1.53.18
func (s AcceptPrimaryEmailUpdateInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AcceptPrimaryEmailUpdateInput) SetAccountId ¶ added in v1.53.18
func (s *AcceptPrimaryEmailUpdateInput) SetAccountId(v string) *AcceptPrimaryEmailUpdateInput
SetAccountId sets the AccountId field's value.
func (*AcceptPrimaryEmailUpdateInput) SetOtp ¶ added in v1.53.18
func (s *AcceptPrimaryEmailUpdateInput) SetOtp(v string) *AcceptPrimaryEmailUpdateInput
SetOtp sets the Otp field's value.
func (*AcceptPrimaryEmailUpdateInput) SetPrimaryEmail ¶ added in v1.53.18
func (s *AcceptPrimaryEmailUpdateInput) SetPrimaryEmail(v string) *AcceptPrimaryEmailUpdateInput
SetPrimaryEmail sets the PrimaryEmail field's value.
func (AcceptPrimaryEmailUpdateInput) String ¶ added in v1.53.18
func (s AcceptPrimaryEmailUpdateInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AcceptPrimaryEmailUpdateInput) Validate ¶ added in v1.53.18
func (s *AcceptPrimaryEmailUpdateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AcceptPrimaryEmailUpdateOutput ¶ added in v1.53.18
type AcceptPrimaryEmailUpdateOutput struct { // Retrieves the status of the accepted primary email update request. Status *string `type:"string" enum:"PrimaryEmailUpdateStatus"` // contains filtered or unexported fields }
func (AcceptPrimaryEmailUpdateOutput) GoString ¶ added in v1.53.18
func (s AcceptPrimaryEmailUpdateOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AcceptPrimaryEmailUpdateOutput) SetStatus ¶ added in v1.53.18
func (s *AcceptPrimaryEmailUpdateOutput) SetStatus(v string) *AcceptPrimaryEmailUpdateOutput
SetStatus sets the Status field's value.
func (AcceptPrimaryEmailUpdateOutput) String ¶ added in v1.53.18
func (s AcceptPrimaryEmailUpdateOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type AccessDeniedException ¶
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The operation failed because the calling identity doesn't have the minimum required permissions.
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Account ¶
Account provides the API operation methods for making requests to AWS Account. See this package's package overview docs for details on the service.
Account methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *Account
New creates a new instance of the Account 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 Account client from just a session. svc := account.New(mySession) // Create a Account client with additional configuration svc := account.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*Account) AcceptPrimaryEmailUpdate ¶ added in v1.53.18
func (c *Account) AcceptPrimaryEmailUpdate(input *AcceptPrimaryEmailUpdateInput) (*AcceptPrimaryEmailUpdateOutput, error)
AcceptPrimaryEmailUpdate API operation for AWS Account.
Accepts the request that originated from StartPrimaryEmailUpdate to update the primary email address (also known as the root user email address) for the specified account.
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 Account's API operation AcceptPrimaryEmailUpdate for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation failed because it specified a resource that can't be found.
ValidationException The operation failed because one of the input parameters was invalid.
ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/AcceptPrimaryEmailUpdate
func (*Account) AcceptPrimaryEmailUpdateRequest ¶ added in v1.53.18
func (c *Account) AcceptPrimaryEmailUpdateRequest(input *AcceptPrimaryEmailUpdateInput) (req *request.Request, output *AcceptPrimaryEmailUpdateOutput)
AcceptPrimaryEmailUpdateRequest generates a "aws/request.Request" representing the client's request for the AcceptPrimaryEmailUpdate 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 AcceptPrimaryEmailUpdate for more information on using the AcceptPrimaryEmailUpdate 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 AcceptPrimaryEmailUpdateRequest method. req, resp := client.AcceptPrimaryEmailUpdateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/AcceptPrimaryEmailUpdate
func (*Account) AcceptPrimaryEmailUpdateWithContext ¶ added in v1.53.18
func (c *Account) AcceptPrimaryEmailUpdateWithContext(ctx aws.Context, input *AcceptPrimaryEmailUpdateInput, opts ...request.Option) (*AcceptPrimaryEmailUpdateOutput, error)
AcceptPrimaryEmailUpdateWithContext is the same as AcceptPrimaryEmailUpdate with the addition of the ability to pass a context and additional request options.
See AcceptPrimaryEmailUpdate 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 (*Account) DeleteAlternateContact ¶
func (c *Account) DeleteAlternateContact(input *DeleteAlternateContactInput) (*DeleteAlternateContactOutput, error)
DeleteAlternateContact API operation for AWS Account.
Deletes the specified alternate contact from an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html).
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html).
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 Account's API operation DeleteAlternateContact for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation failed because it specified a resource that can't be found.
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/DeleteAlternateContact
func (*Account) DeleteAlternateContactRequest ¶
func (c *Account) DeleteAlternateContactRequest(input *DeleteAlternateContactInput) (req *request.Request, output *DeleteAlternateContactOutput)
DeleteAlternateContactRequest generates a "aws/request.Request" representing the client's request for the DeleteAlternateContact 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 DeleteAlternateContact for more information on using the DeleteAlternateContact 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 DeleteAlternateContactRequest method. req, resp := client.DeleteAlternateContactRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/DeleteAlternateContact
func (*Account) DeleteAlternateContactWithContext ¶
func (c *Account) DeleteAlternateContactWithContext(ctx aws.Context, input *DeleteAlternateContactInput, opts ...request.Option) (*DeleteAlternateContactOutput, error)
DeleteAlternateContactWithContext is the same as DeleteAlternateContact with the addition of the ability to pass a context and additional request options.
See DeleteAlternateContact 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 (*Account) DisableRegion ¶ added in v1.44.200
func (c *Account) DisableRegion(input *DisableRegionInput) (*DisableRegionOutput, error)
DisableRegion API operation for AWS Account.
Disables (opts-out) a particular Region for an account.
The act of disabling a Region will remove all IAM access to any resources that reside in that 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 Account's API operation DisableRegion for usage and error information.
Returned Error Types:
ValidationException The operation failed because one of the input parameters was invalid.
ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/DisableRegion
func (*Account) DisableRegionRequest ¶ added in v1.44.200
func (c *Account) DisableRegionRequest(input *DisableRegionInput) (req *request.Request, output *DisableRegionOutput)
DisableRegionRequest generates a "aws/request.Request" representing the client's request for the DisableRegion 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 DisableRegion for more information on using the DisableRegion 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 DisableRegionRequest method. req, resp := client.DisableRegionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/DisableRegion
func (*Account) DisableRegionWithContext ¶ added in v1.44.200
func (c *Account) DisableRegionWithContext(ctx aws.Context, input *DisableRegionInput, opts ...request.Option) (*DisableRegionOutput, error)
DisableRegionWithContext is the same as DisableRegion with the addition of the ability to pass a context and additional request options.
See DisableRegion 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 (*Account) EnableRegion ¶ added in v1.44.200
func (c *Account) EnableRegion(input *EnableRegionInput) (*EnableRegionOutput, error)
EnableRegion API operation for AWS Account.
Enables (opts-in) a particular Region for an account.
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 Account's API operation EnableRegion for usage and error information.
Returned Error Types:
ValidationException The operation failed because one of the input parameters was invalid.
ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/EnableRegion
func (*Account) EnableRegionRequest ¶ added in v1.44.200
func (c *Account) EnableRegionRequest(input *EnableRegionInput) (req *request.Request, output *EnableRegionOutput)
EnableRegionRequest generates a "aws/request.Request" representing the client's request for the EnableRegion 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 EnableRegion for more information on using the EnableRegion 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 EnableRegionRequest method. req, resp := client.EnableRegionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/EnableRegion
func (*Account) EnableRegionWithContext ¶ added in v1.44.200
func (c *Account) EnableRegionWithContext(ctx aws.Context, input *EnableRegionInput, opts ...request.Option) (*EnableRegionOutput, error)
EnableRegionWithContext is the same as EnableRegion with the addition of the ability to pass a context and additional request options.
See EnableRegion 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 (*Account) GetAlternateContact ¶
func (c *Account) GetAlternateContact(input *GetAlternateContactInput) (*GetAlternateContactOutput, error)
GetAlternateContact API operation for AWS Account.
Retrieves the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html).
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html).
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 Account's API operation GetAlternateContact for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation failed because it specified a resource that can't be found.
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetAlternateContact
func (*Account) GetAlternateContactRequest ¶
func (c *Account) GetAlternateContactRequest(input *GetAlternateContactInput) (req *request.Request, output *GetAlternateContactOutput)
GetAlternateContactRequest generates a "aws/request.Request" representing the client's request for the GetAlternateContact 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 GetAlternateContact for more information on using the GetAlternateContact 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 GetAlternateContactRequest method. req, resp := client.GetAlternateContactRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetAlternateContact
func (*Account) GetAlternateContactWithContext ¶
func (c *Account) GetAlternateContactWithContext(ctx aws.Context, input *GetAlternateContactInput, opts ...request.Option) (*GetAlternateContactOutput, error)
GetAlternateContactWithContext is the same as GetAlternateContact with the addition of the ability to pass a context and additional request options.
See GetAlternateContact 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 (*Account) GetContactInformation ¶ added in v1.44.61
func (c *Account) GetContactInformation(input *GetContactInformationInput) (*GetContactInformationOutput, error)
GetContactInformation API operation for AWS Account.
Retrieves the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html).
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 Account's API operation GetContactInformation for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation failed because it specified a resource that can't be found.
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetContactInformation
func (*Account) GetContactInformationRequest ¶ added in v1.44.61
func (c *Account) GetContactInformationRequest(input *GetContactInformationInput) (req *request.Request, output *GetContactInformationOutput)
GetContactInformationRequest generates a "aws/request.Request" representing the client's request for the GetContactInformation 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 GetContactInformation for more information on using the GetContactInformation 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 GetContactInformationRequest method. req, resp := client.GetContactInformationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetContactInformation
func (*Account) GetContactInformationWithContext ¶ added in v1.44.61
func (c *Account) GetContactInformationWithContext(ctx aws.Context, input *GetContactInformationInput, opts ...request.Option) (*GetContactInformationOutput, error)
GetContactInformationWithContext is the same as GetContactInformation with the addition of the ability to pass a context and additional request options.
See GetContactInformation 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 (*Account) GetPrimaryEmail ¶ added in v1.53.18
func (c *Account) GetPrimaryEmail(input *GetPrimaryEmailInput) (*GetPrimaryEmailOutput, error)
GetPrimaryEmail API operation for AWS Account.
Retrieves the primary email address for the specified account.
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 Account's API operation GetPrimaryEmail for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation failed because it specified a resource that can't be found.
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetPrimaryEmail
func (*Account) GetPrimaryEmailRequest ¶ added in v1.53.18
func (c *Account) GetPrimaryEmailRequest(input *GetPrimaryEmailInput) (req *request.Request, output *GetPrimaryEmailOutput)
GetPrimaryEmailRequest generates a "aws/request.Request" representing the client's request for the GetPrimaryEmail 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 GetPrimaryEmail for more information on using the GetPrimaryEmail 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 GetPrimaryEmailRequest method. req, resp := client.GetPrimaryEmailRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetPrimaryEmail
func (*Account) GetPrimaryEmailWithContext ¶ added in v1.53.18
func (c *Account) GetPrimaryEmailWithContext(ctx aws.Context, input *GetPrimaryEmailInput, opts ...request.Option) (*GetPrimaryEmailOutput, error)
GetPrimaryEmailWithContext is the same as GetPrimaryEmail with the addition of the ability to pass a context and additional request options.
See GetPrimaryEmail 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 (*Account) GetRegionOptStatus ¶ added in v1.44.200
func (c *Account) GetRegionOptStatus(input *GetRegionOptStatusInput) (*GetRegionOptStatusOutput, error)
GetRegionOptStatus API operation for AWS Account.
Retrieves the opt-in status of a particular 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 Account's API operation GetRegionOptStatus for usage and error information.
Returned Error Types:
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetRegionOptStatus
func (*Account) GetRegionOptStatusRequest ¶ added in v1.44.200
func (c *Account) GetRegionOptStatusRequest(input *GetRegionOptStatusInput) (req *request.Request, output *GetRegionOptStatusOutput)
GetRegionOptStatusRequest generates a "aws/request.Request" representing the client's request for the GetRegionOptStatus 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 GetRegionOptStatus for more information on using the GetRegionOptStatus 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 GetRegionOptStatusRequest method. req, resp := client.GetRegionOptStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/GetRegionOptStatus
func (*Account) GetRegionOptStatusWithContext ¶ added in v1.44.200
func (c *Account) GetRegionOptStatusWithContext(ctx aws.Context, input *GetRegionOptStatusInput, opts ...request.Option) (*GetRegionOptStatusOutput, error)
GetRegionOptStatusWithContext is the same as GetRegionOptStatus with the addition of the ability to pass a context and additional request options.
See GetRegionOptStatus 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 (*Account) ListRegions ¶ added in v1.44.200
func (c *Account) ListRegions(input *ListRegionsInput) (*ListRegionsOutput, error)
ListRegions API operation for AWS Account.
Lists all the Regions for a given account and their respective opt-in statuses. Optionally, this list can be filtered by the region-opt-status-contains parameter.
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 Account's API operation ListRegions for usage and error information.
Returned Error Types:
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ListRegions
func (*Account) ListRegionsPages ¶ added in v1.44.200
func (c *Account) ListRegionsPages(input *ListRegionsInput, fn func(*ListRegionsOutput, bool) bool) error
ListRegionsPages iterates over the pages of a ListRegions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListRegions 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 ListRegions operation. pageNum := 0 err := client.ListRegionsPages(params, func(page *account.ListRegionsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*Account) ListRegionsPagesWithContext ¶ added in v1.44.200
func (c *Account) ListRegionsPagesWithContext(ctx aws.Context, input *ListRegionsInput, fn func(*ListRegionsOutput, bool) bool, opts ...request.Option) error
ListRegionsPagesWithContext same as ListRegionsPages 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 (*Account) ListRegionsRequest ¶ added in v1.44.200
func (c *Account) ListRegionsRequest(input *ListRegionsInput) (req *request.Request, output *ListRegionsOutput)
ListRegionsRequest generates a "aws/request.Request" representing the client's request for the ListRegions 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 ListRegions for more information on using the ListRegions 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 ListRegionsRequest method. req, resp := client.ListRegionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/ListRegions
func (*Account) ListRegionsWithContext ¶ added in v1.44.200
func (c *Account) ListRegionsWithContext(ctx aws.Context, input *ListRegionsInput, opts ...request.Option) (*ListRegionsOutput, error)
ListRegionsWithContext is the same as ListRegions with the addition of the ability to pass a context and additional request options.
See ListRegions 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 (*Account) PutAlternateContact ¶
func (c *Account) PutAlternateContact(input *PutAlternateContactInput) (*PutAlternateContactOutput, error)
PutAlternateContact API operation for AWS Account.
Modifies the specified alternate contact attached to an Amazon Web Services account.
For complete details about how to use the alternate contact operations, see Access or updating the alternate contacts (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html).
Before you can update the alternate contact information for an Amazon Web Services account that is managed by Organizations, you must first enable integration between Amazon Web Services Account Management and Organizations. For more information, see Enabling trusted access for Amazon Web Services Account Management (https://docs.aws.amazon.com/accounts/latest/reference/using-orgs-trusted-access.html).
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 Account's API operation PutAlternateContact for usage and error information.
Returned Error Types:
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/PutAlternateContact
func (*Account) PutAlternateContactRequest ¶
func (c *Account) PutAlternateContactRequest(input *PutAlternateContactInput) (req *request.Request, output *PutAlternateContactOutput)
PutAlternateContactRequest generates a "aws/request.Request" representing the client's request for the PutAlternateContact 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 PutAlternateContact for more information on using the PutAlternateContact 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 PutAlternateContactRequest method. req, resp := client.PutAlternateContactRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/PutAlternateContact
func (*Account) PutAlternateContactWithContext ¶
func (c *Account) PutAlternateContactWithContext(ctx aws.Context, input *PutAlternateContactInput, opts ...request.Option) (*PutAlternateContactOutput, error)
PutAlternateContactWithContext is the same as PutAlternateContact with the addition of the ability to pass a context and additional request options.
See PutAlternateContact 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 (*Account) PutContactInformation ¶ added in v1.44.61
func (c *Account) PutContactInformation(input *PutContactInformationInput) (*PutContactInformationOutput, error)
PutContactInformation API operation for AWS Account.
Updates the primary contact information of an Amazon Web Services account.
For complete details about how to use the primary contact operations, see Update the primary and alternate contact information (https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-update-contact.html).
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 Account's API operation PutContactInformation for usage and error information.
Returned Error Types:
ValidationException The operation failed because one of the input parameters was invalid.
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/PutContactInformation
func (*Account) PutContactInformationRequest ¶ added in v1.44.61
func (c *Account) PutContactInformationRequest(input *PutContactInformationInput) (req *request.Request, output *PutContactInformationOutput)
PutContactInformationRequest generates a "aws/request.Request" representing the client's request for the PutContactInformation 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 PutContactInformation for more information on using the PutContactInformation 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 PutContactInformationRequest method. req, resp := client.PutContactInformationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/PutContactInformation
func (*Account) PutContactInformationWithContext ¶ added in v1.44.61
func (c *Account) PutContactInformationWithContext(ctx aws.Context, input *PutContactInformationInput, opts ...request.Option) (*PutContactInformationOutput, error)
PutContactInformationWithContext is the same as PutContactInformation with the addition of the ability to pass a context and additional request options.
See PutContactInformation 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 (*Account) StartPrimaryEmailUpdate ¶ added in v1.53.18
func (c *Account) StartPrimaryEmailUpdate(input *StartPrimaryEmailUpdateInput) (*StartPrimaryEmailUpdateOutput, error)
StartPrimaryEmailUpdate API operation for AWS Account.
Starts the process to update the primary email address for the specified account.
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 Account's API operation StartPrimaryEmailUpdate for usage and error information.
Returned Error Types:
ResourceNotFoundException The operation failed because it specified a resource that can't be found.
ValidationException The operation failed because one of the input parameters was invalid.
ConflictException The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
AccessDeniedException The operation failed because the calling identity doesn't have the minimum required permissions.
TooManyRequestsException The operation failed because it was called too frequently and exceeded a throttle limit.
InternalServerException The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/StartPrimaryEmailUpdate
func (*Account) StartPrimaryEmailUpdateRequest ¶ added in v1.53.18
func (c *Account) StartPrimaryEmailUpdateRequest(input *StartPrimaryEmailUpdateInput) (req *request.Request, output *StartPrimaryEmailUpdateOutput)
StartPrimaryEmailUpdateRequest generates a "aws/request.Request" representing the client's request for the StartPrimaryEmailUpdate 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 StartPrimaryEmailUpdate for more information on using the StartPrimaryEmailUpdate 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 StartPrimaryEmailUpdateRequest method. req, resp := client.StartPrimaryEmailUpdateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/account-2021-02-01/StartPrimaryEmailUpdate
func (*Account) StartPrimaryEmailUpdateWithContext ¶ added in v1.53.18
func (c *Account) StartPrimaryEmailUpdateWithContext(ctx aws.Context, input *StartPrimaryEmailUpdateInput, opts ...request.Option) (*StartPrimaryEmailUpdateOutput, error)
StartPrimaryEmailUpdateWithContext is the same as StartPrimaryEmailUpdate with the addition of the ability to pass a context and additional request options.
See StartPrimaryEmailUpdate 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 AlternateContact ¶
type AlternateContact struct { // The type of alternate contact. AlternateContactType *string `type:"string" enum:"AlternateContactType"` // The email address associated with this alternate contact. // // EmailAddress is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AlternateContact's // String and GoString methods. EmailAddress *string `min:"1" type:"string" sensitive:"true"` // The name associated with this alternate contact. // // Name is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AlternateContact's // String and GoString methods. Name *string `min:"1" type:"string" sensitive:"true"` // The phone number associated with this alternate contact. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AlternateContact's // String and GoString methods. PhoneNumber *string `min:"1" type:"string" sensitive:"true"` // The title associated with this alternate contact. // // Title is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by AlternateContact's // String and GoString methods. Title *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
A structure that contains the details of an alternate contact associated with an Amazon Web Services account
func (AlternateContact) GoString ¶
func (s AlternateContact) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AlternateContact) SetAlternateContactType ¶
func (s *AlternateContact) SetAlternateContactType(v string) *AlternateContact
SetAlternateContactType sets the AlternateContactType field's value.
func (*AlternateContact) SetEmailAddress ¶
func (s *AlternateContact) SetEmailAddress(v string) *AlternateContact
SetEmailAddress sets the EmailAddress field's value.
func (*AlternateContact) SetName ¶
func (s *AlternateContact) SetName(v string) *AlternateContact
SetName sets the Name field's value.
func (*AlternateContact) SetPhoneNumber ¶
func (s *AlternateContact) SetPhoneNumber(v string) *AlternateContact
SetPhoneNumber sets the PhoneNumber field's value.
func (*AlternateContact) SetTitle ¶
func (s *AlternateContact) SetTitle(v string) *AlternateContact
SetTitle sets the Title field's value.
func (AlternateContact) String ¶
func (s AlternateContact) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException ¶ added in v1.44.200
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The request could not be processed because of a conflict in the current status of the resource. For example, this happens if you try to enable a Region that is currently being disabled (in a status of DISABLING).
func (*ConflictException) Code ¶ added in v1.44.200
func (s *ConflictException) Code() string
Code returns the exception type name.
func (*ConflictException) Error ¶ added in v1.44.200
func (s *ConflictException) Error() string
func (ConflictException) GoString ¶ added in v1.44.200
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ConflictException) Message ¶ added in v1.44.200
func (s *ConflictException) Message() string
Message returns the exception's message.
func (*ConflictException) OrigErr ¶ added in v1.44.200
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ConflictException) RequestID ¶ added in v1.44.200
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ConflictException) StatusCode ¶ added in v1.44.200
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ConflictException) String ¶ added in v1.44.200
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ContactInformation ¶ added in v1.44.61
type ContactInformation struct { // The first line of the primary contact address. // // AddressLine1 is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. // // AddressLine1 is a required field AddressLine1 *string `min:"1" type:"string" required:"true" sensitive:"true"` // The second line of the primary contact address, if any. // // AddressLine2 is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. AddressLine2 *string `min:"1" type:"string" sensitive:"true"` // The third line of the primary contact address, if any. // // AddressLine3 is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. AddressLine3 *string `min:"1" type:"string" sensitive:"true"` // The city of the primary contact address. // // City is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. // // City is a required field City *string `min:"1" type:"string" required:"true" sensitive:"true"` // The name of the company associated with the primary contact information, // if any. // // CompanyName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. CompanyName *string `min:"1" type:"string" sensitive:"true"` // The ISO-3166 two-letter country code for the primary contact address. // // CountryCode is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. // // CountryCode is a required field CountryCode *string `min:"2" type:"string" required:"true" sensitive:"true"` // The district or county of the primary contact address, if any. // // DistrictOrCounty is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. DistrictOrCounty *string `min:"1" type:"string" sensitive:"true"` // The full name of the primary contact address. // // FullName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. // // FullName is a required field FullName *string `min:"1" type:"string" required:"true" sensitive:"true"` // The phone number of the primary contact information. The number will be validated // and, in some countries, checked for activation. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. // // PhoneNumber is a required field PhoneNumber *string `min:"1" type:"string" required:"true" sensitive:"true"` // The postal code of the primary contact address. // // PostalCode is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. // // PostalCode is a required field PostalCode *string `min:"1" type:"string" required:"true" sensitive:"true"` // The state or region of the primary contact address. If the mailing address // is within the United States (US), the value in this field can be either a // two character state code (for example, NJ) or the full state name (for example, // New Jersey). This field is required in the following countries: US, CA, GB, // DE, JP, IN, and BR. // // StateOrRegion is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. StateOrRegion *string `min:"1" type:"string" sensitive:"true"` // The URL of the website associated with the primary contact information, if // any. // // WebsiteUrl is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ContactInformation's // String and GoString methods. WebsiteUrl *string `min:"1" type:"string" sensitive:"true"` // contains filtered or unexported fields }
Contains the details of the primary contact information associated with an Amazon Web Services account.
func (ContactInformation) GoString ¶ added in v1.44.61
func (s ContactInformation) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ContactInformation) SetAddressLine1 ¶ added in v1.44.61
func (s *ContactInformation) SetAddressLine1(v string) *ContactInformation
SetAddressLine1 sets the AddressLine1 field's value.
func (*ContactInformation) SetAddressLine2 ¶ added in v1.44.61
func (s *ContactInformation) SetAddressLine2(v string) *ContactInformation
SetAddressLine2 sets the AddressLine2 field's value.
func (*ContactInformation) SetAddressLine3 ¶ added in v1.44.61
func (s *ContactInformation) SetAddressLine3(v string) *ContactInformation
SetAddressLine3 sets the AddressLine3 field's value.
func (*ContactInformation) SetCity ¶ added in v1.44.61
func (s *ContactInformation) SetCity(v string) *ContactInformation
SetCity sets the City field's value.
func (*ContactInformation) SetCompanyName ¶ added in v1.44.61
func (s *ContactInformation) SetCompanyName(v string) *ContactInformation
SetCompanyName sets the CompanyName field's value.
func (*ContactInformation) SetCountryCode ¶ added in v1.44.61
func (s *ContactInformation) SetCountryCode(v string) *ContactInformation
SetCountryCode sets the CountryCode field's value.
func (*ContactInformation) SetDistrictOrCounty ¶ added in v1.44.61
func (s *ContactInformation) SetDistrictOrCounty(v string) *ContactInformation
SetDistrictOrCounty sets the DistrictOrCounty field's value.
func (*ContactInformation) SetFullName ¶ added in v1.44.61
func (s *ContactInformation) SetFullName(v string) *ContactInformation
SetFullName sets the FullName field's value.
func (*ContactInformation) SetPhoneNumber ¶ added in v1.44.61
func (s *ContactInformation) SetPhoneNumber(v string) *ContactInformation
SetPhoneNumber sets the PhoneNumber field's value.
func (*ContactInformation) SetPostalCode ¶ added in v1.44.61
func (s *ContactInformation) SetPostalCode(v string) *ContactInformation
SetPostalCode sets the PostalCode field's value.
func (*ContactInformation) SetStateOrRegion ¶ added in v1.44.61
func (s *ContactInformation) SetStateOrRegion(v string) *ContactInformation
SetStateOrRegion sets the StateOrRegion field's value.
func (*ContactInformation) SetWebsiteUrl ¶ added in v1.44.61
func (s *ContactInformation) SetWebsiteUrl(v string) *ContactInformation
SetWebsiteUrl sets the WebsiteUrl field's value.
func (ContactInformation) String ¶ added in v1.44.61
func (s ContactInformation) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ContactInformation) Validate ¶ added in v1.44.61
func (s *ContactInformation) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAlternateContactInput ¶
type DeleteAlternateContactInput struct { // Specifies the 12 digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. // // If you do not specify this parameter, it defaults to the Amazon Web Services // account of the identity used to call the operation. // // To use this parameter, the caller must be an identity in the organization's // management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account, and the specified account ID must be // a member account in the same organization. The organization must have all // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId; it must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // then don't specify this parameter, and call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // Specifies which of the alternate contacts to delete. // // AlternateContactType is a required field AlternateContactType *string `type:"string" required:"true" enum:"AlternateContactType"` // contains filtered or unexported fields }
func (DeleteAlternateContactInput) GoString ¶
func (s DeleteAlternateContactInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteAlternateContactInput) SetAccountId ¶
func (s *DeleteAlternateContactInput) SetAccountId(v string) *DeleteAlternateContactInput
SetAccountId sets the AccountId field's value.
func (*DeleteAlternateContactInput) SetAlternateContactType ¶
func (s *DeleteAlternateContactInput) SetAlternateContactType(v string) *DeleteAlternateContactInput
SetAlternateContactType sets the AlternateContactType field's value.
func (DeleteAlternateContactInput) String ¶
func (s DeleteAlternateContactInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteAlternateContactInput) Validate ¶
func (s *DeleteAlternateContactInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAlternateContactOutput ¶
type DeleteAlternateContactOutput struct {
// contains filtered or unexported fields
}
func (DeleteAlternateContactOutput) GoString ¶
func (s DeleteAlternateContactOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DeleteAlternateContactOutput) String ¶
func (s DeleteAlternateContactOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DisableRegionInput ¶ added in v1.44.200
type DisableRegionInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. If you don't specify // this parameter, it defaults to the Amazon Web Services account of the identity // used to call the operation. To use this parameter, the caller must be an // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId. It must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // don't specify this parameter. Instead, call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // Specifies the Region-code for a given Region name (for example, af-south-1). // When you disable a Region, Amazon Web Services performs actions to deactivate // that Region in your account, such as destroying IAM resources in the Region. // This process takes a few minutes for most accounts, but this can take several // hours. You cannot enable the Region until the disabling process is fully // completed. // // RegionName is a required field RegionName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DisableRegionInput) GoString ¶ added in v1.44.200
func (s DisableRegionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DisableRegionInput) SetAccountId ¶ added in v1.44.200
func (s *DisableRegionInput) SetAccountId(v string) *DisableRegionInput
SetAccountId sets the AccountId field's value.
func (*DisableRegionInput) SetRegionName ¶ added in v1.44.200
func (s *DisableRegionInput) SetRegionName(v string) *DisableRegionInput
SetRegionName sets the RegionName field's value.
func (DisableRegionInput) String ¶ added in v1.44.200
func (s DisableRegionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DisableRegionInput) Validate ¶ added in v1.44.200
func (s *DisableRegionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisableRegionOutput ¶ added in v1.44.200
type DisableRegionOutput struct {
// contains filtered or unexported fields
}
func (DisableRegionOutput) GoString ¶ added in v1.44.200
func (s DisableRegionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (DisableRegionOutput) String ¶ added in v1.44.200
func (s DisableRegionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EnableRegionInput ¶ added in v1.44.200
type EnableRegionInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. If you don't specify // this parameter, it defaults to the Amazon Web Services account of the identity // used to call the operation. To use this parameter, the caller must be an // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId. It must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // don't specify this parameter. Instead, call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // Specifies the Region-code for a given Region name (for example, af-south-1). // When you enable a Region, Amazon Web Services performs actions to prepare // your account in that Region, such as distributing your IAM resources to the // Region. This process takes a few minutes for most accounts, but it can take // several hours. You cannot use the Region until this process is complete. // Furthermore, you cannot disable the Region until the enabling process is // fully completed. // // RegionName is a required field RegionName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (EnableRegionInput) GoString ¶ added in v1.44.200
func (s EnableRegionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnableRegionInput) SetAccountId ¶ added in v1.44.200
func (s *EnableRegionInput) SetAccountId(v string) *EnableRegionInput
SetAccountId sets the AccountId field's value.
func (*EnableRegionInput) SetRegionName ¶ added in v1.44.200
func (s *EnableRegionInput) SetRegionName(v string) *EnableRegionInput
SetRegionName sets the RegionName field's value.
func (EnableRegionInput) String ¶ added in v1.44.200
func (s EnableRegionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnableRegionInput) Validate ¶ added in v1.44.200
func (s *EnableRegionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnableRegionOutput ¶ added in v1.44.200
type EnableRegionOutput struct {
// contains filtered or unexported fields
}
func (EnableRegionOutput) GoString ¶ added in v1.44.200
func (s EnableRegionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (EnableRegionOutput) String ¶ added in v1.44.200
func (s EnableRegionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetAlternateContactInput ¶
type GetAlternateContactInput struct { // Specifies the 12 digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. // // If you do not specify this parameter, it defaults to the Amazon Web Services // account of the identity used to call the operation. // // To use this parameter, the caller must be an identity in the organization's // management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account, and the specified account ID must be // a member account in the same organization. The organization must have all // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId; it must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // then don't specify this parameter, and call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // Specifies which alternate contact you want to retrieve. // // AlternateContactType is a required field AlternateContactType *string `type:"string" required:"true" enum:"AlternateContactType"` // contains filtered or unexported fields }
func (GetAlternateContactInput) GoString ¶
func (s GetAlternateContactInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetAlternateContactInput) SetAccountId ¶
func (s *GetAlternateContactInput) SetAccountId(v string) *GetAlternateContactInput
SetAccountId sets the AccountId field's value.
func (*GetAlternateContactInput) SetAlternateContactType ¶
func (s *GetAlternateContactInput) SetAlternateContactType(v string) *GetAlternateContactInput
SetAlternateContactType sets the AlternateContactType field's value.
func (GetAlternateContactInput) String ¶
func (s GetAlternateContactInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetAlternateContactInput) Validate ¶
func (s *GetAlternateContactInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetAlternateContactOutput ¶
type GetAlternateContactOutput struct { // A structure that contains the details for the specified alternate contact. AlternateContact *AlternateContact `type:"structure"` // contains filtered or unexported fields }
func (GetAlternateContactOutput) GoString ¶
func (s GetAlternateContactOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetAlternateContactOutput) SetAlternateContact ¶
func (s *GetAlternateContactOutput) SetAlternateContact(v *AlternateContact) *GetAlternateContactOutput
SetAlternateContact sets the AlternateContact field's value.
func (GetAlternateContactOutput) String ¶
func (s GetAlternateContactOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetContactInformationInput ¶ added in v1.44.61
type GetContactInformationInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. If you don't specify // this parameter, it defaults to the Amazon Web Services account of the identity // used to call the operation. To use this parameter, the caller must be an // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId. It must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // don't specify this parameter. Instead, call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // contains filtered or unexported fields }
func (GetContactInformationInput) GoString ¶ added in v1.44.61
func (s GetContactInformationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetContactInformationInput) SetAccountId ¶ added in v1.44.61
func (s *GetContactInformationInput) SetAccountId(v string) *GetContactInformationInput
SetAccountId sets the AccountId field's value.
func (GetContactInformationInput) String ¶ added in v1.44.61
func (s GetContactInformationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetContactInformationOutput ¶ added in v1.44.61
type GetContactInformationOutput struct { // Contains the details of the primary contact information associated with an // Amazon Web Services account. ContactInformation *ContactInformation `type:"structure"` // contains filtered or unexported fields }
func (GetContactInformationOutput) GoString ¶ added in v1.44.61
func (s GetContactInformationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetContactInformationOutput) SetContactInformation ¶ added in v1.44.61
func (s *GetContactInformationOutput) SetContactInformation(v *ContactInformation) *GetContactInformationOutput
SetContactInformation sets the ContactInformation field's value.
func (GetContactInformationOutput) String ¶ added in v1.44.61
func (s GetContactInformationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetPrimaryEmailInput ¶ added in v1.53.18
type GetPrimaryEmailInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. To use this parameter, // the caller must be an identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // This operation can only be called from the management account or the delegated // administrator account of an organization for a member account. // // The management account can't specify its own AccountId. // // AccountId is a required field AccountId *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (GetPrimaryEmailInput) GoString ¶ added in v1.53.18
func (s GetPrimaryEmailInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetPrimaryEmailInput) SetAccountId ¶ added in v1.53.18
func (s *GetPrimaryEmailInput) SetAccountId(v string) *GetPrimaryEmailInput
SetAccountId sets the AccountId field's value.
func (GetPrimaryEmailInput) String ¶ added in v1.53.18
func (s GetPrimaryEmailInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetPrimaryEmailInput) Validate ¶ added in v1.53.18
func (s *GetPrimaryEmailInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetPrimaryEmailOutput ¶ added in v1.53.18
type GetPrimaryEmailOutput struct { // Retrieves the primary email address associated with the specified account. // // PrimaryEmail is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by GetPrimaryEmailOutput's // String and GoString methods. PrimaryEmail *string `min:"5" type:"string" sensitive:"true"` // contains filtered or unexported fields }
func (GetPrimaryEmailOutput) GoString ¶ added in v1.53.18
func (s GetPrimaryEmailOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetPrimaryEmailOutput) SetPrimaryEmail ¶ added in v1.53.18
func (s *GetPrimaryEmailOutput) SetPrimaryEmail(v string) *GetPrimaryEmailOutput
SetPrimaryEmail sets the PrimaryEmail field's value.
func (GetPrimaryEmailOutput) String ¶ added in v1.53.18
func (s GetPrimaryEmailOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetRegionOptStatusInput ¶ added in v1.44.200
type GetRegionOptStatusInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. If you don't specify // this parameter, it defaults to the Amazon Web Services account of the identity // used to call the operation. To use this parameter, the caller must be an // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId. It must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // don't specify this parameter. Instead, call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // Specifies the Region-code for a given Region name (for example, af-south-1). // This function will return the status of whatever Region you pass into this // parameter. // // RegionName is a required field RegionName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetRegionOptStatusInput) GoString ¶ added in v1.44.200
func (s GetRegionOptStatusInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetRegionOptStatusInput) SetAccountId ¶ added in v1.44.200
func (s *GetRegionOptStatusInput) SetAccountId(v string) *GetRegionOptStatusInput
SetAccountId sets the AccountId field's value.
func (*GetRegionOptStatusInput) SetRegionName ¶ added in v1.44.200
func (s *GetRegionOptStatusInput) SetRegionName(v string) *GetRegionOptStatusInput
SetRegionName sets the RegionName field's value.
func (GetRegionOptStatusInput) String ¶ added in v1.44.200
func (s GetRegionOptStatusInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetRegionOptStatusInput) Validate ¶ added in v1.44.200
func (s *GetRegionOptStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRegionOptStatusOutput ¶ added in v1.44.200
type GetRegionOptStatusOutput struct { // The Region code that was passed in. RegionName *string `min:"1" type:"string"` // One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, // Disabling, Enabled_By_Default). RegionOptStatus *string `type:"string" enum:"RegionOptStatus"` // contains filtered or unexported fields }
func (GetRegionOptStatusOutput) GoString ¶ added in v1.44.200
func (s GetRegionOptStatusOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetRegionOptStatusOutput) SetRegionName ¶ added in v1.44.200
func (s *GetRegionOptStatusOutput) SetRegionName(v string) *GetRegionOptStatusOutput
SetRegionName sets the RegionName field's value.
func (*GetRegionOptStatusOutput) SetRegionOptStatus ¶ added in v1.44.200
func (s *GetRegionOptStatusOutput) SetRegionOptStatus(v string) *GetRegionOptStatusOutput
SetRegionOptStatus sets the RegionOptStatus field's value.
func (GetRegionOptStatusOutput) String ¶ added in v1.44.200
func (s GetRegionOptStatusOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalServerException ¶
type InternalServerException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
func (*InternalServerException) Code ¶
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (*InternalServerException) Error ¶
func (s *InternalServerException) Error() string
func (InternalServerException) GoString ¶
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*InternalServerException) Message ¶
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (*InternalServerException) OrigErr ¶
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InternalServerException) RequestID ¶
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InternalServerException) StatusCode ¶
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InternalServerException) String ¶
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListRegionsInput ¶ added in v1.44.200
type ListRegionsInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. If you don't specify // this parameter, it defaults to the Amazon Web Services account of the identity // used to call the operation. To use this parameter, the caller must be an // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId. It must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // don't specify this parameter. Instead, call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // The total number of items to return in the command’s output. If the total // number of items available is more than the value specified, a NextToken is // provided in the command’s output. To resume pagination, provide the NextToken // value in the starting-token argument of a subsequent command. Do not use // the NextToken response element directly outside of the Amazon Web Services // CLI. For usage examples, see Pagination (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) // in the Amazon Web Services Command Line Interface User Guide. MaxResults *int64 `min:"1" type:"integer"` // A token used to specify where to start paginating. This is the NextToken // from a previously truncated response. For usage examples, see Pagination // (http://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the // Amazon Web Services Command Line Interface User Guide. NextToken *string `type:"string"` // A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) // to use to filter the list of Regions for a given account. For example, passing // in a value of ENABLING will only return a list of Regions with a Region status // of ENABLING. RegionOptStatusContains []*string `type:"list" enum:"RegionOptStatus"` // contains filtered or unexported fields }
func (ListRegionsInput) GoString ¶ added in v1.44.200
func (s ListRegionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListRegionsInput) SetAccountId ¶ added in v1.44.200
func (s *ListRegionsInput) SetAccountId(v string) *ListRegionsInput
SetAccountId sets the AccountId field's value.
func (*ListRegionsInput) SetMaxResults ¶ added in v1.44.200
func (s *ListRegionsInput) SetMaxResults(v int64) *ListRegionsInput
SetMaxResults sets the MaxResults field's value.
func (*ListRegionsInput) SetNextToken ¶ added in v1.44.200
func (s *ListRegionsInput) SetNextToken(v string) *ListRegionsInput
SetNextToken sets the NextToken field's value.
func (*ListRegionsInput) SetRegionOptStatusContains ¶ added in v1.44.200
func (s *ListRegionsInput) SetRegionOptStatusContains(v []*string) *ListRegionsInput
SetRegionOptStatusContains sets the RegionOptStatusContains field's value.
func (ListRegionsInput) String ¶ added in v1.44.200
func (s ListRegionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListRegionsInput) Validate ¶ added in v1.44.200
func (s *ListRegionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListRegionsOutput ¶ added in v1.44.200
type ListRegionsOutput struct { // If there is more data to be returned, this will be populated. It should be // passed into the next-token request parameter of list-regions. NextToken *string `type:"string"` // This is a list of Regions for a given account, or if the filtered parameter // was used, a list of Regions that match the filter criteria set in the filter // parameter. Regions []*Region `type:"list"` // contains filtered or unexported fields }
func (ListRegionsOutput) GoString ¶ added in v1.44.200
func (s ListRegionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListRegionsOutput) SetNextToken ¶ added in v1.44.200
func (s *ListRegionsOutput) SetNextToken(v string) *ListRegionsOutput
SetNextToken sets the NextToken field's value.
func (*ListRegionsOutput) SetRegions ¶ added in v1.44.200
func (s *ListRegionsOutput) SetRegions(v []*Region) *ListRegionsOutput
SetRegions sets the Regions field's value.
func (ListRegionsOutput) String ¶ added in v1.44.200
func (s ListRegionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PutAlternateContactInput ¶
type PutAlternateContactInput struct { // Specifies the 12 digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. // // If you do not specify this parameter, it defaults to the Amazon Web Services // account of the identity used to call the operation. // // To use this parameter, the caller must be an identity in the organization's // management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account, and the specified account ID must be // a member account in the same organization. The organization must have all // features enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId; it must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // then don't specify this parameter, and call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // Specifies which alternate contact you want to create or update. // // AlternateContactType is a required field AlternateContactType *string `type:"string" required:"true" enum:"AlternateContactType"` // Specifies an email address for the alternate contact. // // EmailAddress is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PutAlternateContactInput's // String and GoString methods. // // EmailAddress is a required field EmailAddress *string `min:"1" type:"string" required:"true" sensitive:"true"` // Specifies a name for the alternate contact. // // Name is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PutAlternateContactInput's // String and GoString methods. // // Name is a required field Name *string `min:"1" type:"string" required:"true" sensitive:"true"` // Specifies a phone number for the alternate contact. // // PhoneNumber is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PutAlternateContactInput's // String and GoString methods. // // PhoneNumber is a required field PhoneNumber *string `min:"1" type:"string" required:"true" sensitive:"true"` // Specifies a title for the alternate contact. // // Title is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PutAlternateContactInput's // String and GoString methods. // // Title is a required field Title *string `min:"1" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (PutAlternateContactInput) GoString ¶
func (s PutAlternateContactInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PutAlternateContactInput) SetAccountId ¶
func (s *PutAlternateContactInput) SetAccountId(v string) *PutAlternateContactInput
SetAccountId sets the AccountId field's value.
func (*PutAlternateContactInput) SetAlternateContactType ¶
func (s *PutAlternateContactInput) SetAlternateContactType(v string) *PutAlternateContactInput
SetAlternateContactType sets the AlternateContactType field's value.
func (*PutAlternateContactInput) SetEmailAddress ¶
func (s *PutAlternateContactInput) SetEmailAddress(v string) *PutAlternateContactInput
SetEmailAddress sets the EmailAddress field's value.
func (*PutAlternateContactInput) SetName ¶
func (s *PutAlternateContactInput) SetName(v string) *PutAlternateContactInput
SetName sets the Name field's value.
func (*PutAlternateContactInput) SetPhoneNumber ¶
func (s *PutAlternateContactInput) SetPhoneNumber(v string) *PutAlternateContactInput
SetPhoneNumber sets the PhoneNumber field's value.
func (*PutAlternateContactInput) SetTitle ¶
func (s *PutAlternateContactInput) SetTitle(v string) *PutAlternateContactInput
SetTitle sets the Title field's value.
func (PutAlternateContactInput) String ¶
func (s PutAlternateContactInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PutAlternateContactInput) Validate ¶
func (s *PutAlternateContactInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutAlternateContactOutput ¶
type PutAlternateContactOutput struct {
// contains filtered or unexported fields
}
func (PutAlternateContactOutput) GoString ¶
func (s PutAlternateContactOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (PutAlternateContactOutput) String ¶
func (s PutAlternateContactOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PutContactInformationInput ¶ added in v1.44.61
type PutContactInformationInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. If you don't specify // this parameter, it defaults to the Amazon Web Services account of the identity // used to call the operation. To use this parameter, the caller must be an // identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // The management account can't specify its own AccountId. It must call the // operation in standalone context by not including the AccountId parameter. // // To call this operation on an account that is not a member of an organization, // don't specify this parameter. Instead, call the operation using an identity // belonging to the account whose contacts you wish to retrieve or modify. AccountId *string `type:"string"` // Contains the details of the primary contact information associated with an // Amazon Web Services account. // // ContactInformation is a required field ContactInformation *ContactInformation `type:"structure" required:"true"` // contains filtered or unexported fields }
func (PutContactInformationInput) GoString ¶ added in v1.44.61
func (s PutContactInformationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PutContactInformationInput) SetAccountId ¶ added in v1.44.61
func (s *PutContactInformationInput) SetAccountId(v string) *PutContactInformationInput
SetAccountId sets the AccountId field's value.
func (*PutContactInformationInput) SetContactInformation ¶ added in v1.44.61
func (s *PutContactInformationInput) SetContactInformation(v *ContactInformation) *PutContactInformationInput
SetContactInformation sets the ContactInformation field's value.
func (PutContactInformationInput) String ¶ added in v1.44.61
func (s PutContactInformationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*PutContactInformationInput) Validate ¶ added in v1.44.61
func (s *PutContactInformationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutContactInformationOutput ¶ added in v1.44.61
type PutContactInformationOutput struct {
// contains filtered or unexported fields
}
func (PutContactInformationOutput) GoString ¶ added in v1.44.61
func (s PutContactInformationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (PutContactInformationOutput) String ¶ added in v1.44.61
func (s PutContactInformationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Region ¶ added in v1.44.200
type Region struct { // The Region code of a given Region (for example, us-east-1). RegionName *string `min:"1" type:"string"` // One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, // Disabling, Enabled_By_Default). RegionOptStatus *string `type:"string" enum:"RegionOptStatus"` // contains filtered or unexported fields }
This is a structure that expresses the Region for a given account, consisting of a name and opt-in status.
func (Region) GoString ¶ added in v1.44.200
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*Region) SetRegionName ¶ added in v1.44.200
SetRegionName sets the RegionName field's value.
func (*Region) SetRegionOptStatus ¶ added in v1.44.200
SetRegionOptStatus sets the RegionOptStatus field's value.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The operation failed because it specified a resource that can't be found.
func (*ResourceNotFoundException) Code ¶
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (*ResourceNotFoundException) Error ¶
func (s *ResourceNotFoundException) Error() string
func (ResourceNotFoundException) GoString ¶
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ResourceNotFoundException) Message ¶
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (*ResourceNotFoundException) OrigErr ¶
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ResourceNotFoundException) RequestID ¶
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ResourceNotFoundException) StatusCode ¶
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceNotFoundException) String ¶
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type StartPrimaryEmailUpdateInput ¶ added in v1.53.18
type StartPrimaryEmailUpdateInput struct { // Specifies the 12-digit account ID number of the Amazon Web Services account // that you want to access or modify with this operation. To use this parameter, // the caller must be an identity in the organization's management account (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account) // or a delegated administrator account. The specified account ID must be a // member account in the same organization. The organization must have all features // enabled (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html), // and the organization must have trusted access (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html) // enabled for the Account Management service, and optionally a delegated admin // (https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html) // account assigned. // // This operation can only be called from the management account or the delegated // administrator account of an organization for a member account. // // The management account can't specify its own AccountId. // // AccountId is a required field AccountId *string `type:"string" required:"true"` // The new primary email address (also known as the root user email address) // to use in the specified account. // // PrimaryEmail is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by StartPrimaryEmailUpdateInput's // String and GoString methods. // // PrimaryEmail is a required field PrimaryEmail *string `min:"5" type:"string" required:"true" sensitive:"true"` // contains filtered or unexported fields }
func (StartPrimaryEmailUpdateInput) GoString ¶ added in v1.53.18
func (s StartPrimaryEmailUpdateInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*StartPrimaryEmailUpdateInput) SetAccountId ¶ added in v1.53.18
func (s *StartPrimaryEmailUpdateInput) SetAccountId(v string) *StartPrimaryEmailUpdateInput
SetAccountId sets the AccountId field's value.
func (*StartPrimaryEmailUpdateInput) SetPrimaryEmail ¶ added in v1.53.18
func (s *StartPrimaryEmailUpdateInput) SetPrimaryEmail(v string) *StartPrimaryEmailUpdateInput
SetPrimaryEmail sets the PrimaryEmail field's value.
func (StartPrimaryEmailUpdateInput) String ¶ added in v1.53.18
func (s StartPrimaryEmailUpdateInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*StartPrimaryEmailUpdateInput) Validate ¶ added in v1.53.18
func (s *StartPrimaryEmailUpdateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartPrimaryEmailUpdateOutput ¶ added in v1.53.18
type StartPrimaryEmailUpdateOutput struct { // The status of the primary email update request. Status *string `type:"string" enum:"PrimaryEmailUpdateStatus"` // contains filtered or unexported fields }
func (StartPrimaryEmailUpdateOutput) GoString ¶ added in v1.53.18
func (s StartPrimaryEmailUpdateOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*StartPrimaryEmailUpdateOutput) SetStatus ¶ added in v1.53.18
func (s *StartPrimaryEmailUpdateOutput) SetStatus(v string) *StartPrimaryEmailUpdateOutput
SetStatus sets the Status field's value.
func (StartPrimaryEmailUpdateOutput) String ¶ added in v1.53.18
func (s StartPrimaryEmailUpdateOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TooManyRequestsException ¶
type TooManyRequestsException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The operation failed because it was called too frequently and exceeded a throttle limit.
func (*TooManyRequestsException) Code ¶
func (s *TooManyRequestsException) Code() string
Code returns the exception type name.
func (*TooManyRequestsException) Error ¶
func (s *TooManyRequestsException) Error() string
func (TooManyRequestsException) GoString ¶
func (s TooManyRequestsException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TooManyRequestsException) Message ¶
func (s *TooManyRequestsException) Message() string
Message returns the exception's message.
func (*TooManyRequestsException) OrigErr ¶
func (s *TooManyRequestsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*TooManyRequestsException) RequestID ¶
func (s *TooManyRequestsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*TooManyRequestsException) StatusCode ¶
func (s *TooManyRequestsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (TooManyRequestsException) String ¶
func (s TooManyRequestsException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationException ¶
type ValidationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // The field where the invalid entry was detected. FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"` // The message that informs you about what was invalid about the request. // // Message_ is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidationException's // String and GoString methods. Message_ *string `locationName:"message" type:"string" sensitive:"true"` // The reason that validation failed. Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"` // contains filtered or unexported fields }
The operation failed because one of the input parameters was invalid.
func (*ValidationException) Code ¶
func (s *ValidationException) Code() string
Code returns the exception type name.
func (*ValidationException) Error ¶
func (s *ValidationException) Error() string
func (ValidationException) GoString ¶
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ValidationException) Message ¶
func (s *ValidationException) Message() string
Message returns the exception's message.
func (*ValidationException) OrigErr ¶
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ValidationException) RequestID ¶
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ValidationException) StatusCode ¶
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ValidationException) String ¶
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationExceptionField ¶ added in v1.44.200
type ValidationExceptionField struct { // A message about the validation exception. // // Message is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by ValidationExceptionField's // String and GoString methods. // // Message is a required field Message *string `locationName:"message" type:"string" required:"true" sensitive:"true"` // The field name where the invalid entry was detected. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // contains filtered or unexported fields }
The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.
func (ValidationExceptionField) GoString ¶ added in v1.44.200
func (s ValidationExceptionField) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ValidationExceptionField) SetMessage ¶ added in v1.44.200
func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField
SetMessage sets the Message field's value.
func (*ValidationExceptionField) SetName ¶ added in v1.44.200
func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField
SetName sets the Name field's value.
func (ValidationExceptionField) String ¶ added in v1.44.200
func (s ValidationExceptionField) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
Directories ¶
Path | Synopsis |
---|---|
Package accountiface provides an interface to enable mocking the AWS Account service client for testing your code.
|
Package accountiface provides an interface to enable mocking the AWS Account service client for testing your code. |