| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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
- data DescribeAddresses = DescribeAddresses' {}
- newDescribeAddresses :: DescribeAddresses
- describeAddresses_nextToken :: Lens' DescribeAddresses (Maybe Text)
- describeAddresses_maxResults :: Lens' DescribeAddresses (Maybe Natural)
- data DescribeAddressesResponse = DescribeAddressesResponse' {}
- newDescribeAddressesResponse :: Int -> DescribeAddressesResponse
- describeAddressesResponse_addresses :: Lens' DescribeAddressesResponse (Maybe [Address])
- describeAddressesResponse_nextToken :: Lens' DescribeAddressesResponse (Maybe Text)
- describeAddressesResponse_httpStatus :: Lens' DescribeAddressesResponse Int
Creating a Request
data DescribeAddresses Source #
See: newDescribeAddresses smart constructor.
Constructors
| DescribeAddresses' | |
Fields
| |
Instances
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
| |
Instances
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.
describeAddressesResponse_httpStatus :: Lens' DescribeAddressesResponse Int Source #
The response's http status code.