Skip to content

describe_automation_step_executions

describe_automation_step_executions(
    automation_execution_id: AutomationExecutionId,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    filters: Optional[StepExecutionFilterList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    reverse_order: Optional[Boolean] = None,
) -> DescribeAutomationStepExecutionsResult

Information about all active and terminated step executions in an Automation workflow.

Parameters:

  • automation_execution_id (AutomationExecutionId) –

    The Automation execution ID for which you want step execution descriptions.

  • filters (Optional[StepExecutionFilterList], default: None ) –

    One or more filters to limit the number of step executions returned by the request.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of items to return. (You received this token from a previous call.)

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

  • reverse_order (Optional[Boolean], default: None ) –

    Indicates whether to list step executions in reverse order by start time. The default value is 'false'.

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def describe_automation_step_executions(
    self,
    automation_execution_id: "capo_ssm.types.automation_execution_id.AutomationExecutionId",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    filters: Optional[
        "capo_ssm.types.step_execution_filter_list.StepExecutionFilterList"
    ] = None,
    next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
    max_results: Optional["capo_ssm.types.max_results.MaxResults"] = None,
    reverse_order: Optional["capo_ssm.types.boolean.Boolean"] = None,
) -> "capo_ssm.types.describe_automation_step_executions_result.DescribeAutomationStepExecutionsResult":
    """<p>Information about all active and terminated step executions in an Automation workflow.</p>

    Args:
        automation_execution_id: <p>The Automation execution ID for which you want step execution descriptions.</p>
        filters: <p>One or more filters to limit the number of step executions returned by the request.</p>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
        max_results: <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
        reverse_order: <p>Indicates whether to list step executions in reverse order by start time. The default value is 'false'.</p>

    Raises:
        capo_ssm.errors.automation_execution_not_found_exception.AutomationExecutionNotFoundException: <p>There is no automation execution information for the requested automation execution ID.</p>
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_filter_key.InvalidFilterKey: <p>The specified key isn't valid.</p>
        capo_ssm.errors.invalid_filter_value.InvalidFilterValue: <p>The filter value isn't valid. Verify the value and try again.</p>
        capo_ssm.errors.invalid_next_token.InvalidNextToken: <p>The specified token isn't valid.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.describe_automation_step_executions_request.DescribeAutomationStepExecutionsRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.describe_automation_step_executions_result.DescribeAutomationStepExecutionsResult"
    ]:
        import capo_ssm._operations.amazon_ssm.describe_automation_step_executions

        output, http_response = (
            capo_ssm._operations.amazon_ssm.describe_automation_step_executions.describe_automation_step_executions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAutomationStepExecutions")
    )
    input_: capo_ssm.types.describe_automation_step_executions_request.DescribeAutomationStepExecutionsRequest = {
        "automation_execution_id": automation_execution_id
    }
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if reverse_order is not None:
        input_["reverse_order"] = reverse_order

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