aws-sdk-appsync 1.71.0 → 1.73.0

data/lib/aws-sdk-appsync/types.rb

@@ -173,6 +173,23 @@ module Aws::AppSync
     #   * **FAILED**: The instance has failed creation.
     #   @return [String]
     #
+    # @!attribute [rw] health_metrics_config
+    #   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`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/ApiCache AWS API Documentation
     #
     class ApiCache < Struct.new(
@@ -181,7 +198,8 @@ module Aws::AppSync
       :transit_encryption_enabled,
       :at_rest_encryption_enabled,
       :type,
-      :status)
+      :status,
+      :health_metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -727,6 +745,20 @@ module Aws::AppSync
     #   * **R4\_8XLARGE**: A r4.8xlarge instance type.
     #   @return [String]
     #
+    # @!attribute [rw] health_metrics_config
+    #   Controls how cache health metrics will be emitted to CloudWatch.
+    #   Cache health metrics include:
+    #
+    #   * NetworkBandwidthOutAllowanceExceeded: The number of times a
+    #     specified GraphQL operation was called.
+    #
+    #   * EngineCPUUtilization: The number of GraphQL errors that occurred
+    #     during a specified GraphQL operation.
+    #
+    #   Metrics will be recorded by API ID. You can set the value to
+    #   `ENABLED` or `DISABLED`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateApiCacheRequest AWS API Documentation
     #
     class CreateApiCacheRequest < Struct.new(
@@ -735,7 +767,8 @@ module Aws::AppSync
       :transit_encryption_enabled,
       :at_rest_encryption_enabled,
       :api_caching_behavior,
-      :type)
+      :type,
+      :health_metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -846,6 +879,18 @@ module Aws::AppSync
     #   Amazon EventBridge settings.
     #   @return [Types::EventBridgeDataSourceConfig]
     #
+    # @!attribute [rw] metrics_config
+    #   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`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateDataSourceRequest AWS API Documentation
     #
     class CreateDataSourceRequest < Struct.new(
@@ -860,7 +905,8 @@ module Aws::AppSync
       :open_search_service_config,
       :http_config,
       :relational_database_config,
-      :event_bridge_config)
+      :event_bridge_config,
+      :metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1099,6 +1145,10 @@ module Aws::AppSync
     #   operation falls out of bounds.
     #   @return [Integer]
     #
+    # @!attribute [rw] enhanced_metrics_config
+    #   The `enhancedMetricsConfig` object.
+    #   @return [Types::EnhancedMetricsConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateGraphqlApiRequest AWS API Documentation
     #
     class CreateGraphqlApiRequest < Struct.new(
@@ -1117,7 +1167,8 @@ module Aws::AppSync
       :owner_contact,
       :introspection_config,
       :query_depth_limit,
-      :resolver_count_limit)
+      :resolver_count_limit,
+      :enhanced_metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1208,6 +1259,17 @@ module Aws::AppSync
     #   `runtime` value must be `APPSYNC_JS`.
     #   @return [String]
     #
+    # @!attribute [rw] metrics_config
+    #   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`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/CreateResolverRequest AWS API Documentation
     #
     class CreateResolverRequest < Struct.new(
@@ -1223,7 +1285,8 @@ module Aws::AppSync
       :caching_config,
       :max_batch_size,
       :runtime,
-      :code)
+      :code,
+      :metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1356,6 +1419,18 @@ module Aws::AppSync
     #   Amazon EventBridge settings.
     #   @return [Types::EventBridgeDataSourceConfig]
     #
+    # @!attribute [rw] metrics_config
+    #   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`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/DataSource AWS API Documentation
     #
     class DataSource < Struct.new(
@@ -1370,7 +1445,8 @@ module Aws::AppSync
       :open_search_service_config,
       :http_config,
       :relational_database_config,
-      :event_bridge_config)
+      :event_bridge_config,
+      :metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1895,6 +1971,150 @@ module Aws::AppSync
       include Aws::Structure
     end
 
