PinpointSMSVoiceV2 / Client / discard_registration_version

discard_registration_version#

PinpointSMSVoiceV2.Client.discard_registration_version(**kwargs)#

Discard the current version of the registration.

See also: AWS API Documentation

Request Syntax

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

RegistrationId (string) –

[REQUIRED]

The unique identifier for the registration.

Return type:

dict

Returns:

Response Syntax

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'VersionNumber': 123,
    'RegistrationVersionStatus': 'DRAFT'|'SUBMITTED'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'APPROVED'|'DISCARDED'|'DENIED'|'REVOKED'|'ARCHIVED',
    'RegistrationVersionStatusHistory': {
        'DraftTimestamp': datetime(2015, 1, 1),
        'SubmittedTimestamp': datetime(2015, 1, 1),
        'ReviewingTimestamp': datetime(2015, 1, 1),
        'RequiresAuthenticationTimestamp': datetime(2015, 1, 1),
        'ApprovedTimestamp': datetime(2015, 1, 1),
        'DiscardedTimestamp': datetime(2015, 1, 1),
        'DeniedTimestamp': datetime(2015, 1, 1),
        'RevokedTimestamp': datetime(2015, 1, 1),
        'ArchivedTimestamp': 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.

    • VersionNumber (integer) –

      The version number of the registration.

    • RegistrationVersionStatus (string) –

      The status of the registration version.

      • APPROVED: Your registration has been approved.

      • ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.

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

      • DISCARDED: You’ve abandon this version of their registration to start over with a new version.

      • DRAFT: The initial status of a registration version after it’s created.

      • REQUIRES_AUTHENTICATION: You need to complete email authentication.

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

      • REVOKED: Your previously approved registration has been revoked.

      • SUBMITTED: Your registration has been submitted.

    • RegistrationVersionStatusHistory (dict) –

      The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

      • DraftTimestamp (datetime) –

        The time when the registration was in the draft state, in UNIX epoch time format.

      • SubmittedTimestamp (datetime) –

        The time when the registration was in the submitted state, in UNIX epoch time format.

      • ReviewingTimestamp (datetime) –

        The time when the registration was in the reviewing state, in UNIX epoch time format.

      • RequiresAuthenticationTimestamp (datetime) –

        The time when the registration was in the requires authentication state, in UNIX epoch time format.

      • ApprovedTimestamp (datetime) –

        The time when the registration was in the approved state, in UNIX epoch time format.

      • DiscardedTimestamp (datetime) –

        The time when the registration was in the discarded state, in UNIX epoch time format.

      • DeniedTimestamp (datetime) –

        The time when the registration was in the denied state, in UNIX epoch time format.

      • RevokedTimestamp (datetime) –

        The time when the registration was in the revoked state, in UNIX epoch time format.

      • ArchivedTimestamp (datetime) –

        The time when the registration was in the archived state, in UNIX epoch time format.

Exceptions