BatchCreateRumMetricDefinitions

$result = $client->batchCreateRumMetricDefinitions([/* ... */]);
$promise = $client->batchCreateRumMetricDefinitionsAsync([/* ... */]);

Specifies the extended metrics and custom 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.

In addition to these default metrics, you can choose to send extended metrics, custom metrics, or both.

• Extended metrics let you send metrics with additional dimensions that aren't included in the default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended metrics are BrowserName, CountryCode, DeviceType, FileType, OSName, and PageId. For more information, see 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. CloudWatch Evidently, or both. With custom metrics, you can use any metric name and namespace. To derive the metrics, you can use any custom events, built-in events, custom attributes, or default attributes.

  You can't send custom metrics to the AWS/RUM namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with AWS/. CloudWatch RUM prepends RUM/CustomMetrics/ to the custom namespace that you define, so the final namespace for your metrics in CloudWatch is RUM/CustomMetrics/your-custom-namespace .

The maximum number of metric definitions that you can specify in one BatchCreateRumMetricDefinitions operation is 200.

The maximum number of metric definitions that one destination can contain is 2000.

Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric. For more information, see Amazon CloudWatch Pricing.

You must have already created a destination for the metrics before you send them. For more information, see PutRumMetricsDestination.

If some metric definitions specified in a BatchCreateRumMetricDefinitions operations are not valid, those metric definitions fail and return errors, but all valid metric definitions in the same operation still succeed.

Parameter Syntax

