EndUserMessaging / Client / create_registrations_from_brand_profile

create_registrations_from_brand_profile¶

EndUserMessaging.Client.create_registrations_from_brand_profile(**kwargs)¶

Creates one or more registrations in the DRAFT state and prefills their fields from the attributes of a brand profile. This operation runs asynchronously. Use the GetJob operation to track its progress.

Request Syntax

response = client.create_registrations_from_brand_profile(
    brandProfileId='string',
    registrationTypes=[
        'string',
    ],
    smartMatch=True|False,
    clientToken='string'
)

Parameters:

brandProfileId (string) –
[REQUIRED]

The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).
registrationTypes (list) –
[REQUIRED]

The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.
- (string) –
  
  Registration type identifier (e.g., US_TOLL_FREE_REGISTRATION, SENDER_ID).
smartMatch (boolean) – Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.
clientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'results': [
        {
            'jobId': 'string',
            'resourceIdentifier': 'string'
        },
    ]
}

Response Structure

(dict) –
- results (list) –
  
  The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.
  - (dict) –
    
    Pairs an asynchronous job with the resource identifier from your request that the job processes.
    - jobId (string) –
      
      The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
    - resourceIdentifier (string) –
      
      The identifier from your request that this job is processing.

Exceptions

EndUserMessaging.Client.exceptions.ValidationException
EndUserMessaging.Client.exceptions.ThrottlingException
EndUserMessaging.Client.exceptions.AccessDeniedException
EndUserMessaging.Client.exceptions.ResourceNotFoundException
EndUserMessaging.Client.exceptions.InternalServerException
EndUserMessaging.Client.exceptions.ConflictException