Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

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.

post/#X-Amz-Target=PinpointSMSVoiceV2.DescribeOptOutLists

Headers

X-Amz-Target'PinpointSMSVoiceV2.DescribeOptOutLists' required

Request body

OptOutListNamesOptOutListNameOrArn[]
<p>The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
NextTokenstring

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.

MaxResultsinteger

The maximum number of results to return per each request.

Owner'SELF' | 'SHARED'

Use <code>SELF</code> to filter the list of Opt-Out List to ones your account owns or use <code>SHARED</code> to filter on Opt-Out List shared with your account. The <code>Owner</code> and <code>OptOutListNames</code> parameters can't be used at the same time.

Response

Success

NextTokenstring

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