PinpointSMSVoiceV2 / Client / describe_registrations

describe_registrations#

PinpointSMSVoiceV2.Client.describe_registrations(**kwargs)#

Retrieves the specified registrations.

See also: AWS API Documentation

Request Syntax

response = client.describe_registrations(
    RegistrationIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'registration-type'|'registration-status',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • RegistrationIds (list) –

    An array of unique identifiers for each registration.

    • (string) –

  • Filters (list) –

    An array of RegistrationFilter objects to filter the results.

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

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

{
    'Registrations': [
        {
            'RegistrationArn': 'string',
            'RegistrationId': 'string',
            'RegistrationType': 'string',
            'RegistrationStatus': 'CREATED'|'SUBMITTED'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'PROVISIONING'|'COMPLETE'|'REQUIRES_UPDATES'|'CLOSED'|'DELETED',
            'CurrentVersionNumber': 123,
            'ApprovedVersionNumber': 123,
            'LatestDeniedVersionNumber': 123,
            'AdditionalAttributes': {
                'string': 'string'
            },
            'CreatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Registrations (list) –

      An array of RegistrationInformation objects.

      • (dict) –

        Provides information about the requested registration.

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

        • RegistrationStatus (string) –

          The status of the registration.

          • CREATED: Your registration is created but not submitted.

          • SUBMITTED: Your registration has been submitted and is awaiting review.

          • REVIEWING: Your registration has been accepted and is being reviewed.

          • PROVISIONING: Your registration has been approved and your origination identity is being created.

          • COMPLETE: Your registration has been approved and and your origination identity has been created.

          • REQUIRES_UPDATES: You must fix your registration and resubmit it.

          • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.

          • DELETED: The registration has been deleted.

        • CurrentVersionNumber (integer) –

          The current version number of the registration.

        • ApprovedVersionNumber (integer) –

          The version number of the registration that was approved.

        • LatestDeniedVersionNumber (integer) –

          The latest version number of the registration that was denied.

        • AdditionalAttributes (dict) –

          Metadata about a given registration which is specific to that registration type.

          • (string) –

            • (string) –

        • CreatedTimestamp (datetime) –

          The time when the registration was created, in UNIX epoch time 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

  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

  • PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException

  • PinpointSMSVoiceV2.Client.exceptions.ValidationException

  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException