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

**********************
describe_registrations
**********************



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

  

  Retrieves the specified registrations.

  

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


  **Request Syntax**
  ::

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

             

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

            
          

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

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

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

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

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

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

  