Transfer / Paginator / ListProfiles
ListProfiles#
- class Transfer.Paginator.ListProfiles#
paginator = client.get_paginator('list_profiles')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Transfer.Client.list_profiles()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( ProfileType='LOCAL'|'PARTNER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
ProfileType (string) – Indicates whether to list only
LOCAL
type profiles or onlyPARTNER
type profiles. If not supplied in the request, the command lists all types of profiles.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
{ 'Profiles': [ { 'Arn': 'string', 'ProfileId': 'string', 'As2Id': 'string', 'ProfileType': 'LOCAL'|'PARTNER' }, ] }
Response Structure
(dict) –
Profiles (list) –
Returns an array, where each item contains the details of a profile.
(dict) –
Returns the properties of the profile that was specified.
Arn (string) –
The Amazon Resource Name (ARN) of the specified profile.
ProfileId (string) –
A unique identifier for the local or partner AS2 profile.
As2Id (string) –
The
As2Id
is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is theAS2-From
header for the AS2 messages sent from the partner. For outbound connectors, this is theAS2-To
header for the AS2 messages sent to the partner using theStartFileTransfer
API operation. This ID cannot include spaces.ProfileType (string) –
Indicates whether to list only
LOCAL
type profiles or onlyPARTNER
type profiles. If not supplied in the request, the command lists all types of profiles.