# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AssociateApi](API_AssociateApi.md) 
+  [AssociateMergedGraphqlApi](API_AssociateMergedGraphqlApi.md) 
+  [AssociateSourceGraphqlApi](API_AssociateSourceGraphqlApi.md) 
+  [CreateApi](API_CreateApi.md) 
+  [CreateApiCache](API_CreateApiCache.md) 
+  [CreateApiKey](API_CreateApiKey.md) 
+  [CreateChannelNamespace](API_CreateChannelNamespace.md) 
+  [CreateDataSource](API_CreateDataSource.md) 
+  [CreateDomainName](API_CreateDomainName.md) 
+  [CreateFunction](API_CreateFunction.md) 
+  [CreateGraphqlApi](API_CreateGraphqlApi.md) 
+  [CreateResolver](API_CreateResolver.md) 
+  [CreateType](API_CreateType.md) 
+  [DeleteApi](API_DeleteApi.md) 
+  [DeleteApiCache](API_DeleteApiCache.md) 
+  [DeleteApiKey](API_DeleteApiKey.md) 
+  [DeleteChannelNamespace](API_DeleteChannelNamespace.md) 
+  [DeleteDataSource](API_DeleteDataSource.md) 
+  [DeleteDomainName](API_DeleteDomainName.md) 
+  [DeleteFunction](API_DeleteFunction.md) 
+  [DeleteGraphqlApi](API_DeleteGraphqlApi.md) 
+  [DeleteResolver](API_DeleteResolver.md) 
+  [DeleteType](API_DeleteType.md) 
+  [DisassociateApi](API_DisassociateApi.md) 
+  [DisassociateMergedGraphqlApi](API_DisassociateMergedGraphqlApi.md) 
+  [DisassociateSourceGraphqlApi](API_DisassociateSourceGraphqlApi.md) 
+  [EvaluateCode](API_EvaluateCode.md) 
+  [EvaluateMappingTemplate](API_EvaluateMappingTemplate.md) 
+  [FlushApiCache](API_FlushApiCache.md) 
+  [GetApi](API_GetApi.md) 
+  [GetApiAssociation](API_GetApiAssociation.md) 
+  [GetApiCache](API_GetApiCache.md) 
+  [GetChannelNamespace](API_GetChannelNamespace.md) 
+  [GetDataSource](API_GetDataSource.md) 
+  [GetDataSourceIntrospection](API_GetDataSourceIntrospection.md) 
+  [GetDomainName](API_GetDomainName.md) 
+  [GetFunction](API_GetFunction.md) 
+  [GetGraphqlApi](API_GetGraphqlApi.md) 
+  [GetGraphqlApiEnvironmentVariables](API_GetGraphqlApiEnvironmentVariables.md) 
+  [GetIntrospectionSchema](API_GetIntrospectionSchema.md) 
+  [GetResolver](API_GetResolver.md) 
+  [GetSchemaCreationStatus](API_GetSchemaCreationStatus.md) 
+  [GetSourceApiAssociation](API_GetSourceApiAssociation.md) 
+  [GetType](API_GetType.md) 
+  [ListApiKeys](API_ListApiKeys.md) 
+  [ListApis](API_ListApis.md) 
+  [ListChannelNamespaces](API_ListChannelNamespaces.md) 
+  [ListDataSources](API_ListDataSources.md) 
+  [ListDomainNames](API_ListDomainNames.md) 
+  [ListFunctions](API_ListFunctions.md) 
+  [ListGraphqlApis](API_ListGraphqlApis.md) 
+  [ListResolvers](API_ListResolvers.md) 
+  [ListResolversByFunction](API_ListResolversByFunction.md) 
+  [ListSourceApiAssociations](API_ListSourceApiAssociations.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTypes](API_ListTypes.md) 
+  [ListTypesByAssociation](API_ListTypesByAssociation.md) 
+  [PutGraphqlApiEnvironmentVariables](API_PutGraphqlApiEnvironmentVariables.md) 
+  [StartDataSourceIntrospection](API_StartDataSourceIntrospection.md) 
+  [StartSchemaCreation](API_StartSchemaCreation.md) 
+  [StartSchemaMerge](API_StartSchemaMerge.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateApi](API_UpdateApi.md) 
+  [UpdateApiCache](API_UpdateApiCache.md) 
+  [UpdateApiKey](API_UpdateApiKey.md) 
+  [UpdateChannelNamespace](API_UpdateChannelNamespace.md) 
+  [UpdateDataSource](API_UpdateDataSource.md) 
+  [UpdateDomainName](API_UpdateDomainName.md) 
+  [UpdateFunction](API_UpdateFunction.md) 
+  [UpdateGraphqlApi](API_UpdateGraphqlApi.md) 
+  [UpdateResolver](API_UpdateResolver.md) 
+  [UpdateSourceApiAssociation](API_UpdateSourceApiAssociation.md) 
+  [UpdateType](API_UpdateType.md) 

# AssociateApi
<a name="API_AssociateApi"></a>

Maps an endpoint to your custom domain.

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

```
POST /v1/domainnames/domainName/apiassociation HTTP/1.1
Content-type: application/json

{
   "apiId": "string"
}
```

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

