CreateConnector - AWS Transfer Family

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

CreateConnector

AS2 または SFTP プロトコルの接続パラメータをキャプチャするコネクタを作成します。AS2 の場合、コネクタは、外部でホストされている AS2 サーバーにファイルを送信するために必要です。SFTP の場合、SFTP サーバーにファイルを送信するとき、または SFTP サーバーからファイルを受信するときにコネクタが必要です。コネクタの詳細については、「AS2 コネクタの設定」および「SFTP コネクタの作成」を参照してください。

注記

AS2 (As2Config) または SFTP (SftpConfig) のいずれかに対して、構成オブジェクトを 1 つだけ指定する必要があります。

リクエストの構文

{ "AccessRole": "string", "As2Config": { "BasicAuthSecretId": "string", "Compression": "string", "EncryptionAlgorithm": "string", "LocalProfileId": "string", "MdnResponse": "string", "MdnSigningAlgorithm": "string", "MessageSubject": "string", "PartnerProfileId": "string", "SigningAlgorithm": "string" }, "LoggingRole": "string", "SftpConfig": { "TrustedHostKeys": [ "string" ], "UserSecretId": "string" }, "Tags": [ { "Key": "string", "Value": "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 リクエストで使用されるファイルロケーションの親ディレクトリへの読み取りおよび書き込みアクセスを提供していることを確認します。さらに、ロールが にアクセスsecretsmanager:GetSecretValue許可を付与していることを確認してください AWS Secrets Manager。

型: 文字列

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

Pattern: arn:.*role/\S+

必須:はい

As2Config

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

タイプ:As2ConnectorConfig オブジェクト

必須: いいえ

LoggingRole

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

型: 文字列

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

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

必須: いいえ

SftpConfig

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

タイプ:SftpConnectorConfig オブジェクト

必須: いいえ

Tags

コネクタのグループ化および検索に使用できるキーと値のペアです。タグは、あらゆる目的でコネクターに付けられるメタデータです。

型: Tag オブジェクトの配列

配列メンバー:最小数は 1 項目です。最大数は 50 項目です。

必須: いいえ

Url

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

型: 文字列

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

必須: はい

レスポンスの構文

{ "ConnectorId": "string" }

レスポンス要素

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

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

ConnectorId

API コールが成功した後に返されるコネクタの一意の識別子。

型: 文字列

長さの制限: 固定長は 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

次の例では、AS2 コネクタを作成します。コマンド内の項目を次のように置き換えます。

  • url: 取引パートナーの AS2 サーバーの URL を指定します。

  • your-IAM-role-for-bucket-access: ファイルの保存に使用している Amazon S3 バケットにアクセスできる IAM ロール。

  • AWS アカウント ID を含むログ記録ロールの ARN を使用します。

  • AS2 コネクタ構成パラメータを含むファイルへのパスを指定します。AS2 コネクタ設定オブジェクトについては、「As2ConnectorConfig」を参照してください。

// Listing for testAs2Config.json { "LocalProfileId": "your-profile-id", "PartnerProfileId": "partner-profile-id", "MdnResponse": "SYNC", "Compression": "ZLIB", "EncryptionAlgorithm": "AES256_CBC", "SigningAlgorithm": "SHA256", "MdnSigningAlgorithm": "DEFAULT", "MessageSubject": "Your Message Subject" }
aws transfer create-connector --url "http://partner-as2-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --as2-config file://path/to/testAS2Config.json

次の例では、SFTP コネクタを作成します。コマンド内の項目を次のように置き換えます。

  • sftp-server-url: ファイルを交換する SFTP サーバーの URL を指定します。

  • your-IAM-role-for-bucket-access: ファイルの保存に使用している Amazon S3 バケットにアクセスできる IAM ロール。

  • AWS アカウント ID を含むログ記録ロールの ARN を使用します。

  • SFTP コネクタ構成パラメータを含むファイルへのパスを指定します。SFTP コネクタ設定オブジェクトについては、「」を参照してくださいSftpConnectorConfig

// Listing for testSFTPConfig.json { "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/example-username-key", "TrustedHostKeys": [ "sftp.example.com ssh-rsa AAAAbbbb...EEEE=" ] }
aws transfer create-connector --url "sftp://sftp-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --sftp-config file://path/to/testSFTPConfig.json

API コールは、新しいコネクタのコネクタ ID を返します。

レスポンス例

{ "ConnectorId": "a-11112222333344444" }

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。