Snowball / Client / describe_addresses

describe_addresses#

Snowball.Client.describe_addresses(**kwargs)#

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Request Syntax

response = client.describe_addresses(
    MaxResults=123,
    NextToken='string'
)

Parameters:

MaxResults (integer) – The number of ADDRESS objects to return.
NextToken (string) – HTTP requests are stateless. To identify what object comes “next” in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

Return type:

dict

Returns:

Response Syntax

{
    'Addresses': [
        {
            'AddressId': 'string',
            'Name': 'string',
            'Company': 'string',
            'Street1': 'string',
            'Street2': 'string',
            'Street3': 'string',
            'City': 'string',
            'StateOrProvince': 'string',
            'PrefectureOrDistrict': 'string',
            'Landmark': 'string',
            'Country': 'string',
            'PostalCode': 'string',
            'PhoneNumber': 'string',
            'IsRestricted': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Addresses (list) –
  
  The Snow device shipping addresses that were created for this account.
  - (dict) –
    
    The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.
    - AddressId (string) –
      
      The unique ID for an address.
    - Name (string) –
      
      The name of a person to receive a Snow device at an address.
    - Company (string) –
      
      The name of the company to receive a Snow device at an address.
    - Street1 (string) –
      
      The first line in a street address that a Snow device is to be delivered to.
    - Street2 (string) –
      
      The second line in a street address that a Snow device is to be delivered to.
    - Street3 (string) –
      
      The third line in a street address that a Snow device is to be delivered to.
    - City (string) –
      
      The city in an address that a Snow device is to be delivered to.
    - StateOrProvince (string) –
      
      The state or province in an address that a Snow device is to be delivered to.
    - PrefectureOrDistrict (string) –
      
      This field is no longer used and the value is ignored.
    - Landmark (string) –
      
      This field is no longer used and the value is ignored.
    - Country (string) –
      
      The country in an address that a Snow device is to be delivered to.
    - PostalCode (string) –
      
      The postal code in an address that a Snow device is to be delivered to.
    - PhoneNumber (string) –
      
      The phone number associated with an address that a Snow device is to be delivered to.
    - IsRestricted (boolean) –
      
      If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
- NextToken (string) –
  
  HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.

Exceptions

Snowball.Client.exceptions.InvalidResourceException
Snowball.Client.exceptions.InvalidNextTokenException

Examples

This operation describes all the addresses that you’ve created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

response = client.describe_addresses(
)

print(response)

Expected Output:

{
    'Addresses': [
        {
            'AddressId': 'ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b',
            'City': 'Seattle',
            'Company': 'My Company',
            'Country': 'US',
            'Name': 'My Name',
            'PhoneNumber': '425-555-5555',
            'PostalCode': '98101',
            'StateOrProvince': 'WA',
            'Street1': '123 Main Street',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}