CreateAppClient - AWS AppFabric

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

CreateAppClient

AWS AppFabric for productivity 機能はプレビュー版であり、変更される可能性があります。

を作成します AppClient。

リクエスト本文

リクエストは以下の JSON 形式のデータを受け入れます。

パラメータ 説明

appName

アプリケーションの名前。

型: 文字列

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

必須: はい

clientToken

リクエストの冪等性のために割り当てる一意の識別子 (大文字と小文字を区別) を指定します。これにより、同じ操作を誤って 2 度実行することなく、リクエストを安全に再試行できます。操作の後半の呼び出しで同じ値を渡す場合は、他のすべてのパラメータにも同じ値を渡す必要があります。UUID タイプの値を使用することが推奨されます。

この値を指定しない場合、 はランダムな値 AWS を生成します。

同じ ClientToken を使って、異なるパラメータで操作を再試行すると、再試行は IdempotentParameterMismatch のエラーにより失敗します。

型: 文字列

パターン:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

必須: いいえ

customerManagedKey識別子

によって カスタマー管理キー 生成された の ARN AWS Key Management Service。このキーはデータの暗号化に使用します。

キーが指定されていない場合は、 AWS マネージドキー が使用されます。リソースに割り当てるタグの、キーと値のペアのマップ。

AWS 所有のキー およびカスタマーマネージドキーの詳細については、「 AWS Key Management Service デベロッパーガイド」の「カスタマーキーと AWS キー」を参照してください。

型: 文字列

長さの制限:最小長は 1 です。最大長は 1,011 です。

Pattern: arn:.+$|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

必須: いいえ

[ Description] ( 説明)

アプリケーションの説明です。

型: 文字列

必須: はい

iconUrl

のアイコンまたはロゴへの URL AppClient。

タイプ: 文字列

必須: いいえ

redirectUrls

承認後にエンドユーザーがリダイレクトされる URI です。redirectUrls は 5 個まで追加できます。例えば、https://localhost:8080 などです。

タイプ:文字列の配列

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

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

Pattern: (http|https):\/\/[-a-zA-Z0-9_:.\/]+

必須:はい

starterUserEmails

AppClient が検証されるまでインサイトを受け取るアクセスが許可されているユーザーのスターター E メールアドレス。

タイプ:文字列の配列

配列メンバー: 定数は 1 項目です。

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

Pattern: [a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*

必須:はい

タグ

リソースに割り当てるタグの、キーと値のペアのマップ。

タイプ: タグオブジェクトの配列

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

必須: いいえ

レスポンス要素

アクションが成功すると、HTTP 201 レスポンスが返されます。

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

パラメータ 説明

appClientSummary

の概要が含まれます AppClient。

タイプ:AppClientSummary オブジェクト