PinpointSMSVoiceV2 / Paginator / DescribeRegistrationAttachments
DescribeRegistrationAttachments#
- class PinpointSMSVoiceV2.Paginator.DescribeRegistrationAttachments#
paginator = client.get_paginator('describe_registration_attachments')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
PinpointSMSVoiceV2.Client.describe_registration_attachments()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( RegistrationAttachmentIds=[ 'string', ], Filters=[ { 'Name': 'attachment-status', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- 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) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- 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) }, ], }
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.