Class: AWS.AppSync

var params = {
  mergedApiIdentifier: 'STRING_VALUE', /* required */
  sourceApiIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  sourceApiAssociationConfig: {
    mergeType: MANUAL_MERGE | AUTO_MERGE
  }
};
appsync.associateMergedGraphqlApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • sourceApiIdentifier — (String)

    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.

  • mergedApiIdentifier — (String)

    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.

  • description — (String)

    The description field.

  • sourceApiAssociationConfig — (map)

    The SourceApiAssociationConfig object data.

    • mergeType — (String)

      The property that indicates which merging option is enabled in the source API association.

      Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations.

      Possible values include:
      • "MANUAL_MERGE"
      • "AUTO_MERGE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sourceApiAssociation — (map)

      The SourceApiAssociation object data.

      • associationId — (String)

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

      • associationArn — (String)

        The Amazon Resource Name (ARN) of the source API association.

      • sourceApiId — (String)

        The ID of the AppSync source API.

      • sourceApiArn — (String)

        The Amazon Resource Name (ARN) of the AppSync source API.

      • mergedApiArn — (String)

        The Amazon Resource Name (ARN) of the AppSync Merged API.

      • mergedApiId — (String)

        The ID of the AppSync Merged API.

      • description — (String)

        The description field.

      • sourceApiAssociationConfig — (map)

        The SourceApiAssociationConfig object data.

        • mergeType — (String)

          The property that indicates which merging option is enabled in the source API association.

          Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations.

          Possible values include:
          • "MANUAL_MERGE"
          • "AUTO_MERGE"
      • sourceApiAssociationStatus — (String)

        The state of the source API association.

        Possible values include:
        • "MERGE_SCHEDULED"
        • "MERGE_FAILED"
        • "MERGE_SUCCESS"
        • "MERGE_IN_PROGRESS"
        • "AUTO_MERGE_SCHEDULE_FAILED"
        • "DELETION_SCHEDULED"
        • "DELETION_IN_PROGRESS"
        • "DELETION_FAILED"
      • sourceApiAssociationStatusDetail — (String)

        The detailed message related to the current state of the source API association.

      • lastSuccessfulMergeDate — (Date)

        The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  mergedApiIdentifier: 'STRING_VALUE', /* required */
  sourceApiIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  sourceApiAssociationConfig: {
    mergeType: MANUAL_MERGE | AUTO_MERGE
  }
};
appsync.associateSourceGraphqlApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • mergedApiIdentifier — (String)

    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.

  • sourceApiIdentifier — (String)

    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.

  • description — (String)

    The description field.

  • sourceApiAssociationConfig — (map)

    The SourceApiAssociationConfig object data.

    • mergeType — (String)

      The property that indicates which merging option is enabled in the source API association.

      Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations.

      Possible values include:
      • "MANUAL_MERGE"
      • "AUTO_MERGE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sourceApiAssociation — (map)

      The SourceApiAssociation object data.

      • associationId — (String)

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

      • associationArn — (String)

        The Amazon Resource Name (ARN) of the source API association.

      • sourceApiId — (String)

        The ID of the AppSync source API.

      • sourceApiArn — (String)

        The Amazon Resource Name (ARN) of the AppSync source API.

      • mergedApiArn — (String)

        The Amazon Resource Name (ARN) of the AppSync Merged API.

      • mergedApiId — (String)

        The ID of the AppSync Merged API.

      • description — (String)

        The description field.

      • sourceApiAssociationConfig — (map)

        The SourceApiAssociationConfig object data.

        • mergeType — (String)

          The property that indicates which merging option is enabled in the source API association.

          Valid merge types are MANUAL_MERGE (default) and AUTO_MERGE. Manual merges are the default behavior and require the user to trigger any changes from the source APIs to the merged API manually. Auto merges subscribe the merged API to the changes performed on the source APIs so that any change in the source APIs are also made to the merged API. Auto merges use MergedApiExecutionRoleArn to perform merge operations.

          Possible values include:
          • "MANUAL_MERGE"
          • "AUTO_MERGE"
      • sourceApiAssociationStatus — (String)

        The state of the source API association.

        Possible values include:
        • "MERGE_SCHEDULED"
        • "MERGE_FAILED"
        • "MERGE_SUCCESS"
        • "MERGE_IN_PROGRESS"
        • "AUTO_MERGE_SCHEDULE_FAILED"
        • "DELETION_SCHEDULED"
        • "DELETION_IN_PROGRESS"
        • "DELETION_FAILED"
      • sourceApiAssociationStatusDetail — (String)

        The detailed message related to the current state of the source API association.

      • lastSuccessfulMergeDate — (Date)

        The datetime value of the last successful merge of the source API association. The result will be in UTC format and your local time zone.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiCachingBehavior: FULL_REQUEST_CACHING | PER_RESOLVER_CACHING, /* required */
  apiId: 'STRING_VALUE', /* required */
  ttl: 'NUMBER_VALUE', /* required */
  type: 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 */
  atRestEncryptionEnabled: true || false,
  healthMetricsConfig: ENABLED | DISABLED,
  transitEncryptionEnabled: true || false
};
appsync.createApiCache(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The GraphQL API ID.

  • ttl — (Integer)

    TTL in seconds for cache entries.

    Valid values are 1–3,600 seconds.

  • transitEncryptionEnabled — (Boolean)

    Transit encryption flag when connecting to cache. You cannot update this setting after creation.

  • atRestEncryptionEnabled — (Boolean)

    At-rest encryption flag for cache. You cannot update this setting after creation.

  • apiCachingBehavior — (String)

    Caching behavior.

    • FULL_REQUEST_CACHING: All requests are fully cached.

    • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

    Possible values include:
    • "FULL_REQUEST_CACHING"
    • "PER_RESOLVER_CACHING"
  • type — (String)

    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_SMALL: A t2.small instance type.

    • T2_MEDIUM: A t2.medium instance type.

    • R4_LARGE: A r4.large instance type.

    • R4_XLARGE: A r4.xlarge instance type.

    • R4_2XLARGE: A r4.2xlarge instance type.

    • R4_4XLARGE: A r4.4xlarge instance type.

    • R4_8XLARGE: A r4.8xlarge instance type.

    Possible values include:
    • "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"
  • healthMetricsConfig — (String)

    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.

    Possible values include:
    • "ENABLED"
    • "DISABLED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • apiCache — (map)

      The ApiCache object.

      • ttl — (Integer)

        TTL in seconds for cache entries.

        Valid values are 1–3,600 seconds.

      • apiCachingBehavior — (String)

        Caching behavior.

        • FULL_REQUEST_CACHING: All requests are fully cached.

        • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

        Possible values include:
        • "FULL_REQUEST_CACHING"
        • "PER_RESOLVER_CACHING"
      • transitEncryptionEnabled — (Boolean)

        Transit encryption flag when connecting to cache. You cannot update this setting after creation.

      • atRestEncryptionEnabled — (Boolean)

        At-rest encryption flag for cache. You cannot update this setting after creation.

      • type — (String)

        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_SMALL: A t2.small instance type.

        • T2_MEDIUM: A t2.medium instance type.

        • R4_LARGE: A r4.large instance type.

        • R4_XLARGE: A r4.xlarge instance type.

        • R4_2XLARGE: A r4.2xlarge instance type.

        • R4_4XLARGE: A r4.4xlarge instance type.

        • R4_8XLARGE: A r4.8xlarge instance type.

        Possible values include:
        • "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"
      • status — (String)

        The cache instance status.

        • AVAILABLE: The instance is available for use.

        • CREATING: The instance is currently creating.

        • DELETING: The instance is currently deleting.

        • MODIFYING: The instance is currently modifying.

        • FAILED: The instance has failed creation.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "DELETING"
        • "MODIFYING"
        • "FAILED"
      • healthMetricsConfig — (String)

        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.

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  expires: 'NUMBER_VALUE'
};
appsync.createApiKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The ID for your GraphQL API.

  • description — (String)

    A description of the purpose of the API key.

  • expires — (Integer)

    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 .

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • apiKey — (map)

      The API key.

      • id — (String)

        The API key ID.

      • description — (String)

        A description of the purpose of the API key.

      • expires — (Integer)

        The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

      • deletes — (Integer)

        The time after which the API key is deleted. The date is represented as seconds since the epoch, rounded down to the nearest hour.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  type: AWS_LAMBDA | AMAZON_DYNAMODB | AMAZON_ELASTICSEARCH | NONE | HTTP | RELATIONAL_DATABASE | AMAZON_OPENSEARCH_SERVICE | AMAZON_EVENTBRIDGE, /* required */
  description: 'STRING_VALUE',
  dynamodbConfig: {
    awsRegion: 'STRING_VALUE', /* required */
    tableName: 'STRING_VALUE', /* required */
    deltaSyncConfig: {
      baseTableTTL: 'NUMBER_VALUE',
      deltaSyncTableName: 'STRING_VALUE',
      deltaSyncTableTTL: 'NUMBER_VALUE'
    },
    useCallerCredentials: true || false,
    versioned: true || false
  },
  elasticsearchConfig: {
    awsRegion: 'STRING_VALUE', /* required */
    endpoint: 'STRING_VALUE' /* required */
  },
  eventBridgeConfig: {
    eventBusArn: 'STRING_VALUE' /* required */
  },
  httpConfig: {
    authorizationConfig: {
      authorizationType: AWS_IAM, /* required */
      awsIamConfig: {
        signingRegion: 'STRING_VALUE',
        signingServiceName: 'STRING_VALUE'
      }
    },
    endpoint: 'STRING_VALUE'
  },
  lambdaConfig: {
    lambdaFunctionArn: 'STRING_VALUE' /* required */
  },
  metricsConfig: ENABLED | DISABLED,
  openSearchServiceConfig: {
    awsRegion: 'STRING_VALUE', /* required */
    endpoint: 'STRING_VALUE' /* required */
  },
  relationalDatabaseConfig: {
    rdsHttpEndpointConfig: {
      awsRegion: 'STRING_VALUE',
      awsSecretStoreArn: 'STRING_VALUE',
      databaseName: 'STRING_VALUE',
      dbClusterIdentifier: 'STRING_VALUE',
      schema: 'STRING_VALUE'
    },
    relationalDatabaseSourceType: RDS_HTTP_ENDPOINT
  },
  serviceRoleArn: 'STRING_VALUE'
};
appsync.createDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID for the GraphQL API for the DataSource.

  • name — (String)

    A user-supplied name for the DataSource.

  • description — (String)

    A description of the DataSource.

  • type — (String)

    The type of the DataSource.

    Possible values include:
    • "AWS_LAMBDA"
    • "AMAZON_DYNAMODB"
    • "AMAZON_ELASTICSEARCH"
    • "NONE"
    • "HTTP"
    • "RELATIONAL_DATABASE"
    • "AMAZON_OPENSEARCH_SERVICE"
    • "AMAZON_EVENTBRIDGE"
  • serviceRoleArn — (String)

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

  • dynamodbConfig — (map)

    Amazon DynamoDB settings.

    • tableName — required — (String)

      The table name.

    • awsRegion — required — (String)

      The Amazon Web Services Region.

    • useCallerCredentials — (Boolean)

      Set to TRUE to use Amazon Cognito credentials with this data source.

    • deltaSyncConfig — (map)

      The DeltaSyncConfig for a versioned data source.

      • baseTableTTL — (Integer)

        The number of minutes that an Item is stored in the data source.

      • deltaSyncTableName — (String)

        The Delta Sync table name.

      • deltaSyncTableTTL — (Integer)

        The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.

    • versioned — (Boolean)

      Set to TRUE to use Conflict Detection and Resolution with this data source.

  • lambdaConfig — (map)

    Lambda settings.

    • lambdaFunctionArn — required — (String)

      The Amazon Resource Name (ARN) for the Lambda function.

  • elasticsearchConfig — (map)

    Amazon OpenSearch Service settings.

    As of September 2021, Amazon Elasticsearch service is Amazon OpenSearch Service. This configuration is deprecated. For new data sources, use CreateDataSourceRequest$openSearchServiceConfig to create an OpenSearch data source.

    • endpoint — required — (String)

      The endpoint.

    • awsRegion — required — (String)

      The Amazon Web Services Region.

  • openSearchServiceConfig — (map)

    Amazon OpenSearch Service settings.

    • endpoint — required — (String)

      The endpoint.

    • awsRegion — required — (String)

      The Amazon Web Services Region.

  • httpConfig — (map)

    HTTP endpoint settings.

    • endpoint — (String)

      The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

    • authorizationConfig — (map)

      The authorization configuration in case the HTTP endpoint requires authorization.

      • authorizationType — required — (String)

        The authorization type that the HTTP endpoint requires.

        • AWS_IAM: The authorization type is Signature Version 4 (SigV4).

        Possible values include:
        • "AWS_IAM"
      • awsIamConfig — (map)

        The Identity and Access Management (IAM) settings.

        • signingRegion — (String)

          The signing Amazon Web Services Region for IAM authorization.

        • signingServiceName — (String)

          The signing service name for IAM authorization.

  • relationalDatabaseConfig — (map)

    Relational database settings.

    • relationalDatabaseSourceType — (String)

      Source type for the relational database.

      • RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.

      Possible values include:
      • "RDS_HTTP_ENDPOINT"
    • rdsHttpEndpointConfig — (map)

      Amazon RDS HTTP endpoint settings.

      • awsRegion — (String)

        Amazon Web Services Region for Amazon RDS HTTP endpoint.

      • dbClusterIdentifier — (String)

        Amazon RDS cluster Amazon Resource Name (ARN).

      • databaseName — (String)

        Logical database name.

      • schema — (String)

        Logical schema name.

      • awsSecretStoreArn — (String)

        Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.

  • eventBridgeConfig — (map)

    Amazon EventBridge settings.

    • eventBusArn — required — (String)

      The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.

  • metricsConfig — (String)

    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.

    Possible values include:
    • "ENABLED"
    • "DISABLED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataSource — (map)

      The DataSource object.

      • dataSourceArn — (String)

        The data source Amazon Resource Name (ARN).

      • name — (String)

        The name of the data source.

      • description — (String)

        The description of the data source.

      • type — (String)

        The type of the data source.

        • AWS_LAMBDA: The data source is an Lambda function.

        • AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.

        • AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.

        • AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.

        • AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.

        • NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.

        • HTTP: The data source is an HTTP endpoint.

        • RELATIONAL_DATABASE: The data source is a relational database.

        Possible values include:
        • "AWS_LAMBDA"
        • "AMAZON_DYNAMODB"
        • "AMAZON_ELASTICSEARCH"
        • "NONE"
        • "HTTP"
        • "RELATIONAL_DATABASE"
        • "AMAZON_OPENSEARCH_SERVICE"
        • "AMAZON_EVENTBRIDGE"
      • serviceRoleArn — (String)

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

      • dynamodbConfig — (map)

        DynamoDB settings.

        • tableName — required — (String)

          The table name.

        • awsRegion — required — (String)

          The Amazon Web Services Region.

        • useCallerCredentials — (Boolean)

          Set to TRUE to use Amazon Cognito credentials with this data source.

        • deltaSyncConfig — (map)

          The DeltaSyncConfig for a versioned data source.

          • baseTableTTL — (Integer)

            The number of minutes that an Item is stored in the data source.

          • deltaSyncTableName — (String)

            The Delta Sync table name.

          • deltaSyncTableTTL — (Integer)

            The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.

        • versioned — (Boolean)

          Set to TRUE to use Conflict Detection and Resolution with this data source.

      • lambdaConfig — (map)

        Lambda settings.

        • lambdaFunctionArn — required — (String)

          The Amazon Resource Name (ARN) for the Lambda function.

      • elasticsearchConfig — (map)

        Amazon OpenSearch Service settings.

        • endpoint — required — (String)

          The endpoint.

        • awsRegion — required — (String)

          The Amazon Web Services Region.

      • openSearchServiceConfig — (map)

        Amazon OpenSearch Service settings.

        • endpoint — required — (String)

          The endpoint.

        • awsRegion — required — (String)

          The Amazon Web Services Region.

      • httpConfig — (map)

        HTTP endpoint settings.

        • endpoint — (String)

          The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

        • authorizationConfig — (map)

          The authorization configuration in case the HTTP endpoint requires authorization.

          • authorizationType — required — (String)

            The authorization type that the HTTP endpoint requires.

            • AWS_IAM: The authorization type is Signature Version 4 (SigV4).

            Possible values include:
            • "AWS_IAM"
          • awsIamConfig — (map)

            The Identity and Access Management (IAM) settings.

            • signingRegion — (String)

              The signing Amazon Web Services Region for IAM authorization.

            • signingServiceName — (String)

              The signing service name for IAM authorization.

      • relationalDatabaseConfig — (map)

        Relational database settings.

        • relationalDatabaseSourceType — (String)

          Source type for the relational database.

          • RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.

          Possible values include:
          • "RDS_HTTP_ENDPOINT"
        • rdsHttpEndpointConfig — (map)

          Amazon RDS HTTP endpoint settings.

          • awsRegion — (String)

            Amazon Web Services Region for Amazon RDS HTTP endpoint.

          • dbClusterIdentifier — (String)

            Amazon RDS cluster Amazon Resource Name (ARN).

          • databaseName — (String)

            Logical database name.

          • schema — (String)

            Logical schema name.

          • awsSecretStoreArn — (String)

            Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.

      • eventBridgeConfig — (map)

        Amazon EventBridge settings.

        • eventBusArn — required — (String)

          The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.

      • metricsConfig — (String)

        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.

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  certificateArn: 'STRING_VALUE', /* required */
  domainName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
