翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # Amazon DocumentDB Elastic Clusters Amazon DocumentDB Elastic クラスターでは、以下のアクションがサポートされています。 + [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md) + [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md) + [CreateCluster](API_elastic_CreateCluster.md) + [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md) + [DeleteCluster](API_elastic_DeleteCluster.md) + [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md) + [GetCluster](API_elastic_GetCluster.md) + [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md) + [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md) + [ListClusters](API_elastic_ListClusters.md) + [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md) + [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md) + [ListTagsForResource](API_elastic_ListTagsForResource.md) + [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md) + [StartCluster](API_elastic_StartCluster.md) + [StopCluster](API_elastic_StopCluster.md) + [TagResource](API_elastic_TagResource.md) + [UntagResource](API_elastic_UntagResource.md) + [UpdateCluster](API_elastic_UpdateCluster.md) # ApplyPendingMaintenanceAction リソースに適用される保留中のメンテナンスアクションのタイプ。 ## リクエストの構文 ``` POST /pending-action HTTP/1.1 Content-type: application/json { "applyAction": "string", "applyOn": "string", "optInType": "string", "resourceArn": "string" } ``` ## URI リクエストパラメータリクエストでは URI パラメータを使用しません。 ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** リソースに適用する保留中のメンテナンスアクション。有効なアクションは以下のとおりです。 + `ENGINE_UPDATE ` + `ENGINE_UPGRADE` + `SECURITY_UPDATE` + `OS_UPDATE` + `MASTER_USER_PASSWORD_UPDATE` タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 256 です。必須: はい ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** オプトインリクエストのタイプを指定するか、オプトインクエストを元に戻す値。タイプ `IMMEDIATE` のオプトインリクエストは元に戻すことができません。型: 文字列有効な値：`IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN` 必須: はい ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 保留中のメンテナンスアクションが適用されるリソースの Amazon DocumentDB ARN (Amazon リソースネーム)。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 256 です。必須: はい ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** 保留中のメンテナンスアクションを適用する特定の日付。オプトインタイプが `APPLY_ON` の場合は必須です。形式: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm` タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 256 です。必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) ** 適用されている保留中のメンテナンスアクションの出力。型: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) # CopyClusterSnapshot Elastic クラスターのスナップショットをコピーします。 ## リクエストの構文 ``` POST /cluster-snapshot/snapshotArn/copy HTTP/1.1 Content-type: application/json { "copyTags": boolean, "kmsKeyId": "string", "tags": { "string" : "string" }, "targetSnapshotName": "string" } ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** Elastic クラスタースナップショットの Amazon リソースネーム (ARN) 識別子。必須: はい ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** コピー元のクラスタースナップショットから作成される新しい Elastic クラスタースナップショットの識別子。このパラメータは大文字と小文字が区別されません。制約: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。例: `elastic-cluster-snapshot-5` タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。必須: はい ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** コピー元のクラスタースナップショットからコピー先のクラスタースナップショットにすべてのタグをコピーする場合は `true` に設定します。デフォルトは `false` です。タイプ: ブール値必須: いいえ ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** 暗号化された Elastic クラスタースナップショットの AWS KMS キー ID。 AWS KMS キー ID は、Amazon リソースネーム (ARN)、 AWS KMS キー識別子、または AWS KMS 暗号化キーの KMS AWS キーエイリアスです。 AWS アカウントから暗号化された Elastic クラスタースナップショットをコピーする場合、の値を指定`KmsKeyId`して、新しい S AWS KMS 暗号化キーでコピーを暗号化できます。`KmsKeyId` の値を指定しない場合、Elastic クラスタースナップショットのコピーはコピー元の Elastic クラスタースナップショットと同じ `AWS` KMS キーで暗号化されます。暗号化されていない Elastic クラスタースナップショットをコピーして `KmsKeyId` パラメータに値を指定すると、エラーが返されます。タイプ: 文字列必須: いいえ ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** Elastic クラスタースナップショットに割り当てるタグ。タイプ: 文字列間のマッピングキーの長さ制限: 最小長さは 1 です。最大長は 128 です。キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) ** 特定のエラスティッククラスタースナップショットに関する情報を返します。型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) # CreateCluster 新しい Amazon DocumentDB エラスティッククラスターを作成し、そのクラスターの構造を返します。 ## リクエストの構文 ``` POST /cluster HTTP/1.1 Content-type: application/json { "adminUserName": "string", "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "clusterName": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "tags": { "string" : "string" }, "vpcSecurityGroupIds": [ "string" ] } ``` ## URI リクエストパラメータリクエストでは URI パラメータを使用しません。 ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) ** Amazon DocumentDB エラスティッククラスター管理者の名前。 *制約*: + 1～63 文字の英数字である必要があります。 + 最初の文字は文字である必要があります。 + 予約語は使用できません。タイプ: 文字列必須: はい ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) ** Amazon DocumentDB エラスティッククラスター管理者のパスワード。パスワードは、印刷可能な任意の ASCII 文字で構成することができます。 *制約*: + 8 〜 100 文字で構成する必要があります。 + スラッシュ (/)、二重引用符 (「」)、または「at」記号 (@) を含むことはできません。タイプ: 文字列必須: はい ** [authType](#API_elastic_CreateCluster_RequestSyntax) ** エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。型: 文字列有効な値：`PLAIN_TEXT | SECRET_ARN` 必須: はい ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) ** 新しいエラスティッククラスターの名前。このパラメータは小文字で保存されます。 *制約*: + 1 ～ 63 の文字、数字またはハイフンを使用する必要があります。 + 最初の文字は文字である必要があります。 + ハイフンで終わることも、2 つのハイフンを連続して含むこともできません。 *例*: `my-cluster` タイプ: 文字列必須: はい ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) ** 各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。タイプ: 整数必須: はい ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) ** エラスティッククラスターに割り当てられているシャードの数。最大数は 32 です。タイプ: 整数必須: はい ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) ** 自動スナップショットが保持される日数。タイプ: 整数必須: いいえ ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) ** エラスティッククラスターのクライアントトークン。タイプ: 文字列必須: いいえ ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) ** 新しいエラスティッククラスターの暗号化に使用する KMS キー識別子。 KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。暗号化キーが指定されていない場合、Amazon DocumentDB は KMS がアカウント用に作成したデフォルトの暗号化キーを使用します。各アカウントは Amazon のリージョンごとにデフォルトの暗号化キーを持ちます。タイプ: 文字列必須: いいえ ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) ** `backupRetentionPeriod` に応じた、自動バックアップが有効な場合に毎日自動バックアップが作成される時間範囲を指定します。タイプ: 文字列必須: いいえ ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 *形式:* `ddd:hh24:mi-ddd:hh24:mi` *デフォルト*: それぞれ 8 時間の時間ブロックからランダムに選択された AWS リージョン 30 分のウィンドウ。ランダムな曜日に発生します。 *有効な曜日*: 月、火、水、木、金、土、日 *制約*: 最小 30 分のウィンドウ。タイプ: 文字列必須: いいえ ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。タイプ: 整数必須: いいえ ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) ** 新しいエラスティッククラスターの Amazon EC2 サブネット ID。型: 文字列の配列必須: いいえ ** [tags](#API_elastic_CreateCluster_RequestSyntax) ** 新しいエラスティッククラスターに割り当てるタグ。タイプ: 文字列間のマッピングキーの長さ制限: 最小長さは 1 です。最大長は 128 です。キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。必須: いいえ ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) ** このクラスターに関連付ける EC2 VPC セキュリティグループのリスト。型: 文字列の配列必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) ** 作成された新しいエラスティッククラスター。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) # CreateClusterSnapshot エラスティッククラスターのスナップショットを作成します。 ## リクエストの構文 ``` POST /cluster-snapshot HTTP/1.1 Content-type: application/json { "clusterArn": "string", "snapshotName": "string", "tags": { "string" : "string" } } ``` ## URI リクエストパラメータリクエストでは URI パラメータを使用しません。 ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** スナップショットを作成するエラスティッククラスターの ARN 識別子。タイプ: 文字列必須: はい ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** 新しいエラスティッククラスタースナップショットの名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。必須: はい ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** 新しいエラスティッククラスターに割り当てるタグ。タイプ: 文字列間のマッピングキーの長さ制限: 最小長さは 1 です。最大長は 128 です。キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) ** 新しいエラスティッククラスタースナップショットに関する情報を返します。型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) # DeleteCluster エラスティッククラスターを削除します。 ## リクエストの構文 ``` DELETE /cluster/clusterArn HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) ** 削除するエラスティッククラスターの ARN 識別子。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) ** 新たに削除されたエラスティッククラスタースナップショットに関する情報を返します。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) # DeleteClusterSnapshot エラスティッククラスタースナップショットを削除します。 ## リクエストの構文 ``` DELETE /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) ** 削除するエラスティッククラスタースナップショットの ARN 識別子。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) ** 新たに削除されたエラスティッククラスタースナップショットに関する情報を返します。型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) # GetCluster 特定のエラスティッククラスターに関する情報を返します。 ## リクエストの構文 ``` GET /cluster/clusterArn HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_GetCluster_ResponseSyntax) ** 特定のエラスティッククラスターに関する情報を返します。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) # GetClusterSnapshot 特定のエラスティッククラスターナップショットに関する情報を返す ## リクエストの構文 ``` GET /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) ** エラスティッククラスタースナップショットの ARN 識別子。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "snapshot": { "adminUserName": "string", "clusterArn": "string", "clusterCreationTime": "string", "kmsKeyId": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "snapshotType": "string", "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) ** 特定のエラスティッククラスタースナップショットに関する情報を返します。型: [ClusterSnapshot](API_elastic_ClusterSnapshot.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) # GetPendingMaintenanceAction 保留中のすべてのメンテナンスアクションを取得します。 ## リクエストの構文 ``` GET /pending-action/resourceArn HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) ** 特定の Amazon リソースネーム (ARN) の保留中のメンテナンスアクションを取得します。長さの制約: 最小長は 1 です。最大長は 256 です。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) ** リソースの保留中のメンテナンスアクションに関する情報を入力します。型: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) # ListClusters プロビジョニングした Amazon DocumentDB クラスターに関する情報を返します。 ## リクエストの構文 ``` GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_elastic_ListClusters_RequestSyntax) ** レスポンスで受け取るエラスティッククラスタースナップショット結果の最大数。有効範囲: 最小値 1。最大値は 100 です。 ** [nextToken](#API_elastic_ListClusters_RequestSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。レスポンスにデータがなくなると、`nextToken` は返されません。 ## リクエスト本文リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "clusters": [ { "clusterArn": "string", "clusterName": "string", "status": "string" } ], "nextToken": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [clusters](#API_elastic_ListClusters_ResponseSyntax) ** Amazon DocumentDB エラスティッククラスターのリスト。型: [ClusterInList](API_elastic_ClusterInList.md) オブジェクトの配列 ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。レスポンスにデータがなくなると、`nextToken` は返されません。タイプ: 文字列 ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) # ListClusterSnapshots 指定された Elastic クラスターのスナップショットに関する情報を返します。 ## リクエストの構文 ``` GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) ** エラスティッククラスターの ARN 識別子。 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) ** レスポンスで受け取るエラスティッククラスタースナップショット結果の最大数。有効範囲: 最小値は 20 です。最大値は 100 です。 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。レスポンスにデータがなくなると、`nextToken` は返されません。 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) ** 返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。 + `automated` - Amazon DocumentDB が AWS アカウントに対して自動的に作成したすべてのクラスタースナップショットを返します。 + `manual` - AWS アカウント用に手動で作成したすべてのクラスタースナップショットを返します。 ## リクエスト本文リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "snapshots": [ { "clusterArn": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "status": "string" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** 以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。レスポンスにデータがなくなると、`nextToken` は返されません。タイプ: 文字列 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** 指定した Elastic クラスターのスナップショットのリスト。型: [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) オブジェクトの配列 ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) # ListPendingMaintenanceActions 保留中のすべてのメンテナンスアクションのリストを取得します。 ## リクエストの構文 ``` GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** レスポンスに含める結果の最大数。指定された `maxResults` の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。有効範囲: 最小値 1。最大値は 100 です。 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには `maxResults` で指定された値まで、マーカーを超えるレコードのみが含まれます。 ## リクエスト本文リクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "resourcePendingMaintenanceActions": [ { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } ] } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** リソースの保留中のメンテナンスアクションに関する情報を入力します。型: [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) オブジェクトの配列 ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** 以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータが表示された場合、レスポンスには `maxResults` で指定された値まで、マーカーを超えるレコードのみが含まれます。タイプ: 文字列 ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) # ListTagsForResource エラスティッククラスターリソースのすべてのタグを一覧表示します。 ## リクエストの構文 ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) ** エラスティッククラスターリソースの ARN 識別子。長さの制限：最小長 1、最大長は 1011 です。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) ** 指定されたエラスティッククラスターリソースに対するタグのリスト。タイプ: 文字列間のマッピングキーの長さ制限: 最小長さは 1 です。最大長は 128 です。キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。 ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) # RestoreClusterFromSnapshot スナップショットからエラスティッククラスターの復元します。 ## リクエストの構文 ``` POST /cluster-snapshot/snapshotArn/restore HTTP/1.1 Content-type: application/json { "clusterName": "string", "kmsKeyId": "string", "shardCapacity": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "tags": { "string" : "string" }, "vpcSecurityGroupIds": [ "string" ] } ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** エラスティッククラスタースナップショットの ARN 識別子。必須: はい ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** エラスティッククラスターの名前。タイプ: 文字列必須: はい ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 新しい Amazon DocumentDB エラスティッククラスターの暗号化に使用する KMS キー識別子。 KMS キー識別子は、KMS 暗号化キーの Amazon リソースネーム (ARN) です。KMS 暗号化キーを所有する Amazon アカウントと同じアカウントを使用して DB クラスターを作成する場合、KMS 暗号化キーの ARN の代わりに KMS キーのエイリアスを使用できます。ここで暗号化キーが指定されていない場合、Amazon DocumentDB は KMS がアカウント用に作成したデフォルトの暗号化キーを使用します。各アカウントは Amazon のリージョンごとにデフォルトの暗号化キーを持ちます。タイプ: 文字列必須: いいえ ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 新しく復元された Elastic クラスター内の各シャードの容量。タイプ: 整数必須: いいえ ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。タイプ: 整数必須: いいえ ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** エラスティッククラスターの Amazon EC2 サブネット ID。型: 文字列の配列必須: いいえ ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** 復元されたエラスティッククラスターに割り当てるキーと値のペアの配列形式でのタグ名のリスト。キーがタグ名、値がキー値です。タイプ: 文字列間のマッピングキーの長さ制限: 最小長さは 1 です。最大長は 128 です。キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。必須: いいえ ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** このエラスティッククラスターに関連付ける EC2 VPC セキュリティグループのリスト。型: 文字列の配列必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) ** 復元されたエラスティッククラスターに関する情報を返します。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ServiceQuotaExceededException ** アクションのサービスクォータを超えました。 HTTP ステータスコード: 402 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) # StartCluster `clusterARN` で指定された停止中の Elastic クラスターを再開します。 ## リクエストの構文 ``` POST /cluster/clusterArn/start HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_StartCluster_ResponseSyntax) ** 特定のエラスティッククラスターに関する情報を返します。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) # StopCluster `clusterArn` で指定された実行中の Elastic クラスターを停止します。これには、この Elastic クラスターが *利用可能な* 状態である必要があります。 ## リクエストの構文 ``` POST /cluster/clusterArn/stop HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_StopCluster_ResponseSyntax) ** 特定のエラスティッククラスターに関する情報を返します。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) # TagResource エラスティッククラスターリソースにメタデータタグを追加します ## リクエストの構文 ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_TagResource_RequestSyntax) ** エラスティッククラスターリソースの ARN 識別子。長さの制限：最小長 1、最大長は 1011 です。必須: はい ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [tags](#API_elastic_TagResource_RequestSyntax) ** エラスティッククラスターリソースに割り当てられているタグ。タイプ: 文字列間のマッピングキーの長さ制限: 最小長さは 1 です。最大長は 128 です。キーパターン: `(?!aws:)[a-zA-Z+-=._:/]+` 値の長さの制限: 最小長は 0 です。最大長は 256 です。必須: はい ## レスポンスの構文 ``` HTTP/1.1 200 ``` ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) # UntagResource エラスティッククラスターリソースからメタデータタグを削除します。 ## リクエストの構文 ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) ** エラスティッククラスターリソースの ARN 識別子。長さの制限：最小長 1、最大長は 1011 です。必須: はい ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) ** エラスティッククラスターリソースから削除するタグのキー。配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。長さの制限：最小長 1、最大長は 128 です。パターン: `(?!aws:)[a-zA-Z+-=._:/]+` 必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 ``` ## レスポンス要素アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。 ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) # UpdateCluster エラスティッククラスターを変更します。これには、管理者ユーザー名/パスワードの更新、API バージョンのアップグレード、バックアップウィンドウとメンテナンスウィンドウの設定が含まれます ## リクエストの構文 ``` PUT /cluster/clusterArn HTTP/1.1 Content-type: application/json { "adminUserPassword": "string", "authType": "string", "backupRetentionPeriod": number, "clientToken": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターの ARN 識別子。必須: はい ## リクエストボディリクエストは以下の JSON 形式のデータを受け入れます。 ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスター管理者に関連付けられているパスワード。このパスワードをには、スラッシュ (/)、二重引用符 (")、または「at」記号 (@) 以外の印刷可能な ASCII 文字を含むことができます。制約: 8 ～ 100 文字の長さの英数字である必要があります。タイプ: 文字列必須: いいえ ** [authType](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターへのアクセスに使用するパスワードの取得先の特定に使用している認証タイプ。有効なタイプは、`PLAIN_TEXT` または `SECRET_ARN` です。型: 文字列有効な値：`PLAIN_TEXT | SECRET_ARN` 必須：いいえ ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) ** 自動スナップショットが保持される日数。タイプ: 整数必須: いいえ ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターのクライアントトークン。タイプ: 文字列必須: いいえ ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) ** `backupRetentionPeriod` に応じた、自動バックアップが有効な場合に毎日自動バックアップが作成される時間範囲を指定します。タイプ: 文字列必須: いいえ ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) ** 週 1 回のシステムメンテナンスを実行できる時間帯 (世界標準時 (UTC))。 *形式:* `ddd:hh24:mi-ddd:hh24:mi` *デフォルト*: それぞれ 8 時間の時間ブロックからランダムに選択された AWS リージョン 30 分のウィンドウ。ランダムな曜日に発生します。 *有効な曜日*: 月、火、水、木、金、土、日 *制約*: 最小 30 分のウィンドウ。タイプ: 文字列必須: いいえ ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) ** 各エラスティッククラスターシャードに割り当てられている vCPU の数。最大数は 64 です。使用できる値は、2、4、8、16、32、64 です。タイプ: 整数必須: いいえ ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターに割り当てられているシャードの数。最大数は 32 です。タイプ: 整数必須: いいえ ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) ** Elastic クラスター内のすべてのシャードに適用されるレプリカインスタンスの数。`shardInstanceCount` 値が 1 の場合、ライターインスタンスが 1 つあり、それ以外の追加のインスタンスはすべてレプリカであり、読み取りや可用性の向上に使用できます。タイプ: 整数必須: いいえ ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) ** エラスティッククラスターの Amazon EC2 サブネット ID。型: 文字列の配列必須: いいえ ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) ** このエラスティッククラスターに関連付ける EC2 VPC セキュリティグループのリスト。型: 文字列の配列必須: いいえ ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "cluster": { "adminUserName": "string", "authType": "string", "backupRetentionPeriod": number, "clusterArn": "string", "clusterEndpoint": "string", "clusterName": "string", "createTime": "string", "kmsKeyId": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "shardCapacity": number, "shardCount": number, "shardInstanceCount": number, "shards": [ { "createTime": "string", "shardId": "string", "status": "string" } ], "status": "string", "subnetIds": [ "string" ], "vpcSecurityGroupIds": [ "string" ] } } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) ** 更新されたエラスティッククラスターに関する情報を返します。型: [Cluster](API_elastic_Cluster.md) オブジェクト ## エラーすべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。 ** AccessDeniedException ** アクションを実行するための十分なアクセス許可がない場合に発生する例外。 ** message ** アクセスが拒否された理由を説明するエラーメッセージ。 HTTP ステータスコード: 403 ** ConflictException ** アクセス競合が発生しました。 ** resourceId ** アクセスの競合が発生したリソースの ID。 ** resourceType ** アクセスの競合が発生したリソースのタイプ。 HTTP ステータスコード: 409 ** InternalServerException ** 内部サーバーエラーが発生しました。 HTTP ステータスコード: 500 ** ResourceNotFoundException ** 指定されたリソースが見つかりませんでした。 ** message ** 失敗を説明するエラーメッセージ。 ** resourceId ** 見つけられなかったリソースの ID。 ** resourceType ** 見つけられなかったリソースのタイプ。 HTTP ステータスコード: 404 ** ThrottlingException ** ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。 ** retryAfterSeconds ** オペレーションを再試行する前に待つ秒数。 HTTP ステータスコード: 429 ** ValidationException ** 検証例外の定義がある構造。 ** fieldList ** 検証例外が発生したフィールドのリスト。 ** message ** 検証例外を説明するエラーメッセージ。 ** reason ** 検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)