CreateGraphqlApi - AWS AppSync

CreateGraphqlApi

Creates a GraphqlApi object.

Request Syntax

POST /v1/apis HTTP/1.1 Content-type: application/json { "additionalAuthenticationProviders": [ { "authenticationType": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "userPoolId": "string" } } ], "authenticationType": "string", "logConfig": { "cloudWatchLogsRoleArn": "string", "excludeVerboseContent": boolean, "fieldLogLevel": "string" }, "name": "string", "openIDConnectConfig": { "authTTL": number, "clientId": "string", "iatTTL": number, "issuer": "string" }, "tags": { "string" : "string" }, "userPoolConfig": { "appIdClientRegex": "string", "awsRegion": "string", "defaultAction": "string", "userPoolId": "string" }, "xrayEnabled": boolean }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

additionalAuthenticationProviders

A list of additional authentication providers for the GraphqlApi API.

Type: Array of AdditionalAuthenticationProvider objects

Required: No

authenticationType

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

Type: String

Valid Values: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT

Required: Yes

logConfig

The Amazon CloudWatch Logs configuration.

Type: LogConfig object

Required: No

name

A user-supplied name for the GraphqlApi.

Type: String

Required: Yes

openIDConnectConfig

The OpenID Connect configuration.

Type: OpenIDConnectConfig object

Required: No

tags

A TagMap object.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

userPoolConfig

The Amazon Cognito user pool configuration.

Type: UserPoolConfig object

Required: No

xrayEnabled

A flag indicating whether to enable X-Ray tracing for the GraphqlApi.

Type: Boolean

Required: No

Response Syntax

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

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.

Type: GraphqlApi object

Errors

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

ApiLimitExceededException

The GraphQL API exceeded a limit. Try your request again.

HTTP Status Code: 400

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

LimitExceededException

The request exceeded a limit. Try your request again.

HTTP Status Code: 429

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: