Snowball / Paginator / DescribeAddresses

DescribeAddresses#

class Snowball.Paginator.DescribeAddresses#

paginator = client.get_paginator('describe_addresses')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Snowball.Client.describe_addresses().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

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,
            'Type': 'CUST_PICKUP'|'AWS_SHIP'
        },
    ],

}

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.
    - Type (string) –
      
      Differentiates between delivery address and pickup address in the customer account. Provided at job creation.