PinpointSMSVoiceV2 / Client / list_registration_associations

list_registration_associations#

PinpointSMSVoiceV2.Client.list_registration_associations(**kwargs)#

Retrieve all of the origination identities that are associated with a registration.

See also: AWS API Documentation

Request Syntax

response = client.list_registration_associations(
    RegistrationId='string',
    Filters=[
        {
            'Name': 'resource-type'|'iso-country-code',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • RegistrationId (string) –

    [REQUIRED]

    The unique identifier for the registration.

  • Filters (list) –

    An array of RegistrationAssociationFilter to apply to the results that are returned.

    • (dict) –

      The filter definition for filtering registrations that meets a specified criteria.

      • Name (string) – [REQUIRED]

        The name of the attribute to filter on.

      • Values (list) – [REQUIRED]

        An array of values to filter for.

        • (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:

dict

Returns:

Response Syntax

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'RegistrationType': 'string',
    'RegistrationAssociations': [
        {
            'ResourceArn': 'string',
            'ResourceId': 'string',
            'ResourceType': 'string',
            'IsoCountryCode': 'string',
            'PhoneNumber': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RegistrationArn (string) –

      The Amazon Resource Name (ARN) for the registration.

    • RegistrationId (string) –

      The unique identifier for the registration.

    • RegistrationType (string) –

      The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    • RegistrationAssociations (list) –

      An array of RegistrationAssociationMetadata objects.

      • (dict) –

        Metadata for the origination identity that is associated with the registration.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

        • ResourceId (string) –

          The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

        • ResourceType (string) –

          The origination identity type.

        • IsoCountryCode (string) –

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

        • PhoneNumber (string) –

          The phone number associated with the registration in E.164 format.

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

Exceptions