# StartSchemaCreation
<a name="API_StartSchemaCreation"></a>

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use [GetSchemaCreationStatus](API_GetSchemaCreationStatus.md) to determine when it has completed.

## Request Syntax
<a name="API_StartSchemaCreation_RequestSyntax"></a>

```
POST /v1/apis/apiId/schemacreation HTTP/1.1
Content-type: application/json

{
   "definition": blob
}
```

## URI Request Parameters
<a name="API_StartSchemaCreation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [apiId](#API_StartSchemaCreation_RequestSyntax) **   <a name="appsync-StartSchemaCreation-request-uri-apiId"></a>
The API ID.  
Required: Yes

## Request Body
<a name="API_StartSchemaCreation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [definition](#API_StartSchemaCreation_RequestSyntax) **   <a name="appsync-StartSchemaCreation-request-definition"></a>
The schema definition, in GraphQL schema language format.  
Type: Base64-encoded binary data object  
Required: Yes

## Response Syntax
<a name="API_StartSchemaCreation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_StartSchemaCreation_ResponseElements"></a>

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

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

 ** [status](#API_StartSchemaCreation_ResponseSyntax) **   <a name="appsync-StartSchemaCreation-response-status"></a>
The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT\$1APPLICABLE). When the schema is in the ACTIVE state, you can add data.  
Type: String  
Valid Values: `PROCESSING | ACTIVE | DELETING | FAILED | SUCCESS | NOT_APPLICABLE` 

## Errors
<a name="API_StartSchemaCreation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.    
 ** detail **   
Provides further details for the reason behind the bad request. For reason type `CODE_ERROR`, the detail will contain a list of code errors.  
 ** reason **   
Provides context for the cause of the bad request. The only supported value is `CODE_ERROR`.
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

## See Also
<a name="API_StartSchemaCreation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/StartSchemaCreation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/StartSchemaCreation)