Skip to content

describe_map_run async

describe_map_run(
    map_run_arn: LongArn, *, config_overrides: Optional[AsyncSFNClientConfig] = None
) -> DescribeMapRunOutput

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

Parameters:

  • map_run_arn (LongArn) –

    The Amazon Resource Name (ARN) that identifies a Map Run.

Raises:

Source code in docs_src/capo_sfn/_services/async_sfn.py
async def describe_map_run(
    self,
    map_run_arn: "capo_sfn.types.long_arn.LongArn",
    *,
    config_overrides: Optional[AsyncSFNClientConfig] = None,
) -> "capo_sfn.types.describe_map_run_output.DescribeMapRunOutput":
    """<p>Provides information about a Map Run's configuration, progress, and results. If you've <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">redriven</a> a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</p>

    Args:
        map_run_arn: <p>The Amazon Resource Name (ARN) that identifies a Map Run.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sfn.types.describe_map_run_input.DescribeMapRunInput]",
    ) -> AsyncOperationResponse[
        "capo_sfn.types.describe_map_run_output.DescribeMapRunOutput"
    ]:
        import capo_sfn._operations.aws_step_functions.describe_map_run

        (
            output,
            http_response,
        ) = await capo_sfn._operations.aws_step_functions.describe_map_run.async_describe_map_run(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeMapRun")
    )
    input_: capo_sfn.types.describe_map_run_input.DescribeMapRunInput = {
        "map_run_arn": map_run_arn
    }

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