aws-sdk 2.1236.0 → 2.1237.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -1
- package/README.md +1 -1
- package/apis/devops-guru-2020-12-01.min.json +140 -125
- package/apis/globalaccelerator-2018-08-08.min.json +163 -109
- package/apis/resiliencehub-2020-04-30.min.json +2 -1
- package/apis/rum-2018-05-10.min.json +360 -12
- package/apis/rum-2018-05-10.paginators.json +12 -0
- package/clients/devopsguru.d.ts +26 -4
- package/clients/globalaccelerator.d.ts +60 -3
- package/clients/resiliencehub.d.ts +7 -3
- package/clients/rum.d.ts +340 -5
- package/dist/aws-sdk-core-react-native.js +9 -5
- package/dist/aws-sdk-react-native.js +14 -10
- package/dist/aws-sdk.js +11 -7
- package/dist/aws-sdk.min.js +10 -10
- package/lib/core.js +1 -1
- package/lib/event_listeners.js +7 -4
- package/lib/model/api.js +1 -0
- package/package.json +1 -1
|
@@ -19,6 +19,14 @@ declare class GlobalAccelerator extends Service {
|
|
|
19
19
|
* Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator. The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports. Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException. By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
|
|
20
20
|
*/
|
|
21
21
|
addCustomRoutingEndpoints(callback?: (err: AWSError, data: GlobalAccelerator.Types.AddCustomRoutingEndpointsResponse) => void): Request<GlobalAccelerator.Types.AddCustomRoutingEndpointsResponse, AWSError>;
|
|
22
|
+
/**
|
|
23
|
+
* Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API). There are two advantages to using AddEndpoints to add endpoints: It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding. It's more convenient, because you don't need to specify all of the current endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.
|
|
24
|
+
*/
|
|
25
|
+
addEndpoints(params: GlobalAccelerator.Types.AddEndpointsRequest, callback?: (err: AWSError, data: GlobalAccelerator.Types.AddEndpointsResponse) => void): Request<GlobalAccelerator.Types.AddEndpointsResponse, AWSError>;
|
|
26
|
+
/**
|
|
27
|
+
* Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API). There are two advantages to using AddEndpoints to add endpoints: It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding. It's more convenient, because you don't need to specify all of the current endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.
|
|
28
|
+
*/
|
|
29
|
+
addEndpoints(callback?: (err: AWSError, data: GlobalAccelerator.Types.AddEndpointsResponse) => void): Request<GlobalAccelerator.Types.AddEndpointsResponse, AWSError>;
|
|
22
30
|
/**
|
|
23
31
|
* Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays. To stop advertising the BYOIP address range, use WithdrawByoipCidr. For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
|
|
24
32
|
*/
|
|
@@ -307,6 +315,14 @@ declare class GlobalAccelerator extends Service {
|
|
|
307
315
|
* Remove endpoints from a custom routing accelerator.
|
|
308
316
|
*/
|
|
309
317
|
removeCustomRoutingEndpoints(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
318
|
+
/**
|
|
319
|
+
* Remove endpoints from an endpoint group. The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead: It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group. It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
|
|
320
|
+
*/
|
|
321
|
+
removeEndpoints(params: GlobalAccelerator.Types.RemoveEndpointsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
322
|
+
/**
|
|
323
|
+
* Remove endpoints from an endpoint group. The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead: It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group. It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
|
|
324
|
+
*/
|
|
325
|
+
removeEndpoints(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
310
326
|
/**
|
|
311
327
|
* Add tags to an accelerator resource. For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
|
|
312
328
|
*/
|
|
@@ -411,7 +427,7 @@ declare namespace GlobalAccelerator {
|
|
|
411
427
|
*/
|
|
412
428
|
IpSets?: IpSets;
|
|
413
429
|
/**
|
|
414
|
-
* The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator
|
|
430
|
+
* The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. The naming convention for the DNS name for an accelerator is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses. For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
|
|
415
431
|
*/
|
|
416
432
|
DnsName?: GenericString;
|
|
417
433
|
/**
|
|
@@ -427,7 +443,7 @@ declare namespace GlobalAccelerator {
|
|
|
427
443
|
*/
|
|
428
444
|
LastModifiedTime?: Timestamp;
|
|
429
445
|
/**
|
|
430
|
-
* The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com. Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses. For more information, see Support for DNS
|
|
446
|
+
* The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. The naming convention for the dual-stack DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .dualstack.awsglobalaccelerator.com. For example: a1234567890abcdef.dualstack.awsglobalaccelerator.com. Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses. For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
|
|
431
447
|
*/
|
|
432
448
|
DualStackDnsName?: GenericString;
|
|
433
449
|
/**
|
|
@@ -482,6 +498,26 @@ declare namespace GlobalAccelerator {
|
|
|
482
498
|
*/
|
|
483
499
|
EndpointGroupArn?: GenericString;
|
|
484
500
|
}
|
|
501
|
+
export interface AddEndpointsRequest {
|
|
502
|
+
/**
|
|
503
|
+
* The list of endpoint objects.
|
|
504
|
+
*/
|
|
505
|
+
EndpointConfigurations: EndpointConfigurations;
|
|
506
|
+
/**
|
|
507
|
+
* The Amazon Resource Name (ARN) of the endpoint group.
|
|
508
|
+
*/
|
|
509
|
+
EndpointGroupArn: GenericString;
|
|
510
|
+
}
|
|
511
|
+
export interface AddEndpointsResponse {
|
|
512
|
+
/**
|
|
513
|
+
* The list of endpoint objects.
|
|
514
|
+
*/
|
|
515
|
+
EndpointDescriptions?: EndpointDescriptions;
|
|
516
|
+
/**
|
|
517
|
+
* The Amazon Resource Name (ARN) of the endpoint group.
|
|
518
|
+
*/
|
|
519
|
+
EndpointGroupArn?: GenericString;
|
|
520
|
+
}
|
|
485
521
|
export interface AdvertiseByoipCidrRequest {
|
|
486
522
|
/**
|
|
487
523
|
* The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.
|
|
@@ -764,7 +800,7 @@ declare namespace GlobalAccelerator {
|
|
|
764
800
|
*/
|
|
765
801
|
IpSets?: IpSets;
|
|
766
802
|
/**
|
|
767
|
-
* The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator
|
|
803
|
+
* The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com. If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses. For more information about the default DNS name, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.
|
|
768
804
|
*/
|
|
769
805
|
DnsName?: GenericString;
|
|
770
806
|
/**
|
|
@@ -1157,6 +1193,17 @@ declare namespace GlobalAccelerator {
|
|
|
1157
1193
|
PortOverrides?: PortOverrides;
|
|
1158
1194
|
}
|
|
1159
1195
|
export type EndpointGroups = EndpointGroup[];
|
|
1196
|
+
export interface EndpointIdentifier {
|
|
1197
|
+
/**
|
|
1198
|
+
* An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. An Application Load Balancer can be either internal or internet-facing.
|
|
1199
|
+
*/
|
|
1200
|
+
EndpointId: GenericString;
|
|
1201
|
+
/**
|
|
1202
|
+
* Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the endpoint fronted by the accelerator.
|
|
1203
|
+
*/
|
|
1204
|
+
ClientIPPreservationEnabled?: GenericBoolean;
|
|
1205
|
+
}
|
|
1206
|
+
export type EndpointIdentifiers = EndpointIdentifier[];
|
|
1160
1207
|
export type EndpointIds = GenericString[];
|
|
1161
1208
|
export type EndpointWeight = number;
|
|
1162
1209
|
export type GenericBoolean = boolean;
|
|
@@ -1509,6 +1556,16 @@ declare namespace GlobalAccelerator {
|
|
|
1509
1556
|
*/
|
|
1510
1557
|
EndpointGroupArn: GenericString;
|
|
1511
1558
|
}
|
|
1559
|
+
export interface RemoveEndpointsRequest {
|
|
1560
|
+
/**
|
|
1561
|
+
* The identifiers of the endpoints that you want to remove.
|
|
1562
|
+
*/
|
|
1563
|
+
EndpointIdentifiers: EndpointIdentifiers;
|
|
1564
|
+
/**
|
|
1565
|
+
* The Amazon Resource Name (ARN) of the endpoint group.
|
|
1566
|
+
*/
|
|
1567
|
+
EndpointGroupArn: GenericString;
|
|
1568
|
+
}
|
|
1512
1569
|
export type ResourceArn = string;
|
|
1513
1570
|
export interface SocketAddress {
|
|
1514
1571
|
/**
|
|
@@ -428,7 +428,7 @@ declare namespace Resiliencehub {
|
|
|
428
428
|
*/
|
|
429
429
|
resiliencyScore?: Double;
|
|
430
430
|
/**
|
|
431
|
-
* The status of the
|
|
431
|
+
* The status of the application.
|
|
432
432
|
*/
|
|
433
433
|
status?: AppStatusType;
|
|
434
434
|
/**
|
|
@@ -622,6 +622,10 @@ declare namespace Resiliencehub {
|
|
|
622
622
|
* The current resiliency score for the application.
|
|
623
623
|
*/
|
|
624
624
|
resiliencyScore?: Double;
|
|
625
|
+
/**
|
|
626
|
+
* The status of the application.
|
|
627
|
+
*/
|
|
628
|
+
status?: AppStatusType;
|
|
625
629
|
}
|
|
626
630
|
export type AppSummaryList = AppSummary[];
|
|
627
631
|
export type AppTemplateBody = string;
|
|
@@ -701,7 +705,7 @@ declare namespace Resiliencehub {
|
|
|
701
705
|
suggestedChanges?: SuggestedChangesList;
|
|
702
706
|
}
|
|
703
707
|
export type ConfigRecommendationList = ConfigRecommendation[];
|
|
704
|
-
export type ConfigRecommendationOptimizationType = "LeastCost"|"LeastChange"|"BestAZRecovery"|"LeastErrors"|"BestAttainable"|string;
|
|
708
|
+
export type ConfigRecommendationOptimizationType = "LeastCost"|"LeastChange"|"BestAZRecovery"|"LeastErrors"|"BestAttainable"|"BestRegionRecovery"|string;
|
|
705
709
|
export interface Cost {
|
|
706
710
|
/**
|
|
707
711
|
* The cost amount.
|
|
@@ -2135,7 +2139,7 @@ declare namespace Resiliencehub {
|
|
|
2135
2139
|
*/
|
|
2136
2140
|
dataLocationConstraint?: DataLocationConstraint;
|
|
2137
2141
|
/**
|
|
2138
|
-
* The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
|
|
2142
|
+
* The type of resiliency policy to be created, including the recovery time objective (RTO) and recovery point objective (RPO) in seconds.
|
|
2139
2143
|
*/
|
|
2140
2144
|
policy?: DisruptionPolicy;
|
|
2141
2145
|
/**
|
package/clients/rum.d.ts
CHANGED
|
@@ -11,6 +11,30 @@ declare class RUM extends Service {
|
|
|
11
11
|
*/
|
|
12
12
|
constructor(options?: RUM.Types.ClientConfiguration)
|
|
13
13
|
config: Config & RUM.Types.ClientConfiguration;
|
|
14
|
+
/**
|
|
15
|
+
* Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently. By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM. If you also send extended metrics, you can send metrics to Evidently as well as CloudWatch, and you can also optionally send the metrics with additional dimensions. The valid dimension names for the additional dimensions are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently. The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200. <p>The maximum number of metric definitions that one destination can contain is 2000.</p> <p>Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p> <p>You must have already created a destination for the metrics before you send them. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p> <p>If some metric definitions specified in a <code>BatchCreateRumMetricDefinitions</code> operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.</p>
|
|
16
|
+
*/
|
|
17
|
+
batchCreateRumMetricDefinitions(params: RUM.Types.BatchCreateRumMetricDefinitionsRequest, callback?: (err: AWSError, data: RUM.Types.BatchCreateRumMetricDefinitionsResponse) => void): Request<RUM.Types.BatchCreateRumMetricDefinitionsResponse, AWSError>;
|
|
18
|
+
/**
|
|
19
|
+
* Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid destinations include CloudWatch and Evidently. By default, RUM app monitors send some metrics to CloudWatch. These default metrics are listed in CloudWatch metrics that you can collect with CloudWatch RUM. If you also send extended metrics, you can send metrics to Evidently as well as CloudWatch, and you can also optionally send the metrics with additional dimensions. The valid dimension names for the additional dimensions are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see Extended metrics that you can send to CloudWatch and CloudWatch Evidently. The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200. <p>The maximum number of metric definitions that one destination can contain is 2000.</p> <p>Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p> <p>You must have already created a destination for the metrics before you send them. For more information, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_PutRumMetricsDestination.html">PutRumMetricsDestination</a>.</p> <p>If some metric definitions specified in a <code>BatchCreateRumMetricDefinitions</code> operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.</p>
|
|
20
|
+
*/
|
|
21
|
+
batchCreateRumMetricDefinitions(callback?: (err: AWSError, data: RUM.Types.BatchCreateRumMetricDefinitionsResponse) => void): Request<RUM.Types.BatchCreateRumMetricDefinitionsResponse, AWSError>;
|
|
22
|
+
/**
|
|
23
|
+
* Removes the specified metrics from being sent to an extended metrics destination. If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted. The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.
|
|
24
|
+
*/
|
|
25
|
+
batchDeleteRumMetricDefinitions(params: RUM.Types.BatchDeleteRumMetricDefinitionsRequest, callback?: (err: AWSError, data: RUM.Types.BatchDeleteRumMetricDefinitionsResponse) => void): Request<RUM.Types.BatchDeleteRumMetricDefinitionsResponse, AWSError>;
|
|
26
|
+
/**
|
|
27
|
+
* Removes the specified metrics from being sent to an extended metrics destination. If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted. The maximum number of metric definitions that you can specify in one BatchDeleteRumMetricDefinitions operation is 200.
|
|
28
|
+
*/
|
|
29
|
+
batchDeleteRumMetricDefinitions(callback?: (err: AWSError, data: RUM.Types.BatchDeleteRumMetricDefinitionsResponse) => void): Request<RUM.Types.BatchDeleteRumMetricDefinitionsResponse, AWSError>;
|
|
30
|
+
/**
|
|
31
|
+
* Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
|
|
32
|
+
*/
|
|
33
|
+
batchGetRumMetricDefinitions(params: RUM.Types.BatchGetRumMetricDefinitionsRequest, callback?: (err: AWSError, data: RUM.Types.BatchGetRumMetricDefinitionsResponse) => void): Request<RUM.Types.BatchGetRumMetricDefinitionsResponse, AWSError>;
|
|
34
|
+
/**
|
|
35
|
+
* Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.
|
|
36
|
+
*/
|
|
37
|
+
batchGetRumMetricDefinitions(callback?: (err: AWSError, data: RUM.Types.BatchGetRumMetricDefinitionsResponse) => void): Request<RUM.Types.BatchGetRumMetricDefinitionsResponse, AWSError>;
|
|
14
38
|
/**
|
|
15
39
|
* Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior. You use this operation only to create a new app monitor. To update an existing app monitor, use UpdateAppMonitor instead. After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?
|
|
16
40
|
*/
|
|
@@ -27,6 +51,14 @@ declare class RUM extends Service {
|
|
|
27
51
|
* Deletes an existing app monitor. This immediately stops the collection of data.
|
|
28
52
|
*/
|
|
29
53
|
deleteAppMonitor(callback?: (err: AWSError, data: RUM.Types.DeleteAppMonitorResponse) => void): Request<RUM.Types.DeleteAppMonitorResponse, AWSError>;
|
|
54
|
+
/**
|
|
55
|
+
* Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
|
|
56
|
+
*/
|
|
57
|
+
deleteRumMetricsDestination(params: RUM.Types.DeleteRumMetricsDestinationRequest, callback?: (err: AWSError, data: RUM.Types.DeleteRumMetricsDestinationResponse) => void): Request<RUM.Types.DeleteRumMetricsDestinationResponse, AWSError>;
|
|
58
|
+
/**
|
|
59
|
+
* Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.
|
|
60
|
+
*/
|
|
61
|
+
deleteRumMetricsDestination(callback?: (err: AWSError, data: RUM.Types.DeleteRumMetricsDestinationResponse) => void): Request<RUM.Types.DeleteRumMetricsDestinationResponse, AWSError>;
|
|
30
62
|
/**
|
|
31
63
|
* Retrieves the complete configuration information for one app monitor.
|
|
32
64
|
*/
|
|
@@ -51,6 +83,14 @@ declare class RUM extends Service {
|
|
|
51
83
|
* Returns a list of the Amazon CloudWatch RUM app monitors in the account.
|
|
52
84
|
*/
|
|
53
85
|
listAppMonitors(callback?: (err: AWSError, data: RUM.Types.ListAppMonitorsResponse) => void): Request<RUM.Types.ListAppMonitorsResponse, AWSError>;
|
|
86
|
+
/**
|
|
87
|
+
* Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. For more information about extended metrics, see AddRumMetrics.
|
|
88
|
+
*/
|
|
89
|
+
listRumMetricsDestinations(params: RUM.Types.ListRumMetricsDestinationsRequest, callback?: (err: AWSError, data: RUM.Types.ListRumMetricsDestinationsResponse) => void): Request<RUM.Types.ListRumMetricsDestinationsResponse, AWSError>;
|
|
90
|
+
/**
|
|
91
|
+
* Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. For more information about extended metrics, see AddRumMetrics.
|
|
92
|
+
*/
|
|
93
|
+
listRumMetricsDestinations(callback?: (err: AWSError, data: RUM.Types.ListRumMetricsDestinationsResponse) => void): Request<RUM.Types.ListRumMetricsDestinationsResponse, AWSError>;
|
|
54
94
|
/**
|
|
55
95
|
* Displays the tags associated with a CloudWatch RUM resource.
|
|
56
96
|
*/
|
|
@@ -67,6 +107,14 @@ declare class RUM extends Service {
|
|
|
67
107
|
* Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM. Each PutRumEvents operation can send a batch of events from one user session.
|
|
68
108
|
*/
|
|
69
109
|
putRumEvents(callback?: (err: AWSError, data: RUM.Types.PutRumEventsResponse) => void): Request<RUM.Types.PutRumEventsResponse, AWSError>;
|
|
110
|
+
/**
|
|
111
|
+
* Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment. For more information about extended metrics, see AddRumMetrics.
|
|
112
|
+
*/
|
|
113
|
+
putRumMetricsDestination(params: RUM.Types.PutRumMetricsDestinationRequest, callback?: (err: AWSError, data: RUM.Types.PutRumMetricsDestinationResponse) => void): Request<RUM.Types.PutRumMetricsDestinationResponse, AWSError>;
|
|
114
|
+
/**
|
|
115
|
+
* Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment. For more information about extended metrics, see AddRumMetrics.
|
|
116
|
+
*/
|
|
117
|
+
putRumMetricsDestination(callback?: (err: AWSError, data: RUM.Types.PutRumMetricsDestinationResponse) => void): Request<RUM.Types.PutRumMetricsDestinationResponse, AWSError>;
|
|
70
118
|
/**
|
|
71
119
|
* Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. For more information, see Tagging Amazon Web Services resources.
|
|
72
120
|
*/
|
|
@@ -91,6 +139,14 @@ declare class RUM extends Service {
|
|
|
91
139
|
* Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept. You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use TagResource. To create a new app monitor, use CreateAppMonitor. After you update an app monitor, sign in to the CloudWatch RUM console to get the updated JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?
|
|
92
140
|
*/
|
|
93
141
|
updateAppMonitor(callback?: (err: AWSError, data: RUM.Types.UpdateAppMonitorResponse) => void): Request<RUM.Types.UpdateAppMonitorResponse, AWSError>;
|
|
142
|
+
/**
|
|
143
|
+
* Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.
|
|
144
|
+
*/
|
|
145
|
+
updateRumMetricDefinition(params: RUM.Types.UpdateRumMetricDefinitionRequest, callback?: (err: AWSError, data: RUM.Types.UpdateRumMetricDefinitionResponse) => void): Request<RUM.Types.UpdateRumMetricDefinitionResponse, AWSError>;
|
|
146
|
+
/**
|
|
147
|
+
* Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.
|
|
148
|
+
*/
|
|
149
|
+
updateRumMetricDefinition(callback?: (err: AWSError, data: RUM.Types.UpdateRumMetricDefinitionResponse) => void): Request<RUM.Types.UpdateRumMetricDefinitionResponse, AWSError>;
|
|
94
150
|
}
|
|
95
151
|
declare namespace RUM {
|
|
96
152
|
export interface AppMonitor {
|
|
@@ -145,7 +201,7 @@ declare namespace RUM {
|
|
|
145
201
|
*/
|
|
146
202
|
ExcludedPages?: Pages;
|
|
147
203
|
/**
|
|
148
|
-
* A list of pages in
|
|
204
|
+
* A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
|
|
149
205
|
*/
|
|
150
206
|
FavoritePages?: FavoritePages;
|
|
151
207
|
/**
|
|
@@ -161,7 +217,7 @@ declare namespace RUM {
|
|
|
161
217
|
*/
|
|
162
218
|
IncludedPages?: Pages;
|
|
163
219
|
/**
|
|
164
|
-
* Specifies the
|
|
220
|
+
* Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs. The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled. If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.
|
|
165
221
|
*/
|
|
166
222
|
SessionSampleRate?: SessionSampleRate;
|
|
167
223
|
/**
|
|
@@ -210,6 +266,124 @@ declare namespace RUM {
|
|
|
210
266
|
}
|
|
211
267
|
export type AppMonitorSummaryList = AppMonitorSummary[];
|
|
212
268
|
export type Arn = string;
|
|
269
|
+
export interface BatchCreateRumMetricDefinitionsError {
|
|
270
|
+
/**
|
|
271
|
+
* The error code.
|
|
272
|
+
*/
|
|
273
|
+
ErrorCode: String;
|
|
274
|
+
/**
|
|
275
|
+
* The error message for this metric definition.
|
|
276
|
+
*/
|
|
277
|
+
ErrorMessage: String;
|
|
278
|
+
/**
|
|
279
|
+
* The metric definition that caused this error.
|
|
280
|
+
*/
|
|
281
|
+
MetricDefinition: MetricDefinitionRequest;
|
|
282
|
+
}
|
|
283
|
+
export type BatchCreateRumMetricDefinitionsErrors = BatchCreateRumMetricDefinitionsError[];
|
|
284
|
+
export interface BatchCreateRumMetricDefinitionsRequest {
|
|
285
|
+
/**
|
|
286
|
+
* The name of the CloudWatch RUM app monitor that is to send the metrics.
|
|
287
|
+
*/
|
|
288
|
+
AppMonitorName: AppMonitorName;
|
|
289
|
+
/**
|
|
290
|
+
* The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.
|
|
291
|
+
*/
|
|
292
|
+
Destination: MetricDestination;
|
|
293
|
+
/**
|
|
294
|
+
* This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
|
|
295
|
+
*/
|
|
296
|
+
DestinationArn?: DestinationArn;
|
|
297
|
+
/**
|
|
298
|
+
* An array of structures which define the metrics that you want to send.
|
|
299
|
+
*/
|
|
300
|
+
MetricDefinitions: MetricDefinitionsRequest;
|
|
301
|
+
}
|
|
302
|
+
export interface BatchCreateRumMetricDefinitionsResponse {
|
|
303
|
+
/**
|
|
304
|
+
* An array of error objects, if the operation caused any errors.
|
|
305
|
+
*/
|
|
306
|
+
Errors: BatchCreateRumMetricDefinitionsErrors;
|
|
307
|
+
/**
|
|
308
|
+
* An array of structures that define the extended metrics.
|
|
309
|
+
*/
|
|
310
|
+
MetricDefinitions?: MetricDefinitions;
|
|
311
|
+
}
|
|
312
|
+
export interface BatchDeleteRumMetricDefinitionsError {
|
|
313
|
+
/**
|
|
314
|
+
* The error code.
|
|
315
|
+
*/
|
|
316
|
+
ErrorCode: String;
|
|
317
|
+
/**
|
|
318
|
+
* The error message for this metric definition.
|
|
319
|
+
*/
|
|
320
|
+
ErrorMessage: String;
|
|
321
|
+
/**
|
|
322
|
+
* The ID of the metric definition that caused this error.
|
|
323
|
+
*/
|
|
324
|
+
MetricDefinitionId: MetricDefinitionId;
|
|
325
|
+
}
|
|
326
|
+
export type BatchDeleteRumMetricDefinitionsErrors = BatchDeleteRumMetricDefinitionsError[];
|
|
327
|
+
export interface BatchDeleteRumMetricDefinitionsRequest {
|
|
328
|
+
/**
|
|
329
|
+
* The name of the CloudWatch RUM app monitor that is sending these metrics.
|
|
330
|
+
*/
|
|
331
|
+
AppMonitorName: AppMonitorName;
|
|
332
|
+
/**
|
|
333
|
+
* Defines the destination where you want to stop sending the specified metrics. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
|
|
334
|
+
*/
|
|
335
|
+
Destination: MetricDestination;
|
|
336
|
+
/**
|
|
337
|
+
* This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that was receiving the metrics that are being deleted.
|
|
338
|
+
*/
|
|
339
|
+
DestinationArn?: DestinationArn;
|
|
340
|
+
/**
|
|
341
|
+
* An array of structures which define the metrics that you want to stop sending.
|
|
342
|
+
*/
|
|
343
|
+
MetricDefinitionIds: MetricDefinitionIds;
|
|
344
|
+
}
|
|
345
|
+
export interface BatchDeleteRumMetricDefinitionsResponse {
|
|
346
|
+
/**
|
|
347
|
+
* An array of error objects, if the operation caused any errors.
|
|
348
|
+
*/
|
|
349
|
+
Errors: BatchDeleteRumMetricDefinitionsErrors;
|
|
350
|
+
/**
|
|
351
|
+
* The IDs of the metric definitions that were deleted.
|
|
352
|
+
*/
|
|
353
|
+
MetricDefinitionIds?: MetricDefinitionIds;
|
|
354
|
+
}
|
|
355
|
+
export interface BatchGetRumMetricDefinitionsRequest {
|
|
356
|
+
/**
|
|
357
|
+
* The name of the CloudWatch RUM app monitor that is sending the metrics.
|
|
358
|
+
*/
|
|
359
|
+
AppMonitorName: AppMonitorName;
|
|
360
|
+
/**
|
|
361
|
+
* The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.
|
|
362
|
+
*/
|
|
363
|
+
Destination: MetricDestination;
|
|
364
|
+
/**
|
|
365
|
+
* This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.
|
|
366
|
+
*/
|
|
367
|
+
DestinationArn?: DestinationArn;
|
|
368
|
+
/**
|
|
369
|
+
* The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100. To retrieve the remaining results, make another call with the returned NextToken value.
|
|
370
|
+
*/
|
|
371
|
+
MaxResults?: MaxResultsInteger;
|
|
372
|
+
/**
|
|
373
|
+
* Use the token returned by the previous operation to request the next page of results.
|
|
374
|
+
*/
|
|
375
|
+
NextToken?: String;
|
|
376
|
+
}
|
|
377
|
+
export interface BatchGetRumMetricDefinitionsResponse {
|
|
378
|
+
/**
|
|
379
|
+
* An array of structures that display information about the metrics that are sent by the specified app monitor to the specified destination.
|
|
380
|
+
*/
|
|
381
|
+
MetricDefinitions?: MetricDefinitions;
|
|
382
|
+
/**
|
|
383
|
+
* A token that you can use in a subsequent operation to retrieve the next set of results.
|
|
384
|
+
*/
|
|
385
|
+
NextToken?: String;
|
|
386
|
+
}
|
|
213
387
|
export type Boolean = boolean;
|
|
214
388
|
export interface CreateAppMonitorRequest {
|
|
215
389
|
/**
|
|
@@ -263,8 +437,29 @@ declare namespace RUM {
|
|
|
263
437
|
}
|
|
264
438
|
export interface DeleteAppMonitorResponse {
|
|
265
439
|
}
|
|
440
|
+
export interface DeleteRumMetricsDestinationRequest {
|
|
441
|
+
/**
|
|
442
|
+
* The name of the app monitor that is sending metrics to the destination that you want to delete.
|
|
443
|
+
*/
|
|
444
|
+
AppMonitorName: AppMonitorName;
|
|
445
|
+
/**
|
|
446
|
+
* The type of destination to delete. Valid values are CloudWatch and Evidently.
|
|
447
|
+
*/
|
|
448
|
+
Destination: MetricDestination;
|
|
449
|
+
/**
|
|
450
|
+
* This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that corresponds to the destination to delete.
|
|
451
|
+
*/
|
|
452
|
+
DestinationArn?: DestinationArn;
|
|
453
|
+
}
|
|
454
|
+
export interface DeleteRumMetricsDestinationResponse {
|
|
455
|
+
}
|
|
456
|
+
export type DestinationArn = string;
|
|
457
|
+
export type DimensionKey = string;
|
|
458
|
+
export type DimensionKeysMap = {[key: string]: DimensionName};
|
|
459
|
+
export type DimensionName = string;
|
|
266
460
|
export type EventData = string;
|
|
267
461
|
export type EventDataList = EventData[];
|
|
462
|
+
export type EventPattern = string;
|
|
268
463
|
export type FavoritePages = String[];
|
|
269
464
|
export interface GetAppMonitorDataRequest {
|
|
270
465
|
/**
|
|
@@ -311,14 +506,14 @@ declare namespace RUM {
|
|
|
311
506
|
AppMonitor?: AppMonitor;
|
|
312
507
|
}
|
|
313
508
|
export type ISOTimestampString = string;
|
|
509
|
+
export type IamRoleArn = string;
|
|
314
510
|
export type IdentityPoolId = string;
|
|
315
|
-
export type Integer = number;
|
|
316
511
|
export type JsonValue = string;
|
|
317
512
|
export interface ListAppMonitorsRequest {
|
|
318
513
|
/**
|
|
319
|
-
* The maximum number of results to return in one operation.
|
|
514
|
+
* The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.
|
|
320
515
|
*/
|
|
321
|
-
MaxResults?:
|
|
516
|
+
MaxResults?: MaxResultsInteger;
|
|
322
517
|
/**
|
|
323
518
|
* Use the token returned by the previous operation to request the next page of results.
|
|
324
519
|
*/
|
|
@@ -334,6 +529,30 @@ declare namespace RUM {
|
|
|
334
529
|
*/
|
|
335
530
|
NextToken?: String;
|
|
336
531
|
}
|
|
532
|
+
export interface ListRumMetricsDestinationsRequest {
|
|
533
|
+
/**
|
|
534
|
+
* The name of the app monitor associated with the destinations that you want to retrieve.
|
|
535
|
+
*/
|
|
536
|
+
AppMonitorName: AppMonitorName;
|
|
537
|
+
/**
|
|
538
|
+
* The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100. To retrieve the remaining results, make another call with the returned NextToken value.
|
|
539
|
+
*/
|
|
540
|
+
MaxResults?: MaxResultsInteger;
|
|
541
|
+
/**
|
|
542
|
+
* Use the token returned by the previous operation to request the next page of results.
|
|
543
|
+
*/
|
|
544
|
+
NextToken?: String;
|
|
545
|
+
}
|
|
546
|
+
export interface ListRumMetricsDestinationsResponse {
|
|
547
|
+
/**
|
|
548
|
+
* The list of CloudWatch RUM extended metrics destinations associated with the app monitor that you specified.
|
|
549
|
+
*/
|
|
550
|
+
Destinations?: MetricDestinationSummaryList;
|
|
551
|
+
/**
|
|
552
|
+
* A token that you can use in a subsequent operation to retrieve the next set of results.
|
|
553
|
+
*/
|
|
554
|
+
NextToken?: String;
|
|
555
|
+
}
|
|
337
556
|
export interface ListTagsForResourceRequest {
|
|
338
557
|
/**
|
|
339
558
|
* The ARN of the resource that you want to see the tags of.
|
|
@@ -351,6 +570,76 @@ declare namespace RUM {
|
|
|
351
570
|
Tags: TagMap;
|
|
352
571
|
}
|
|
353
572
|
export type MaxQueryResults = number;
|
|
573
|
+
export type MaxResultsInteger = number;
|
|
574
|
+
export interface MetricDefinition {
|
|
575
|
+
/**
|
|
576
|
+
* This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.
|
|
577
|
+
*/
|
|
578
|
+
DimensionKeys?: DimensionKeysMap;
|
|
579
|
+
/**
|
|
580
|
+
* The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination. If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
|
|
581
|
+
*/
|
|
582
|
+
EventPattern?: EventPattern;
|
|
583
|
+
/**
|
|
584
|
+
* The ID of this metric definition.
|
|
585
|
+
*/
|
|
586
|
+
MetricDefinitionId: MetricDefinitionId;
|
|
587
|
+
/**
|
|
588
|
+
* The name of the metric that is defined in this structure.
|
|
589
|
+
*/
|
|
590
|
+
Name: MetricName;
|
|
591
|
+
/**
|
|
592
|
+
* Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
|
|
593
|
+
*/
|
|
594
|
+
UnitLabel?: UnitLabel;
|
|
595
|
+
/**
|
|
596
|
+
* The field within the event object that the metric value is sourced from.
|
|
597
|
+
*/
|
|
598
|
+
ValueKey?: ValueKey;
|
|
599
|
+
}
|
|
600
|
+
export type MetricDefinitionId = string;
|
|
601
|
+
export type MetricDefinitionIds = MetricDefinitionId[];
|
|
602
|
+
export interface MetricDefinitionRequest {
|
|
603
|
+
/**
|
|
604
|
+
* Use this field only if you are sending the metric to CloudWatch. This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. Valid values for the entries in this field are the following: "metadata.pageId": "PageId" "metadata.browserName": "BrowserName" "metadata.deviceType": "DeviceType" "metadata.osName": "OSName" "metadata.countryCode": "CountryCode" "event_details.fileType": "FileType" <p> All dimensions listed in this field must also be included in <code>EventPattern</code>.</p>
|
|
605
|
+
*/
|
|
606
|
+
DimensionKeys?: DimensionKeysMap;
|
|
607
|
+
/**
|
|
608
|
+
* The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination. When you define extended metrics, the metric definition is not valid if EventPattern is omitted. Example event patterns: '{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }' '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }' '{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }' If the metrics destination' is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
|
|
609
|
+
*/
|
|
610
|
+
EventPattern?: EventPattern;
|
|
611
|
+
/**
|
|
612
|
+
* The name for the metric that is defined in this structure. Valid values are the following: PerformanceNavigationDuration PerformanceResourceDuration NavigationSatisfiedTransaction NavigationToleratedTransaction NavigationFrustratedTransaction WebVitalsCumulativeLayoutShift WebVitalsFirstInputDelay WebVitalsLargestContentfulPaint JsErrorCount HttpErrorCount SessionCount
|
|
613
|
+
*/
|
|
614
|
+
Name: MetricName;
|
|
615
|
+
/**
|
|
616
|
+
* The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
|
|
617
|
+
*/
|
|
618
|
+
UnitLabel?: UnitLabel;
|
|
619
|
+
/**
|
|
620
|
+
* The field within the event object that the metric value is sourced from. If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you just want to count the number of events that the filter catches. If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently will handle data extraction from the event.
|
|
621
|
+
*/
|
|
622
|
+
ValueKey?: ValueKey;
|
|
623
|
+
}
|
|
624
|
+
export type MetricDefinitions = MetricDefinition[];
|
|
625
|
+
export type MetricDefinitionsRequest = MetricDefinitionRequest[];
|
|
626
|
+
export type MetricDestination = "CloudWatch"|"Evidently"|string;
|
|
627
|
+
export interface MetricDestinationSummary {
|
|
628
|
+
/**
|
|
629
|
+
* Specifies whether the destination is CloudWatch or Evidently.
|
|
630
|
+
*/
|
|
631
|
+
Destination?: MetricDestination;
|
|
632
|
+
/**
|
|
633
|
+
* If the destination is Evidently, this specifies the ARN of the Evidently experiment that receives the metrics.
|
|
634
|
+
*/
|
|
635
|
+
DestinationArn?: DestinationArn;
|
|
636
|
+
/**
|
|
637
|
+
* This field appears only when the destination is Evidently. It specifies the ARN of the IAM role that is used to write to the Evidently experiment that receives the metrics.
|
|
638
|
+
*/
|
|
639
|
+
IamRoleArn?: IamRoleArn;
|
|
640
|
+
}
|
|
641
|
+
export type MetricDestinationSummaryList = MetricDestinationSummary[];
|
|
642
|
+
export type MetricName = string;
|
|
354
643
|
export type Pages = Url[];
|
|
355
644
|
export interface PutRumEventsRequest {
|
|
356
645
|
/**
|
|
@@ -376,6 +665,26 @@ declare namespace RUM {
|
|
|
376
665
|
}
|
|
377
666
|
export interface PutRumEventsResponse {
|
|
378
667
|
}
|
|
668
|
+
export interface PutRumMetricsDestinationRequest {
|
|
669
|
+
/**
|
|
670
|
+
* The name of the CloudWatch RUM app monitor that will send the metrics.
|
|
671
|
+
*/
|
|
672
|
+
AppMonitorName: AppMonitorName;
|
|
673
|
+
/**
|
|
674
|
+
* Defines the destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.
|
|
675
|
+
*/
|
|
676
|
+
Destination: MetricDestination;
|
|
677
|
+
/**
|
|
678
|
+
* Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.
|
|
679
|
+
*/
|
|
680
|
+
DestinationArn?: DestinationArn;
|
|
681
|
+
/**
|
|
682
|
+
* This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.
|
|
683
|
+
*/
|
|
684
|
+
IamRoleArn?: IamRoleArn;
|
|
685
|
+
}
|
|
686
|
+
export interface PutRumMetricsDestinationResponse {
|
|
687
|
+
}
|
|
379
688
|
export interface QueryFilter {
|
|
380
689
|
/**
|
|
381
690
|
* The name of a key to search for. The filter returns only the events that match the Name and Values that you specify. Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert
|
|
@@ -447,6 +756,7 @@ declare namespace RUM {
|
|
|
447
756
|
}
|
|
448
757
|
export type Timestamp = Date;
|
|
449
758
|
export type Token = string;
|
|
759
|
+
export type UnitLabel = string;
|
|
450
760
|
export interface UntagResourceRequest {
|
|
451
761
|
/**
|
|
452
762
|
* The ARN of the CloudWatch RUM resource that you're removing tags from.
|
|
@@ -479,6 +789,30 @@ declare namespace RUM {
|
|
|
479
789
|
}
|
|
480
790
|
export interface UpdateAppMonitorResponse {
|
|
481
791
|
}
|
|
792
|
+
export interface UpdateRumMetricDefinitionRequest {
|
|
793
|
+
/**
|
|
794
|
+
* The name of the CloudWatch RUM app monitor that sends these metrics.
|
|
795
|
+
*/
|
|
796
|
+
AppMonitorName: AppMonitorName;
|
|
797
|
+
/**
|
|
798
|
+
* The destination to send the metrics to. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that will receive the metrics and an IAM role that has permission to write to the experiment.
|
|
799
|
+
*/
|
|
800
|
+
Destination: MetricDestination;
|
|
801
|
+
/**
|
|
802
|
+
* This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.
|
|
803
|
+
*/
|
|
804
|
+
DestinationArn?: DestinationArn;
|
|
805
|
+
/**
|
|
806
|
+
* A structure that contains the new definition that you want to use for this metric.
|
|
807
|
+
*/
|
|
808
|
+
MetricDefinition: MetricDefinitionRequest;
|
|
809
|
+
/**
|
|
810
|
+
* The ID of the metric definition to update.
|
|
811
|
+
*/
|
|
812
|
+
MetricDefinitionId: MetricDefinitionId;
|
|
813
|
+
}
|
|
814
|
+
export interface UpdateRumMetricDefinitionResponse {
|
|
815
|
+
}
|
|
482
816
|
export type Url = string;
|
|
483
817
|
export interface UserDetails {
|
|
484
818
|
/**
|
|
@@ -490,6 +824,7 @@ declare namespace RUM {
|
|
|
490
824
|
*/
|
|
491
825
|
userId?: String;
|
|
492
826
|
}
|
|
827
|
+
export type ValueKey = string;
|
|
493
828
|
/**
|
|
494
829
|
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
|
|
495
830
|
*/
|