[ aws . sesv2 ]

list-deliverability-test-reports

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-deliverability-test-reports
[--next-token <value>]
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

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

--page-size (integer)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

DeliverabilityTestReports -> (list)

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

(structure)

An object that contains metadata related to a predictive inbox placement test.

ReportId -> (string)

A unique string that identifies the predictive inbox placement test.

ReportName -> (string)

A name that helps you identify a predictive inbox placement test report.

Subject -> (string)

The subject line for an email that you submitted in a predictive inbox placement test.

FromEmailAddress -> (string)

The sender address that you specified for the predictive inbox placement test.

CreateDate -> (timestamp)

The date and time when the predictive inbox placement test was created, in Unix time format.

DeliverabilityTestStatus -> (string)

The status of the predictive inbox placement test. If the status is IN_PROGRESS , then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE , then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

NextToken -> (string)

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.