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

*********************************
describe_registration_attachments
*********************************



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

  

  Retrieves the specified registration attachments or all registration attachments associated with your Amazon Web Services account.

  

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


  **Request Syntax**
  ::

    response = client.describe_registration_attachments(
        RegistrationAttachmentIds=[
            'string',
        ],
        Filters=[
            {
                'Name': 'attachment-status',
                'Values': [
                    'string',
                ]
            },
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :type RegistrationAttachmentIds: list
  :param RegistrationAttachmentIds: 

    The unique identifier of registration attachments to find. This is an array of **RegistrationAttachmentId**.

    

  
    - *(string) --* 

    

  :type Filters: list
  :param Filters: 

    An array of RegistrationAttachmentFilter objects to filter the results.

    

  
    - *(dict) --* 

      The filter definition for filtering registration attachments 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**

    
    ::

      {
          'RegistrationAttachments': [
              {
                  'RegistrationAttachmentArn': 'string',
                  'RegistrationAttachmentId': 'string',
                  'AttachmentStatus': 'UPLOAD_IN_PROGRESS'|'UPLOAD_COMPLETE'|'UPLOAD_FAILED'|'DELETED',
                  'AttachmentUploadErrorReason': 'INTERNAL_ERROR',
                  'CreatedTimestamp': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RegistrationAttachments** *(list) --* 

        An array of **RegistrationAttachments** objects that contain the details for the requested registration attachments.

        
        

        - *(dict) --* 

          Provides information on the specified registration attachments.

          
          

          - **RegistrationAttachmentArn** *(string) --* 

            The Amazon Resource Name (ARN) for the registration attachment.

            
          

          - **RegistrationAttachmentId** *(string) --* 

            The unique identifier for the registration attachment.

            
          

          - **AttachmentStatus** *(string) --* 

            The status of the registration attachment.

             

            
            * ``UPLOAD_IN_PROGRESS`` The attachment is being uploaded.
             
            * ``UPLOAD_COMPLETE`` The attachment has been uploaded.
             
            * ``UPLOAD_FAILED`` The attachment failed to uploaded.
             
            * ``DELETED`` The attachment has been deleted..
            

            
          

          - **AttachmentUploadErrorReason** *(string) --* 

            A description of why the upload didn't successfully complete.

            
          

          - **CreatedTimestamp** *(datetime) --* 

            The time when the registration attachment 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`

  