appsync.createDomainName(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domainName — (String)

    The domain name.

  • certificateArn — (String)

    The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

  • description — (String)

    A description of the DomainName.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • domainNameConfig — (map)

      The configuration for the DomainName.

      • domainName — (String)

        The domain name.

      • description — (String)

        A description of the DomainName configuration.

      • certificateArn — (String)

        The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

      • appsyncDomainName — (String)

        The domain name that AppSync provides.

      • hostedZoneId — (String)

        The ID of your Amazon Route 53 hosted zone.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  dataSourceName: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  code: 'STRING_VALUE',
  description: 'STRING_VALUE',
  functionVersion: 'STRING_VALUE',
  maxBatchSize: 'NUMBER_VALUE',
  requestMappingTemplate: 'STRING_VALUE',
  responseMappingTemplate: 'STRING_VALUE',
  runtime: {
    name: APPSYNC_JS, /* required */
    runtimeVersion: 'STRING_VALUE' /* required */
  },
  syncConfig: {
    conflictDetection: VERSION | NONE,
    conflictHandler: OPTIMISTIC_CONCURRENCY | LAMBDA | AUTOMERGE | NONE,
    lambdaConflictHandlerConfig: {
      lambdaConflictHandlerArn: 'STRING_VALUE'
    }
  }
};
appsync.createFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The GraphQL API ID.

  • name — (String)

    The Function name. The function name does not have to be unique.

  • description — (String)

    The Function description.

  • dataSourceName — (String)

    The Function DataSource name.

  • requestMappingTemplate — (String)

    The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

  • responseMappingTemplate — (String)

    The Function response mapping template.

  • functionVersion — (String)

    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.

  • syncConfig — (map)

    Describes a Sync configuration for a resolver.

    Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

    • conflictHandler — (String)

      The Conflict Resolution strategy to perform in the event of a conflict.

      • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.

      • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.

      • LAMBDA: Resolve conflicts with an Lambda function supplied in the LambdaConflictHandlerConfig.

      Possible values include:
      • "OPTIMISTIC_CONCURRENCY"
      • "LAMBDA"
      • "AUTOMERGE"
      • "NONE"
    • conflictDetection — (String)

      The Conflict Detection strategy to use.

      • VERSION: Detect conflicts based on object versions for this resolver.

      • NONE: Do not detect conflicts when invoking this resolver.

      Possible values include:
      • "VERSION"
      • "NONE"
    • lambdaConflictHandlerConfig — (map)

      The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

      • lambdaConflictHandlerArn — (String)

        The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

  • maxBatchSize — (Integer)

    The maximum batching size for a resolver.

  • runtime — (map)

    Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

    • name — required — (String)

      The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.

      Possible values include:
      • "APPSYNC_JS"
    • runtimeVersion — required — (String)

      The version of the runtime to use. Currently, the only allowed version is 1.0.0.

  • code — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • functionConfiguration — (map)

      The Function object.

      • functionId — (String)

        A unique ID representing the Function object.

      • functionArn — (String)

        The Amazon Resource Name (ARN) of the Function object.

      • name — (String)

        The name of the Function object.

      • description — (String)

        The Function description.

      • dataSourceName — (String)

        The name of the DataSource.

      • requestMappingTemplate — (String)

        The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

      • responseMappingTemplate — (String)

        The Function response mapping template.

      • functionVersion — (String)

        The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

      • syncConfig — (map)

        Describes a Sync configuration for a resolver.

        Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

        • conflictHandler — (String)

          The Conflict Resolution strategy to perform in the event of a conflict.

          • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.

          • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.

          • LAMBDA: Resolve conflicts with an Lambda function supplied in the LambdaConflictHandlerConfig.

          Possible values include:
          • "OPTIMISTIC_CONCURRENCY"
          • "LAMBDA"
          • "AUTOMERGE"
          • "NONE"
        • conflictDetection — (String)

          The Conflict Detection strategy to use.

          • VERSION: Detect conflicts based on object versions for this resolver.

          • NONE: Do not detect conflicts when invoking this resolver.

          Possible values include:
          • "VERSION"
          • "NONE"
        • lambdaConflictHandlerConfig — (map)

          The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

          • lambdaConflictHandlerArn — (String)

            The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

      • maxBatchSize — (Integer)

        The maximum batching size for a resolver.

      • runtime — (map)

        Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

        • name — required — (String)

          The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.

          Possible values include:
          • "APPSYNC_JS"
        • runtimeVersion — required — (String)

          The version of the runtime to use. Currently, the only allowed version is 1.0.0.

      • code — (String)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  authenticationType: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDA, /* required */
  name: 'STRING_VALUE', /* required */
  additionalAuthenticationProviders: [
    {
      authenticationType: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDA,
      lambdaAuthorizerConfig: {
        authorizerUri: 'STRING_VALUE', /* required */
        authorizerResultTtlInSeconds: 'NUMBER_VALUE',
        identityValidationExpression: 'STRING_VALUE'
      },
      openIDConnectConfig: {
        issuer: 'STRING_VALUE', /* required */
        authTTL: 'NUMBER_VALUE',
        clientId: 'STRING_VALUE',
        iatTTL: 'NUMBER_VALUE'
      },
      userPoolConfig: {
        awsRegion: 'STRING_VALUE', /* required */
        userPoolId: 'STRING_VALUE', /* required */
        appIdClientRegex: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  apiType: GRAPHQL | MERGED,
  enhancedMetricsConfig: {
    dataSourceLevelMetricsBehavior: FULL_REQUEST_DATA_SOURCE_METRICS | PER_DATA_SOURCE_METRICS, /* required */
    operationLevelMetricsConfig: ENABLED | DISABLED, /* required */
    resolverLevelMetricsBehavior: FULL_REQUEST_RESOLVER_METRICS | PER_RESOLVER_METRICS /* required */
  },
  introspectionConfig: ENABLED | DISABLED,
  lambdaAuthorizerConfig: {
    authorizerUri: 'STRING_VALUE', /* required */
    authorizerResultTtlInSeconds: 'NUMBER_VALUE',
    identityValidationExpression: 'STRING_VALUE'
  },
  logConfig: {
    cloudWatchLogsRoleArn: 'STRING_VALUE', /* required */
    fieldLogLevel: NONE | ERROR | ALL | INFO | DEBUG, /* required */
    excludeVerboseContent: true || false
  },
  mergedApiExecutionRoleArn: 'STRING_VALUE',
  openIDConnectConfig: {
    issuer: 'STRING_VALUE', /* required */
    authTTL: 'NUMBER_VALUE',
    clientId: 'STRING_VALUE',
    iatTTL: 'NUMBER_VALUE'
  },
  ownerContact: 'STRING_VALUE',
  queryDepthLimit: 'NUMBER_VALUE',
  resolverCountLimit: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  userPoolConfig: {
    awsRegion: 'STRING_VALUE', /* required */
    defaultAction: ALLOW | DENY, /* required */
    userPoolId: 'STRING_VALUE', /* required */
    appIdClientRegex: 'STRING_VALUE'
  },
  visibility: GLOBAL | PRIVATE,
  xrayEnabled: true || false
};
appsync.createGraphqlApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    A user-supplied name for the GraphqlApi.

  • logConfig — (map)

    The Amazon CloudWatch Logs configuration.

    • fieldLogLevel — required — (String)

      The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

      • NONE: No field-level logs are captured.

      • ERROR: Logs the following information only for the fields that are in the error category:

        • The error section in the server response.

        • Field-level errors.

        • The generated request/response functions that got resolved for error fields.

      • INFO: Logs the following information only for the fields that are in the info and error categories:

        • Info-level messages.

        • The user messages sent through $util.log.info and console.log.

        • Field-level tracing and mapping logs are not shown.

      • DEBUG: Logs the following information only for the fields that are in the debug, info, and error categories:

        • Debug-level messages.

        • The user messages sent through $util.log.info, $util.log.debug, console.log, and console.debug.

        • Field-level tracing and mapping logs are not shown.

      • ALL: The following information is logged for all fields in the query:

        • Field-level tracing information.

        • The generated request/response functions that were resolved for each field.

      Possible values include:
      • "NONE"
      • "ERROR"
      • "ALL"
      • "INFO"
      • "DEBUG"
    • cloudWatchLogsRoleArn — required — (String)

      The service role that AppSync assumes to publish to CloudWatch logs in your account.

    • excludeVerboseContent — (Boolean)

      Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

  • authenticationType — (String)

    The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

    Possible values include:
    • "API_KEY"
    • "AWS_IAM"
    • "AMAZON_COGNITO_USER_POOLS"
    • "OPENID_CONNECT"
    • "AWS_LAMBDA"
  • userPoolConfig — (map)

    The Amazon Cognito user pool configuration.

    • userPoolId — required — (String)

      The user pool ID.

    • awsRegion — required — (String)

      The Amazon Web Services Region in which the user pool was created.

    • defaultAction — required — (String)

      The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

      Possible values include:
      • "ALLOW"
      • "DENY"
    • appIdClientRegex — (String)

      A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

  • openIDConnectConfig — (map)

    The OIDC configuration.

    • issuer — required — (String)

      The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

    • clientId — (String)

      The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

    • iatTTL — (Integer)

      The number of milliseconds that a token is valid after it's issued to a user.

    • authTTL — (Integer)

      The number of milliseconds that a token is valid after being authenticated.

  • tags — (map<String>)

    A TagMap object.

  • additionalAuthenticationProviders — (Array<map>)

    A list of additional authentication providers for the GraphqlApi API.

    • authenticationType — (String)

      The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

      Possible values include:
      • "API_KEY"
      • "AWS_IAM"
      • "AMAZON_COGNITO_USER_POOLS"
      • "OPENID_CONNECT"
      • "AWS_LAMBDA"
    • openIDConnectConfig — (map)

      The OIDC configuration.

      • issuer — required — (String)

        The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

      • clientId — (String)

        The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

      • iatTTL — (Integer)

        The number of milliseconds that a token is valid after it's issued to a user.

      • authTTL — (Integer)

        The number of milliseconds that a token is valid after being authenticated.

    • userPoolConfig — (map)

      The Amazon Cognito user pool configuration.

      • userPoolId — required — (String)

        The user pool ID.

      • awsRegion — required — (String)

        The Amazon Web Services Region in which the user pool was created.

      • appIdClientRegex — (String)

        A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

    • lambdaAuthorizerConfig — (map)

      Configuration for Lambda function authorization.

      • authorizerResultTtlInSeconds — (Integer)

        The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

      • authorizerUri — required — (String)

        The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

        Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

        aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

      • identityValidationExpression — (String)

        A regular expression for validation of tokens before the Lambda function is called.

  • xrayEnabled — (Boolean)

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

  • lambdaAuthorizerConfig — (map)

    Configuration for Lambda function authorization.

    • authorizerResultTtlInSeconds — (Integer)

      The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

    • authorizerUri — required — (String)

      The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

      Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

      aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

    • identityValidationExpression — (String)

      A regular expression for validation of tokens before the Lambda function is called.

  • visibility — (String)

    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.

    Possible values include:
    • "GLOBAL"
    • "PRIVATE"
  • apiType — (String)

    The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

    Possible values include:
    • "GRAPHQL"
    • "MERGED"
  • mergedApiExecutionRoleArn — (String)

    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.

  • ownerContact — (String)

    The owner contact information for an API resource.

    This field accepts any string input with a length of 0 - 256 characters.

  • introspectionConfig — (String)

    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.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • queryDepthLimit — (Integer)

    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.

  • resolverCountLimit — (Integer)

    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.

  • enhancedMetricsConfig — (map)

    The enhancedMetricsConfig object.

    • resolverLevelMetricsBehavior — required — (String)

      Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

      • GraphQL errors: The number of GraphQL errors that occurred.

      • Requests: The number of invocations that occurred during a request.

      • Latency: The time to complete a resolver invocation.

      • Cache hits: The number of cache hits during a request.

      • Cache misses: The number of cache misses during a request.

      These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:

      • FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the request.

      • PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED.

      Possible values include:
      • "FULL_REQUEST_RESOLVER_METRICS"
      • "PER_RESOLVER_METRICS"
    • dataSourceLevelMetricsBehavior — required — (String)

      Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

      • Requests: The number of invocations that occured during a request.

      • Latency: The time to complete a data source invocation.

      • Errors: The number of errors that occurred during a data source invocation.

      These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:

      • FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources in the request.

      • PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the metricsConfig value set to ENABLED.

      Possible values include:
      • "FULL_REQUEST_DATA_SOURCE_METRICS"
      • "PER_DATA_SOURCE_METRICS"
    • operationLevelMetricsConfig — required — (String)

      Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

      • Requests: The number of times a specified GraphQL operation was called.

      • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.

      Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or DISABLED.

      Possible values include:
      • "ENABLED"
      • "DISABLED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • graphqlApi — (map)

      The GraphqlApi.

      • name — (String)

        The API name.

      • apiId — (String)

        The API ID.

      • authenticationType — (String)

        The authentication type.

        Possible values include:
        • "API_KEY"
        • "AWS_IAM"
        • "AMAZON_COGNITO_USER_POOLS"
        • "OPENID_CONNECT"
        • "AWS_LAMBDA"
      • logConfig — (map)

        The Amazon CloudWatch Logs configuration.

        • fieldLogLevel — required — (String)

          The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

          • NONE: No field-level logs are captured.

          • ERROR: Logs the following information only for the fields that are in the error category:

            • The error section in the server response.

            • Field-level errors.

            • The generated request/response functions that got resolved for error fields.

          • INFO: Logs the following information only for the fields that are in the info and error categories:

            • Info-level messages.

            • The user messages sent through $util.log.info and console.log.

            • Field-level tracing and mapping logs are not shown.

          • DEBUG: Logs the following information only for the fields that are in the debug, info, and error categories:

            • Debug-level messages.

            • The user messages sent through $util.log.info, $util.log.debug, console.log, and console.debug.

            • Field-level tracing and mapping logs are not shown.

          • ALL: The following information is logged for all fields in the query:

            • Field-level tracing information.

            • The generated request/response functions that were resolved for each field.

          Possible values include:
          • "NONE"
          • "ERROR"
          • "ALL"
          • "INFO"
          • "DEBUG"
        • cloudWatchLogsRoleArn — required — (String)

          The service role that AppSync assumes to publish to CloudWatch logs in your account.

        • excludeVerboseContent — (Boolean)

          Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

      • userPoolConfig — (map)

        The Amazon Cognito user pool configuration.

        • userPoolId — required — (String)

          The user pool ID.

        • awsRegion — required — (String)

          The Amazon Web Services Region in which the user pool was created.

        • defaultAction — required — (String)

          The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

          Possible values include:
          • "ALLOW"
          • "DENY"
        • appIdClientRegex — (String)

          A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

      • openIDConnectConfig — (map)

        The OpenID Connect configuration.

        • issuer — required — (String)

          The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

        • clientId — (String)

          The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

        • iatTTL — (Integer)

          The number of milliseconds that a token is valid after it's issued to a user.

        • authTTL — (Integer)

          The number of milliseconds that a token is valid after being authenticated.

      • arn — (String)

        The Amazon Resource Name (ARN).

      • uris — (map<String>)

        The URIs.

      • tags — (map<String>)

        The tags.

      • additionalAuthenticationProviders — (Array<map>)

        A list of additional authentication providers for the GraphqlApi API.

        • authenticationType — (String)

          The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

          Possible values include:
          • "API_KEY"
          • "AWS_IAM"
          • "AMAZON_COGNITO_USER_POOLS"
          • "OPENID_CONNECT"
          • "AWS_LAMBDA"
        • openIDConnectConfig — (map)

          The OIDC configuration.

          • issuer — required — (String)

            The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

          • clientId — (String)

            The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

          • iatTTL — (Integer)

            The number of milliseconds that a token is valid after it's issued to a user.

          • authTTL — (Integer)

            The number of milliseconds that a token is valid after being authenticated.

        • userPoolConfig — (map)

          The Amazon Cognito user pool configuration.

          • userPoolId — required — (String)

            The user pool ID.

          • awsRegion — required — (String)

            The Amazon Web Services Region in which the user pool was created.

          • appIdClientRegex — (String)

            A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

        • lambdaAuthorizerConfig — (map)

          Configuration for Lambda function authorization.

          • authorizerResultTtlInSeconds — (Integer)

            The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

          • authorizerUri — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

            Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

            aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

          • identityValidationExpression — (String)

            A regular expression for validation of tokens before the Lambda function is called.

      • xrayEnabled — (Boolean)

        A flag indicating whether to use X-Ray tracing for this GraphqlApi.

      • wafWebAclArn — (String)

        The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

      • lambdaAuthorizerConfig — (map)

        Configuration for Lambda function authorization.

        • authorizerResultTtlInSeconds — (Integer)

          The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

        • authorizerUri — required — (String)

          The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

          Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

          aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

        • identityValidationExpression — (String)

          A regular expression for validation of tokens before the Lambda function is called.

      • dns — (map<String>)

        The DNS records for the API.

      • visibility — (String)

        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.

        Possible values include:
        • "GLOBAL"
        • "PRIVATE"
      • apiType — (String)

        The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

        Possible values include:
        • "GRAPHQL"
        • "MERGED"
      • mergedApiExecutionRoleArn — (String)

        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.

      • owner — (String)

        The account owner of the GraphQL API.

      • ownerContact — (String)

        The owner contact information for an API resource.

        This field accepts any string input with a length of 0 - 256 characters.

      • introspectionConfig — (String)

        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.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • queryDepthLimit — (Integer)

        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.

      • resolverCountLimit — (Integer)

        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.

      • enhancedMetricsConfig — (map)

        The enhancedMetricsConfig object.

        • resolverLevelMetricsBehavior — required — (String)

          Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

          • GraphQL errors: The number of GraphQL errors that occurred.

          • Requests: The number of invocations that occurred during a request.

          • Latency: The time to complete a resolver invocation.

          • Cache hits: The number of cache hits during a request.

          • Cache misses: The number of cache misses during a request.

          These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:

          • FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the request.

          • PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED.

          Possible values include:
          • "FULL_REQUEST_RESOLVER_METRICS"
          • "PER_RESOLVER_METRICS"
        • dataSourceLevelMetricsBehavior — required — (String)

          Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

          • Requests: The number of invocations that occured during a request.

          • Latency: The time to complete a data source invocation.

          • Errors: The number of errors that occurred during a data source invocation.

          These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:

          • FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources in the request.

          • PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the metricsConfig value set to ENABLED.

          Possible values include:
          • "FULL_REQUEST_DATA_SOURCE_METRICS"
          • "PER_DATA_SOURCE_METRICS"
        • operationLevelMetricsConfig — required — (String)

          Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

          • Requests: The number of times a specified GraphQL operation was called.

          • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.

          Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or DISABLED.

          Possible values include:
          • "ENABLED"
          • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  fieldName: 'STRING_VALUE', /* required */
  typeName: 'STRING_VALUE', /* required */
  cachingConfig: {
    ttl: 'NUMBER_VALUE', /* required */
    cachingKeys: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  code: 'STRING_VALUE',
  dataSourceName: 'STRING_VALUE',
  kind: UNIT | PIPELINE,
  maxBatchSize: 'NUMBER_VALUE',
  metricsConfig: ENABLED | DISABLED,
  pipelineConfig: {
    functions: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  requestMappingTemplate: 'STRING_VALUE',
  responseMappingTemplate: 'STRING_VALUE',
  runtime: {
    name: APPSYNC_JS, /* required */
    runtimeVersion: 'STRING_VALUE' /* required */
  },
  syncConfig: {
    conflictDetection: VERSION | NONE,
    conflictHandler: OPTIMISTIC_CONCURRENCY | LAMBDA | AUTOMERGE | NONE,
    lambdaConflictHandlerConfig: {
      lambdaConflictHandlerArn: 'STRING_VALUE'
    }
  }
};
appsync.createResolver(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The ID for the GraphQL API for which the resolver is being created.

  • typeName — (String)

    The name of the Type.

  • fieldName — (String)

    The name of the field to attach the resolver to.

  • dataSourceName — (String)

    The name of the data source for which the resolver is being created.

  • requestMappingTemplate — (String)

    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 Lambda data source. For all other data sources, VTL request and response mapping templates are required.

  • responseMappingTemplate — (String)

    The mapping template to use for responses from the data source.

  • kind — (String)

    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.

    Possible values include:
    • "UNIT"
    • "PIPELINE"
  • pipelineConfig — (map)

    The PipelineConfig.

    • functions — (Array<String>)

      A list of Function objects.

  • syncConfig — (map)

    The SyncConfig for a resolver attached to a versioned data source.

    • conflictHandler — (String)

      The Conflict Resolution strategy to perform in the event of a conflict.

      • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.

      • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.

      • LAMBDA: Resolve conflicts with an Lambda function supplied in the LambdaConflictHandlerConfig.

      Possible values include:
      • "OPTIMISTIC_CONCURRENCY"
      • "LAMBDA"
      • "AUTOMERGE"
      • "NONE"
    • conflictDetection — (String)

      The Conflict Detection strategy to use.

      • VERSION: Detect conflicts based on object versions for this resolver.

      • NONE: Do not detect conflicts when invoking this resolver.

      Possible values include:
      • "VERSION"
      • "NONE"
    • lambdaConflictHandlerConfig — (map)

      The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

      • lambdaConflictHandlerArn — (String)

        The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

  • cachingConfig — (map)

    The caching configuration for the resolver.

    • ttl — required — (Integer)

      The TTL in seconds for a resolver that has caching activated.

      Valid values are 1–3,600 seconds.

    • cachingKeys — (Array<String>)

      The caching keys for a resolver that has caching activated.

      Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.

  • maxBatchSize — (Integer)

    The maximum batching size for a resolver.

  • runtime — (map)

    Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

    • name — required — (String)

      The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.

      Possible values include:
      • "APPSYNC_JS"
    • runtimeVersion — required — (String)

      The version of the runtime to use. Currently, the only allowed version is 1.0.0.

  • code — (String)

    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.

  • metricsConfig — (String)

    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.

    Possible values include:
    • "ENABLED"
    • "DISABLED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • resolver — (map)

      The Resolver object.

      • typeName — (String)

        The resolver type name.

      • fieldName — (String)

        The resolver field name.

      • dataSourceName — (String)

        The resolver data source name.

      • resolverArn — (String)

        The resolver Amazon Resource Name (ARN).

      • requestMappingTemplate — (String)

        The request mapping template.

      • responseMappingTemplate — (String)

        The response mapping template.

      • kind — (String)

        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.

        Possible values include:
        • "UNIT"
        • "PIPELINE"
      • pipelineConfig — (map)

        The PipelineConfig.

        • functions — (Array<String>)

          A list of Function objects.

      • syncConfig — (map)

        The SyncConfig for a resolver attached to a versioned data source.

        • conflictHandler — (String)

          The Conflict Resolution strategy to perform in the event of a conflict.

          • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.

          • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.

          • LAMBDA: Resolve conflicts with an Lambda function supplied in the LambdaConflictHandlerConfig.

          Possible values include:
          • "OPTIMISTIC_CONCURRENCY"
          • "LAMBDA"
          • "AUTOMERGE"
          • "NONE"
        • conflictDetection — (String)

          The Conflict Detection strategy to use.

          • VERSION: Detect conflicts based on object versions for this resolver.

          • NONE: Do not detect conflicts when invoking this resolver.

          Possible values include:
          • "VERSION"
          • "NONE"
        • lambdaConflictHandlerConfig — (map)

          The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

          • lambdaConflictHandlerArn — (String)

            The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

      • cachingConfig — (map)

        The caching configuration for the resolver.

        • ttl — required — (Integer)

          The TTL in seconds for a resolver that has caching activated.

          Valid values are 1–3,600 seconds.

        • cachingKeys — (Array<String>)

          The caching keys for a resolver that has caching activated.

          Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.

      • maxBatchSize — (Integer)

        The maximum batching size for a resolver.

      • runtime — (map)

        Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

        • name — required — (String)

          The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.

          Possible values include:
          • "APPSYNC_JS"
        • runtimeVersion — required — (String)

          The version of the runtime to use. Currently, the only allowed version is 1.0.0.

      • code — (String)

        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.

      • metricsConfig — (String)

        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.

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  definition: 'STRING_VALUE', /* required */
  format: SDL | JSON /* required */
};
appsync.createType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

  • definition — (String)

    The type definition, in GraphQL Schema Definition Language (SDL) format.

    For more information, see the GraphQL SDL documentation.

  • format — (String)

    The type format: SDL or JSON.

    Possible values include:
    • "SDL"
    • "JSON"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • type — (map)

      The Type object.

      • name — (String)

        The type name.

      • description — (String)

        The type description.

      • arn — (String)

        The type Amazon Resource Name (ARN).

      • definition — (String)

        The type definition.

      • format — (String)

        The type format: SDL or JSON.

        Possible values include:
        • "SDL"
        • "JSON"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE' /* required */
};
appsync.deleteApiCache(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE' /* required */
};
appsync.deleteApiKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

  • id — (String)

    The ID for the API key.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
appsync.deleteDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

  • name — (String)

    The name of the data source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domainName: 'STRING_VALUE' /* required */
};
appsync.deleteDomainName(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domainName — (String)

    The domain name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  functionId: 'STRING_VALUE' /* required */
};
appsync.deleteFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The GraphQL API ID.

  • functionId — (String)

    The Function ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE' /* required */
};
appsync.deleteGraphqlApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  fieldName: 'STRING_VALUE', /* required */
  typeName: 'STRING_VALUE' /* required */
};
appsync.deleteResolver(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

  • typeName — (String)

    The name of the resolver type.

  • fieldName — (String)

    The resolver field name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  typeName: 'STRING_VALUE' /* required */
};
appsync.deleteType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

  • typeName — (String)

    The type name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domainName: 'STRING_VALUE' /* required */
};
appsync.disassociateApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domainName — (String)

    The domain name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  associationId: 'STRING_VALUE', /* required */
  sourceApiIdentifier: 'STRING_VALUE' /* required */
};
appsync.disassociateMergedGraphqlApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • sourceApiIdentifier — (String)

    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.

  • associationId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sourceApiAssociationStatus — (String)

      The state of the source API association.

      Possible values include:
      • "MERGE_SCHEDULED"
      • "MERGE_FAILED"
      • "MERGE_SUCCESS"
      • "MERGE_IN_PROGRESS"
      • "AUTO_MERGE_SCHEDULE_FAILED"
      • "DELETION_SCHEDULED"
      • "DELETION_IN_PROGRESS"
      • "DELETION_FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  associationId: 'STRING_VALUE', /* required */
  mergedApiIdentifier: 'STRING_VALUE' /* required */
};
appsync.disassociateSourceGraphqlApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • mergedApiIdentifier — (String)

    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.

  • associationId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sourceApiAssociationStatus — (String)

      The state of the source API association.

      Possible values include:
      • "MERGE_SCHEDULED"
      • "MERGE_FAILED"
      • "MERGE_SUCCESS"
      • "MERGE_IN_PROGRESS"
      • "AUTO_MERGE_SCHEDULE_FAILED"
      • "DELETION_SCHEDULED"
      • "DELETION_IN_PROGRESS"
      • "DELETION_FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  code: 'STRING_VALUE', /* required */
  context: 'STRING_VALUE', /* required */
  runtime: { /* required */
    name: APPSYNC_JS, /* required */
    runtimeVersion: 'STRING_VALUE' /* required */
  },
  function: 'STRING_VALUE'
};
appsync.evaluateCode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • runtime — (map)

    The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is supported.

    • name — required — (String)

      The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.

      Possible values include:
      • "APPSYNC_JS"
    • runtimeVersion — required — (String)

      The version of the runtime to use. Currently, the only allowed version is 1.0.0.

  • code — (String)

    The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_JS.

  • context — (String)

    The map that holds all of the contextual information for your resolver invocation. A context is required for this action.

  • function — (String)

    The function within the code to be evaluated. If provided, the valid values are request and response.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • evaluationResult — (String)

      The result of the evaluation operation.

    • error — (map)

      Contains the payload of the response error.

      • message — (String)

        The error payload.

      • codeErrors — (Array<map>)

        Contains the list of CodeError objects.

        • errorType — (String)

          The type of code error.

          Examples include, but aren't limited to: LINT_ERROR, PARSER_ERROR.

        • value — (String)

          A user presentable error.

          Examples include, but aren't limited to: Parsing error: Unterminated string literal.

        • location — (map)

          The line, column, and span location of the error in the code.

          • line — (Integer)

            The line number in the code. Defaults to 0 if unknown.

          • column — (Integer)

            The column number in the code. Defaults to 0 if unknown.

          • span — (Integer)

            The span/length of the error. Defaults to -1 if unknown.

    • logs — (Array<String>)

      A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  context: 'STRING_VALUE', /* required */
  template: 'STRING_VALUE' /* required */
};
appsync.evaluateMappingTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • template — (String)

    The mapping template; this can be a request or response template. A template is required for this action.

  • context — (String)

    The map that holds all of the contextual information for your resolver invocation. A context is required for this action.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • evaluationResult — (String)

      The mapping template; this can be a request or response template.

    • error — (map)

      The ErrorDetail object.

      • message — (String)

        The error payload.

    • logs — (Array<String>)

      A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE' /* required */
};
appsync.flushApiCache(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domainName: 'STRING_VALUE' /* required */
};
appsync.getApiAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domainName — (String)

    The domain name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • apiAssociation — (map)

      The ApiAssociation object.

      • domainName — (String)

        The domain name.

      • apiId — (String)

        The API ID.

      • associationStatus — (String)

        Identifies the status of an association.

        • PROCESSING: The API association is being created. You cannot modify association requests during processing.

        • SUCCESS: The API association was successful. You can modify associations after success.

        • FAILED: The API association has failed. You can modify associations after failure.

        Possible values include:
        • "PROCESSING"
        • "FAILED"
        • "SUCCESS"
      • deploymentDetail — (String)

        Details about the last deployment status.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE' /* required */
};
appsync.getApiCache(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • apiCache — (map)

      The ApiCache object.

      • ttl — (Integer)

        TTL in seconds for cache entries.

        Valid values are 1–3,600 seconds.

      • apiCachingBehavior — (String)

        Caching behavior.

        • FULL_REQUEST_CACHING: All requests are fully cached.

        • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

        Possible values include:
        • "FULL_REQUEST_CACHING"
        • "PER_RESOLVER_CACHING"
      • transitEncryptionEnabled — (Boolean)

        Transit encryption flag when connecting to cache. You cannot update this setting after creation.

      • atRestEncryptionEnabled — (Boolean)

        At-rest encryption flag for cache. You cannot update this setting after creation.

      • type — (String)

        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_SMALL: A t2.small instance type.

        • T2_MEDIUM: A t2.medium instance type.

        • R4_LARGE: A r4.large instance type.

        • R4_XLARGE: A r4.xlarge instance type.

        • R4_2XLARGE: A r4.2xlarge instance type.

        • R4_4XLARGE: A r4.4xlarge instance type.

        • R4_8XLARGE: A r4.8xlarge instance type.

        Possible values include:
        • "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"
      • status — (String)

        The cache instance status.

        • AVAILABLE: The instance is available for use.

        • CREATING: The instance is currently creating.

        • DELETING: The instance is currently deleting.

        • MODIFYING: The instance is currently modifying.

        • FAILED: The instance has failed creation.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "DELETING"
        • "MODIFYING"
        • "FAILED"
      • healthMetricsConfig — (String)

        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.

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE' /* required */
};
appsync.getDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID.

  • name — (String)

    The name of the data source.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • dataSource — (map)

      The DataSource object.

      • dataSourceArn — (String)

        The data source Amazon Resource Name (ARN).

      • name — (String)

        The name of the data source.

      • description — (String)

        The description of the data source.

      • type — (String)

        The type of the data source.

        • AWS_LAMBDA: The data source is an Lambda function.

        • AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.

        • AMAZON_ELASTICSEARCH: The data source is an Amazon OpenSearch Service domain.

        • AMAZON_OPENSEARCH_SERVICE: The data source is an Amazon OpenSearch Service domain.

        • AMAZON_EVENTBRIDGE: The data source is an Amazon EventBridge configuration.

        • NONE: There is no data source. Use this type when you want to invoke a GraphQL operation without connecting to a data source, such as when you're performing data transformation with resolvers or invoking a subscription from a mutation.

        • HTTP: The data source is an HTTP endpoint.

        • RELATIONAL_DATABASE: The data source is a relational database.

        Possible values include:
        • "AWS_LAMBDA"
        • "AMAZON_DYNAMODB"
        • "AMAZON_ELASTICSEARCH"
        • "NONE"
        • "HTTP"
        • "RELATIONAL_DATABASE"
        • "AMAZON_OPENSEARCH_SERVICE"
        • "AMAZON_EVENTBRIDGE"
      • serviceRoleArn — (String)

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

      • dynamodbConfig — (map)

        DynamoDB settings.

        • tableName — required — (String)

          The table name.

        • awsRegion — required — (String)

          The Amazon Web Services Region.

        • useCallerCredentials — (Boolean)

          Set to TRUE to use Amazon Cognito credentials with this data source.

        • deltaSyncConfig — (map)

          The DeltaSyncConfig for a versioned data source.

          • baseTableTTL — (Integer)

            The number of minutes that an Item is stored in the data source.

          • deltaSyncTableName — (String)

            The Delta Sync table name.

          • deltaSyncTableTTL — (Integer)

            The number of minutes that a Delta Sync log entry is stored in the Delta Sync table.

        • versioned — (Boolean)

          Set to TRUE to use Conflict Detection and Resolution with this data source.

      • lambdaConfig — (map)

        Lambda settings.

        • lambdaFunctionArn — required — (String)

          The Amazon Resource Name (ARN) for the Lambda function.

      • elasticsearchConfig — (map)

        Amazon OpenSearch Service settings.

        • endpoint — required — (String)

          The endpoint.

        • awsRegion — required — (String)

          The Amazon Web Services Region.

      • openSearchServiceConfig — (map)

        Amazon OpenSearch Service settings.

        • endpoint — required — (String)

          The endpoint.

        • awsRegion — required — (String)

          The Amazon Web Services Region.

      • httpConfig — (map)

        HTTP endpoint settings.

        • endpoint — (String)

          The HTTP URL endpoint. You can specify either the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If you don't specify the port, AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

        • authorizationConfig — (map)

          The authorization configuration in case the HTTP endpoint requires authorization.

          • authorizationType — required — (String)

            The authorization type that the HTTP endpoint requires.

            • AWS_IAM: The authorization type is Signature Version 4 (SigV4).

            Possible values include:
            • "AWS_IAM"
          • awsIamConfig — (map)

            The Identity and Access Management (IAM) settings.

            • signingRegion — (String)

              The signing Amazon Web Services Region for IAM authorization.

            • signingServiceName — (String)

              The signing service name for IAM authorization.

      • relationalDatabaseConfig — (map)

        Relational database settings.

        • relationalDatabaseSourceType — (String)

          Source type for the relational database.

          • RDS_HTTP_ENDPOINT: The relational database source type is an Amazon Relational Database Service (Amazon RDS) HTTP endpoint.

          Possible values include:
          • "RDS_HTTP_ENDPOINT"
        • rdsHttpEndpointConfig — (map)

          Amazon RDS HTTP endpoint settings.

          • awsRegion — (String)

            Amazon Web Services Region for Amazon RDS HTTP endpoint.

          • dbClusterIdentifier — (String)

            Amazon RDS cluster Amazon Resource Name (ARN).

          • databaseName — (String)

            Logical database name.

          • schema — (String)

            Logical schema name.

          • awsSecretStoreArn — (String)

            Amazon Web Services secret store Amazon Resource Name (ARN) for database credentials.

      • eventBridgeConfig — (map)

        Amazon EventBridge settings.

        • eventBusArn — required — (String)

          The ARN of the event bus. For more information about event buses, see Amazon EventBridge event buses.

      • metricsConfig — (String)

        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.

        Possible values include:
        • "ENABLED"
        • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  introspectionId: 'STRING_VALUE', /* required */
  includeModelsSDL: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
