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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

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 Methods (==) :: GetDedicatedIps -> GetDedicatedIps -> Bool # (/=) :: GetDedicatedIps -> GetDedicatedIps -> Bool #
Read GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods readsPrec :: Int -> ReadS GetDedicatedIps # readList :: ReadS [GetDedicatedIps] # readPrec :: ReadPrec GetDedicatedIps # readListPrec :: ReadPrec [GetDedicatedIps] #
Show GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods showsPrec :: Int -> GetDedicatedIps -> ShowS # show :: GetDedicatedIps -> String # showList :: [GetDedicatedIps] -> ShowS #
Generic GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Associated Types type Rep GetDedicatedIps :: Type -> Type # Methods from :: GetDedicatedIps -> Rep GetDedicatedIps x # to :: Rep GetDedicatedIps x -> GetDedicatedIps #
NFData GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods rnf :: GetDedicatedIps -> () #
Hashable GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods hashWithSalt :: Int -> GetDedicatedIps -> Int # hash :: GetDedicatedIps -> Int #
AWSPager GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods page :: GetDedicatedIps -> AWSResponse GetDedicatedIps -> Maybe GetDedicatedIps #
AWSRequest GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Associated Types type AWSResponse GetDedicatedIps # Methods request :: GetDedicatedIps -> Request GetDedicatedIps # response :: MonadResource m => Logger -> Service -> Proxy GetDedicatedIps -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDedicatedIps))) #
ToHeaders GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods toHeaders :: GetDedicatedIps -> [Header] #
ToPath GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods toPath :: GetDedicatedIps -> ByteString #
ToQuery GetDedicatedIps Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods toQuery :: GetDedicatedIps -> QueryString #
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 type AWSResponse GetDedicatedIps = GetDedicatedIpsResponse

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 Methods (==) :: GetDedicatedIpsResponse -> GetDedicatedIpsResponse -> Bool # (/=) :: GetDedicatedIpsResponse -> GetDedicatedIpsResponse -> Bool #
Read GetDedicatedIpsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods readsPrec :: Int -> ReadS GetDedicatedIpsResponse # readList :: ReadS [GetDedicatedIpsResponse] # readPrec :: ReadPrec GetDedicatedIpsResponse # readListPrec :: ReadPrec [GetDedicatedIpsResponse] #
Show GetDedicatedIpsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Methods showsPrec :: Int -> GetDedicatedIpsResponse -> ShowS # show :: GetDedicatedIpsResponse -> String # showList :: [GetDedicatedIpsResponse] -> ShowS #
Generic GetDedicatedIpsResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetDedicatedIps Associated Types type Rep GetDedicatedIpsResponse :: Type -> Type # Methods from :: GetDedicatedIpsResponse -> Rep GetDedicatedIpsResponse x # to :: Rep GetDedicatedIpsResponse x -> GetDedicatedIpsResponse #
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 #

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

getDedicatedIpsResponse_httpStatus :: Lens' GetDedicatedIpsResponse Int Source #

The response's http status code.