list_profiles

Transfer.Client.list_profiles(**kwargs)

Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken , you can supply that value to continue listing profiles from where you left off.

See also: AWS API Documentation

Request Syntax

response = client.list_profiles(
    MaxResults=123,
    NextToken='string',
    ProfileType='LOCAL'|'PARTNER'
)

Parameters

• MaxResults (integer) -- The maximum number of profiles to return.
• NextToken (string) -- When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.
• ProfileType (string) -- Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Profiles': [
        {
            'Arn': 'string',
            'ProfileId': 'string',
            'As2Id': 'string',
            'ProfileType': 'LOCAL'|'PARTNER'
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

    Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

  • 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 the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

      • ProfileType (string) --

        Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Exceptions

• Transfer.Client.exceptions.ServiceUnavailableException
• Transfer.Client.exceptions.InternalServiceError
• Transfer.Client.exceptions.InvalidNextTokenException
• Transfer.Client.exceptions.InvalidRequestException
• Transfer.Client.exceptions.ResourceNotFoundException