Skip to content

tag_resource 

tag_resource(
    resource_arn: Arn,
    tags: TagList,
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
) -> TagResourceOutput

Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.

For more information, see Proton resources and tagging in the Proton User Guide.

Parameters:

  • resource_arn (Arn) –

    The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.

  • tags (TagList) –

    A list of customer tags to apply to the Proton resource.

Raises:

Source code in docs_src/capo_proton/_services/proton.py 
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
def tag_resource(
    self,
    resource_arn: "capo_proton.types.arn.Arn",
    tags: "capo_proton.types.tag_list.TagList",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
) -> "capo_proton.types.tag_resource_output.TagResourceOutput":
    """<p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User Guide</i>.</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) of the Proton resource to apply customer tags to.</p>
        tags: <p>A list of customer tags to apply to the Proton resource.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.conflict_exception.ConflictException: <p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.tag_resource_input.TagResourceInput]",
    ) -> OperationResponse[
        "capo_proton.types.tag_resource_output.TagResourceOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.tag_resource

        output, http_response = (
            capo_proton._operations.aws_proton20200720.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_proton.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