+    # Enables and controls the enhanced metrics feature. Enhanced metrics
+    # emit granular data on API usage and performance such as AppSync
+    # request and error counts, latency, and cache hits/misses. All enhanced
+    # metric data is sent to your CloudWatch account, and you can configure
+    # the types of data that will be sent.
+    #
+    # Enhanced metrics can be configured at the resolver, data source, and
+    # operation levels. `EnhancedMetricsConfig` contains three required
+    # parameters, each controlling one of these categories:
+    #
+    # 1.  `resolverLevelMetricsBehavior`: 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 `metricConfig` value set to `ENABLED`.
+    #
+    # 2.  `dataSourceLevelMetricsBehavior`: 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 `metricConfig` value set to
+    #       `ENABLED`.
+    #
+    # 3.  `operationLevelMetricsConfig`: 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`.
+    #
+    # @!attribute [rw] resolver_level_metrics_behavior
+    #   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 `metricConfig` value set to `ENABLED`.
+    #   @return [String]
+    #
+    # @!attribute [rw] data_source_level_metrics_behavior
+    #   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 `metricConfig` value set to `ENABLED`.
+    #   @return [String]
+    #
+    # @!attribute [rw] operation_level_metrics_config
+    #   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`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/EnhancedMetricsConfig AWS API Documentation
+    #
+    class EnhancedMetricsConfig < Struct.new(
+      :resolver_level_metrics_behavior,
+      :data_source_level_metrics_behavior,
+      :operation_level_metrics_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains the list of errors generated. When using JavaScript, this
     # will apply to the request or response function evaluation.
     #
@@ -2348,6 +2568,32 @@ module Aws::AppSync
       include Aws::Structure
     end
 
+    # @!attribute [rw] api_id
+    #   The ID of the API from which the environmental variable list will be
+    #   retrieved.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetGraphqlApiEnvironmentVariablesRequest AWS API Documentation
+    #
+    class GetGraphqlApiEnvironmentVariablesRequest < Struct.new(
+      :api_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] environment_variables
+    #   The payload containing each environmental variable in the `"key" :
+    #   "value"` format.
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GetGraphqlApiEnvironmentVariablesResponse AWS API Documentation
+    #
+    class GetGraphqlApiEnvironmentVariablesResponse < Struct.new(
+      :environment_variables)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] api_id
     #   The API ID for the GraphQL API.
     #   @return [String]
@@ -2688,6 +2934,10 @@ module Aws::AppSync
     #   operation falls out of bounds.
     #   @return [Integer]
     #
+    # @!attribute [rw] enhanced_metrics_config
+    #   The `enhancedMetricsConfig` object.
+    #   @return [Types::EnhancedMetricsConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/GraphqlApi AWS API Documentation
     #
     class GraphqlApi < Struct.new(
@@ -2712,7 +2962,8 @@ module Aws::AppSync
       :owner_contact,
       :introspection_config,
       :query_depth_limit,
-      :resolver_count_limit)
+      :resolver_count_limit,
+      :enhanced_metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3448,6 +3699,60 @@ module Aws::AppSync
       include Aws::Structure
     end
 
+    # @!attribute [rw] api_id
+    #   The ID of the API to which the environmental variable list will be
+    #   written.
+    #   @return [String]
+    #
+    # @!attribute [rw] environment_variables
+    #   The list of environmental variables to add to the API.
+    #
+    #   When creating an environmental variable key-value pair, it must
+    #   follow the additional constraints below:
+    #
+    #   * Keys must begin with a letter.
+    #
+    #   * Keys must be at least two characters long.
+    #
+    #   * Keys can only contain letters, numbers, and the underscore
+    #     character (\_).
+    #
+    #   * Values can be up to 512 characters long.
+    #
+    #   * You can configure up to 50 key-value pairs in a GraphQL API.
+    #
+    #   You can create a list of environmental variables by adding it to the
+    #   `environmentVariables` payload as a list in the format
+    #   `\{"key1":"value1","key2":"value2", …\}`. Note that each call of the
+    #   `PutGraphqlApiEnvironmentVariables` action will result in the
+    #   overwriting of the existing environmental variable list of that API.
+    #   This means the existing environmental variables will be lost. To
+    #   avoid this, you must include all existing and new environmental
+    #   variables in the list each time you call this action.
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/PutGraphqlApiEnvironmentVariablesRequest AWS API Documentation
+    #
+    class PutGraphqlApiEnvironmentVariablesRequest < Struct.new(
+      :api_id,
+      :environment_variables)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] environment_variables
+    #   The payload containing each environmental variable in the `"key" :
+    #   "value"` format.
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/PutGraphqlApiEnvironmentVariablesResponse AWS API Documentation
+    #
+    class PutGraphqlApiEnvironmentVariablesResponse < Struct.new(
+      :environment_variables)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains the metadata required to introspect the RDS cluster.
     #
     # @!attribute [rw] resource_arn
