libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email
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.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

Creating a Request

data ListDedicatedIpPools Source #

A request to obtain a list of dedicated IP pools.

See: newListDedicatedIpPools smart constructor.

Constructors

ListDedicatedIpPools' 

Fields

  • nextToken :: Maybe Text

    A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.

  • pageSize :: Maybe Int

    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.

Instances

Instances details
Eq ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Read ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Show ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Generic ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Associated Types

type Rep ListDedicatedIpPools :: Type -> Type #

NFData ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Methods

rnf :: ListDedicatedIpPools -> () #

Hashable ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

AWSPager ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

AWSRequest ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Associated Types

type AWSResponse ListDedicatedIpPools #

ToHeaders ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

ToPath ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

ToQuery ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

type Rep ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

type Rep ListDedicatedIpPools = D1 ('MetaData "ListDedicatedIpPools" "Amazonka.PinpointEmail.ListDedicatedIpPools" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "ListDedicatedIpPools'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))
type AWSResponse ListDedicatedIpPools Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

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

  • dedicatedIpPools :: Maybe [Text]

    A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListDedicatedIpPoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Read ListDedicatedIpPoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Show ListDedicatedIpPoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Generic ListDedicatedIpPoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

Associated Types

type Rep ListDedicatedIpPoolsResponse :: Type -> Type #

NFData ListDedicatedIpPoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

type Rep ListDedicatedIpPoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDedicatedIpPools

type Rep ListDedicatedIpPoolsResponse = D1 ('MetaData "ListDedicatedIpPoolsResponse" "Amazonka.PinpointEmail.ListDedicatedIpPools" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "ListDedicatedIpPoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dedicatedIpPools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.