UpdateConnector - AWS Transfer Family

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

UpdateConnector

既存のコネクタのパラメータの一部を更新します。更新するコネクタの ConnectorId を、更新するパラメータの新しい値とともに指定します。

リクエストの構文

{ "AccessRole": "string", "As2Config": { "BasicAuthSecretId": "string", "Compression": "string", "EncryptionAlgorithm": "string", "LocalProfileId": "string", "MdnResponse": "string", "MdnSigningAlgorithm": "string", "MessageSubject": "string", "PartnerProfileId": "string", "SigningAlgorithm": "string" }, "ConnectorId": "string", "LoggingRole": "string", "SftpConfig": { "TrustedHostKeys": [ "string" ], "UserSecretId": "string" }, "Url": "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+

必須: いいえ

As2Config

AS2 コネクタオブジェクトのパラメータを含む構造体。

タイプ:As2ConnectorConfig オブジェクト

必須: いいえ

ConnectorId

コネクタの一意の識別子。

型: 文字列

長さの制限: 固定長は 19 です。

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

必須:はい

LoggingRole

コネクタが Amazon S3 イベントの CloudWatch ログ記録をオンにできるようにする AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。 Amazon S3 設定すると、 CloudWatch ログにコネクタアクティビティを表示できます。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 2,048 です。

パターン: arn:.*role/\S+

必須: いいえ

SftpConfig

SFTP コネクタオブジェクトのパラメータを含む構造体。

タイプ:SftpConnectorConfig オブジェクト

必須: いいえ

Url

パートナーの AS2 または SFTP エンドポイントの URL。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 255 です。

必須: いいえ

レスポンスの構文

{ "ConnectorId": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

ConnectorId

更新しているコネクタ オブジェクトの識別子を返します。

型: 文字列

長さの制限: 固定長は 19 です。

パターン:c-([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 を使用する方法の詳細については、以下を参照してください。