AWS API Changes

2024/10/17 - Amazon Pinpoint SMS Voice V2 - 7 updated api methods

Changes Added the registrations status of REQUIRES_AUTHENTICATION

CreateRegistration (updated)

Link ¶
Changes (response)

{'RegistrationStatus': {'REQUIRES_AUTHENTICATION'}}

Creates a new registration based on the RegistrationType field.

See also: AWS API Documentation

Request Syntax

client.create_registration(
    RegistrationType='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientToken='string'
)

type RegistrationType

string

param RegistrationType

[REQUIRED]

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

type Tags

list

param Tags

An array of tags (key and value pairs) to associate with the registration.

(dict) --

The list of tags to be added to the specified topic.
- Key (string) -- [REQUIRED]
  
  The key identifier, or name, of the tag.
- Value (string) -- [REQUIRED]
  
  The string value associated with the key of the tag.

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'RegistrationType': 'string',
    'RegistrationStatus': 'CREATED'|'SUBMITTED'|'REVIEWING'|'REQUIRES_AUTHENTICATION'|'PROVISIONING'|'COMPLETE'|'REQUIRES_UPDATES'|'CLOSED'|'DELETED',
    'CurrentVersionNumber': 123,
    'AdditionalAttributes': {
        'string': 'string'
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': '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 to create. 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.
- AdditionalAttributes (dict) --
  
  Metadata about a given registration which is specific to that registration type.
  - (string) --
    - (string) --
- Tags (list) --
  
  An array of tags (key and value pairs) to associate with the registration.
  - (dict) --
    
    The list of tags to be added to the specified topic.
    - Key (string) --
      
      The key identifier, or name, of the tag.
    - Value (string) --
      
      The string value associated with the key of the tag.
- CreatedTimestamp (datetime) --
  
  The time when the registration was created, in UNIX epoch time format.

CreateRegistrationVersion (updated)

Link ¶
Changes (response)

{'RegistrationVersionStatus': {'REQUIRES_AUTHENTICATION'}}

Create a new version of the registration and increase the VersionNumber . The previous version of the registration becomes read-only.

See also: AWS API Documentation

Request Syntax

client.create_registration_version(
    RegistrationId='string'
)

type RegistrationId

string

param RegistrationId

[REQUIRED]

The unique identifier for the registration.

rtype

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),
        '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 new version number of the registration.
- RegistrationVersionStatus (string) --
  
  The status of the registration.
  - DRAFT : The initial status of a registration version after it’s created.
  - SUBMITTED : Your registration has been submitted.
  - REVIEWING : Your registration has been accepted and is being reviewed.
  - APPROVED : Your registration has been approved.
  - DISCARDED : You've abandon this version of their registration to start over with a new version.
  - DENIED : You must fix your registration and resubmit it.
  - REVOKED : Your previously approved registration has been revoked.
  - ARCHIVED : Your previously approved registration version moves into this status when a more recently submitted version is approved.
- RegistrationVersionStatusHistory (dict) --
  
  A RegistrationVersionStatusHistory object that contains timestamps for the registration.
  - 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.
  - 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.

DeleteRegistration (updated)

Link ¶
Changes (response)

{'RegistrationStatus': {'REQUIRES_AUTHENTICATION'}}

Permanently delete an existing registration from your account.

See also: AWS API Documentation

Request Syntax

client.delete_registration(
    RegistrationId='string'
)

type RegistrationId

string

param RegistrationId

[REQUIRED]

The unique identifier for the registration.

rtype

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

DescribeRegistrationVersions (updated)

Link ¶
Changes (response)

{'RegistrationVersions': {'RegistrationVersionStatus': {'REQUIRES_AUTHENTICATION'}}}

Retrieves the specified registration version.

See also: AWS API Documentation

Request Syntax

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

type RegistrationId

string

param RegistrationId

[REQUIRED]

The unique identifier for the registration.

type VersionNumbers

list

param VersionNumbers

An array of registration version numbers.

(integer) --

type Filters

list

param Filters

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) --

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

The maximum number of results to return per each request.

rtype

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),
                '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.
      - DRAFT : The initial status of a registration version after it’s created.
      - SUBMITTED : Your registration has been submitted.
      - REVIEWING : Your registration has been accepted and is being reviewed.
      - APPROVED : Your registration has been approved.
      - DISCARDED : You've abandon this version of their registration to start over with a new version.
      - DENIED : You must fix your registration and resubmit it.
      - REVOKED : Your previously approved registration has been revoked.
      - ARCHIVED : Your previously approved registration version moves into this status when a more recently submitted version is approved.
    - 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.
      - 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.

DescribeRegistrations (updated)

Link ¶
Changes (response)

{'Registrations': {'RegistrationStatus': {'REQUIRES_AUTHENTICATION'}}}

Retrieves the specified registrations.

See also: AWS API Documentation

Request Syntax

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

type RegistrationIds

list

param RegistrationIds

An array of unique identifiers for each registration.

(string) --

type Filters

list

param Filters

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) --

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

The maximum number of results to return per each request.

rtype

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.

DiscardRegistrationVersion (updated)

Link ¶
Changes (response)

{'RegistrationVersionStatus': {'REQUIRES_AUTHENTICATION'}}

Discard the current version of the registration.

See also: AWS API Documentation

Request Syntax

client.discard_registration_version(
    RegistrationId='string'
)

type RegistrationId

string

param RegistrationId

[REQUIRED]

The unique identifier for the registration.

rtype

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),
        '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.
  - DRAFT : The initial status of a registration version after it’s created.
  - SUBMITTED : Your registration has been submitted.
  - REVIEWING : Your registration has been accepted and is being reviewed.
  - APPROVED : Your registration has been approved.
  - DISCARDED : You've abandon this version of their registration to start over with a new version.
  - DENIED : You must fix your registration and resubmit it.
  - REVOKED : Your previously approved registration has been revoked.
  - ARCHIVED : Your previously approved registration version moves into this status when a more recently submitted version is approved.
- 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.
  - 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.

SubmitRegistrationVersion (updated)

Link ¶
Changes (response)

{'RegistrationVersionStatus': {'REQUIRES_AUTHENTICATION'}}

Submit the specified registration for review and approval.

See also: AWS API Documentation

Request Syntax

client.submit_registration_version(
    RegistrationId='string'
)

type RegistrationId

string

param RegistrationId

[REQUIRED]

The unique identifier for the registration.

rtype

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),
        '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.
  - DRAFT : The initial status of a registration version after it’s created.
  - SUBMITTED : Your registration has been submitted.
  - REVIEWING : Your registration has been accepted and is being reviewed.
  - APPROVED : Your registration has been approved.
  - DISCARDED : You've abandon this version of their registration to start over with a new version.
  - DENIED : You must fix your registration and resubmit it.
  - REVOKED : Your previously approved registration has been revoked.
  - ARCHIVED : Your previously approved registration version moves into this status when a more recently submitted version is approved.
- 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.
  - 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.