As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # Amazon DocumentDB Elastic Clusters As seguintes ações são compatíveis com Amazon DocumentDB Elastic Clusters: + [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 O tipo de ação de manutenção pendente a ser aplicada ao recurso. ## Sintaxe da Solicitação ``` POST /pending-action HTTP/1.1 Content-type: application/json { "applyAction": "string", "applyOn": "string", "optInType": "string", "resourceArn": "string" } ``` ## Parâmetros da solicitação de URI A solicitação não usa nenhum parâmetro de URI. ## Corpo da Solicitação A solicitação aceita os dados a seguir no formato JSON. ** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** A ação de manutenção pendente a ser aplicada ao recurso. As ações válidas são: + `ENGINE_UPDATE ` + `ENGINE_UPGRADE` + `SECURITY_UPDATE` + `OS_UPDATE` + `MASTER_USER_PASSWORD_UPDATE` Tipo: string Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256. Obrigatório: sim ** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** Um valor que especifica o tipo de solicitação de inclusão ou desfaz uma solicitação de inclusão. Uma solicitação de inclusão do tipo `IMMEDIATE` não pode ser desfeita. Tipo: string Valores válidos: `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN` Obrigatório: Sim ** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** O nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplica. Tipo: string Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256. Obrigatório: sim ** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) ** Uma data específica para aplicar a ação de manutenção pendente. Obrigatório se opt-in-type for `APPLY_ON`. Formato: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`. Tipo: string Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256. Obrigatório: não ## Sintaxe da resposta ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) ** A saída da ação de manutenção pendente sendo aplicada. Tipo: objeto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction) # CopyClusterSnapshot Copia um snapshot de um cluster elástico. ## Sintaxe da Solicitação ``` POST /cluster-snapshot/snapshotArn/copy HTTP/1.1 Content-type: application/json { "copyTags": boolean, "kmsKeyId": "string", "tags": { "string" : "string" }, "targetSnapshotName": "string" } ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** O identificador de nome do recurso da Amazon (ARN) do snapshot do cluster elástico. Obrigatório: Sim ## Corpo da Solicitação A solicitação aceita os dados a seguir no formato JSON. ** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** O identificador do snapshot de cluster elástico novo a ser criado a partir do snapshot de cluster de origem. Esse parâmetro não diferencia maiúsculas de minúsculas. Restrições: + Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens. + O primeiro caractere deve ser uma letra. + Não pode terminar com um hífen ou conter dois hifens consecutivos. Exemplo: `elastic-cluster-snapshot-5` Tipo: string Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63. Obrigatório: Sim ** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** Defina `true` para copiar todas as tags do snapshot do cluster de origem no snapshot do cluster elástico de destino. O padrão é `false`. Tipo: booliano Obrigatório: não ** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** O ID da chave AWS KMS para um snapshot de cluster elástico criptografado. O ID da chave AWS KMS é o Amazon Resource Name (ARN) AWS , o identificador da chave KMS ou AWS o alias da chave KMS da chave de criptografia KMS. AWS Se você copiar um snapshot de cluster elástico criptografado da sua AWS conta, poderá especificar um valor para `KmsKeyId` criptografar a cópia com uma nova chave de criptografia AWS S KMS. Se você não especificar um valor para `KmsKeyId`, a cópia do snapshot do cluster elástico será criptografada com a mesma chave do `AWS` KMS que o snapshot do cluster elástico de origem. Se você copiar um snapshot do cluster elástico não criptografado e especificar um valor para o parâmetro `KmsKeyId`, um erro será retornado. Tipo: string Obrigatório: não ** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) ** As tags a serem atribuídas ao snapshot do cluster elástico. Tipo: mapa de string para string Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128. Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+` Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256. Obrigatório: não ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) ** Retorna informações sobre um snapshot de cluster elástico específico. Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ServiceQuotaExceededException ** O Service Quotas para a ação foi excedida. Código de status HTTP: 402 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot) # CreateCluster Cria um novo cluster elástico do Amazon DocumentDB e retorna sua estrutura de cluster. ## Sintaxe da Solicitação ``` 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" ] } ``` ## Parâmetros da solicitação de URI A solicitação não usa nenhum parâmetro de URI. ## Corpo da Solicitação A solicitação aceita os dados a seguir no formato JSON. ** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) ** O nome do administrador dos clusters elásticos do Amazon DocumentDB. *Restrições*: + Deve ter de 1 a 63 letras ou números. + O primeiro caractere deve ser uma letra. + Não pode ser uma palavra reservada. Tipo: String Obrigatório: Sim ** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) ** A senha do administrador dos clusters elásticos do Amazon DocumentDB. A senha pode conter qualquer caractere ASCII imprimível. *Restrições*: + Deve conter de 8 a 100 caracteres. + Não pode conter barra (/), aspas duplas (“) ou arroba (“@”). Tipo: String Obrigatório: Sim ** [authType](#API_elastic_CreateCluster_RequestSyntax) ** O tipo de autenticação usado para determinar onde buscar a senha usada para acessar o cluster elástico. Os tipos válidos são `PLAIN_TEXT` e `SECRET_ARN`. Tipo: String Valores válidos: `PLAIN_TEXT | SECRET_ARN` Obrigatório: Sim ** [clusterName](#API_elastic_CreateCluster_RequestSyntax) ** O nome do novo cluster elástico. Este parâmetro é armazenado como uma string com letras minúsculas. *Restrições*: + Deve conter de 1 a 63 caracteres, incluindo letras, números ou hífens. + O primeiro caractere deve ser uma letra. + Não pode terminar com um hífen ou conter dois hifens consecutivos. *Exemplo*: `my-cluster` Tipo: String Obrigatório: Sim ** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) ** O número de v CPUs atribuído a cada fragmento elástico do cluster. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64. Tipo: Inteiro Obrigatório: Sim ** [shardCount](#API_elastic_CreateCluster_RequestSyntax) ** O número de fragmentos atribuídos ao cluster elástico. O máximo é 32. Tipo: inteiro Obrigatório: Sim ** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) ** O número de dias durante os quais os snapshots automáticos são retidos. Tipo: inteiro Obrigatório: não ** [clientToken](#API_elastic_CreateCluster_RequestSyntax) ** O token do cliente para o cluster elástico. Tipo: String Obrigatório: Não ** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) ** O identificador da chave do KMS a ser usado para criptografar o novo cluster elástico. O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando um cluster usando a mesma conta da Amazon que possui essa chave de criptografia KMS, poderá usar o alias da chave KMS em vez do ARN como chave de criptografia KMS. Se uma chave de criptografia não for especificada, o Amazon DocumentDB usará a chave de criptografia padrão que o KMS cria para sua conta. Sua conta tem uma chave de criptografia padrão diferente para cada região da Amazon. Tipo: String Obrigatório: não ** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) ** O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `backupRetentionPeriod`. Tipo: string Obrigatório: não ** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) ** O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC). *Formato*: `ddd:hh24:mi-ddd:hh24:mi` *Padrão*: uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma Região da AWS, ocorrendo em um dia aleatório da semana. *Dias válidos*: Seg, Ter, Qua, Qui, Sex, Sáb, Dom *Restrições*: janela mínima de 30 minutos. Tipo: String Obrigatório: não ** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) ** O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em `shardInstanceCount` significa que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade. Tipo: inteiro Obrigatório: não ** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) ** A sub-rede Amazon EC2 IDs para o novo cluster elástico. Tipo: matriz de strings Obrigatório: Não ** [tags](#API_elastic_CreateCluster_RequestSyntax) ** As tags a serem atribuídas ao cluster. Tipo: mapa de string para string Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128. Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+` Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256. Obrigatório: Não ** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) ** Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse novo cluster elástico. Tipo: Matriz de strings Obrigatório: Não ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [cluster](#API_elastic_CreateCluster_ResponseSyntax) ** O novo cluster elástico que foi criado. Tipo: objeto [Cluster](API_elastic_Cluster.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ServiceQuotaExceededException ** O Service Quotas para a ação foi excedida. Código de status HTTP: 402 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster) # CreateClusterSnapshot Cria um snapshot de um cluster elástico. ## Sintaxe da Solicitação ``` POST /cluster-snapshot HTTP/1.1 Content-type: application/json { "clusterArn": "string", "snapshotName": "string", "tags": { "string" : "string" } } ``` ## Parâmetros da solicitação de URI A solicitação não usa nenhum parâmetro de URI. ## Corpo da Solicitação A solicitação aceita os dados a seguir no formato JSON. ** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** O identificador ARN do cluster elástico do qual você deseja criar um snapshot. Tipo: String Obrigatório: Sim ** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** O nome do novo snapshot do cluster elástico. Tipo: string Restrições de tamanho: o tamanho mínimo é 1. O tamanho máximo é 63. Obrigatório: Sim ** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) ** As tags a serem atribuídas ao snapshot do cluster elástico. Tipo: Mapa de string para string Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128. Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+` Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256. Obrigatório: não ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) ** Retorna informações sobre o novo snapshot do cluster elástico. Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ServiceQuotaExceededException ** O Service Quotas para a ação foi excedida. Código de status HTTP: 402 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot) # DeleteCluster Exclua um cluster elástico. ## Sintaxe da Solicitação ``` DELETE /cluster/clusterArn HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) ** O identificador ARN da captura de tela do cluster elástico que deve ser excluído. Obrigatório: sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) ** Retorna informações sobre a captura de tela do cluster elástico recém excluído. Tipo: objeto [Cluster](API_elastic_Cluster.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster) # DeleteClusterSnapshot Exclua um instantâneo do cluster elástico. ## Sintaxe da Solicitação ``` DELETE /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) ** O identificador ARN do snapshot do cluster elástico que deve ser excluído. Obrigatório: Sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) ** Retorna informações sobre o snapshot do cluster elástico recém-excluído. Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot) # GetCluster Retorna informações sobre um cluster elástico específico. ## Sintaxe da Solicitação ``` GET /cluster/clusterArn HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [clusterArn](#API_elastic_GetCluster_RequestSyntax) ** O identificador ARN do cluster elástico. Obrigatório: Sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [cluster](#API_elastic_GetCluster_ResponseSyntax) ** Retorna informações sobre um cluster elástico específico. Tipo: objeto [Cluster](API_elastic_Cluster.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de status HTTP: 403 ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster) # GetClusterSnapshot Retorna informações sobre um snapshot de cluster elástico específico. ## Sintaxe da Solicitação ``` GET /cluster-snapshot/snapshotArn HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) ** O identificador ARN do snapshot do cluster elástico. Obrigatório: Sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) ** Retorna informações sobre um snapshot de cluster elástico específico. Tipo: objeto [ClusterSnapshot](API_elastic_ClusterSnapshot.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de status HTTP: 403 ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot) # GetPendingMaintenanceAction Recupera todas as ações de manutenção que estão pendentes. ## Sintaxe da Solicitação ``` GET /pending-action/resourceArn HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) ** Recupera ações de manutenção pendentes para um determinado nome do recurso da Amazon (ARN). Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 256. Obrigatório: sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` HTTP/1.1 200 Content-type: application/json { "resourcePendingMaintenanceAction": { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) ** Fornece informações sobre uma ação de manutenção pendente para um recurso. Tipo: objeto [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction) # ListClusters Retorna informações sobre clusters elásticos do Amazon DocumentDB provisionados. ## Sintaxe da Solicitação ``` GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [maxResults](#API_elastic_ListClusters_RequestSyntax) ** O número máximo de resultados de instantâneos de cluster elástico a ser recebido na resposta. Faixa válida: valor mínimo de 1. Valor máximo de 100. ** [nextToken](#API_elastic_ListClusters_RequestSyntax) ** Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`. Se não houver mais dados na resposta, `nextToken` não será retornado. ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` HTTP/1.1 200 Content-type: application/json { "clusters": [ { "clusterArn": "string", "clusterName": "string", "status": "string" } ], "nextToken": "string" } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [clusters](#API_elastic_ListClusters_ResponseSyntax) ** Uma lista de clusters elásticos do Amazon DocumentDB. Tipo: matriz de objetos [ClusterInList](API_elastic_ClusterInList.md) ** [nextToken](#API_elastic_ListClusters_ResponseSyntax) ** Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`. Se não houver mais dados na resposta, `nextToken` não será retornado. Tipo: string ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de status HTTP: 403 ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters) # ListClusterSnapshots Retorna informações sobre instantâneos para um cluster elástico específico. ## Sintaxe da Solicitação ``` GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) ** O identificador ARN do cluster elástico. ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) ** O número máximo de resultados de instantâneos de cluster elástico a ser recebido na resposta. Intervalo válido: valor mínimo de 20. Valor máximo de 100. ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) ** Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`. Se não houver mais dados na resposta, `nextToken` não será retornado. ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) ** O tipo de snapshots de cluster a ser retornado. É possível especificar um dos seguintes valores: + `automated`- Retorne todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para AWS sua conta. + `manual`- Retorne todos os instantâneos do cluster que você criou manualmente para sua AWS conta. ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "snapshots": [ { "clusterArn": "string", "snapshotArn": "string", "snapshotCreationTime": "string", "snapshotName": "string", "status": "string" } ] } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** Um token de paginação fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além desse token, até o valor especificado por `max-results`. Se não houver mais dados na resposta, `nextToken` não será retornado. Tipo: string ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) ** Uma lista de instantâneos para um cluster elástico especificado. Tipo: matriz de objetos [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de status HTTP: 403 ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots) # ListPendingMaintenanceActions Recupera uma lista de todas as ações de manutenção que estão pendentes. ## Sintaxe da Solicitação ``` GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** O número máximo de registros a serem incluídos na resposta. Se existirem mais registros que o valor `maxResults` especificado, um token de paginação (marcador) será incluído na resposta para que os resultados restantes possam ser recuperados. Faixa válida: valor mínimo de 1. Valor máximo de 100. ** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) ** Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `maxResults`. ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` 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" } ] } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** Fornece informações sobre uma ação de manutenção pendente para um recurso. Tipo: matriz de objetos [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md) ** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) ** Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for exibido, as respostas incluirão apenas os registros além do marcador, até o valor especificado por `maxResults`. Tipo: string ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de status HTTP: 403 ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions) # ListTagsForResource Lista todas as tags em um recurso de cluster elástico ## Sintaxe da Solicitação ``` GET /tags/resourceArn HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) ** O identificador ARN do recurso cluster elástico. Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011. Obrigatório: Sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "string" } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) ** A lista de tags do recurso de cluster elástico especificado. Tipo: Mapa de string para string Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128. Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+` Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256. ## Erros Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md). ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource) # RestoreClusterFromSnapshot Para restaurar um cluster a partir de um snapshot ## Sintaxe da Solicitação ``` 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" ] } ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** O identificador ARN do snapshot do cluster elástico. Obrigatório: Sim ## Corpo da Solicitação A solicitação aceita os dados a seguir no formato JSON. ** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** O nome do cluster. Tipo: String Obrigatório: Sim ** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** O identificador de chave KMS a ser usado para criptografar o novo cluster de clusters elásticos Amazon DocumentDB. O identificador de chave KMS é o Amazon Resource Name (ARN) da chave de criptografia KMS. Se você estiver criando um cluster usando a mesma conta da Amazon que possui essa chave de criptografia KMS, poderá usar o alias da chave KMS em vez do ARN como chave de criptografia KMS. Se uma chave de criptografia não for especificada aqui, o Amazon DocumentDB usará a chave de criptografia padrão que o KMS cria para sua conta. Sua conta tem uma chave de criptografia padrão diferente para cada região da Amazon. Tipo: String Obrigatório: não ** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** A capacidade de cada fragmento no novo cluster elástico restaurado. Tipo: inteiro Obrigatório: não ** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em `shardInstanceCount` significa que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade. Tipo: inteiro Obrigatório: não ** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** A sub-rede Amazon EC2 IDs para o cluster elástico. Tipo: matriz de strings Obrigatório: Não ** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** Uma lista dos nomes de tags a serem atribuídos ao cluster elástico restaurado, na forma de uma matriz de pares de valores-chave em que a chave é o nome da tag e o valor é o valor da chave. Tipo: mapa de strings para string Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128. Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+` Restrições de comprimento do valor: comprimento mínimo de 0. Tamanho máximo de 256. Obrigatório: Não ** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) ** Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse cluster elástico. Tipo: Matriz de strings Obrigatório: Não ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) ** Retorna informações sobre um cluster elástico restaurado. Tipo: objeto [Cluster](API_elastic_Cluster.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ServiceQuotaExceededException ** O Service Quotas para a ação foi excedida. Código de status HTTP: 402 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot) # StartCluster Reinicia o cluster elástico interrompido especificado por `clusterARN`. ## Sintaxe da Solicitação ``` POST /cluster/clusterArn/start HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [clusterArn](#API_elastic_StartCluster_RequestSyntax) ** O identificador ARN do cluster elástico. Obrigatório: Sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [cluster](#API_elastic_StartCluster_ResponseSyntax) ** Retorna informações sobre um cluster elástico específico. Tipo: objeto [Cluster](API_elastic_Cluster.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de status HTTP: 403 ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster) # StopCluster Interrompe o cluster elástico em execução especificado por `clusterArn`. O cluster elástico deve estar no estado *disponível*. ## Sintaxe da Solicitação ``` POST /cluster/clusterArn/stop HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [clusterArn](#API_elastic_StopCluster_RequestSyntax) ** O identificador ARN do cluster elástico. Obrigatório: Sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [cluster](#API_elastic_StopCluster_ResponseSyntax) ** Retorna informações sobre um cluster elástico específico. Tipo: objeto [Cluster](API_elastic_Cluster.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de status HTTP: 403 ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster) # TagResource Adiciona tags de metadados a um recurso de cluster elástico ## Sintaxe da Solicitação ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [resourceArn](#API_elastic_TagResource_RequestSyntax) ** O identificador ARN do recurso cluster elástico. Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011. Obrigatório: Sim ## Corpo da Solicitação A solicitação aceita os dados a seguir no formato JSON. ** [tags](#API_elastic_TagResource_RequestSyntax) ** As tags atribuídas ao recurso de cluster elástico. Tipo: Mapa de string para string Restrições de Tamanho de Chave: tamanho mínimo de 1. O comprimento máximo é 128. Padrão da chave: `(?!aws:)[a-zA-Z+-=._:/]+` Restrições de comprimento do valor: comprimento mínimo de 0. O comprimento máximo é 256. Obrigatório: sim ## Sintaxe da resposta ``` HTTP/1.1 200 ``` ## Elementos de Resposta Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio. ## Erros Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md). ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource) # UntagResource Remove tags de metadados de um recurso de cluster elástico. ## Sintaxe da Solicitação ``` DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [resourceArn](#API_elastic_UntagResource_RequestSyntax) ** O identificador ARN do recurso cluster elástico. Restrições de Tamanho: tamanho mínimo 1. O comprimento máximo é 1011. Obrigatório: Sim ** [tagKeys](#API_elastic_UntagResource_RequestSyntax) ** As chaves de tag a serem removidas do recurso de cluster elástico. Membros da Matriz: Número mínimo de 0 itens. Número máximo de 50 itens. Restrições de Tamanho: Tamanho mínimo 1. O tamanho máximo é 128. Padrão: `(?!aws:)[a-zA-Z+-=._:/]+` Obrigatório: Sim ## Corpo da Solicitação Essa solicitação não tem corpo. ## Sintaxe da resposta ``` HTTP/1.1 200 ``` ## Elementos de Resposta Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio. ## Erros Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md). ** InternalServerException ** Ocorreu um erro interno do servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource) # UpdateCluster Modifica um cluster elástico. Isso inclui atualizar o nome de usuário/senha do administrador, atualizar a versão da API e configurar uma janela de backup e uma janela de manutenção ## Sintaxe da Solicitação ``` 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" ] } ``` ## Parâmetros da Solicitação de URI A solicitação usa os seguintes parâmetros de URI: ** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) ** O identificador ARN do cluster elástico. Obrigatório: Sim ## Corpo da Solicitação A solicitação aceita os dados a seguir no formato JSON. ** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) ** A senha associada ao administrador do cluster elástico. Ela pode conter qualquer caractere ASCII imprimível, exceto barra (/), aspas duplas (") ou arroba ("@"). *Restrições*: deve conter de 8 a 100 caracteres. Tipo: String Obrigatório: Não ** [authType](#API_elastic_UpdateCluster_RequestSyntax) ** O tipo de autenticação usado para determinar onde buscar a senha usada para acessar o cluster elástico. Os tipos válidos são `PLAIN_TEXT` e `SECRET_ARN`. Tipo: String Valores válidos: `PLAIN_TEXT | SECRET_ARN` Obrigatório: não ** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) ** O número de dias durante os quais os snapshots automáticos são retidos. Tipo: inteiro Obrigatório: não ** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) ** O token do cliente para o cluster elástico. Tipo: String Obrigatório: não ** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) ** O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `backupRetentionPeriod`. Tipo: string Obrigatório: não ** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) ** O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC). *Formato*: `ddd:hh24:mi-ddd:hh24:mi` *Padrão*: uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma Região da AWS, ocorrendo em um dia aleatório da semana. *Dias válidos*: Seg, Ter, Qua, Qui, Sex, Sáb, Dom *Restrições*: janela mínima de 30 minutos. Tipo: String Obrigatório: não ** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) ** O número de v CPUs atribuído a cada fragmento elástico do cluster. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64. Tipo: Inteiro Obrigatório: Não ** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) ** O número de fragmentos atribuídos ao cluster elástico. O máximo é 32. Tipo: Inteiro Obrigatório: não ** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) ** O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em `shardInstanceCount` significa que há uma instância de gravação, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade. Tipo: inteiro Obrigatório: não ** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) ** A sub-rede Amazon EC2 IDs para o cluster elástico. Tipo: matriz de strings Obrigatório: Não ** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) ** Uma lista de grupos de segurança da VPC do EC2 a serem associados a esse cluster elástico. Tipo: Matriz de strings Obrigatório: Não ## Sintaxe da resposta ``` 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" ] } } ``` ## Elementos de resposta Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço. ** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) ** Retorna informações sobre o cluster elástico atualizado. Tipo: objeto [Cluster](API_elastic_Cluster.md) ## Erros Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md). ** AccessDeniedException ** Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação. ** message ** Uma mensagem de erro explicando por que o acesso foi negado. Código de Status HTTP: 403 ** ConflictException ** Houve um conflito de acesso. ** resourceId ** O ID do recurso em que houve um conflito de acesso. ** resourceType ** O tipo do recurso em que houve um conflito de acesso. Código de Status HTTP: 409 ** InternalServerException ** Ocorreu um erro interno no servidor. Código de Status HTTP: 500 ** ResourceNotFoundException ** O recurso especificado não foi localizado. ** message ** Uma mensagem de erro descrevendo a falha. ** resourceId ** O ID do recurso que não pôde ser localizado. ** resourceType ** O tipo do recurso que não pôde ser localizado. Código de status HTTP: 404 ** ThrottlingException ** ThrottlingException será lançado quando a solicitação for negada devido à limitação da solicitação. ** retryAfterSeconds ** O número de segundos a esperar antes de repetir a operação. Código de Status HTTP: 429 ** ValidationException ** Uma estrutura que define uma exceção de validação. ** fieldList ** Uma lista dos campos onde ocorreu a exceção de validação. ** message ** Uma mensagem de erro descrevendo a exceção de validação. ** reason ** O motivo pelo qual a exceção de validação ocorreu (um dentre `unknownOperation`, `cannotParse`, `fieldValidationFailed` ou `other`). Código de Status HTTP: 400 ## Consulte também Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: + [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)