Describes the agreement that’s identified by the
See also: AWS API Documentation
describe-agreement --agreement-id <value> --server-id <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
A unique identifier for the agreement. This identifier is returned when you create an agreement.
The server identifier that’s associated with the agreement.
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
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.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
Agreement -> (structure)
The details for the specified agreement, returned as a
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
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 local profile.
PartnerProfileId -> (string)A unique identifier for the partner profile used in the agreement.
BaseDirectory -> (string)The landing directory (folder) for files that are transferred by using the AS2 protocol.
AccessRole -> (string)With AS2, you can send files by calling
StartFileTransferand specifying the file paths in the request parameter,
SendFilePaths. We use the file’s parent directory (for example, for
--send-file-paths /bucket/dir/file.txt, parent directory is
/bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the
AccessRoleneeds to provide read and write access to the parent directory of the file location used in the
StartFileTransferrequest. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with
Tags -> (list)
Key-value pairs that can be used to group and search for agreements.
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
Groupand assign the values
Accountingto 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.