Operations for Amazon Web Services Account Management
", "operations": { "AcceptPrimaryEmailUpdate": "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.
", "DeleteAlternateContact": "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.
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.
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.
Enables (opts-in) a particular Region for an account.
", "GetAccountInformation": "Retrieves information about the specified account including its account name, account ID, and account creation date and time. To use this API, an IAM user or role must have the account:GetAccountInformation IAM permission.
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.
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.
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.
", "GetPrimaryEmail": "Retrieves the primary email address for the specified account.
", "GetRegionOptStatus": "Retrieves the opt-in status of a particular Region.
", "ListRegions": "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.
Updates the account name of the specified account. To use this API, IAM principals must have the account:PutAccountName IAM permission.
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.
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.
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.
", "StartPrimaryEmailUpdate": "Starts the process to update the primary email address for the specified account.
" }, "shapes": { "AcceptPrimaryEmailUpdateRequest": { "base": null, "refs": { } }, "AcceptPrimaryEmailUpdateResponse": { "base": null, "refs": { } }, "AccessDeniedException": { "base": "The operation failed because the calling identity doesn't have the minimum required permissions.
", "refs": { } }, "AccountCreatedDate": { "base": null, "refs": { "GetAccountInformationResponse$AccountCreatedDate": "The date and time the account was created.
" } }, "AccountId": { "base": null, "refs": { "AcceptPrimaryEmailUpdateRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "DisableRegionRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "EnableRegionRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "GetAccountInformationRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "GetAccountInformationResponse$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "GetContactInformationRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "GetPrimaryEmailRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "ListRegionsRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "PutAccountNameRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "PutAlternateContactRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "PutContactInformationRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
", "StartPrimaryEmailUpdateRequest$AccountId": "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 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, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated admin 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.
The name of the account.
", "PutAccountNameRequest$AccountName": "The name of the account.
" } }, "AddressLine": { "base": null, "refs": { "ContactInformation$AddressLine1": "The first line of the primary contact address.
", "ContactInformation$AddressLine2": "The second line of the primary contact address, if any.
", "ContactInformation$AddressLine3": "The third line of the primary contact address, if any.
" } }, "AlternateContact": { "base": "A structure that contains the details of an alternate contact associated with an Amazon Web Services account
", "refs": { "GetAlternateContactResponse$AlternateContact": "A structure that contains the details for the specified alternate contact.
" } }, "AlternateContactType": { "base": null, "refs": { "AlternateContact$AlternateContactType": "The type of alternate contact.
", "DeleteAlternateContactRequest$AlternateContactType": "Specifies which of the alternate contacts to delete.
", "GetAlternateContactRequest$AlternateContactType": "Specifies which alternate contact you want to retrieve.
", "PutAlternateContactRequest$AlternateContactType": "Specifies which alternate contact you want to create or update.
" } }, "City": { "base": null, "refs": { "ContactInformation$City": "The city of the primary contact address.
" } }, "CompanyName": { "base": null, "refs": { "ContactInformation$CompanyName": "The name of the company associated with the primary contact information, if any.
" } }, "ConflictException": { "base": "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) or if you try to change an account’s root user email to an email address which is already in use.
", "refs": { } }, "ContactInformation": { "base": "Contains the details of the primary contact information associated with an Amazon Web Services account.
", "refs": { "GetContactInformationResponse$ContactInformation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
", "PutContactInformationRequest$ContactInformation": "Contains the details of the primary contact information associated with an Amazon Web Services account.
" } }, "ContactInformationPhoneNumber": { "base": null, "refs": { "ContactInformation$PhoneNumber": "The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.
" } }, "CountryCode": { "base": null, "refs": { "ContactInformation$CountryCode": "The ISO-3166 two-letter country code for the primary contact address.
" } }, "DeleteAlternateContactRequest": { "base": null, "refs": { } }, "DisableRegionRequest": { "base": null, "refs": { } }, "DistrictOrCounty": { "base": null, "refs": { "ContactInformation$DistrictOrCounty": "The district or county of the primary contact address, if any.
" } }, "EmailAddress": { "base": null, "refs": { "AlternateContact$EmailAddress": "The email address associated with this alternate contact.
", "PutAlternateContactRequest$EmailAddress": "Specifies an email address for the alternate contact.
" } }, "EnableRegionRequest": { "base": null, "refs": { } }, "FullName": { "base": null, "refs": { "ContactInformation$FullName": "The full name of the primary contact address.
" } }, "GetAccountInformationRequest": { "base": null, "refs": { } }, "GetAccountInformationResponse": { "base": null, "refs": { } }, "GetAlternateContactRequest": { "base": null, "refs": { } }, "GetAlternateContactResponse": { "base": null, "refs": { } }, "GetContactInformationRequest": { "base": null, "refs": { } }, "GetContactInformationResponse": { "base": null, "refs": { } }, "GetPrimaryEmailRequest": { "base": null, "refs": { } }, "GetPrimaryEmailResponse": { "base": null, "refs": { } }, "GetRegionOptStatusRequest": { "base": null, "refs": { } }, "GetRegionOptStatusResponse": { "base": null, "refs": { } }, "InternalServerException": { "base": "The operation failed because of an error internal to Amazon Web Services. Try your operation again later.
", "refs": { } }, "ListRegionsRequest": { "base": null, "refs": { } }, "ListRegionsRequestMaxResultsInteger": { "base": null, "refs": { "ListRegionsRequest$MaxResults": "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 in the Amazon Web Services Command Line Interface User Guide.
A token used to specify where to start paginating. This is the NextToken from a previously truncated response. For usage examples, see Pagination in the Amazon Web Services Command Line Interface User Guide.
The name associated with this alternate contact.
", "PutAlternateContactRequest$Name": "Specifies a name for the alternate contact.
" } }, "Otp": { "base": null, "refs": { "AcceptPrimaryEmailUpdateRequest$Otp": "The OTP code sent to the PrimaryEmail specified on the StartPrimaryEmailUpdate API call.
The phone number associated with this alternate contact.
", "PutAlternateContactRequest$PhoneNumber": "Specifies a phone number for the alternate contact.
" } }, "PostalCode": { "base": null, "refs": { "ContactInformation$PostalCode": "The postal code of the primary contact address.
" } }, "PrimaryEmailAddress": { "base": null, "refs": { "AcceptPrimaryEmailUpdateRequest$PrimaryEmail": "The new primary email address for use with the specified account. This must match the PrimaryEmail from the StartPrimaryEmailUpdate API call.
Retrieves the primary email address associated with the specified account.
", "StartPrimaryEmailUpdateRequest$PrimaryEmail": "The new primary email address (also known as the root user email address) to use in the specified account.
" } }, "PrimaryEmailUpdateStatus": { "base": null, "refs": { "AcceptPrimaryEmailUpdateResponse$Status": "Retrieves the status of the accepted primary email update request.
", "StartPrimaryEmailUpdateResponse$Status": "The status of the primary email update request.
" } }, "PutAccountNameRequest": { "base": null, "refs": { } }, "PutAlternateContactRequest": { "base": null, "refs": { } }, "PutContactInformationRequest": { "base": null, "refs": { } }, "Region": { "base": "This is a structure that expresses the Region for a given account, consisting of a name and opt-in status.
", "refs": { "RegionOptList$member": null } }, "RegionName": { "base": null, "refs": { "DisableRegionRequest$RegionName": "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.
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.
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.
The Region code that was passed in.
", "Region$RegionName": "The Region code of a given Region (for example, us-east-1).
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.
One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
", "Region$RegionOptStatus": "One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).
", "RegionOptStatusList$member": null } }, "RegionOptStatusList": { "base": null, "refs": { "ListRegionsRequest$RegionOptStatusContains": "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.
" } }, "ResourceNotFoundException": { "base": "The operation failed because it specified a resource that can't be found.
", "refs": { } }, "SensitiveString": { "base": null, "refs": { "ValidationException$message": "The message that informs you about what was invalid about the request.
", "ValidationExceptionField$message": "A message about the validation exception.
" } }, "StartPrimaryEmailUpdateRequest": { "base": null, "refs": { } }, "StartPrimaryEmailUpdateResponse": { "base": null, "refs": { } }, "StateOrRegion": { "base": null, "refs": { "ContactInformation$StateOrRegion": "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.
The value populated to the x-amzn-ErrorType response header by API Gateway.
The value populated to the x-amzn-ErrorType response header by API Gateway.
The value populated to the x-amzn-ErrorType response header by API Gateway.
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.
The value populated to the x-amzn-ErrorType response header by API Gateway.
The value populated to the x-amzn-ErrorType response header by API Gateway.
The field name where the invalid entry was detected.
" } }, "Title": { "base": null, "refs": { "AlternateContact$Title": "The title associated with this alternate contact.
", "PutAlternateContactRequest$Title": "Specifies a title for the alternate contact.
" } }, "TooManyRequestsException": { "base": "The operation failed because it was called too frequently and exceeded a throttle limit.
", "refs": { } }, "ValidationException": { "base": "The operation failed because one of the input parameters was invalid.
", "refs": { } }, "ValidationExceptionField": { "base": "The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "The field where the invalid entry was detected.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$reason": "The reason that validation failed.
" } }, "WebsiteUrl": { "base": null, "refs": { "ContactInformation$WebsiteUrl": "The URL of the website associated with the primary contact information, if any.
" } } } }