Skip to content

describe_activity async

describe_activity(
    activity_arn: Arn, *, config_overrides: Optional[AsyncSFNClientConfig] = None
) -> DescribeActivityOutput

Describes an activity.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Parameters:

  • activity_arn (Arn) –

    The Amazon Resource Name (ARN) of the activity to describe.

Raises:

Source code in docs_src/capo_sfn/_services/async_sfn.py
async def describe_activity(
    self,
    activity_arn: "capo_sfn.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncSFNClientConfig] = None,
) -> "capo_sfn.types.describe_activity_output.DescribeActivityOutput":
    """<p>Describes an activity.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>

    Args:
        activity_arn: <p>The Amazon Resource Name (ARN) of the activity to describe.</p>

    Raises:
        capo_sfn.errors.activity_does_not_exist.ActivityDoesNotExist: <p>The specified activity does not exist.</p>
        capo_sfn.errors.invalid_arn.InvalidArn: <p>The provided Amazon Resource Name (ARN) is not valid.</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_activity_input.DescribeActivityInput]",
    ) -> AsyncOperationResponse[
        "capo_sfn.types.describe_activity_output.DescribeActivityOutput"
    ]:
        import capo_sfn._operations.aws_step_functions.describe_activity

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeActivity")
    )
    input_: capo_sfn.types.describe_activity_input.DescribeActivityInput = {
        "activity_arn": activity_arn
    }

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