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

Description

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDeliverabilityTestReports Source #

A request to list all of the predictive inbox placement tests that you've performed.

See: newListDeliverabilityTestReports smart constructor.

Constructors

ListDeliverabilityTestReports' 

Fields

  • nextToken :: Maybe Text

    A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

  • pageSize :: Maybe Int

    The number of results to show in a single call to ListDeliverabilityTestReports. 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.

    The value you specify has to be at least 0, and can be no more than 1000.

Instances

Instances details
Eq ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Read ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Show ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Generic ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Associated Types

type Rep ListDeliverabilityTestReports :: Type -> Type #

NFData ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Hashable ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

AWSPager ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

AWSRequest ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

ToHeaders ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

ToPath ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

ToQuery ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

type Rep ListDeliverabilityTestReports Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

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

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

newListDeliverabilityTestReports :: ListDeliverabilityTestReports Source #

Create a value of ListDeliverabilityTestReports 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:ListDeliverabilityTestReports', listDeliverabilityTestReports_nextToken - A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

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

The value you specify has to be at least 0, and can be no more than 1000.

Request Lenses

listDeliverabilityTestReports_nextToken :: Lens' ListDeliverabilityTestReports (Maybe Text) Source #

A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

listDeliverabilityTestReports_pageSize :: Lens' ListDeliverabilityTestReports (Maybe Int) Source #

The number of results to show in a single call to ListDeliverabilityTestReports. 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.

The value you specify has to be at least 0, and can be no more than 1000.

Destructuring the Response

data ListDeliverabilityTestReportsResponse Source #

A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.

See: newListDeliverabilityTestReportsResponse smart constructor.

Constructors

ListDeliverabilityTestReportsResponse' 

Fields

  • nextToken :: Maybe Text

    A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

  • httpStatus :: Int

    The response's http status code.

  • deliverabilityTestReports :: [DeliverabilityTestReport]

    An object that contains a lists of predictive inbox placement tests that you've performed.

Instances

Instances details
Eq ListDeliverabilityTestReportsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Read ListDeliverabilityTestReportsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Show ListDeliverabilityTestReportsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

Generic ListDeliverabilityTestReportsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

NFData ListDeliverabilityTestReportsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

type Rep ListDeliverabilityTestReportsResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.ListDeliverabilityTestReports

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

newListDeliverabilityTestReportsResponse Source #

Create a value of ListDeliverabilityTestReportsResponse 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:ListDeliverabilityTestReports', listDeliverabilityTestReportsResponse_nextToken - A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

$sel:httpStatus:ListDeliverabilityTestReportsResponse', listDeliverabilityTestReportsResponse_httpStatus - The response's http status code.

$sel:deliverabilityTestReports:ListDeliverabilityTestReportsResponse', listDeliverabilityTestReportsResponse_deliverabilityTestReports - An object that contains a lists of predictive inbox placement tests that you've performed.

Response Lenses

listDeliverabilityTestReportsResponse_nextToken :: Lens' ListDeliverabilityTestReportsResponse (Maybe Text) Source #

A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

listDeliverabilityTestReportsResponse_deliverabilityTestReports :: Lens' ListDeliverabilityTestReportsResponse [DeliverabilityTestReport] Source #

An object that contains a lists of predictive inbox placement tests that you've performed.