PinpointSMSVoiceV2 / Client / delete_registration

delete_registration#

PinpointSMSVoiceV2.Client.delete_registration(**kwargs)#

Permanently delete an existing registration from your account.

See also: AWS API Documentation

Request Syntax

response = client.delete_registration(
    RegistrationId='string'
)
Parameters:

RegistrationId (string) –

[REQUIRED]

The unique identifier for the registration.

Return type:

dict

Returns:

Response Syntax

{
    '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)
}

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.

    • RegistrationStatus (string) –

      The status of the registration.

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

      • CREATED: Your registration is created but not submitted.

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

      • DELETED: The registration has been deleted.

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

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

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

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

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

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

Exceptions