AWS AppSync
API Reference (API Version 2017-07-25)

GetGraphqlApi

Retrieves a GraphqlApi object.

Request Syntax

GET /apis/apiId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

apiId

The API ID for the GraphQL API.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "graphqlApi": { "apiId": "string", "arn": "string", "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "uris": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

graphqlApi

The GraphqlApi object.

Type: GraphqlApi object

Errors

For information about the errors that are common to all actions, see Common Errors.

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.

HTTP Status Code: 400

InternalFailureException

An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500

NotFoundException

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

HTTP Status Code: 404

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: