[ aws . transfer ]

list-agreements

Description

Returns a list of the agreements for the server that’s identified by the ServerId that you supply. 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 agreements from where you left off.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-agreements is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Agreements

Synopsis

  list-agreements
--server-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--server-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

NextToken -> (string)

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

Agreements -> (list)

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

(structure)

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

PartnerProfileId -> (string)

A unique identifier for the partner process.