tag_resource ¶

tag_resource(
    arn: PipelineArn,
    tags: TagList,
    *,
    config_overrides: Optional[OSISClientConfig] = None,
) -> TagResourceResponse

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

Parameters:

arn (PipelineArn) –

The Amazon Resource Name (ARN) of the pipeline to tag.
tags (TagList) –

The list of key-value tags to add to the pipeline.

Raises:

AccessDeniedException –

You don't have permissions to access the resource.
DisabledOperationException –

Exception is thrown when an operation has been disabled.
InternalException –

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
LimitExceededException –

You attempted to create more than the allowed number of tags.
ResourceNotFoundException –

You attempted to access or delete a resource that does not exist.
ValidationException –

An exception for missing or invalid input fields.
UnknownServiceError –

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

Source code in docs_src/capo_osis/_services/osis.py

def tag_resource(
    self,
    arn: "capo_osis.types.pipeline_arn.PipelineArn",
    tags: "capo_osis.types.tag_list.TagList",
    *,
    config_overrides: Optional[OSISClientConfig] = None,
) -> "capo_osis.types.tag_resource_response.TagResourceResponse":
    """<p>Tags an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging Amazon OpenSearch Ingestion pipelines</a>.</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the pipeline to tag.</p>
        tags: <p>The list of key-value tags to add to the pipeline.</p>

    Raises:
        capo_osis.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to access the resource.</p>
        capo_osis.errors.disabled_operation_exception.DisabledOperationException: <p>Exception is thrown when an operation has been disabled.</p>
        capo_osis.errors.internal_exception.InternalException: <p>The request failed because of an unknown error, exception, or failure (the failure is internal to the service).</p>
        capo_osis.errors.limit_exceeded_exception.LimitExceededException: <p>You attempted to create more than the allowed number of tags.</p>
        capo_osis.errors.resource_not_found_exception.ResourceNotFoundException: <p>You attempted to access or delete a resource that does not exist.</p>
        capo_osis.errors.validation_exception.ValidationException: <p>An exception for missing or invalid input fields.</p>
        capo_osis.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_osis.types.tag_resource_request.TagResourceRequest]",
    ) -> OperationResponse[
        "capo_osis.types.tag_resource_response.TagResourceResponse"
    ]:
        import capo_osis._operations.amazon_open_search_ingestion_service.tag_resource

        output, http_response = (
            capo_osis._operations.amazon_open_search_ingestion_service.tag_resource.tag_resource(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("TagResource")
    )
    input_: capo_osis.types.tag_resource_request.TagResourceRequest = {
        "arn": arn,
        "tags": tags,
    }

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