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

ListTypesByAssociation

Lists Type objects by the source API association ID.

Request Syntax


GET /v1/mergedApis/mergedApiIdentifier/sourceApiAssociations/associationId/types?format=format&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

associationId

The ID generated by the AppSync service for the source API association.

Required: Yes

format

The format type.

Valid Values: SDL | JSON

Required: Yes

maxResults

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

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

mergedApiIdentifier

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs in other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

Required: Yes

nextToken

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

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

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 that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

Type: String

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

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