PutAccountName
指定されたアカウントのアカウント名を更新します。この API を使用するには、IAM プリンシパルに account:PutAccountName IAM アクセス許可が必要です。
リクエストの構文
POST /putAccountName HTTP/1.1
Content-type: application/json
{
"AccountId": "string",
"AccountName": "string"
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- AccountId
-
この操作でアクセスまたは変更する AWS アカウントの 12 桁のアカウント ID 番号を指定します。
このパラメータを指定しない場合、操作を呼び出したアイデンティティの AWS アカウントがデフォルトになります。
このパラメータを使用するには、呼び出し元が組織の管理アカウントまたは委任管理者アカウント、および指定されたアカウント ID は、同じ組織内のメンバーアカウントである必要があります。組織はすべての機能を有効化して、アカウント管理サービス用の有効な信頼されたアクセスを持つ必要があり、オプションとして委任管理者アカウントが割り当てられます。
注記
管理アカウントは独自の
AccountIdアカウントを指定できません; これは、AccountIdパラメータを含めないことにより、スタンドアロンコンテキストでの操作を呼び出さなければなりません。組織のメンバーではないアカウントでこの操作を呼び出すには、このパラメータを指定せず、取得または変更する取引先責任者のアカウントに属する ID を使用して操作を呼び出します。
タイプ: 文字列
パターン:
\d{12}必須: いいえ
- AccountName
-
アカウントの名前。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 50 です。
パターン:
[ -;=?-~]+必須: はい
レスポンスの構文
HTTP/1.1 200
レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
呼び出し元の ID に必要な最小アクセス許可がないため、操作が失敗しました。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 403
- InternalServerException
-
AWS への内部エラーのため、操作が失敗しました。後でもう一度操作をお試しください。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 500
- TooManyRequestsException
-
操作が頻繁に呼び出され、スロットルの制限を超えているため、操作が失敗しました。
- errorType
-
API Gateway によって
x-amzn-ErrorTypeレスポンスヘッダーに入力された値。
HTTP ステータスコード: 429
- ValidationException
-
入力パラメータのいずれかが無効であるため、操作が失敗しました。
- fieldList
-
無効なエントリが検出されたフィールド。
- message
-
リクエストのどの部分が無効だったかを知らせるメッセージ。
- reason
-
検証が失敗した理由。
HTTP ステータスコード: 400
例
例 1
次の例では、オペレーションの呼び出しに使用される認証情報を持つアカウント名を更新します。
リクエスト例
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.PutAccountName
{
"AccountName":"MyAccount"
}レスポンス例
HTTP/1.1 200 OK
Content-Type: application/json例 2
次の例では、組織内の指定されたメンバーアカウントのアカウント名を更新します。組織の管理アカウントまたはアカウント管理サービスの委任管理者アカウントの認証情報を使用する必要があります。
リクエスト例
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.PutAccountName
{
"AccountId": "123456789012",
"AccountName": "MyMemberAccount"
}レスポンス例
HTTP/1.1 200 OK
Content-Type: application/json以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
