| 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.PinpointEmail.ListDedicatedIpPools
Description
List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.
This operation returns paginated results.
Synopsis
- data ListDedicatedIpPools = ListDedicatedIpPools' {}
- newListDedicatedIpPools :: ListDedicatedIpPools
- listDedicatedIpPools_nextToken :: Lens' ListDedicatedIpPools (Maybe Text)
- listDedicatedIpPools_pageSize :: Lens' ListDedicatedIpPools (Maybe Int)
- data ListDedicatedIpPoolsResponse = ListDedicatedIpPoolsResponse' {
- dedicatedIpPools :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListDedicatedIpPoolsResponse :: Int -> ListDedicatedIpPoolsResponse
- listDedicatedIpPoolsResponse_dedicatedIpPools :: Lens' ListDedicatedIpPoolsResponse (Maybe [Text])
- listDedicatedIpPoolsResponse_nextToken :: Lens' ListDedicatedIpPoolsResponse (Maybe Text)
- listDedicatedIpPoolsResponse_httpStatus :: Lens' ListDedicatedIpPoolsResponse Int
Creating a Request
data ListDedicatedIpPools Source #
A request to obtain a list of dedicated IP pools.
See: newListDedicatedIpPools smart constructor.
Constructors
| ListDedicatedIpPools' | |
Fields
| |
Instances
newListDedicatedIpPools :: ListDedicatedIpPools Source #
Create a value of ListDedicatedIpPools 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:ListDedicatedIpPools', listDedicatedIpPools_nextToken - A token returned from a previous call to ListDedicatedIpPools to
indicate the position in the list of dedicated IP pools.
$sel:pageSize:ListDedicatedIpPools', listDedicatedIpPools_pageSize - The number of results to show in a single call to
ListDedicatedIpPools. If the number of results is larger than the
number you specified in this parameter, then the response includes a
NextToken element, which you can use to obtain additional results.
Request Lenses
listDedicatedIpPools_nextToken :: Lens' ListDedicatedIpPools (Maybe Text) Source #
A token returned from a previous call to ListDedicatedIpPools to
indicate the position in the list of dedicated IP pools.
listDedicatedIpPools_pageSize :: Lens' ListDedicatedIpPools (Maybe Int) Source #
The number of results to show in a single call to
ListDedicatedIpPools. If the number of results is larger than the
number you specified in this parameter, then the response includes a
NextToken element, which you can use to obtain additional results.
Destructuring the Response
data ListDedicatedIpPoolsResponse Source #
A list of dedicated IP pools.
See: newListDedicatedIpPoolsResponse smart constructor.
Constructors
| ListDedicatedIpPoolsResponse' | |
Fields
| |
Instances
newListDedicatedIpPoolsResponse Source #
Create a value of ListDedicatedIpPoolsResponse 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:dedicatedIpPools:ListDedicatedIpPoolsResponse', listDedicatedIpPoolsResponse_dedicatedIpPools - A list of all of the dedicated IP pools that are associated with your
Amazon Pinpoint account.
$sel:nextToken:ListDedicatedIpPools', listDedicatedIpPoolsResponse_nextToken - A token that indicates that there are additional IP pools to list. To
view additional IP pools, issue another request to
ListDedicatedIpPools, passing this token in the NextToken parameter.
$sel:httpStatus:ListDedicatedIpPoolsResponse', listDedicatedIpPoolsResponse_httpStatus - The response's http status code.
Response Lenses
listDedicatedIpPoolsResponse_dedicatedIpPools :: Lens' ListDedicatedIpPoolsResponse (Maybe [Text]) Source #
A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.
listDedicatedIpPoolsResponse_nextToken :: Lens' ListDedicatedIpPoolsResponse (Maybe Text) Source #
A token that indicates that there are additional IP pools to list. To
view additional IP pools, issue another request to
ListDedicatedIpPools, passing this token in the NextToken parameter.
listDedicatedIpPoolsResponse_httpStatus :: Lens' ListDedicatedIpPoolsResponse Int Source #
The response's http status code.