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