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.

See also: AWS API Documentation

Request Syntax

response = client.describe_opt_out_lists(
  • OptOutListNames (list) --

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

    • (string) --
  • NextToken (string) -- 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 (integer) -- The maximum number of results to return per each request.
Return type



Response Syntax

    'OptOutLists': [
            'OptOutListArn': 'string',
            'OptOutListName': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1)
    'NextToken': 'string'

Response Structure

  • (dict) --

    • OptOutLists (list) --

      An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

      • (dict) --

        The information for all OptOutList in an Amazon Web Services account.

        • OptOutListArn (string) --

          The Amazon Resource Name (ARN) of the OptOutList.

        • OptOutListName (string) --

          The name of the OptOutList.

        • CreatedTimestamp (datetime) --

          The time when the OutOutList was created, in UNIX epoch time format.

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


  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
  • PinpointSMSVoiceV2.Client.exceptions.ValidationException
  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException