get_environment ¶

get_environment(
    environment_id: Identifier, *, config_overrides: Optional[m2ClientConfig] = None
) -> GetEnvironmentResponse

Describes a specific runtime environment.

Parameters:

environment_id (Identifier) –

The unique identifier of the runtime environment.

Raises:

AccessDeniedException –

The account or role doesn't have the right permissions to make the request.
InternalServerException –

An unexpected error occurred during the processing of the request.
ResourceNotFoundException –

The specified resource was not found.
ThrottlingException –

The number of requests made exceeds the limit.
ValidationException –

One or more parameters provided in the request is not valid.
UnknownServiceError –

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

Source code in docs_src/capo_m2/_services/m2.py

def get_environment(
    self,
    environment_id: "capo_m2.types.identifier.Identifier",
    *,
    config_overrides: Optional[m2ClientConfig] = None,
) -> "capo_m2.types.get_environment_response.GetEnvironmentResponse":
    """<p>Describes a specific runtime environment.</p>

    Args:
        environment_id: <p>The unique identifier of the runtime environment.</p>

    Raises:
        capo_m2.errors.access_denied_exception.AccessDeniedException: <p>The account or role doesn't have the right permissions to make the request.</p>
        capo_m2.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
        capo_m2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_m2.errors.throttling_exception.ThrottlingException: <p>The number of requests made exceeds the limit.</p>
        capo_m2.errors.validation_exception.ValidationException: <p>One or more parameters provided in the request is not valid.</p>
        capo_m2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_m2.types.get_environment_request.GetEnvironmentRequest]",
    ) -> OperationResponse[
        "capo_m2.types.get_environment_response.GetEnvironmentResponse"
    ]:
        import capo_m2._operations.aws_supernova_control_plane_service.get_environment

        output, http_response = (
            capo_m2._operations.aws_supernova_control_plane_service.get_environment.get_environment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEnvironment")
    )
    input_: capo_m2.types.get_environment_request.GetEnvironmentRequest = {
        "environment_id": environment_id
    }

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