PinpointSMSVoiceV2 / Client / create_registration_association

create_registration_association#

PinpointSMSVoiceV2.Client.create_registration_association(**kwargs)#

Associate the registration with an origination identity such as a phone number or sender ID.

Request Syntax

response = client.create_registration_association(
    RegistrationId='string',
    ResourceId='string'
)

Parameters:

RegistrationId (string) –
[REQUIRED]

The unique identifier for the registration.
ResourceId (string) –
[REQUIRED]

The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

Return type:

dict

Returns:

Response Syntax

{
    'RegistrationArn': 'string',
    'RegistrationId': 'string',
    'RegistrationType': 'string',
    'ResourceArn': 'string',
    'ResourceId': 'string',
    'ResourceType': 'string',
    'IsoCountryCode': 'string',
    'PhoneNumber': 'string'
}

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.
- ResourceArn (string) –
  
  The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
- ResourceId (string) –
  
  The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
- ResourceType (string) –
  
  The registration type or origination identity type.
- IsoCountryCode (string) –
  
  The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- PhoneNumber (string) –
  
  The phone number associated with the registration in E.164 format.

Exceptions

PinpointSMSVoiceV2.Client.exceptions.ServiceQuotaExceededException
PinpointSMSVoiceV2.Client.exceptions.ThrottlingException
PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException
PinpointSMSVoiceV2.Client.exceptions.ResourceNotFoundException
PinpointSMSVoiceV2.Client.exceptions.ValidationException
PinpointSMSVoiceV2.Client.exceptions.ConflictException
PinpointSMSVoiceV2.Client.exceptions.InternalServerException