Skip to content

describe_simulation async

describe_simulation(
    simulation: SimSpaceWeaverResourceName,
    *,
    config_overrides: Optional[AsyncSimSpaceWeaverClientConfig] = None,
) -> DescribeSimulationOutput

Returns the current state of the given simulation.

Parameters:

Raises:

Source code in docs_src/capo_simspaceweaver/_services/async_sim_space_weaver.py
async def describe_simulation(
    self,
    simulation: "capo_simspaceweaver.types.sim_space_weaver_resource_name.SimSpaceWeaverResourceName",
    *,
    config_overrides: Optional[AsyncSimSpaceWeaverClientConfig] = None,
) -> (
    "capo_simspaceweaver.types.describe_simulation_output.DescribeSimulationOutput"
):
    """<p>Returns the current state of the given simulation.</p>

    Args:
        simulation: <p>The name of the simulation.</p>

    Raises:
        capo_simspaceweaver.errors.access_denied_exception.AccessDeniedException: <p/>
        capo_simspaceweaver.errors.internal_server_exception.InternalServerException: <p/>
        capo_simspaceweaver.errors.resource_not_found_exception.ResourceNotFoundException: <p/>
        capo_simspaceweaver.errors.validation_exception.ValidationException: <p/>
        capo_simspaceweaver.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_simspaceweaver.types.describe_simulation_input.DescribeSimulationInput]",
    ) -> AsyncOperationResponse[
        "capo_simspaceweaver.types.describe_simulation_output.DescribeSimulationOutput"
    ]:
        import capo_simspaceweaver._operations.sim_space_weaver.describe_simulation

        (
            output,
            http_response,
        ) = await capo_simspaceweaver._operations.sim_space_weaver.describe_simulation.async_describe_simulation(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSimulation")
    )
    input_: capo_simspaceweaver.types.describe_simulation_input.DescribeSimulationInput = {
        "simulation": simulation
    }

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