Todos os produtos
Search
Central de documentação

:UpdateKeyDescription

Última atualização: Jul 08, 2026

Atualiza a descrição de uma CMK.

Esta operação substitui a descrição de uma chave mestra do cliente (CMK) pela descrição especificada. O parâmetro Description define a descrição original da CMK ao chamar a operação DescribeKey. Use esta operação para crie, modifique ou exclua a descrição de uma CMK.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

UpdateKeyDescription

A operação a ser executada. Defina o valor como UpdateKeyDescription.

KeyId

String

Sim

1234abcd-12ab-34cd-56ef-12345678****

O ID da CMK. O ID deve ser globalmente único.

Description

String

Sim

key description example

A descrição da CMK. Inclui a finalidade da CMK, como os tipos de dados a proteger e as aplicações que podem usar a CMK.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

3455b9b4-95c1-419d-b310-db6a53b09a39

O ID da solicitação, usado para localizar e solucionar problemas.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=UpdateKeyDescription
&KeyId=1234abcd-12ab-34cd-56ef-12345678****
&Description=key description example
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateKeyDescriptionResponse>
    <RequestId>3455b9b4-95c1-419d-b310-db6a53b09a39</RequestId>
</UpdateKeyDescriptionResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.