Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- describeAddresses :: DescribeAddresses
- data DescribeAddresses
- daNextToken :: Lens' DescribeAddresses (Maybe Text)
- daMaxResults :: Lens' DescribeAddresses (Maybe Natural)
- describeAddressesResponse :: Int -> DescribeAddressesResponse
- data DescribeAddressesResponse
- drsAddresses :: Lens' DescribeAddressesResponse [Address]
- drsNextToken :: Lens' DescribeAddressesResponse (Maybe Text)
- drsResponseStatus :: Lens' DescribeAddressesResponse Int
Creating a Request
describeAddresses :: DescribeAddresses Source #
Creates a value of DescribeAddresses
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
daNextToken
- HTTP requests are stateless. To identify what object comes "next" in the list ofADDRESS
objects, you have the option of specifying a value forNextToken
as the starting point for your list of returned addresses.daMaxResults
- The number ofADDRESS
objects to return.
data DescribeAddresses Source #
See: describeAddresses
smart constructor.
Request Lenses
daNextToken :: 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.
daMaxResults :: Lens' DescribeAddresses (Maybe Natural) Source #
The number of ADDRESS
objects to return.
Destructuring the Response
describeAddressesResponse Source #
Creates a value of DescribeAddressesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drsAddresses
- The Snowball shipping addresses that were created for this account.drsNextToken
- HTTP requests are stateless. If you use the automatically generatedNextToken
value in your nextDescribeAddresses
call, your list of returned addresses will start from this point in the array.drsResponseStatus
- -- | The response status code.
data DescribeAddressesResponse Source #
See: describeAddressesResponse
smart constructor.
Response Lenses
drsAddresses :: Lens' DescribeAddressesResponse [Address] Source #
The Snowball shipping addresses that were created for this account.
drsNextToken :: 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.
drsResponseStatus :: Lens' DescribeAddressesResponse Int Source #
- - | The response status code.