tag_resource `async` ¶

tag_resource(
    resource_arn: ImageBuilderArn,
    tags: TagMap,
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
) -> TagResourceResponse

Adds a tag to a resource.

Parameters:

resource_arn (ImageBuilderArn) –

The Amazon Resource Name (ARN) of the resource that you want to tag.
tags (TagMap) –

The tags to apply to the resource.

Raises:

InvalidParameterException –

The specified parameter is invalid. Review the available parameters for the API request.
ResourceNotFoundException –

At least one of the resources referenced by your request does not exist.
ServiceException –

An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.
UnknownServiceError –

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

Examples:

Add tags to a component build version The following example adds two tags to a component build version.

>>> await client.tag_resource(resource_arn='arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-tagged-component/1.0.0/1', tags={'Environment': 'Production', 'CostCenter': '12345'})

Source code in docs_src/capo_imagebuilder/_services/async_imagebuilder.py

async def tag_resource(
    self,
    resource_arn: "capo_imagebuilder.types.image_builder_arn.ImageBuilderArn",
    tags: "capo_imagebuilder.types.tag_map.TagMap",
    *,
    config_overrides: Optional[AsyncimagebuilderClientConfig] = None,
) -> "capo_imagebuilder.types.tag_resource_response.TagResourceResponse":
    """<p>Adds a tag to a resource.</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) of the resource that you want to tag.</p>
        tags: <p>The tags to apply to the resource.</p>

    Raises:
        capo_imagebuilder.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_imagebuilder.errors.resource_not_found_exception.ResourceNotFoundException: <p>At least one of the resources referenced by your request does not exist.</p>
        capo_imagebuilder.errors.service_exception.ServiceException: <p>An internal server error occurred while Image Builder processed the request. Retrying the request may succeed.</p>
        capo_imagebuilder.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Add tags to a component build version
        The following example adds two tags to a component build version.

        >>> await client.tag_resource(resource_arn='arn:aws:imagebuilder:us-west-2:111122223333:component/my-example-tagged-component/1.0.0/1', tags={'Environment': 'Production', 'CostCenter': '12345'})
    """

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

        (
            output,
            http_response,
        ) = await capo_imagebuilder._operations.imagebuilder.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_imagebuilder.types.tag_resource_request.TagResourceRequest = {
        "resource_arn": resource_arn,
        "tags": tags,
    }

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

tag_resource async ¶

tag_resource `async` ¶