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

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' => [
                    'DependencyConfig' => [
                        'DependencyKeyAttributes' => ['<string>', ...],
                        'DependencyOperationName' => '<string>',
                    ],
                    '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' => [
                    'DependencyConfig' => [
                        'DependencyKeyAttributes' => ['<string>', ...],
                        'DependencyOperationName' => '<string>',
                    ],
                    '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

Errors

ValidationException:

The resource is not valid.

ThrottlingException:

The request was throttled because of quota limits.

BatchUpdateExclusionWindows

$result = $client->batchUpdateExclusionWindows([/* ... */]);
$promise = $client->batchUpdateExclusionWindowsAsync([/* ... */]);

Add or remove time window exclusions for one or more Service Level Objectives (SLOs).

Parameter Syntax

$result = $client->batchUpdateExclusionWindows([
    'AddExclusionWindows' => [
        [
            'Reason' => '<string>',
            'RecurrenceRule' => [
                'Expression' => '<string>', // REQUIRED
            ],
            'StartTime' => <integer || string || DateTime>,
            'Window' => [ // REQUIRED
                'Duration' => <integer>, // REQUIRED
                'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', // REQUIRED
            ],
        ],
        // ...
    ],
    'RemoveExclusionWindows' => [
        [
            'Reason' => '<string>',
            'RecurrenceRule' => [
                'Expression' => '<string>', // REQUIRED
            ],
            'StartTime' => <integer || string || DateTime>,
            'Window' => [ // REQUIRED
                'Duration' => <integer>, // REQUIRED
                'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH', // REQUIRED
            ],
        ],
        // ...
    ],
    'SloIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'SloId' => '<string>',
        ],
        // ...
    ],
    'SloIds' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The resource is not valid.

ResourceNotFoundException:

Resource not found.

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
            'DependencyConfig' => [
                'DependencyKeyAttributes' => ['<string>', ...], // REQUIRED
                'DependencyOperationName' => '<string>', // 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
            'DependencyConfig' => [
                'DependencyKeyAttributes' => ['<string>', ...], // REQUIRED
                'DependencyOperationName' => '<string>', // 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,
                ],
                // ...
            ],
            'MetricName' => '<string>',
            'MetricType' => 'LATENCY|AVAILABILITY',
            'OperationName' => '<string>',
            'PeriodSeconds' => <integer>,
            'Statistic' => '<string>',
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

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>,
        'MetricSourceType' => 'ServiceOperation|CloudWatchMetric|ServiceDependency',
        'Name' => '<string>',
        'RequestBasedSli' => [
            'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo',
            'MetricThreshold' => <float>,
            'RequestBasedSliMetric' => [
                'DependencyConfig' => [
                    'DependencyKeyAttributes' => ['<string>', ...],
                    'DependencyOperationName' => '<string>',
                ],
                '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' => [
                'DependencyConfig' => [
                    'DependencyKeyAttributes' => ['<string>', ...],
                    'DependencyOperationName' => '<string>',
                ],
                '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

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.

DeleteGroupingConfiguration

$result = $client->deleteGroupingConfiguration([/* ... */]);
$promise = $client->deleteGroupingConfigurationAsync([/* ... */]);

Deletes a grouping configuration that defines how services are grouped and organized in Application Signals. Once deleted, services will no longer be grouped according to the specified configuration rules.

This operation is irreversible. After deletion, you must recreate the grouping configuration if you want to restore the same grouping behavior.

Parameter Syntax

$result = $client->deleteGroupingConfiguration([
]);

Parameter Details

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.

DeleteServiceLevelObjective

$result = $client->deleteServiceLevelObjective([/* ... */]);
$promise = $client->deleteServiceLevelObjectiveAsync([/* ... */]);

Deletes the specified service level objective.

Parameter Syntax

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

Parameter Details

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

Result Syntax

[
    'EndTime' => <DateTime>,
    'LogGroupReferences' => [
        ['<string>', ...],
        // ...
    ],
    'Service' => [
        'AttributeMaps' => [
            ['<string>', ...],
            // ...
        ],
        'KeyAttributes' => ['<string>', ...],
        'LogGroupReferences' => [
            ['<string>', ...],
            // ...
        ],
        'MetricReferences' => [
            [
                'AccountId' => '<string>',
                'Dimensions' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'MetricName' => '<string>',
                'MetricType' => '<string>',
                'Namespace' => '<string>',
            ],
            // ...
        ],
        'ServiceGroups' => [
            [
                'GroupIdentifier' => '<string>',
                'GroupName' => '<string>',
                'GroupSource' => '<string>',
                'GroupValue' => '<string>',
            ],
            // ...
        ],
    ],
    'StartTime' => <DateTime>,
]

Result Details

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

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>,
        'MetricSourceType' => 'ServiceOperation|CloudWatchMetric|ServiceDependency',
        'Name' => '<string>',
        'RequestBasedSli' => [
            'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo',
            'MetricThreshold' => <float>,
            'RequestBasedSliMetric' => [
                'DependencyConfig' => [
                    'DependencyKeyAttributes' => ['<string>', ...],
                    'DependencyOperationName' => '<string>',
                ],
                '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' => [
                'DependencyConfig' => [
                    'DependencyKeyAttributes' => ['<string>', ...],
                    'DependencyOperationName' => '<string>',
                ],
                '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

Errors

ValidationException:

The resource is not valid.

ResourceNotFoundException:

Resource not found.

ThrottlingException:

The request was throttled because of quota limits.

ListAuditFindings

$result = $client->listAuditFindings([/* ... */]);
$promise = $client->listAuditFindingsAsync([/* ... */]);

Retrieves a list of audit findings for Application Signals resources. Audit findings identify potential issues, misconfigurations, or compliance violations in your observability setup.

You can filter findings by time range, auditor type, and target resources to focus on specific areas of concern. This operation supports pagination for large result sets.

Parameter Syntax

$result = $client->listAuditFindings([
    'AuditTargets' => [ // REQUIRED
        [
            'Data' => [ // REQUIRED
                'Canary' => [
                    'CanaryName' => '<string>', // REQUIRED
                ],
                'Service' => [
                    'AwsAccountId' => '<string>',
                    'Environment' => '<string>',
                    'Name' => '<string>',
                    'Type' => '<string>',
                ],
                'ServiceOperation' => [
                    'MetricType' => '<string>',
                    'Operation' => '<string>',
                    'Service' => [
                        'AwsAccountId' => '<string>',
                        'Environment' => '<string>',
                        'Name' => '<string>',
                        'Type' => '<string>',
                    ],
                ],
                'Slo' => [
                    'SloArn' => '<string>',
                    'SloName' => '<string>',
                ],
            ],
            'Type' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Auditors' => ['<string>', ...],
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuditFindings' => [
        [
            'AuditorResults' => [
                [
                    'Auditor' => '<string>',
                    'Description' => '<string>',
                    'Severity' => 'CRITICAL|HIGH|MEDIUM|LOW|NONE',
                ],
                // ...
            ],
            'DependencyGraph' => [
                'Edges' => [
                    [
                        'ConnectionType' => 'INDIRECT|DIRECT',
                        'DestinationNodeId' => '<string>',
                        'Duration' => <float>,
                        'SourceNodeId' => '<string>',
                    ],
                    // ...
                ],
                'Nodes' => [
                    [
                        'Duration' => <float>,
                        'KeyAttributes' => ['<string>', ...],
                        'Name' => '<string>',
                        'NodeId' => '<string>',
                        'Operation' => '<string>',
                        'Status' => '<string>',
                        'Type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'KeyAttributes' => ['<string>', ...],
            'MetricGraph' => [
                'EndTime' => <DateTime>,
                '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,
                    ],
                    // ...
                ],
                'StartTime' => <DateTime>,
            ],
            'Operation' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The resource is not valid.

ThrottlingException:

The request was throttled because of quota limits.

ListGroupingAttributeDefinitions

$result = $client->listGroupingAttributeDefinitions([/* ... */]);
$promise = $client->listGroupingAttributeDefinitionsAsync([/* ... */]);

Retrieves the available grouping attribute definitions that can be used to create grouping configurations. These definitions specify the attributes and rules available for organizing services.

Use this operation to discover what grouping options are available before creating or updating grouping configurations.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'GroupingAttributeDefinitions' => [
        [
            'DefaultGroupingValue' => '<string>',
            'GroupingName' => '<string>',
            'GroupingSourceKeys' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'UpdatedAt' => <DateTime>,
]

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.

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

Result Syntax

[
    'EndTime' => <DateTime>,
    'NextToken' => '<string>',
    'ServiceDependencies' => [
        [
            'DependencyKeyAttributes' => ['<string>', ...],
            'DependencyOperationName' => '<string>',
            'MetricReferences' => [
                [
                    'AccountId' => '<string>',
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricName' => '<string>',
                    'MetricType' => '<string>',
                    'Namespace' => '<string>',
                ],
                // ...
            ],
            'OperationName' => '<string>',
        ],
        // ...
    ],
    'StartTime' => <DateTime>,
]

Result Details

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

Result Syntax

[
    'EndTime' => <DateTime>,
    'NextToken' => '<string>',
    'ServiceDependents' => [
        [
            'DependentKeyAttributes' => ['<string>', ...],
            'DependentOperationName' => '<string>',
            'MetricReferences' => [
                [
                    'AccountId' => '<string>',
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricName' => '<string>',
                    'MetricType' => '<string>',
                    'Namespace' => '<string>',
                ],
                // ...
            ],
            'OperationName' => '<string>',
        ],
        // ...
    ],
    'StartTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The resource is not valid.

ThrottlingException:

The request was throttled because of quota limits.

ListServiceLevelObjectiveExclusionWindows

$result = $client->listServiceLevelObjectiveExclusionWindows([/* ... */]);
$promise = $client->listServiceLevelObjectiveExclusionWindowsAsync([/* ... */]);

Retrieves all exclusion windows configured for a specific SLO.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ExclusionWindows' => [
        [
            'Reason' => '<string>',
            'RecurrenceRule' => [
                'Expression' => '<string>',
            ],
            'StartTime' => <DateTime>,
            'Window' => [
                'Duration' => <integer>,
                'DurationUnit' => 'MINUTE|HOUR|DAY|MONTH',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The resource is not valid.

ResourceNotFoundException:

Resource not found.

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([
    'DependencyConfig' => [
        'DependencyKeyAttributes' => ['<string>', ...], // REQUIRED
        'DependencyOperationName' => '<string>', // REQUIRED
    ],
    'IncludeLinkedAccounts' => true || false,
    'KeyAttributes' => ['<string>', ...],
    'MaxResults' => <integer>,
    'MetricSourceTypes' => ['<string>', ...],
    'NextToken' => '<string>',
    'OperationName' => '<string>',
    'SloOwnerAwsAccountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SloSummaries' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'DependencyConfig' => [
                'DependencyKeyAttributes' => ['<string>', ...],
                'DependencyOperationName' => '<string>',
            ],
            'EvaluationType' => 'PeriodBased|RequestBased',
            'KeyAttributes' => ['<string>', ...],
            'MetricSourceType' => 'ServiceOperation|CloudWatchMetric|ServiceDependency',
            'Name' => '<string>',
            'OperationName' => '<string>',
        ],
        // ...
    ],
]

Result Details

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

Result Syntax

[
    'EndTime' => <DateTime>,
    'NextToken' => '<string>',
    'ServiceOperations' => [
        [
            'MetricReferences' => [
                [
                    'AccountId' => '<string>',
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricName' => '<string>',
                    'MetricType' => '<string>',
                    'Namespace' => '<string>',
                ],
                // ...
            ],
            'Name' => '<string>',
        ],
        // ...
    ],
    'StartTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The resource is not valid.

ThrottlingException:

The request was throttled because of quota limits.

ListServiceStates

$result = $client->listServiceStates([/* ... */]);
$promise = $client->listServiceStatesAsync([/* ... */]);

Retrieves the current state information for services monitored by Application Signals. Service states include health status, recent change events, and other operational metadata.

You can filter results by time range, AWS account, and service attributes to focus on specific services or time periods. This operation supports pagination and can include data from linked accounts.

Parameter Syntax

$result = $client->listServiceStates([
    'AttributeFilters' => [
        [
            'AttributeFilterName' => '<string>', // REQUIRED
            'AttributeFilterValues' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'AwsAccountId' => '<string>',
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'IncludeLinkedAccounts' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndTime' => <DateTime>,
    'NextToken' => '<string>',
    'ServiceStates' => [
        [
            'AttributeFilters' => [
                [
                    'AttributeFilterName' => '<string>',
                    'AttributeFilterValues' => ['<string>', ...],
                ],
                // ...
            ],
            'LatestChangeEvents' => [
                [
                    'AccountId' => '<string>',
                    'ChangeEventType' => 'DEPLOYMENT',
                    'Entity' => ['<string>', ...],
                    'EventId' => '<string>',
                    'EventName' => '<string>',
                    'Region' => '<string>',
                    'Timestamp' => <DateTime>,
                    'UserName' => '<string>',
                ],
                // ...
            ],
            'Service' => ['<string>', ...],
        ],
        // ...
    ],
    'StartTime' => <DateTime>,
]

Result Details

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([
    'AwsAccountId' => '<string>',
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'IncludeLinkedAccounts' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EndTime' => <DateTime>,
    'NextToken' => '<string>',
    'ServiceSummaries' => [
        [
            'AttributeMaps' => [
                ['<string>', ...],
                // ...
            ],
            'KeyAttributes' => ['<string>', ...],
            'MetricReferences' => [
                [
                    'AccountId' => '<string>',
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricName' => '<string>',
                    'MetricType' => '<string>',
                    'Namespace' => '<string>',
                ],
                // ...
            ],
            'ServiceGroups' => [
                [
                    'GroupIdentifier' => '<string>',
                    'GroupName' => '<string>',
                    'GroupSource' => '<string>',
                    'GroupValue' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'StartTime' => <DateTime>,
]

Result Details

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

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

Resource not found.

ThrottlingException:

The request was throttled because of quota limits.

PutGroupingConfiguration

$result = $client->putGroupingConfiguration([/* ... */]);
$promise = $client->putGroupingConfigurationAsync([/* ... */]);

Creates or updates a grouping configuration that defines how services are organized and grouped in Application Signals dashboards and service maps.

Grouping configurations allow you to logically organize services based on attributes such as environment, team ownership, or business function, making it easier to monitor and manage related services together.

Parameter Syntax

$result = $client->putGroupingConfiguration([
    'GroupingAttributeDefinitions' => [ // REQUIRED
        [
            'DefaultGroupingValue' => '<string>',
            'GroupingName' => '<string>', // REQUIRED
            'GroupingSourceKeys' => ['<string>', ...],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'GroupingConfiguration' => [
        'GroupingAttributeDefinitions' => [
            [
                'DefaultGroupingValue' => '<string>',
                'GroupingName' => '<string>',
                'GroupingSourceKeys' => ['<string>', ...],
            ],
            // ...
        ],
        'UpdatedAt' => <DateTime>,
    ],
]

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.

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

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

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

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
            'DependencyConfig' => [
                'DependencyKeyAttributes' => ['<string>', ...], // REQUIRED
                'DependencyOperationName' => '<string>', // 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
            'DependencyConfig' => [
                'DependencyKeyAttributes' => ['<string>', ...], // REQUIRED
                'DependencyOperationName' => '<string>', // 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,
                ],
                // ...
            ],
            'MetricName' => '<string>',
            'MetricType' => 'LATENCY|AVAILABILITY',
            'OperationName' => '<string>',
            'PeriodSeconds' => <integer>,
            'Statistic' => '<string>',
        ],
    ],
]);

Parameter Details

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>,
        'MetricSourceType' => 'ServiceOperation|CloudWatchMetric|ServiceDependency',
        'Name' => '<string>',
        'RequestBasedSli' => [
            'ComparisonOperator' => 'GreaterThanOrEqualTo|GreaterThan|LessThan|LessThanOrEqualTo',
            'MetricThreshold' => <float>,
            'RequestBasedSliMetric' => [
                'DependencyConfig' => [
                    'DependencyKeyAttributes' => ['<string>', ...],
                    'DependencyOperationName' => '<string>',
                ],
                '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' => [
                'DependencyConfig' => [
                    'DependencyKeyAttributes' => ['<string>', ...],
                    'DependencyOperationName' => '<string>',
                ],
                '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

Errors

ValidationException:

The resource is not valid.

ResourceNotFoundException:

Resource not found.

ThrottlingException:

The request was throttled because of quota limits.