list_steps `async` ¶

list_steps(
    *,
    config_overrides: Optional[AsyncEMRClientConfig] = None,
    cluster_id: Optional[ClusterId] = None,
    step_states: Optional[StepStateList] = None,
    step_ids: Optional[XmlStringList] = None,
    marker: Optional[Marker] = None,
) -> ListStepsOutput

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request or filter by StepStates. You can specify a maximum of 10 stepIDs. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a Marker, which is a pagination token that indicates the next set of steps to retrieve.

Parameters:

cluster_id (Optional[ClusterId], default: None ) –

The identifier of the cluster for which to list the steps.
step_states (Optional[StepStateList], default: None ) –

The filter to limit the step list based on certain states.
step_ids (Optional[XmlStringList], default: None ) –

The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.
marker (Optional[Marker], default: None ) –

The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

Raises:

InternalServerException –

This exception occurs when there is an internal failure in the Amazon EMR service.
InvalidRequestException –

This exception occurs when there is something wrong with user input.
UnknownServiceError –

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

Source code in docs_src/capo_emr/_services/async_emr.py

async def list_steps(
    self,
    *,
    config_overrides: Optional[AsyncEMRClientConfig] = None,
    cluster_id: Optional["capo_emr.types.cluster_id.ClusterId"] = None,
    step_states: Optional["capo_emr.types.step_state_list.StepStateList"] = None,
    step_ids: Optional["capo_emr.types.xml_string_list.XmlStringList"] = None,
    marker: Optional["capo_emr.types.marker.Marker"] = None,
) -> "capo_emr.types.list_steps_output.ListStepsOutput":
    """<p>Provides a list of steps for the cluster in reverse order unless you specify <code>stepIds</code> with the request or filter by <code>StepStates</code>. You can specify a maximum of 10 <code>stepIDs</code>. The CLI automatically paginates results to return a list greater than 50 steps. To return more than 50 steps using the CLI, specify a <code>Marker</code>, which is a pagination token that indicates the next set of steps to retrieve.</p>

    Args:
        cluster_id: <p>The identifier of the cluster for which to list the steps.</p>
        step_states: <p>The filter to limit the step list based on certain states.</p>
        step_ids: <p>The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.</p>
        marker: <p>The maximum number of steps that a single <code>ListSteps</code> action returns is 50. To return a longer list of steps, use multiple <code>ListSteps</code> actions along with the <code>Marker</code> parameter, which is a pagination token that indicates the next set of results to retrieve.</p>

    Raises:
        capo_emr.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Amazon EMR service.</p>
        capo_emr.errors.invalid_request_exception.InvalidRequestException: <p>This exception occurs when there is something wrong with user input.</p>
        capo_emr.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_emr.types.list_steps_input.ListStepsInput]",
    ) -> AsyncOperationResponse["capo_emr.types.list_steps_output.ListStepsOutput"]:
        import capo_emr._operations.elastic_map_reduce.list_steps

        (
            output,
            http_response,
        ) = await capo_emr._operations.elastic_map_reduce.list_steps.async_list_steps(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSteps")
    )
    input_: capo_emr.types.list_steps_input.ListStepsInput = {}
    if cluster_id is not None:
        input_["cluster_id"] = cluster_id
    if step_states is not None:
        input_["step_states"] = step_states
    if step_ids is not None:
        input_["step_ids"] = step_ids
    if marker is not None:
        input_["marker"] = marker

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_steps async ¶

list_steps `async` ¶