Skip to content

tag_resource async

tag_resource(
    resource_id: ResourceId,
    tag_list: TagList,
    *,
    config_overrides: Optional[AsyncCloudHSMV2ClientConfig] = None,
) -> TagResourceResponse

Adds or overwrites one or more tags for the specified CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

Parameters:

  • resource_id (ResourceId) –

    The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.

  • tag_list (TagList) –

    A list of one or more tags.

Raises:

Source code in docs_src/capo_cloudhsm_v2/_services/async_cloud_hsmv2.py
async def tag_resource(
    self,
    resource_id: "capo_cloudhsm_v2.types.resource_id.ResourceId",
    tag_list: "capo_cloudhsm_v2.types.tag_list.TagList",
    *,
    config_overrides: Optional[AsyncCloudHSMV2ClientConfig] = None,
) -> "capo_cloudhsm_v2.types.tag_resource_response.TagResourceResponse":
    """<p>Adds or overwrites one or more tags for the specified CloudHSM cluster.</p> <p> <b>Cross-account use:</b> No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.</p>

    Args:
        resource_id: <p>The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use <a>DescribeClusters</a>.</p>
        tag_list: <p>A list of one or more tags.</p>

    Raises:
        capo_cloudhsm_v2.errors.cloud_hsm_access_denied_exception.CloudHsmAccessDeniedException: <p>The request was rejected because the requester does not have permission to perform the requested operation.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_internal_failure_exception.CloudHsmInternalFailureException: <p>The request was rejected because of an CloudHSM internal failure. The request can be retried.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_invalid_request_exception.CloudHsmInvalidRequestException: <p>The request was rejected because it is not a valid request.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_resource_limit_exceeded_exception.CloudHsmResourceLimitExceededException: <p>The request was rejected because it exceeds an CloudHSM limit.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_resource_not_found_exception.CloudHsmResourceNotFoundException: <p>The request was rejected because it refers to a resource that cannot be found.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_service_exception.CloudHsmServiceException: <p>The request was rejected because an error occurred.</p>
        capo_cloudhsm_v2.errors.cloud_hsm_tag_exception.CloudHsmTagException: <p>The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.</p>
        capo_cloudhsm_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudhsm_v2.types.tag_resource_request.TagResourceRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudhsm_v2.types.tag_resource_response.TagResourceResponse"
    ]:
        import capo_cloudhsm_v2._operations.baldr_api_service.tag_resource

        (
            output,
            http_response,
        ) = await capo_cloudhsm_v2._operations.baldr_api_service.tag_resource.async_tag_resource(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TagResource")
    )
    input_: capo_cloudhsm_v2.types.tag_resource_request.TagResourceRequest = {
        "resource_id": resource_id,
        "tag_list": tag_list,
    }

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