Returns details about a state machine alias.
Related operations:
Parameters:
-
state_machine_alias_arn
(Arn)
–
The Amazon Resource Name (ARN) of the state machine alias.
Raises:
-
InvalidArn
–
The provided Amazon Resource Name (ARN) is not valid.
-
ResourceNotFound
–
Could not find the referenced resource.
-
ValidationException
–
The input does not satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_sfn/_services/sfn.py
| def describe_state_machine_alias(
self,
state_machine_alias_arn: "capo_sfn.types.arn.Arn",
*,
config_overrides: Optional[SFNClientConfig] = None,
) -> "capo_sfn.types.describe_state_machine_alias_output.DescribeStateMachineAliasOutput":
"""<p>Returns details about a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>CreateStateMachineAlias</a> </p> </li> <li> <p> <a>ListStateMachineAliases</a> </p> </li> <li> <p> <a>UpdateStateMachineAlias</a> </p> </li> <li> <p> <a>DeleteStateMachineAlias</a> </p> </li> </ul>
Args:
state_machine_alias_arn: <p>The Amazon Resource Name (ARN) of the state machine alias.</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.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.describe_state_machine_alias_input.DescribeStateMachineAliasInput]",
) -> OperationResponse[
"capo_sfn.types.describe_state_machine_alias_output.DescribeStateMachineAliasOutput"
]:
import capo_sfn._operations.aws_step_functions.describe_state_machine_alias
output, http_response = (
capo_sfn._operations.aws_step_functions.describe_state_machine_alias.describe_state_machine_alias(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_sfn.types.describe_state_machine_alias_output.DescribeStateMachineAliasOutput",
) -> dict[str, Any]:
import capo_sfn.types.describe_state_machine_alias_output
return capo_sfn.types.describe_state_machine_alias_output.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("DescribeStateMachineAlias", redact_output=_redact_output),
)
input_: capo_sfn.types.describe_state_machine_alias_input.DescribeStateMachineAliasInput = {
"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
|