PinpointSMSVoiceV2 / Paginator / DescribeRcsAgentCountryLaunchStatus

DescribeRcsAgentCountryLaunchStatus

class PinpointSMSVoiceV2.Paginator.DescribeRcsAgentCountryLaunchStatus

paginator = client.get_paginator('describe_rcs_agent_country_launch_status')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RcsAgentId='string',
    IsoCountryCodes=[
        'string',
    ],
    Filters=[
        {
            'Name': 'country-launch-status',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• RcsAgentId (string) –

  [REQUIRED]

  The unique identifier of the RCS agent. You can use either the RcsAgentId or RcsAgentArn.

• IsoCountryCodes (list) –

  An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, to filter the results.

  • (string) –

• Filters (list) –

  An array of CountryLaunchStatusFilter objects to filter the results.

  • (dict) –

    The information for a country launch status that meets 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

{
    'RcsAgentId': 'string',
    'RcsAgentArn': 'string',
    'CountryLaunchStatus': [
        {
            'IsoCountryCode': 'string',
            'Status': 'CREATED'|'PENDING'|'PARTIAL'|'ACTIVE'|'REJECTED',
            'RcsPlatformId': 'string',
            'RegistrationId': 'string',
            'CarrierStatus': [
                {
                    'CarrierName': 'string',
                    'Status': 'PENDING'|'ACTIVE'|'REJECTED'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • RcsAgentId (string) –

    The unique identifier for the RCS agent.

  • RcsAgentArn (string) –

    The Amazon Resource Name (ARN) of the RCS agent.

  • CountryLaunchStatus (list) –

    An array of CountryLaunchStatusInformation objects that contain the per-country launch status details.

    • (dict) –

      Contains per-country launch status details for an RCS agent.

      • IsoCountryCode (string) –

        The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      • Status (string) –

        The launch status for this country.

      • RcsPlatformId (string) –

        The RCS platform identifier for this country.

      • RegistrationId (string) –

        The unique identifier of the registration associated with this country launch.

      • CarrierStatus (list) –

        An array of CarrierStatusInformation objects containing carrier-level launch status details.

        • (dict) –

          Contains carrier-level launch status details for an RCS agent within a country.

          • CarrierName (string) –

            The name of the carrier.

          • Status (string) –

            The launch status for this carrier.