update_key_description `async` ¶

update_key_description(
    key_id: KeyIdType,
    description: DescriptionType,
    *,
    config_overrides: Optional[AsyncKMSClientConfig] = None,
) -> None

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:UpdateKeyDescription (key policy)

Related operations

CreateKey
DescribeKey

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Parameters:

key_id (KeyIdType) –
Updates the description of the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:
- Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
description (DescriptionType) –

New description for the KMS key.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Raises:

DependencyTimeoutException –

The system timed out while trying to fulfill the request. You can retry the request.
InvalidArnException –

The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
KMSInternalException –

The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException –
The request was rejected because the state of the specified resource is not valid for this request.

This exceptions means one of the following:
- The key state of the KMS key is not compatible with the operation.
  
  To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide .
- For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.
NotFoundException –

The request was rejected because the specified entity or resource could not be found.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To update the description of a KMS key The following example updates the description of the specified KMS key.

>>> await client.update_key_description(key_id='1234abcd-12ab-34cd-56ef-1234567890ab', description='Example description that indicates the intended use of this KMS key.')

Source code in docs_src/capo_kms/_services/async_kms.py

async def update_key_description(
    self,
    key_id: "capo_kms.types.key_id_type.KeyIdType",
    description: "capo_kms.types.description_type.DescriptionType",
    *,
    config_overrides: Optional[AsyncKMSClientConfig] = None,
) -> None:
    """<p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</a>. </p> <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p> <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p> <p> <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p> <p> <b>Related operations</b> </p> <ul> <li> <p> <a>CreateKey</a> </p> </li> <li> <p> <a>DescribeKey</a> </p> </li> </ul> <p> <b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>

    Args:
        key_id: <p>Updates the description of the specified KMS key.</p> <p>Specify the key ID or key ARN of the KMS key.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul> <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
        description: <p>New description for the KMS key.</p> <important> <p>Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important>

    Raises:
        capo_kms.errors.dependency_timeout_exception.DependencyTimeoutException: <p>The system timed out while trying to fulfill the request. You can retry the request.</p>
        capo_kms.errors.invalid_arn_exception.InvalidArnException: <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.</p>
        capo_kms.errors.kms_internal_exception.KMSInternalException: <p>The request was rejected because an internal exception occurred. The request can be retried.</p>
        capo_kms.errors.kms_invalid_state_exception.KMSInvalidStateException: <p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>This exceptions means one of the following:</p> <ul> <li> <p>The key state of the KMS key is not compatible with the operation. </p> <p>To find the key state, use the <a>DescribeKey</a> operation. For more information about which key states are compatible with each KMS operation, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i> <i>Key Management Service Developer Guide</i> </i>.</p> </li> <li> <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p> </li> </ul>
        capo_kms.errors.not_found_exception.NotFoundException: <p>The request was rejected because the specified entity or resource could not be found.</p>
        capo_kms.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update the description of a KMS key
        The following example updates the description of the specified KMS key.

        >>> await client.update_key_description(key_id='1234abcd-12ab-34cd-56ef-1234567890ab', description='Example description that indicates the intended use of this KMS key.')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kms.types.update_key_description_request.UpdateKeyDescriptionRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_kms._operations.trent_service.update_key_description

        (
            output,
            http_response,
        ) = await capo_kms._operations.trent_service.update_key_description.async_update_key_description(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateKeyDescription")
    )
    input_: capo_kms.types.update_key_description_request.UpdateKeyDescriptionRequest = {
        "key_id": key_id,
        "description": description,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

update_key_description async ¶

update_key_description `async` ¶