Amazon CloudWatch Application Signals 2024-04-15
- Client: Aws\ApplicationSignals\ApplicationSignalsClient
- Service ID: application-signals
- Version: 2024-04-15
This page describes the parameters and results for the operations of the Amazon CloudWatch Application Signals (2024-04-15), and shows how to use the Aws\ApplicationSignals\ApplicationSignalsClient object to call the described operations. This documentation is specific to the 2024-04-15 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- BatchGetServiceLevelObjectiveBudgetReport ( array $params = [] )
- Use this operation to retrieve one or more service level objective (SLO) budget reports.
- CreateServiceLevelObjective ( array $params = [] )
- Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations.
- DeleteServiceLevelObjective ( array $params = [] )
- Deletes the specified service level objective.
- GetService ( array $params = [] )
- Returns information about a service discovered by Application Signals.
- GetServiceLevelObjective ( array $params = [] )
- Returns information about one SLO created in the account.
- ListServiceDependencies ( array $params = [] )
- Returns a list of service dependencies of the service that you specify.
- ListServiceDependents ( array $params = [] )
- Returns the list of dependents that invoked the specified service during the provided time range.
- ListServiceLevelObjectives ( array $params = [] )
- Returns a list of SLOs created in this account.
- ListServiceOperations ( array $params = [] )
- Returns a list of the operations of this service that have been discovered by Application Signals.
- ListServices ( array $params = [] )
- Returns a list of services that have been discovered by Application Signals.
- ListTagsForResource ( array $params = [] )
- Displays the tags associated with a CloudWatch resource.
- StartDiscovery ( array $params = [] )
- Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role.
- TagResource ( array $params = [] )
- Assigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective.
- UntagResource ( array $params = [] )
- Removes one or more tags from the specified resource.
- UpdateServiceLevelObjective ( array $params = [] )
- Updates an existing service level objective (SLO).
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListServiceDependencies
- ListServiceDependents
- ListServiceLevelObjectives
- ListServiceOperations
- ListServices
Operations
BatchGetServiceLevelObjectiveBudgetReport
$result = $client->batchGetServiceLevelObjectiveBudgetReport
([/* ... */]); $promise = $client->batchGetServiceLevelObjectiveBudgetReportAsync
([/* ... */]);
Use this operation to retrieve one or more service level objective (SLO) budget reports.
An error budget is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.
Budget reports include a health indicator, the attainment value, and remaining budget.
For more information about SLO error budgets, see SLO concepts.
Parameter Syntax
$result = $client->batchGetServiceLevelObjectiveBudgetReport([ 'SloIds' => ['<string>', ...], // REQUIRED 'Timestamp' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- SloIds
-
- Required: Yes
- Type: Array of strings
An array containing the IDs of the service level objectives that you want to include in the report.
- Timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that you want the report to be for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Result Syntax
[ 'Errors' => [ [ 'Arn' => '<string>', 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'Name' => '<string>', ], // ... ], 'Reports' => [ [ 'Arn' => '<string>', 'Attainment' => <float>, 'BudgetRequestsRemaining' => <integer>, 'BudgetSecondsRemaining' => <integer>, 'BudgetStatus' => 'OK|WARNING|BREACHED|INSUFFICIENT_DATA', 'EvaluationType' => 'PeriodBased|RequestBased', 'Goal' => [ 'AttainmentGoal' => <float>, 'Interval' => [ 'CalendarInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', 'StartTime' => <DateTime>, ], 'RollingInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', ], ], 'WarningThreshold' => <float>, ], 'Name' => '<string>', 'RequestBasedSli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'RequestBasedSliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricType' => 'LATENCY|AVAILABILITY', 'MonitoredRequestCountMetric' => [ 'BadCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'GoodCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], 'OperationName' => '<string>', 'TotalRequestCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], ], 'Sli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'SliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricDataQueries' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'MetricType' => 'LATENCY|AVAILABILITY', 'OperationName' => '<string>', ], ], 'TotalBudgetRequests' => <integer>, 'TotalBudgetSeconds' => <integer>, ], // ... ], 'Timestamp' => <DateTime>, ]
Result Details
Members
- Errors
-
- Required: Yes
- Type: Array of ServiceLevelObjectiveBudgetReportError structures
An array of structures, where each structure includes an error indicating that one of the requests in the array was not valid.
- Reports
-
- Required: Yes
- Type: Array of ServiceLevelObjectiveBudgetReport structures
An array of structures, where each structure is one budget report.
- Timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the report is for. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
CreateServiceLevelObjective
$result = $client->createServiceLevelObjective
([/* ... */]); $promise = $client->createServiceLevelObjectiveAsync
([/* ... */]);
Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.
Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached.
The target performance quality that is defined for an SLO is the attainment goal.
You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.
When you create an SLO, you specify whether it is a period-based SLO or a request-based SLO. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.
-
A period-based SLO uses defined periods of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the
number of good periods/number of total periods
.For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.
-
A request-based SLO doesn't use pre-defined periods of time. Instead, the SLO measures
number of good requests/number of total requests
during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.
After you have created an SLO, you can retrieve error budget reports for it. An error budget is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.
-
For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The remaining error budget decreases with every failed period that is recorded. The error budget within one interval can never increase.
For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.
-
For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.
For more information about SLOs, see Service level objectives (SLOs).
When you perform a CreateServiceLevelObjective
operation, Application Signals creates the AWSServiceRoleForCloudWatchApplicationSignals service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:
-
xray:GetServiceGraph
-
logs:StartQuery
-
logs:GetQueryResults
-
cloudwatch:GetMetricData
-
cloudwatch:ListMetrics
-
tag:GetResources
-
autoscaling:DescribeAutoScalingGroups
Parameter Syntax
$result = $client->createServiceLevelObjective([ 'BurnRateConfigurations' => [ [ 'LookBackWindowMinutes' => <integer>, // REQUIRED ], // ... ], 'Description' => '<string>', 'Goal' => [ 'AttainmentGoal' => <float>, 'Interval' => [ 'CalendarInterval' => [ 'Duration' => <integer>, // REQUIRED 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ], 'RollingInterval' => [ 'Duration' => <integer>, // REQUIRED 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', // REQUIRED ], ], 'WarningThreshold' => <float>, ], 'Name' => '<string>', // REQUIRED 'RequestBasedSliConfig' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'RequestBasedSliMetricConfig' => [ // REQUIRED 'KeyAttributes' => ['<string>', ...], 'MetricType' => 'LATENCY|AVAILABILITY', 'MonitoredRequestCountMetric' => [ 'BadCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'GoodCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], 'OperationName' => '<string>', 'TotalRequestCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], ], 'SliConfig' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', // REQUIRED 'MetricThreshold' => <float>, // REQUIRED 'SliMetricConfig' => [ // REQUIRED 'KeyAttributes' => ['<string>', ...], 'MetricDataQueries' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'MetricType' => 'LATENCY|AVAILABILITY', 'OperationName' => '<string>', 'PeriodSeconds' => <integer>, 'Statistic' => '<string>', ], ], 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- BurnRateConfigurations
-
- Type: Array of BurnRateConfiguration structures
Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.
- Description
-
- Type: string
An optional description for this SLO.
- Goal
-
- Type: Goal structure
This structure contains the attributes that determine the goal of the SLO.
- Name
-
- Required: Yes
- Type: string
A name for this SLO.
- RequestBasedSliConfig
-
- Type: RequestBasedServiceLevelIndicatorConfig structure
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both
RequestBasedSliConfig
andSliConfig
in the same operation. - SliConfig
-
- Type: ServiceLevelIndicatorConfig structure
If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both
RequestBasedSliConfig
andSliConfig
in the same operation. - Tags
-
- Type: Array of Tag structures
A list of key-value pairs to associate with the SLO. You can associate as many as 50 tags with an SLO. To be able to associate tags with the SLO when you create the SLO, you must have the
cloudwatch:TagResource
permission.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.
Result Syntax
[ 'Slo' => [ 'Arn' => '<string>', 'BurnRateConfigurations' => [ [ 'LookBackWindowMinutes' => <integer>, ], // ... ], 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'EvaluationType' => 'PeriodBased|RequestBased', 'Goal' => [ 'AttainmentGoal' => <float>, 'Interval' => [ 'CalendarInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', 'StartTime' => <DateTime>, ], 'RollingInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', ], ], 'WarningThreshold' => <float>, ], 'LastUpdatedTime' => <DateTime>, 'Name' => '<string>', 'RequestBasedSli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'RequestBasedSliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricType' => 'LATENCY|AVAILABILITY', 'MonitoredRequestCountMetric' => [ 'BadCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'GoodCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], 'OperationName' => '<string>', 'TotalRequestCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], ], 'Sli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'SliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricDataQueries' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'MetricType' => 'LATENCY|AVAILABILITY', 'OperationName' => '<string>', ], ], ], ]
Result Details
Members
- Slo
-
- Required: Yes
- Type: ServiceLevelObjective structure
A structure that contains information about the SLO that you just created.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
- AccessDeniedException:
You don't have sufficient permissions to perform this action.
- ServiceQuotaExceededException:
This request exceeds a service quota.
- ConflictException:
This operation attempted to create a resource that already exists.
DeleteServiceLevelObjective
$result = $client->deleteServiceLevelObjective
([/* ... */]); $promise = $client->deleteServiceLevelObjectiveAsync
([/* ... */]);
Deletes the specified service level objective.
Parameter Syntax
$result = $client->deleteServiceLevelObjective([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ARN or name of the service level objective to delete.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The resource is not valid.
- ResourceNotFoundException:
Resource not found.
- ThrottlingException:
The request was throttled because of quota limits.
GetService
$result = $client->getService
([/* ... */]); $promise = $client->getServiceAsync
([/* ... */]);
Returns information about a service discovered by Application Signals.
Parameter Syntax
$result = $client->getService([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'KeyAttributes' => ['<string>', ...], // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
- KeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
Use this field to specify which service you want to retrieve information for. You must specify at least the
Type
,Name
, andEnvironment
attributes.This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
Result Syntax
[ 'EndTime' => <DateTime>, 'LogGroupReferences' => [ ['<string>', ...], // ... ], 'Service' => [ 'AttributeMaps' => [ ['<string>', ...], // ... ], 'KeyAttributes' => ['<string>', ...], 'LogGroupReferences' => [ ['<string>', ...], // ... ], 'MetricReferences' => [ [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'MetricType' => '<string>', 'Namespace' => '<string>', ], // ... ], ], 'StartTime' => <DateTime>, ]
Result Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
.This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
- LogGroupReferences
-
- Type: Array of stringss
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
-
"Type": "AWS::Resource"
-
"ResourceType": "AWS::Logs::LogGroup"
-
"Identifier": "name-of-log-group"
- Service
-
- Required: Yes
- Type: Service structure
A structure containing information about the service.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
.This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
GetServiceLevelObjective
$result = $client->getServiceLevelObjective
([/* ... */]); $promise = $client->getServiceLevelObjectiveAsync
([/* ... */]);
Returns information about one SLO created in the account.
Parameter Syntax
$result = $client->getServiceLevelObjective([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ARN or name of the SLO that you want to retrieve information about. You can find the ARNs of SLOs by using the ListServiceLevelObjectives operation.
Result Syntax
[ 'Slo' => [ 'Arn' => '<string>', 'BurnRateConfigurations' => [ [ 'LookBackWindowMinutes' => <integer>, ], // ... ], 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'EvaluationType' => 'PeriodBased|RequestBased', 'Goal' => [ 'AttainmentGoal' => <float>, 'Interval' => [ 'CalendarInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', 'StartTime' => <DateTime>, ], 'RollingInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', ], ], 'WarningThreshold' => <float>, ], 'LastUpdatedTime' => <DateTime>, 'Name' => '<string>', 'RequestBasedSli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'RequestBasedSliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricType' => 'LATENCY|AVAILABILITY', 'MonitoredRequestCountMetric' => [ 'BadCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'GoodCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], 'OperationName' => '<string>', 'TotalRequestCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], ], 'Sli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'SliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricDataQueries' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'MetricType' => 'LATENCY|AVAILABILITY', 'OperationName' => '<string>', ], ], ], ]
Result Details
Members
- Slo
-
- Required: Yes
- Type: ServiceLevelObjective structure
A structure containing the information about the SLO.
Errors
- ValidationException:
The resource is not valid.
- ResourceNotFoundException:
Resource not found.
- ThrottlingException:
The request was throttled because of quota limits.
ListServiceDependencies
$result = $client->listServiceDependencies
([/* ... */]); $promise = $client->listServiceDependenciesAsync
([/* ... */]);
Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services.
Parameter Syntax
$result = $client->listServiceDependencies([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'KeyAttributes' => ['<string>', ...], // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested end time will be rounded to the nearest hour.
- KeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
Use this field to specify which service you want to retrieve information for. You must specify at least the
Type
,Name
, andEnvironment
attributes.This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MaxResults
-
- Type: int
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
- NextToken
-
- Type: string
Include this value, if it was returned by the previous operation, to get the next set of service dependencies.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
Result Syntax
[ 'EndTime' => <DateTime>, 'NextToken' => '<string>', 'ServiceDependencies' => [ [ 'DependencyKeyAttributes' => ['<string>', ...], 'DependencyOperationName' => '<string>', 'MetricReferences' => [ [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'MetricType' => '<string>', 'Namespace' => '<string>', ], // ... ], 'OperationName' => '<string>', ], // ... ], 'StartTime' => <DateTime>, ]
Result Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
- NextToken
-
- Type: string
Include this value in your next use of this API to get next set of service dependencies.
- ServiceDependencies
-
- Required: Yes
- Type: Array of ServiceDependency structures
An array, where each object in the array contains information about one of the dependencies of this service.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
ListServiceDependents
$result = $client->listServiceDependents
([/* ... */]); $promise = $client->listServiceDependentsAsync
([/* ... */]);
Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
Parameter Syntax
$result = $client->listServiceDependents([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'KeyAttributes' => ['<string>', ...], // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
- KeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
Use this field to specify which service you want to retrieve information for. You must specify at least the
Type
,Name
, andEnvironment
attributes.This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MaxResults
-
- Type: int
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
- NextToken
-
- Type: string
Include this value, if it was returned by the previous operation, to get the next set of service dependents.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
Result Syntax
[ 'EndTime' => <DateTime>, 'NextToken' => '<string>', 'ServiceDependents' => [ [ 'DependentKeyAttributes' => ['<string>', ...], 'DependentOperationName' => '<string>', 'MetricReferences' => [ [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'MetricType' => '<string>', 'Namespace' => '<string>', ], // ... ], 'OperationName' => '<string>', ], // ... ], 'StartTime' => <DateTime>, ]
Result Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
- NextToken
-
- Type: string
Include this value in your next use of this API to get next set of service dependents.
- ServiceDependents
-
- Required: Yes
- Type: Array of ServiceDependent structures
An array, where each object in the array contains information about one of the dependents of this service.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
ListServiceLevelObjectives
$result = $client->listServiceLevelObjectives
([/* ... */]); $promise = $client->listServiceLevelObjectivesAsync
([/* ... */]);
Returns a list of SLOs created in this account.
Parameter Syntax
$result = $client->listServiceLevelObjectives([ 'KeyAttributes' => ['<string>', ...], 'MaxResults' => <integer>, 'NextToken' => '<string>', 'OperationName' => '<string>', ]);
Parameter Details
Members
- KeyAttributes
-
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
You can use this optional field to specify which services you want to retrieve SLO information for.
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MaxResults
-
- Type: int
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
- NextToken
-
- Type: string
Include this value, if it was returned by the previous operation, to get the next set of service level objectives.
- OperationName
-
- Type: string
The name of the operation that this SLO is associated with.
Result Syntax
[ 'NextToken' => '<string>', 'SloSummaries' => [ [ 'Arn' => '<string>', 'CreatedTime' => <DateTime>, 'KeyAttributes' => ['<string>', ...], 'Name' => '<string>', 'OperationName' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
Include this value in your next use of this API to get next set of service level objectives.
- SloSummaries
-
- Type: Array of ServiceLevelObjectiveSummary structures
An array of structures, where each structure contains information about one SLO.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
ListServiceOperations
$result = $client->listServiceOperations
([/* ... */]); $promise = $client->listServiceOperationsAsync
([/* ... */]);
Returns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.
Parameter Syntax
$result = $client->listServiceOperations([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'KeyAttributes' => ['<string>', ...], // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested end time will be rounded to the nearest hour.
- KeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
Use this field to specify which service you want to retrieve information for. You must specify at least the
Type
,Name
, andEnvironment
attributes.This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MaxResults
-
- Type: int
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
- NextToken
-
- Type: string
Include this value, if it was returned by the previous operation, to get the next set of service operations.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
Result Syntax
[ 'EndTime' => <DateTime>, 'NextToken' => '<string>', 'ServiceOperations' => [ [ 'MetricReferences' => [ [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'MetricType' => '<string>', 'Namespace' => '<string>', ], // ... ], 'Name' => '<string>', ], // ... ], 'StartTime' => <DateTime>, ]
Result Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
- NextToken
-
- Type: string
Include this value in your next use of this API to get next set of service operations.
- ServiceOperations
-
- Required: Yes
- Type: Array of ServiceOperation structures
An array of structures that each contain information about one operation of this service.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
ListServices
$result = $client->listServices
([/* ... */]); $promise = $client->listServicesAsync
([/* ... */]);
Returns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a business function. Services are discovered through Application Signals instrumentation.
Parameter Syntax
$result = $client->listServices([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
- MaxResults
-
- Type: int
The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.
- NextToken
-
- Type: string
Include this value, if it was returned by the previous operation, to get the next set of services.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
Your requested start time will be rounded to the nearest hour.
Result Syntax
[ 'EndTime' => <DateTime>, 'NextToken' => '<string>', 'ServiceSummaries' => [ [ 'AttributeMaps' => [ ['<string>', ...], // ... ], 'KeyAttributes' => ['<string>', ...], 'MetricReferences' => [ [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'MetricType' => '<string>', 'Namespace' => '<string>', ], // ... ], ], // ... ], 'StartTime' => <DateTime>, ]
Result Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
- NextToken
-
- Type: string
Include this value in your next use of this API to get next set of services.
- ServiceSummaries
-
- Required: Yes
- Type: Array of ServiceSummary structures
An array of structures, where each structure contains some information about a service. To get complete information about a service, use GetService.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.
Errors
- ValidationException:
The resource is not valid.
- ThrottlingException:
The request was throttled because of quota limits.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Displays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the CloudWatch resource that you want to view tags for.
The ARN format of an Application Signals SLO is
arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
The list of tag keys and values associated with the resource you specified.
Errors
- ResourceNotFoundException:
Resource not found.
- ThrottlingException:
The request was throttled because of quota limits.
StartDiscovery
$result = $client->startDiscovery
([/* ... */]); $promise = $client->startDiscoveryAsync
([/* ... */]);
Enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. This service- linked role has the following permissions:
-
xray:GetServiceGraph
-
logs:StartQuery
-
logs:GetQueryResults
-
cloudwatch:GetMetricData
-
cloudwatch:ListMetrics
-
tag:GetResources
-
autoscaling:DescribeAutoScalingGroups
After completing this step, you still need to instrument your Java and Python applications to send data to Application Signals. For more information, see Enabling Application Signals.
Parameter Syntax
$result = $client->startDiscovery([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
- ValidationException:
The resource 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 resource, such as a service level objective.
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 an alarm that already has tags. If you specify a new tag key for the alarm, 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 alarm, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a CloudWatch resource.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the CloudWatch resource that you want to set tags for.
The ARN format of an Application Signals SLO is
arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
The list of key-value pairs to associate with the alarm.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
Resource not found.
- ThrottlingException:
The request was throttled because of quota limits.
- ServiceQuotaExceededException:
This request exceeds a service quota.
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
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the CloudWatch resource that you want to delete tags from.
The ARN format of an Application Signals SLO is
arn:aws:cloudwatch:Region:account-id:slo:slo-name
For more information about ARN format, see Resource Types Defined by Amazon CloudWatch in the Amazon Web Services General Reference.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The list of tag keys to remove from the resource.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
Resource not found.
- ThrottlingException:
The request was throttled because of quota limits.
UpdateServiceLevelObjective
$result = $client->updateServiceLevelObjective
([/* ... */]); $promise = $client->updateServiceLevelObjectiveAsync
([/* ... */]);
Updates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained.
You cannot change from a period-based SLO to a request-based SLO, or change from a request-based SLO to a period-based SLO.
Parameter Syntax
$result = $client->updateServiceLevelObjective([ 'BurnRateConfigurations' => [ [ 'LookBackWindowMinutes' => <integer>, // REQUIRED ], // ... ], 'Description' => '<string>', 'Goal' => [ 'AttainmentGoal' => <float>, 'Interval' => [ 'CalendarInterval' => [ 'Duration' => <integer>, // REQUIRED 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ], 'RollingInterval' => [ 'Duration' => <integer>, // REQUIRED 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', // REQUIRED ], ], 'WarningThreshold' => <float>, ], 'Id' => '<string>', // REQUIRED 'RequestBasedSliConfig' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'RequestBasedSliMetricConfig' => [ // REQUIRED 'KeyAttributes' => ['<string>', ...], 'MetricType' => 'LATENCY|AVAILABILITY', 'MonitoredRequestCountMetric' => [ 'BadCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'GoodCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], 'OperationName' => '<string>', 'TotalRequestCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], ], 'SliConfig' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', // REQUIRED 'MetricThreshold' => <float>, // REQUIRED 'SliMetricConfig' => [ // REQUIRED 'KeyAttributes' => ['<string>', ...], 'MetricDataQueries' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', // REQUIRED 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ // REQUIRED 'Dimensions' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, // REQUIRED 'Stat' => '<string>', // REQUIRED 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'MetricType' => 'LATENCY|AVAILABILITY', 'OperationName' => '<string>', 'PeriodSeconds' => <integer>, 'Statistic' => '<string>', ], ], ]);
Parameter Details
Members
- BurnRateConfigurations
-
- Type: Array of BurnRateConfiguration structures
Use this array to create burn rates for this SLO. Each burn rate is a metric that indicates how fast the service is consuming the error budget, relative to the attainment goal of the SLO.
- Description
-
- Type: string
An optional description for the SLO.
- Goal
-
- Type: Goal structure
A structure that contains the attributes that determine the goal of the SLO. This includes the time period for evaluation and the attainment threshold.
- Id
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) or name of the service level objective that you want to update.
- RequestBasedSliConfig
-
- Type: RequestBasedServiceLevelIndicatorConfig structure
If this SLO is a request-based SLO, this structure defines the information about what performance metric this SLO will monitor.
You can't specify both
SliConfig
andRequestBasedSliConfig
in the same operation. - SliConfig
-
- Type: ServiceLevelIndicatorConfig structure
If this SLO is a period-based SLO, this structure defines the information about what performance metric this SLO will monitor.
Result Syntax
[ 'Slo' => [ 'Arn' => '<string>', 'BurnRateConfigurations' => [ [ 'LookBackWindowMinutes' => <integer>, ], // ... ], 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'EvaluationType' => 'PeriodBased|RequestBased', 'Goal' => [ 'AttainmentGoal' => <float>, 'Interval' => [ 'CalendarInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', 'StartTime' => <DateTime>, ], 'RollingInterval' => [ 'Duration' => <integer>, 'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', ], ], 'WarningThreshold' => <float>, ], 'LastUpdatedTime' => <DateTime>, 'Name' => '<string>', 'RequestBasedSli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'RequestBasedSliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricType' => 'LATENCY|AVAILABILITY', 'MonitoredRequestCountMetric' => [ 'BadCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'GoodCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], 'OperationName' => '<string>', 'TotalRequestCountMetric' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], ], ], 'Sli' => [ 'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo', 'MetricThreshold' => <float>, 'SliMetric' => [ 'KeyAttributes' => ['<string>', ...], 'MetricDataQueries' => [ [ 'AccountId' => '<string>', 'Expression' => '<string>', 'Id' => '<string>', 'Label' => '<string>', 'MetricStat' => [ 'Metric' => [ 'Dimensions' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'MetricName' => '<string>', 'Namespace' => '<string>', ], 'Period' => <integer>, 'Stat' => '<string>', 'Unit' => 'Microseconds|Milliseconds|Seconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None', ], 'Period' => <integer>, 'ReturnData' => true || false, ], // ... ], 'MetricType' => 'LATENCY|AVAILABILITY', 'OperationName' => '<string>', ], ], ], ]
Result Details
Members
- Slo
-
- Required: Yes
- Type: ServiceLevelObjective structure
A structure that contains information about the SLO that you just updated.
Errors
- ValidationException:
The resource is not valid.
- ResourceNotFoundException:
Resource not found.
- ThrottlingException:
The request was throttled because of quota limits.
Shapes
AccessDeniedException
Description
You don't have sufficient permissions to perform this action.
Members
- Message
-
- Type: string
BurnRateConfiguration
Description
This object defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO. A burn rate of exactly 1 indicates that the SLO goal will be met exactly.
For example, if you specify 60 as the number of minutes in the look-back window, the burn rate is calculated as the following:
burn rate = error rate over the look-back window / (1 - attainment goal percentage)
For more information about burn rates, see Calculate burn rates.
Members
- LookBackWindowMinutes
-
- Required: Yes
- Type: int
The number of minutes to use as the look-back window.
CalendarInterval
Description
If the interval for this service level objective is a calendar interval, this structure contains the interval specifications.
Members
- Duration
-
- Required: Yes
- Type: int
Specifies the duration of each calendar interval. For example, if
Duration
is1
andDurationUnit
isMONTH
, each interval is one month, aligned with the calendar. - DurationUnit
-
- Required: Yes
- Type: string
Specifies the calendar interval unit.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when you want the first interval to start. Be sure to choose a time that configures the intervals the way that you want. For example, if you want weekly intervals starting on Mondays at 6 a.m., be sure to specify a start time that is a Monday at 6 a.m.
When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example:
1698778057
As soon as one calendar interval ends, another automatically begins.
ConflictException
Description
This operation attempted to create a resource that already exists.
Members
- Message
-
- Required: Yes
- Type: string
Dimension
Description
A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId
as a dimension name, and the actual instance ID as the value for that dimension.
You can assign up to 30 dimensions to a metric.
Members
- Name
-
- Required: Yes
- Type: string
The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (
:
). ASCII control characters are not supported as part of dimension names. - Value
-
- Required: Yes
- Type: string
The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.
Goal
Description
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
Members
- AttainmentGoal
-
- Type: double
The threshold that determines if the goal is being met.
If this is a period-based SLO, the attainment goal is the percentage of good periods that meet the threshold requirements to the total periods within the interval. For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the periods to be in healthy state.
If this is a request-based SLO, the attainment goal is the percentage of requests that must be successful to meet the attainment goal.
If you omit this parameter, 99 is used to represent 99% as the attainment goal.
- Interval
-
- Type: Interval structure
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
If you omit this parameter, a rolling interval of 7 days is used.
- WarningThreshold
-
- Type: double
The percentage of remaining budget over total budget that you want to get warnings for. If you omit this parameter, the default of 50.0 is used.
Interval
Description
The time period used to evaluate the SLO. It can be either a calendar interval or rolling interval.
Members
- CalendarInterval
-
- Type: CalendarInterval structure
If the interval is a calendar interval, this structure contains the interval specifications.
- RollingInterval
-
- Type: RollingInterval structure
If the interval is a rolling interval, this structure contains the interval specifications.
Metric
Description
This structure defines the metric used for a service level indicator, including the metric name, namespace, and dimensions
Members
- Dimensions
-
- Type: Array of Dimension structures
An array of one or more dimensions to use to define the metric that you want to use. For more information, see Dimensions.
- MetricName
-
- Type: string
The name of the metric to use.
- Namespace
-
- Type: string
The namespace of the metric. For more information, see Namespaces.
MetricDataQuery
Description
Use this structure to define a metric or metric math expression that you want to use as for a service level objective.
Each MetricDataQuery
in the MetricDataQueries
array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries
array can include as many as 20 MetricDataQuery
structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat
parameter to retrieve a metric, and as many as 10 structures that contain the Expression
parameter to perform a math expression. Of those Expression
structures, exactly one must have true as the value for ReturnData
. The result of this expression used for the SLO.
For more information about metric math expressions, see CloudWatchUse metric math.
Within each MetricDataQuery
object, you must specify either Expression
or MetricStat
but not both.
Members
- AccountId
-
- Type: string
The ID of the account where this metric is located. If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.
- Expression
-
- Type: string
This field can contain a metric math expression to be performed on the other metrics that you are retrieving within this
MetricDataQueries
structure.A math expression can use the
Id
of the other metrics or queries to refer to those metrics, and can also use theId
of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
but not both. - Id
-
- Required: Yes
- Type: string
A short name used to tie this object to the results in the response. This
Id
must be unique within aMetricDataQueries
array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter. - Label
-
- Type: string
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If
Label
is omitted, CloudWatch generates a default.You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
- MetricStat
-
- Type: MetricStat structure
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.
Within one
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
but not both. - Period
-
- Type: int
The granularity, in seconds, of the returned data points for this metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a
PutMetricData
call that includes aStorageResolution
of 1 second.If the
StartTime
parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:-
Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
-
Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
-
Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
- ReturnData
-
- Type: boolean
Use this only if you are using a metric math expression for the SLO. Specify
true
forReturnData
for only the one expression result to use as the alarm. For all other metrics and expressions in the sameCreateServiceLevelObjective
operation, specifyReturnData
asfalse
.
MetricReference
Description
This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.
Members
- Dimensions
-
- Type: Array of Dimension structures
An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions.
- MetricName
-
- Required: Yes
- Type: string
The name of the metric.
- MetricType
-
- Required: Yes
- Type: string
Used to display the appropriate statistics in the CloudWatch console.
- Namespace
-
- Required: Yes
- Type: string
The namespace of the metric. For more information, see CloudWatchNamespaces.
MetricStat
Description
This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.
Members
- Metric
-
- Required: Yes
- Type: Metric structure
The metric to use as the service level indicator, including the metric name, namespace, and dimensions.
- Period
-
- Required: Yes
- Type: int
The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a
PutMetricData
call that includes aStorageResolution
of 1 second. - Stat
-
- Required: Yes
- Type: string
The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.
- Unit
-
- Type: string
If you omit
Unit
then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
MonitoredRequestCountMetricDataQueries
Description
This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric
is divided by the number found for MonitoredRequestCountMetric
to determine the percentage of successful requests that this SLO tracks.
Members
- BadCountMetric
-
- Type: Array of MetricDataQuery structures
If you want to count "bad requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "bad requests" in this structure.
- GoodCountMetric
-
- Type: Array of MetricDataQuery structures
If you want to count "good requests" to determine the percentage of successful requests for this request-based SLO, specify the metric to use as "good requests" in this structure.
RequestBasedServiceLevelIndicator
Description
This structure contains information about the performance metric that a request-based SLO monitors.
Members
- ComparisonOperator
-
- Type: string
The arithmetic operation used when comparing the specified metric to the threshold.
- MetricThreshold
-
- Type: double
This value is the threshold that the observed metric values of the SLI metric are compared to.
- RequestBasedSliMetric
-
- Required: Yes
- Type: RequestBasedServiceLevelIndicatorMetric structure
A structure that contains information about the metric that the SLO monitors.
RequestBasedServiceLevelIndicatorConfig
Description
This structure specifies the information about the service and the performance metric that a request-based SLO is to monitor.
Members
- ComparisonOperator
-
- Type: string
The arithmetic operation to use when comparing the specified metric to the threshold. This parameter is required if this SLO is tracking the
Latency
metric. - MetricThreshold
-
- Type: double
The value that the SLI metric is compared to. This parameter is required if this SLO is tracking the
Latency
metric. - RequestBasedSliMetricConfig
-
- Required: Yes
- Type: RequestBasedServiceLevelIndicatorMetricConfig structure
Use this structure to specify the metric to be used for the SLO.
RequestBasedServiceLevelIndicatorMetric
Description
This structure contains the information about the metric that is used for a request-based SLO.
Members
- KeyAttributes
-
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.
-
Type
designates the type of object that this SLO is related to. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MetricType
-
- Type: string
If the SLO monitors either the
LATENCY
orAVAILABILITY
metric that Application Signals collects, this field displays which of those metrics is used. - MonitoredRequestCountMetric
-
- Required: Yes
- Type: MonitoredRequestCountMetricDataQueries structure
This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in
TotalRequestCountMetric
is divided by the number found forMonitoredRequestCountMetric
to determine the percentage of successful requests that this SLO tracks. - OperationName
-
- Type: string
If the SLO monitors a specific operation of the service, this field displays that operation name.
- TotalRequestCountMetric
-
- Required: Yes
- Type: Array of MetricDataQuery structures
This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in
MonitoredRequestCountMetric
.
RequestBasedServiceLevelIndicatorMetricConfig
Description
Use this structure to specify the information for the metric that a period-based SLO will monitor.
Members
- KeyAttributes
-
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the
Type
,Name
, andEnvironment
attributes.This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MetricType
-
- Type: string
If the SLO is to monitor either the
LATENCY
orAVAILABILITY
metric that Application Signals collects, use this field to specify which of those metrics is used. - MonitoredRequestCountMetric
-
- Type: MonitoredRequestCountMetricDataQueries structure
Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in
TotalRequestCountMetric
will be divided by the number found forMonitoredRequestCountMetric
to determine the percentage of successful requests that this SLO tracks. - OperationName
-
- Type: string
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
- TotalRequestCountMetric
-
- Type: Array of MetricDataQuery structures
Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in
MonitoredRequestCountMetric
.
ResourceNotFoundException
Description
Resource not found.
Members
- Message
-
- Required: Yes
- Type: string
- ResourceId
-
- Required: Yes
- Type: string
Can't find the resource id.
- ResourceType
-
- Required: Yes
- Type: string
The resource type is not valid.
RollingInterval
Description
If the interval for this SLO is a rolling interval, this structure contains the interval specifications.
Members
- Duration
-
- Required: Yes
- Type: int
Specifies the duration of each rolling interval. For example, if
Duration
is7
andDurationUnit
isDAY
, each rolling interval is seven days. - DurationUnit
-
- Required: Yes
- Type: string
Specifies the rolling interval unit.
Service
Description
This structure contains information about one of your services that was discovered by Application Signals.
Members
- AttributeMaps
-
- Type: Array of stringss
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
-
PlatformType
defines the hosted-in platform. -
EKS.Cluster
is the name of the Amazon EKS cluster. -
K8s.Cluster
is the name of the self-hosted Kubernetes cluster. -
K8s.Namespace
is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters. -
K8s.Workload
is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters. -
K8s.Node
is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters. -
K8s.Pod
is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters. -
EC2.AutoScalingGroup
is the name of the Amazon EC2 Auto Scaling group. -
EC2.InstanceId
is the ID of the Amazon EC2 instance. -
Host
is the name of the host, for all platform types.
Application attributes contain information about the application.
-
AWS.Application
is the application's name in Amazon Web Services Service Catalog AppRegistry. -
AWS.Application.ARN
is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
-
Telemetry.SDK
is the fingerprint of the OpenTelemetry SDK version for instrumented services. -
Telemetry.Agent
is the fingerprint of the agent used to collect and send telemetry data. -
Telemetry.Source
Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
- KeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- LogGroupReferences
-
- Type: Array of stringss
An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:
-
"Type": "AWS::Resource"
-
"ResourceType": "AWS::Logs::LogGroup"
-
"Identifier": "name-of-log-group"
- MetricReferences
-
- Required: Yes
- Type: Array of MetricReference structures
An array of structures that each contain information about one metric associated with this service.
ServiceDependency
Description
This structure contains information about one dependency of this service.
Members
- DependencyKeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- DependencyOperationName
-
- Required: Yes
- Type: string
The name of the called operation in the dependency.
- MetricReferences
-
- Required: Yes
- Type: Array of MetricReference structures
An array of structures that each contain information about one metric associated with this service dependency that was discovered by Application Signals.
- OperationName
-
- Required: Yes
- Type: string
The name of the operation in this service that calls the dependency.
ServiceDependent
Description
This structure contains information about a service dependent that was discovered by Application Signals. A dependent is an entity that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.
Members
- DependentKeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- DependentOperationName
-
- Type: string
If the dependent invoker was a service that invoked it from an operation, the name of that dependent operation is displayed here.
- MetricReferences
-
- Required: Yes
- Type: Array of MetricReference structures
An array of structures that each contain information about one metric associated with this service dependent that was discovered by Application Signals.
- OperationName
-
- Type: string
If the invoked entity is an operation on an entity, the name of that dependent operation is displayed here.
ServiceLevelIndicator
Description
This structure contains information about the performance metric that a period-based SLO monitors.
Members
- ComparisonOperator
-
- Required: Yes
- Type: string
The arithmetic operation used when comparing the specified metric to the threshold.
- MetricThreshold
-
- Required: Yes
- Type: double
The value that the SLI metric is compared to.
- SliMetric
-
- Required: Yes
- Type: ServiceLevelIndicatorMetric structure
A structure that contains information about the metric that the SLO monitors.
ServiceLevelIndicatorConfig
Description
This structure specifies the information about the service and the performance metric that a period-based SLO is to monitor.
Members
- ComparisonOperator
-
- Required: Yes
- Type: string
The arithmetic operation to use when comparing the specified metric to the threshold.
- MetricThreshold
-
- Required: Yes
- Type: double
This parameter is used only when a request-based SLO tracks the
Latency
metric. Specify the threshold value that the observedLatency
metric values are to be compared to. - SliMetricConfig
-
- Required: Yes
- Type: ServiceLevelIndicatorMetricConfig structure
Use this structure to specify the metric to be used for the SLO.
ServiceLevelIndicatorMetric
Description
This structure contains the information about the metric that is used for a period-based SLO.
Members
- KeyAttributes
-
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.
-
Type
designates the type of object that this SLO is related to. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MetricDataQueries
-
- Required: Yes
- Type: Array of MetricDataQuery structures
If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression.
- MetricType
-
- Type: string
If the SLO monitors either the
LATENCY
orAVAILABILITY
metric that Application Signals collects, this field displays which of those metrics is used. - OperationName
-
- Type: string
If the SLO monitors a specific operation of the service, this field displays that operation name.
ServiceLevelIndicatorMetricConfig
Description
Use this structure to specify the information for the metric that a period-based SLO will monitor.
Members
- KeyAttributes
-
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the
Type
,Name
, andEnvironment
attributes.This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MetricDataQueries
-
- Type: Array of MetricDataQuery structures
If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.
- MetricType
-
- Type: string
If the SLO is to monitor either the
LATENCY
orAVAILABILITY
metric that Application Signals collects, use this field to specify which of those metrics is used. - OperationName
-
- Type: string
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
- PeriodSeconds
-
- Type: int
The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.
- Statistic
-
- Type: string
The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.
ServiceLevelObjective
Description
A structure containing information about one service level objective (SLO) that has been created in Application Signals. Creating SLOs can help you ensure your services are performing to the level that you expect. SLOs help you set and track a specific target level for the reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is a key performance metric, to calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of this SLO.
- BurnRateConfigurations
-
- Type: Array of BurnRateConfiguration structures
Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.
- CreatedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that this SLO was created. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
. - Description
-
- Type: string
The description that you created for this SLO.
- EvaluationType
-
- Type: string
Displays whether this is a period-based SLO or a request-based SLO.
- Goal
-
- Required: Yes
- Type: Goal structure
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
- LastUpdatedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that this SLO was most recently updated. When used in a raw HTTP Query API, it is formatted as
yyyy-MM-dd'T'HH:mm:ss
. For example,2019-07-01T23:59:59
. - Name
-
- Required: Yes
- Type: string
The name of this SLO.
- RequestBasedSli
-
- Type: RequestBasedServiceLevelIndicator structure
A structure containing information about the performance metric that this SLO monitors, if this is a request-based SLO.
- Sli
-
- Type: ServiceLevelIndicator structure
A structure containing information about the performance metric that this SLO monitors, if this is a period-based SLO.
ServiceLevelObjectiveBudgetReport
Description
A structure containing an SLO budget report that you have requested.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the SLO that this report is for.
- Attainment
-
- Type: double
A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.
If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.
If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.
- BudgetRequestsRemaining
-
- Type: int
This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.
This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.
- BudgetSecondsRemaining
-
- Type: int
The budget amount remaining before the SLO status becomes
BREACHING
, at the time specified in theTimestemp
parameter of the request. If this value is negative, then the SLO is already inBREACHING
status.This field is included only if the SLO is a period-based SLO.
- BudgetStatus
-
- Required: Yes
- Type: string
The status of this SLO, as it relates to the error budget for the entire time interval.
-
OK
means that the SLO had remaining budget above the warning threshold, as of the time that you specified inTimeStamp
. -
WARNING
means that the SLO's remaining budget was below the warning threshold, as of the time that you specified inTimeStamp
. -
BREACHED
means that the SLO's budget was exhausted, as of the time that you specified inTimeStamp
. -
INSUFFICIENT_DATA
means that the specified start and end times were before the SLO was created, or that attainment data is missing.
- EvaluationType
-
- Type: string
Displays whether this budget report is for a period-based SLO or a request-based SLO.
- Goal
-
- Type: Goal structure
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
- Name
-
- Required: Yes
- Type: string
The name of the SLO that this report is for.
- RequestBasedSli
-
- Type: RequestBasedServiceLevelIndicator structure
This structure contains information about the performance metric that a request-based SLO monitors.
- Sli
-
- Type: ServiceLevelIndicator structure
A structure that contains information about the performance metric that this SLO monitors.
- TotalBudgetRequests
-
- Type: int
This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.
This number can go up and down between reports with different time stamps, based on both how many total requests occur.
- TotalBudgetSeconds
-
- Type: int
The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.
ServiceLevelObjectiveBudgetReportError
Description
A structure containing information about one error that occurred during a BatchGetServiceLevelObjectiveBudgetReport operation.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the SLO that this error is related to.
- ErrorCode
-
- Required: Yes
- Type: string
The error code for this error.
- ErrorMessage
-
- Required: Yes
- Type: string
The message for this error.
- Name
-
- Required: Yes
- Type: string
The name of the SLO that this error is related to.
ServiceLevelObjectiveSummary
Description
A structure that contains information about one service level objective (SLO) created in Application Signals.
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of this service level objective.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
- KeyAttributes
-
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this service level objective is for. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- Name
-
- Required: Yes
- Type: string
The name of the service level objective.
- OperationName
-
- Type: string
If this service level objective is specific to a single operation, this field displays the name of that operation.
ServiceOperation
Description
This structure contains information about an operation discovered by Application Signals. An operation is a specific function performed by a service that was discovered by Application Signals, and is often an API that is called by an upstream dependent.
Members
- MetricReferences
-
- Required: Yes
- Type: Array of MetricReference structures
An array of structures that each contain information about one metric associated with this service operation that was discovered by Application Signals.
- Name
-
- Required: Yes
- Type: string
The name of the operation, discovered by Application Signals.
ServiceQuotaExceededException
Description
This request exceeds a service quota.
Members
- Message
-
- Required: Yes
- Type: string
ServiceSummary
Description
This structure contains information about one of your services that was discovered by Application Signals
Members
- AttributeMaps
-
- Type: Array of stringss
This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes, application attributes, and telemetry attributes.
Platform attributes contain information the service's platform.
-
PlatformType
defines the hosted-in platform. -
EKS.Cluster
is the name of the Amazon EKS cluster. -
K8s.Cluster
is the name of the self-hosted Kubernetes cluster. -
K8s.Namespace
is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters. -
K8s.Workload
is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters. -
K8s.Node
is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters. -
K8s.Pod
is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters. -
EC2.AutoScalingGroup
is the name of the Amazon EC2 Auto Scaling group. -
EC2.InstanceId
is the ID of the Amazon EC2 instance. -
Host
is the name of the host, for all platform types.
Application attributes contain information about the application.
-
AWS.Application
is the application's name in Amazon Web Services Service Catalog AppRegistry. -
AWS.Application.ARN
is the application's ARN in Amazon Web Services Service Catalog AppRegistry.
Telemetry attributes contain telemetry information.
-
Telemetry.SDK
is the fingerprint of the OpenTelemetry SDK version for instrumented services. -
Telemetry.Agent
is the fingerprint of the agent used to collect and send telemetry data. -
Telemetry.Source
Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.
- KeyAttributes
-
- Required: Yes
- Type: Associative array of custom strings keys (KeyAttributeName) to strings
This is a string-to-string map that help identify the objects discovered by Application Signals. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
- MetricReferences
-
- Required: Yes
- Type: Array of MetricReference structures
An array of structures that each contain information about one metric associated with this service.
Tag
Description
A key-value pair associated with a resource. Tags can help you organize and categorize your resources.
Members
- Key
-
- Required: Yes
- Type: string
A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
- Value
-
- Required: Yes
- Type: string
The value for the specified tag key.
ThrottlingException
Description
The request was throttled because of quota limits.
Members
- Message
-
- Required: Yes
- Type: string
ValidationException
Description
The resource is not valid.
Members
- message
-
- Type: string