[ aws . pinpoint-sms-voice-v2 ]

describe-opted-out-numbers

Description

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don’t specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn’t valid, an Error is returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-opted-out-numbers is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: OptedOutNumbers

Synopsis

  describe-opted-out-numbers
--opt-out-list-name <value>
[--opted-out-numbers <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--opt-out-list-name (string)

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

--opted-out-numbers (list)

An array of phone numbers to search for in the OptOutList.

(string)

Syntax:

"string" "string" ...

--filters (list)

An array of OptedOutFilter objects to filter the results on.

(structure)

The information for opted out numbers that meet a specified criteria.

Name -> (string)

The name of the attribute to filter on.

Values -> (list)

An array of values to filter for.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "end-user-opted-out",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

OptOutListArn -> (string)

The Amazon Resource Name (ARN) of the OptOutList.

OptOutListName -> (string)

The name of the OptOutList.

OptedOutNumbers -> (list)

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

(structure)

The information for an opted out number in an Amazon Web Services account.

OptedOutNumber -> (string)

The phone number that is opted out.

OptedOutTimestamp -> (timestamp)

The time that the op tout occurred, in UNIX epoch time format.

EndUserOptedOut -> (boolean)

This is set to true if it was the end recipient that opted out.

NextToken -> (string)

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