ListedAgreement

Describes the properties of an agreement.

AgreementId

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

Type: String

Length Constraints: Fixed length of 19.

Pattern: a-([0-9a-f]{17})

Required: No

Arn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:\S+

Required: No

Description

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [\p{Graph}]+

Required: No

LocalProfileId

A unique identifier for the AS2 local profile.

Type: String

Length Constraints: Fixed length of 19.

Pattern: p-([0-9a-f]{17})

Required: No

PartnerProfileId

A unique identifier for the partner profile.

Type: String

Length Constraints: Fixed length of 19.

Pattern: p-([0-9a-f]{17})

Required: No

ServerId

The unique identifier for the agreement.

Type: String

Length Constraints: Fixed length of 19.

Pattern: s-([0-9a-f]{17})

Required: No

Status

The agreement can be either ACTIVE or INACTIVE.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

Contents