CreateConnector - AWS Transfer Family

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

CreateConnector

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

注記

As2Config) または AS2 () のいずれかに、1 つの設定オブジェクトのみを指定する必要がありますSFTPSftpConfig

リクエストの構文

{ "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 コネクタに基本認証を使用している場合、アクセスロールにはシークレットの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

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

型: 文字列

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

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

必須: いいえ

SftpConfig

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

型: SftpConnectorConfig オブジェクト

必須:いいえ

Tags

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

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

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

必須:いいえ

Url

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

型: 文字列

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

必須:はい

レスポンスの構文

{ "ConnectorId": "string" }

レスポンス要素

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

次のデータは、 サービスによって 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ロール。

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

  • 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: ファイルを交換するURLSFTPサーバーの を指定します。

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

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

  • 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" }

以下の資料も参照してください。

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