Skip to content

delete_state_machine_alias 

delete_state_machine_alias(
    state_machine_alias_arn: Arn, *, config_overrides: Optional[SFNClientConfig] = None
) -> DeleteStateMachineAliasOutput

Deletes a state machine alias.

After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.

Related operations:

Parameters:

  • state_machine_alias_arn (Arn) –

    The Amazon Resource Name (ARN) of the state machine alias to delete.

Raises:

Source code in docs_src/capo_sfn/_services/sfn.py 
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
def delete_state_machine_alias(
    self,
    state_machine_alias_arn: "capo_sfn.types.arn.Arn",
    *,
    config_overrides: Optional[SFNClientConfig] = None,
) -> (
    "capo_sfn.types.delete_state_machine_alias_output.DeleteStateMachineAliasOutput"
):
    """<p>Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <p>After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>DescribeStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> </ul>

    Args:
        state_machine_alias_arn: <p>The Amazon Resource Name (ARN) of the state machine alias to delete.</p>

    Raises:
        capo_sfn.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for <a>DeleteStateMachineVersion</a>, <a>PublishStateMachineVersion</a>, or <a>UpdateStateMachine</a> with the <code>publish</code> parameter set to <code>true</code>.</p> <p>HTTP Status Code: 409</p>
        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.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_sfn.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sfn.types.delete_state_machine_alias_input.DeleteStateMachineAliasInput]",
    ) -> OperationResponse[
        "capo_sfn.types.delete_state_machine_alias_output.DeleteStateMachineAliasOutput"
    ]:
        import capo_sfn._operations.aws_step_functions.delete_state_machine_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteStateMachineAlias")
    )
    input_: capo_sfn.types.delete_state_machine_alias_input.DeleteStateMachineAliasInput = {
        "state_machine_alias_arn": state_machine_alias_arn
    }

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