翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribedAgreement
契約のプロパティを説明します。
内容
- Arn
-
契約の一意のAmazon リソースネーム (ARN)。
型: 文字列
長さの制限: 最小長は 20 です。最大長は 1600 です。
Pattern:
arn:\S+必須：はい
- AccessRole
-
コネクターは、AS2 または SFTP プロトコルを使用してファイルを送信するために使用されます。アクセスロールには、使用する AWS Identity and Access Management ロールの Amazon リソースネーム (ARN) を指定します。
AS2 コネクタ用
AS2 では、
StartFileTransferを呼び出してリクエストパラメータ にファイルパスを指定することでファイルを送信できます。SendFilePathsファイルの親ディレクトリ (例えば--send-file-paths /bucket/dir/file.txtの場合、親ディレクトリは/bucket/dir/) を使用して、処理済みの AS2 メッセージファイルを一時的に保存し、パートナーから受け取った MDN を保存して、送信の関連メタデータを含む最終的な JSON ファイルを記述します。そのため、AccessRoleは、StartFileTransferリクエストで使用されるファイルの場所の親ディレクトリに対する読み取り/書き込みアクセスを提供する必要があります。さらに、StartFileTransferで送信するファイルの親ディレクトリに対する読み取り/書き込みアクセスを提供する必要があります。AS2 コネクタに Basic 認証を使用している場合、アクセスロールにはシークレットの
secretsmanager:GetSecretValue権限が必要です。Secrets Manager の マネージドキーではなく、カスタマー AWS マネージドキーを使用してシークレットが暗号化されている場合、ロールにはそのキーに対するkms:Decryptアクセス許可も必要です。SFTP コネクタ用
アクセスロールが、
StartFileTransferリクエストで使用されるファイルロケーションの親ディレクトリへの読み取りおよび書き込みアクセスを提供していることを確認します。さらに、ロールが にアクセスsecretsmanager:GetSecretValue許可を付与していることを確認します AWS Secrets Manager。型: 文字列
長さの制限: 最小長は 20 です。最大長は 2,048 です。
パターン:
arn:.*role/\S+必須: いいえ
- AgreementId
-
契約の一意の識別子。この識別子は、契約を作成するときに返されます。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
a-([0-9a-f]{17})必須: いいえ
- BaseDirectory
-
AS2 プロトコルを使用して転送されるファイルのランディングディレクトリ (フォルダ) です。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 1,024 です。
パターン:
(|/.*)必須: いいえ
- Description
-
契約書を識別するために使用される名前または簡単な説明です。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 200 です。
Pattern:
[\p{Graph}]+必須: いいえ
- LocalProfileId
-
AS2 ローカルプロファイルの一意の識別子です。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
p-([0-9a-f]{17})必須: いいえ
- PartnerProfileId
-
契約で使用されるパートナープロファイルの一意の識別子です。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
p-([0-9a-f]{17})必須: いいえ
- ServerId
-
サーバーインスタンスにシステムで割り当てられた一意の識別子。この識別子は、契約が使用する特定のサーバーを示します。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須: いいえ
- Status
-
契約の現在のステータス (
ACTIVEまたはINACTIVE) です。型: 文字列
有効な値：
ACTIVE | INACTIVE必須：いいえ
- Tags
-
契約のグループ化および検索に使用できるキーと値のペアです。
型: Tag オブジェクトの配列
配列メンバー：最小数は 1 項目です。最大数は 50 項目です。
必須：いいえ
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
