Skip to content

untag_resource

untag_resource(
    resource_arn: Arn,
    tag_keys: TagKeyList,
    *,
    config_overrides: Optional[SFNClientConfig] = None,
) -> UntagResourceOutput

Remove a tag from a Step Functions resource

Parameters:

  • resource_arn (Arn) –

    The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

  • tag_keys (TagKeyList) –

    The list of tags to remove from the resource.

Raises:

Source code in docs_src/capo_sfn/_services/sfn.py
def untag_resource(
    self,
    resource_arn: "capo_sfn.types.arn.Arn",
    tag_keys: "capo_sfn.types.tag_key_list.TagKeyList",
    *,
    config_overrides: Optional[SFNClientConfig] = None,
) -> "capo_sfn.types.untag_resource_output.UntagResourceOutput":
    """<p>Remove a tag from a Step Functions resource</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) for the Step Functions state machine or activity.</p>
        tag_keys: <p>The list of tags to remove from the resource.</p>

    Raises:
        capo_sfn.errors.invalid_arn.InvalidArn: <p>The provided Amazon Resource Name (ARN) is not valid.</p>
        capo_sfn.errors.resource_not_found.ResourceNotFound: <p>Could not find the referenced resource.</p>
        capo_sfn.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sfn.types.untag_resource_input.UntagResourceInput]",
    ) -> OperationResponse[
        "capo_sfn.types.untag_resource_output.UntagResourceOutput"
    ]:
        import capo_sfn._operations.aws_step_functions.untag_resource

        output, http_response = (
            capo_sfn._operations.aws_step_functions.untag_resource.untag_resource(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UntagResource")
    )
    input_: capo_sfn.types.untag_resource_input.UntagResourceInput = {
        "resource_arn": resource_arn,
        "tag_keys": tag_keys,
    }

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