Skip to content

describe_service async

describe_service(
    service_arn: AppRunnerResourceArn,
    *,
    config_overrides: Optional[AsyncAppRunnerClientConfig] = None,
) -> DescribeServiceResponse

Return a full description of an App Runner service.

Parameters:

  • service_arn (AppRunnerResourceArn) –

    The Amazon Resource Name (ARN) of the App Runner service that you want a description for.

Raises:

Source code in docs_src/capo_apprunner/_services/async_app_runner.py
async def describe_service(
    self,
    service_arn: "capo_apprunner.types.app_runner_resource_arn.AppRunnerResourceArn",
    *,
    config_overrides: Optional[AsyncAppRunnerClientConfig] = None,
) -> "capo_apprunner.types.describe_service_response.DescribeServiceResponse":
    """<p>Return a full description of an App Runner service.</p>

    Args:
        service_arn: <p>The Amazon Resource Name (ARN) of the App Runner service that you want a description for.</p>

    Raises:
        capo_apprunner.errors.internal_service_error_exception.InternalServiceErrorException: <p>An unexpected service exception occurred.</p>
        capo_apprunner.errors.invalid_request_exception.InvalidRequestException: <p>One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.</p>
        capo_apprunner.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource doesn't exist for the specified Amazon Resource Name (ARN) in your Amazon Web Services account.</p>
        capo_apprunner.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_apprunner.types.describe_service_request.DescribeServiceRequest]",
    ) -> AsyncOperationResponse[
        "capo_apprunner.types.describe_service_response.DescribeServiceResponse"
    ]:
        import capo_apprunner._operations.app_runner.describe_service

        (
            output,
            http_response,
        ) = await capo_apprunner._operations.app_runner.describe_service.async_describe_service(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_apprunner.types.describe_service_response.DescribeServiceResponse",
    ) -> dict[str, Any]:
        import capo_apprunner.types.describe_service_response

        return capo_apprunner.types.describe_service_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeService", redact_output=_redact_output),
    )
    input_: capo_apprunner.types.describe_service_request.DescribeServiceRequest = {
        "service_arn": service_arn
    }

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