Skip to content

Describe Opt Out Lists

pinpointsmsvoicev2_describe_opt_out_lists R Documentation

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

Description

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.

Usage

pinpointsmsvoicev2_describe_opt_out_lists(OptOutListNames, NextToken,
  MaxResults, Owner)

Arguments

OptOutListNames

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

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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.

MaxResults

The maximum number of results to return per each request.

Owner

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

Value

A list with the following syntax: 

list(
  OptOutLists = list(
    list(
      OptOutListArn = "string",
      OptOutListName = "string",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_opt_out_lists(
  OptOutListNames = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123,
  Owner = "SELF"|"SHARED"
)