Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Describes the specified opt-out list or all opt-out lists in your account.

If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.

If you specify an opt-out list name that isn't valid, an Error is returned.

This operation returns paginated results.

Creating a Request

data DescribeOptOutLists

See: newDescribeOptOutLists smart constructor.

Constructors

DescribeOptOutLists'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to return per each request.

• nextToken :: Maybe Text

  The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

• optOutListNames :: Maybe [Text]

  The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

Instances

ToJSON DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

toJSON :: DescribeOptOutLists -> Value

toEncoding :: DescribeOptOutLists -> Encoding

toJSONList :: [DescribeOptOutLists] -> Value

toEncodingList :: [DescribeOptOutLists] -> Encoding

ToHeaders DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

toHeaders :: DescribeOptOutLists -> [Header]

ToPath DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

toPath :: DescribeOptOutLists -> ByteString

ToQuery DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

toQuery :: DescribeOptOutLists -> QueryString

AWSPager DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

page :: DescribeOptOutLists -> AWSResponse DescribeOptOutLists -> Maybe DescribeOptOutLists

AWSRequest DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Associated Types

type AWSResponse DescribeOptOutLists

Methods

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

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

Generic DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Associated Types

type Rep DescribeOptOutLists :: Type -> Type

Methods

from :: DescribeOptOutLists -> Rep DescribeOptOutLists x

to :: Rep DescribeOptOutLists x -> DescribeOptOutLists

Read DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

readsPrec :: Int -> ReadS DescribeOptOutLists

readList :: ReadS [DescribeOptOutLists]

readPrec :: ReadPrec DescribeOptOutLists

readListPrec :: ReadPrec [DescribeOptOutLists]

Show DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

showsPrec :: Int -> DescribeOptOutLists -> ShowS

show :: DescribeOptOutLists -> String

showList :: [DescribeOptOutLists] -> ShowS

NFData DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

rnf :: DescribeOptOutLists -> ()

Eq DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

(==) :: DescribeOptOutLists -> DescribeOptOutLists -> Bool

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

Hashable DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

hashWithSalt :: Int -> DescribeOptOutLists -> Int

hash :: DescribeOptOutLists -> Int

type AWSResponse DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

type AWSResponse DescribeOptOutLists = DescribeOptOutListsResponse

type Rep DescribeOptOutLists

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

type Rep DescribeOptOutLists = D1 ('MetaData "DescribeOptOutLists" "Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DescribeOptOutLists'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "optOutListNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeOptOutLists :: DescribeOptOutLists

Create a value of DescribeOptOutLists 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:maxResults:DescribeOptOutLists', describeOptOutLists_maxResults - The maximum number of results to return per each request.

DescribeOptOutLists, describeOptOutLists_nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

$sel:optOutListNames:DescribeOptOutLists', describeOptOutLists_optOutListNames - The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

Request Lenses

describeOptOutLists_maxResults :: Lens' DescribeOptOutLists (Maybe Natural)

The maximum number of results to return per each request.

describeOptOutLists_nextToken :: Lens' DescribeOptOutLists (Maybe Text)

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

describeOptOutLists_optOutListNames :: Lens' DescribeOptOutLists (Maybe [Text])

The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

Destructuring the Response

data DescribeOptOutListsResponse

See: newDescribeOptOutListsResponse smart constructor.

Constructors

DescribeOptOutListsResponse'

Fields

• nextToken :: Maybe Text

  The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• optOutLists :: Maybe [OptOutListInformation]

  An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeOptOutListsResponse

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Associated Types

type Rep DescribeOptOutListsResponse :: Type -> Type

Methods

from :: DescribeOptOutListsResponse -> Rep DescribeOptOutListsResponse x

to :: Rep DescribeOptOutListsResponse x -> DescribeOptOutListsResponse

Read DescribeOptOutListsResponse

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

readsPrec :: Int -> ReadS DescribeOptOutListsResponse

readList :: ReadS [DescribeOptOutListsResponse]

readPrec :: ReadPrec DescribeOptOutListsResponse

readListPrec :: ReadPrec [DescribeOptOutListsResponse]

Show DescribeOptOutListsResponse

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

showsPrec :: Int -> DescribeOptOutListsResponse -> ShowS

show :: DescribeOptOutListsResponse -> String

showList :: [DescribeOptOutListsResponse] -> ShowS

NFData DescribeOptOutListsResponse

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

rnf :: DescribeOptOutListsResponse -> ()

Eq DescribeOptOutListsResponse

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

Methods

(==) :: DescribeOptOutListsResponse -> DescribeOptOutListsResponse -> Bool

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

type Rep DescribeOptOutListsResponse

Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists

type Rep DescribeOptOutListsResponse = D1 ('MetaData "DescribeOptOutListsResponse" "Amazonka.PinpointSmsVoiceV2.DescribeOptOutLists" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DescribeOptOutListsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "optOutLists") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptOutListInformation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOptOutListsResponse

Arguments

:: Int

$sel:httpStatus:DescribeOptOutListsResponse'

-> DescribeOptOutListsResponse

Create a value of DescribeOptOutListsResponse 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:

DescribeOptOutLists, describeOptOutListsResponse_nextToken - The token to be used for the next set of paginated results. If this field is empty then there are no more results.

$sel:optOutLists:DescribeOptOutListsResponse', describeOptOutListsResponse_optOutLists - An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

$sel:httpStatus:DescribeOptOutListsResponse', describeOptOutListsResponse_httpStatus - The response's http status code.

Response Lenses

describeOptOutListsResponse_nextToken :: Lens' DescribeOptOutListsResponse (Maybe Text)

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

describeOptOutListsResponse_optOutLists :: Lens' DescribeOptOutListsResponse (Maybe [OptOutListInformation])

An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

describeOptOutListsResponse_httpStatus :: Lens' DescribeOptOutListsResponse Int

The response's http status code.