libZSservicesZSamazonka-snowballZSamazonka-snowball
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Snowball.DescribeAddresses

Description

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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeAddresses Source #

See: newDescribeAddresses smart constructor.

Constructors

DescribeAddresses' 

Fields

  • nextToken :: Maybe Text

    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.

  • maxResults :: Maybe Natural

    The number of ADDRESS objects to return.

Instances

Instances details
Eq DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Read DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Show DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Generic DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Associated Types

type Rep DescribeAddresses :: Type -> Type #

NFData DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Methods

rnf :: DescribeAddresses -> () #

Hashable DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

ToJSON DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

AWSPager DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

AWSRequest DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Associated Types

type AWSResponse DescribeAddresses #

ToHeaders DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

ToPath DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

ToQuery DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

type Rep DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

type Rep DescribeAddresses = D1 ('MetaData "DescribeAddresses" "Amazonka.Snowball.DescribeAddresses" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "DescribeAddresses'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse DescribeAddresses Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

newDescribeAddresses :: DescribeAddresses Source #

Create a value of DescribeAddresses with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:DescribeAddresses', describeAddresses_nextToken - 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.

$sel:maxResults:DescribeAddresses', describeAddresses_maxResults - The number of ADDRESS objects to return.

Request Lenses

describeAddresses_nextToken :: Lens' DescribeAddresses (Maybe Text) Source #

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.

describeAddresses_maxResults :: Lens' DescribeAddresses (Maybe Natural) Source #

The number of ADDRESS objects to return.

Destructuring the Response

data DescribeAddressesResponse Source #

See: newDescribeAddressesResponse smart constructor.

Constructors

DescribeAddressesResponse' 

Fields

  • addresses :: Maybe [Address]

    The Snow device shipping addresses that were created for this account.

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Read DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Show DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Generic DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

Associated Types

type Rep DescribeAddressesResponse :: Type -> Type #

NFData DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

type Rep DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.Snowball.DescribeAddresses

type Rep DescribeAddressesResponse = D1 ('MetaData "DescribeAddressesResponse" "Amazonka.Snowball.DescribeAddresses" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "DescribeAddressesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Address])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeAddressesResponse Source #

Create a value of DescribeAddressesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:addresses:DescribeAddressesResponse', describeAddressesResponse_addresses - The Snow device shipping addresses that were created for this account.

$sel:nextToken:DescribeAddresses', describeAddressesResponse_nextToken - 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.

$sel:httpStatus:DescribeAddressesResponse', describeAddressesResponse_httpStatus - The response's http status code.

Response Lenses

describeAddressesResponse_addresses :: Lens' DescribeAddressesResponse (Maybe [Address]) Source #

The Snow device shipping addresses that were created for this account.

describeAddressesResponse_nextToken :: Lens' DescribeAddressesResponse (Maybe Text) Source #

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.