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.GetDedicatedIps

Description

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

This operation returns paginated results.

Synopsis

Creating a Request

data GetDedicatedIps Source #

A request to obtain more information about dedicated IP pools.

See: newGetDedicatedIps smart constructor.

Constructors

GetDedicatedIps' 

Fields

  • poolName :: Maybe Text

    The name of the IP pool that the dedicated IP address is associated with.

  • nextToken :: Maybe Text

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

  • pageSize :: Maybe Int

    The number of results to show in a single call to GetDedicatedIpsRequest. 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 GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Read GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Show GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Generic GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Associated Types

type Rep GetDedicatedIps :: Type -> Type #

NFData GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

rnf :: GetDedicatedIps -> () #

Hashable GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

AWSPager GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

AWSRequest GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Associated Types

type AWSResponse GetDedicatedIps #

ToHeaders GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

ToPath GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

ToQuery GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

type Rep GetDedicatedIps Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

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

Defined in Amazonka.PinpointEmail.GetDedicatedIps

newGetDedicatedIps :: GetDedicatedIps Source #

Create a value of GetDedicatedIps 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:poolName:GetDedicatedIps', getDedicatedIps_poolName - The name of the IP pool that the dedicated IP address is associated with.

$sel:nextToken:GetDedicatedIps', getDedicatedIps_nextToken - A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

$sel:pageSize:GetDedicatedIps', getDedicatedIps_pageSize - The number of results to show in a single call to GetDedicatedIpsRequest. 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

getDedicatedIps_poolName :: Lens' GetDedicatedIps (Maybe Text) Source #

The name of the IP pool that the dedicated IP address is associated with.

getDedicatedIps_nextToken :: Lens' GetDedicatedIps (Maybe Text) Source #

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

getDedicatedIps_pageSize :: Lens' GetDedicatedIps (Maybe Int) Source #

The number of results to show in a single call to GetDedicatedIpsRequest. 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 GetDedicatedIpsResponse Source #

Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.

See: newGetDedicatedIpsResponse smart constructor.

Constructors

GetDedicatedIpsResponse' 

Fields

  • nextToken :: Maybe Text

    A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

  • dedicatedIps :: Maybe [DedicatedIp]

    A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetDedicatedIpsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Read GetDedicatedIpsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Show GetDedicatedIpsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Generic GetDedicatedIpsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Associated Types

type Rep GetDedicatedIpsResponse :: Type -> Type #

NFData GetDedicatedIpsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

rnf :: GetDedicatedIpsResponse -> () #

type Rep GetDedicatedIpsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetDedicatedIps

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

newGetDedicatedIpsResponse Source #

Create a value of GetDedicatedIpsResponse 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:GetDedicatedIps', getDedicatedIpsResponse_nextToken - A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

$sel:dedicatedIps:GetDedicatedIpsResponse', getDedicatedIpsResponse_dedicatedIps - A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.

$sel:httpStatus:GetDedicatedIpsResponse', getDedicatedIpsResponse_httpStatus - The response's http status code.

Response Lenses

getDedicatedIpsResponse_nextToken :: Lens' GetDedicatedIpsResponse (Maybe Text) Source #

A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

getDedicatedIpsResponse_dedicatedIps :: Lens' GetDedicatedIpsResponse (Maybe [DedicatedIp]) Source #

A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.