@@ -3605,6 +3910,17 @@ module Aws::AppSync
     #   `runtime` value must be `APPSYNC_JS`.
     #   @return [String]
     #
+    # @!attribute [rw] metrics_config
+    #   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`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/Resolver AWS API Documentation
     #
     class Resolver < Struct.new(
@@ -3620,7 +3936,8 @@ module Aws::AppSync
       :caching_config,
       :max_batch_size,
       :runtime,
-      :code)
+      :code,
+      :metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4079,13 +4396,28 @@ module Aws::AppSync
     #   * **R4\_8XLARGE**: A r4.8xlarge instance type.
     #   @return [String]
     #
+    # @!attribute [rw] health_metrics_config
+    #   Controls how cache health metrics will be emitted to CloudWatch.
+    #   Cache health metrics include:
+    #
+    #   * NetworkBandwidthOutAllowanceExceeded: The number of times a
+    #     specified GraphQL operation was called.
+    #
+    #   * EngineCPUUtilization: The number of GraphQL errors that occurred
+    #     during a specified GraphQL operation.
+    #
+    #   Metrics will be recorded by API ID. You can set the value to
+    #   `ENABLED` or `DISABLED`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateApiCacheRequest AWS API Documentation
     #
     class UpdateApiCacheRequest < Struct.new(
       :api_id,
       :ttl,
       :api_caching_behavior,
-      :type)
+      :type,
+      :health_metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4198,6 +4530,18 @@ module Aws::AppSync
     #   The new Amazon EventBridge settings.
     #   @return [Types::EventBridgeDataSourceConfig]
     #
+    # @!attribute [rw] metrics_config
+    #   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`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateDataSourceRequest AWS API Documentation
     #
     class UpdateDataSourceRequest < Struct.new(
@@ -4212,7 +4556,8 @@ module Aws::AppSync
       :open_search_service_config,
       :http_config,
       :relational_database_config,
-      :event_bridge_config)
+      :event_bridge_config,
+      :metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4438,6 +4783,10 @@ module Aws::AppSync
     #   operation falls out of bounds.
     #   @return [Integer]
     #
+    # @!attribute [rw] enhanced_metrics_config
+    #   The `enhancedMetricsConfig` object.
+    #   @return [Types::EnhancedMetricsConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateGraphqlApiRequest AWS API Documentation
     #
     class UpdateGraphqlApiRequest < Struct.new(
@@ -4454,7 +4803,8 @@ module Aws::AppSync
       :owner_contact,
       :introspection_config,
       :query_depth_limit,
-      :resolver_count_limit)
+      :resolver_count_limit,
+      :enhanced_metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4545,6 +4895,17 @@ module Aws::AppSync
     #   `runtime` value must be `APPSYNC_JS`.
     #   @return [String]
     #
+    # @!attribute [rw] metrics_config
+    #   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`.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/appsync-2017-07-25/UpdateResolverRequest AWS API Documentation
     #
     class UpdateResolverRequest < Struct.new(
@@ -4560,7 +4921,8 @@ module Aws::AppSync
       :caching_config,
       :max_batch_size,
       :runtime,
-      :code)
+      :code,
+      :metrics_config)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-appsync.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-appsync/customizations'
 # @!group service
 module Aws::AppSync
 
-  GEM_VERSION = '1.71.0'
+  GEM_VERSION = '1.73.0'
 
 end