Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetType

Retrieves a Type object.

Request Syntax


GET /v1/apis/apiId/types/typeName?format=format HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

apiId

The API ID.

Required: Yes

format

The type format: SDL or JSON.

Valid Values: SDL | JSON

Required: Yes

typeName

The type name.

Length Constraints: Minimum length of 1. Maximum length of 65536.

Pattern: [_A-Za-z][_0-9A-Za-z]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "type": { 
      "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.

type

The Type object.

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

ConcurrentModificationException

Another modification is in progress at this time and it 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 then try again.

HTTP Status Code: 404

UnauthorizedException

You aren't authorized to perform this operation.

HTTP Status Code: 401