Skip to content

tag_resource

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

Adds to and modifies existing tags of an IoT Device Advisor resource.

Requires permission to access the TagResource action.

Parameters:

  • resource_arn (AmazonResourceName) –

    The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.

  • tags (Optional[TagMap], default: None ) –

    The tags to be attached to the IoT Device Advisor resource.

Raises:

Source code in docs_src/capo_iotdeviceadvisor/_services/iot_device_advisor.py
def tag_resource(
    self,
    resource_arn: "capo_iotdeviceadvisor.types.amazon_resource_name.AmazonResourceName",
    *,
    config_overrides: Optional[IotDeviceAdvisorClientConfig] = None,
    tags: Optional["capo_iotdeviceadvisor.types.tag_map.TagMap"] = None,
) -> "capo_iotdeviceadvisor.types.tag_resource_response.TagResourceResponse":
    """<p>Adds to and modifies existing tags of an IoT Device Advisor resource.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TagResource</a> action.</p>

    Args:
        resource_arn: <p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.</p>
        tags: <p>The tags to be attached to the IoT Device Advisor resource.</p>

    Raises:
        capo_iotdeviceadvisor.errors.internal_server_exception.InternalServerException: <p>Sends an Internal Failure exception.</p>
        capo_iotdeviceadvisor.errors.resource_not_found_exception.ResourceNotFoundException: <p>Sends a Resource Not Found exception.</p>
        capo_iotdeviceadvisor.errors.validation_exception.ValidationException: <p>Sends a validation exception.</p>
        capo_iotdeviceadvisor.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_iotdeviceadvisor._operations.iot_senate_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_iotdeviceadvisor.types.tag_resource_request.TagResourceRequest = {
        "resource_arn": resource_arn
    }
    if tags is not None:
        input_["tags"] = tags

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