翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
UpdateAgreement
既存の契約の一部のパラメータを更新します。更新する契約書のAgreementIdとServerIdを、更新するパラメータの新しい値を指定します。
リクエストの構文
{
"AccessRole": "string",
"AgreementId": "string",
"BaseDirectory": "string",
"Description": "string",
"LocalProfileId": "string",
"PartnerProfileId": "string",
"ServerId": "string",
"Status": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- 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リクエストで使用されるファイルロケーションの親ディレクトリへの読み取りおよび書き込みアクセスを提供していることを確認します。さらに、ロールが AWS Secrets Manager にsecretsmanager:GetSecretValue許可を与えていることを確認します。型: 文字列
長さの制限: 最小長は 20 です。最大長は 2,048 です。
パターン:
arn:.*role/\S+必須: いいえ
- AgreementId
-
契約の一意の識別子。この識別子は、契約を作成するときに返されます。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
a-([0-9a-f]{17})必須：はい
- BaseDirectory
-
転送されるファイルのランディングディレクトリ (フォルダ) を変更するには、使用したいバケットフォルダを指定します。例えば、
/DOC-EXAMPLE-BUCKET/home/mydirectory。型: 文字列
長さの制限: 最小長は 0 です。最大長は 1,024 です。
パターン:
(|/.*)必須: いいえ
- Description
-
既存の説明を置き換えるには、契約の簡単な説明を入力します。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 200 です。
Pattern:
[\p{Graph}]+必須: いいえ
- LocalProfileId
-
AS2 ローカルプロファイルの一意の識別子です。
ローカルプロファイル識別子を変更するには、ここに新しい値を入力します。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
p-([0-9a-f]{17})必須: いいえ
- PartnerProfileId
-
パートナープロファイルの一意の識別子。パートナープロファイル ID を変更するには、ここに新しい値を入力します。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
p-([0-9a-f]{17})必須: いいえ
- ServerId
-
サーバーインスタンスにシステムで割り当てられた一意の識別子。これは、契約が使用する特定のサーバーです。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須：はい
- Status
-
契約のステータスを更新できます。無効になっている契約を有効化することも、その逆を行うこともできます。
型: 文字列
有効な値：
ACTIVE | INACTIVE必須：いいえ
レスポンスの構文
{
"AgreementId": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- AgreementId
-
契約の一意の識別子。この識別子は、契約を作成するときに返されます。
型: 文字列
長さの制限: 固定長は 19 です。
パターン：
a-([0-9a-f]{17})
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceExistsException
-
要求されたリソースは存在しないか、コマンドに指定されたリージョン以外のリージョンに存在します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、AWS Transfer Family サービスでリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスを利用できないためリクエストは失敗しました。
HTTP ステータスコード：500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