appsync.getDataSourceIntrospection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • introspectionId — (String)

    The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

  • includeModelsSDL — (Boolean)

    A boolean flag that determines whether SDL should be generated for introspected types or not. 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.

  • nextToken — (String)

    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.

  • maxResults — (Integer)

    The maximum number of introspected types that will be returned in a single response.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • introspectionId — (String)

      The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

    • introspectionStatus — (String)

      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.

      Possible values include:
      • "PROCESSING"
      • "FAILED"
      • "SUCCESS"
    • introspectionStatusDetail — (String)

      The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

    • introspectionResult — (map)

      The DataSourceIntrospectionResult object data.

      • models — (Array<map>)

        The array of DataSourceIntrospectionModel objects.

        • name — (String)

          The name of the model. For example, this could be the name of a single table in a database.

        • fields — (Array<map>)

          The DataSourceIntrospectionModelField object data.

          • name — (String)

            The name of the field that was retrieved from the introspected data.

          • type — (map)

            The DataSourceIntrospectionModelFieldType object data.

            • kind — (String)

              Specifies the classification of data. For example, this could be set to values like Scalar or NonNull to indicate a fundamental property of the field.

              Valid values include:

              • Scalar: Indicates the value is a primitive type (scalar).

              • NonNull: Indicates the field cannot be null.

              • List: Indicates the field contains a list.

            • name — (String)

              The name of the data type that represents the field. For example, String is a valid name value.

            • values — (Array<String>)

              The values of the type field. This field represents the AppSync data type equivalent of the introspected field.

          • length — (Integer)

            The length value of the introspected field.

        • primaryKey — (map)

          The primary key stored as a DataSourceIntrospectionModelIndex object.

          • name — (String)

            The name of the index.

          • fields — (Array<String>)

            The fields of the index.

        • indexes — (Array<map>)

          The array of DataSourceIntrospectionModelIndex objects.

          • name — (String)

            The name of the index.

          • fields — (Array<String>)

            The fields of the index.

        • sdl — (String)

          Contains the output of the SDL that was generated from the introspected types. This is controlled by the includeModelsSDL parameter of the GetDataSourceIntrospection operation.

      • nextToken — (String)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  domainName: 'STRING_VALUE' /* required */
};
appsync.getDomainName(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • domainName — (String)

    The domain name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • domainNameConfig — (map)

      The configuration for the DomainName.

      • domainName — (String)

        The domain name.

      • description — (String)

        A description of the DomainName configuration.

      • certificateArn — (String)

        The Amazon Resource Name (ARN) of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate.

      • appsyncDomainName — (String)

        The domain name that AppSync provides.

      • hostedZoneId — (String)

        The ID of your Amazon Route 53 hosted zone.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE', /* required */
  functionId: 'STRING_VALUE' /* required */
};
appsync.getFunction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The GraphQL API ID.

  • functionId — (String)

    The Function ID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • functionConfiguration — (map)

      The Function object.

      • functionId — (String)

        A unique ID representing the Function object.

      • functionArn — (String)

        The Amazon Resource Name (ARN) of the Function object.

      • name — (String)

        The name of the Function object.

      • description — (String)

        The Function description.

      • dataSourceName — (String)

        The name of the DataSource.

      • requestMappingTemplate — (String)

        The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

      • responseMappingTemplate — (String)

        The Function response mapping template.

      • functionVersion — (String)

        The version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.

      • syncConfig — (map)

        Describes a Sync configuration for a resolver.

        Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.

        • conflictHandler — (String)

          The Conflict Resolution strategy to perform in the event of a conflict.

          • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.

          • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.

          • LAMBDA: Resolve conflicts with an Lambda function supplied in the LambdaConflictHandlerConfig.

          Possible values include:
          • "OPTIMISTIC_CONCURRENCY"
          • "LAMBDA"
          • "AUTOMERGE"
          • "NONE"
        • conflictDetection — (String)

          The Conflict Detection strategy to use.

          • VERSION: Detect conflicts based on object versions for this resolver.

          • NONE: Do not detect conflicts when invoking this resolver.

          Possible values include:
          • "VERSION"
          • "NONE"
        • lambdaConflictHandlerConfig — (map)

          The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

          • lambdaConflictHandlerArn — (String)

            The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

      • maxBatchSize — (Integer)

        The maximum batching size for a resolver.

      • runtime — (map)

        Describes a runtime used by an Amazon Web Services AppSync pipeline resolver or Amazon Web Services AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.

        • name — required — (String)

          The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.

          Possible values include:
          • "APPSYNC_JS"
        • runtimeVersion — required — (String)

          The version of the runtime to use. Currently, the only allowed version is 1.0.0.

      • code — (String)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  apiId: 'STRING_VALUE' /* required */
};
appsync.getGraphqlApi(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • apiId — (String)

    The API ID for the GraphQL API.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • graphqlApi — (map)

      The GraphqlApi object.

      • name — (String)

        The API name.

      • apiId — (String)

        The API ID.

      • authenticationType — (String)

        The authentication type.

        Possible values include:
        • "API_KEY"
        • "AWS_IAM"
        • "AMAZON_COGNITO_USER_POOLS"
        • "OPENID_CONNECT"
        • "AWS_LAMBDA"
      • logConfig — (map)

        The Amazon CloudWatch Logs configuration.

        • fieldLogLevel — required — (String)

          The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

          • NONE: No field-level logs are captured.

          • ERROR: Logs the following information only for the fields that are in the error category:

            • The error section in the server response.

            • Field-level errors.

            • The generated request/response functions that got resolved for error fields.

          • INFO: Logs the following information only for the fields that are in the info and error categories:

            • Info-level messages.

            • The user messages sent through $util.log.info and console.log.

            • Field-level tracing and mapping logs are not shown.

          • DEBUG: Logs the following information only for the fields that are in the debug, info, and error categories:

            • Debug-level messages.

            • The user messages sent through $util.log.info, $util.log.debug, console.log, and console.debug.

            • Field-level tracing and mapping logs are not shown.

          • ALL: The following information is logged for all fields in the query:

            • Field-level tracing information.

            • The generated request/response functions that were resolved for each field.

          Possible values include:
          • "NONE"
          • "ERROR"
          • "ALL"
          • "INFO"
          • "DEBUG"
        • cloudWatchLogsRoleArn — required — (String)

          The service role that AppSync assumes to publish to CloudWatch logs in your account.

        • excludeVerboseContent — (Boolean)

          Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

      • userPoolConfig — (map)

        The Amazon Cognito user pool configuration.

        • userPoolId — required — (String)

          The user pool ID.

        • awsRegion — required — (String)

          The Amazon Web Services Region in which the user pool was created.

        • defaultAction — required — (String)

          The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

          Possible values include:
          • "ALLOW"
          • "DENY"
        • appIdClientRegex — (String)

          A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

      • openIDConnectConfig — (map)

        The OpenID Connect configuration.

        • issuer — required — (String)

          The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

        • clientId — (String)

          The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

        • iatTTL — (Integer)

          The number of milliseconds that a token is valid after it's issued to a user.

        • authTTL — (Integer)

          The number of milliseconds that a token is valid after being authenticated.

      • arn — (String)

        The Amazon Resource Name (ARN).

      • uris — (map<String>)

        The URIs.

      • tags — (map<String>)

        The tags.

      • additionalAuthenticationProviders — (Array<map>)

        A list of additional authentication providers for the GraphqlApi API.

        • authenticationType — (String)

          The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

          Possible values include:
          • "API_KEY"
          • "AWS_IAM"
          • "AMAZON_COGNITO_USER_POOLS"
          • "OPENID_CONNECT"
          • "AWS_LAMBDA"
        • openIDConnectConfig — (map)

          The OIDC configuration.

          • issuer — required — (String)

            The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

          • clientId — (String)

            The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

          • iatTTL — (Integer)

            The number of milliseconds that a token is valid after it's issued to a user.

          • authTTL — (Integer)

            The number of milliseconds that a token is valid after being authenticated.

        • userPoolConfig — (map)

          The Amazon Cognito user pool configuration.

          • userPoolId — required — (String)

            The user pool ID.

          • awsRegion — required — (String)

            The Amazon Web Services Region in which the user pool was created.

          • appIdClientRegex — (String)

            A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

        • lambdaAuthorizerConfig — (map)

          Configuration for Lambda function authorization.

          • authorizerResultTtlInSeconds — (Integer)

            The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

          • authorizerUri — required — (String)

            The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

            Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

            aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

          • identityValidationExpression — (String)

            A regular expression for validation of tokens before the Lambda function is called.

      • xrayEnabled — (Boolean)

        A flag indicating whether to use X-Ray tracing for this GraphqlApi.

      • wafWebAclArn — (String)

        The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

      • lambdaAuthorizerConfig — (map)

        Configuration for Lambda function authorization.

        • authorizerResultTtlInSeconds — (Integer)

          The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

        • authorizerUri — required — (String)

          The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

          Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

          aws lambda add-permission --function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" --statement-id "appsync" --principal appsync.amazonaws.com --action lambda:InvokeFunction

        • identityValidationExpression — (String)

          A regular expression for validation of tokens before the Lambda function is called.

      • dns — (map<String>)

        The DNS records for the API.

      • visibility — (String)

        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.

        Possible values include:
        • "GLOBAL"
        • "PRIVATE"
      • apiType — (String)

        The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

        Possible values include:
        • "GRAPHQL"
        • "MERGED"
      • mergedApiExecutionRoleArn — (String)

        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.

      • owner — (String)

        The account owner of the GraphQL API.

      • ownerContact — (String)

        The owner contact information for an API resource.

        This field accepts any string input with a length of 0 - 256 characters.

      • introspectionConfig — (String)

        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.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • queryDepthLimit — (Integer)

        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.

      • resolverCountLimit — (Integer)

        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.

      • enhancedMetricsConfig — (map)

        The enhancedMetricsConfig object.

        • resolverLevelMetricsBehavior — required — (String)

          Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

          • GraphQL errors: The number of GraphQL errors that occurred.

          • Requests: The number of invocations that occurred during a request.

          • Latency: The time to complete a resolver invocation.

          • Cache hits: The number of cache hits during a request.

          • Cache misses: The number of cache misses during a request.

          These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:

          • FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the request.

          • PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED.

          Possible values include:
          • "FULL_REQUEST_RESOLVER_METRICS"
          • "PER_RESOLVER_METRICS"
        • dataSourceLevelMetricsBehavior — required — (String)

          Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

          • Requests: The number of invocations that occured during a request.

          • Latency: The time to complete a data source invocation.

          • Errors: The number of errors that occurred during a data source invocation.

          These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:

          • FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources in the request.

          • PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the metricsConfig value set to ENABLED.

          Possible values include:
          • "FULL_REQUEST_DATA_SOURCE_METRICS"
          • "PER_DATA_SOURCE_METRICS"
        • operationLevelMetricsConfig — required — (String)

          Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

          • Requests: The number of times a specified GraphQL operation was called.

          • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.

          Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or DISABLED.

          Possible values include:
          • "ENABLED"
          • "DISABLED"