PinpointSMSVoiceV2 / Client / describe_registration_attachments

describe_registration_attachments#

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

Request Syntax

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

  • RegistrationAttachmentIds (list) –

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

    • (string) –

  • Filters (list) –

    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) –

  • 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.

  • MaxResults (integer) – The maximum number of results to return per each request.

Return type:

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 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