get_api ¶

get_api(
    api_id: String, *, config_overrides: Optional[AppSyncClientConfig] = None
) -> GetApiResponse

Retrieves an Api object.

Parameters:

api_id (String) –

The Api ID.

Raises:

AccessDeniedException –

You don't have access to perform this operation on this resource.
BadRequestException –

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.
InternalFailureException –

An internal AppSync error occurred. Try your request again.
NotFoundException –

The resource specified in the request was not found. Check the resource, and then try again.
UnauthorizedException –

You aren't authorized to perform this operation.
UnknownServiceError –

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

Source code in docs_src/capo_appsync/_services/app_sync.py

def get_api(
    self,
    api_id: "capo_appsync.types.string.String",
    *,
    config_overrides: Optional[AppSyncClientConfig] = None,
) -> "capo_appsync.types.get_api_response.GetApiResponse":
    """<p>Retrieves an <code>Api</code> object.</p>

    Args:
        api_id: <p>The <code>Api</code> ID.</p>

    Raises:
        capo_appsync.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to perform this operation on this resource.</p>
        capo_appsync.errors.bad_request_exception.BadRequestException: <p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.</p>
        capo_appsync.errors.internal_failure_exception.InternalFailureException: <p>An internal AppSync error occurred. Try your request again.</p>
        capo_appsync.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. Check the resource, and then try again.</p>
        capo_appsync.errors.unauthorized_exception.UnauthorizedException: <p>You aren't authorized to perform this operation.</p>
        capo_appsync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appsync.types.get_api_request.GetApiRequest]",
    ) -> OperationResponse["capo_appsync.types.get_api_response.GetApiResponse"]:
        import capo_appsync._operations.aws_deepdish_control_plane_service.get_api

        output, http_response = (
            capo_appsync._operations.aws_deepdish_control_plane_service.get_api.get_api(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetApi")
    )
    input_: capo_appsync.types.get_api_request.GetApiRequest = {"api_id": api_id}

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