:doc:`PinpointSMSVoiceV2 <../../pinpoint-sms-voice-v2>` / Client / create_registration

*******************
create_registration
*******************



.. py:method:: PinpointSMSVoiceV2.Client.create_registration(**kwargs)

  

  Creates a new registration based on the **RegistrationType** field.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-v2-2022-03-31/CreateRegistration>`_  


  **Request Syntax**
  ::

    response = 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'|'AWS_REVIEWING'|'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.

         

        
        * ``CLOSED``: The phone number or sender ID has been deleted and you must also delete the registration for the number.
         
        * ``CREATED``: Your registration is created but not submitted.
         
        * ``COMPLETE``: Your registration has been approved and your origination identity has been created.
         
        * ``DELETED``: The registration has been deleted.
         
        * ``PROVISIONING``: Your registration has been approved and your origination identity is being created.
         
        * ``REQUIRES_AUTHENTICATION``: You need to complete email authentication.
         
        * ``REQUIRES_UPDATES``: You must fix your registration and resubmit it.
         
        * ``REVIEWING``: Your registration has been accepted and is being reviewed.
         
        * ``SUBMITTED``: Your registration has been submitted and is awaiting review.
        

        
      

      - **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 <https://www.epochconverter.com/>`__ format.

        
  
  **Exceptions**
  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ValidationException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.ConflictException`

  
  *   :py:class:`PinpointSMSVoiceV2.Client.exceptions.InternalServerException`

  