翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateProfile
AS2 転送に使用するローカルプロファイルまたはパートナープロファイルを作成します。
リクエストの構文
{
"As2Id": "string",
"CertificateIds": [ "string" ],
"ProfileType": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- As2Id
-
As2Idは、RFC 4130で定義されている AS2-name です。インバウンド転送の場合、これはパートナーから送信される AS2 メッセージの AS2-Fromヘッダーです。アウトバウンドコネクタの場合、これはStartFileTransferAPI オペレーションを使用してパートナーに送信される AS2 メッセージのAS2-Toヘッダーです。この ID にスペースを含めることはできません。型: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン:
[\p{Print}\s]*必須：はい
- CertificateIds
-
インポートされた証明書の識別子の配列です。この識別子は、プロファイルやパートナープロファイルの操作に使用します。
タイプ：文字列の配列
長さの制限: 22 の固定長
Pattern:
cert-([0-9a-f]{17})必須: いいえ
- ProfileType
-
作成するプロファイルのタイプを決定します。
-
ローカルプロファイルを作成する場合に
LOCAL指定します。ローカルプロファイルは、AS2対応のTransTransfer Family yサーバーの組織またはパーティーを表します。 -
パートナー プロファイルを作成するように
PARTNER指定します。パートナープロフィールは、Transfer Familyの外部にあるリモート組織を表します。
型: 文字列
有効な値：
LOCAL | PARTNER必須: はい
-
- Tags
-
AS2 プロファイルのグループ化と検索に使用できるキーと値のペア。
型: Tag オブジェクトの配列
配列メンバー：最小数は 1 項目です。最大数は 50 項目です。
必須：いいえ
レスポンスの構文
{
"ProfileId": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ProfileId
-
API コールが成功すると返される AS2 プロファイルの一意の識別子です。
型: 文字列
長さの制限: 固定長は 19 です。
パターン：
p-([0-9a-f]{17})
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード：400
例
例
次の例では、プロファイルを作成します。プロファイルIDを返します。
証明書 ID はimport-certificateの実行時に作成され、1 つは署名証明書用、もう 1 つは暗号化証明書用です。
aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk c-987654aaaa321bbbb
レスポンス例
API コールは、新しいプロファイルのプロファイル ID を返します。
{ "ProfileId": "p-11112222333344444" }
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
