Amazonka.PinpointEmail.GetDedicatedIps

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

This operation returns paginated results.

Creating a Request

data GetDedicatedIps

A request to obtain more information about dedicated IP pools.

See: newGetDedicatedIps smart constructor.

Constructors

GetDedicatedIps'

Fields

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

• poolName :: Maybe Text

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

Instances

ToHeaders GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

toHeaders :: GetDedicatedIps -> [Header]

ToPath GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

toPath :: GetDedicatedIps -> ByteString

ToQuery GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

toQuery :: GetDedicatedIps -> QueryString

AWSPager GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

page :: GetDedicatedIps -> AWSResponse GetDedicatedIps -> Maybe GetDedicatedIps

AWSRequest GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Associated Types

type AWSResponse GetDedicatedIps

Methods

request :: (Service -> Service) -> GetDedicatedIps -> Request GetDedicatedIps

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDedicatedIps -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDedicatedIps)))

Generic GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Associated Types

type Rep GetDedicatedIps :: Type -> Type

Methods

from :: GetDedicatedIps -> Rep GetDedicatedIps x

to :: Rep GetDedicatedIps x -> GetDedicatedIps

Read GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

readsPrec :: Int -> ReadS GetDedicatedIps

readList :: ReadS [GetDedicatedIps]

readPrec :: ReadPrec GetDedicatedIps

readListPrec :: ReadPrec [GetDedicatedIps]

Show GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

showsPrec :: Int -> GetDedicatedIps -> ShowS

show :: GetDedicatedIps -> String

showList :: [GetDedicatedIps] -> ShowS

NFData GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

rnf :: GetDedicatedIps -> ()

Eq GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

(==) :: GetDedicatedIps -> GetDedicatedIps -> Bool

(/=) :: GetDedicatedIps -> GetDedicatedIps -> Bool

Hashable GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

hashWithSalt :: Int -> GetDedicatedIps -> Int

hash :: GetDedicatedIps -> Int

type AWSResponse GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

type AWSResponse GetDedicatedIps = GetDedicatedIpsResponse

type Rep GetDedicatedIps

Defined in Amazonka.PinpointEmail.GetDedicatedIps

type Rep GetDedicatedIps = D1 ('MetaData "GetDedicatedIps" "Amazonka.PinpointEmail.GetDedicatedIps" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "GetDedicatedIps'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "poolName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newGetDedicatedIps :: GetDedicatedIps

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:

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.

GetDedicatedIps, getDedicatedIps_poolName - The name of the IP pool that the dedicated IP address is associated with.

Request Lenses

getDedicatedIps_nextToken :: Lens' GetDedicatedIps (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.

getDedicatedIps_pageSize :: Lens' GetDedicatedIps (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.

getDedicatedIps_poolName :: Lens' GetDedicatedIps (Maybe Text)

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

Destructuring the Response

data GetDedicatedIpsResponse

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

See: newGetDedicatedIpsResponse smart constructor.

Constructors

GetDedicatedIpsResponse'

Fields

• dedicatedIps :: Maybe [DedicatedIp]

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

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetDedicatedIpsResponse

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Associated Types

type Rep GetDedicatedIpsResponse :: Type -> Type

Methods

from :: GetDedicatedIpsResponse -> Rep GetDedicatedIpsResponse x

to :: Rep GetDedicatedIpsResponse x -> GetDedicatedIpsResponse

Read GetDedicatedIpsResponse

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

readsPrec :: Int -> ReadS GetDedicatedIpsResponse

readList :: ReadS [GetDedicatedIpsResponse]

readPrec :: ReadPrec GetDedicatedIpsResponse

readListPrec :: ReadPrec [GetDedicatedIpsResponse]

Show GetDedicatedIpsResponse

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

showsPrec :: Int -> GetDedicatedIpsResponse -> ShowS

show :: GetDedicatedIpsResponse -> String

showList :: [GetDedicatedIpsResponse] -> ShowS

NFData GetDedicatedIpsResponse

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

rnf :: GetDedicatedIpsResponse -> ()

Eq GetDedicatedIpsResponse

Defined in Amazonka.PinpointEmail.GetDedicatedIps

Methods

(==) :: GetDedicatedIpsResponse -> GetDedicatedIpsResponse -> Bool

(/=) :: GetDedicatedIpsResponse -> GetDedicatedIpsResponse -> Bool

type Rep GetDedicatedIpsResponse

Defined in Amazonka.PinpointEmail.GetDedicatedIps

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

newGetDedicatedIpsResponse

Arguments

:: Int

$sel:httpStatus:GetDedicatedIpsResponse'

-> GetDedicatedIpsResponse

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:dedicatedIps:GetDedicatedIpsResponse', getDedicatedIpsResponse_dedicatedIps - A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.

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:httpStatus:GetDedicatedIpsResponse', getDedicatedIpsResponse_httpStatus - The response's http status code.

Response Lenses

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

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

getDedicatedIpsResponse_nextToken :: Lens' GetDedicatedIpsResponse (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.

getDedicatedIpsResponse_httpStatus :: Lens' GetDedicatedIpsResponse Int

The response's http status code.