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

ListTypes

Lists the types for a given API.

Request Syntax

GET /apis/apiId/types?format=format&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

apiId

The API ID.

format

The type format: SDL or JSON.

Valid Values: SDL | JSON

maxResults

The maximum number of results you want the request to return.

Valid Range: Minimum value of 0. Maximum value of 25.

nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Pattern: [\\S]+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "types": [ { "arn": "string", "definition": "string", "description": "string", "format": "string", "name": "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.

nextToken

An identifier to be passed in the next request to this operation to return the next set of items in the list.

Type: String

Pattern: [\\S]+

types

The Type objects.

Type: Array of Type objects

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 try again.

HTTP Status Code: 400

ConcurrentModificationException

Another modification is being made. That modification must complete before you can make your change.

HTTP Status Code: 409

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 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: