diff --git a/codegen/sdk-codegen/aws-models/appsync.json b/codegen/sdk-codegen/aws-models/appsync.json index 8b30eca4a3e..925e9273fe0 100644 --- a/codegen/sdk-codegen/aws-models/appsync.json +++ b/codegen/sdk-codegen/aws-models/appsync.json @@ -2250,7 +2250,7 @@ "healthMetricsConfig": { "target": "com.amazonaws.appsync#CacheHealthMetricsConfig", "traits": { - "smithy.api#documentation": "
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The number of times a specified GraphQL operation was\n called.
\nEngineCPUUtilization: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID. You can set the value to ENABLED
or\n DISABLED
.
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED
or\n DISABLED
.
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be\n recorded by API ID and resolver name. resolverLevelMetricsBehavior
accepts one of these values at\n a time:
\n FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the\n request.
\n PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have the\n metricConfig
value set to ENABLED
.
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
\nGraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be\n recorded by API ID and resolver name. resolverLevelMetricsBehavior
accepts one of these values at\n a time:
\n FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the\n request.
\n PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have the\n metricsConfig
value set to ENABLED
.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics\n will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
accepts one of\n these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources\n in the request.
\n PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have the\n metricConfig
value set to ENABLED
.
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
\nRequests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics\n will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
accepts one of\n these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources\n in the request.
\n PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have the\n metricsConfig
value set to ENABLED
.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and\n performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data\n is sent to your CloudWatch account, and you can configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig
contains three required parameters, each controlling one of these\n categories:
\n resolverLevelMetricsBehavior
: Controls how resolver metrics will be emitted to\n CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics\n will be recorded by API ID and resolver name. resolverLevelMetricsBehavior
accepts one of\n these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers\n in the request.
\n PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have the\n metricConfig
value set to ENABLED
.
\n dataSourceLevelMetricsBehavior
: Controls how data source metrics will be emitted to\n CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request.\n Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
\n accepts one of these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data\n sources in the request.
\n PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that\n have the metricConfig
value set to ENABLED
.
\n operationLevelMetricsConfig
: Controls how operation metrics will be emitted to\n CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED
\n or DISABLED
.
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and\n performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data\n is sent to your CloudWatch account, and you can configure the types of data that will be sent.
\nEnhanced metrics can be configured at the resolver, data source, and operation levels.\n EnhancedMetricsConfig
contains three required parameters, each controlling one of these\n categories:
\n resolverLevelMetricsBehavior
: Controls how resolver metrics will be emitted to\n CloudWatch. Resolver metrics include:
GraphQL errors: The number of GraphQL errors that occurred.
\nRequests: The number of invocations that occurred during a request.
\nLatency: The time to complete a resolver invocation.
\nCache hits: The number of cache hits during a request.
\nCache misses: The number of cache misses during a request.
\nThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics\n will be recorded by API ID and resolver name. resolverLevelMetricsBehavior
accepts one of\n these values at a time:
\n FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers\n in the request.
\n PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have the\n metricsConfig
value set to ENABLED
.
\n dataSourceLevelMetricsBehavior
: Controls how data source metrics will be emitted to\n CloudWatch. Data source metrics include:
Requests: The number of invocations that occured during a request.
\nLatency: The time to complete a data source invocation.
\nErrors: The number of errors that occurred during a data source invocation.
\nThese metrics can be emitted to CloudWatch per data source or for all data sources in the request.\n Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
\n accepts one of these values at a time:
\n FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data\n sources in the request.
\n PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that\n have the metricsConfig
value set to ENABLED
.
\n operationLevelMetricsConfig
: Controls how operation metrics will be emitted to\n CloudWatch. Operation metrics include:
Requests: The number of times a specified GraphQL operation was called.
\nGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID and operation name. You can set the value to ENABLED
\n or DISABLED
.
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The number of times a specified GraphQL operation was\n called.
\nEngineCPUUtilization: The number of GraphQL errors that occurred during a specified GraphQL\n operation.
\nMetrics will be recorded by API ID. You can set the value to ENABLED
or\n DISABLED
.
Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:
\nNetworkBandwidthOutAllowanceExceeded: The network packets dropped because the throughput exceeded\n the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache\n configuration.
\nEngineCPUUtilization: The CPU utilization (percentage) allocated to the Redis process. This is\n useful for diagnosing bottlenecks in a cache configuration.
\nMetrics will be recorded by API ID. You can set the value to ENABLED
or\n DISABLED
.
Information about the encryption of data at rest in the ledger. This includes the\n current status, the KMS key, and when the key became inaccessible (in the case of an\n error).
" + "smithy.api#documentation": "Information about the encryption of data at rest in the ledger. This includes the\n current status, the KMS key, and when the key became inaccessible (in the case of an\n error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.
" } } }, @@ -1997,7 +1997,7 @@ "KmsKeyArn": { "target": "com.amazonaws.qldb#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for\n encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key\n for encryption.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for\n encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key\n for encryption. It will display AWS_OWNED_KMS_KEY
when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.
The name of the DB shard group.
" } @@ -11048,6 +11048,16 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.rds#DBShardGroupIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$" + } + }, "com.amazonaws.rds#DBShardGroupNotFoundFault": { "type": "structure", "members": { @@ -12588,7 +12598,7 @@ "type": "structure", "members": { "DBShardGroupIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBShardGroupIdentifier", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Teh name of the DB shard group to delete.
", @@ -15744,7 +15754,7 @@ "type": "structure", "members": { "DBShardGroupIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBShardGroupIdentifier", "traits": { "smithy.api#documentation": "The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. If this parameter is specified, \n information for only the specific DB shard group is returned. This parameter isn't case-sensitive.
\nConstraints:
\nIf supplied, must match an existing DB shard group identifier.
\nThe name of the DB shard group to modify.
", @@ -25288,7 +25298,7 @@ "type": "structure", "members": { "DBShardGroupIdentifier": { - "target": "com.amazonaws.rds#String", + "target": "com.amazonaws.rds#DBShardGroupIdentifier", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The name of the DB shard group to reboot.
", diff --git a/codegen/sdk-codegen/aws-models/rum.json b/codegen/sdk-codegen/aws-models/rum.json index b37fa1da48e..eb9793f243b 100644 --- a/codegen/sdk-codegen/aws-models/rum.json +++ b/codegen/sdk-codegen/aws-models/rum.json @@ -122,7 +122,7 @@ "GuestRoleArn": { "target": "com.amazonaws.rum#Arn", "traits": { - "smithy.api#documentation": "The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool \n that is used to authorize the sending of data to RUM.
" + "smithy.api#documentation": "The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool \n that is used to authorize the sending of data to RUM.
\nIt is possible that an app monitor does not have a value for GuestRoleArn
. For example, \n this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to \n create a new identity pool for Authorization. In this case, GuestRoleArn
is not present in the \n GetAppMonitor\n response because it is not stored by the service.
If this issue affects you, you can take one of the following steps:
\nUse the Cloud Development Kit (CDK) to create an identity pool and the associated IAM\n role, and use that for your app monitor.
\nMake a separate GetIdentityPoolRoles\n call to Amazon Cognito to retrieve \n the GuestRoleArn
.
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid\n destinations include CloudWatch and Evidently.
\nBy default, RUM app monitors send some metrics to CloudWatch. These default metrics\n are listed in CloudWatch metrics that you can collect \n with CloudWatch RUM.
\nIn addition to these default metrics, you can choose to send extended metrics or custom metrics or both.
\nExtended metrics enable you to send metrics with additional dimensions not included \n in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch. \n The valid dimension names for the additional dimensions for extended metrics are\n BrowserName
, CountryCode
, DeviceType
,\n FileType
, OSName
, and PageId
. For more information, see \n \n Extended metrics that you can send to CloudWatch and CloudWatch Evidently.
Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or\n to CloudWatch Evidently or to both. With custom metrics, \n you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events, \n custom attributes, or default attributes.
\nYou can't send custom metrics to the AWS/RUM
namespace. You must send custom metrics to a \n custom namespace that you define. The namespace that you use can't start with AWS/
. \n CloudWatch RUM prepends RUM/CustomMetrics/
to the custom namespace that you define, \n so the final namespace for your metrics in CloudWatch is \n RUM/CustomMetrics/your-custom-namespace\n
.
The maximum number of metric definitions that you can specify in one \n BatchCreateRumMetricDefinitions
operation is 200.
The maximum number of metric definitions that one destination can contain is 2000.
\nExtended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension\n value counts as a custom metric. For more information, see \n Amazon CloudWatch Pricing.
\nYou must have\n already created a destination for the metrics before you send them. For more information, see \n PutRumMetricsDestination.
\nIf some metric definitions specified in a BatchCreateRumMetricDefinitions
operations are not valid,\n those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.
Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid\n destinations include CloudWatch and Evidently.
\nBy default, RUM app monitors send some metrics to CloudWatch. These default metrics\n are listed in CloudWatch metrics that you can collect \n with CloudWatch RUM.
\nIn addition to these default metrics, you can choose to send extended metrics, custom\n metrics, or both.
\nExtended metrics let you send metrics with additional dimensions that aren't included in the\n default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended\n metrics are BrowserName
, CountryCode
,\n DeviceType
, FileType
, OSName
, and\n PageId
. For more information, see \n Extended metrics that you can send to CloudWatch and CloudWatch\n Evidently.
Custom metrics are metrics that you define. You can send custom metrics to CloudWatch.\n CloudWatch Evidently, or both. With custom metrics, you can use any metric\n name and namespace. To derive the metrics, you can use any custom events, built-in\n events, custom attributes, or default attributes.
\nYou can't send custom metrics to the AWS/RUM
namespace. You must send custom metrics to a \n custom namespace that you define. The namespace that you use can't start with AWS/
. \n CloudWatch RUM prepends RUM/CustomMetrics/
to the custom namespace that you define, \n so the final namespace for your metrics in CloudWatch is \n RUM/CustomMetrics/your-custom-namespace\n
.
The maximum number of metric definitions that you can specify in one \n BatchCreateRumMetricDefinitions
operation is 200.
The maximum number of metric definitions that one destination can contain is 2000.
\nExtended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension\n value counts as a custom metric. For more information, see \n Amazon CloudWatch Pricing.
\nYou must have\n already created a destination for the metrics before you send them. For more information, see \n PutRumMetricsDestination.
\nIf some metric definitions specified in a BatchCreateRumMetricDefinitions
operations are not valid,\n those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.
The destination to send the metrics to. Valid values are CloudWatch
and Evidently
. If\n you specify Evidently
, you must also specify the ARN of the CloudWatchEvidently experiment \n that will receive\n the metrics and an IAM role that has permission to write to the experiment.
The destination to send the metrics to. Valid values are CloudWatch
and\n Evidently
. If you specify Evidently
, you must also specify the\n Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive\n the metrics and an IAM role that has permission to write to the\n experiment.
A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration
, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.
If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.
" + "smithy.api#documentation": "A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration
, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.
If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.
" } }, "CwLogEnabled": { @@ -1588,7 +1588,7 @@ "ValueKey": { "target": "com.amazonaws.rum#ValueKey", "traits": { - "smithy.api#documentation": "The field within the event object that the metric value is sourced from.
\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you\n just want to count the number of events that the filter catches.
\nIf this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently \n will handle data extraction from the event.
" + "smithy.api#documentation": "The field within the event object that the metric value is sourced from.
\nIf you omit this field, a hardcoded value of 1 is pushed as the metric value. This is\n useful if you want to count the number of events that the filter catches.
\nIf this metric is sent to CloudWatch Evidently, this field will be passed to\n Evidently raw. Evidently will handle data extraction from the event.
" } }, "UnitLabel": { @@ -1606,7 +1606,7 @@ "EventPattern": { "target": "com.amazonaws.rum#EventPattern", "traits": { - "smithy.api#documentation": "The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session\n against the pattern, and events that match the pattern are sent to the metric destination.
\nWhen you define extended metrics, the metric definition is not valid if EventPattern
\n is omitted.
Example event patterns:
\n\n '{\n \"event_type\": [\"com.amazon.rum.js_error_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ], } }'
\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Firefox\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \"<\", 2000 ]\n }]\n }\n }'
\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ],\n \"countryCode\": [ \"US\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \">=\", 2000, \"<\", 8000 ]\n }]\n }\n }'
\n
If the metrics destination'\n is CloudWatch
and the event\n also matches a value in DimensionKeys
, then the metric is published with the specified dimensions.
The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session\n against the pattern, and events that match the pattern are sent to the metric destination.
\nWhen you define extended metrics, the metric definition is not valid if EventPattern
\n is omitted.
Example event patterns:
\n\n '{\n \"event_type\": [\"com.amazon.rum.js_error_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ], } }'
\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Firefox\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \"<\", 2000 ]\n }]\n }\n }'
\n
\n '{\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"metadata\": {\n \"browserName\": [ \"Chrome\", \"Safari\" ],\n \"countryCode\": [ \"US\" ]\n },\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [ \">=\", 2000, \"<\", 8000 ]\n }]\n }\n }'
\n
If the metrics destination is CloudWatch
and the event also matches a value\n in DimensionKeys
, then the metric is published with the specified dimensions.
Use this structure to define one extended metric or custom metric that RUM will send\n to CloudWatch or CloudWatch Evidently. For more information, see \n \n Additional metrics that you can send to CloudWatch and CloudWatch Evidently.
\nThis structure is validated differently for extended metrics and custom metrics. For extended metrics\n that are sent to the AWS/RUM
namespace, the following validations apply:
The Namespace
parameter must be omitted or set to AWS/RUM
.
Only certain combinations of values for Name
, ValueKey
, and EventPattern
\n are valid. In addition to what is displayed in the list below, the EventPattern
can also include information\n used by the DimensionKeys
field.
If Name
is PerformanceNavigationDuration
, then\n ValueKey
must be event_details.duration
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.performance_navigation_event\"]}
\n
If Name
is PerformanceResourceDuration
, then\n ValueKey
must be event_details.duration
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.performance_resource_event\"]}
\n
If Name
is NavigationSatisfiedTransaction
, then\n ValueKey
must be null and the EventPattern
\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">\",2000]\n }]\n }\n }
\n
If Name
is NavigationToleratedTransaction
, then\n ValueKey
must be null and the EventPattern
\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",2000,\"<\"8000]\n }]\n }\n }
\n
If Name
is NavigationFrustratedTransaction
, then\n ValueKey
must be null and the EventPattern
\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",8000]\n }]\n }\n }
\n
If Name
is WebVitalsCumulativeLayoutShift
, then\n ValueKey
must be event_details.value
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.cumulative_layout_shift_event\"]}
\n
If Name
is WebVitalsFirstInputDelay
, then\n ValueKey
must be event_details.value
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.first_input_delay_event\"]}
\n
If Name
is WebVitalsLargestContentfulPaint
, then\n ValueKey
must be event_details.value
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.largest_contentful_paint_event\"]}
\n
If Name
is JsErrorCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.js_error_event\"]}
\n
If Name
is HttpErrorCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.http_event\"]}
\n
If Name
is SessionCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.session_start_event\"]}
\n
For custom metrics, the following validation rules apply:
\nThe namespace can't be omitted and can't be AWS/RUM
. You can use the AWS/RUM
\n namespace only for extended metrics.
All dimensions listed in the DimensionKeys
field must be present in the value\n of EventPattern
.
The values that you specify for ValueKey
, EventPattern
, and \n DimensionKeys
must be fields in RUM events, so all first-level keys in these fields must \n be one of the keys in the list later in this section.
If you set a value for EventPattern
, it must be a JSON object.
For every non-empty event_details
, there must be a non-empty event_type
.
If EventPattern
contains an event_details
field, \n it must also contain an event_type
. For every built-in event_type
that you use, you must use \n a value for event_details
that corresponds to that\n event_type
. For information about event details that correspond to event types, see \n \n RUM event details.
In EventPattern
, any JSON array must contain only one value.
Valid key values for first-level keys in the ValueKey
, EventPattern
, and \n DimensionKeys
fields:
\n account_id
\n
\n application_Id
\n
\n application_version
\n
\n application_name
\n
\n batch_id
\n
\n event_details
\n
\n event_id
\n
\n event_interaction
\n
\n event_timestamp
\n
\n event_type
\n
\n event_version
\n
\n log_stream
\n
\n metadata
\n
\n sessionId
\n
\n user_details
\n
\n userId
\n
Use this structure to define one extended metric or custom metric that RUM will send\n to CloudWatch or CloudWatch Evidently. For more information, see \n \n Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently.
\nThis structure is validated differently for extended metrics and custom metrics. For extended metrics\n that are sent to the AWS/RUM
namespace, the following validations apply:
The Namespace
parameter must be omitted or set to AWS/RUM
.
Only certain combinations of values for Name
, ValueKey
, and\n EventPattern
are valid. In addition to what is displayed in the\n following list, the EventPattern
can also include information used by\n the DimensionKeys
field.
If Name
is PerformanceNavigationDuration
, then\n ValueKey
must be event_details.duration
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.performance_navigation_event\"]}
\n
If Name
is PerformanceResourceDuration
, then\n ValueKey
must be event_details.duration
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.performance_resource_event\"]}
\n
If Name
is NavigationSatisfiedTransaction
, then\n ValueKey
must be null and the EventPattern
\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">\",2000]\n }]\n }\n }
\n
If Name
is NavigationToleratedTransaction
, then\n ValueKey
must be null and the EventPattern
\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",2000,\"<\"8000]\n }]\n }\n }
\n
If Name
is NavigationFrustratedTransaction
, then\n ValueKey
must be null and the EventPattern
\n must include {\n \"event_type\": [\"com.amazon.rum.performance_navigation_event\"],\n \"event_details\": {\n \"duration\": [{\n \"numeric\": [\">=\",8000]\n }]\n }\n }
\n
If Name
is WebVitalsCumulativeLayoutShift
, then\n ValueKey
must be event_details.value
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.cumulative_layout_shift_event\"]}
\n
If Name
is WebVitalsFirstInputDelay
, then\n ValueKey
must be event_details.value
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.first_input_delay_event\"]}
\n
If Name
is WebVitalsLargestContentfulPaint
, then\n ValueKey
must be event_details.value
and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.largest_contentful_paint_event\"]}
\n
If Name
is JsErrorCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.js_error_event\"]}
\n
If Name
is HttpErrorCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.http_event\"]}
\n
If Name
is SessionCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.session_start_event\"]}
\n
If Name
is PageViewCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\":[\"com.amazon.rum.page_view_event\"]}
\n
If Name
is Http4xxCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\": [\"com.amazon.rum.http_event\"],\"event_details\":{\"response\":{\"status\":[{\"numeric\":[\">=\",400,\"<\",500]}]}}} }
\n
If Name
is Http5xxCount
, then\n ValueKey
must be null and the EventPattern
\n must include {\"event_type\": [\"com.amazon.rum.http_event\"],\"event_details\":{\"response\":{\"status\":[{\"numeric\":[\">=\",500,\"<=\",599]}]}}} }
\n
For custom metrics, the following validation rules apply:
\nThe namespace can't be omitted and can't be AWS/RUM
. You can use the AWS/RUM
\n namespace only for extended metrics.
All dimensions listed in the DimensionKeys
field must be present in the value\n of EventPattern
.
The values that you specify for ValueKey
, EventPattern
, and \n DimensionKeys
must be fields in RUM events, so all first-level keys in these fields must \n be one of the keys in the list later in this section.
If you set a value for EventPattern
, it must be a JSON object.
For every non-empty event_details
, there must be a non-empty event_type
.
If EventPattern
contains an event_details
field, \n it must also contain an event_type
. For every built-in event_type
that you use, you must use \n a value for event_details
that corresponds to that\n event_type
. For information about event details that correspond to event types, see \n \n RUM event details.
In EventPattern
, any JSON array must contain only one value.
Valid key values for first-level keys in the ValueKey
, EventPattern
, and \n DimensionKeys
fields:
\n account_id
\n
\n application_Id
\n
\n application_version
\n
\n application_name
\n
\n batch_id
\n
\n event_details
\n
\n event_id
\n
\n event_interaction
\n
\n event_timestamp
\n
\n event_type
\n
\n event_version
\n
\n log_stream
\n
\n metadata
\n
\n sessionId
\n
\n user_details
\n
\n userId
\n
This parameter is required if Destination
is Evidently
. If Destination
is \n CloudWatch
, do not use this parameter.
This parameter specifies\n the ARN of an IAM role that RUM will assume to write to the Evidently \n experiment that you are sending metrics to. This role must have permission to write to that experiment.
" + "smithy.api#documentation": "This parameter is required if Destination
is Evidently
. If Destination
is \n CloudWatch
, don't use this parameter.
This parameter specifies\n the ARN of an IAM role that RUM will assume to write to the Evidently \n experiment that you are sending metrics to. This role must have permission to write to that experiment.
\nIf you specify this parameter, you must be signed on to a role that has PassRole permissions attached to it, to allow\n the role to be passed. The \n CloudWatchAmazonCloudWatchRUMFullAccess\n policy doesn't include PassRole
\n permissions.
A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration
, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.
A structure that contains much of the configuration data for the app monitor. If you are using \n Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the \n Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration
, you must set up your own \n authorization method. For more information, see \n Authorize your application\n to send data to Amazon Web Services.