$result = $client->batchCreateRumMetricDefinitions([
    'AppMonitorName' => '<string>', // REQUIRED
    'Destination' => 'CloudWatch|Evidently', // REQUIRED
    'DestinationArn' => '<string>',
    'MetricDefinitions' => [ // REQUIRED
        [
            'DimensionKeys' => ['<string>', ...],
            'EventPattern' => '<string>',
            'Name' => '<string>', // REQUIRED
            'Namespace' => '<string>',
            'UnitLabel' => '<string>',
            'ValueKey' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'MetricDefinition' => [
                'DimensionKeys' => ['<string>', ...],
                'EventPattern' => '<string>',
                'Name' => '<string>',
                'Namespace' => '<string>',
                'UnitLabel' => '<string>',
                'ValueKey' => '<string>',
            ],
        ],
        // ...
    ],
    'MetricDefinitions' => [
        [
            'DimensionKeys' => ['<string>', ...],
            'EventPattern' => '<string>',
            'MetricDefinitionId' => '<string>',
            'Name' => '<string>',
            'Namespace' => '<string>',
            'UnitLabel' => '<string>',
            'ValueKey' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ServiceQuotaExceededException:

This request exceeds a service quota.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

BatchDeleteRumMetricDefinitions

$result = $client->batchDeleteRumMetricDefinitions([/* ... */]);
$promise = $client->batchDeleteRumMetricDefinitionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchDeleteRumMetricDefinitions([
    'AppMonitorName' => '<string>', // REQUIRED
    'Destination' => 'CloudWatch|Evidently', // REQUIRED
    'DestinationArn' => '<string>',
    'MetricDefinitionIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'MetricDefinitionId' => '<string>',
        ],
        // ...
    ],
    'MetricDefinitionIds' => ['<string>', ...],
]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

BatchGetRumMetricDefinitions

$result = $client->batchGetRumMetricDefinitions([/* ... */]);
$promise = $client->batchGetRumMetricDefinitionsAsync([/* ... */]);

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

Parameter Syntax

$result = $client->batchGetRumMetricDefinitions([
    'AppMonitorName' => '<string>', // REQUIRED
    'Destination' => 'CloudWatch|Evidently', // REQUIRED
    'DestinationArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'MetricDefinitions' => [
        [
            'DimensionKeys' => ['<string>', ...],
            'EventPattern' => '<string>',
            'MetricDefinitionId' => '<string>',
            'Name' => '<string>',
            'Namespace' => '<string>',
            'UnitLabel' => '<string>',
            'ValueKey' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

CreateAppMonitor

$result = $client->createAppMonitor([/* ... */]);
$promise = $client->createAppMonitorAsync([/* ... */]);

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?

Parameter Syntax

$result = $client->createAppMonitor([
    'AppMonitorConfiguration' => [
        'AllowCookies' => true || false,
        'EnableXRay' => true || false,
        'ExcludedPages' => ['<string>', ...],
        'FavoritePages' => ['<string>', ...],
        'GuestRoleArn' => '<string>',
        'IdentityPoolId' => '<string>',
        'IncludedPages' => ['<string>', ...],
        'SessionSampleRate' => <float>,
        'Telemetries' => ['<string>', ...],
    ],
    'CustomEvents' => [
        'Status' => 'ENABLED|DISABLED',
    ],
    'CwLogEnabled' => true || false,
    'Domain' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Id' => '<string>',
]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ServiceQuotaExceededException:

This request exceeds a service quota.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

DeleteAppMonitor

$result = $client->deleteAppMonitor([/* ... */]);
$promise = $client->deleteAppMonitorAsync([/* ... */]);

Deletes an existing app monitor. This immediately stops the collection of data.

Parameter Syntax

$result = $client->deleteAppMonitor([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

DeleteRumMetricsDestination

$result = $client->deleteRumMetricsDestination([/* ... */]);
$promise = $client->deleteRumMetricsDestinationAsync([/* ... */]);

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

Parameter Syntax

$result = $client->deleteRumMetricsDestination([
    'AppMonitorName' => '<string>', // REQUIRED
    'Destination' => 'CloudWatch|Evidently', // REQUIRED
    'DestinationArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

GetAppMonitor

$result = $client->getAppMonitor([/* ... */]);
$promise = $client->getAppMonitorAsync([/* ... */]);

Retrieves the complete configuration information for one app monitor.

Parameter Syntax

$result = $client->getAppMonitor([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AppMonitor' => [
        'AppMonitorConfiguration' => [
            'AllowCookies' => true || false,
            'EnableXRay' => true || false,
            'ExcludedPages' => ['<string>', ...],
            'FavoritePages' => ['<string>', ...],
            'GuestRoleArn' => '<string>',
            'IdentityPoolId' => '<string>',
            'IncludedPages' => ['<string>', ...],
            'SessionSampleRate' => <float>,
            'Telemetries' => ['<string>', ...],
        ],
        'Created' => '<string>',
        'CustomEvents' => [
            'Status' => 'ENABLED|DISABLED',
        ],
        'DataStorage' => [
            'CwLog' => [
                'CwLogEnabled' => true || false,
                'CwLogGroup' => '<string>',
            ],
        ],
        'Domain' => '<string>',
        'Id' => '<string>',
        'LastModified' => '<string>',
        'Name' => '<string>',
        'State' => 'CREATED|DELETING|ACTIVE',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

GetAppMonitorData

$result = $client->getAppMonitorData([/* ... */]);
$promise = $client->getAppMonitorDataAsync([/* ... */]);

Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data.

Parameter Syntax

$result = $client->getAppMonitorData([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'TimeRange' => [ // REQUIRED
        'After' => <integer>, // REQUIRED
        'Before' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'Events' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

ListAppMonitors

$result = $client->listAppMonitors([/* ... */]);
$promise = $client->listAppMonitorsAsync([/* ... */]);

Returns a list of the Amazon CloudWatch RUM app monitors in the account.

Parameter Syntax

$result = $client->listAppMonitors([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AppMonitorSummaries' => [
        [
            'Created' => '<string>',
            'Id' => '<string>',
            'LastModified' => '<string>',
            'Name' => '<string>',
            'State' => 'CREATED|DELETING|ACTIVE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

ListRumMetricsDestinations

$result = $client->listRumMetricsDestinations([/* ... */]);
$promise = $client->listRumMetricsDestinationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listRumMetricsDestinations([
    'AppMonitorName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Destinations' => [
        [
            'Destination' => 'CloudWatch|Evidently',
            'DestinationArn' => '<string>',
            'IamRoleArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Displays the tags associated with a CloudWatch RUM resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ResourceArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

PutRumEvents

$result = $client->putRumEvents([/* ... */]);
$promise = $client->putRumEventsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putRumEvents([
    'AppMonitorDetails' => [ // REQUIRED
        'id' => '<string>',
        'name' => '<string>',
        'version' => '<string>',
    ],
    'BatchId' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
    'RumEvents' => [ // REQUIRED
        [
            'details' => '<string>', // REQUIRED
            'id' => '<string>', // REQUIRED
            'metadata' => '<string>',
            'timestamp' => <integer || string || DateTime>, // REQUIRED
            'type' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'UserDetails' => [ // REQUIRED
        'sessionId' => '<string>',
        'userId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

PutRumMetricsDestination

$result = $client->putRumMetricsDestination([/* ... */]);
$promise = $client->putRumMetricsDestinationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->putRumMetricsDestination([
    'AppMonitorName' => '<string>', // REQUIRED
    'Destination' => 'CloudWatch|Evidently', // REQUIRED
    'DestinationArn' => '<string>',
    'IamRoleArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

UpdateAppMonitor

$result = $client->updateAppMonitor([/* ... */]);
$promise = $client->updateAppMonitorAsync([/* ... */]);

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?

Parameter Syntax

$result = $client->updateAppMonitor([
    'AppMonitorConfiguration' => [
        'AllowCookies' => true || false,
        'EnableXRay' => true || false,
        'ExcludedPages' => ['<string>', ...],
        'FavoritePages' => ['<string>', ...],
        'GuestRoleArn' => '<string>',
        'IdentityPoolId' => '<string>',
        'IncludedPages' => ['<string>', ...],
        'SessionSampleRate' => <float>,
        'Telemetries' => ['<string>', ...],
    ],
    'CustomEvents' => [
        'Status' => 'ENABLED|DISABLED',
    ],
    'CwLogEnabled' => true || false,
    'Domain' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.

UpdateRumMetricDefinition

$result = $client->updateRumMetricDefinition([/* ... */]);
$promise = $client->updateRumMetricDefinitionAsync([/* ... */]);

Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.

Parameter Syntax

$result = $client->updateRumMetricDefinition([
    'AppMonitorName' => '<string>', // REQUIRED
    'Destination' => 'CloudWatch|Evidently', // REQUIRED
    'DestinationArn' => '<string>',
    'MetricDefinition' => [ // REQUIRED
        'DimensionKeys' => ['<string>', ...],
        'EventPattern' => '<string>',
        'Name' => '<string>', // REQUIRED
        'Namespace' => '<string>',
        'UnitLabel' => '<string>',
        'ValueKey' => '<string>',
    ],
    'MetricDefinitionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

This operation attempted to create a resource that already exists.

ServiceQuotaExceededException:

This request exceeds a service quota.

ResourceNotFoundException:

Resource not found.

InternalServerException:

Internal service exception.

ValidationException:

One of the arguments for the request is not valid.

ThrottlingException:

The request was throttled because of quota limits.

AccessDeniedException:

You don't have sufficient permissions to perform this action.