CreateConnector - AWS Transfer Family
請求語法請求參數回應語法回應元素錯誤範例另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

CreateConnector

建立連接器，該連接器會擷取 AS2或 SFTP通訊協定連線的參數。對於 AS2，傳送檔案至外部託管AS2伺服器時需要連接器。對於 SFTP，傳送檔案至SFTP伺服器或從伺服器接收檔案時，需要連接器SFTP。如需連接器的詳細資訊，請參閱設定AS2連接器和建立SFTP連接器。

注意

您必須只指定一個組態物件：針對 AS2（As2Config） 或 SFTP（）SftpConfig。

請求語法

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

請求參數

如需所有動作的一般參數資訊，請參閱《Common Parameters》。

請求接受下列JSON格式的資料。

AccessRole

連接器用於使用 AS2或 SFTP通訊協定傳送檔案。針對存取角色，提供要使用 AWS Identity and Access Management 的角色的 Amazon Resource Name （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。長度上限為 2048。

模式：arn:.*role/\S+

必要：是

As2Config

包含AS2連接器物件參數的結構。

類型：As2ConnectorConfig 物件

必要：否

LoggingRole

（ARN） 角色的 Amazon Resource Name AWS Identity and Access Management （IAM），允許連接器開啟 Amazon S3 事件 CloudWatch 的記錄。設定時，您可以在 CloudWatch 日誌中檢視連接器活動。

類型：字串

長度限制︰長度下限為 20。長度上限為 2048。

模式：arn:.*role/\S+

必要：否

SftpConfig

包含SFTP連接器物件參數的結構。

類型：SftpConnectorConfig 物件

必要：否

Tags

金鑰/值對，可用來分組和搜尋連接器。標籤是為任何目的連接到連接器的中繼資料。

類型：Tag 物件陣列

陣列成員：項目數下限為 1。項目數上限為 50。

必要：否

Url

URL 合作夥伴AS2或SFTP端點的 。

類型：字串

長度限制：長度下限為 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：URL為交易合作夥伴的AS2伺服器提供 。

  • your-IAM-role-for-bucket-access：可存取您用來存放檔案的 Amazon S3 儲存貯體IAM的角色。

  • 將 ARN用於您的記錄角色，其中包含您的 AWS 帳戶 ID。

  • 提供包含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：URL為您交換檔案的SFTP伺服器提供 。

  • your-IAM-role-for-bucket-access：可存取您用來存放檔案的 Amazon S3 儲存貯體IAM的角色。

  • 將 ARN用於您的記錄角色，其中包含您的 AWS 帳戶 ID。

  • 提供包含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，請參閱下列內容：