PinpointSMSVoiceV2 / Client / describe_registration_versions

describe_registration_versions#

PinpointSMSVoiceV2.Client.describe_registration_versions(**kwargs)#

Retrieves the specified registration version.

Request Syntax

response = client.describe_registration_versions(
    RegistrationId='string',
    VersionNumbers=[
        123,
    ],
    Filters=[
        {
            'Name': 'registration-version-status',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters:

RegistrationId (string) –
[REQUIRED]

The unique identifier for the registration.
VersionNumbers (list) –
An array of registration version numbers.
- (integer) –
Filters (list) –
An array of RegistrationVersionFilter objects to filter the results.
- (dict) –
  
  The filter definition for filtering registration versions 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

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'RegistrationVersions': [
        {
            '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)
            },
            'DeniedReasons': [
                {
                    'Reason': 'string',
                    'ShortDescription': 'string',
                    'LongDescription': 'string',
                    'DocumentationTitle': 'string',
                    'DocumentationLink': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- RegistrationArn (string) –
  
  The Amazon Resource Name (ARN) for the registration.
- RegistrationId (string) –
  
  The unique identifier for the registration.
- RegistrationVersions (list) –
  
  An array of RegistrationVersions objects.
  - (dict) –
    
    Provides information about the specified version of the registration.
    - VersionNumber (integer) –
      
      The version number of the registration.
    - RegistrationVersionStatus (string) –
      
      The status of the registration.
      - 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.
    - DeniedReasons (list) –
      
      An array of RegistrationDeniedReasonInformation objects.
      - (dict) –
        
        Provides the reason a registration was rejected.
        
        Reason (string) –
        
        The reason a registration was rejected.
        
        ShortDescription (string) –
        
        A short description of the rejection reason.
        
        LongDescription (string) –
        
        A long description of the rejection reason.
        
        DocumentationTitle (string) –
        
        The title of the document.
        
        DocumentationLink (string) –
        
        The link to the document.
- 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.

describe_registration_versions#

Request Syntax

Response Syntax

Response Structure

Exceptions