Account

Client

class Account.Client

A low-level client representing AWS Account

Operations for Amazon Web Services Account Management

client = session.create_client('account')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

delete_alternate_contact(**kwargs)

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 .

Note

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 .

See also: AWS API Documentation

Request Syntax

response = client.delete_alternate_contact(
    AccountId='string',
    AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY'
)
Parameters
  • AccountId (string) --

    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.

    Note

    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.

  • AlternateContactType (string) --

    [REQUIRED]

    Specifies which of the alternate contacts to delete.

Returns

None

Exceptions

get_alternate_contact(**kwargs)

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 .

Note

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 .

See also: AWS API Documentation

Request Syntax

response = client.get_alternate_contact(
    AccountId='string',
    AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY'
)
Parameters
  • AccountId (string) --

    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.

    Note

    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.

  • AlternateContactType (string) --

    [REQUIRED]

    Specifies which alternate contact you want to retrieve.

Return type

dict

Returns

Response Syntax

{
    'AlternateContact': {
        'AlternateContactType': 'BILLING'|'OPERATIONS'|'SECURITY',
        'EmailAddress': 'string',
        'Name': 'string',
        'PhoneNumber': 'string',
        'Title': 'string'
    }
}

Response Structure

  • (dict) --

    • AlternateContact (dict) --

      A structure that contains the details for the specified alternate contact.

      • AlternateContactType (string) --

        The type of alternate contact.

      • EmailAddress (string) --

        The email address associated with this alternate contact.

      • Name (string) --

        The name associated with this alternate contact.

      • PhoneNumber (string) --

        The phone number associated with this alternate contact.

      • Title (string) --

        The title associated with this alternate contact.

Exceptions

get_contact_information(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.get_contact_information(
    AccountId='string'
)
Parameters
AccountId (string) --

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 also 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.

Note

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.

Return type
dict
Returns
Response Syntax
{
    'ContactInformation': {
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'CompanyName': 'string',
        'CountryCode': 'string',
        'DistrictOrCounty': 'string',
        'FullName': 'string',
        'PhoneNumber': 'string',
        'PostalCode': 'string',
        'StateOrRegion': 'string',
        'WebsiteUrl': 'string'
    }
}

Response Structure

  • (dict) --
    • ContactInformation (dict) --

      Contains the details of the primary contact information associated with an Amazon Web Services account.

      • AddressLine1 (string) --

        The first line of the primary contact address.

      • AddressLine2 (string) --

        The second line of the primary contact address, if any.

      • AddressLine3 (string) --

        The third line of the primary contact address, if any.

      • City (string) --

        The city of the primary contact address.

      • CompanyName (string) --

        The name of the company associated with the primary contact information, if any.

      • CountryCode (string) --

        The ISO-3166 two-letter country code for the primary contact address.

      • DistrictOrCounty (string) --

        The district or county of the primary contact address, if any.

      • FullName (string) --

        The full name of the primary contact address.

      • PhoneNumber (string) --

        The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.

      • PostalCode (string) --

        The postal code of the primary contact address.

      • StateOrRegion (string) --

        The state or region of the primary contact address. This field is required in selected countries.

      • WebsiteUrl (string) --

        The URL of the website associated with the primary contact information, if any.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
put_alternate_contact(**kwargs)

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 .

Note

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 .

See also: AWS API Documentation

Request Syntax

response = client.put_alternate_contact(
    AccountId='string',
    AlternateContactType='BILLING'|'OPERATIONS'|'SECURITY',
    EmailAddress='string',
    Name='string',
    PhoneNumber='string',
    Title='string'
)
Parameters
  • AccountId (string) --

    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.

    Note

    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.

  • AlternateContactType (string) --

    [REQUIRED]

    Specifies which alternate contact you want to create or update.

  • EmailAddress (string) --

    [REQUIRED]

    Specifies an email address for the alternate contact.

  • Name (string) --

    [REQUIRED]

    Specifies a name for the alternate contact.

  • PhoneNumber (string) --

    [REQUIRED]

    Specifies a phone number for the alternate contact.

  • Title (string) --

    [REQUIRED]

    Specifies a title for the alternate contact.

Returns

None

Exceptions

put_contact_information(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.put_contact_information(
    AccountId='string',
    ContactInformation={
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'CompanyName': 'string',
        'CountryCode': 'string',
        'DistrictOrCounty': 'string',
        'FullName': 'string',
        'PhoneNumber': 'string',
        'PostalCode': 'string',
        'StateOrRegion': 'string',
        'WebsiteUrl': 'string'
    }
)
Parameters
  • AccountId (string) --

    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 also 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.

    Note

    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.

  • ContactInformation (dict) --

    [REQUIRED]

    Contains the details of the primary contact information associated with an Amazon Web Services account.

    • AddressLine1 (string) -- [REQUIRED]

      The first line of the primary contact address.

    • AddressLine2 (string) --

      The second line of the primary contact address, if any.

    • AddressLine3 (string) --

      The third line of the primary contact address, if any.

    • City (string) -- [REQUIRED]

      The city of the primary contact address.

    • CompanyName (string) --

      The name of the company associated with the primary contact information, if any.

    • CountryCode (string) -- [REQUIRED]

      The ISO-3166 two-letter country code for the primary contact address.

    • DistrictOrCounty (string) --

      The district or county of the primary contact address, if any.

    • FullName (string) -- [REQUIRED]

      The full name of the primary contact address.

    • PhoneNumber (string) -- [REQUIRED]

      The phone number of the primary contact information. The number will be validated and, in some countries, checked for activation.

    • PostalCode (string) -- [REQUIRED]

      The postal code of the primary contact address.

    • StateOrRegion (string) --

      The state or region of the primary contact address. This field is required in selected countries.

    • WebsiteUrl (string) --

      The URL of the website associated with the primary contact information, if any.

Returns

None

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class Account.Client.exceptions.AccessDeniedException

The operation failed because the calling identity doesn't have the minimum required permissions.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation failed because the calling identity doesn't have the minimum required permissions.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Account.Client.exceptions.InternalServerException

The operation failed because of an error internal to Amazon Web Services. Try your operation again later.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation failed because of an error internal to Amazon Web Services. Try your operation again later.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Account.Client.exceptions.ResourceNotFoundException

The operation failed because it specified a resource that can't be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation failed because it specified a resource that can't be found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Account.Client.exceptions.TooManyRequestsException

The operation failed because it was called too frequently and exceeded a throttle limit.

Example

try:
  ...
except client.exceptions.TooManyRequestsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation failed because it was called too frequently and exceeded a throttle limit.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class Account.Client.exceptions.ValidationException

The operation failed because one of the input parameters was invalid.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The operation failed because one of the input parameters was invalid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: