DescribeKeywords

class PinpointSMSVoiceV2.Paginator.DescribeKeywords

paginator = client.get_paginator('describe_keywords')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_keywords().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OriginationIdentity='string',
    Keywords=[
        'string',
    ],
    Filters=[
        {
            'Name': 'keyword-action',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• OriginationIdentity (string) --

  [REQUIRED]

  The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

• Keywords (list) --

  An array of keywords to search for.

  • (string) --
• Filters (list) --

  An array of keyword filters to filter the results.

  • (dict) --

    The information for keywords that meet a specified criteria.

    • Name (string) -- [REQUIRED]

      The name of the attribute to filter on.

    • Values (list) -- [REQUIRED]

      An array values to filter for.

      • (string) --
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

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

Return type

dict

Returns

Response Syntax

{
    'OriginationIdentityArn': 'string',
    'OriginationIdentity': 'string',
    'Keywords': [
        {
            'Keyword': 'string',
            'KeywordMessage': 'string',
            'KeywordAction': 'AUTOMATIC_RESPONSE'|'OPT_OUT'|'OPT_IN'
        },
    ],

}

Response Structure

• (dict) --

  • OriginationIdentityArn (string) --

    The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

  • OriginationIdentity (string) --

    The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

  • Keywords (list) --

    An array of KeywordInformation objects that contain the results.

    • (dict) --

      The information for all keywords in a pool.

      • Keyword (string) --

        The keyword as a string.

      • KeywordMessage (string) --

        A custom message that can be used with the keyword.

      • KeywordAction (string) --

        The action to perform for the keyword.