Skip to content

tag_resource

tag_resource(
    resource_arn: ARN,
    tags: Tags,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> None

Assigns a set of key-value pairs to a resource.

Parameters:

  • resource_arn (ARN) –

    The ARN that uniquely identifies the resource.

  • tags (Tags) –

    Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{"Key":"string","Value":"string"}].

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def tag_resource(
    self,
    resource_arn: "capo_backup.types.arn.ARN",
    tags: "capo_backup.types.tags.Tags",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> None:
    """<p>Assigns a set of key-value pairs to a resource.</p>

    Args:
        resource_arn: <p>The ARN that uniquely identifies the resource.</p>
        tags: <p>Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: <code>[{"Key":"string","Value":"string"}]</code>.</p>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.limit_exceeded_exception.LimitExceededException: <p>A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.tag_resource_input.TagResourceInput]",
    ) -> OperationResponse[None]:
        import capo_backup._operations.cryo_controller_user_manager.tag_resource

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.tag_resource.tag_resource(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_backup.types.tag_resource_input.TagResourceInput",
    ) -> dict[str, Any]:
        import capo_backup.types.tag_resource_input

        return capo_backup.types.tag_resource_input.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("TagResource", redact_input=_redact_input),
    )
    input_: capo_backup.types.tag_resource_input.TagResourceInput = {
        "resource_arn": resource_arn,
        "tags": tags,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output