The request uses the following URI parameters.

 ** [domainName](#API_AssociateApi_RequestSyntax) **   <a name="appsync-AssociateApi-request-uri-domainName"></a>
The domain name.  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [apiId](#API_AssociateApi_RequestSyntax) **   <a name="appsync-AssociateApi-request-apiId"></a>
The API ID. Private APIs can not be associated with custom domains.  
Type: String  
Required: Yes

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

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

{
   "apiAssociation": { 
      "apiId": "string",
      "associationStatus": "string",
      "deploymentDetail": "string",
      "domainName": "string"
   }
}
```

## Response Elements
<a name="API_AssociateApi_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.

 ** [apiAssociation](#API_AssociateApi_ResponseSyntax) **   <a name="appsync-AssociateApi-response-apiAssociation"></a>
The `ApiAssociation` object.  
Type: [ApiAssociation](API_ApiAssociation.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

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

## See Also
<a name="API_AssociateApi_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/AssociateApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/AssociateApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/AssociateApi) 

# AssociateMergedGraphqlApi
<a name="API_AssociateMergedGraphqlApi"></a>

Creates an association between a Merged API and source API using the source API's identifier.

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

```
POST /v1/sourceApis/sourceApiIdentifier/mergedApiAssociations HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "mergedApiIdentifier": "string",
   "sourceApiAssociationConfig": { 
      "mergeType": "string"
   }
}
```

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

The request uses the following URI parameters.

 ** [sourceApiIdentifier](#API_AssociateMergedGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateMergedGraphqlApi-request-uri-sourceApiIdentifier"></a>
The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.  
Required: Yes

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

The request accepts the following data in JSON format.

 ** [description](#API_AssociateMergedGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateMergedGraphqlApi-request-description"></a>
The description field.  
Type: String  
Required: No

 ** [mergedApiIdentifier](#API_AssociateMergedGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateMergedGraphqlApi-request-mergedApiIdentifier"></a>
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.  
Type: String  
Required: Yes

 ** [sourceApiAssociationConfig](#API_AssociateMergedGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateMergedGraphqlApi-request-sourceApiAssociationConfig"></a>
The `SourceApiAssociationConfig` object data.  
Type: [SourceApiAssociationConfig](API_SourceApiAssociationConfig.md) object  
Required: No

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

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

{
   "sourceApiAssociation": { 
      "associationArn": "string",
      "associationId": "string",
      "description": "string",
      "lastSuccessfulMergeDate": number,
      "mergedApiArn": "string",
      "mergedApiId": "string",
      "sourceApiArn": "string",
      "sourceApiAssociationConfig": { 
         "mergeType": "string"
      },
      "sourceApiAssociationStatus": "string",
      "sourceApiAssociationStatusDetail": "string",
      "sourceApiId": "string"
   }
}
```

## Response Elements
<a name="API_AssociateMergedGraphqlApi_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.

 ** [sourceApiAssociation](#API_AssociateMergedGraphqlApi_ResponseSyntax) **   <a name="appsync-AssociateMergedGraphqlApi-response-sourceApiAssociation"></a>
The `SourceApiAssociation` object data.  
Type: [SourceApiAssociation](API_SourceApiAssociation.md) object

## Errors
<a name="API_AssociateMergedGraphqlApi_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

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** 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_AssociateMergedGraphqlApi_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/AssociateMergedGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/AssociateMergedGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/AssociateMergedGraphqlApi) 

# AssociateSourceGraphqlApi
<a name="API_AssociateSourceGraphqlApi"></a>

Creates an association between a Merged API and source API using the Merged API's identifier.

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

```
POST /v1/mergedApis/mergedApiIdentifier/sourceApiAssociations HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "sourceApiAssociationConfig": { 
      "mergeType": "string"
   },
   "sourceApiIdentifier": "string"
}
```

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

The request uses the following URI parameters.

 ** [mergedApiIdentifier](#API_AssociateSourceGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateSourceGraphqlApi-request-uri-mergedApiIdentifier"></a>
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

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

The request accepts the following data in JSON format.

 ** [description](#API_AssociateSourceGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateSourceGraphqlApi-request-description"></a>
The description field.  
Type: String  
Required: No

 ** [sourceApiAssociationConfig](#API_AssociateSourceGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateSourceGraphqlApi-request-sourceApiAssociationConfig"></a>
The `SourceApiAssociationConfig` object data.  
Type: [SourceApiAssociationConfig](API_SourceApiAssociationConfig.md) object  
Required: No

 ** [sourceApiIdentifier](#API_AssociateSourceGraphqlApi_RequestSyntax) **   <a name="appsync-AssociateSourceGraphqlApi-request-sourceApiIdentifier"></a>
The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.  
Type: String  
Required: Yes

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

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

{
   "sourceApiAssociation": { 
      "associationArn": "string",
      "associationId": "string",
      "description": "string",
      "lastSuccessfulMergeDate": number,
      "mergedApiArn": "string",
      "mergedApiId": "string",
      "sourceApiArn": "string",
      "sourceApiAssociationConfig": { 
         "mergeType": "string"
      },
      "sourceApiAssociationStatus": "string",
      "sourceApiAssociationStatusDetail": "string",
      "sourceApiId": "string"
   }
}
```

## Response Elements
<a name="API_AssociateSourceGraphqlApi_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.

 ** [sourceApiAssociation](#API_AssociateSourceGraphqlApi_ResponseSyntax) **   <a name="appsync-AssociateSourceGraphqlApi-response-sourceApiAssociation"></a>
The `SourceApiAssociation` object data.  
Type: [SourceApiAssociation](API_SourceApiAssociation.md) object

## Errors
<a name="API_AssociateSourceGraphqlApi_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

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** 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_AssociateSourceGraphqlApi_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/AssociateSourceGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/AssociateSourceGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/AssociateSourceGraphqlApi) 

# CreateApi
<a name="API_CreateApi"></a>

Creates an `Api` object. Use this operation to create an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

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

```
POST /v2/apis HTTP/1.1
Content-type: application/json

{
   "eventConfig": { 
      "authProviders": [ 
         { 
            "authType": "string",
            "cognitoConfig": { 
               "appIdClientRegex": "string",
               "awsRegion": "string",
               "userPoolId": "string"
            },
            "lambdaAuthorizerConfig": { 
               "authorizerResultTtlInSeconds": number,
               "authorizerUri": "string",
               "identityValidationExpression": "string"
            },
            "openIDConnectConfig": { 
               "authTTL": number,
               "clientId": "string",
               "iatTTL": number,
               "issuer": "string"
            }
         }
      ],
      "connectionAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "defaultPublishAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "defaultSubscribeAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "logConfig": { 
         "cloudWatchLogsRoleArn": "string",
         "logLevel": "string"
      }
   },
   "name": "string",
   "ownerContact": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

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

The request does not use any URI parameters.

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

The request accepts the following data in JSON format.

 ** [eventConfig](#API_CreateApi_RequestSyntax) **   <a name="appsync-CreateApi-request-eventConfig"></a>
The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.  
Type: [EventConfig](API_EventConfig.md) object  
Required: No

 ** [name](#API_CreateApi_RequestSyntax) **   <a name="appsync-CreateApi-request-name"></a>
The name for the `Api`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[A-Za-z0-9_\-\ ]+`   
Required: Yes

 ** [ownerContact](#API_CreateApi_RequestSyntax) **   <a name="appsync-CreateApi-request-ownerContact"></a>
The owner contact information for the `Api`.  
Type: String  
Required: No

 ** [tags](#API_CreateApi_RequestSyntax) **   <a name="appsync-CreateApi-request-tags"></a>
A map with keys of `TagKey` objects and values of `TagValue` objects.  
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.  
Value Pattern: `^[\s\w+-=\.:/@]*$`   
Required: No

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

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

{
   "api": { 
      "apiArn": "string",
      "apiId": "string",
      "created": number,
      "dns": { 
         "string" : "string" 
      },
      "eventConfig": { 
         "authProviders": [ 
            { 
               "authType": "string",
               "cognitoConfig": { 
                  "appIdClientRegex": "string",
                  "awsRegion": "string",
                  "userPoolId": "string"
               },
               "lambdaAuthorizerConfig": { 
                  "authorizerResultTtlInSeconds": number,
                  "authorizerUri": "string",
                  "identityValidationExpression": "string"
               },
               "openIDConnectConfig": { 
                  "authTTL": number,
                  "clientId": "string",
                  "iatTTL": number,
                  "issuer": "string"
               }
            }
         ],
         "connectionAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "defaultPublishAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "defaultSubscribeAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "logConfig": { 
            "cloudWatchLogsRoleArn": "string",
            "logLevel": "string"
         }
      },
      "name": "string",
      "ownerContact": "string",
      "tags": { 
         "string" : "string" 
      },
      "wafWebAclArn": "string",
      "xrayEnabled": boolean
   }
}
```

## Response Elements
<a name="API_CreateApi_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.

 ** [api](#API_CreateApi_ResponseSyntax) **   <a name="appsync-CreateApi-response-api"></a>
The `Api` object.  
Type: [Api](API_Api.md) object

## Errors
<a name="API_CreateApi_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

 ** ServiceQuotaExceededException **   
The operation exceeded the service quota for this resource.  
HTTP Status Code: 402

 ** UnauthorizedException **   
You aren't authorized to perform this operation.  
HTTP Status Code: 401

## See Also
<a name="API_CreateApi_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/CreateApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateApi) 

# CreateApiCache
<a name="API_CreateApiCache"></a>

Creates a cache for the GraphQL API.

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

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

{
   "apiCachingBehavior": "string",
   "atRestEncryptionEnabled": boolean,
   "healthMetricsConfig": "string",
   "transitEncryptionEnabled": boolean,
   "ttl": number,
   "type": "string"
}
```

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

The request uses the following URI parameters.

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

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

The request accepts the following data in JSON format.

 ** [apiCachingBehavior](#API_CreateApiCache_RequestSyntax) **   <a name="appsync-CreateApiCache-request-apiCachingBehavior"></a>
Caching behavior.  
+  **FULL\$1REQUEST\$1CACHING**: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
+  **PER\$1RESOLVER\$1CACHING**: Individual resolvers that you specify are cached.
+  **OPERATION\$1LEVEL\$1CACHING**: Full requests are cached together and returned without executing resolvers.
Type: String  
Valid Values: `FULL_REQUEST_CACHING | PER_RESOLVER_CACHING | OPERATION_LEVEL_CACHING`   
Required: Yes

 ** [atRestEncryptionEnabled](#API_CreateApiCache_RequestSyntax) **   <a name="appsync-CreateApiCache-request-atRestEncryptionEnabled"></a>
 *This parameter has been deprecated.*   
At-rest encryption flag for cache. You cannot update this setting after creation.  
Type: Boolean  
Required: No

 ** [healthMetricsConfig](#API_CreateApiCache_RequestSyntax) **   <a name="appsync-CreateApiCache-request-healthMetricsConfig"></a>
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:  
+ NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
+ EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.
Metrics will be recorded by API ID. You can set the value to `ENABLED` or `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [transitEncryptionEnabled](#API_CreateApiCache_RequestSyntax) **   <a name="appsync-CreateApiCache-request-transitEncryptionEnabled"></a>
 *This parameter has been deprecated.*   
Transit encryption flag when connecting to cache. You cannot update this setting after creation.  
Type: Boolean  
Required: No

 ** [ttl](#API_CreateApiCache_RequestSyntax) **   <a name="appsync-CreateApiCache-request-ttl"></a>
TTL in seconds for cache entries.  
Valid values are 1–3,600 seconds.  
Type: Long  
Required: Yes

 ** [type](#API_CreateApiCache_RequestSyntax) **   <a name="appsync-CreateApiCache-request-type"></a>
The cache instance type. Valid values are   
+  `SMALL` 
+  `MEDIUM` 
+  `LARGE` 
+  `XLARGE` 
+  `LARGE_2X` 
+  `LARGE_4X` 
+  `LARGE_8X` (not available in all regions)
+  `LARGE_12X` 
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.  
The following legacy instance types are available, but their use is discouraged:  
+  **T2\$1SMALL**: A t2.small instance type.
+  **T2\$1MEDIUM**: A t2.medium instance type.
+  **R4\$1LARGE**: A r4.large instance type.
+  **R4\$1XLARGE**: A r4.xlarge instance type.
+  **R4\$12XLARGE**: A r4.2xlarge instance type.
+  **R4\$14XLARGE**: A r4.4xlarge instance type.
+  **R4\$18XLARGE**: A r4.8xlarge instance type.
Type: String  
Valid Values: `T2_SMALL | T2_MEDIUM | R4_LARGE | R4_XLARGE | R4_2XLARGE | R4_4XLARGE | R4_8XLARGE | SMALL | MEDIUM | LARGE | XLARGE | LARGE_2X | LARGE_4X | LARGE_8X | LARGE_12X`   
Required: Yes

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

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

{
   "apiCache": { 
      "apiCachingBehavior": "string",
      "atRestEncryptionEnabled": boolean,
      "healthMetricsConfig": "string",
      "status": "string",
      "transitEncryptionEnabled": boolean,
      "ttl": number,
      "type": "string"
   }
}
```

## Response Elements
<a name="API_CreateApiCache_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.

 ** [apiCache](#API_CreateApiCache_ResponseSyntax) **   <a name="appsync-CreateApiCache-response-apiCache"></a>
The `ApiCache` object.  
Type: [ApiCache](API_ApiCache.md) object

## Errors
<a name="API_CreateApiCache_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_CreateApiCache_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/CreateApiCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateApiCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateApiCache) 

# CreateApiKey
<a name="API_CreateApiKey"></a>

Creates a unique key that you can distribute to clients who invoke your API.

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

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

{
   "description": "string",
   "expires": number
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_CreateApiKey_RequestSyntax) **   <a name="appsync-CreateApiKey-request-uri-apiId"></a>
The ID for your GraphQL API.  
Required: Yes

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

The request accepts the following data in JSON format.

 ** [description](#API_CreateApiKey_RequestSyntax) **   <a name="appsync-CreateApiKey-request-description"></a>
A description of the purpose of the API key.  
Type: String  
Required: No

 ** [expires](#API_CreateApiKey_RequestSyntax) **   <a name="appsync-CreateApiKey-request-expires"></a>
From the creation time, the time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see [ApiKey](API_ApiKey.md).  
Type: Long  
Required: No

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

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

{
   "apiKey": { 
      "deletes": number,
      "description": "string",
      "expires": number,
      "id": "string"
   }
}
```

## Response Elements
<a name="API_CreateApiKey_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.

 ** [apiKey](#API_CreateApiKey_ResponseSyntax) **   <a name="appsync-CreateApiKey-response-apiKey"></a>
The API key.  
Type: [ApiKey](API_ApiKey.md) object

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

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

 ** ApiKeyLimitExceededException **   
The API key exceeded a limit. Try your request again.  
HTTP Status Code: 400

 ** ApiKeyValidityOutOfBoundsException **   
The API key expiration must be set to a value between 1 and 365 days from creation (for `CreateApiKey`) or from update (for `UpdateApiKey`).  
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.    
 ** 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

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

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** 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_CreateApiKey_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/CreateApiKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateApiKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateApiKey) 

# CreateChannelNamespace
<a name="API_CreateChannelNamespace"></a>

Creates a `ChannelNamespace` for an `Api`.

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

```
POST /v2/apis/apiId/channelNamespaces HTTP/1.1
Content-type: application/json

{
   "codeHandlers": "string",
   "handlerConfigs": { 
      "onPublish": { 
         "behavior": "string",
         "integration": { 
            "dataSourceName": "string",
            "lambdaConfig": { 
               "invokeType": "string"
            }
         }
      },
      "onSubscribe": { 
         "behavior": "string",
         "integration": { 
            "dataSourceName": "string",
            "lambdaConfig": { 
               "invokeType": "string"
            }
         }
      }
   },
   "name": "string",
   "publishAuthModes": [ 
      { 
         "authType": "string"
      }
   ],
   "subscribeAuthModes": [ 
      { 
         "authType": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_CreateChannelNamespace_RequestSyntax) **   <a name="appsync-CreateChannelNamespace-request-uri-apiId"></a>
The `Api` ID.  
Required: Yes

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

The request accepts the following data in JSON format.

 ** [codeHandlers](#API_CreateChannelNamespace_RequestSyntax) **   <a name="appsync-CreateChannelNamespace-request-codeHandlers"></a>
The event handler functions that run custom business logic to process published events and subscribe requests.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

 ** [handlerConfigs](#API_CreateChannelNamespace_RequestSyntax) **   <a name="appsync-CreateChannelNamespace-request-handlerConfigs"></a>
The configuration for the `OnPublish` and `OnSubscribe` handlers.  
Type: [HandlerConfigs](API_HandlerConfigs.md) object  
Required: No

 ** [name](#API_CreateChannelNamespace_RequestSyntax) **   <a name="appsync-CreateChannelNamespace-request-name"></a>
The name of the `ChannelNamespace`. This name must be unique within the `Api`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `([A-Za-z0-9](?:[A-Za-z0-9\-]{0,48}[A-Za-z0-9])?)`   
Required: Yes

 ** [publishAuthModes](#API_CreateChannelNamespace_RequestSyntax) **   <a name="appsync-CreateChannelNamespace-request-publishAuthModes"></a>
The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.  
Type: Array of [AuthMode](API_AuthMode.md) objects  
Required: No

 ** [subscribeAuthModes](#API_CreateChannelNamespace_RequestSyntax) **   <a name="appsync-CreateChannelNamespace-request-subscribeAuthModes"></a>
The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.  
Type: Array of [AuthMode](API_AuthMode.md) objects  
Required: No

 ** [tags](#API_CreateChannelNamespace_RequestSyntax) **   <a name="appsync-CreateChannelNamespace-request-tags"></a>
A map with keys of `TagKey` objects and values of `TagValue` objects.  
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.  
Value Pattern: `^[\s\w+-=\.:/@]*$`   
Required: No

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

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

{
   "channelNamespace": { 
      "apiId": "string",
      "channelNamespaceArn": "string",
      "codeHandlers": "string",
      "created": number,
      "handlerConfigs": { 
         "onPublish": { 
            "behavior": "string",
            "integration": { 
               "dataSourceName": "string",
               "lambdaConfig": { 
                  "invokeType": "string"
               }
            }
         },
         "onSubscribe": { 
            "behavior": "string",
            "integration": { 
               "dataSourceName": "string",
               "lambdaConfig": { 
                  "invokeType": "string"
               }
            }
         }
      },
      "lastModified": number,
      "name": "string",
      "publishAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "subscribeAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_CreateChannelNamespace_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.

 ** [channelNamespace](#API_CreateChannelNamespace_ResponseSyntax) **   <a name="appsync-CreateChannelNamespace-response-channelNamespace"></a>
The `ChannelNamespace` object.  
Type: [ChannelNamespace](API_ChannelNamespace.md) object

## Errors
<a name="API_CreateChannelNamespace_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

 ** ConflictException **   
A conflict with a previous successful update is detected. This typically occurs when the previous update did not have time to propagate before the next update was made. A retry (with appropriate backoff logic) is the recommended response to this exception.  
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

 ** ServiceQuotaExceededException **   
The operation exceeded the service quota for this resource.  
HTTP Status Code: 402

 ** UnauthorizedException **   
You aren't authorized to perform this operation.  
HTTP Status Code: 401

## See Also
<a name="API_CreateChannelNamespace_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/CreateChannelNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateChannelNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateChannelNamespace) 

# CreateDataSource
<a name="API_CreateDataSource"></a>

Creates a `DataSource` object.

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

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

{
   "description": "string",
   "dynamodbConfig": { 
      "awsRegion": "string",
      "deltaSyncConfig": { 
         "baseTableTTL": number,
         "deltaSyncTableName": "string",
         "deltaSyncTableTTL": number
      },
      "tableName": "string",
      "useCallerCredentials": boolean,
      "versioned": boolean
   },
   "elasticsearchConfig": { 
      "awsRegion": "string",
      "endpoint": "string"
   },
   "eventBridgeConfig": { 
      "eventBusArn": "string"
   },
   "httpConfig": { 
      "authorizationConfig": { 
         "authorizationType": "string",
         "awsIamConfig": { 
            "signingRegion": "string",
            "signingServiceName": "string"
         }
      },
      "endpoint": "string"
   },
   "lambdaConfig": { 
      "lambdaFunctionArn": "string"
   },
   "metricsConfig": "string",
   "name": "string",
   "openSearchServiceConfig": { 
      "awsRegion": "string",
      "endpoint": "string"
   },
   "relationalDatabaseConfig": { 
      "rdsHttpEndpointConfig": { 
         "awsRegion": "string",
         "awsSecretStoreArn": "string",
         "databaseName": "string",
         "dbClusterIdentifier": "string",
         "schema": "string"
      },
      "relationalDatabaseSourceType": "string"
   },
   "serviceRoleArn": "string",
   "type": "string"
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-uri-apiId"></a>
The API ID for the GraphQL API for the `DataSource`.  
Required: Yes

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

The request accepts the following data in JSON format.

 ** [description](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-description"></a>
A description of the `DataSource`.  
Type: String  
Required: No

 ** [dynamodbConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-dynamodbConfig"></a>
Amazon DynamoDB settings.  
Type: [DynamodbDataSourceConfig](API_DynamodbDataSourceConfig.md) object  
Required: No

 ** [elasticsearchConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-elasticsearchConfig"></a>
Amazon OpenSearch Service settings.  
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use [CreateDataSource:openSearchServiceConfig](#appsync-CreateDataSource-request-openSearchServiceConfig) to create an OpenSearch data source.  
Type: [ElasticsearchDataSourceConfig](API_ElasticsearchDataSourceConfig.md) object  
Required: No

 ** [eventBridgeConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-eventBridgeConfig"></a>
Amazon EventBridge settings.  
Type: [EventBridgeDataSourceConfig](API_EventBridgeDataSourceConfig.md) object  
Required: No

 ** [httpConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-httpConfig"></a>
HTTP endpoint settings.  
Type: [HttpDataSourceConfig](API_HttpDataSourceConfig.md) object  
Required: No

 ** [lambdaConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-lambdaConfig"></a>
 AWS Lambda settings.  
Type: [LambdaDataSourceConfig](API_LambdaDataSourceConfig.md) object  
Required: No

 ** [metricsConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-metricsConfig"></a>
Enables or disables enhanced data source metrics for specified data sources. Note that `metricsConfig` won't be used unless the `dataSourceLevelMetricsBehavior` value is set to `PER_DATA_SOURCE_METRICS`. If the `dataSourceLevelMetricsBehavior` is set to `FULL_REQUEST_DATA_SOURCE_METRICS` instead, `metricsConfig` will be ignored. However, you can still set its value.  
 `metricsConfig` can be `ENABLED` or `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [name](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-name"></a>
A user-supplied name for the `DataSource`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [openSearchServiceConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-openSearchServiceConfig"></a>
Amazon OpenSearch Service settings.  
Type: [OpenSearchServiceDataSourceConfig](API_OpenSearchServiceDataSourceConfig.md) object  
Required: No

 ** [relationalDatabaseConfig](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-relationalDatabaseConfig"></a>
Relational database settings.  
Type: [RelationalDatabaseDataSourceConfig](API_RelationalDatabaseDataSourceConfig.md) object  
Required: No

 ** [serviceRoleArn](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-serviceRoleArn"></a>
The AWS Identity and Access Management (IAM) service role Amazon Resource Name (ARN) for the data source. The system assumes this role when accessing the data source.  
Type: String  
Required: No

 ** [type](#API_CreateDataSource_RequestSyntax) **   <a name="appsync-CreateDataSource-request-type"></a>
The type of the `DataSource`.  
Type: String  
Valid Values: `AWS_LAMBDA | AMAZON_DYNAMODB | AMAZON_ELASTICSEARCH | NONE | HTTP | RELATIONAL_DATABASE | AMAZON_OPENSEARCH_SERVICE | AMAZON_EVENTBRIDGE | AMAZON_BEDROCK_RUNTIME`   
Required: Yes

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

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

{
   "dataSource": { 
      "dataSourceArn": "string",
      "description": "string",
      "dynamodbConfig": { 
         "awsRegion": "string",
         "deltaSyncConfig": { 
            "baseTableTTL": number,
            "deltaSyncTableName": "string",
            "deltaSyncTableTTL": number
         },
         "tableName": "string",
         "useCallerCredentials": boolean,
         "versioned": boolean
      },
      "elasticsearchConfig": { 
         "awsRegion": "string",
         "endpoint": "string"
      },
      "eventBridgeConfig": { 
         "eventBusArn": "string"
      },
      "httpConfig": { 
         "authorizationConfig": { 
            "authorizationType": "string",
            "awsIamConfig": { 
               "signingRegion": "string",
               "signingServiceName": "string"
            }
         },
         "endpoint": "string"
      },
      "lambdaConfig": { 
         "lambdaFunctionArn": "string"
      },
      "metricsConfig": "string",
      "name": "string",
      "openSearchServiceConfig": { 
         "awsRegion": "string",
         "endpoint": "string"
      },
      "relationalDatabaseConfig": { 
         "rdsHttpEndpointConfig": { 
            "awsRegion": "string",
            "awsSecretStoreArn": "string",
            "databaseName": "string",
            "dbClusterIdentifier": "string",
            "schema": "string"
         },
         "relationalDatabaseSourceType": "string"
      },
      "serviceRoleArn": "string",
      "type": "string"
   }
}
```

## Response Elements
<a name="API_CreateDataSource_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.

 ** [dataSource](#API_CreateDataSource_ResponseSyntax) **   <a name="appsync-CreateDataSource-response-dataSource"></a>
The `DataSource` object.  
Type: [DataSource](API_DataSource.md) object

## Errors
<a name="API_CreateDataSource_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_CreateDataSource_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/CreateDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateDataSource) 

# CreateDomainName
<a name="API_CreateDomainName"></a>

Creates a custom `DomainName` object.

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

```
POST /v1/domainnames HTTP/1.1
Content-type: application/json

{
   "certificateArn": "string",
   "description": "string",
   "domainName": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

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

The request does not use any URI parameters.

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

The request accepts the following data in JSON format.

 ** [certificateArn](#API_CreateDomainName_RequestSyntax) **   <a name="appsync-CreateDomainName-request-certificateArn"></a>
The Amazon Resource Name (ARN) of the certificate. This can be an AWS Certificate Manager (ACM) certificate or an AWS Identity and Access Management (IAM) server certificate.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$`   
Required: Yes

 ** [description](#API_CreateDomainName_RequestSyntax) **   <a name="appsync-CreateDomainName-request-description"></a>
A description of the `DomainName`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `^.*$`   
Required: No

 ** [domainName](#API_CreateDomainName_RequestSyntax) **   <a name="appsync-CreateDomainName-request-domainName"></a>
The domain name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$`   
Required: Yes

 ** [tags](#API_CreateDomainName_RequestSyntax) **   <a name="appsync-CreateDomainName-request-tags"></a>
A map with keys of `TagKey` objects and values of `TagValue` objects.  
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.  
Value Pattern: `^[\s\w+-=\.:/@]*$`   
Required: No

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

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

{
   "domainNameConfig": { 
      "appsyncDomainName": "string",
      "certificateArn": "string",
      "description": "string",
      "domainName": "string",
      "domainNameArn": "string",
      "hostedZoneId": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_CreateDomainName_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.

 ** [domainNameConfig](#API_CreateDomainName_ResponseSyntax) **   <a name="appsync-CreateDomainName-response-domainNameConfig"></a>
The configuration for the `DomainName`.  
Type: [DomainNameConfig](API_DomainNameConfig.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** InternalFailureException **   
An internal AWS AppSync error occurred. Try your request again.  
HTTP Status Code: 500

## See Also
<a name="API_CreateDomainName_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/CreateDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateDomainName) 

# CreateFunction
<a name="API_CreateFunction"></a>

Creates a `Function` object.

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

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

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

{
   "code": "string",
   "dataSourceName": "string",
   "description": "string",
   "functionVersion": "string",
   "maxBatchSize": number,
   "name": "string",
   "requestMappingTemplate": "string",
   "responseMappingTemplate": "string",
   "runtime": { 
      "name": "string",
      "runtimeVersion": "string"
   },
   "syncConfig": { 
      "conflictDetection": "string",
      "conflictHandler": "string",
      "lambdaConflictHandlerConfig": { 
         "lambdaConflictHandlerArn": "string"
      }
   }
}
```

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

The request uses the following URI parameters.

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

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

The request accepts the following data in JSON format.

 ** [code](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-code"></a>
The `function` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

 ** [dataSourceName](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-dataSourceName"></a>
The `Function` `DataSource` name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [description](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-description"></a>
The `Function` description.  
Type: String  
Required: No

 ** [functionVersion](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-functionVersion"></a>
The `version` of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the `functionVersion` is required.  
Type: String  
Required: No

 ** [maxBatchSize](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-maxBatchSize"></a>
The maximum batching size for a resolver.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2000.  
Required: No

 ** [name](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-name"></a>
The `Function` name. The function name does not have to be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [requestMappingTemplate](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-requestMappingTemplate"></a>
The `Function` request mapping template. Functions support only the 2018-05-29 version of the request mapping template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [responseMappingTemplate](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-responseMappingTemplate"></a>
The `Function` response mapping template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [runtime](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-runtime"></a>
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.  
Type: [AppSyncRuntime](API_AppSyncRuntime.md) object  
Required: No

 ** [syncConfig](#API_CreateFunction_RequestSyntax) **   <a name="appsync-CreateFunction-request-syncConfig"></a>
Describes a Sync configuration for a resolver.  
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.  
Type: [SyncConfig](API_SyncConfig.md) object  
Required: No

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

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

{
   "functionConfiguration": { 
      "code": "string",
      "dataSourceName": "string",
      "description": "string",
      "functionArn": "string",
      "functionId": "string",
      "functionVersion": "string",
      "maxBatchSize": number,
      "name": "string",
      "requestMappingTemplate": "string",
      "responseMappingTemplate": "string",
      "runtime": { 
         "name": "string",
         "runtimeVersion": "string"
      },
      "syncConfig": { 
         "conflictDetection": "string",
         "conflictHandler": "string",
         "lambdaConflictHandlerConfig": { 
            "lambdaConflictHandlerArn": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_CreateFunction_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.

 ** [functionConfiguration](#API_CreateFunction_ResponseSyntax) **   <a name="appsync-CreateFunction-response-functionConfiguration"></a>
The `Function` object.  
Type: [FunctionConfiguration](API_FunctionConfiguration.md) object

## Errors
<a name="API_CreateFunction_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_CreateFunction_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/CreateFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateFunction) 

# CreateGraphqlApi
<a name="API_CreateGraphqlApi"></a>

Creates a `GraphqlApi` object.

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

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

{
   "additionalAuthenticationProviders": [ 
      { 
         "authenticationType": "string",
         "lambdaAuthorizerConfig": { 
            "authorizerResultTtlInSeconds": number,
            "authorizerUri": "string",
            "identityValidationExpression": "string"
         },
         "openIDConnectConfig": { 
            "authTTL": number,
            "clientId": "string",
            "iatTTL": number,
            "issuer": "string"
         },
         "userPoolConfig": { 
            "appIdClientRegex": "string",
            "awsRegion": "string",
            "userPoolId": "string"
         }
      }
   ],
   "apiType": "string",
   "authenticationType": "string",
   "enhancedMetricsConfig": { 
      "dataSourceLevelMetricsBehavior": "string",
      "operationLevelMetricsConfig": "string",
      "resolverLevelMetricsBehavior": "string"
   },
   "introspectionConfig": "string",
   "lambdaAuthorizerConfig": { 
      "authorizerResultTtlInSeconds": number,
      "authorizerUri": "string",
      "identityValidationExpression": "string"
   },
   "logConfig": { 
      "cloudWatchLogsRoleArn": "string",
      "excludeVerboseContent": boolean,
      "fieldLogLevel": "string"
   },
   "mergedApiExecutionRoleArn": "string",
   "name": "string",
   "openIDConnectConfig": { 
      "authTTL": number,
      "clientId": "string",
      "iatTTL": number,
      "issuer": "string"
   },
   "ownerContact": "string",
   "queryDepthLimit": number,
   "resolverCountLimit": number,
   "tags": { 
      "string" : "string" 
   },
   "userPoolConfig": { 
      "appIdClientRegex": "string",
      "awsRegion": "string",
      "defaultAction": "string",
      "userPoolId": "string"
   },
   "visibility": "string",
   "xrayEnabled": boolean
}
```

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

The request does not use any URI parameters.

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

The request accepts the following data in JSON format.

 ** [additionalAuthenticationProviders](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-additionalAuthenticationProviders"></a>
A list of additional authentication providers for the `GraphqlApi` API.  
Type: Array of [AdditionalAuthenticationProvider](API_AdditionalAuthenticationProvider.md) objects  
Required: No

 ** [apiType](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-apiType"></a>
The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API (`MERGED`).  
Type: String  
Valid Values: `GRAPHQL | MERGED`   
Required: No

 ** [authenticationType](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-authenticationType"></a>
The authentication type: API key, AWS Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or AWS Lambda.  
Type: String  
Valid Values: `API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDA`   
Required: Yes

 ** [enhancedMetricsConfig](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-enhancedMetricsConfig"></a>
The `enhancedMetricsConfig` object.  
Type: [EnhancedMetricsConfig](API_EnhancedMetricsConfig.md) object  
Required: No

 ** [introspectionConfig](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-introspectionConfig"></a>
Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection. If no value is provided, the introspection configuration will be set to `ENABLED` by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.  
For more information about introspection, see [GraphQL introspection](https://graphql.org/learn/introspection/).  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [lambdaAuthorizerConfig](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-lambdaAuthorizerConfig"></a>
Configuration for AWS Lambda function authorization.  
Type: [LambdaAuthorizerConfig](API_LambdaAuthorizerConfig.md) object  
Required: No

 ** [logConfig](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-logConfig"></a>
The Amazon CloudWatch Logs configuration.  
Type: [LogConfig](API_LogConfig.md) object  
Required: No

 ** [mergedApiExecutionRoleArn](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-mergedApiExecutionRoleArn"></a>
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the `AUTO_MERGE` to update the merged API endpoint with the source API changes automatically.  
Type: String  
Required: No

 ** [name](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-name"></a>
A user-supplied name for the `GraphqlApi`.  
Type: String  
Required: Yes

 ** [openIDConnectConfig](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-openIDConnectConfig"></a>
The OIDC configuration.  
Type: [OpenIDConnectConfig](API_OpenIDConnectConfig.md) object  
Required: No

 ** [ownerContact](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-ownerContact"></a>
The owner contact information for an API resource.  
This field accepts any string input with a length of 0 - 256 characters.  
Type: String  
Required: No

 ** [queryDepthLimit](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-queryDepthLimit"></a>
The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is `0` (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between `1` and `75` nested levels. This field will produce a limit error if the operation falls out of bounds.  
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 75.  
Required: No

 ** [resolverCountLimit](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-resolverCountLimit"></a>
The maximum number of resolvers that can be invoked in a single request. The default value is `0` (or unspecified), which will set the limit to `10000`. When specified, the limit value can be between `1` and `10000`. This field will produce a limit error if the operation falls out of bounds.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 10000.  
Required: No

 ** [tags](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-tags"></a>
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.  
Value Pattern: `^[\s\w+-=\.:/@]*$`   
Required: No

 ** [userPoolConfig](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-userPoolConfig"></a>
The Amazon Cognito user pool configuration.  
Type: [UserPoolConfig](API_UserPoolConfig.md) object  
Required: No

 ** [visibility](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-visibility"></a>
Sets the value of the GraphQL API to public (`GLOBAL`) or private (`PRIVATE`). If no value is provided, the visibility will be set to `GLOBAL` by default. This value cannot be changed once the API has been created.  
Type: String  
Valid Values: `GLOBAL | PRIVATE`   
Required: No

 ** [xrayEnabled](#API_CreateGraphqlApi_RequestSyntax) **   <a name="appsync-CreateGraphqlApi-request-xrayEnabled"></a>
A flag indicating whether to use AWS X-Ray tracing for the `GraphqlApi`.  
Type: Boolean  
Required: No

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

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

{
   "graphqlApi": { 
      "additionalAuthenticationProviders": [ 
         { 
            "authenticationType": "string",
            "lambdaAuthorizerConfig": { 
               "authorizerResultTtlInSeconds": number,
               "authorizerUri": "string",
               "identityValidationExpression": "string"
            },
            "openIDConnectConfig": { 
               "authTTL": number,
               "clientId": "string",
               "iatTTL": number,
               "issuer": "string"
            },
            "userPoolConfig": { 
               "appIdClientRegex": "string",
               "awsRegion": "string",
               "userPoolId": "string"
            }
         }
      ],
      "apiId": "string",
      "apiType": "string",
      "arn": "string",
      "authenticationType": "string",
      "dns": { 
         "string" : "string" 
      },
      "enhancedMetricsConfig": { 
         "dataSourceLevelMetricsBehavior": "string",
         "operationLevelMetricsConfig": "string",
         "resolverLevelMetricsBehavior": "string"
      },
      "introspectionConfig": "string",
      "lambdaAuthorizerConfig": { 
         "authorizerResultTtlInSeconds": number,
         "authorizerUri": "string",
         "identityValidationExpression": "string"
      },
      "logConfig": { 
         "cloudWatchLogsRoleArn": "string",
         "excludeVerboseContent": boolean,
         "fieldLogLevel": "string"
      },
      "mergedApiExecutionRoleArn": "string",
      "name": "string",
      "openIDConnectConfig": { 
         "authTTL": number,
         "clientId": "string",
         "iatTTL": number,
         "issuer": "string"
      },
      "owner": "string",
      "ownerContact": "string",
      "queryDepthLimit": number,
      "resolverCountLimit": number,
      "tags": { 
         "string" : "string" 
      },
      "uris": { 
         "string" : "string" 
      },
      "userPoolConfig": { 
         "appIdClientRegex": "string",
         "awsRegion": "string",
         "defaultAction": "string",
         "userPoolId": "string"
      },
      "visibility": "string",
      "wafWebAclArn": "string",
      "xrayEnabled": boolean
   }
}
```

## Response Elements
<a name="API_CreateGraphqlApi_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.

 ** [graphqlApi](#API_CreateGraphqlApi_ResponseSyntax) **   <a name="appsync-CreateGraphqlApi-response-graphqlApi"></a>
The `GraphqlApi`.  
Type: [GraphqlApi](API_GraphqlApi.md) object

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

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

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

 ** LimitExceededException **   
The request exceeded a limit. Try your request again.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You aren't authorized to perform this operation.  
HTTP Status Code: 401

## See Also
<a name="API_CreateGraphqlApi_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/CreateGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateGraphqlApi) 

# CreateResolver
<a name="API_CreateResolver"></a>

Creates a `Resolver` object.

A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.

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

```
POST /v1/apis/apiId/types/typeName/resolvers HTTP/1.1
Content-type: application/json

{
   "cachingConfig": { 
      "cachingKeys": [ "string" ],
      "ttl": number
   },
   "code": "string",
   "dataSourceName": "string",
   "fieldName": "string",
   "kind": "string",
   "maxBatchSize": number,
   "metricsConfig": "string",
   "pipelineConfig": { 
      "functions": [ "string" ]
   },
   "requestMappingTemplate": "string",
   "responseMappingTemplate": "string",
   "runtime": { 
      "name": "string",
      "runtimeVersion": "string"
   },
   "syncConfig": { 
      "conflictDetection": "string",
      "conflictHandler": "string",
      "lambdaConflictHandlerConfig": { 
         "lambdaConflictHandlerArn": "string"
      }
   }
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-uri-apiId"></a>
The ID for the GraphQL API for which the resolver is being created.  
Required: Yes

 ** [typeName](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-uri-typeName"></a>
The name of the `Type`.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [cachingConfig](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-cachingConfig"></a>
The caching configuration for the resolver.  
Type: [CachingConfig](API_CachingConfig.md) object  
Required: No

 ** [code](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-code"></a>
The `resolver` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

 ** [dataSourceName](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-dataSourceName"></a>
The name of the data source for which the resolver is being created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: No

 ** [fieldName](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-fieldName"></a>
The name of the field to attach the resolver to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [kind](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-kind"></a>
The resolver type.  
+  **UNIT**: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
+  **PIPELINE**: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
Type: String  
Valid Values: `UNIT | PIPELINE`   
Required: No

 ** [maxBatchSize](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-maxBatchSize"></a>
The maximum batching size for a resolver.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2000.  
Required: No

 ** [metricsConfig](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-metricsConfig"></a>
Enables or disables enhanced resolver metrics for specified resolvers. Note that `metricsConfig` won't be used unless the `resolverLevelMetricsBehavior` value is set to `PER_RESOLVER_METRICS`. If the `resolverLevelMetricsBehavior` is set to `FULL_REQUEST_RESOLVER_METRICS` instead, `metricsConfig` will be ignored. However, you can still set its value.  
 `metricsConfig` can be `ENABLED` or `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [pipelineConfig](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-pipelineConfig"></a>
The `PipelineConfig`.  
Type: [PipelineConfig](API_PipelineConfig.md) object  
Required: No

 ** [requestMappingTemplate](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-requestMappingTemplate"></a>
The mapping template to use for requests.  
A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).  
VTL request mapping templates are optional when using an AWS Lambda data source. For all other data sources, VTL request and response mapping templates are required.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [responseMappingTemplate](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-responseMappingTemplate"></a>
The mapping template to use for responses from the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [runtime](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-runtime"></a>
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.  
Type: [AppSyncRuntime](API_AppSyncRuntime.md) object  
Required: No

 ** [syncConfig](#API_CreateResolver_RequestSyntax) **   <a name="appsync-CreateResolver-request-syncConfig"></a>
The `SyncConfig` for a resolver attached to a versioned data source.  
Type: [SyncConfig](API_SyncConfig.md) object  
Required: No

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

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

{
   "resolver": { 
      "cachingConfig": { 
         "cachingKeys": [ "string" ],
         "ttl": number
      },
      "code": "string",
      "dataSourceName": "string",
      "fieldName": "string",
      "kind": "string",
      "maxBatchSize": number,
      "metricsConfig": "string",
      "pipelineConfig": { 
         "functions": [ "string" ]
      },
      "requestMappingTemplate": "string",
      "resolverArn": "string",
      "responseMappingTemplate": "string",
      "runtime": { 
         "name": "string",
         "runtimeVersion": "string"
      },
      "syncConfig": { 
         "conflictDetection": "string",
         "conflictHandler": "string",
         "lambdaConflictHandlerConfig": { 
            "lambdaConflictHandlerArn": "string"
         }
      },
      "typeName": "string"
   }
}
```

## Response Elements
<a name="API_CreateResolver_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.

 ** [resolver](#API_CreateResolver_ResponseSyntax) **   <a name="appsync-CreateResolver-response-resolver"></a>
The `Resolver` object.  
Type: [Resolver](API_Resolver.md) object

## Errors
<a name="API_CreateResolver_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_CreateResolver_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/CreateResolver) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateResolver) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateResolver) 

# CreateType
<a name="API_CreateType"></a>

Creates a `Type` object.

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

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

{
   "definition": "string",
   "format": "string"
}
```

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

The request uses the following URI parameters.

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

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

The request accepts the following data in JSON format.

 ** [definition](#API_CreateType_RequestSyntax) **   <a name="appsync-CreateType-request-definition"></a>
The type definition, in GraphQL Schema Definition Language (SDL) format.  
For more information, see the [GraphQL SDL documentation](http://graphql.org/learn/schema/).  
Type: String  
Required: Yes

 ** [format](#API_CreateType_RequestSyntax) **   <a name="appsync-CreateType-request-format"></a>
The type format: SDL or JSON.  
Type: String  
Valid Values: `SDL | JSON`   
Required: Yes

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

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

{
   "type": { 
      "arn": "string",
      "definition": "string",
      "description": "string",
      "format": "string",
      "name": "string"
   }
}
```

## Response Elements
<a name="API_CreateType_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.

 ** [type](#API_CreateType_ResponseSyntax) **   <a name="appsync-CreateType-response-type"></a>
The `Type` object.  
Type: [Type](API_Type.md) object

## Errors
<a name="API_CreateType_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_CreateType_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/CreateType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/CreateType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/CreateType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/CreateType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/CreateType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/CreateType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/CreateType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/CreateType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/CreateType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/CreateType) 

# DeleteApi
<a name="API_DeleteApi"></a>

Deletes an `Api` object

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

```
DELETE /v2/apis/apiId HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiId](#API_DeleteApi_RequestSyntax) **   <a name="appsync-DeleteApi-request-uri-apiId"></a>
The `Api` ID.  
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

 ** 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_DeleteApi_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/DeleteApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteApi) 

# DeleteApiCache
<a name="API_DeleteApiCache"></a>

Deletes an `ApiCache` object.

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

```
DELETE /v1/apis/apiId/ApiCaches HTTP/1.1
```

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

The request uses the following URI parameters.

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

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

## Errors
<a name="API_DeleteApiCache_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_DeleteApiCache_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/DeleteApiCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteApiCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteApiCache) 

# DeleteApiKey
<a name="API_DeleteApiKey"></a>

Deletes an API key.

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

```
DELETE /v1/apis/apiId/apikeys/id HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [id](#API_DeleteApiKey_RequestSyntax) **   <a name="appsync-DeleteApiKey-request-uri-id"></a>
The ID for the API key.  
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

## Errors
<a name="API_DeleteApiKey_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

 ** 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_DeleteApiKey_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/DeleteApiKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteApiKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteApiKey) 

# DeleteChannelNamespace
<a name="API_DeleteChannelNamespace"></a>

Deletes a `ChannelNamespace`.

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

```
DELETE /v2/apis/apiId/channelNamespaces/name HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiId](#API_DeleteChannelNamespace_RequestSyntax) **   <a name="appsync-DeleteChannelNamespace-request-uri-apiId"></a>
The ID of the `Api` associated with the `ChannelNamespace`.  
Required: Yes

 ** [name](#API_DeleteChannelNamespace_RequestSyntax) **   <a name="appsync-DeleteChannelNamespace-request-uri-name"></a>
The name of the `ChannelNamespace`.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `([A-Za-z0-9](?:[A-Za-z0-9\-]{0,48}[A-Za-z0-9])?)`   
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

 ** 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_DeleteChannelNamespace_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/DeleteChannelNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteChannelNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteChannelNamespace) 

# DeleteDataSource
<a name="API_DeleteDataSource"></a>

Deletes a `DataSource` object.

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

```
DELETE /v1/apis/apiId/datasources/name HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [name](#API_DeleteDataSource_RequestSyntax) **   <a name="appsync-DeleteDataSource-request-uri-name"></a>
The name of the data source.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

## Errors
<a name="API_DeleteDataSource_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_DeleteDataSource_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/DeleteDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteDataSource) 

# DeleteDomainName
<a name="API_DeleteDomainName"></a>

Deletes a custom `DomainName` object.

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

```
DELETE /v1/domainnames/domainName HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [domainName](#API_DeleteDomainName_RequestSyntax) **   <a name="appsync-DeleteDomainName-request-uri-domainName"></a>
The domain name.  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$`   
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

## See Also
<a name="API_DeleteDomainName_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/DeleteDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteDomainName) 

# DeleteFunction
<a name="API_DeleteFunction"></a>

Deletes a `Function`.

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

```
DELETE /v1/apis/apiId/functions/functionId HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [functionId](#API_DeleteFunction_RequestSyntax) **   <a name="appsync-DeleteFunction-request-uri-functionId"></a>
The `Function` ID.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

## Errors
<a name="API_DeleteFunction_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_DeleteFunction_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/DeleteFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteFunction) 

# DeleteGraphqlApi
<a name="API_DeleteGraphqlApi"></a>

Deletes a `GraphqlApi` object.

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

```
DELETE /v1/apis/apiId HTTP/1.1
```

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

The request uses the following URI parameters.

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

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

 ** 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_DeleteGraphqlApi_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/DeleteGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteGraphqlApi) 

# DeleteResolver
<a name="API_DeleteResolver"></a>

Deletes a `Resolver` object.

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

```
DELETE /v1/apis/apiId/types/typeName/resolvers/fieldName HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [fieldName](#API_DeleteResolver_RequestSyntax) **   <a name="appsync-DeleteResolver-request-uri-fieldName"></a>
The resolver field name.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [typeName](#API_DeleteResolver_RequestSyntax) **   <a name="appsync-DeleteResolver-request-uri-typeName"></a>
The name of the resolver type.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

## Errors
<a name="API_DeleteResolver_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_DeleteResolver_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/DeleteResolver) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteResolver) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteResolver) 

# DeleteType
<a name="API_DeleteType"></a>

Deletes a `Type` object.

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

```
DELETE /v1/apis/apiId/types/typeName HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [typeName](#API_DeleteType_RequestSyntax) **   <a name="appsync-DeleteType-request-uri-typeName"></a>
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
<a name="API_DeleteType_RequestBody"></a>

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

## Errors
<a name="API_DeleteType_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_DeleteType_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/DeleteType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DeleteType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DeleteType) 

# DisassociateApi
<a name="API_DisassociateApi"></a>

Removes an `ApiAssociation` object from a custom domain.

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

```
DELETE /v1/domainnames/domainName/apiassociation HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [domainName](#API_DisassociateApi_RequestSyntax) **   <a name="appsync-DisassociateApi-request-uri-domainName"></a>
The domain name.  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$`   
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

## See Also
<a name="API_DisassociateApi_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/DisassociateApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DisassociateApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DisassociateApi) 

# DisassociateMergedGraphqlApi
<a name="API_DisassociateMergedGraphqlApi"></a>

Deletes an association between a Merged API and source API using the source API's identifier and the association ID.

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

```
DELETE /v1/sourceApis/sourceApiIdentifier/mergedApiAssociations/associationId HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [associationId](#API_DisassociateMergedGraphqlApi_RequestSyntax) **   <a name="appsync-DisassociateMergedGraphqlApi-request-uri-associationId"></a>
The ID generated by the AppSync service for the source API association.  
Required: Yes

 ** [sourceApiIdentifier](#API_DisassociateMergedGraphqlApi_RequestSyntax) **   <a name="appsync-DisassociateMergedGraphqlApi-request-uri-sourceApiIdentifier"></a>
The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.  
Required: Yes

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

The request does not have a request body.

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

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

{
   "sourceApiAssociationStatus": "string"
}
```

## Response Elements
<a name="API_DisassociateMergedGraphqlApi_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.

 ** [sourceApiAssociationStatus](#API_DisassociateMergedGraphqlApi_ResponseSyntax) **   <a name="appsync-DisassociateMergedGraphqlApi-response-sourceApiAssociationStatus"></a>
The state of the source API association.  
Type: String  
Valid Values: `MERGE_SCHEDULED | MERGE_FAILED | MERGE_SUCCESS | MERGE_IN_PROGRESS | AUTO_MERGE_SCHEDULE_FAILED | DELETION_SCHEDULED | DELETION_IN_PROGRESS | DELETION_FAILED` 

## Errors
<a name="API_DisassociateMergedGraphqlApi_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_DisassociateMergedGraphqlApi_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/DisassociateMergedGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DisassociateMergedGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DisassociateMergedGraphqlApi) 

# DisassociateSourceGraphqlApi
<a name="API_DisassociateSourceGraphqlApi"></a>

Deletes an association between a Merged API and source API using the Merged API's identifier and the association ID.

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

```
DELETE /v1/mergedApis/mergedApiIdentifier/sourceApiAssociations/associationId HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [associationId](#API_DisassociateSourceGraphqlApi_RequestSyntax) **   <a name="appsync-DisassociateSourceGraphqlApi-request-uri-associationId"></a>
The ID generated by the AppSync service for the source API association.  
Required: Yes

 ** [mergedApiIdentifier](#API_DisassociateSourceGraphqlApi_RequestSyntax) **   <a name="appsync-DisassociateSourceGraphqlApi-request-uri-mergedApiIdentifier"></a>
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

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

The request does not have a request body.

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

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

{
   "sourceApiAssociationStatus": "string"
}
```

## Response Elements
<a name="API_DisassociateSourceGraphqlApi_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.

 ** [sourceApiAssociationStatus](#API_DisassociateSourceGraphqlApi_ResponseSyntax) **   <a name="appsync-DisassociateSourceGraphqlApi-response-sourceApiAssociationStatus"></a>
The state of the source API association.  
Type: String  
Valid Values: `MERGE_SCHEDULED | MERGE_FAILED | MERGE_SUCCESS | MERGE_IN_PROGRESS | AUTO_MERGE_SCHEDULE_FAILED | DELETION_SCHEDULED | DELETION_IN_PROGRESS | DELETION_FAILED` 

## Errors
<a name="API_DisassociateSourceGraphqlApi_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_DisassociateSourceGraphqlApi_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/DisassociateSourceGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/DisassociateSourceGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/DisassociateSourceGraphqlApi) 

# EvaluateCode
<a name="API_EvaluateCode"></a>

Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For `APPSYNC_JS` runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type. 

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

```
POST /v1/dataplane-evaluatecode HTTP/1.1
Content-type: application/json

{
   "code": "string",
   "context": "string",
   "function": "string",
   "runtime": { 
      "name": "string",
      "runtimeVersion": "string"
   }
}
```

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

The request does not use any URI parameters.

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

The request accepts the following data in JSON format.

 ** [code](#API_EvaluateCode_RequestSyntax) **   <a name="appsync-EvaluateCode-request-code"></a>
The code definition to be evaluated. Note that `code` and `runtime` are both required for this action. The `runtime` value must be `APPSYNC_JS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: Yes

 ** [context](#API_EvaluateCode_RequestSyntax) **   <a name="appsync-EvaluateCode-request-context"></a>
The map that holds all of the contextual information for your resolver invocation. A `context` is required for this action.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 28000.  
Pattern: `^[\s\S]*$`   
Required: Yes

 ** [function](#API_EvaluateCode_RequestSyntax) **   <a name="appsync-EvaluateCode-request-function"></a>
The function within the code to be evaluated. If provided, the valid values are `request` and `response`.  
Type: String  
Required: No

 ** [runtime](#API_EvaluateCode_RequestSyntax) **   <a name="appsync-EvaluateCode-request-runtime"></a>
The runtime to be used when evaluating the code. Currently, only the `APPSYNC_JS` runtime is supported.  
Type: [AppSyncRuntime](API_AppSyncRuntime.md) object  
Required: Yes

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

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

{
   "error": { 
      "codeErrors": [ 
         { 
            "errorType": "string",
            "location": { 
               "column": number,
               "line": number,
               "span": number
            },
            "value": "string"
         }
      ],
      "message": "string"
   },
   "evaluationResult": "string",
   "logs": [ "string" ],
   "outErrors": "string",
   "stash": "string"
}
```

## Response Elements
<a name="API_EvaluateCode_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.

 ** [error](#API_EvaluateCode_ResponseSyntax) **   <a name="appsync-EvaluateCode-response-error"></a>
Contains the payload of the response error.  
Type: [EvaluateCodeErrorDetail](API_EvaluateCodeErrorDetail.md) object

 ** [evaluationResult](#API_EvaluateCode_ResponseSyntax) **   <a name="appsync-EvaluateCode-response-evaluationResult"></a>
The result of the evaluation operation.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 65536.  
Pattern: `^[\s\S]*$` 

 ** [logs](#API_EvaluateCode_ResponseSyntax) **   <a name="appsync-EvaluateCode-response-logs"></a>
A list of logs that were generated by calls to `util.log.info` and `util.log.error` in the evaluated code.  
Type: Array of strings

 ** [outErrors](#API_EvaluateCode_ResponseSyntax) **   <a name="appsync-EvaluateCode-response-outErrors"></a>
The list of runtime errors that are added to the GraphQL operation response.  
Type: String  
Pattern: `^[\s\S]*$` 

 ** [stash](#API_EvaluateCode_ResponseSyntax) **   <a name="appsync-EvaluateCode-response-stash"></a>
An object available inside each resolver and function handler. A single `stash` object lives through a single resolver run. Therefore, you can use the stash to pass arbitrary data across request and response handlers and across functions in a pipeline resolver.  
Type: String  
Pattern: `^[\s\S]*$` 

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** InternalFailureException **   
An internal AWS AppSync error occurred. Try your request again.  
HTTP Status Code: 500

## See Also
<a name="API_EvaluateCode_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/EvaluateCode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/EvaluateCode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/EvaluateCode) 

# EvaluateMappingTemplate
<a name="API_EvaluateMappingTemplate"></a>

Evaluates a given template and returns the response. The mapping template can be a request or response template.

Request templates take the incoming request after a GraphQL operation is parsed and convert it into a request configuration for the selected data source operation. Response templates interpret responses from the data source and map it to the shape of the GraphQL field output type.

Mapping templates are written in the Apache Velocity Template Language (VTL).

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

```
POST /v1/dataplane-evaluatetemplate HTTP/1.1
Content-type: application/json

{
   "context": "string",
   "template": "string"
}
```

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

The request does not use any URI parameters.

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

The request accepts the following data in JSON format.

 ** [context](#API_EvaluateMappingTemplate_RequestSyntax) **   <a name="appsync-EvaluateMappingTemplate-request-context"></a>
The map that holds all of the contextual information for your resolver invocation. A `context` is required for this action.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 28000.  
Pattern: `^[\s\S]*$`   
Required: Yes

 ** [template](#API_EvaluateMappingTemplate_RequestSyntax) **   <a name="appsync-EvaluateMappingTemplate-request-template"></a>
The mapping template; this can be a request or response template. A `template` is required for this action.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 65536.  
Pattern: `^[\s\S]*$`   
Required: Yes

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

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

{
   "error": { 
      "message": "string"
   },
   "evaluationResult": "string",
   "logs": [ "string" ],
   "outErrors": "string",
   "stash": "string"
}
```

## Response Elements
<a name="API_EvaluateMappingTemplate_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.

 ** [error](#API_EvaluateMappingTemplate_ResponseSyntax) **   <a name="appsync-EvaluateMappingTemplate-response-error"></a>
The `ErrorDetail` object.  
Type: [ErrorDetail](API_ErrorDetail.md) object

 ** [evaluationResult](#API_EvaluateMappingTemplate_ResponseSyntax) **   <a name="appsync-EvaluateMappingTemplate-response-evaluationResult"></a>
The mapping template; this can be a request or response template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 65536.  
Pattern: `^[\s\S]*$` 

 ** [logs](#API_EvaluateMappingTemplate_ResponseSyntax) **   <a name="appsync-EvaluateMappingTemplate-response-logs"></a>
A list of logs that were generated by calls to `util.log.info` and `util.log.error` in the evaluated code.  
Type: Array of strings

 ** [outErrors](#API_EvaluateMappingTemplate_ResponseSyntax) **   <a name="appsync-EvaluateMappingTemplate-response-outErrors"></a>
The list of runtime errors that are added to the GraphQL operation response.  
Type: String  
Pattern: `^[\s\S]*$` 

 ** [stash](#API_EvaluateMappingTemplate_ResponseSyntax) **   <a name="appsync-EvaluateMappingTemplate-response-stash"></a>
An object available inside each resolver and function handler. A single `stash` object lives through a single resolver run. Therefore, you can use the stash to pass arbitrary data across request and response handlers and across functions in a pipeline resolver.  
Type: String  
Pattern: `^[\s\S]*$` 

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** InternalFailureException **   
An internal AWS AppSync error occurred. Try your request again.  
HTTP Status Code: 500

## See Also
<a name="API_EvaluateMappingTemplate_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/EvaluateMappingTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/EvaluateMappingTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/EvaluateMappingTemplate) 

# FlushApiCache
<a name="API_FlushApiCache"></a>

Flushes an `ApiCache` object.

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

```
DELETE /v1/apis/apiId/FlushCache HTTP/1.1
```

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

The request uses the following URI parameters.

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

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

## Errors
<a name="API_FlushApiCache_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_FlushApiCache_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/FlushApiCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/FlushApiCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/FlushApiCache) 

# GetApi
<a name="API_GetApi"></a>

Retrieves an `Api` object.

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

```
GET /v2/apis/apiId HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiId](#API_GetApi_RequestSyntax) **   <a name="appsync-GetApi-request-uri-apiId"></a>
The `Api` ID.  
Required: Yes

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

The request does not have a request body.

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

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

{
   "api": { 
      "apiArn": "string",
      "apiId": "string",
      "created": number,
      "dns": { 
         "string" : "string" 
      },
      "eventConfig": { 
         "authProviders": [ 
            { 
               "authType": "string",
               "cognitoConfig": { 
                  "appIdClientRegex": "string",
                  "awsRegion": "string",
                  "userPoolId": "string"
               },
               "lambdaAuthorizerConfig": { 
                  "authorizerResultTtlInSeconds": number,
                  "authorizerUri": "string",
                  "identityValidationExpression": "string"
               },
               "openIDConnectConfig": { 
                  "authTTL": number,
                  "clientId": "string",
                  "iatTTL": number,
                  "issuer": "string"
               }
            }
         ],
         "connectionAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "defaultPublishAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "defaultSubscribeAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "logConfig": { 
            "cloudWatchLogsRoleArn": "string",
            "logLevel": "string"
         }
      },
      "name": "string",
      "ownerContact": "string",
      "tags": { 
         "string" : "string" 
      },
      "wafWebAclArn": "string",
      "xrayEnabled": boolean
   }
}
```

## Response Elements
<a name="API_GetApi_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.

 ** [api](#API_GetApi_ResponseSyntax) **   <a name="appsync-GetApi-response-api"></a>
The `Api` object.  
Type: [Api](API_Api.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** 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_GetApi_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/GetApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetApi) 

# GetApiAssociation
<a name="API_GetApiAssociation"></a>

Retrieves an `ApiAssociation` object.

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

```
GET /v1/domainnames/domainName/apiassociation HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [domainName](#API_GetApiAssociation_RequestSyntax) **   <a name="appsync-GetApiAssociation-request-uri-domainName"></a>
The domain name.  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$`   
Required: Yes

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

The request does not have a request body.

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

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

{
   "apiAssociation": { 
      "apiId": "string",
      "associationStatus": "string",
      "deploymentDetail": "string",
      "domainName": "string"
   }
}
```

## Response Elements
<a name="API_GetApiAssociation_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.

 ** [apiAssociation](#API_GetApiAssociation_ResponseSyntax) **   <a name="appsync-GetApiAssociation-response-apiAssociation"></a>
The `ApiAssociation` object.  
Type: [ApiAssociation](API_ApiAssociation.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

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

## See Also
<a name="API_GetApiAssociation_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/GetApiAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetApiAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetApiAssociation) 

# GetApiCache
<a name="API_GetApiCache"></a>

Retrieves an `ApiCache` object.

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

```
GET /v1/apis/apiId/ApiCaches HTTP/1.1
```

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

The request uses the following URI parameters.

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

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

The request does not have a request body.

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

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

{
   "apiCache": { 
      "apiCachingBehavior": "string",
      "atRestEncryptionEnabled": boolean,
      "healthMetricsConfig": "string",
      "status": "string",
      "transitEncryptionEnabled": boolean,
      "ttl": number,
      "type": "string"
   }
}
```

## Response Elements
<a name="API_GetApiCache_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.

 ** [apiCache](#API_GetApiCache_ResponseSyntax) **   <a name="appsync-GetApiCache-response-apiCache"></a>
The `ApiCache` object.  
Type: [ApiCache](API_ApiCache.md) object

## Errors
<a name="API_GetApiCache_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_GetApiCache_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/GetApiCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetApiCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetApiCache) 

# GetChannelNamespace
<a name="API_GetChannelNamespace"></a>

Retrieves the channel namespace for a specified `Api`.

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

```
GET /v2/apis/apiId/channelNamespaces/name HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiId](#API_GetChannelNamespace_RequestSyntax) **   <a name="appsync-GetChannelNamespace-request-uri-apiId"></a>
The `Api` ID.  
Required: Yes

 ** [name](#API_GetChannelNamespace_RequestSyntax) **   <a name="appsync-GetChannelNamespace-request-uri-name"></a>
The name of the `ChannelNamespace`.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `([A-Za-z0-9](?:[A-Za-z0-9\-]{0,48}[A-Za-z0-9])?)`   
Required: Yes

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

The request does not have a request body.

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

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

{
   "channelNamespace": { 
      "apiId": "string",
      "channelNamespaceArn": "string",
      "codeHandlers": "string",
      "created": number,
      "handlerConfigs": { 
         "onPublish": { 
            "behavior": "string",
            "integration": { 
               "dataSourceName": "string",
               "lambdaConfig": { 
                  "invokeType": "string"
               }
            }
         },
         "onSubscribe": { 
            "behavior": "string",
            "integration": { 
               "dataSourceName": "string",
               "lambdaConfig": { 
                  "invokeType": "string"
               }
            }
         }
      },
      "lastModified": number,
      "name": "string",
      "publishAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "subscribeAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_GetChannelNamespace_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.

 ** [channelNamespace](#API_GetChannelNamespace_ResponseSyntax) **   <a name="appsync-GetChannelNamespace-response-channelNamespace"></a>
The `ChannelNamespace` object.  
Type: [ChannelNamespace](API_ChannelNamespace.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** 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_GetChannelNamespace_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/GetChannelNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetChannelNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetChannelNamespace) 

# GetDataSource
<a name="API_GetDataSource"></a>

Retrieves a `DataSource` object.

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

```
GET /v1/apis/apiId/datasources/name HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [name](#API_GetDataSource_RequestSyntax) **   <a name="appsync-GetDataSource-request-uri-name"></a>
The name of the data source.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request does not have a request body.

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

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

{
   "dataSource": { 
      "dataSourceArn": "string",
      "description": "string",
      "dynamodbConfig": { 
         "awsRegion": "string",
         "deltaSyncConfig": { 
            "baseTableTTL": number,
            "deltaSyncTableName": "string",
            "deltaSyncTableTTL": number
         },
         "tableName": "string",
         "useCallerCredentials": boolean,
         "versioned": boolean
      },
      "elasticsearchConfig": { 
         "awsRegion": "string",
         "endpoint": "string"
      },
      "eventBridgeConfig": { 
         "eventBusArn": "string"
      },
      "httpConfig": { 
         "authorizationConfig": { 
            "authorizationType": "string",
            "awsIamConfig": { 
               "signingRegion": "string",
               "signingServiceName": "string"
            }
         },
         "endpoint": "string"
      },
      "lambdaConfig": { 
         "lambdaFunctionArn": "string"
      },
      "metricsConfig": "string",
      "name": "string",
      "openSearchServiceConfig": { 
         "awsRegion": "string",
         "endpoint": "string"
      },
      "relationalDatabaseConfig": { 
         "rdsHttpEndpointConfig": { 
            "awsRegion": "string",
            "awsSecretStoreArn": "string",
            "databaseName": "string",
            "dbClusterIdentifier": "string",
            "schema": "string"
         },
         "relationalDatabaseSourceType": "string"
      },
      "serviceRoleArn": "string",
      "type": "string"
   }
}
```

## Response Elements
<a name="API_GetDataSource_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.

 ** [dataSource](#API_GetDataSource_ResponseSyntax) **   <a name="appsync-GetDataSource-response-dataSource"></a>
The `DataSource` object.  
Type: [DataSource](API_DataSource.md) object

## Errors
<a name="API_GetDataSource_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_GetDataSource_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/GetDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetDataSource) 

# GetDataSourceIntrospection
<a name="API_GetDataSourceIntrospection"></a>

Retrieves the record of an existing introspection. If the retrieval is successful, the result of the instrospection will also be returned. If the retrieval fails the operation, an error message will be returned instead.

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

```
GET /v1/datasources/introspections/introspectionId?includeModelsSDL=includeModelsSDL&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [includeModelsSDL](#API_GetDataSourceIntrospection_RequestSyntax) **   <a name="appsync-GetDataSourceIntrospection-request-uri-includeModelsSDL"></a>
A boolean flag that determines whether SDL should be generated for introspected types. If set to `true`, each model will contain an `sdl` property that contains the SDL for that type. The SDL only contains the type data and no additional metadata or directives. 

 ** [introspectionId](#API_GetDataSourceIntrospection_RequestSyntax) **   <a name="appsync-GetDataSourceIntrospection-request-uri-introspectionId"></a>
The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.  
Required: Yes

 ** [maxResults](#API_GetDataSourceIntrospection_RequestSyntax) **   <a name="appsync-GetDataSourceIntrospection-request-uri-maxResults"></a>
The maximum number of introspected types that will be returned in a single response.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_GetDataSourceIntrospection_RequestSyntax) **   <a name="appsync-GetDataSourceIntrospection-request-uri-nextToken"></a>
Determines the number of types to be returned in a single response before paginating. This value is typically taken from `nextToken` value from the previous response.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[\S]+` 

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

The request does not have a request body.

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

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

{
   "introspectionId": "string",
   "introspectionResult": { 
      "models": [ 
         { 
            "fields": [ 
               { 
                  "length": number,
                  "name": "string",
                  "type": { 
                     "kind": "string",
                     "name": "string",
                     "type": "DataSourceIntrospectionModelFieldType",
                     "values": [ "string" ]
                  }
               }
            ],
            "indexes": [ 
               { 
                  "fields": [ "string" ],
                  "name": "string"
               }
            ],
            "name": "string",
            "primaryKey": { 
               "fields": [ "string" ],
               "name": "string"
            },
            "sdl": "string"
         }
      ],
      "nextToken": "string"
   },
   "introspectionStatus": "string",
   "introspectionStatusDetail": "string"
}
```

## Response Elements
<a name="API_GetDataSourceIntrospection_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.

 ** [introspectionId](#API_GetDataSourceIntrospection_ResponseSyntax) **   <a name="appsync-GetDataSourceIntrospection-response-introspectionId"></a>
The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.  
Type: String

 ** [introspectionResult](#API_GetDataSourceIntrospection_ResponseSyntax) **   <a name="appsync-GetDataSourceIntrospection-response-introspectionResult"></a>
The `DataSourceIntrospectionResult` object data.  
Type: [DataSourceIntrospectionResult](API_DataSourceIntrospectionResult.md) object

 ** [introspectionStatus](#API_GetDataSourceIntrospection_ResponseSyntax) **   <a name="appsync-GetDataSourceIntrospection-response-introspectionStatus"></a>
The status of the introspection during retrieval. By default, when a new instrospection is being retrieved, the status will be set to `PROCESSING`. Once the operation has been completed, the status will change to `SUCCESS` or `FAILED` depending on how the data was parsed. A `FAILED` operation will return an error and its details as an `introspectionStatusDetail`.  
Type: String  
Valid Values: `PROCESSING | FAILED | SUCCESS` 

 ** [introspectionStatusDetail](#API_GetDataSourceIntrospection_ResponseSyntax) **   <a name="appsync-GetDataSourceIntrospection-response-introspectionStatusDetail"></a>
The error detail field. When a `FAILED` `introspectionStatus` is returned, the `introspectionStatusDetail` will also return the exact error that was generated during the operation.  
Type: String

## Errors
<a name="API_GetDataSourceIntrospection_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

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

## See Also
<a name="API_GetDataSourceIntrospection_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/GetDataSourceIntrospection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetDataSourceIntrospection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetDataSourceIntrospection) 

# GetDomainName
<a name="API_GetDomainName"></a>

Retrieves a custom `DomainName` object.

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

```
GET /v1/domainnames/domainName HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [domainName](#API_GetDomainName_RequestSyntax) **   <a name="appsync-GetDomainName-request-uri-domainName"></a>
The domain name.  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$`   
Required: Yes

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

The request does not have a request body.

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

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

{
   "domainNameConfig": { 
      "appsyncDomainName": "string",
      "certificateArn": "string",
      "description": "string",
      "domainName": "string",
      "domainNameArn": "string",
      "hostedZoneId": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_GetDomainName_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.

 ** [domainNameConfig](#API_GetDomainName_ResponseSyntax) **   <a name="appsync-GetDomainName-response-domainNameConfig"></a>
The configuration for the `DomainName`.  
Type: [DomainNameConfig](API_DomainNameConfig.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

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

## See Also
<a name="API_GetDomainName_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/GetDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetDomainName) 

# GetFunction
<a name="API_GetFunction"></a>

Get a `Function`.

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

```
GET /v1/apis/apiId/functions/functionId HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [functionId](#API_GetFunction_RequestSyntax) **   <a name="appsync-GetFunction-request-uri-functionId"></a>
The `Function` ID.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request does not have a request body.

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

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

{
   "functionConfiguration": { 
      "code": "string",
      "dataSourceName": "string",
      "description": "string",
      "functionArn": "string",
      "functionId": "string",
      "functionVersion": "string",
      "maxBatchSize": number,
      "name": "string",
      "requestMappingTemplate": "string",
      "responseMappingTemplate": "string",
      "runtime": { 
         "name": "string",
         "runtimeVersion": "string"
      },
      "syncConfig": { 
         "conflictDetection": "string",
         "conflictHandler": "string",
         "lambdaConflictHandlerConfig": { 
            "lambdaConflictHandlerArn": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_GetFunction_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.

 ** [functionConfiguration](#API_GetFunction_ResponseSyntax) **   <a name="appsync-GetFunction-response-functionConfiguration"></a>
The `Function` object.  
Type: [FunctionConfiguration](API_FunctionConfiguration.md) object

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

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

 ** ConcurrentModificationException **   
Another modification is in progress at this time and it must complete before you can make your change.  
HTTP Status Code: 409

 ** 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_GetFunction_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/GetFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetFunction) 

# GetGraphqlApi
<a name="API_GetGraphqlApi"></a>

Retrieves a `GraphqlApi` object.

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

```
GET /v1/apis/apiId HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiId](#API_GetGraphqlApi_RequestSyntax) **   <a name="appsync-GetGraphqlApi-request-uri-apiId"></a>
The API ID for the GraphQL API.  
Required: Yes

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

The request does not have a request body.

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

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

{
   "graphqlApi": { 
      "additionalAuthenticationProviders": [ 
         { 
            "authenticationType": "string",
            "lambdaAuthorizerConfig": { 
               "authorizerResultTtlInSeconds": number,
               "authorizerUri": "string",
               "identityValidationExpression": "string"
            },
            "openIDConnectConfig": { 
               "authTTL": number,
               "clientId": "string",
               "iatTTL": number,
               "issuer": "string"
            },
            "userPoolConfig": { 
               "appIdClientRegex": "string",
               "awsRegion": "string",
               "userPoolId": "string"
            }
         }
      ],
      "apiId": "string",
      "apiType": "string",
      "arn": "string",
      "authenticationType": "string",
      "dns": { 
         "string" : "string" 
      },
      "enhancedMetricsConfig": { 
         "dataSourceLevelMetricsBehavior": "string",
         "operationLevelMetricsConfig": "string",
         "resolverLevelMetricsBehavior": "string"
      },
      "introspectionConfig": "string",
      "lambdaAuthorizerConfig": { 
         "authorizerResultTtlInSeconds": number,
         "authorizerUri": "string",
         "identityValidationExpression": "string"
      },
      "logConfig": { 
         "cloudWatchLogsRoleArn": "string",
         "excludeVerboseContent": boolean,
         "fieldLogLevel": "string"
      },
      "mergedApiExecutionRoleArn": "string",
      "name": "string",
      "openIDConnectConfig": { 
         "authTTL": number,
         "clientId": "string",
         "iatTTL": number,
         "issuer": "string"
      },
      "owner": "string",
      "ownerContact": "string",
      "queryDepthLimit": number,
      "resolverCountLimit": number,
      "tags": { 
         "string" : "string" 
      },
      "uris": { 
         "string" : "string" 
      },
      "userPoolConfig": { 
         "appIdClientRegex": "string",
         "awsRegion": "string",
         "defaultAction": "string",
         "userPoolId": "string"
      },
      "visibility": "string",
      "wafWebAclArn": "string",
      "xrayEnabled": boolean
   }
}
```

## Response Elements
<a name="API_GetGraphqlApi_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.

 ** [graphqlApi](#API_GetGraphqlApi_ResponseSyntax) **   <a name="appsync-GetGraphqlApi-response-graphqlApi"></a>
The `GraphqlApi` object.  
Type: [GraphqlApi](API_GraphqlApi.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** 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_GetGraphqlApi_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/GetGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetGraphqlApi) 

# GetGraphqlApiEnvironmentVariables
<a name="API_GetGraphqlApiEnvironmentVariables"></a>

Retrieves the list of environmental variable key-value pairs associated with an API by its ID value.

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

```
GET /v1/apis/apiId/environmentVariables HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiId](#API_GetGraphqlApiEnvironmentVariables_RequestSyntax) **   <a name="appsync-GetGraphqlApiEnvironmentVariables-request-uri-apiId"></a>
The ID of the API from which the environmental variable list will be retrieved.  
Required: Yes

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

The request does not have a request body.

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

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

{
   "environmentVariables": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetGraphqlApiEnvironmentVariables_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.

 ** [environmentVariables](#API_GetGraphqlApiEnvironmentVariables_ResponseSyntax) **   <a name="appsync-GetGraphqlApiEnvironmentVariables-response-environmentVariables"></a>
The payload containing each environmental variable in the `"key" : "value"` format.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 2. Maximum length of 64.  
Key Pattern: `^[A-Za-z]+\w*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 512.

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** 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_GetGraphqlApiEnvironmentVariables_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/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetGraphqlApiEnvironmentVariables) 

# GetIntrospectionSchema
<a name="API_GetIntrospectionSchema"></a>

Retrieves the introspection schema for a GraphQL API.

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

```
GET /v1/apis/apiId/schema?format=format&includeDirectives=includeDirectives HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [format](#API_GetIntrospectionSchema_RequestSyntax) **   <a name="appsync-GetIntrospectionSchema-request-uri-format"></a>
The schema format: SDL or JSON.  
Valid Values: `SDL | JSON`   
Required: Yes

 ** [includeDirectives](#API_GetIntrospectionSchema_RequestSyntax) **   <a name="appsync-GetIntrospectionSchema-request-uri-includeDirectives"></a>
A flag that specifies whether the schema introspection should contain directives.

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

The request does not have a request body.

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

```
HTTP/1.1 200

schema
```

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

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

The response returns the following as the HTTP body.

 ** [schema](#API_GetIntrospectionSchema_ResponseSyntax) **   <a name="appsync-GetIntrospectionSchema-response-schema"></a>
The schema, in GraphQL Schema Definition Language (SDL) format.  
For more information, see the [GraphQL SDL documentation](http://graphql.org/learn/schema/).

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

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

 ** GraphQLSchemaException **   
The GraphQL schema is not valid.  
HTTP Status Code: 400

 ** 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_GetIntrospectionSchema_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/GetIntrospectionSchema) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetIntrospectionSchema) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetIntrospectionSchema) 

# GetResolver
<a name="API_GetResolver"></a>

Retrieves a `Resolver` object.

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

```
GET /v1/apis/apiId/types/typeName/resolvers/fieldName HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [fieldName](#API_GetResolver_RequestSyntax) **   <a name="appsync-GetResolver-request-uri-fieldName"></a>
The resolver field name.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [typeName](#API_GetResolver_RequestSyntax) **   <a name="appsync-GetResolver-request-uri-typeName"></a>
The resolver type name.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request does not have a request body.

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

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

{
   "resolver": { 
      "cachingConfig": { 
         "cachingKeys": [ "string" ],
         "ttl": number
      },
      "code": "string",
      "dataSourceName": "string",
      "fieldName": "string",
      "kind": "string",
      "maxBatchSize": number,
      "metricsConfig": "string",
      "pipelineConfig": { 
         "functions": [ "string" ]
      },
      "requestMappingTemplate": "string",
      "resolverArn": "string",
      "responseMappingTemplate": "string",
      "runtime": { 
         "name": "string",
         "runtimeVersion": "string"
      },
      "syncConfig": { 
         "conflictDetection": "string",
         "conflictHandler": "string",
         "lambdaConflictHandlerConfig": { 
            "lambdaConflictHandlerArn": "string"
         }
      },
      "typeName": "string"
   }
}
```

## Response Elements
<a name="API_GetResolver_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.

 ** [resolver](#API_GetResolver_ResponseSyntax) **   <a name="appsync-GetResolver-response-resolver"></a>
The `Resolver` object.  
Type: [Resolver](API_Resolver.md) object

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

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

 ** ConcurrentModificationException **   
Another modification is in progress at this time and it must complete before you can make your change.  
HTTP Status Code: 409

 ** 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_GetResolver_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/GetResolver) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetResolver) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetResolver) 

# GetSchemaCreationStatus
<a name="API_GetSchemaCreationStatus"></a>

Retrieves the current status of a schema creation operation.

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

```
GET /v1/apis/apiId/schemacreation HTTP/1.1
```

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

The request uses the following URI parameters.

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

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

The request does not have a request body.

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

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

{
   "details": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_GetSchemaCreationStatus_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.

 ** [details](#API_GetSchemaCreationStatus_ResponseSyntax) **   <a name="appsync-GetSchemaCreationStatus-response-details"></a>
Detailed information about the status of the schema creation operation.  
Type: String

 ** [status](#API_GetSchemaCreationStatus_ResponseSyntax) **   <a name="appsync-GetSchemaCreationStatus-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_GetSchemaCreationStatus_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

 ** 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_GetSchemaCreationStatus_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/GetSchemaCreationStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetSchemaCreationStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetSchemaCreationStatus) 

# GetSourceApiAssociation
<a name="API_GetSourceApiAssociation"></a>

Retrieves a `SourceApiAssociation` object.

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

```
GET /v1/mergedApis/mergedApiIdentifier/sourceApiAssociations/associationId HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [associationId](#API_GetSourceApiAssociation_RequestSyntax) **   <a name="appsync-GetSourceApiAssociation-request-uri-associationId"></a>
The ID generated by the AppSync service for the source API association.  
Required: Yes

 ** [mergedApiIdentifier](#API_GetSourceApiAssociation_RequestSyntax) **   <a name="appsync-GetSourceApiAssociation-request-uri-mergedApiIdentifier"></a>
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

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

The request does not have a request body.

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

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

{
   "sourceApiAssociation": { 
      "associationArn": "string",
      "associationId": "string",
      "description": "string",
      "lastSuccessfulMergeDate": number,
      "mergedApiArn": "string",
      "mergedApiId": "string",
      "sourceApiArn": "string",
      "sourceApiAssociationConfig": { 
         "mergeType": "string"
      },
      "sourceApiAssociationStatus": "string",
      "sourceApiAssociationStatusDetail": "string",
      "sourceApiId": "string"
   }
}
```

## Response Elements
<a name="API_GetSourceApiAssociation_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.

 ** [sourceApiAssociation](#API_GetSourceApiAssociation_ResponseSyntax) **   <a name="appsync-GetSourceApiAssociation-response-sourceApiAssociation"></a>
The `SourceApiAssociation` object data.  
Type: [SourceApiAssociation](API_SourceApiAssociation.md) object

## Errors
<a name="API_GetSourceApiAssociation_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

 ** 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_GetSourceApiAssociation_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/GetSourceApiAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetSourceApiAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetSourceApiAssociation) 

# GetType
<a name="API_GetType"></a>

Retrieves a `Type` object.

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

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

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

The request uses the following URI parameters.

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

 ** [format](#API_GetType_RequestSyntax) **   <a name="appsync-GetType-request-uri-format"></a>
The type format: SDL or JSON.  
Valid Values: `SDL | JSON`   
Required: Yes

 ** [typeName](#API_GetType_RequestSyntax) **   <a name="appsync-GetType-request-uri-typeName"></a>
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
<a name="API_GetType_RequestBody"></a>

The request does not have a request body.

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

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

{
   "type": { 
      "arn": "string",
      "definition": "string",
      "description": "string",
      "format": "string",
      "name": "string"
   }
}
```

## Response Elements
<a name="API_GetType_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.

 ** [type](#API_GetType_ResponseSyntax) **   <a name="appsync-GetType-response-type"></a>
The `Type` object.  
Type: [Type](API_Type.md) object

## Errors
<a name="API_GetType_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_GetType_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/GetType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/GetType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/GetType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/GetType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/GetType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/GetType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/GetType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/GetType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/GetType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/GetType) 

# ListApiKeys
<a name="API_ListApiKeys"></a>

Lists the API keys for a given API.

**Note**  
API keys are deleted automatically 60 days after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call `DeleteApiKey` to manually delete a key before it's automatically deleted.

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

```
GET /v1/apis/apiId/apikeys?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [maxResults](#API_ListApiKeys_RequestSyntax) **   <a name="appsync-ListApiKeys-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListApiKeys_RequestSyntax) **   <a name="appsync-ListApiKeys-request-uri-nextToken"></a>
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
<a name="API_ListApiKeys_RequestBody"></a>

The request does not have a request body.

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

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

{
   "apiKeys": [ 
      { 
         "deletes": number,
         "description": "string",
         "expires": number,
         "id": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListApiKeys_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.

 ** [apiKeys](#API_ListApiKeys_ResponseSyntax) **   <a name="appsync-ListApiKeys-response-apiKeys"></a>
The `ApiKey` objects.  
Type: Array of [ApiKey](API_ApiKey.md) objects

 ** [nextToken](#API_ListApiKeys_ResponseSyntax) **   <a name="appsync-ListApiKeys-response-nextToken"></a>
An identifier to pass in the next request to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[\S]+` 

## Errors
<a name="API_ListApiKeys_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

 ** 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_ListApiKeys_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/ListApiKeys) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListApiKeys) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListApiKeys) 

# ListApis
<a name="API_ListApis"></a>

Lists the APIs in your AWS AppSync account.

 `ListApis` returns only the high level API details. For more detailed information about an API, use `GetApi`.

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

```
GET /v2/apis?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [maxResults](#API_ListApis_RequestSyntax) **   <a name="appsync-ListApis-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListApis_RequestSyntax) **   <a name="appsync-ListApis-request-uri-nextToken"></a>
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
<a name="API_ListApis_RequestBody"></a>

The request does not have a request body.

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

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

{
   "apis": [ 
      { 
         "apiArn": "string",
         "apiId": "string",
         "created": number,
         "dns": { 
            "string" : "string" 
         },
         "eventConfig": { 
            "authProviders": [ 
               { 
                  "authType": "string",
                  "cognitoConfig": { 
                     "appIdClientRegex": "string",
                     "awsRegion": "string",
                     "userPoolId": "string"
                  },
                  "lambdaAuthorizerConfig": { 
                     "authorizerResultTtlInSeconds": number,
                     "authorizerUri": "string",
                     "identityValidationExpression": "string"
                  },
                  "openIDConnectConfig": { 
                     "authTTL": number,
                     "clientId": "string",
                     "iatTTL": number,
                     "issuer": "string"
                  }
               }
            ],
            "connectionAuthModes": [ 
               { 
                  "authType": "string"
               }
            ],
            "defaultPublishAuthModes": [ 
               { 
                  "authType": "string"
               }
            ],
            "defaultSubscribeAuthModes": [ 
               { 
                  "authType": "string"
               }
            ],
            "logConfig": { 
               "cloudWatchLogsRoleArn": "string",
               "logLevel": "string"
            }
         },
         "name": "string",
         "ownerContact": "string",
         "tags": { 
            "string" : "string" 
         },
         "wafWebAclArn": "string",
         "xrayEnabled": boolean
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListApis_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.

 ** [apis](#API_ListApis_ResponseSyntax) **   <a name="appsync-ListApis-response-apis"></a>
The `Api` objects.  
Type: Array of [Api](API_Api.md) objects

 ** [nextToken](#API_ListApis_ResponseSyntax) **   <a name="appsync-ListApis-response-nextToken"></a>
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]+` 

## Errors
<a name="API_ListApis_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

 ** InternalFailureException **   
An internal AWS AppSync error occurred. Try your request again.  
HTTP Status Code: 500

 ** UnauthorizedException **   
You aren't authorized to perform this operation.  
HTTP Status Code: 401

## See Also
<a name="API_ListApis_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/ListApis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListApis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListApis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListApis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListApis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListApis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListApis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListApis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListApis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListApis) 

# ListChannelNamespaces
<a name="API_ListChannelNamespaces"></a>

Lists the channel namespaces for a specified `Api`.

 `ListChannelNamespaces` returns only high level details for the channel namespace. To retrieve code handlers, use `GetChannelNamespace`.

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

```
GET /v2/apis/apiId/channelNamespaces?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiId](#API_ListChannelNamespaces_RequestSyntax) **   <a name="appsync-ListChannelNamespaces-request-uri-apiId"></a>
The `Api` ID.  
Required: Yes

 ** [maxResults](#API_ListChannelNamespaces_RequestSyntax) **   <a name="appsync-ListChannelNamespaces-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListChannelNamespaces_RequestSyntax) **   <a name="appsync-ListChannelNamespaces-request-uri-nextToken"></a>
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
<a name="API_ListChannelNamespaces_RequestBody"></a>

The request does not have a request body.

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

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

{
   "channelNamespaces": [ 
      { 
         "apiId": "string",
         "channelNamespaceArn": "string",
         "codeHandlers": "string",
         "created": number,
         "handlerConfigs": { 
            "onPublish": { 
               "behavior": "string",
               "integration": { 
                  "dataSourceName": "string",
                  "lambdaConfig": { 
                     "invokeType": "string"
                  }
               }
            },
            "onSubscribe": { 
               "behavior": "string",
               "integration": { 
                  "dataSourceName": "string",
                  "lambdaConfig": { 
                     "invokeType": "string"
                  }
               }
            }
         },
         "lastModified": number,
         "name": "string",
         "publishAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "subscribeAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListChannelNamespaces_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.

 ** [channelNamespaces](#API_ListChannelNamespaces_ResponseSyntax) **   <a name="appsync-ListChannelNamespaces-response-channelNamespaces"></a>
The `ChannelNamespace` objects.  
Type: Array of [ChannelNamespace](API_ChannelNamespace.md) objects

 ** [nextToken](#API_ListChannelNamespaces_ResponseSyntax) **   <a name="appsync-ListChannelNamespaces-response-nextToken"></a>
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]+` 

## Errors
<a name="API_ListChannelNamespaces_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

 ** 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_ListChannelNamespaces_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/ListChannelNamespaces) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListChannelNamespaces) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListChannelNamespaces) 

# ListDataSources
<a name="API_ListDataSources"></a>

Lists the data sources for a given API.

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

```
GET /v1/apis/apiId/datasources?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [maxResults](#API_ListDataSources_RequestSyntax) **   <a name="appsync-ListDataSources-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListDataSources_RequestSyntax) **   <a name="appsync-ListDataSources-request-uri-nextToken"></a>
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
<a name="API_ListDataSources_RequestBody"></a>

The request does not have a request body.

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

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

{
   "dataSources": [ 
      { 
         "dataSourceArn": "string",
         "description": "string",
         "dynamodbConfig": { 
            "awsRegion": "string",
            "deltaSyncConfig": { 
               "baseTableTTL": number,
               "deltaSyncTableName": "string",
               "deltaSyncTableTTL": number
            },
            "tableName": "string",
            "useCallerCredentials": boolean,
            "versioned": boolean
         },
         "elasticsearchConfig": { 
            "awsRegion": "string",
            "endpoint": "string"
         },
         "eventBridgeConfig": { 
            "eventBusArn": "string"
         },
         "httpConfig": { 
            "authorizationConfig": { 
               "authorizationType": "string",
               "awsIamConfig": { 
                  "signingRegion": "string",
                  "signingServiceName": "string"
               }
            },
            "endpoint": "string"
         },
         "lambdaConfig": { 
            "lambdaFunctionArn": "string"
         },
         "metricsConfig": "string",
         "name": "string",
         "openSearchServiceConfig": { 
            "awsRegion": "string",
            "endpoint": "string"
         },
         "relationalDatabaseConfig": { 
            "rdsHttpEndpointConfig": { 
               "awsRegion": "string",
               "awsSecretStoreArn": "string",
               "databaseName": "string",
               "dbClusterIdentifier": "string",
               "schema": "string"
            },
            "relationalDatabaseSourceType": "string"
         },
         "serviceRoleArn": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataSources_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.

 ** [dataSources](#API_ListDataSources_ResponseSyntax) **   <a name="appsync-ListDataSources-response-dataSources"></a>
The `DataSource` objects.  
Type: Array of [DataSource](API_DataSource.md) objects

 ** [nextToken](#API_ListDataSources_ResponseSyntax) **   <a name="appsync-ListDataSources-response-nextToken"></a>
An identifier to pass in the next request to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[\S]+` 

## Errors
<a name="API_ListDataSources_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

 ** 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_ListDataSources_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/ListDataSources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListDataSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListDataSources) 

# ListDomainNames
<a name="API_ListDomainNames"></a>

Lists multiple custom domain names.

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

```
GET /v1/domainnames?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [maxResults](#API_ListDomainNames_RequestSyntax) **   <a name="appsync-ListDomainNames-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListDomainNames_RequestSyntax) **   <a name="appsync-ListDomainNames-request-uri-nextToken"></a>
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
<a name="API_ListDomainNames_RequestBody"></a>

The request does not have a request body.

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

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

{
   "domainNameConfigs": [ 
      { 
         "appsyncDomainName": "string",
         "certificateArn": "string",
         "description": "string",
         "domainName": "string",
         "domainNameArn": "string",
         "hostedZoneId": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDomainNames_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.

 ** [domainNameConfigs](#API_ListDomainNames_ResponseSyntax) **   <a name="appsync-ListDomainNames-response-domainNameConfigs"></a>
Lists configurations for multiple domain names.  
Type: Array of [DomainNameConfig](API_DomainNameConfig.md) objects

 ** [nextToken](#API_ListDomainNames_ResponseSyntax) **   <a name="appsync-ListDomainNames-response-nextToken"></a>
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]+` 

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

 ** InternalFailureException **   
An internal AWS AppSync error occurred. Try your request again.  
HTTP Status Code: 500

## See Also
<a name="API_ListDomainNames_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/ListDomainNames) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListDomainNames) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListDomainNames) 

# ListFunctions
<a name="API_ListFunctions"></a>

List multiple functions.

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

```
GET /v1/apis/apiId/functions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [maxResults](#API_ListFunctions_RequestSyntax) **   <a name="appsync-ListFunctions-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListFunctions_RequestSyntax) **   <a name="appsync-ListFunctions-request-uri-nextToken"></a>
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
<a name="API_ListFunctions_RequestBody"></a>

The request does not have a request body.

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

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

{
   "functions": [ 
      { 
         "code": "string",
         "dataSourceName": "string",
         "description": "string",
         "functionArn": "string",
         "functionId": "string",
         "functionVersion": "string",
         "maxBatchSize": number,
         "name": "string",
         "requestMappingTemplate": "string",
         "responseMappingTemplate": "string",
         "runtime": { 
            "name": "string",
            "runtimeVersion": "string"
         },
         "syncConfig": { 
            "conflictDetection": "string",
            "conflictHandler": "string",
            "lambdaConflictHandlerConfig": { 
               "lambdaConflictHandlerArn": "string"
            }
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListFunctions_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.

 ** [functions](#API_ListFunctions_ResponseSyntax) **   <a name="appsync-ListFunctions-response-functions"></a>
A list of `Function` objects.  
Type: Array of [FunctionConfiguration](API_FunctionConfiguration.md) objects

 ** [nextToken](#API_ListFunctions_ResponseSyntax) **   <a name="appsync-ListFunctions-response-nextToken"></a>
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]+` 

## Errors
<a name="API_ListFunctions_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

 ** 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_ListFunctions_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/ListFunctions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListFunctions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListFunctions) 

# ListGraphqlApis
<a name="API_ListGraphqlApis"></a>

Lists your GraphQL APIs.

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

```
GET /v1/apis?apiType=apiType&maxResults=maxResults&nextToken=nextToken&owner=owner HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [apiType](#API_ListGraphqlApis_RequestSyntax) **   <a name="appsync-ListGraphqlApis-request-uri-apiType"></a>
The value that indicates whether the GraphQL API is a standard API (`GRAPHQL`) or merged API (`MERGED`).  
Valid Values: `GRAPHQL | MERGED` 

 ** [maxResults](#API_ListGraphqlApis_RequestSyntax) **   <a name="appsync-ListGraphqlApis-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListGraphqlApis_RequestSyntax) **   <a name="appsync-ListGraphqlApis-request-uri-nextToken"></a>
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]+` 

 ** [owner](#API_ListGraphqlApis_RequestSyntax) **   <a name="appsync-ListGraphqlApis-request-uri-owner"></a>
The account owner of the GraphQL API.  
Valid Values: `CURRENT_ACCOUNT | OTHER_ACCOUNTS` 

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

The request does not have a request body.

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

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

{
   "graphqlApis": [ 
      { 
         "additionalAuthenticationProviders": [ 
            { 
               "authenticationType": "string",
               "lambdaAuthorizerConfig": { 
                  "authorizerResultTtlInSeconds": number,
                  "authorizerUri": "string",
                  "identityValidationExpression": "string"
               },
               "openIDConnectConfig": { 
                  "authTTL": number,
                  "clientId": "string",
                  "iatTTL": number,
                  "issuer": "string"
               },
               "userPoolConfig": { 
                  "appIdClientRegex": "string",
                  "awsRegion": "string",
                  "userPoolId": "string"
               }
            }
         ],
         "apiId": "string",
         "apiType": "string",
         "arn": "string",
         "authenticationType": "string",
         "dns": { 
            "string" : "string" 
         },
         "enhancedMetricsConfig": { 
            "dataSourceLevelMetricsBehavior": "string",
            "operationLevelMetricsConfig": "string",
            "resolverLevelMetricsBehavior": "string"
         },
         "introspectionConfig": "string",
         "lambdaAuthorizerConfig": { 
            "authorizerResultTtlInSeconds": number,
            "authorizerUri": "string",
            "identityValidationExpression": "string"
         },
         "logConfig": { 
            "cloudWatchLogsRoleArn": "string",
            "excludeVerboseContent": boolean,
            "fieldLogLevel": "string"
         },
         "mergedApiExecutionRoleArn": "string",
         "name": "string",
         "openIDConnectConfig": { 
            "authTTL": number,
            "clientId": "string",
            "iatTTL": number,
            "issuer": "string"
         },
         "owner": "string",
         "ownerContact": "string",
         "queryDepthLimit": number,
         "resolverCountLimit": number,
         "tags": { 
            "string" : "string" 
         },
         "uris": { 
            "string" : "string" 
         },
         "userPoolConfig": { 
            "appIdClientRegex": "string",
            "awsRegion": "string",
            "defaultAction": "string",
            "userPoolId": "string"
         },
         "visibility": "string",
         "wafWebAclArn": "string",
         "xrayEnabled": boolean
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListGraphqlApis_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.

 ** [graphqlApis](#API_ListGraphqlApis_ResponseSyntax) **   <a name="appsync-ListGraphqlApis-response-graphqlApis"></a>
The `GraphqlApi` objects.  
Type: Array of [GraphqlApi](API_GraphqlApi.md) objects

 ** [nextToken](#API_ListGraphqlApis_ResponseSyntax) **   <a name="appsync-ListGraphqlApis-response-nextToken"></a>
An identifier to pass in the next request to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[\S]+` 

## Errors
<a name="API_ListGraphqlApis_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

 ** InternalFailureException **   
An internal AWS AppSync error occurred. Try your request again.  
HTTP Status Code: 500

 ** UnauthorizedException **   
You aren't authorized to perform this operation.  
HTTP Status Code: 401

## See Also
<a name="API_ListGraphqlApis_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/ListGraphqlApis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListGraphqlApis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListGraphqlApis) 

# ListResolvers
<a name="API_ListResolvers"></a>

Lists the resolvers for a given API and type.

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

```
GET /v1/apis/apiId/types/typeName/resolvers?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [maxResults](#API_ListResolvers_RequestSyntax) **   <a name="appsync-ListResolvers-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListResolvers_RequestSyntax) **   <a name="appsync-ListResolvers-request-uri-nextToken"></a>
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]+` 

 ** [typeName](#API_ListResolvers_RequestSyntax) **   <a name="appsync-ListResolvers-request-uri-typeName"></a>
The type name.  
Required: Yes

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

The request does not have a request body.

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

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

{
   "nextToken": "string",
   "resolvers": [ 
      { 
         "cachingConfig": { 
            "cachingKeys": [ "string" ],
            "ttl": number
         },
         "code": "string",
         "dataSourceName": "string",
         "fieldName": "string",
         "kind": "string",
         "maxBatchSize": number,
         "metricsConfig": "string",
         "pipelineConfig": { 
            "functions": [ "string" ]
         },
         "requestMappingTemplate": "string",
         "resolverArn": "string",
         "responseMappingTemplate": "string",
         "runtime": { 
            "name": "string",
            "runtimeVersion": "string"
         },
         "syncConfig": { 
            "conflictDetection": "string",
            "conflictHandler": "string",
            "lambdaConflictHandlerConfig": { 
               "lambdaConflictHandlerArn": "string"
            }
         },
         "typeName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListResolvers_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.

 ** [nextToken](#API_ListResolvers_ResponseSyntax) **   <a name="appsync-ListResolvers-response-nextToken"></a>
An identifier to pass in the next request to this operation to return the next set of items in the list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[\S]+` 

 ** [resolvers](#API_ListResolvers_ResponseSyntax) **   <a name="appsync-ListResolvers-response-resolvers"></a>
The `Resolver` objects.  
Type: Array of [Resolver](API_Resolver.md) objects

## Errors
<a name="API_ListResolvers_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

 ** 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_ListResolvers_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/ListResolvers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListResolvers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListResolvers) 

# ListResolversByFunction
<a name="API_ListResolversByFunction"></a>

List the resolvers that are associated with a specific function.

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

```
GET /v1/apis/apiId/functions/functionId/resolvers?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [functionId](#API_ListResolversByFunction_RequestSyntax) **   <a name="appsync-ListResolversByFunction-request-uri-functionId"></a>
The function ID.  
Required: Yes

 ** [maxResults](#API_ListResolversByFunction_RequestSyntax) **   <a name="appsync-ListResolversByFunction-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListResolversByFunction_RequestSyntax) **   <a name="appsync-ListResolversByFunction-request-uri-nextToken"></a>
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
<a name="API_ListResolversByFunction_RequestBody"></a>

The request does not have a request body.

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

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

{
   "nextToken": "string",
   "resolvers": [ 
      { 
         "cachingConfig": { 
            "cachingKeys": [ "string" ],
            "ttl": number
         },
         "code": "string",
         "dataSourceName": "string",
         "fieldName": "string",
         "kind": "string",
         "maxBatchSize": number,
         "metricsConfig": "string",
         "pipelineConfig": { 
            "functions": [ "string" ]
         },
         "requestMappingTemplate": "string",
         "resolverArn": "string",
         "responseMappingTemplate": "string",
         "runtime": { 
            "name": "string",
            "runtimeVersion": "string"
         },
         "syncConfig": { 
            "conflictDetection": "string",
            "conflictHandler": "string",
            "lambdaConflictHandlerConfig": { 
               "lambdaConflictHandlerArn": "string"
            }
         },
         "typeName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListResolversByFunction_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.

 ** [nextToken](#API_ListResolversByFunction_ResponseSyntax) **   <a name="appsync-ListResolversByFunction-response-nextToken"></a>
An identifier that 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]+` 

 ** [resolvers](#API_ListResolversByFunction_ResponseSyntax) **   <a name="appsync-ListResolversByFunction-response-resolvers"></a>
The list of resolvers.  
Type: Array of [Resolver](API_Resolver.md) objects

## Errors
<a name="API_ListResolversByFunction_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

 ** 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_ListResolversByFunction_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/ListResolversByFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListResolversByFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListResolversByFunction) 

# ListSourceApiAssociations
<a name="API_ListSourceApiAssociations"></a>

Lists the `SourceApiAssociationSummary` data.

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

```
GET /v1/apis/apiId/sourceApiAssociations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

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

The request uses the following URI parameters.

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

 ** [maxResults](#API_ListSourceApiAssociations_RequestSyntax) **   <a name="appsync-ListSourceApiAssociations-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListSourceApiAssociations_RequestSyntax) **   <a name="appsync-ListSourceApiAssociations-request-uri-nextToken"></a>
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
<a name="API_ListSourceApiAssociations_RequestBody"></a>

The request does not have a request body.

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

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

{
   "nextToken": "string",
   "sourceApiAssociationSummaries": [ 
      { 
         "associationArn": "string",
         "associationId": "string",
         "description": "string",
         "mergedApiArn": "string",
         "mergedApiId": "string",
         "sourceApiArn": "string",
         "sourceApiId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSourceApiAssociations_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.

 ** [nextToken](#API_ListSourceApiAssociations_ResponseSyntax) **   <a name="appsync-ListSourceApiAssociations-response-nextToken"></a>
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]+` 

 ** [sourceApiAssociationSummaries](#API_ListSourceApiAssociations_ResponseSyntax) **   <a name="appsync-ListSourceApiAssociations-response-sourceApiAssociationSummaries"></a>
The `SourceApiAssociationSummary` object data.  
Type: Array of [SourceApiAssociationSummary](API_SourceApiAssociationSummary.md) objects

## Errors
<a name="API_ListSourceApiAssociations_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

 ** 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_ListSourceApiAssociations_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/ListSourceApiAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListSourceApiAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListSourceApiAssociations) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists the tags for a resource.

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

```
GET /v1/tags/resourceArn HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="appsync-ListTagsForResource-request-uri-resourceArn"></a>
The `GraphqlApi` Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 70. Maximum length of 75.  
Pattern: `^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\d{12}:apis/[0-9A-Za-z_-]{26}$`   
Required: Yes

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

The request does not have a request body.

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

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

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_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.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="appsync-ListTagsForResource-response-tags"></a>
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.  
Value Pattern: `^[\s\w+-=\.:/@]*$` 

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

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

 ** 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_ListTagsForResource_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/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListTagsForResource) 

# ListTypes
<a name="API_ListTypes"></a>

Lists the types for a given API.

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

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

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

The request uses the following URI parameters.

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

 ** [format](#API_ListTypes_RequestSyntax) **   <a name="appsync-ListTypes-request-uri-format"></a>
The type format: SDL or JSON.  
Valid Values: `SDL | JSON`   
Required: Yes

 ** [maxResults](#API_ListTypes_RequestSyntax) **   <a name="appsync-ListTypes-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [nextToken](#API_ListTypes_RequestSyntax) **   <a name="appsync-ListTypes-request-uri-nextToken"></a>
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
<a name="API_ListTypes_RequestBody"></a>

The request does not have a request body.

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

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

{
   "nextToken": "string",
   "types": [ 
      { 
         "arn": "string",
         "definition": "string",
         "description": "string",
         "format": "string",
         "name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTypes_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.

 ** [nextToken](#API_ListTypes_ResponseSyntax) **   <a name="appsync-ListTypes-response-nextToken"></a>
An identifier to pass in the next request to this operation 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](#API_ListTypes_ResponseSyntax) **   <a name="appsync-ListTypes-response-types"></a>
The `Type` objects.  
Type: Array of [Type](API_Type.md) objects

## Errors
<a name="API_ListTypes_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_ListTypes_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/ListTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListTypes) 

# ListTypesByAssociation
<a name="API_ListTypesByAssociation"></a>

Lists `Type` objects by the source API association ID.

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

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

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

The request uses the following URI parameters.

 ** [associationId](#API_ListTypesByAssociation_RequestSyntax) **   <a name="appsync-ListTypesByAssociation-request-uri-associationId"></a>
The ID generated by the AppSync service for the source API association.  
Required: Yes

 ** [format](#API_ListTypesByAssociation_RequestSyntax) **   <a name="appsync-ListTypesByAssociation-request-uri-format"></a>
The format type.  
Valid Values: `SDL | JSON`   
Required: Yes

 ** [maxResults](#API_ListTypesByAssociation_RequestSyntax) **   <a name="appsync-ListTypesByAssociation-request-uri-maxResults"></a>
The maximum number of results that you want the request to return.  
Valid Range: Minimum value of 0. Maximum value of 25.

 ** [mergedApiIdentifier](#API_ListTypesByAssociation_RequestSyntax) **   <a name="appsync-ListTypesByAssociation-request-uri-mergedApiIdentifier"></a>
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](#API_ListTypesByAssociation_RequestSyntax) **   <a name="appsync-ListTypesByAssociation-request-uri-nextToken"></a>
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
<a name="API_ListTypesByAssociation_RequestBody"></a>

The request does not have a request body.

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

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

{
   "nextToken": "string",
   "types": [ 
      { 
         "arn": "string",
         "definition": "string",
         "description": "string",
         "format": "string",
         "name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTypesByAssociation_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.

 ** [nextToken](#API_ListTypesByAssociation_ResponseSyntax) **   <a name="appsync-ListTypesByAssociation-response-nextToken"></a>
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](#API_ListTypesByAssociation_ResponseSyntax) **   <a name="appsync-ListTypesByAssociation-response-types"></a>
The `Type` objects.  
Type: Array of [Type](API_Type.md) objects

## Errors
<a name="API_ListTypesByAssociation_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_ListTypesByAssociation_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/ListTypesByAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/ListTypesByAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/ListTypesByAssociation) 

# PutGraphqlApiEnvironmentVariables
<a name="API_PutGraphqlApiEnvironmentVariables"></a>

Creates a list of environmental variables in an API by its ID value. 

When creating an environmental variable, it must follow the constraints below:
+ Both JavaScript and VTL templates support environmental variables.
+ Environmental variables are not evaluated before function invocation.
+ Environmental variables only support string values.
+ Any defined value in an environmental variable is considered a string literal and not expanded.
+ Variable evaluations should ideally be performed in the function code.

When creating an environmental variable key-value pair, it must follow the additional constraints below:
+ Keys must begin with a letter.
+ Keys must be at least two characters long.
+ Keys can only contain letters, numbers, and the underscore character (\$1).
+ Values can be up to 512 characters long.
+ You can configure up to 50 key-value pairs in a GraphQL API.

You can create a list of environmental variables by adding it to the `environmentVariables` payload as a list in the format `{"key1":"value1","key2":"value2", …}`. Note that each call of the `PutGraphqlApiEnvironmentVariables` action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.

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

```
PUT /v1/apis/apiId/environmentVariables HTTP/1.1
Content-type: application/json

{
   "environmentVariables": { 
      "string" : "string" 
   }
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_PutGraphqlApiEnvironmentVariables_RequestSyntax) **   <a name="appsync-PutGraphqlApiEnvironmentVariables-request-uri-apiId"></a>
The ID of the API to which the environmental variable list will be written.  
Required: Yes

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

The request accepts the following data in JSON format.

 ** [environmentVariables](#API_PutGraphqlApiEnvironmentVariables_RequestSyntax) **   <a name="appsync-PutGraphqlApiEnvironmentVariables-request-environmentVariables"></a>
The list of environmental variables to add to the API.  
When creating an environmental variable key-value pair, it must follow the additional constraints below:  
+ Keys must begin with a letter.
+ Keys must be at least two characters long.
+ Keys can only contain letters, numbers, and the underscore character (\$1).
+ Values can be up to 512 characters long.
+ You can configure up to 50 key-value pairs in a GraphQL API.
You can create a list of environmental variables by adding it to the `environmentVariables` payload as a list in the format `{"key1":"value1","key2":"value2", …}`. Note that each call of the `PutGraphqlApiEnvironmentVariables` action will result in the overwriting of the existing environmental variable list of that API. This means the existing environmental variables will be lost. To avoid this, you must include all existing and new environmental variables in the list each time you call this action.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 2. Maximum length of 64.  
Key Pattern: `^[A-Za-z]+\w*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 512.  
Required: Yes

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

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

{
   "environmentVariables": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_PutGraphqlApiEnvironmentVariables_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.

 ** [environmentVariables](#API_PutGraphqlApiEnvironmentVariables_ResponseSyntax) **   <a name="appsync-PutGraphqlApiEnvironmentVariables-response-environmentVariables"></a>
The payload containing each environmental variable in the `"key" : "value"` format.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 2. Maximum length of 64.  
Key Pattern: `^[A-Za-z]+\w*$`   
Value Length Constraints: Minimum length of 0. Maximum length of 512.

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

 ** 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_PutGraphqlApiEnvironmentVariables_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/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/PutGraphqlApiEnvironmentVariables) 

# StartDataSourceIntrospection
<a name="API_StartDataSourceIntrospection"></a>

Creates a new introspection. Returns the `introspectionId` of the new introspection after its creation. 

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

```
POST /v1/datasources/introspections HTTP/1.1
Content-type: application/json

{
   "rdsDataApiConfig": { 
      "databaseName": "string",
      "resourceArn": "string",
      "secretArn": "string"
   }
}
```

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

The request does not use any URI parameters.

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

The request accepts the following data in JSON format.

 ** [rdsDataApiConfig](#API_StartDataSourceIntrospection_RequestSyntax) **   <a name="appsync-StartDataSourceIntrospection-request-rdsDataApiConfig"></a>
The `rdsDataApiConfig` object data.  
Type: [RdsDataApiConfig](API_RdsDataApiConfig.md) object  
Required: No

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

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

{
   "introspectionId": "string",
   "introspectionStatus": "string",
   "introspectionStatusDetail": "string"
}
```

## Response Elements
<a name="API_StartDataSourceIntrospection_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.

 ** [introspectionId](#API_StartDataSourceIntrospection_ResponseSyntax) **   <a name="appsync-StartDataSourceIntrospection-response-introspectionId"></a>
The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.  
Type: String

 ** [introspectionStatus](#API_StartDataSourceIntrospection_ResponseSyntax) **   <a name="appsync-StartDataSourceIntrospection-response-introspectionStatus"></a>
The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to `PROCESSING`. Once the operation has been completed, the status will change to `SUCCESS` or `FAILED` depending on how the data was parsed. A `FAILED` operation will return an error and its details as an `introspectionStatusDetail`.  
Type: String  
Valid Values: `PROCESSING | FAILED | SUCCESS` 

 ** [introspectionStatusDetail](#API_StartDataSourceIntrospection_ResponseSyntax) **   <a name="appsync-StartDataSourceIntrospection-response-introspectionStatusDetail"></a>
The error detail field. When a `FAILED` `introspectionStatus` is returned, the `introspectionStatusDetail` will also return the exact error that was generated during the operation.  
Type: String

## Errors
<a name="API_StartDataSourceIntrospection_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

 ** 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_StartDataSourceIntrospection_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/StartDataSourceIntrospection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/StartDataSourceIntrospection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/StartDataSourceIntrospection) 

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

# StartSchemaMerge
<a name="API_StartSchemaMerge"></a>

Initiates a merge operation. Returns a status that shows the result of the merge operation.

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

```
POST /v1/mergedApis/mergedApiIdentifier/sourceApiAssociations/associationId/merge HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [associationId](#API_StartSchemaMerge_RequestSyntax) **   <a name="appsync-StartSchemaMerge-request-uri-associationId"></a>
The ID generated by the AppSync service for the source API association.  
Required: Yes

 ** [mergedApiIdentifier](#API_StartSchemaMerge_RequestSyntax) **   <a name="appsync-StartSchemaMerge-request-uri-mergedApiIdentifier"></a>
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

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

The request does not have a request body.

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

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

{
   "sourceApiAssociationStatus": "string"
}
```

## Response Elements
<a name="API_StartSchemaMerge_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.

 ** [sourceApiAssociationStatus](#API_StartSchemaMerge_ResponseSyntax) **   <a name="appsync-StartSchemaMerge-response-sourceApiAssociationStatus"></a>
The state of the source API association.  
Type: String  
Valid Values: `MERGE_SCHEDULED | MERGE_FAILED | MERGE_SUCCESS | MERGE_IN_PROGRESS | AUTO_MERGE_SCHEDULE_FAILED | DELETION_SCHEDULED | DELETION_IN_PROGRESS | DELETION_FAILED` 

## Errors
<a name="API_StartSchemaMerge_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_StartSchemaMerge_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/StartSchemaMerge) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/StartSchemaMerge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/StartSchemaMerge) 

# TagResource
<a name="API_TagResource"></a>

Tags a resource with user-supplied tags.

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

```
POST /v1/tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

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

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="appsync-TagResource-request-uri-resourceArn"></a>
The `GraphqlApi` Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 70. Maximum length of 75.  
Pattern: `^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\d{12}:apis/[0-9A-Za-z_-]{26}$`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="appsync-TagResource-request-tags"></a>
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.  
Value Pattern: `^[\s\w+-=\.:/@]*$`   
Required: Yes

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

```
HTTP/1.1 200
```

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

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

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

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

 ** 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_TagResource_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/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Untags a resource.

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

```
DELETE /v1/tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

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

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="appsync-UntagResource-request-uri-resourceArn"></a>
The `GraphqlApi` Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 70. Maximum length of 75.  
Pattern: `^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\d{12}:apis/[0-9A-Za-z_-]{26}$`   
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="appsync-UntagResource-request-uri-tagKeys"></a>
A list of `TagKey` objects.  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[ a-zA-Z+-=._:/]+$`   
Required: Yes

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

The request does not have a request body.

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

```
HTTP/1.1 200
```

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

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

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

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

 ** 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_UntagResource_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/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UntagResource) 

# UpdateApi
<a name="API_UpdateApi"></a>

Updates an `Api`.

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

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

{
   "eventConfig": { 
      "authProviders": [ 
         { 
            "authType": "string",
            "cognitoConfig": { 
               "appIdClientRegex": "string",
               "awsRegion": "string",
               "userPoolId": "string"
            },
            "lambdaAuthorizerConfig": { 
               "authorizerResultTtlInSeconds": number,
               "authorizerUri": "string",
               "identityValidationExpression": "string"
            },
            "openIDConnectConfig": { 
               "authTTL": number,
               "clientId": "string",
               "iatTTL": number,
               "issuer": "string"
            }
         }
      ],
      "connectionAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "defaultPublishAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "defaultSubscribeAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "logConfig": { 
         "cloudWatchLogsRoleArn": "string",
         "logLevel": "string"
      }
   },
   "name": "string",
   "ownerContact": "string"
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_UpdateApi_RequestSyntax) **   <a name="appsync-UpdateApi-request-uri-apiId"></a>
The `Api` ID.  
Required: Yes

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

The request accepts the following data in JSON format.

 ** [eventConfig](#API_UpdateApi_RequestSyntax) **   <a name="appsync-UpdateApi-request-eventConfig"></a>
The new event configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.  
Type: [EventConfig](API_EventConfig.md) object  
Required: No

 ** [name](#API_UpdateApi_RequestSyntax) **   <a name="appsync-UpdateApi-request-name"></a>
The name of the Api.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[A-Za-z0-9_\-\ ]+`   
Required: Yes

 ** [ownerContact](#API_UpdateApi_RequestSyntax) **   <a name="appsync-UpdateApi-request-ownerContact"></a>
The owner contact information for the `Api`.  
Type: String  
Required: No

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

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

{
   "api": { 
      "apiArn": "string",
      "apiId": "string",
      "created": number,
      "dns": { 
         "string" : "string" 
      },
      "eventConfig": { 
         "authProviders": [ 
            { 
               "authType": "string",
               "cognitoConfig": { 
                  "appIdClientRegex": "string",
                  "awsRegion": "string",
                  "userPoolId": "string"
               },
               "lambdaAuthorizerConfig": { 
                  "authorizerResultTtlInSeconds": number,
                  "authorizerUri": "string",
                  "identityValidationExpression": "string"
               },
               "openIDConnectConfig": { 
                  "authTTL": number,
                  "clientId": "string",
                  "iatTTL": number,
                  "issuer": "string"
               }
            }
         ],
         "connectionAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "defaultPublishAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "defaultSubscribeAuthModes": [ 
            { 
               "authType": "string"
            }
         ],
         "logConfig": { 
            "cloudWatchLogsRoleArn": "string",
            "logLevel": "string"
         }
      },
      "name": "string",
      "ownerContact": "string",
      "tags": { 
         "string" : "string" 
      },
      "wafWebAclArn": "string",
      "xrayEnabled": boolean
   }
}
```

## Response Elements
<a name="API_UpdateApi_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.

 ** [api](#API_UpdateApi_ResponseSyntax) **   <a name="appsync-UpdateApi-response-api"></a>
The `Api` object.  
Type: [Api](API_Api.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

 ** 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_UpdateApi_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/UpdateApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateApi) 

# UpdateApiCache
<a name="API_UpdateApiCache"></a>

Updates the cache for the GraphQL API.

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

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

{
   "apiCachingBehavior": "string",
   "healthMetricsConfig": "string",
   "ttl": number,
   "type": "string"
}
```

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

The request uses the following URI parameters.

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

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

The request accepts the following data in JSON format.

 ** [apiCachingBehavior](#API_UpdateApiCache_RequestSyntax) **   <a name="appsync-UpdateApiCache-request-apiCachingBehavior"></a>
Caching behavior.  
+  **FULL\$1REQUEST\$1CACHING**: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
+  **PER\$1RESOLVER\$1CACHING**: Individual resolvers that you specify are cached.
+  **OPERATION\$1LEVEL\$1CACHING**: Full requests are cached together and returned without executing resolvers.
Type: String  
Valid Values: `FULL_REQUEST_CACHING | PER_RESOLVER_CACHING | OPERATION_LEVEL_CACHING`   
Required: Yes

 ** [healthMetricsConfig](#API_UpdateApiCache_RequestSyntax) **   <a name="appsync-UpdateApiCache-request-healthMetricsConfig"></a>
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:  
+ NetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
+ EngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.
Metrics will be recorded by API ID. You can set the value to `ENABLED` or `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [ttl](#API_UpdateApiCache_RequestSyntax) **   <a name="appsync-UpdateApiCache-request-ttl"></a>
TTL in seconds for cache entries.  
Valid values are 1–3,600 seconds.  
Type: Long  
Required: Yes

 ** [type](#API_UpdateApiCache_RequestSyntax) **   <a name="appsync-UpdateApiCache-request-type"></a>
The cache instance type. Valid values are   
+  `SMALL` 
+  `MEDIUM` 
+  `LARGE` 
+  `XLARGE` 
+  `LARGE_2X` 
+  `LARGE_4X` 
+  `LARGE_8X` (not available in all regions)
+  `LARGE_12X` 
Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.  
The following legacy instance types are available, but their use is discouraged:  
+  **T2\$1SMALL**: A t2.small instance type.
+  **T2\$1MEDIUM**: A t2.medium instance type.
+  **R4\$1LARGE**: A r4.large instance type.
+  **R4\$1XLARGE**: A r4.xlarge instance type.
+  **R4\$12XLARGE**: A r4.2xlarge instance type.
+  **R4\$14XLARGE**: A r4.4xlarge instance type.
+  **R4\$18XLARGE**: A r4.8xlarge instance type.
Type: String  
Valid Values: `T2_SMALL | T2_MEDIUM | R4_LARGE | R4_XLARGE | R4_2XLARGE | R4_4XLARGE | R4_8XLARGE | SMALL | MEDIUM | LARGE | XLARGE | LARGE_2X | LARGE_4X | LARGE_8X | LARGE_12X`   
Required: Yes

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

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

{
   "apiCache": { 
      "apiCachingBehavior": "string",
      "atRestEncryptionEnabled": boolean,
      "healthMetricsConfig": "string",
      "status": "string",
      "transitEncryptionEnabled": boolean,
      "ttl": number,
      "type": "string"
   }
}
```

## Response Elements
<a name="API_UpdateApiCache_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.

 ** [apiCache](#API_UpdateApiCache_ResponseSyntax) **   <a name="appsync-UpdateApiCache-response-apiCache"></a>
The `ApiCache` object.  
Type: [ApiCache](API_ApiCache.md) object

## Errors
<a name="API_UpdateApiCache_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_UpdateApiCache_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/UpdateApiCache) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateApiCache) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateApiCache) 

# UpdateApiKey
<a name="API_UpdateApiKey"></a>

Updates an API key. You can update the key as long as it's not deleted.

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

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

{
   "description": "string",
   "expires": number
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_UpdateApiKey_RequestSyntax) **   <a name="appsync-UpdateApiKey-request-uri-apiId"></a>
The ID for the GraphQL API.  
Required: Yes

 ** [id](#API_UpdateApiKey_RequestSyntax) **   <a name="appsync-UpdateApiKey-request-uri-id"></a>
The API key ID.  
Required: Yes

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

The request accepts the following data in JSON format.

 ** [description](#API_UpdateApiKey_RequestSyntax) **   <a name="appsync-UpdateApiKey-request-description"></a>
A description of the purpose of the API key.  
Type: String  
Required: No

 ** [expires](#API_UpdateApiKey_RequestSyntax) **   <a name="appsync-UpdateApiKey-request-expires"></a>
From the update time, the time after which the API key expires. The date is represented as seconds since the epoch. For more information, see [ApiKey](API_ApiKey.md).  
Type: Long  
Required: No

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

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

{
   "apiKey": { 
      "deletes": number,
      "description": "string",
      "expires": number,
      "id": "string"
   }
}
```

## Response Elements
<a name="API_UpdateApiKey_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.

 ** [apiKey](#API_UpdateApiKey_ResponseSyntax) **   <a name="appsync-UpdateApiKey-response-apiKey"></a>
The API key.  
Type: [ApiKey](API_ApiKey.md) object

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

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

 ** ApiKeyValidityOutOfBoundsException **   
The API key expiration must be set to a value between 1 and 365 days from creation (for `CreateApiKey`) or from update (for `UpdateApiKey`).  
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.    
 ** 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

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

 ** 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_UpdateApiKey_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/UpdateApiKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateApiKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateApiKey) 

# UpdateChannelNamespace
<a name="API_UpdateChannelNamespace"></a>

Updates a `ChannelNamespace` associated with an `Api`.

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

```
POST /v2/apis/apiId/channelNamespaces/name HTTP/1.1
Content-type: application/json

{
   "codeHandlers": "string",
   "handlerConfigs": { 
      "onPublish": { 
         "behavior": "string",
         "integration": { 
            "dataSourceName": "string",
            "lambdaConfig": { 
               "invokeType": "string"
            }
         }
      },
      "onSubscribe": { 
         "behavior": "string",
         "integration": { 
            "dataSourceName": "string",
            "lambdaConfig": { 
               "invokeType": "string"
            }
         }
      }
   },
   "publishAuthModes": [ 
      { 
         "authType": "string"
      }
   ],
   "subscribeAuthModes": [ 
      { 
         "authType": "string"
      }
   ]
}
```

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

The request uses the following URI parameters.

 ** [apiId](#API_UpdateChannelNamespace_RequestSyntax) **   <a name="appsync-UpdateChannelNamespace-request-uri-apiId"></a>
The `Api` ID.  
Required: Yes

 ** [name](#API_UpdateChannelNamespace_RequestSyntax) **   <a name="appsync-UpdateChannelNamespace-request-uri-name"></a>
The name of the `ChannelNamespace`.  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `([A-Za-z0-9](?:[A-Za-z0-9\-]{0,48}[A-Za-z0-9])?)`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [codeHandlers](#API_UpdateChannelNamespace_RequestSyntax) **   <a name="appsync-UpdateChannelNamespace-request-codeHandlers"></a>
The event handler functions that run custom business logic to process published events and subscribe requests.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

 ** [handlerConfigs](#API_UpdateChannelNamespace_RequestSyntax) **   <a name="appsync-UpdateChannelNamespace-request-handlerConfigs"></a>
The configuration for the `OnPublish` and `OnSubscribe` handlers.  
Type: [HandlerConfigs](API_HandlerConfigs.md) object  
Required: No

 ** [publishAuthModes](#API_UpdateChannelNamespace_RequestSyntax) **   <a name="appsync-UpdateChannelNamespace-request-publishAuthModes"></a>
The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.  
Type: Array of [AuthMode](API_AuthMode.md) objects  
Required: No

 ** [subscribeAuthModes](#API_UpdateChannelNamespace_RequestSyntax) **   <a name="appsync-UpdateChannelNamespace-request-subscribeAuthModes"></a>
The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.  
Type: Array of [AuthMode](API_AuthMode.md) objects  
Required: No

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

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

{
   "channelNamespace": { 
      "apiId": "string",
      "channelNamespaceArn": "string",
      "codeHandlers": "string",
      "created": number,
      "handlerConfigs": { 
         "onPublish": { 
            "behavior": "string",
            "integration": { 
               "dataSourceName": "string",
               "lambdaConfig": { 
                  "invokeType": "string"
               }
            }
         },
         "onSubscribe": { 
            "behavior": "string",
            "integration": { 
               "dataSourceName": "string",
               "lambdaConfig": { 
                  "invokeType": "string"
               }
            }
         }
      },
      "lastModified": number,
      "name": "string",
      "publishAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "subscribeAuthModes": [ 
         { 
            "authType": "string"
         }
      ],
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_UpdateChannelNamespace_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.

 ** [channelNamespace](#API_UpdateChannelNamespace_ResponseSyntax) **   <a name="appsync-UpdateChannelNamespace-response-channelNamespace"></a>
The `ChannelNamespace` object.  
Type: [ChannelNamespace](API_ChannelNamespace.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

 ** 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_UpdateChannelNamespace_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/UpdateChannelNamespace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateChannelNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateChannelNamespace) 

# UpdateDataSource
<a name="API_UpdateDataSource"></a>

Updates a `DataSource` object.

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

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

{
   "description": "string",
   "dynamodbConfig": { 
      "awsRegion": "string",
      "deltaSyncConfig": { 
         "baseTableTTL": number,
         "deltaSyncTableName": "string",
         "deltaSyncTableTTL": number
      },
      "tableName": "string",
      "useCallerCredentials": boolean,
      "versioned": boolean
   },
   "elasticsearchConfig": { 
      "awsRegion": "string",
      "endpoint": "string"
   },
   "eventBridgeConfig": { 
      "eventBusArn": "string"
   },
   "httpConfig": { 
      "authorizationConfig": { 
         "authorizationType": "string",
         "awsIamConfig": { 
            "signingRegion": "string",
            "signingServiceName": "string"
         }
      },
      "endpoint": "string"
   },
   "lambdaConfig": { 
      "lambdaFunctionArn": "string"
   },
   "metricsConfig": "string",
   "openSearchServiceConfig": { 
      "awsRegion": "string",
      "endpoint": "string"
   },
   "relationalDatabaseConfig": { 
      "rdsHttpEndpointConfig": { 
         "awsRegion": "string",
         "awsSecretStoreArn": "string",
         "databaseName": "string",
         "dbClusterIdentifier": "string",
         "schema": "string"
      },
      "relationalDatabaseSourceType": "string"
   },
   "serviceRoleArn": "string",
   "type": "string"
}
```

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

The request uses the following URI parameters.

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

 ** [name](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-uri-name"></a>
The new name for the data source.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [description](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-description"></a>
The new description for the data source.  
Type: String  
Required: No

 ** [dynamodbConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-dynamodbConfig"></a>
The new Amazon DynamoDB configuration.  
Type: [DynamodbDataSourceConfig](API_DynamodbDataSourceConfig.md) object  
Required: No

 ** [elasticsearchConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-elasticsearchConfig"></a>
The new OpenSearch configuration.  
As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. Instead, use [UpdateDataSource:openSearchServiceConfig](#appsync-UpdateDataSource-request-openSearchServiceConfig) to update an OpenSearch data source.  
Type: [ElasticsearchDataSourceConfig](API_ElasticsearchDataSourceConfig.md) object  
Required: No

 ** [eventBridgeConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-eventBridgeConfig"></a>
The new Amazon EventBridge settings.  
Type: [EventBridgeDataSourceConfig](API_EventBridgeDataSourceConfig.md) object  
Required: No

 ** [httpConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-httpConfig"></a>
The new HTTP endpoint configuration.  
Type: [HttpDataSourceConfig](API_HttpDataSourceConfig.md) object  
Required: No

 ** [lambdaConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-lambdaConfig"></a>
The new AWS Lambda configuration.  
Type: [LambdaDataSourceConfig](API_LambdaDataSourceConfig.md) object  
Required: No

 ** [metricsConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-metricsConfig"></a>
Enables or disables enhanced data source metrics for specified data sources. Note that `metricsConfig` won't be used unless the `dataSourceLevelMetricsBehavior` value is set to `PER_DATA_SOURCE_METRICS`. If the `dataSourceLevelMetricsBehavior` is set to `FULL_REQUEST_DATA_SOURCE_METRICS` instead, `metricsConfig` will be ignored. However, you can still set its value.  
 `metricsConfig` can be `ENABLED` or `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [openSearchServiceConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-openSearchServiceConfig"></a>
The new OpenSearch configuration.  
Type: [OpenSearchServiceDataSourceConfig](API_OpenSearchServiceDataSourceConfig.md) object  
Required: No

 ** [relationalDatabaseConfig](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-relationalDatabaseConfig"></a>
The new relational database configuration.  
Type: [RelationalDatabaseDataSourceConfig](API_RelationalDatabaseDataSourceConfig.md) object  
Required: No

 ** [serviceRoleArn](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-serviceRoleArn"></a>
The new service role Amazon Resource Name (ARN) for the data source.  
Type: String  
Required: No

 ** [type](#API_UpdateDataSource_RequestSyntax) **   <a name="appsync-UpdateDataSource-request-type"></a>
The new data source type.  
Type: String  
Valid Values: `AWS_LAMBDA | AMAZON_DYNAMODB | AMAZON_ELASTICSEARCH | NONE | HTTP | RELATIONAL_DATABASE | AMAZON_OPENSEARCH_SERVICE | AMAZON_EVENTBRIDGE | AMAZON_BEDROCK_RUNTIME`   
Required: Yes

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

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

{
   "dataSource": { 
      "dataSourceArn": "string",
      "description": "string",
      "dynamodbConfig": { 
         "awsRegion": "string",
         "deltaSyncConfig": { 
            "baseTableTTL": number,
            "deltaSyncTableName": "string",
            "deltaSyncTableTTL": number
         },
         "tableName": "string",
         "useCallerCredentials": boolean,
         "versioned": boolean
      },
      "elasticsearchConfig": { 
         "awsRegion": "string",
         "endpoint": "string"
      },
      "eventBridgeConfig": { 
         "eventBusArn": "string"
      },
      "httpConfig": { 
         "authorizationConfig": { 
            "authorizationType": "string",
            "awsIamConfig": { 
               "signingRegion": "string",
               "signingServiceName": "string"
            }
         },
         "endpoint": "string"
      },
      "lambdaConfig": { 
         "lambdaFunctionArn": "string"
      },
      "metricsConfig": "string",
      "name": "string",
      "openSearchServiceConfig": { 
         "awsRegion": "string",
         "endpoint": "string"
      },
      "relationalDatabaseConfig": { 
         "rdsHttpEndpointConfig": { 
            "awsRegion": "string",
            "awsSecretStoreArn": "string",
            "databaseName": "string",
            "dbClusterIdentifier": "string",
            "schema": "string"
         },
         "relationalDatabaseSourceType": "string"
      },
      "serviceRoleArn": "string",
      "type": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDataSource_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.

 ** [dataSource](#API_UpdateDataSource_ResponseSyntax) **   <a name="appsync-UpdateDataSource-response-dataSource"></a>
The updated `DataSource` object.  
Type: [DataSource](API_DataSource.md) object

## Errors
<a name="API_UpdateDataSource_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_UpdateDataSource_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/UpdateDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateDataSource) 

# UpdateDomainName
<a name="API_UpdateDomainName"></a>

Updates a custom `DomainName` object.

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

```
POST /v1/domainnames/domainName HTTP/1.1
Content-type: application/json

{
   "description": "string"
}
```

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

The request uses the following URI parameters.

 ** [domainName](#API_UpdateDomainName_RequestSyntax) **   <a name="appsync-UpdateDomainName-request-uri-domainName"></a>
The domain name.  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [description](#API_UpdateDomainName_RequestSyntax) **   <a name="appsync-UpdateDomainName-request-description"></a>
A description of the `DomainName`.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Pattern: `^.*$`   
Required: No

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

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

{
   "domainNameConfig": { 
      "appsyncDomainName": "string",
      "certificateArn": "string",
      "description": "string",
      "domainName": "string",
      "domainNameArn": "string",
      "hostedZoneId": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_UpdateDomainName_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.

 ** [domainNameConfig](#API_UpdateDomainName_ResponseSyntax) **   <a name="appsync-UpdateDomainName-response-domainNameConfig"></a>
The configuration for the `DomainName`.  
Type: [DomainNameConfig](API_DomainNameConfig.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

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

## See Also
<a name="API_UpdateDomainName_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/UpdateDomainName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateDomainName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateDomainName) 

# UpdateFunction
<a name="API_UpdateFunction"></a>

Updates a `Function` object.

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

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

{
   "code": "string",
   "dataSourceName": "string",
   "description": "string",
   "functionVersion": "string",
   "maxBatchSize": number,
   "name": "string",
   "requestMappingTemplate": "string",
   "responseMappingTemplate": "string",
   "runtime": { 
      "name": "string",
      "runtimeVersion": "string"
   },
   "syncConfig": { 
      "conflictDetection": "string",
      "conflictHandler": "string",
      "lambdaConflictHandlerConfig": { 
         "lambdaConflictHandlerArn": "string"
      }
   }
}
```

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

The request uses the following URI parameters.

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

 ** [functionId](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-uri-functionId"></a>
The function ID.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [code](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-code"></a>
The `function` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

 ** [dataSourceName](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-dataSourceName"></a>
The `Function` `DataSource` name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [description](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-description"></a>
The `Function` description.  
Type: String  
Required: No

 ** [functionVersion](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-functionVersion"></a>
The `version` of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the `functionVersion` is required.  
Type: String  
Required: No

 ** [maxBatchSize](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-maxBatchSize"></a>
The maximum batching size for a resolver.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2000.  
Required: No

 ** [name](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-name"></a>
The `Function` name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [requestMappingTemplate](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-requestMappingTemplate"></a>
The `Function` request mapping template. Functions support only the 2018-05-29 version of the request mapping template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [responseMappingTemplate](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-responseMappingTemplate"></a>
The `Function` request mapping template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [runtime](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-runtime"></a>
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.  
Type: [AppSyncRuntime](API_AppSyncRuntime.md) object  
Required: No

 ** [syncConfig](#API_UpdateFunction_RequestSyntax) **   <a name="appsync-UpdateFunction-request-syncConfig"></a>
Describes a Sync configuration for a resolver.  
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.  
Type: [SyncConfig](API_SyncConfig.md) object  
Required: No

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

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

{
   "functionConfiguration": { 
      "code": "string",
      "dataSourceName": "string",
      "description": "string",
      "functionArn": "string",
      "functionId": "string",
      "functionVersion": "string",
      "maxBatchSize": number,
      "name": "string",
      "requestMappingTemplate": "string",
      "responseMappingTemplate": "string",
      "runtime": { 
         "name": "string",
         "runtimeVersion": "string"
      },
      "syncConfig": { 
         "conflictDetection": "string",
         "conflictHandler": "string",
         "lambdaConflictHandlerConfig": { 
            "lambdaConflictHandlerArn": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_UpdateFunction_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.

 ** [functionConfiguration](#API_UpdateFunction_ResponseSyntax) **   <a name="appsync-UpdateFunction-response-functionConfiguration"></a>
The `Function` object.  
Type: [FunctionConfiguration](API_FunctionConfiguration.md) object

## Errors
<a name="API_UpdateFunction_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_UpdateFunction_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/UpdateFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateFunction) 

# UpdateGraphqlApi
<a name="API_UpdateGraphqlApi"></a>

Updates a `GraphqlApi` object.

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

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

{
   "additionalAuthenticationProviders": [ 
      { 
         "authenticationType": "string",
         "lambdaAuthorizerConfig": { 
            "authorizerResultTtlInSeconds": number,
            "authorizerUri": "string",
            "identityValidationExpression": "string"
         },
         "openIDConnectConfig": { 
            "authTTL": number,
            "clientId": "string",
            "iatTTL": number,
            "issuer": "string"
         },
         "userPoolConfig": { 
            "appIdClientRegex": "string",
            "awsRegion": "string",
            "userPoolId": "string"
         }
      }
   ],
   "authenticationType": "string",
   "enhancedMetricsConfig": { 
      "dataSourceLevelMetricsBehavior": "string",
      "operationLevelMetricsConfig": "string",
      "resolverLevelMetricsBehavior": "string"
   },
   "introspectionConfig": "string",
   "lambdaAuthorizerConfig": { 
      "authorizerResultTtlInSeconds": number,
      "authorizerUri": "string",
      "identityValidationExpression": "string"
   },
   "logConfig": { 
      "cloudWatchLogsRoleArn": "string",
      "excludeVerboseContent": boolean,
      "fieldLogLevel": "string"
   },
   "mergedApiExecutionRoleArn": "string",
   "name": "string",
   "openIDConnectConfig": { 
      "authTTL": number,
      "clientId": "string",
      "iatTTL": number,
      "issuer": "string"
   },
   "ownerContact": "string",
   "queryDepthLimit": number,
   "resolverCountLimit": number,
   "userPoolConfig": { 
      "appIdClientRegex": "string",
      "awsRegion": "string",
      "defaultAction": "string",
      "userPoolId": "string"
   },
   "xrayEnabled": boolean
}
```

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

The request uses the following URI parameters.

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

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

The request accepts the following data in JSON format.

 ** [additionalAuthenticationProviders](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-additionalAuthenticationProviders"></a>
A list of additional authentication providers for the `GraphqlApi` API.  
Type: Array of [AdditionalAuthenticationProvider](API_AdditionalAuthenticationProvider.md) objects  
Required: No

 ** [authenticationType](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-authenticationType"></a>
The new authentication type for the `GraphqlApi` object.  
Type: String  
Valid Values: `API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDA`   
Required: Yes

 ** [enhancedMetricsConfig](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-enhancedMetricsConfig"></a>
The `enhancedMetricsConfig` object.  
Type: [EnhancedMetricsConfig](API_EnhancedMetricsConfig.md) object  
Required: No

 ** [introspectionConfig](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-introspectionConfig"></a>
Sets the value of the GraphQL API to enable (`ENABLED`) or disable (`DISABLED`) introspection. If no value is provided, the introspection configuration will be set to `ENABLED` by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.  
For more information about introspection, see [GraphQL introspection](https://graphql.org/learn/introspection/).  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [lambdaAuthorizerConfig](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-lambdaAuthorizerConfig"></a>
Configuration for Lambda function authorization.  
Type: [LambdaAuthorizerConfig](API_LambdaAuthorizerConfig.md) object  
Required: No

 ** [logConfig](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-logConfig"></a>
The Amazon CloudWatch Logs configuration for the `GraphqlApi` object.  
Type: [LogConfig](API_LogConfig.md) object  
Required: No

 ** [mergedApiExecutionRoleArn](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-mergedApiExecutionRoleArn"></a>
The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the `AUTO_MERGE` to update the merged API endpoint with the source API changes automatically.  
Type: String  
Required: No

 ** [name](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-name"></a>
The new name for the `GraphqlApi` object.  
Type: String  
Required: Yes

 ** [openIDConnectConfig](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-openIDConnectConfig"></a>
The OpenID Connect configuration for the `GraphqlApi` object.  
Type: [OpenIDConnectConfig](API_OpenIDConnectConfig.md) object  
Required: No

 ** [ownerContact](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-ownerContact"></a>
The owner contact information for an API resource.  
This field accepts any string input with a length of 0 - 256 characters.  
Type: String  
Required: No

 ** [queryDepthLimit](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-queryDepthLimit"></a>
The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is `0` (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between `1` and `75` nested levels. This field will produce a limit error if the operation falls out of bounds.  
Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 75.  
Required: No

 ** [resolverCountLimit](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-resolverCountLimit"></a>
The maximum number of resolvers that can be invoked in a single request. The default value is `0` (or unspecified), which will set the limit to `10000`. When specified, the limit value can be between `1` and `10000`. This field will produce a limit error if the operation falls out of bounds.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 10000.  
Required: No

 ** [userPoolConfig](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-userPoolConfig"></a>
The new Amazon Cognito user pool configuration for the `~GraphqlApi` object.  
Type: [UserPoolConfig](API_UserPoolConfig.md) object  
Required: No

 ** [xrayEnabled](#API_UpdateGraphqlApi_RequestSyntax) **   <a name="appsync-UpdateGraphqlApi-request-xrayEnabled"></a>
A flag indicating whether to use AWS X-Ray tracing for the `GraphqlApi`.  
Type: Boolean  
Required: No

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

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

{
   "graphqlApi": { 
      "additionalAuthenticationProviders": [ 
         { 
            "authenticationType": "string",
            "lambdaAuthorizerConfig": { 
               "authorizerResultTtlInSeconds": number,
               "authorizerUri": "string",
               "identityValidationExpression": "string"
            },
            "openIDConnectConfig": { 
               "authTTL": number,
               "clientId": "string",
               "iatTTL": number,
               "issuer": "string"
            },
            "userPoolConfig": { 
               "appIdClientRegex": "string",
               "awsRegion": "string",
               "userPoolId": "string"
            }
         }
      ],
      "apiId": "string",
      "apiType": "string",
      "arn": "string",
      "authenticationType": "string",
      "dns": { 
         "string" : "string" 
      },
      "enhancedMetricsConfig": { 
         "dataSourceLevelMetricsBehavior": "string",
         "operationLevelMetricsConfig": "string",
         "resolverLevelMetricsBehavior": "string"
      },
      "introspectionConfig": "string",
      "lambdaAuthorizerConfig": { 
         "authorizerResultTtlInSeconds": number,
         "authorizerUri": "string",
         "identityValidationExpression": "string"
      },
      "logConfig": { 
         "cloudWatchLogsRoleArn": "string",
         "excludeVerboseContent": boolean,
         "fieldLogLevel": "string"
      },
      "mergedApiExecutionRoleArn": "string",
      "name": "string",
      "openIDConnectConfig": { 
         "authTTL": number,
         "clientId": "string",
         "iatTTL": number,
         "issuer": "string"
      },
      "owner": "string",
      "ownerContact": "string",
      "queryDepthLimit": number,
      "resolverCountLimit": number,
      "tags": { 
         "string" : "string" 
      },
      "uris": { 
         "string" : "string" 
      },
      "userPoolConfig": { 
         "appIdClientRegex": "string",
         "awsRegion": "string",
         "defaultAction": "string",
         "userPoolId": "string"
      },
      "visibility": "string",
      "wafWebAclArn": "string",
      "xrayEnabled": boolean
   }
}
```

## Response Elements
<a name="API_UpdateGraphqlApi_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.

 ** [graphqlApi](#API_UpdateGraphqlApi_ResponseSyntax) **   <a name="appsync-UpdateGraphqlApi-response-graphqlApi"></a>
The updated `GraphqlApi` object.  
Type: [GraphqlApi](API_GraphqlApi.md) object

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

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

 ** AccessDeniedException **   
You don't have access to perform this operation on this resource.  
HTTP Status Code: 403

 ** 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_UpdateGraphqlApi_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/UpdateGraphqlApi) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateGraphqlApi) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateGraphqlApi) 

# UpdateResolver
<a name="API_UpdateResolver"></a>

Updates a `Resolver` object.

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

```
POST /v1/apis/apiId/types/typeName/resolvers/fieldName HTTP/1.1
Content-type: application/json

{
   "cachingConfig": { 
      "cachingKeys": [ "string" ],
      "ttl": number
   },
   "code": "string",
   "dataSourceName": "string",
   "kind": "string",
   "maxBatchSize": number,
   "metricsConfig": "string",
   "pipelineConfig": { 
      "functions": [ "string" ]
   },
   "requestMappingTemplate": "string",
   "responseMappingTemplate": "string",
   "runtime": { 
      "name": "string",
      "runtimeVersion": "string"
   },
   "syncConfig": { 
      "conflictDetection": "string",
      "conflictHandler": "string",
      "lambdaConflictHandlerConfig": { 
         "lambdaConflictHandlerArn": "string"
      }
   }
}
```

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

The request uses the following URI parameters.

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

 ** [fieldName](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-uri-fieldName"></a>
The new field name.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

 ** [typeName](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-uri-typeName"></a>
The new type name.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [cachingConfig](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-cachingConfig"></a>
The caching configuration for the resolver.  
Type: [CachingConfig](API_CachingConfig.md) object  
Required: No

 ** [code](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-code"></a>
The `resolver` code that contains the request and response functions. When code is used, the `runtime` is required. The `runtime` value must be `APPSYNC_JS`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 32768.  
Required: No

 ** [dataSourceName](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-dataSourceName"></a>
The new data source name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: No

 ** [kind](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-kind"></a>
The resolver type.  
+  **UNIT**: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
+  **PIPELINE**: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of `Function` objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
Type: String  
Valid Values: `UNIT | PIPELINE`   
Required: No

 ** [maxBatchSize](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-maxBatchSize"></a>
The maximum batching size for a resolver.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2000.  
Required: No

 ** [metricsConfig](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-metricsConfig"></a>
Enables or disables enhanced resolver metrics for specified resolvers. Note that `metricsConfig` won't be used unless the `resolverLevelMetricsBehavior` value is set to `PER_RESOLVER_METRICS`. If the `resolverLevelMetricsBehavior` is set to `FULL_REQUEST_RESOLVER_METRICS` instead, `metricsConfig` will be ignored. However, you can still set its value.  
 `metricsConfig` can be `ENABLED` or `DISABLED`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [pipelineConfig](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-pipelineConfig"></a>
The `PipelineConfig`.  
Type: [PipelineConfig](API_PipelineConfig.md) object  
Required: No

 ** [requestMappingTemplate](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-requestMappingTemplate"></a>
The new request mapping template.  
A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).  
VTL request mapping templates are optional when using an AWS Lambda data source. For all other data sources, VTL request and response mapping templates are required.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [responseMappingTemplate](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-responseMappingTemplate"></a>
The new response mapping template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `^.*$`   
Required: No

 ** [runtime](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-runtime"></a>
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.  
Type: [AppSyncRuntime](API_AppSyncRuntime.md) object  
Required: No

 ** [syncConfig](#API_UpdateResolver_RequestSyntax) **   <a name="appsync-UpdateResolver-request-syncConfig"></a>
The `SyncConfig` for a resolver attached to a versioned data source.  
Type: [SyncConfig](API_SyncConfig.md) object  
Required: No

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

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

{
   "resolver": { 
      "cachingConfig": { 
         "cachingKeys": [ "string" ],
         "ttl": number
      },
      "code": "string",
      "dataSourceName": "string",
      "fieldName": "string",
      "kind": "string",
      "maxBatchSize": number,
      "metricsConfig": "string",
      "pipelineConfig": { 
         "functions": [ "string" ]
      },
      "requestMappingTemplate": "string",
      "resolverArn": "string",
      "responseMappingTemplate": "string",
      "runtime": { 
         "name": "string",
         "runtimeVersion": "string"
      },
      "syncConfig": { 
         "conflictDetection": "string",
         "conflictHandler": "string",
         "lambdaConflictHandlerConfig": { 
            "lambdaConflictHandlerArn": "string"
         }
      },
      "typeName": "string"
   }
}
```

## Response Elements
<a name="API_UpdateResolver_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.

 ** [resolver](#API_UpdateResolver_ResponseSyntax) **   <a name="appsync-UpdateResolver-response-resolver"></a>
The updated `Resolver` object.  
Type: [Resolver](API_Resolver.md) object

## Errors
<a name="API_UpdateResolver_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_UpdateResolver_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/UpdateResolver) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateResolver) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateResolver) 

# UpdateSourceApiAssociation
<a name="API_UpdateSourceApiAssociation"></a>

Updates some of the configuration choices of a particular source API association.

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

```
POST /v1/mergedApis/mergedApiIdentifier/sourceApiAssociations/associationId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "sourceApiAssociationConfig": { 
      "mergeType": "string"
   }
}
```

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

The request uses the following URI parameters.

 ** [associationId](#API_UpdateSourceApiAssociation_RequestSyntax) **   <a name="appsync-UpdateSourceApiAssociation-request-uri-associationId"></a>
The ID generated by the AppSync service for the source API association.  
Required: Yes

 ** [mergedApiIdentifier](#API_UpdateSourceApiAssociation_RequestSyntax) **   <a name="appsync-UpdateSourceApiAssociation-request-uri-mergedApiIdentifier"></a>
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

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

The request accepts the following data in JSON format.

 ** [description](#API_UpdateSourceApiAssociation_RequestSyntax) **   <a name="appsync-UpdateSourceApiAssociation-request-description"></a>
The description field.  
Type: String  
Required: No

 ** [sourceApiAssociationConfig](#API_UpdateSourceApiAssociation_RequestSyntax) **   <a name="appsync-UpdateSourceApiAssociation-request-sourceApiAssociationConfig"></a>
The `SourceApiAssociationConfig` object data.  
Type: [SourceApiAssociationConfig](API_SourceApiAssociationConfig.md) object  
Required: No

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

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

{
   "sourceApiAssociation": { 
      "associationArn": "string",
      "associationId": "string",
      "description": "string",
      "lastSuccessfulMergeDate": number,
      "mergedApiArn": "string",
      "mergedApiId": "string",
      "sourceApiArn": "string",
      "sourceApiAssociationConfig": { 
         "mergeType": "string"
      },
      "sourceApiAssociationStatus": "string",
      "sourceApiAssociationStatusDetail": "string",
      "sourceApiId": "string"
   }
}
```

## Response Elements
<a name="API_UpdateSourceApiAssociation_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.

 ** [sourceApiAssociation](#API_UpdateSourceApiAssociation_ResponseSyntax) **   <a name="appsync-UpdateSourceApiAssociation-response-sourceApiAssociation"></a>
The `SourceApiAssociation` object data.  
Type: [SourceApiAssociation](API_SourceApiAssociation.md) object

## Errors
<a name="API_UpdateSourceApiAssociation_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_UpdateSourceApiAssociation_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/UpdateSourceApiAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateSourceApiAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateSourceApiAssociation) 

# UpdateType
<a name="API_UpdateType"></a>

Updates a `Type` object.

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

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

{
   "definition": "string",
   "format": "string"
}
```

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

The request uses the following URI parameters.

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

 ** [typeName](#API_UpdateType_RequestSyntax) **   <a name="appsync-UpdateType-request-uri-typeName"></a>
The new type name.  
Length Constraints: Minimum length of 1. Maximum length of 65536.  
Pattern: `[_A-Za-z][_0-9A-Za-z]*`   
Required: Yes

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

The request accepts the following data in JSON format.

 ** [definition](#API_UpdateType_RequestSyntax) **   <a name="appsync-UpdateType-request-definition"></a>
The new definition.  
Type: String  
Required: No

 ** [format](#API_UpdateType_RequestSyntax) **   <a name="appsync-UpdateType-request-format"></a>
The new type format: SDL or JSON.  
Type: String  
Valid Values: `SDL | JSON`   
Required: Yes

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

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

{
   "type": { 
      "arn": "string",
      "definition": "string",
      "description": "string",
      "format": "string",
      "name": "string"
   }
}
```

## Response Elements
<a name="API_UpdateType_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.

 ** [type](#API_UpdateType_ResponseSyntax) **   <a name="appsync-UpdateType-response-type"></a>
The updated `Type` object.  
Type: [Type](API_Type.md) object

## Errors
<a name="API_UpdateType_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_UpdateType_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/UpdateType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appsync-2017-07-25/UpdateType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appsync-2017-07-25/UpdateType)