Outposts / Client / get_site_address

get_site_address#

Outposts.Client.get_site_address(**kwargs)#

Gets the site address of the specified site.

See also: AWS API Documentation

Request Syntax

response = client.get_site_address(
    SiteId='string',
    AddressType='SHIPPING_ADDRESS'|'OPERATING_ADDRESS'
)
Parameters:

  • SiteId (string) –

    [REQUIRED]

    The ID or the Amazon Resource Name (ARN) of the site.

  • AddressType (string) –

    [REQUIRED]

    The type of the address you request.

Return type:

dict

Returns:

Response Syntax

{
    'SiteId': 'string',
    'AddressType': 'SHIPPING_ADDRESS'|'OPERATING_ADDRESS',
    'Address': {
        'ContactName': 'string',
        'ContactPhoneNumber': 'string',
        'AddressLine1': 'string',
        'AddressLine2': 'string',
        'AddressLine3': 'string',
        'City': 'string',
        'StateOrRegion': 'string',
        'DistrictOrCounty': 'string',
        'PostalCode': 'string',
        'CountryCode': 'string',
        'Municipality': 'string'
    }
}

Response Structure

  • (dict) –

    • SiteId (string) –

      The ID of the site.

    • AddressType (string) –

      The type of the address you receive.

    • Address (dict) –

      Information about the address.

      • ContactName (string) –

        The name of the contact.

      • ContactPhoneNumber (string) –

        The phone number of the contact.

      • AddressLine1 (string) –

        The first line of the address.

      • AddressLine2 (string) –

        The second line of the address.

      • AddressLine3 (string) –

        The third line of the address.

      • City (string) –

        The city for the address.

      • StateOrRegion (string) –

        The state for the address.

      • DistrictOrCounty (string) –

        The district or county for the address.

      • PostalCode (string) –

        The postal code for the address.

      • CountryCode (string) –

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

      • Municipality (string) –

        The municipality for the address.

Exceptions