[ aws . transfer ]

describe-agreement

Description

Describes the agreement that’s identified by the AgreementId .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-agreement
--agreement-id <value>
--server-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--agreement-id (string)

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

--server-id (string)

The server ID that’s associated with the agreement.

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

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

Agreement -> (structure)

The details for the specified agreement, returned as a DescribedAgreement object.

Arn -> (string)

The unique Amazon Resource Name (ARN) for the agreement.

AgreementId -> (string)

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

Description -> (string)

The name or short description that’s used to identify the agreement.

Status -> (string)

The current status of the agreement, either ACTIVE or INACTIVE .

ServerId -> (string)

A system-assigned unique identifier for a server instance. This identifier indicates the specific server that the agreement uses.

LocalProfileId -> (string)

A unique identifier for the AS2 process.

PartnerProfileId -> (string)

A unique identifier for the partner in the agreement.

BaseDirectory -> (string)

The landing directory (folder) for files that are transferred by using the AS2 protocol.

AccessRole -> (string)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that grants access to at least the HomeDirectory of your users’ Amazon S3 buckets.

Tags -> (list)

Key-value pairs that can be used to group and search for agreements.

(structure)

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

Key -> (string)

The name assigned to the tag that you create.

Value -> (string)

Contains one or more values that you assigned to the key name you create.