Transfer / Paginator / ListAgreements


class Transfer.Paginator.ListAgreements#
paginator = client.get_paginator('list_agreements')

Creates an iterator that will paginate through responses from Transfer.Client.list_agreements().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • ServerId (string) –


    The identifier of the server for which you want a list of agreements.

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



Response Syntax

    'Agreements': [
            'Arn': 'string',
            'AgreementId': 'string',
            'Description': 'string',
            'Status': 'ACTIVE'|'INACTIVE',
            'ServerId': 'string',
            'LocalProfileId': 'string',
            'PartnerProfileId': 'string'

Response Structure

  • (dict) –

    • Agreements (list) –

      Returns an array, where each item contains the details of an agreement.

      • (dict) –

        Describes the properties of an agreement.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the specified agreement.

        • AgreementId (string) –

          A unique identifier for the agreement. This identifier is returned when you create an agreement.

        • Description (string) –

          The current description for the agreement. You can change it by calling the UpdateAgreement operation and providing a new description.

        • Status (string) –

          The agreement can be either ACTIVE or INACTIVE.

        • ServerId (string) –

          The unique identifier for the agreement.

        • LocalProfileId (string) –

          A unique identifier for the AS2 local profile.

        • PartnerProfileId (string) –

          A unique identifier for the partner profile.