tag_resource ¶

tag_resource(
    resource_arn: TaggableResourceArn,
    tags: TagList,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    instance_arn: Optional[InstanceArn] = None,
) -> TagResourceResponse

Associates a set of tags with a specified resource.

Parameters:

instance_arn (Optional[InstanceArn], default: None ) –

The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
resource_arn (TaggableResourceArn) –

The ARN of the resource with the tags to be listed.
tags (TagList) –

A set of key-value pairs that are used to manage the resource.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
InternalServerException –

The request processing has failed because of an unknown error, exception, or failure with an internal server.
ResourceNotFoundException –

Indicates that a requested resource is not found.
ServiceQuotaExceededException –

Indicates that the principal has crossed the permitted number of resources that can be created.
ThrottlingException –

Indicates that the principal has crossed the throttling limits of the API operations.
ValidationException –

The request failed because it contains a syntax error.
UnknownServiceError –

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

Source code in docs_src/capo_sso_admin/_services/sso_admin.py

def tag_resource(
    self,
    resource_arn: "capo_sso_admin.types.taggable_resource_arn.TaggableResourceArn",
    tags: "capo_sso_admin.types.tag_list.TagList",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
    instance_arn: Optional["capo_sso_admin.types.instance_arn.InstanceArn"] = None,
) -> "capo_sso_admin.types.tag_resource_response.TagResourceResponse":
    """<p>Associates a set of tags with a specified resource.</p>

    Args:
        instance_arn: <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
        resource_arn: <p>The ARN of the resource with the tags to be listed.</p>
        tags: <p>A set of key-value pairs that are used to manage the resource.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Indicates that the principal has crossed the permitted number of resources that can be created.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

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

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