CreateAccessGrant

$result = $client->createAccessGrant([/* ... */]);
$promise = $client->createAccessGrantAsync([/* ... */]);

Creates an AccessGrant that authorizes a principal to perform a set of actions on resources in a space.

Optionally narrow the grant with scoped actions that limit it to specific resources and fields. Use ListAccessGrants and GetAccessGrant to retrieve grants, and DeleteAccessGrant to remove them.

Parameter Syntax

$result = $client->createAccessGrant([
    'clientToken' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'permission' => 'SPACE_ADMIN|READ|READ_WRITE_DELETE|CUSTOM', // REQUIRED
    'principal' => [ // REQUIRED
        'principalAttributes' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'principalId' => '<string>',
        'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT|ACCESS_PROFILE|ALERT|AGENT', // REQUIRED
    ],
    'scopedActions' => [
        [
            'actions' => ['<string>', ...], // REQUIRED
            'contextConditions' => [
                '<String>' => ['<string>', ...],
                // ...
            ],
            'resources' => [
                [
                    'resourceArns' => ['<string>', ...],
                    'resourceType' => '<string>', // REQUIRED
                    'rowScopeGroups' => [
                        [
                            [
                                'field' => '<string>', // REQUIRED
                                'operator' => 'IN', // REQUIRED
                                'values' => ['<string>', ...], // REQUIRED
                            ],
                            // ...
                        ],
                        // ...
                    ],
                    'signalTypes' => ['<string>', ...],
                    'tags' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'spaceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'accessGrant' => [
        'accountId' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'domainId' => '<string>',
        'grantArn' => '<string>',
        'grantId' => '<string>',
        'grantType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        'name' => '<string>',
        'permission' => 'SPACE_ADMIN|READ|READ_WRITE_DELETE|CUSTOM',
        'principal' => [
            'principalAttributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'principalId' => '<string>',
            'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT|ACCESS_PROFILE|ALERT|AGENT',
        ],
        'scopedActions' => [
            [
                'actions' => ['<string>', ...],
                'contextConditions' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'resources' => [
                    [
                        'resourceArns' => ['<string>', ...],
                        'resourceType' => '<string>',
                        'rowScopeGroups' => [
                            [
                                [
                                    'field' => '<string>',
                                    'operator' => 'IN',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            // ...
                        ],
                        'signalTypes' => ['<string>', ...],
                        'tags' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'spaceId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Create an access grant

The following example creates a custom access grant that authorizes an Identity Center user to read and update a specific dashboard in a space. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createAccessGrant([
    'name' => 'analyst-read-access',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'domainId' => 'd-1a2b3c4d5e',
    'permission' => 'CUSTOM',
    'principal' => [
        'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
        'principalType' => 'IDC_USER',
    ],
    'scopedActions' => [
        [
            'actions' => [
                'cloudwatch:GetOmniDashboard',
                'cloudwatch:UpdateOmniDashboard',
            ],
            'resources' => [
                [
                    'resourceArns' => [
                        'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
                    ],
                    'resourceType' => 'OmniDashboard',
                ],
            ],
        ],
    ],
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'accessGrant' => [
        'name' => 'analyst-read-access',
        'accountId' => '123456789012',
        'createdAt' => ,
        'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
        'domainId' => 'd-1a2b3c4d5e',
        'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-grant/7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantType' => 'CUSTOMER_MANAGED',
        'permission' => 'CUSTOM',
        'principal' => [
            'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
            'principalType' => 'IDC_USER',
        ],
        'scopedActions' => [
            [
                'actions' => [
                    'cloudwatch:GetOmniDashboard',
                    'cloudwatch:UpdateOmniDashboard',
                ],
                'resources' => [
                    [
                        'resourceArns' => [
                            'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
                        ],
                        'resourceType' => 'OmniDashboard',
                    ],
                ],
            ],
        ],
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

CreateAccessProfile

$result = $client->createAccessProfile([/* ... */]);
$promise = $client->createAccessProfileAsync([/* ... */]);

Creates an access profile in a space.

Use GetAccessProfile and ListAccessProfiles to retrieve profiles, and UpdateAccessProfile to modify one.

Parameter Syntax

$result = $client->createAccessProfile([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'accessProfile' => [
        'arn' => '<string>',
        'assumeStatus' => 'ALLOWED|DENIED',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'profileId' => '<string>',
        'profileType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        'spaceId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Create an access profile

The following example creates a customer-managed access profile in a space. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createAccessProfile([
    'name' => 'Analyst read-only profile',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'description' => 'Read-only access for analysts.',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'accessProfile' => [
        'name' => 'Analyst read-only profile',
        'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-profile/analyst-readonly',
        'assumeStatus' => 'ALLOWED',
        'createdAt' => ,
        'description' => 'Read-only access for analysts.',
        'profileId' => 'analyst-readonly',
        'profileType' => 'CUSTOMER_MANAGED',
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

CreateAlert

$result = $client->createAlert([/* ... */]);
$promise = $client->createAlertAsync([/* ... */]);

Creates a new alert within a space.

Use GetAlert and ListAlerts to retrieve alerts, UpdateAlert to modify one, and DeleteAlert to remove it.

Parameter Syntax

$result = $client->createAlert([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'notificationRules' => [
        [
            'target' => [ // REQUIRED
                'arn' => '<string>', // REQUIRED
                'metadata' => ['<string>', ...],
                'type' => 'sns|slack|pagerduty', // REQUIRED
            ],
            'trigger' => [ // REQUIRED
                'stateValues' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'notificationsEnabled' => true || false,
    'profileId' => '<string>', // REQUIRED
    'rule' => [ // REQUIRED
        'telemetryRule' => [
            'condition' => [
                'comparator' => 'GT|LT|GTE|LTE',
                'criticalThreshold' => <float>,
                'thresholdField' => '<string>',
                'thresholdMode' => 'COUNT_OF_RESULTS|FIELD_VALUE',
                'warningThreshold' => <float>,
            ],
            'evaluation' => [
                'intervalSeconds' => <integer>, // REQUIRED
                'pendingDurationSeconds' => <integer>,
                'recoveryDurationSeconds' => <integer>,
            ],
            'noData' => [
                'treatAs' => 'OK|WARNING|CRITICAL|NODATA', // REQUIRED
            ],
            'query' => [
                'expression' => '<string>', // REQUIRED
                'language' => 'SQL|PROMQL', // REQUIRED
            ],
        ],
    ],
    'spaceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'alert' => [
        'accountId' => '<string>',
        'alertArn' => '<string>',
        'alertId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'notificationRules' => [
            [
                'target' => [
                    'arn' => '<string>',
                    'metadata' => ['<string>', ...],
                    'type' => 'sns|slack|pagerduty',
                ],
                'trigger' => [
                    'stateValues' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'notificationStatus' => 'ENABLED|DISABLED',
        'profileId' => '<string>',
        'rule' => [
            'telemetryRule' => [
                'condition' => [
                    'comparator' => 'GT|LT|GTE|LTE',
                    'criticalThreshold' => <float>,
                    'thresholdField' => '<string>',
                    'thresholdMode' => 'COUNT_OF_RESULTS|FIELD_VALUE',
                    'warningThreshold' => <float>,
                ],
                'evaluation' => [
                    'intervalSeconds' => <integer>,
                    'pendingDurationSeconds' => <integer>,
                    'recoveryDurationSeconds' => <integer>,
                ],
                'noData' => [
                    'treatAs' => 'OK|WARNING|CRITICAL|NODATA',
                ],
                'query' => [
                    'expression' => '<string>',
                    'language' => 'SQL|PROMQL',
                ],
            ],
        ],
        'spaceId' => '<string>',
        'state' => [
            'contributorSummary' => [
                'criticalCount' => <integer>,
                'warningCount' => <integer>,
            ],
            'data' => [
                'thresholdBreached' => <float>,
            ],
            'transitionedAt' => <DateTime>,
            'value' => 'OK|WARNING|CRITICAL|NODATA',
        ],
        'updatedAt' => <DateTime>,
    ],
    'alertArn' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Create an alert on a field value

The following example creates an alert whose threshold is compared against a named field of each result row, so every service the query groups by is tracked as its own contributor. FIELD_VALUE requires thresholdField. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createAlert([
    'name' => 'service-error-count-elevated',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'description' => 'Alerts when a service logs more errors than its accepted rate.',
    'notificationRules' => [
        [
            'target' => [
                'metadata' => [
                    'channel' => 'oncall-alerts',
                ],
                'type' => 'slack',
                'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
            ],
            'trigger' => [
                'stateValues' => [
                    'CRITICAL',
                ],
            ],
        ],
    ],
    'notificationsEnabled' => 1,
    'profileId' => 'analyst-readonly',
    'rule' => [
        'telemetryRule' => [
            'condition' => [
                'comparator' => 'GT',
                'criticalThreshold' => 200,
                'thresholdField' => 'error_count',
                'thresholdMode' => 'FIELD_VALUE',
                'warningThreshold' => 50,
            ],
            'evaluation' => [
                'intervalSeconds' => 300,
                'pendingDurationSeconds' => 600,
                'recoveryDurationSeconds' => 300,
            ],
            'noData' => [
                'treatAs' => 'NODATA',
            ],
            'query' => [
                'expression' => 'SELECT resource['attributes']['service.name'] AS service, COUNT(*) AS error_count FROM "logs.default" WHERE severityText = 'ERROR' GROUP BY service',
                'language' => 'SQL',
            ],
        ],
    ],
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'alert' => [
        'name' => 'service-error-count-elevated',
        'accountId' => '123456789012',
        'alertArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:alert/c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
        'alertId' => 'c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
        'createdAt' => ,
        'description' => 'Alerts when a service logs more errors than its accepted rate.',
        'notificationRules' => [
            [
                'target' => [
                    'metadata' => [
                        'channel' => 'oncall-alerts',
                    ],
                    'type' => 'slack',
                    'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
                ],
                'trigger' => [
                    'stateValues' => [
                        'CRITICAL',
                    ],
                ],
            ],
        ],
        'notificationStatus' => 'ENABLED',
        'profileId' => 'analyst-readonly',
        'rule' => [
            'telemetryRule' => [
                'condition' => [
                    'comparator' => 'GT',
                    'criticalThreshold' => 200,
                    'thresholdField' => 'error_count',
                    'thresholdMode' => 'FIELD_VALUE',
                    'warningThreshold' => 50,
                ],
                'evaluation' => [
                    'intervalSeconds' => 300,
                    'pendingDurationSeconds' => 600,
                    'recoveryDurationSeconds' => 300,
                ],
                'noData' => [
                    'treatAs' => 'NODATA',
                ],
                'query' => [
                    'expression' => 'SELECT resource['attributes']['service.name'] AS service, COUNT(*) AS error_count FROM "logs.default" WHERE severityText = 'ERROR' GROUP BY service',
                    'language' => 'SQL',
                ],
            ],
        ],
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

Example 2: Create an alert on the number of matching rows

The following example creates an alert whose threshold is compared against how many rows the query returns, rather than a value within them. COUNT_OF_RESULTS takes no thresholdField. Notifications are created disabled, so the alert evaluates and records state without sending anything, and an empty result set is treated as OK rather than as missing data. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createAlert([
    'name' => 'service-checkout-5xx-responses',
    'description' => 'Counts checkout responses that returned a server error.',
    'notificationsEnabled' => ,
    'profileId' => 'analyst-readonly',
    'rule' => [
        'telemetryRule' => [
            'condition' => [
                'comparator' => 'GT',
                'criticalThreshold' => 50,
                'thresholdMode' => 'COUNT_OF_RESULTS',
                'warningThreshold' => 10,
            ],
            'evaluation' => [
                'intervalSeconds' => 60,
                'pendingDurationSeconds' => 120,
            ],
            'noData' => [
                'treatAs' => 'OK',
            ],
            'query' => [
                'expression' => 'SELECT * FROM "logs.default" WHERE resource['attributes']['service.name'] = 'checkout' AND attributes['http.response.status_code'] >= 500',
                'language' => 'SQL',
            ],
        ],
    ],
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'alert' => [
        'name' => 'service-checkout-5xx-responses',
        'accountId' => '123456789012',
        'alertArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:alert/d4e5f6a78b9c4d0e9f1a2b3c4d5e6f70',
        'alertId' => 'd4e5f6a78b9c4d0e9f1a2b3c4d5e6f70',
        'createdAt' => ,
        'description' => 'Counts checkout responses that returned a server error.',
        'notificationStatus' => 'DISABLED',
        'profileId' => 'analyst-readonly',
        'rule' => [
            'telemetryRule' => [
                'condition' => [
                    'comparator' => 'GT',
                    'criticalThreshold' => 50,
                    'thresholdMode' => 'COUNT_OF_RESULTS',
                    'warningThreshold' => 10,
                ],
                'evaluation' => [
                    'intervalSeconds' => 60,
                    'pendingDurationSeconds' => 120,
                ],
                'noData' => [
                    'treatAs' => 'OK',
                ],
                'query' => [
                    'expression' => 'SELECT * FROM "logs.default" WHERE resource['attributes']['service.name'] = 'checkout' AND attributes['http.response.status_code'] >= 500',
                    'language' => 'SQL',
                ],
            ],
        ],
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

Example 3: Create an alert from a PromQL query

The following example creates an alert from a PromQL expression instead of SQL. A PromQL rule compares against the series value, which is carried as the `value` field, so the condition is FIELD_VALUE with thresholdField set to `value`. Notifications go to an Amazon SNS topic, whose ARN is the topic itself rather than an integration. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createAlert([
    'name' => 'checkout-error-rate-promql',
    'description' => 'Alerts on the checkout server error rate over a five-minute window.',
    'notificationRules' => [
        [
            'target' => [
                'type' => 'sns',
                'arn' => 'arn:aws:sns:us-east-1:123456789012:checkout-oncall',
            ],
            'trigger' => [
                'stateValues' => [
                    'WARNING',
                    'CRITICAL',
                ],
            ],
        ],
    ],
    'profileId' => 'analyst-readonly',
    'rule' => [
        'telemetryRule' => [
            'condition' => [
                'comparator' => 'GT',
                'criticalThreshold' => 0.1,
                'thresholdField' => 'value',
                'thresholdMode' => 'FIELD_VALUE',
                'warningThreshold' => 0.05,
            ],
            'evaluation' => [
                'intervalSeconds' => 300,
                'pendingDurationSeconds' => 300,
            ],
            'noData' => [
                'treatAs' => 'NODATA',
            ],
            'query' => [
                'expression' => 'sum by (service_name) (rate(http_server_errors_total{service_name="checkout"}[5m]))',
                'language' => 'PROMQL',
            ],
        ],
    ],
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'alert' => [
        'name' => 'checkout-error-rate-promql',
        'accountId' => '123456789012',
        'alertArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:alert/e5f6a78b9c0d4e1f8a2b3c4d5e6f7081',
        'alertId' => 'e5f6a78b9c0d4e1f8a2b3c4d5e6f7081',
        'createdAt' => ,
        'description' => 'Alerts on the checkout server error rate over a five-minute window.',
        'notificationRules' => [
            [
                'target' => [
                    'type' => 'sns',
                    'arn' => 'arn:aws:sns:us-east-1:123456789012:checkout-oncall',
                ],
                'trigger' => [
                    'stateValues' => [
                        'WARNING',
                        'CRITICAL',
                    ],
                ],
            ],
        ],
        'notificationStatus' => 'ENABLED',
        'profileId' => 'analyst-readonly',
        'rule' => [
            'telemetryRule' => [
                'condition' => [
                    'comparator' => 'GT',
                    'criticalThreshold' => 0.1,
                    'thresholdField' => 'value',
                    'thresholdMode' => 'FIELD_VALUE',
                    'warningThreshold' => 0.05,
                ],
                'evaluation' => [
                    'intervalSeconds' => 300,
                    'pendingDurationSeconds' => 300,
                ],
                'noData' => [
                    'treatAs' => 'NODATA',
                ],
                'query' => [
                    'expression' => 'sum by (service_name) (rate(http_server_errors_total{service_name="checkout"}[5m]))',
                    'language' => 'PROMQL',
                ],
            ],
        ],
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates a domain with identity provider configuration.

Use GetDomain to retrieve the domain, UpdateDomain to change its configuration, and CreateSpace to add spaces within it.

Parameter Syntax

$result = $client->createDomain([
    'clientToken' => '<string>',
    'identityProviderConfiguration' => [
        'identityCenterConfiguration' => [
            'identityCenterInstanceArn' => '<string>',
        ],
    ],
    'identityProviders' => ['<string>', ...], // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'domain' => [
        'createdAt' => <DateTime>,
        'customEndpointUrls' => ['<string>', ...],
        'domainArn' => '<string>',
        'domainEndpointUrl' => '<string>',
        'domainId' => '<string>',
        'identityCenterApplicationArn' => '<string>',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => '<string>',
            ],
        ],
        'identityProviders' => ['<string>', ...],
        'name' => '<string>',
        'region' => '<string>',
        'status' => 'ACTIVE',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Create a domain

The following example creates an Identity Center domain and configures it with an Identity Center instance. The name must be 3-63 characters of lowercase letters, numbers, and hyphens, and the endpoint URLs are derived from it. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createDomain([
    'name' => 'prod-observability',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'identityProviderConfiguration' => [
        'identityCenterConfiguration' => [
            'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
        ],
    ],
    'identityProviders' => [
        'IDC',
    ],
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'domain' => [
        'name' => 'prod-observability',
        'createdAt' => ,
        'customEndpointUrls' => [
            'https://prod-observability.cloudwatch-omni.global.app.aws',
        ],
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
        'domainEndpointUrl' => 'https://d-1a2b3c4d5e.cloudwatch-omni.global.app.aws',
        'domainId' => 'd-1a2b3c4d5e',
        'identityCenterApplicationArn' => 'arn:aws:sso::123456789012:application/ssoins-1234567890abcdef/apl-0f9e8d7c6b5a4938',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            ],
        ],
        'identityProviders' => [
            'IDC',
        ],
        'region' => 'us-east-1',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

CreateDomainAccessGrantForOrganization

$result = $client->createDomainAccessGrantForOrganization([/* ... */]);
$promise = $client->createDomainAccessGrantForOrganizationAsync([/* ... */]);

Creates an AccessGrant that authorizes a principal to administer an organization domain.

Parameter Syntax

$result = $client->createDomainAccessGrantForOrganization([
    'clientToken' => '<string>',
    'domainId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'permission' => 'ADMIN', // REQUIRED
    'principal' => [ // REQUIRED
        'principalAttributes' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'principalId' => '<string>',
        'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'accessGrant' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'domainId' => '<string>',
        'grantArn' => '<string>',
        'grantId' => '<string>',
        'grantType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        'name' => '<string>',
        'permission' => 'ADMIN',
        'principal' => [
            'principalAttributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'principalId' => '<string>',
            'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Create an organization domain access grant

The following example grants an Identity Center user administrative access to an organization domain. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createDomainAccessGrantForOrganization([
    'name' => 'org-domain-admin',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'domainId' => 'd-1a2b3c4d5e',
    'permission' => 'ADMIN',
    'principal' => [
        'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
        'principalType' => 'IDC_USER',
    ],
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'accessGrant' => [
        'name' => 'org-domain-admin',
        'createdAt' => ,
        'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
        'domainId' => 'd-1a2b3c4d5e',
        'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-access-grant/7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantType' => 'CUSTOMER_MANAGED',
        'permission' => 'ADMIN',
        'principal' => [
            'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
            'principalType' => 'IDC_USER',
        ],
        'updatedAt' => ,
    ],
]

CreateDomainForOrganization

$result = $client->createDomainForOrganization([/* ... */]);
$promise = $client->createDomainForOrganizationAsync([/* ... */]);

Creates an organization-scoped domain for the caller's AWS Organization. Only the organization's management account can call this operation.

Parameter Syntax

$result = $client->createDomainForOrganization([
    'clientToken' => '<string>',
    'domainAccessRoleArn' => '<string>', // REQUIRED
    'identityProviderConfiguration' => [
        'identityCenterConfiguration' => [
            'identityCenterInstanceArn' => '<string>',
        ],
    ],
    'identityProviders' => ['<string>', ...], // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'organizationDomain' => [
        'createdAt' => <DateTime>,
        'customEndpointUrls' => ['<string>', ...],
        'domainAccessRoleArn' => '<string>',
        'domainArn' => '<string>',
        'domainEndpointUrl' => '<string>',
        'domainId' => '<string>',
        'identityCenterApplicationArn' => '<string>',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => '<string>',
            ],
        ],
        'identityProviders' => ['<string>', ...],
        'name' => '<string>',
        'organizationId' => '<string>',
        'ownerAccountId' => '<string>',
        'region' => '<string>',
        'status' => 'ACTIVE',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Create an organization domain

The following example creates an organization-scoped domain from the organization's management account, configures it with an Identity Center instance, and supplies an IAM role in the management account for domain access. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createDomainForOrganization([
    'name' => 'prod-observability-org',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'domainAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchOrganizationDomainAccessRole',
    'identityProviderConfiguration' => [
        'identityCenterConfiguration' => [
            'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
        ],
    ],
    'identityProviders' => [
        'IDC',
    ],
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'organizationDomain' => [
        'name' => 'prod-observability-org',
        'createdAt' => ,
        'customEndpointUrls' => [
            'https://prod-observability-org.cloudwatch-omni.global.app.aws',
        ],
        'domainAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchOrganizationDomainAccessRole',
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-domain/d-9z8y7x6w5v',
        'domainEndpointUrl' => 'https://d-9z8y7x6w5v.cloudwatch-omni.global.app.aws',
        'domainId' => 'd-9z8y7x6w5v',
        'identityCenterApplicationArn' => 'arn:aws:sso::123456789012:application/ssoins-1234567890abcdef/apl-0f9e8d7c6b5a4938',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            ],
        ],
        'identityProviders' => [
            'IDC',
        ],
        'organizationId' => 'o-a1b2c3d4e5',
        'ownerAccountId' => '123456789012',
        'region' => 'us-east-1',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

CreateIntegration

$result = $client->createIntegration([/* ... */]);
$promise = $client->createIntegrationAsync([/* ... */]);

Creates an integration with a third-party provider. Returns the integration identifier and its initial status; when the provider requires interactive consent, an authorization URL is returned for the user to complete setup.

Parameter Syntax

$result = $client->createIntegration([
    'clientToken' => '<string>',
    'credential' => [
        'apiKeyCredential' => [
            'apiKeyValue' => '<string>', // REQUIRED
        ],
        'oauthClientCredential' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
            'providerId' => '<string>',
        ],
        'oauthCodeCredential' => [
            'authCode' => '<string>', // REQUIRED
        ],
    ],
    'integrationAttributes' => ['<string>', ...],
    'integrationType' => 'AWS_CONFIG_SLREC|SLACK|EXTERNAL_AGENT|AWS_INTEGRATION', // REQUIRED
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'integration' => [
        'authType' => 'NONE|OAUTH2|API_KEY',
        'authorizationUrl' => '<string>',
        'createdAt' => <DateTime>,
        'credentialArn' => '<string>',
        'errorMessage' => '<string>',
        'integrationArn' => '<string>',
        'integrationAttributes' => ['<string>', ...],
        'integrationId' => '<string>',
        'integrationType' => 'AWS_CONFIG_SLREC|SLACK|EXTERNAL_AGENT|AWS_INTEGRATION',
        'name' => '<string>',
        'roleArn' => '<string>',
        'scope' => 'ACCOUNT|ORGANIZATION',
        'status' => 'ACTIVE|DELETED|PENDING|PENDING_OAUTH|ERROR|FAILED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Create an AWS integration

The following example creates an AWS_INTEGRATION named my-aws-integration, authorized by an IAM role. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createIntegration([
    'name' => 'my-aws-integration',
    'clientToken' => 'b3f8c7d6-5b4a-4c3d-9e2f-1a0b2c3d4e5f',
    'integrationType' => 'AWS_INTEGRATION',
    'roleArn' => 'arn:aws:iam::123456789012:role/service-role/CloudWatchIntegrationRole',
]);

Result syntax:

[
    'integration' => [
        'name' => 'my-aws-integration',
        'createdAt' => ,
        'integrationArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'integrationId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'integrationType' => 'AWS_INTEGRATION',
        'roleArn' => 'arn:aws:iam::123456789012:role/service-role/CloudWatchIntegrationRole',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

CreateOmniDashboard

$result = $client->createOmniDashboard([/* ... */]);
$promise = $client->createOmniDashboardAsync([/* ... */]);

Creates a new dashboard within a space.

Use GetOmniDashboard and ListOmniDashboards to retrieve dashboards, UpdateOmniDashboard to modify one, and DeleteOmniDashboard to remove it.

Parameter Syntax

$result = $client->createOmniDashboard([
    'body' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'omniDashboard' => [
        'arn' => '<string>',
        'body' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'dashboardId' => '<string>',
        'description' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Create a dashboard

The following example creates a dashboard in a space from a JSON dashboard definition. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createOmniDashboard([
    'name' => 'service-health-overview',
    'body' => '{"widgets":[{"type":"metric","x":0,"y":0,"width":12,"height":6,"properties":{"metrics":[["AWS/Lambda","Errors","FunctionName","OrderProcessor"]],"region":"us-east-1","title":"Lambda Errors"}}]}',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'description' => 'Overview of service health metrics.',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'omniDashboard' => [
        'name' => 'service-health-overview',
        'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
        'body' => '{"widgets":[{"type":"metric","x":0,"y":0,"width":12,"height":6,"properties":{"metrics":[["AWS/Lambda","Errors","FunctionName","OrderProcessor"]],"region":"us-east-1","title":"Lambda Errors"}}]}',
        'createdAt' => ,
        'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
        'dashboardId' => 'c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
        'description' => 'Overview of service health metrics.',
        'tags' => [
            'Team' => 'observability',
        ],
        'updatedAt' => ,
    ],
]

CreateOneTimeDeepLinkCode

$result = $client->createOneTimeDeepLinkCode([/* ... */]);
$promise = $client->createOneTimeDeepLinkCodeAsync([/* ... */]);

Generates a one-time code for deep-link authentication.

Direct the user's browser to the returned deepLinkUrl before it expires. The code is exchanged for an authenticated, domain-scoped session and can be used only once.

Parameter Syntax

$result = $client->createOneTimeDeepLinkCode([
    'domainId' => '<string>', // REQUIRED
    'redirectUrl' => '<string>',
    'ttlSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'code' => '<string>',
    'deepLinkUrl' => '<string>',
    'expiresAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Create a one-time deep-link code

The following example creates a one-time deep-link code for a domain that remains valid for 300 seconds and, once used, redirects the browser to the domain's /auth/callback path. Direct the user's browser to the returned deepLinkUrl before it expires; the code can be used only once. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createOneTimeDeepLinkCode([
    'domainId' => 'd-1a2b3c4d5e',
    'redirectUrl' => 'https://d-1a2b3c4d5e.cloudwatch-omni.global.app.aws/auth/callback',
    'ttlSeconds' => 300,
]);

Result syntax:

[
    'code' => 'dlc-EXAMPLE1234567890',
    'deepLinkUrl' => 'https://d-1a2b3c4d5e.cloudwatch-omni.global.app.aws/deeplink?code=EXAMPLE1234567890',
    'expiresAt' => ,
]

CreateSpace

$result = $client->createSpace([/* ... */]);
$promise = $client->createSpaceAsync([/* ... */]);

Creates a space in a domain.

Use GetSpace to retrieve the space, ListSpaces to enumerate spaces, UpdateSpace to modify it, and DeleteSpace to remove it.

Parameter Syntax

$result = $client->createSpace([
    'agentCoreEvaluationRoleArn' => '<string>',
    'clientToken' => '<string>',
    'dataAccessRoleArn' => '<string>', // REQUIRED
    'domainId' => '<string>', // REQUIRED
    'encryptionConfiguration' => [
        'encryptionStrategy' => 'AWS_OWNED|CUSTOMER_MANAGED', // REQUIRED
        'kmsKeyArn' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'space' => [
        'agentCoreEvaluationRoleArn' => '<string>',
        'createdAt' => <DateTime>,
        'dataAccessRoleArn' => '<string>',
        'domainArn' => '<string>',
        'encryptionConfiguration' => [
            'encryptionStrategy' => 'AWS_OWNED|CUSTOMER_MANAGED',
            'kmsKeyArn' => '<string>',
        ],
        'name' => '<string>',
        'ownerAccountId' => '<string>',
        'region' => '<string>',
        'spaceArn' => '<string>',
        'spaceId' => '<string>',
        'status' => 'ACTIVE|SUSPENDED|MOVING',
        'statusReason' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Create a space

The following example creates a space in a domain and encrypts its data at rest with a customer managed KMS key. The name must be 3-64 characters of lowercase letters, numbers, and hyphens. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createSpace([
    'name' => 'prod-observability',
    'agentCoreEvaluationRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchAgentCoreEvaluationRole',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'dataAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchSpaceDataAccessRole',
    'domainId' => 'd-1a2b3c4d5e',
    'encryptionConfiguration' => [
        'encryptionStrategy' => 'CUSTOMER_MANAGED',
        'kmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    ],
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'space' => [
        'name' => 'prod-observability',
        'agentCoreEvaluationRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchAgentCoreEvaluationRole',
        'createdAt' => ,
        'dataAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchSpaceDataAccessRole',
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
        'encryptionConfiguration' => [
            'encryptionStrategy' => 'CUSTOMER_MANAGED',
            'kmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        ],
        'ownerAccountId' => '123456789012',
        'region' => 'us-east-1',
        'spaceArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:space/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

CreateView

$result = $client->createView([/* ... */]);
$promise = $client->createViewAsync([/* ... */]);

Creates a new SQL view.

A view is a named, reusable SQL query that can be referenced from telemetry queries. View names must be unique within the account and region. Only USER views can be created — MANAGED views are provisioned by AWS.

Parameter Syntax

$result = $client->createView([
    'clientToken' => '<string>',
    'definition' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'definition' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'type' => 'USER|MANAGED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Create a view

The following example creates a user view that saves an error-count-by-service query. View names must begin with the view. prefix and be unique within the account and Region. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->createView([
    'name' => 'view.service_errors',
    'clientToken' => '3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73',
    'definition' => 'SELECT resource['attributes']['service.name'] AS service, COUNT(*) AS error_count FROM "logs.default" WHERE severityText = 'ERROR' GROUP BY service',
    'description' => 'Error counts by service',
    'tags' => [
        'Team' => 'observability',
    ],
]);

Result syntax:

[
    'name' => 'view.service_errors',
    'type' => 'USER',
    'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:view/view.service_errors',
    'createdAt' => ,
    'definition' => 'SELECT resource['attributes']['service.name'] AS service, COUNT(*) AS error_count FROM "logs.default" WHERE severityText = 'ERROR' GROUP BY service',
    'description' => 'Error counts by service',
    'updatedAt' => ,
]

DeleteAccessGrant

$result = $client->deleteAccessGrant([/* ... */]);
$promise = $client->deleteAccessGrantAsync([/* ... */]);

Removes an existing AccessGrant, revoking the access it granted.

A service-managed grant cannot be deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Delete an access grant

The following example deletes an access grant by ID, revoking the access it granted. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteAccessGrant([
    'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
]);

Result syntax:

[
]

DeleteAccessProfile

$result = $client->deleteAccessProfile([/* ... */]);
$promise = $client->deleteAccessProfileAsync([/* ... */]);

Removes an access profile.

An access profile cannot be deleted while access grants reference it.

Parameter Syntax

$result = $client->deleteAccessProfile([
    'profileId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Delete an access profile

The following example deletes an access profile from a space. An access profile cannot be deleted while access grants reference it. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteAccessProfile([
    'profileId' => 'analyst-readonly',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
]

DeleteAlert

$result = $client->deleteAlert([/* ... */]);
$promise = $client->deleteAlertAsync([/* ... */]);

Deletes an alert by its identifier.

Idempotent: deleting an alert that has already been removed succeeds without error.

Parameter Syntax

$result = $client->deleteAlert([
    'alertId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Delete an alert

The following example removes an alert from a space. Deleting an alert that has already been removed succeeds without error. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteAlert([
    'alertId' => 'c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
]

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

Removes a domain and all of its resources. Call this operation in the Region where the domain was created.

A domain cannot be deleted while it contains spaces.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Delete a domain

The following example deletes a domain in the Region where it was created. The domain must not contain any spaces. A successful response returns an empty body. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteDomain([
    'domainId' => 'd-1a2b3c4d5e',
]);

Result syntax:

[
]

DeleteDomainAccessGrantForOrganization

$result = $client->deleteDomainAccessGrantForOrganization([/* ... */]);
$promise = $client->deleteDomainAccessGrantForOrganizationAsync([/* ... */]);

Removes an existing organization access grant, revoking the access it granted.

A service-managed grant cannot be deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Delete an organization domain access grant

The following example deletes an organization domain access grant by ID, revoking the access it granted. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteDomainAccessGrantForOrganization([
    'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
]);

Result syntax:

[
]

DeleteDomainForOrganization

$result = $client->deleteDomainForOrganization([/* ... */]);
$promise = $client->deleteDomainForOrganizationAsync([/* ... */]);

Removes an organization domain and all of its resources. Call this operation in the Region where the domain was created.

A domain cannot be deleted while it contains spaces.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Delete an organization domain

The following example deletes an organization domain in the Region where it was created. The domain must not contain any spaces. A successful response returns an empty body. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteDomainForOrganization([
    'domainId' => 'd-9z8y7x6w5v',
]);

Result syntax:

[
]

DeleteIntegration

$result = $client->deleteIntegration([/* ... */]);
$promise = $client->deleteIntegrationAsync([/* ... */]);

Deletes an integration. Returns the resulting status.

Parameter Syntax

$result = $client->deleteIntegration([
    'identifier' => [ // REQUIRED
        'integrationArn' => '<string>',
        'integrationId' => '<string>',
        'integrationName' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Delete an integration by id

The following example deletes the integration identified by its id. DeleteIntegration is idempotent and returns an empty response. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteIntegration([
    'identifier' => [
        'integrationId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    ],
]);

Result syntax:

[
]

DeleteOmniDashboard

$result = $client->deleteOmniDashboard([/* ... */]);
$promise = $client->deleteOmniDashboardAsync([/* ... */]);

Removes a dashboard from a space.

Parameter Syntax

$result = $client->deleteOmniDashboard([
    'dashboardId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Delete a dashboard

The following example removes a dashboard from a space. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteOmniDashboard([
    'dashboardId' => 'c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
]

DeleteSpace

$result = $client->deleteSpace([/* ... */]);
$promise = $client->deleteSpaceAsync([/* ... */]);

Removes a space and all of its resources.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Delete a space

The following example removes a space and all of its resources. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteSpace([
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
]

DeleteView

$result = $client->deleteView([/* ... */]);
$promise = $client->deleteViewAsync([/* ... */]);

Deletes the specified view.

Queries that reference the view fail after it is deleted. Managed views cannot be deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Delete a view

The following example deletes a view. The response body is empty. Queries that reference the view fail after it is deleted. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->deleteView([
    'name' => 'view.service_errors',
]);

Result syntax:

[
]

GetAccessGrant

$result = $client->getAccessGrant([/* ... */]);
$promise = $client->getAccessGrantAsync([/* ... */]);

Retrieves the full detail of a single AccessGrant by ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'accessGrant' => [
        'accountId' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'domainId' => '<string>',
        'grantArn' => '<string>',
        'grantId' => '<string>',
        'grantType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        'name' => '<string>',
        'permission' => 'SPACE_ADMIN|READ|READ_WRITE_DELETE|CUSTOM',
        'principal' => [
            'principalAttributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'principalId' => '<string>',
            'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT|ACCESS_PROFILE|ALERT|AGENT',
        ],
        'scopedActions' => [
            [
                'actions' => ['<string>', ...],
                'contextConditions' => [
                    '<String>' => ['<string>', ...],
                    // ...
                ],
                'resources' => [
                    [
                        'resourceArns' => ['<string>', ...],
                        'resourceType' => '<string>',
                        'rowScopeGroups' => [
                            [
                                [
                                    'field' => '<string>',
                                    'operator' => 'IN',
                                    'values' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            // ...
                        ],
                        'signalTypes' => ['<string>', ...],
                        'tags' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'spaceId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get an access grant

The following example retrieves the full detail of a single access grant by ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getAccessGrant([
    'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
]);

Result syntax:

[
    'accessGrant' => [
        'name' => 'analyst-read-access',
        'accountId' => '123456789012',
        'createdAt' => ,
        'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
        'domainId' => 'd-1a2b3c4d5e',
        'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-grant/7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantType' => 'CUSTOMER_MANAGED',
        'permission' => 'CUSTOM',
        'principal' => [
            'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
            'principalType' => 'IDC_USER',
        ],
        'scopedActions' => [
            [
                'actions' => [
                    'cloudwatch:GetOmniDashboard',
                    'cloudwatch:UpdateOmniDashboard',
                ],
                'resources' => [
                    [
                        'resourceArns' => [
                            'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
                        ],
                        'resourceType' => 'OmniDashboard',
                    ],
                ],
            ],
        ],
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

GetAccessProfile

$result = $client->getAccessProfile([/* ... */]);
$promise = $client->getAccessProfileAsync([/* ... */]);

Retrieves an access profile by ID.

The response indicates whether the calling principal is currently allowed to assume the profile.

Parameter Syntax

$result = $client->getAccessProfile([
    'profileId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accessProfile' => [
        'arn' => '<string>',
        'assumeStatus' => 'ALLOWED|DENIED',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'profileId' => '<string>',
        'profileType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        'spaceId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get an access profile

The following example retrieves an access profile by ID, including whether the calling principal is currently allowed to assume it. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getAccessProfile([
    'profileId' => 'analyst-readonly',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'accessProfile' => [
        'name' => 'Analyst read-only profile',
        'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-profile/analyst-readonly',
        'assumeStatus' => 'ALLOWED',
        'createdAt' => ,
        'description' => 'Read-only access for analysts.',
        'profileId' => 'analyst-readonly',
        'profileType' => 'CUSTOMER_MANAGED',
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

GetAlert

$result = $client->getAlert([/* ... */]);
$promise = $client->getAlertAsync([/* ... */]);

Retrieves a single alert by its identifier.

Use ListAlerts to enumerate alerts in the space.

Parameter Syntax

$result = $client->getAlert([
    'alertId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'alert' => [
        'accountId' => '<string>',
        'alertArn' => '<string>',
        'alertId' => '<string>',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'notificationRules' => [
            [
                'target' => [
                    'arn' => '<string>',
                    'metadata' => ['<string>', ...],
                    'type' => 'sns|slack|pagerduty',
                ],
                'trigger' => [
                    'stateValues' => ['<string>', ...],
                ],
            ],
            // ...
        ],
        'notificationStatus' => 'ENABLED|DISABLED',
        'profileId' => '<string>',
        'rule' => [
            'telemetryRule' => [
                'condition' => [
                    'comparator' => 'GT|LT|GTE|LTE',
                    'criticalThreshold' => <float>,
                    'thresholdField' => '<string>',
                    'thresholdMode' => 'COUNT_OF_RESULTS|FIELD_VALUE',
                    'warningThreshold' => <float>,
                ],
                'evaluation' => [
                    'intervalSeconds' => <integer>,
                    'pendingDurationSeconds' => <integer>,
                    'recoveryDurationSeconds' => <integer>,
                ],
                'noData' => [
                    'treatAs' => 'OK|WARNING|CRITICAL|NODATA',
                ],
                'query' => [
                    'expression' => '<string>',
                    'language' => 'SQL|PROMQL',
                ],
            ],
        ],
        'spaceId' => '<string>',
        'state' => [
            'contributorSummary' => [
                'criticalCount' => <integer>,
                'warningCount' => <integer>,
            ],
            'data' => [
                'thresholdBreached' => <float>,
            ],
            'transitionedAt' => <DateTime>,
            'value' => 'OK|WARNING|CRITICAL|NODATA',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Retrieve an alert

The following example retrieves an alert by its identifier, including the live evaluation state that CreateAlert does not report. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getAlert([
    'alertId' => 'c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'alert' => [
        'name' => 'service-error-count-elevated',
        'accountId' => '123456789012',
        'alertArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:alert/c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
        'alertId' => 'c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
        'createdAt' => ,
        'description' => 'Alerts when a service logs more errors than its accepted rate.',
        'notificationRules' => [
            [
                'target' => [
                    'metadata' => [
                        'channel' => 'oncall-alerts',
                    ],
                    'type' => 'slack',
                    'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
                ],
                'trigger' => [
                    'stateValues' => [
                        'CRITICAL',
                    ],
                ],
            ],
        ],
        'notificationStatus' => 'ENABLED',
        'profileId' => 'analyst-readonly',
        'rule' => [
            'telemetryRule' => [
                'condition' => [
                    'comparator' => 'GT',
                    'criticalThreshold' => 200,
                    'thresholdField' => 'error_count',
                    'thresholdMode' => 'FIELD_VALUE',
                    'warningThreshold' => 50,
                ],
                'evaluation' => [
                    'intervalSeconds' => 300,
                    'pendingDurationSeconds' => 600,
                    'recoveryDurationSeconds' => 300,
                ],
                'noData' => [
                    'treatAs' => 'NODATA',
                ],
                'query' => [
                    'expression' => 'SELECT resource['attributes']['service.name'] AS service, COUNT(*) AS error_count FROM "logs.default" WHERE severityText = 'ERROR' GROUP BY service',
                    'language' => 'SQL',
                ],
            ],
        ],
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'state' => [
            'value' => 'CRITICAL',
            'contributorSummary' => [
                'criticalCount' => 1,
                'warningCount' => 3,
            ],
            'transitionedAt' => ,
        ],
        'updatedAt' => ,
    ],
]

GetContextGraph

$result = $client->getContextGraph([/* ... */]);
$promise = $client->getContextGraphAsync([/* ... */]);

Queries the context graph with filtering, traversal, and pagination support.

Pagination note: nodes and edges are returned together as a coherent subgraph. Pagination cursors advance over nodes (the primary collection); each page includes all edges connecting nodes within that page. Callers should treat nodes as the paginated collection and edges as supplementary relationship data attached to those nodes.

Parameter Syntax

$result = $client->getContextGraph([
    'depth' => <integer>,
    'edgeFilters' => [
        'edgeId' => '<string>',
        'edgeType' => 'CALLS|ACCESSES|RUNS_ON',
        'from' => '<string>',
        'operations' => ['<string>', ...],
        'sources' => ['<string>', ...],
        'telemetryAttributes' => [
            [
                'key' => '<string>', // REQUIRED
                'values' => ['<string>', ...],
            ],
            // ...
        ],
        'to' => '<string>',
    ],
    'endTime' => <integer || string || DateTime>, // REQUIRED
    'includeMetadata' => true || false,
    'maxEdgesPerNode' => <integer>,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'nodeFilters' => [
        'category' => ['<string>', ...],
        'cloudProvider' => ['<string>', ...],
        'name' => '<string>',
        'namespace' => ['<string>', ...],
        'nodeId' => '<string>',
        'nodeType' => 'SERVICE|RESOURCE|REMOTE_SERVICE',
        'region' => ['<string>', ...],
        'sourceAccountId' => ['<string>', ...],
        'sources' => ['<string>', ...],
        'stage' => ['<string>', ...],
        'tags' => [
            [
                'key' => '<string>', // REQUIRED
                'values' => ['<string>', ...],
            ],
            // ...
        ],
        'telemetryAttributes' => [
            [
                'key' => '<string>', // REQUIRED
                'values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'startTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'nodes' => [
        [
            'alternateNames' => ['<string>', ...],
            'edges' => [
                [
                    'edgeId' => '<string>',
                    'edgeProperties' => [
                        'blocked' => true || false,
                        'destinationPort' => '<string>',
                        'errorCode' => '<string>',
                        'httpMethod' => '<string>',
                        'httpStatusCode' => '<string>',
                        'protocol' => '<string>',
                        'serviceInitiated' => true || false,
                        'sourcePort' => '<string>',
                        'trafficStats' => [
                            'bytes' => <integer>,
                            'flows' => <integer>,
                            'packets' => <integer>,
                            'receivedBytes' => <integer>,
                            'sentBytes' => <integer>,
                        ],
                    ],
                    'edgeType' => 'CALLS|ACCESSES|RUNS_ON',
                    'firstObservedAt' => <DateTime>,
                    'from' => '<string>',
                    'lastObservedAt' => <DateTime>,
                    'metadata' => [
                        'logs' => [
                            [
                                'attributes' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'metrics' => [
                            [
                                'attributes' => ['<string>', ...],
                                'metricType' => '<string>',
                                'name' => '<string>',
                                'namespace' => '<string>',
                                'preferredStat' => '<string>',
                                'semantics' => [
                                    'description' => '<string>',
                                    'unit' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                        'semantics' => [
                            'framework' => '<string>',
                            'kind' => '<string>',
                            'language' => '<string>',
                            'purpose' => '<string>',
                            'repository' => '<string>',
                        ],
                        'traces' => [
                            [
                                'attributes' => ['<string>', ...],
                            ],
                            // ...
                        ],
                    ],
                    'operations' => ['<string>', ...],
                    'signalTypes' => ['<string>', ...],
                    'sources' => ['<string>', ...],
                    'telemetryAttributes' => ['<string>', ...],
                    'to' => '<string>',
                ],
                // ...
            ],
            'firstObservedAt' => <DateTime>,
            'lastObservedAt' => <DateTime>,
            'metadata' => [
                'logs' => [
                    [
                        'attributes' => ['<string>', ...],
                    ],
                    // ...
                ],
                'metrics' => [
                    [
                        'attributes' => ['<string>', ...],
                        'metricType' => '<string>',
                        'name' => '<string>',
                        'namespace' => '<string>',
                        'preferredStat' => '<string>',
                        'semantics' => [
                            'description' => '<string>',
                            'unit' => '<string>',
                        ],
                    ],
                    // ...
                ],
                'semantics' => [
                    'framework' => '<string>',
                    'kind' => '<string>',
                    'language' => '<string>',
                    'purpose' => '<string>',
                    'repository' => '<string>',
                ],
                'traces' => [
                    [
                        'attributes' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'name' => '<string>',
            'nodeId' => '<string>',
            'nodeProperties' => [
                'category' => 'GEN_AI_AGENT|GEN_AI_MODEL|DATABASE|MESSAGING_QUEUE|COMPUTE|STORAGE|NETWORK',
                'cloudProvider' => '<string>',
                'namespace' => '<string>',
                'region' => '<string>',
                'sourceAccountId' => '<string>',
                'stage' => '<string>',
            ],
            'nodeType' => 'SERVICE|RESOURCE|REMOTE_SERVICE',
            'operationDetails' => [
                '<OperationName>' => [
                    ['<string>', ...],
                    // ...
                ],
                // ...
            ],
            'signalTypes' => ['<string>', ...],
            'sources' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'telemetryAttributes' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Query a service and its immediate dependencies

The following example returns context graph nodes matching the filter and traverses one hop out to their direct dependencies, over a one-hour window. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getContextGraph([
    'depth' => 1,
    'endTime' => ,
    'includeMetadata' => ,
    'maxResults' => 100,
    'nodeFilters' => [
        'namespace' => [
            'ecommerce',
        ],
        'nodeType' => 'SERVICE',
    ],
    'startTime' => ,
]);

Result syntax:

[
    'nextToken' => 'eyJvZmZzZXQiOjEwMH0=',
    'nodes' => [
        [
            'name' => 'checkout-service',
            'edges' => [
                [
                    'operations' => [
                        'POST /charges',
                    ],
                    'edgeId' => 'edge:checkout-service->payments-service',
                    'edgeType' => 'CALLS',
                    'firstObservedAt' => ,
                    'from' => 'svc:checkout-service',
                    'lastObservedAt' => ,
                    'signalTypes' => [
                        'TRACES',
                    ],
                    'sources' => [
                        'TELEMETRY',
                    ],
                    'to' => 'svc:payments-service',
                ],
            ],
            'firstObservedAt' => ,
            'lastObservedAt' => ,
            'nodeId' => 'svc:checkout-service',
            'nodeProperties' => [
                'cloudProvider' => 'aws',
                'namespace' => 'ecommerce',
                'region' => 'us-east-1',
                'sourceAccountId' => '123456789012',
            ],
            'nodeType' => 'SERVICE',
            'signalTypes' => [
                'TRACES',
            ],
            'sources' => [
                'TELEMETRY',
            ],
        ],
        [
            'name' => 'payments-service',
            'firstObservedAt' => ,
            'lastObservedAt' => ,
            'nodeId' => 'svc:payments-service',
            'nodeProperties' => [
                'cloudProvider' => 'aws',
                'namespace' => 'ecommerce',
                'region' => 'us-east-1',
                'sourceAccountId' => '123456789012',
            ],
            'nodeType' => 'SERVICE',
            'signalTypes' => [
                'TRACES',
            ],
            'sources' => [
                'TELEMETRY',
            ],
        ],
    ],
]

GetDomain

$result = $client->getDomain([/* ... */]);
$promise = $client->getDomainAsync([/* ... */]);

Retrieves the details of a domain by ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'domain' => [
        'createdAt' => <DateTime>,
        'customEndpointUrls' => ['<string>', ...],
        'domainArn' => '<string>',
        'domainEndpointUrl' => '<string>',
        'domainId' => '<string>',
        'identityCenterApplicationArn' => '<string>',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => '<string>',
            ],
        ],
        'identityProviders' => ['<string>', ...],
        'name' => '<string>',
        'region' => '<string>',
        'status' => 'ACTIVE',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get a domain

The following example retrieves the configuration and status of an Identity Center domain by its ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getDomain([
    'domainId' => 'd-1a2b3c4d5e',
]);

Result syntax:

[
    'domain' => [
        'name' => 'prod-observability',
        'createdAt' => ,
        'customEndpointUrls' => [
            'https://prod-observability.cloudwatch-omni.global.app.aws',
        ],
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
        'domainEndpointUrl' => 'https://d-1a2b3c4d5e.cloudwatch-omni.global.app.aws',
        'domainId' => 'd-1a2b3c4d5e',
        'identityCenterApplicationArn' => 'arn:aws:sso::123456789012:application/ssoins-1234567890abcdef/apl-0f9e8d7c6b5a4938',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            ],
        ],
        'identityProviders' => [
            'IDC',
        ],
        'region' => 'us-east-1',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

GetDomainAccessGrantForOrganization

$result = $client->getDomainAccessGrantForOrganization([/* ... */]);
$promise = $client->getDomainAccessGrantForOrganizationAsync([/* ... */]);

Retrieves the full detail of a single organization access grant by ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'accessGrant' => [
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'domainId' => '<string>',
        'grantArn' => '<string>',
        'grantId' => '<string>',
        'grantType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        'name' => '<string>',
        'permission' => 'ADMIN',
        'principal' => [
            'principalAttributes' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'principalId' => '<string>',
            'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT',
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get an organization domain access grant

The following example retrieves the full detail of a single organization domain access grant by ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getDomainAccessGrantForOrganization([
    'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
]);

Result syntax:

[
    'accessGrant' => [
        'name' => 'org-domain-admin',
        'createdAt' => ,
        'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
        'domainId' => 'd-1a2b3c4d5e',
        'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-access-grant/7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
        'grantType' => 'CUSTOMER_MANAGED',
        'permission' => 'ADMIN',
        'principal' => [
            'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
            'principalType' => 'IDC_USER',
        ],
        'updatedAt' => ,
    ],
]

GetDomainForOrganization

$result = $client->getDomainForOrganization([/* ... */]);
$promise = $client->getDomainForOrganizationAsync([/* ... */]);

Retrieves the details of an organization domain by ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'organizationDomain' => [
        'createdAt' => <DateTime>,
        'customEndpointUrls' => ['<string>', ...],
        'domainAccessRoleArn' => '<string>',
        'domainArn' => '<string>',
        'domainEndpointUrl' => '<string>',
        'domainId' => '<string>',
        'identityCenterApplicationArn' => '<string>',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => '<string>',
            ],
        ],
        'identityProviders' => ['<string>', ...],
        'name' => '<string>',
        'organizationId' => '<string>',
        'ownerAccountId' => '<string>',
        'region' => '<string>',
        'status' => 'ACTIVE',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get an organization domain

The following example retrieves the configuration and status of an organization-scoped domain by its ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getDomainForOrganization([
    'domainId' => 'd-9z8y7x6w5v',
]);

Result syntax:

[
    'organizationDomain' => [
        'name' => 'prod-observability-org',
        'createdAt' => ,
        'customEndpointUrls' => [
            'https://prod-observability-org.cloudwatch-omni.global.app.aws',
        ],
        'domainAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchOrganizationDomainAccessRole',
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-domain/d-9z8y7x6w5v',
        'domainEndpointUrl' => 'https://d-9z8y7x6w5v.cloudwatch-omni.global.app.aws',
        'domainId' => 'd-9z8y7x6w5v',
        'identityCenterApplicationArn' => 'arn:aws:sso::123456789012:application/ssoins-1234567890abcdef/apl-0f9e8d7c6b5a4938',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            ],
        ],
        'identityProviders' => [
            'IDC',
        ],
        'organizationId' => 'o-a1b2c3d4e5',
        'ownerAccountId' => '123456789012',
        'region' => 'us-east-1',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

GetIntegration

$result = $client->getIntegration([/* ... */]);
$promise = $client->getIntegrationAsync([/* ... */]);

Returns the details of a single integration, identified by its identifier, Amazon Resource Name, or name.

Parameter Syntax

$result = $client->getIntegration([
    'identifier' => [ // REQUIRED
        'integrationArn' => '<string>',
        'integrationId' => '<string>',
        'integrationName' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'integration' => [
        'authType' => 'NONE|OAUTH2|API_KEY',
        'authorizationUrl' => '<string>',
        'createdAt' => <DateTime>,
        'credentialArn' => '<string>',
        'errorMessage' => '<string>',
        'integrationArn' => '<string>',
        'integrationAttributes' => ['<string>', ...],
        'integrationId' => '<string>',
        'integrationType' => 'AWS_CONFIG_SLREC|SLACK|EXTERNAL_AGENT|AWS_INTEGRATION',
        'name' => '<string>',
        'roleArn' => '<string>',
        'scope' => 'ACCOUNT|ORGANIZATION',
        'status' => 'ACTIVE|DELETED|PENDING|PENDING_OAUTH|ERROR|FAILED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get an integration by id

The following example returns the integration with the given id. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getIntegration([
    'identifier' => [
        'integrationId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    ],
]);

Result syntax:

[
    'integration' => [
        'name' => 'my-aws-integration',
        'createdAt' => ,
        'integrationArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'integrationId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'integrationType' => 'AWS_INTEGRATION',
        'roleArn' => 'arn:aws:iam::123456789012:role/service-role/CloudWatchIntegrationRole',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

GetIntelligenceConfiguration

$result = $client->getIntelligenceConfiguration([/* ... */]);
$promise = $client->getIntelligenceConfigurationAsync([/* ... */]);

Retrieves the intelligence configuration for the calling account. Account is identified via FAS (caller identity). Returns the default configuration if none exists yet.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'accountId' => '<string>',
    'createdAt' => <DateTime>,
    'kmsKeyArn' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Retrieve the intelligence configuration

The following example retrieves the intelligence configuration for the calling account. The request carries no parameters; the account is taken from the caller identity. Payloads are shown as JSON; on the wire they are CBOR-encoded.

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

Result syntax:

[
    'accountId' => '123456789012',
    'createdAt' => ,
    'kmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    'updatedAt' => ,
]

GetOmniDashboard

$result = $client->getOmniDashboard([/* ... */]);
$promise = $client->getOmniDashboardAsync([/* ... */]);

Retrieves a dashboard by ID within a space.

Parameter Syntax

$result = $client->getOmniDashboard([
    'dashboardId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'omniDashboard' => [
        'arn' => '<string>',
        'body' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'dashboardId' => '<string>',
        'description' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get a dashboard

The following example retrieves a dashboard by ID within a space, including its full body. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getOmniDashboard([
    'dashboardId' => 'c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'omniDashboard' => [
        'name' => 'service-health-overview',
        'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
        'body' => '{"widgets":[{"type":"metric","x":0,"y":0,"width":12,"height":6,"properties":{"metrics":[["AWS/Lambda","Errors","FunctionName","OrderProcessor"]],"region":"us-east-1","title":"Lambda Errors"}}]}',
        'createdAt' => ,
        'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
        'dashboardId' => 'c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
        'description' => 'Overview of service health metrics.',
        'tags' => [
            'Team' => 'observability',
        ],
        'updatedAt' => ,
    ],
]

GetSpace

$result = $client->getSpace([/* ... */]);
$promise = $client->getSpaceAsync([/* ... */]);

Retrieves the details of a space by ID.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'space' => [
        'agentCoreEvaluationRoleArn' => '<string>',
        'createdAt' => <DateTime>,
        'dataAccessRoleArn' => '<string>',
        'domainArn' => '<string>',
        'encryptionConfiguration' => [
            'encryptionStrategy' => 'AWS_OWNED|CUSTOMER_MANAGED',
            'kmsKeyArn' => '<string>',
        ],
        'name' => '<string>',
        'ownerAccountId' => '<string>',
        'region' => '<string>',
        'spaceArn' => '<string>',
        'spaceId' => '<string>',
        'status' => 'ACTIVE|SUSPENDED|MOVING',
        'statusReason' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get a space

The following example retrieves the details of a space by ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getSpace([
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'space' => [
        'name' => 'prod-observability',
        'agentCoreEvaluationRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchAgentCoreEvaluationRole',
        'createdAt' => ,
        'dataAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchSpaceDataAccessRole',
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
        'encryptionConfiguration' => [
            'encryptionStrategy' => 'CUSTOMER_MANAGED',
            'kmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        ],
        'ownerAccountId' => '123456789012',
        'region' => 'us-east-1',
        'spaceArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:space/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

GetSpaceCredentialsForOrganization

$result = $client->getSpaceCredentialsForOrganization([/* ... */]);
$promise = $client->getSpaceCredentialsForOrganizationAsync([/* ... */]);

Returns temporary credentials for a space in an organization member account. The credentials are valid for one hour.

The caller must be the organization's management account or a delegated administrator with access to the target space. The target account must be an active member of the same organization as the domain, and the space must already exist.

Parameter Syntax

$result = $client->getSpaceCredentialsForOrganization([
    'context' => [ // REQUIRED
        'domainId' => '<string>',
        'spaceId' => '<string>',
        'targetAccountId' => '<string>',
    ],
    'credentialType' => 'SPACE_OPERATION', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'credentials' => [
        'accessKeyId' => '<string>',
        'expiration' => <DateTime>,
        'secretAccessKey' => '<string>',
        'sessionToken' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get space credentials for an organization member account

The following example returns temporary, space-scoped AWS credentials for an existing space in an organization member account, selected by spaceId. The credentials are valid for one hour, as reflected by the expiration timestamp. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getSpaceCredentialsForOrganization([
    'context' => [
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    ],
    'credentialType' => 'SPACE_OPERATION',
]);

Result syntax:

[
    'credentials' => [
        'accessKeyId' => 'ASIAIOSFODNN7EXAMPLE',
        'expiration' => ,
        'secretAccessKey' => 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
        'sessionToken' => 'IQoJb3JpZ2luX2VjEXAMPLESESSIONTOKEN1234567890',
    ],
]

GetTelemetryQueryResults

$result = $client->getTelemetryQueryResults([/* ... */]);
$promise = $client->getTelemetryQueryResultsAsync([/* ... */]);

Returns the results for the specified query.

Parameter Syntax

$result = $client->getTelemetryQueryResults([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'queryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'rows' => [
        ['<string>', ...],
        // ...
    ],
    'statistics' => [
        'bytesScanned' => <float>,
        'partialResults' => [
            'partialResultsDetected' => true || false,
        ],
        'percentComplete' => <integer>,
        'recordsMatched' => <integer>,
        'recordsScanned' => <integer>,
    ],
    'status' => 'Running|Failed|Complete|Cancelled',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get telemetry query results

The following example retrieves a page of results for a completed query, along with execution statistics. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getTelemetryQueryResults([
    'maxResults' => 100,
    'queryId' => '3b2a1c0d-7e6f-4a5b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'rows' => [
        [
            'error_count' => '42',
            'service.name' => 'checkout-service',
        ],
        [
            'error_count' => '7',
            'service.name' => 'payments-service',
        ],
    ],
    'statistics' => [
        'bytesScanned' => 1048576,
        'partialResults' => [
            'partialResultsDetected' => ,
        ],
        'percentComplete' => 100,
        'recordsMatched' => 49,
        'recordsScanned' => 20000,
    ],
    'status' => 'Complete',
]

GetView

$result = $client->getView([/* ... */]);
$promise = $client->getViewAsync([/* ... */]);

Returns the definition and metadata of the specified view.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'definition' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'type' => 'USER|MANAGED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Get a view

The following example returns the definition and metadata of a view. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->getView([
    'name' => 'view.service_errors',
]);

Result syntax:

[
    'name' => 'view.service_errors',
    'type' => 'USER',
    'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:view/view.service_errors',
    'createdAt' => ,
    'definition' => 'SELECT resource['attributes']['service.name'] AS service, COUNT(*) AS error_count FROM "logs.default" WHERE severityText = 'ERROR' GROUP BY service',
    'description' => 'Error counts by service',
    'updatedAt' => ,
]

ListAccessGrants

$result = $client->listAccessGrants([/* ... */]);
$promise = $client->listAccessGrantsAsync([/* ... */]);

Returns AccessGrants, with optional filtering by domain, space, principal, or permission. A grant is returned only when it matches every filter supplied. With no filters, returns the grants for the current account and Region.

Parameter Syntax

$result = $client->listAccessGrants([
    'domainId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'permission' => 'SPACE_ADMIN|READ|READ_WRITE_DELETE|CUSTOM',
    'principalId' => '<string>',
    'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT|ACCESS_PROFILE|ALERT|AGENT',
    'spaceId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'domainId' => '<string>',
            'grantArn' => '<string>',
            'grantId' => '<string>',
            'grantType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
            'name' => '<string>',
            'permission' => 'SPACE_ADMIN|READ|READ_WRITE_DELETE|CUSTOM',
            'principal' => [
                'principalAttributes' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'principalId' => '<string>',
                'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT|ACCESS_PROFILE|ALERT|AGENT',
            ],
            'spaceId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List access grants in a space

The following example lists the first page of access grants in a space and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listAccessGrants([
    'domainId' => 'd-1a2b3c4d5e',
    'maxResults' => 50,
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'analyst-read-access',
            'domainId' => 'd-1a2b3c4d5e',
            'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-grant/7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
            'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
            'grantType' => 'CUSTOMER_MANAGED',
            'permission' => 'CUSTOM',
            'principal' => [
                'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
                'principalType' => 'IDC_USER',
            ],
            'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        ],
        [
            'name' => 'oncall-read-write',
            'domainId' => 'd-1a2b3c4d5e',
            'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-grant/8a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
            'grantId' => '8a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
            'grantType' => 'CUSTOMER_MANAGED',
            'permission' => 'READ_WRITE_DELETE',
            'principal' => [
                'principalId' => '2f5a8c1b-6d3e-4f7a-8b9c-0d1e2f3a4b5c',
                'principalType' => 'IDC_GROUP',
            ],
            'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListAccessProfiles

$result = $client->listAccessProfiles([/* ... */]);
$promise = $client->listAccessProfilesAsync([/* ... */]);

Returns the access profiles in a space.

Parameter Syntax

$result = $client->listAccessProfiles([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'profileId' => '<string>',
            'profileType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List access profiles in a space

The following example lists the first page of access profiles in a space and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listAccessProfiles([
    'maxResults' => 50,
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'Analyst read-only profile',
            'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-profile/analyst-readonly',
            'description' => 'Read-only access for analysts.',
            'profileId' => 'analyst-readonly',
            'profileType' => 'CUSTOMER_MANAGED',
        ],
        [
            'name' => 'On-call admin profile',
            'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-profile/oncall-admin',
            'description' => 'Full access for on-call responders.',
            'profileId' => 'oncall-admin',
            'profileType' => 'CUSTOMER_MANAGED',
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListAlerts

$result = $client->listAlerts([/* ... */]);
$promise = $client->listAlertsAsync([/* ... */]);

Lists alerts within a space, optionally filtered by exact name(s), a single name prefix, or exact alertId(s), with pagination.

Use GetAlert to retrieve a single alert's full detail.

Parameter Syntax

$result = $client->listAlerts([
    'filterCriteria' => [
        'ids' => ['<string>', ...],
        'namePrefix' => '<string>',
        'names' => ['<string>', ...],
        'notificationsEnabled' => true || false,
        'stateValue' => ['<string>', ...],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'NAME|STATE',
    'sortOrder' => 'ASC|DESC',
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'alertArn' => '<string>',
            'alertId' => '<string>',
            'createdAt' => <DateTime>,
            'name' => '<string>',
            'notificationStatus' => 'ENABLED|DISABLED',
            'profileId' => '<string>',
            'spaceId' => '<string>',
            'state' => [
                'contributorSummary' => [
                    'criticalCount' => <integer>,
                    'warningCount' => <integer>,
                ],
                'data' => [
                    'thresholdBreached' => <float>,
                ],
                'transitionedAt' => <DateTime>,
                'value' => 'OK|WARNING|CRITICAL|NODATA',
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List alerts in a space

The following example lists the first page of alerts in a space, sorted by state, and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listAlerts([
    'filterCriteria' => [
        'namePrefix' => 'service-',
        'stateValue' => [
            'WARNING',
            'CRITICAL',
        ],
    ],
    'maxResults' => 50,
    'sortBy' => 'STATE',
    'sortOrder' => 'DESC',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'service-error-count-elevated',
            'alertArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:alert/c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
            'alertId' => 'c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
            'createdAt' => ,
            'notificationStatus' => 'ENABLED',
            'profileId' => 'analyst-readonly',
            'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
            'state' => [
                'value' => 'CRITICAL',
                'contributorSummary' => [
                    'criticalCount' => 1,
                    'warningCount' => 3,
                ],
                'transitionedAt' => ,
            ],
            'updatedAt' => ,
        ],
        [
            'name' => 'service-checkout-5xx-responses',
            'alertArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:alert/d4e5f6a78b9c4d0e9f1a2b3c4d5e6f70',
            'alertId' => 'd4e5f6a78b9c4d0e9f1a2b3c4d5e6f70',
            'createdAt' => ,
            'notificationStatus' => 'DISABLED',
            'profileId' => 'analyst-readonly',
            'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
            'state' => [
                'value' => 'WARNING',
                'data' => [
                    'thresholdBreached' => 14,
                ],
                'transitionedAt' => ,
            ],
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListDomainAccessGrantsForOrganization

$result = $client->listDomainAccessGrantsForOrganization([/* ... */]);
$promise = $client->listDomainAccessGrantsForOrganizationAsync([/* ... */]);

Returns organization-level domain access grants, with optional filtering by domain, principal, or permission. A grant is returned only when it matches every filter supplied. With no filters, returns the grants for the caller's organization.

Parameter Syntax

$result = $client->listDomainAccessGrantsForOrganization([
    'domainId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'permission' => 'ADMIN',
    'principalId' => '<string>',
    'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'domainId' => '<string>',
            'grantArn' => '<string>',
            'grantId' => '<string>',
            'grantType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
            'name' => '<string>',
            'permission' => 'ADMIN',
            'principal' => [
                'principalAttributes' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'principalId' => '<string>',
                'principalType' => 'IDC_USER|IDC_GROUP|IAM_USER|IAM_ROLE|IAM_ROOT',
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List organization domain access grants

The following example lists the first page of organization domain access grants and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listDomainAccessGrantsForOrganization([
    'domainId' => 'd-1a2b3c4d5e',
    'maxResults' => 50,
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'org-domain-admin',
            'createdAt' => ,
            'domainId' => 'd-1a2b3c4d5e',
            'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-access-grant/7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
            'grantId' => '7f3e9d21-4c8b-4f6a-b1d2-3e4f5a6b7c8d',
            'grantType' => 'CUSTOMER_MANAGED',
            'permission' => 'ADMIN',
            'principal' => [
                'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
                'principalType' => 'IDC_USER',
            ],
            'updatedAt' => ,
        ],
        [
            'name' => 'org-domain-admin-group',
            'createdAt' => ,
            'domainId' => 'd-1a2b3c4d5e',
            'grantArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-access-grant/8a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
            'grantId' => '8a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d',
            'grantType' => 'CUSTOMER_MANAGED',
            'permission' => 'ADMIN',
            'principal' => [
                'principalId' => '2f5a8c1b-6d3e-4f7a-8b9c-0d1e2f3a4b5c',
                'principalType' => 'IDC_GROUP',
            ],
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Returns the caller's domains: the account-scoped domain and the organization-scoped domain, if either exists. At most two domains are returned.

Parameter Syntax

$result = $client->listDomains([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'domainArn' => '<string>',
            'domainId' => '<string>',
            'identityCenterInstanceArn' => '<string>',
            'name' => '<string>',
            'region' => '<string>',
            'status' => 'ACTIVE',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List domains

The following example lists the caller's domains. At most two are returned — the account-scoped domain and the organization-scoped domain — so there is no nextToken. Payloads are shown as JSON; on the wire they are CBOR-encoded.

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

Result syntax:

[
    'items' => [
        [
            'name' => 'prod-observability',
            'createdAt' => ,
            'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
            'domainId' => 'd-1a2b3c4d5e',
            'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            'region' => 'us-east-1',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
        [
            'name' => 'prod-observability-org',
            'createdAt' => ,
            'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-domain/d-9z8y7x6w5v',
            'domainId' => 'd-9z8y7x6w5v',
            'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            'region' => 'us-east-1',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
    ],
]

ListIntegrations

$result = $client->listIntegrations([/* ... */]);
$promise = $client->listIntegrationsAsync([/* ... */]);

Lists the integrations in the account, optionally filtered by type, status, or name. Results are paginated.

Parameter Syntax

$result = $client->listIntegrations([
    'integrationType' => 'AWS_CONFIG_SLREC|SLACK|EXTERNAL_AGENT|AWS_INTEGRATION',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'status' => 'ACTIVE|DELETED|PENDING|PENDING_OAUTH|ERROR|FAILED',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'authType' => 'NONE|OAUTH2|API_KEY',
            'authorizationUrl' => '<string>',
            'createdAt' => <DateTime>,
            'credentialArn' => '<string>',
            'errorMessage' => '<string>',
            'integrationArn' => '<string>',
            'integrationAttributes' => ['<string>', ...],
            'integrationId' => '<string>',
            'integrationType' => 'AWS_CONFIG_SLREC|SLACK|EXTERNAL_AGENT|AWS_INTEGRATION',
            'name' => '<string>',
            'roleArn' => '<string>',
            'scope' => 'ACCOUNT|ORGANIZATION',
            'status' => 'ACTIVE|DELETED|PENDING|PENDING_OAUTH|ERROR|FAILED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List integrations of a type

The following example lists up to 20 AWS_INTEGRATION integrations in the account. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listIntegrations([
    'integrationType' => 'AWS_INTEGRATION',
    'maxResults' => 20,
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'my-aws-integration',
            'createdAt' => ,
            'integrationArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
            'integrationId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
            'integrationType' => 'AWS_INTEGRATION',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListOmniDashboards

$result = $client->listOmniDashboards([/* ... */]);
$promise = $client->listOmniDashboardsAsync([/* ... */]);

Returns the dashboards in a space, optionally filtered by name prefix.

Parameter Syntax

$result = $client->listOmniDashboards([
    'maxResults' => <integer>,
    'namePrefix' => '<string>',
    'nextToken' => '<string>',
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'dashboardId' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List dashboards in a space

The following example lists the first page of dashboards in a space and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listOmniDashboards([
    'maxResults' => 50,
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'service-health-overview',
            'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
            'createdAt' => ,
            'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
            'dashboardId' => 'c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
            'description' => 'Overview of service health metrics.',
            'updatedAt' => ,
        ],
        [
            'name' => 'cost-explorer-dashboard',
            'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/d4e5f6a7-8b9c-4d0e-9f1a-2b3c4d5e6f70',
            'createdAt' => ,
            'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
            'dashboardId' => 'd4e5f6a7-8b9c-4d0e-9f1a-2b3c4d5e6f70',
            'description' => 'Monthly cost breakdown by service.',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListSpaces

$result = $client->listSpaces([/* ... */]);
$promise = $client->listSpacesAsync([/* ... */]);

Returns the spaces in the account, optionally filtered by domain.

Parameter Syntax

$result = $client->listSpaces([
    'domainId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'domainArn' => '<string>',
            'name' => '<string>',
            'ownerAccountId' => '<string>',
            'region' => '<string>',
            'spaceArn' => '<string>',
            'spaceId' => '<string>',
            'status' => 'ACTIVE|SUSPENDED|MOVING',
            'statusReason' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List spaces in a domain

The following example lists the first page of spaces in a domain and returns a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listSpaces([
    'domainId' => 'd-1a2b3c4d5e',
    'maxResults' => 50,
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'prod-observability',
            'createdAt' => ,
            'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
            'ownerAccountId' => '123456789012',
            'region' => 'us-east-1',
            'spaceArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:space/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
            'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
        [
            'name' => 'staging-observability',
            'createdAt' => ,
            'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
            'ownerAccountId' => '123456789012',
            'region' => 'us-east-1',
            'spaceArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:space/b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e',
            'spaceId' => 'b2c3d4e5-6f7a-4b8c-9d0e-1f2a3b4c5d6e',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListSpacesForOrganization

$result = $client->listSpacesForOrganization([/* ... */]);
$promise = $client->listSpacesForOrganizationAsync([/* ... */]);

Returns the spaces across all member accounts in the organization.

Parameter Syntax

$result = $client->listSpacesForOrganization([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'domainArn' => '<string>',
            'name' => '<string>',
            'ownerAccountId' => '<string>',
            'region' => '<string>',
            'spaceArn' => '<string>',
            'spaceId' => '<string>',
            'status' => 'ACTIVE|SUSPENDED|MOVING',
            'statusReason' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List spaces across the organization

The following example lists the first page of spaces across all member accounts in the organization. The results include spaces owned by different accounts, along with a nextToken to retrieve the next page. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listSpacesForOrganization([
    'maxResults' => 50,
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'prod-observability',
            'createdAt' => ,
            'ownerAccountId' => '111122223333',
            'region' => 'us-east-1',
            'spaceArn' => 'arn:aws:cloudwatch:us-east-1:111122223333:space/c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f',
            'spaceId' => 'c1d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
        [
            'name' => 'prod-observability',
            'createdAt' => ,
            'ownerAccountId' => '444455556666',
            'region' => 'us-east-1',
            'spaceArn' => 'arn:aws:cloudwatch:us-east-1:444455556666:space/d4e5f6a7-8b9c-4d0e-8f1a-2b3c4d5e6f7a',
            'spaceId' => 'd4e5f6a7-8b9c-4d0e-8f1a-2b3c4d5e6f7a',
            'status' => 'ACTIVE',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjIwfQ==',
]

ListTelemetryFields

$result = $client->listTelemetryFields([/* ... */]);
$promise = $client->listTelemetryFieldsAsync([/* ... */]);

Lists fields available for telemetry queries.

Returns a list of fields included in the specified dataset, granular to telemetry type. Returned field names reflect the exact stored casing and are case-sensitive when referenced in query expressions; the query engine does not normalize identifier case.

Parameter Syntax

$result = $client->listTelemetryFields([
    'dataSetName' => '<string>', // REQUIRED
    'endTime' => <integer || string || DateTime>,
    'nextToken' => '<string>',
    'startTime' => <integer || string || DateTime>,
    'telemetryType' => 'LOGS|TRACES',
]);

Parameter Details

Result Syntax

[
    'fields' => [
        [
            'children' => [
                [...], // RECURSIVE
                // ...
            ],
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List fields for a dataset

The following example lists the log fields available in the specified dataset. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listTelemetryFields([
    'dataSetName' => 'default',
    'telemetryType' => 'LOGS',
]);

Result syntax:

[
    'fields' => [
        [
            'name' => '@timestamp',
        ],
        [
            'name' => '@message',
        ],
        [
            'name' => 'attributes',
            'children' => [
                [
                    'name' => 'http.method',
                ],
                [
                    'name' => 'http.status_code',
                ],
            ],
        ],
    ],
]

ListTelemetryQuerySessions

$result = $client->listTelemetryQuerySessions([/* ... */]);
$promise = $client->listTelemetryQuerySessionsAsync([/* ... */]);

Lists telemetry query sessions.

Returns a list of telemetry query sessions owned by the caller.

Parameter Syntax

$result = $client->listTelemetryQuerySessions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sessions' => [
        [
            'createdAt' => <DateTime>,
            'lastActivityAt' => <DateTime>,
            'sessionId' => '<string>',
            'sessionName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List telemetry query sessions

The following example lists the query sessions owned by the caller. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listTelemetryQuerySessions([
    'maxResults' => 10,
]);

Result syntax:

[
    'nextToken' => 'eyJvZmZzZXQiOjEwfQ==',
    'sessions' => [
        [
            'createdAt' => ,
            'lastActivityAt' => ,
            'sessionId' => '9f8c7d6e-5b4a-4c3d-9e2f-1a0b2c3d4e5f',
            'sessionName' => 'prod-latency-investigation',
        ],
    ],
]

ListViews

$result = $client->listViews([/* ... */]);
$promise = $client->listViewsAsync([/* ... */]);

Lists the views in the caller's account and region.

Returns a summary for each view, optionally filtered by view type. View definitions are not included — use GetView to retrieve them.

Parameter Syntax

$result = $client->listViews([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'type' => 'USER|MANAGED',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'type' => 'USER|MANAGED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: List the views in an account and Region

The following example returns a page of view summaries, filtered to user-created views. Definitions are not included — call GetView to retrieve them. A nextToken is returned when more results are available. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->listViews([
    'type' => 'USER',
    'maxResults' => 10,
]);

Result syntax:

[
    'items' => [
        [
            'name' => 'view.service_errors',
            'type' => 'USER',
            'createdAt' => ,
            'description' => 'Error counts by service',
            'updatedAt' => ,
        ],
    ],
    'nextToken' => 'eyJvZmZzZXQiOjEwfQ==',
]

PutIntelligenceConfiguration

$result = $client->putIntelligenceConfiguration([/* ... */]);
$promise = $client->putIntelligenceConfigurationAsync([/* ... */]);

Creates or updates the intelligence configuration for the calling account. Account is identified via FAS (caller identity).

Parameter Syntax

$result = $client->putIntelligenceConfiguration([
    'clientToken' => '<string>',
    'kmsKeyArn' => '<string>',
    'removeKmsKey' => true || false,
]);

Parameter Details

Result Syntax

[
    'accountId' => '<string>',
    'createdAt' => <DateTime>,
    'kmsKeyArn' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Configure a customer-managed KMS key

The following example sets the customer-managed KMS key used to encrypt the account's intelligence data. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->putIntelligenceConfiguration([
    'clientToken' => 'b3f8c7d6-5b4a-4c3d-9e2f-1a0b2c3d4e5f',
    'kmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'accountId' => '123456789012',
    'createdAt' => ,
    'kmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    'updatedAt' => ,
]

SearchPrincipals

$result = $client->searchPrincipals([/* ... */]);
$promise = $client->searchPrincipalsAsync([/* ... */]);

Searches Identity Center for users and groups in a domain. The domain must be configured with Identity Center.

To grant access to a result, pass its principalId to CreateAccessGrant with a principalType of IDC_USER for a user or IDC_GROUP for a group.

Parameter Syntax

$result = $client->searchPrincipals([
    'domainId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchQuery' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'results' => [
        [
            'description' => '<string>',
            'displayName' => '<string>',
            'principalId' => '<string>',
            'principalType' => 'USER|GROUP',
            'userName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Search principals by name

The following example searches a domain for principals whose name matches a text query. A text search (any searchQuery other than *) returns at most 10 results and does not paginate, so maxResults and nextToken are not supplied and no nextToken is returned. To grant access to a result, pass its principalId to CreateAccessGrant with a principalType of IDC_USER for a user or IDC_GROUP for a group. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->searchPrincipals([
    'domainId' => 'd-1a2b3c4d5e',
    'searchQuery' => 'jane',
]);

Result syntax:

[
    'results' => [
        [
            'displayName' => 'Jane Doe',
            'principalId' => '94b6c7d8-1a2b-4c3d-9e4f-5a6b7c8d9e0f',
            'principalType' => 'USER',
            'userName' => 'jane.doe',
        ],
        [
            'displayName' => 'Jane's Analysts',
            'principalId' => '2f5a8c1b-6d3e-4f7a-8b9c-0d1e2f3a4b5c',
            'principalType' => 'GROUP',
        ],
    ],
]

StartTelemetryQuery

$result = $client->startTelemetryQuery([/* ... */]);
$promise = $client->startTelemetryQueryAsync([/* ... */]);

Starts a telemetry query within a session.

Submits the provided query string for execution in the specified session. Use GetTelemetryQueryResults to poll for results and check query status.

Parameter Syntax

$result = $client->startTelemetryQuery([
    'queryString' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'queryId' => '<string>',
    'sessionId' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Start a telemetry query

The following example submits a SQL query within a session and returns the query ID used to poll for results. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->startTelemetryQuery([
    'queryString' => 'SELECT `@timestamp`, `@message` FROM "logs.default" WHERE `@timestamp` BETWEEN NOW() - INTERVAL '1 HOUR' AND NOW() ORDER BY `@timestamp` DESC LIMIT 100',
    'sessionId' => '9f8c7d6e-5b4a-4c3d-9e2f-1a0b2c3d4e5f',
]);

Result syntax:

[
    'queryId' => '3b2a1c0d-7e6f-4a5b-8c9d-0e1f2a3b4c5d',
    'sessionId' => '9f8c7d6e-5b4a-4c3d-9e2f-1a0b2c3d4e5f',
]

StartTelemetryQuerySession

$result = $client->startTelemetryQuerySession([/* ... */]);
$promise = $client->startTelemetryQuerySessionAsync([/* ... */]);

Starts a new telemetry query session.

A session provides a logical grouping for one or more telemetry queries. The returned session ID is required when starting queries via StartTelemetryQuery.

Parameter Syntax

$result = $client->startTelemetryQuerySession([
    'sessionName' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Start a telemetry query session

The following example starts a session for grouping telemetry queries and returns its session ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->startTelemetryQuerySession([
    'sessionName' => 'prod-latency-investigation',
]);

Result syntax:

[
    'sessionId' => '9f8c7d6e-5b4a-4c3d-9e2f-1a0b2c3d4e5f',
]

StopTelemetryQuery

$result = $client->stopTelemetryQuery([/* ... */]);
$promise = $client->stopTelemetryQueryAsync([/* ... */]);

Stops a running telemetry query.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Stop a running telemetry query

The following example stops a running query by its ID. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->stopTelemetryQuery([
    'queryId' => '3b2a1c0d-7e6f-4a5b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
]

StopTelemetryQuerySession

$result = $client->stopTelemetryQuerySession([/* ... */]);
$promise = $client->stopTelemetryQuerySessionAsync([/* ... */]);

Stops a telemetry query session.

Terminates the specified session. After a session is stopped it cannot be reused.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Stop a telemetry query session

The following example terminates the specified session. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->stopTelemetryQuerySession([
    'sessionId' => '9f8c7d6e-5b4a-4c3d-9e2f-1a0b2c3d4e5f',
]);

Result syntax:

[
]

UpdateAccessProfile

$result = $client->updateAccessProfile([/* ... */]);
$promise = $client->updateAccessProfileAsync([/* ... */]);

Updates the name or description of an access profile.

Only the provided fields are changed; omitted fields are left unchanged.

Parameter Syntax

$result = $client->updateAccessProfile([
    'description' => '<string>',
    'name' => '<string>',
    'profileId' => '<string>', // REQUIRED
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'accessProfile' => [
        'arn' => '<string>',
        'assumeStatus' => 'ALLOWED|DENIED',
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'name' => '<string>',
        'profileId' => '<string>',
        'profileType' => 'SERVICE_MANAGED|CUSTOMER_MANAGED',
        'spaceId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Update an access profile description

The following example updates only the description of an access profile; the name is left unchanged. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->updateAccessProfile([
    'description' => 'Read-only access for analysts and on-call responders.',
    'profileId' => 'analyst-readonly',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'accessProfile' => [
        'name' => 'Analyst read-only profile',
        'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:access-profile/analyst-readonly',
        'createdAt' => ,
        'description' => 'Read-only access for analysts and on-call responders.',
        'profileId' => 'analyst-readonly',
        'profileType' => 'CUSTOMER_MANAGED',
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'updatedAt' => ,
    ],
]

UpdateAlert

$result = $client->updateAlert([/* ... */]);
$promise = $client->updateAlertAsync([/* ... */]);

Updates an existing alert.

Only non-null fields overwrite existing values.

Parameter Syntax

$result = $client->updateAlert([
    'alertId' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>',
    'notificationRules' => [
        [
            'target' => [ // REQUIRED
                'arn' => '<string>', // REQUIRED
                'metadata' => ['<string>', ...],
                'type' => 'sns|slack|pagerduty', // REQUIRED
            ],
            'trigger' => [ // REQUIRED
                'stateValues' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'notificationsEnabled' => true || false,
    'profileId' => '<string>',
    'rule' => [
        'telemetryRule' => [
            'condition' => [
                'comparator' => 'GT|LT|GTE|LTE',
                'criticalThreshold' => <float>,
                'thresholdField' => '<string>',
                'thresholdMode' => 'COUNT_OF_RESULTS|FIELD_VALUE',
                'warningThreshold' => <float>,
            ],
            'evaluation' => [
                'intervalSeconds' => <integer>, // REQUIRED
                'pendingDurationSeconds' => <integer>,
                'recoveryDurationSeconds' => <integer>,
            ],
            'noData' => [
                'treatAs' => 'OK|WARNING|CRITICAL|NODATA', // REQUIRED
            ],
            'query' => [
                'expression' => '<string>', // REQUIRED
                'language' => 'SQL|PROMQL', // REQUIRED
            ],
        ],
    ],
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Raise an alert's thresholds

The following example replaces only the condition of an alert's rule; the query, the evaluation cadence and the notification rules are left unchanged. A supplied condition is replaced whole rather than merged, so every threshold to keep is sent again. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->updateAlert([
    'alertId' => 'c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f',
    'rule' => [
        'telemetryRule' => [
            'condition' => [
                'comparator' => 'GT',
                'criticalThreshold' => 400,
                'thresholdField' => 'error_count',
                'thresholdMode' => 'FIELD_VALUE',
                'warningThreshold' => 100,
            ],
        ],
    ],
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
]

UpdateDomain

$result = $client->updateDomain([/* ... */]);
$promise = $client->updateDomainAsync([/* ... */]);

Updates a domain's name or identity provider configuration.

Only the provided fields are changed; omitted fields are left unchanged. Renaming a domain also changes the endpoint URLs derived from its name.

Parameter Syntax

$result = $client->updateDomain([
    'domainId' => '<string>', // REQUIRED
    'identityProviderConfiguration' => [
        'identityCenterConfiguration' => [
            'identityCenterInstanceArn' => '<string>',
        ],
    ],
    'identityProviders' => ['<string>', ...],
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'domain' => [
        'createdAt' => <DateTime>,
        'customEndpointUrls' => ['<string>', ...],
        'domainArn' => '<string>',
        'domainEndpointUrl' => '<string>',
        'domainId' => '<string>',
        'identityCenterApplicationArn' => '<string>',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => '<string>',
            ],
        ],
        'identityProviders' => ['<string>', ...],
        'name' => '<string>',
        'region' => '<string>',
        'status' => 'ACTIVE',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Rename a domain

The following example performs a partial update that changes only the domain name; the omitted fields are left unchanged. Renaming the domain also updates the endpoint URLs derived from its name, and updatedAt advances past createdAt. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->updateDomain([
    'name' => 'prod-observability-metrics',
    'domainId' => 'd-1a2b3c4d5e',
]);

Result syntax:

[
    'domain' => [
        'name' => 'prod-observability-metrics',
        'createdAt' => ,
        'customEndpointUrls' => [
            'https://prod-observability-metrics.cloudwatch-omni.global.app.aws',
        ],
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
        'domainEndpointUrl' => 'https://d-1a2b3c4d5e.cloudwatch-omni.global.app.aws',
        'domainId' => 'd-1a2b3c4d5e',
        'identityCenterApplicationArn' => 'arn:aws:sso::123456789012:application/ssoins-1234567890abcdef/apl-0f9e8d7c6b5a4938',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            ],
        ],
        'identityProviders' => [
            'IDC',
        ],
        'region' => 'us-east-1',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

UpdateDomainForOrganization

$result = $client->updateDomainForOrganization([/* ... */]);
$promise = $client->updateDomainForOrganizationAsync([/* ... */]);

Updates an organization domain's name or identity provider configuration. Call this operation in the Region where the domain was created.

Only the provided fields are changed; omitted fields are left unchanged. Renaming a domain also changes the endpoint URLs derived from its name.

Parameter Syntax

$result = $client->updateDomainForOrganization([
    'domainId' => '<string>', // REQUIRED
    'identityProviderConfiguration' => [
        'identityCenterConfiguration' => [
            'identityCenterInstanceArn' => '<string>',
        ],
    ],
    'identityProviders' => ['<string>', ...],
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'organizationDomain' => [
        'createdAt' => <DateTime>,
        'customEndpointUrls' => ['<string>', ...],
        'domainAccessRoleArn' => '<string>',
        'domainArn' => '<string>',
        'domainEndpointUrl' => '<string>',
        'domainId' => '<string>',
        'identityCenterApplicationArn' => '<string>',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => '<string>',
            ],
        ],
        'identityProviders' => ['<string>', ...],
        'name' => '<string>',
        'organizationId' => '<string>',
        'ownerAccountId' => '<string>',
        'region' => '<string>',
        'status' => 'ACTIVE',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

Examples

Example 1: Rename an organization domain

The following example performs a partial update that changes only the organization domain name; the omitted fields are left unchanged. The endpoint URLs derived from the name are updated, and updatedAt advances past createdAt. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->updateDomainForOrganization([
    'name' => 'prod-observability-org-metrics',
    'domainId' => 'd-9z8y7x6w5v',
]);

Result syntax:

[
    'organizationDomain' => [
        'name' => 'prod-observability-org-metrics',
        'createdAt' => ,
        'customEndpointUrls' => [
            'https://prod-observability-org-metrics.cloudwatch-omni.global.app.aws',
        ],
        'domainAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchOrganizationDomainAccessRole',
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:organization-domain/d-9z8y7x6w5v',
        'domainEndpointUrl' => 'https://d-9z8y7x6w5v.cloudwatch-omni.global.app.aws',
        'domainId' => 'd-9z8y7x6w5v',
        'identityCenterApplicationArn' => 'arn:aws:sso::123456789012:application/ssoins-1234567890abcdef/apl-0f9e8d7c6b5a4938',
        'identityProviderConfiguration' => [
            'identityCenterConfiguration' => [
                'identityCenterInstanceArn' => 'arn:aws:sso:::instance/ssoins-1234567890abcdef',
            ],
        ],
        'identityProviders' => [
            'IDC',
        ],
        'organizationId' => 'o-a1b2c3d4e5',
        'ownerAccountId' => '123456789012',
        'region' => 'us-east-1',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

UpdateIntegration

$result = $client->updateIntegration([/* ... */]);
$promise = $client->updateIntegrationAsync([/* ... */]);

Updates an existing integration, identified by its id, ARN, or name. Only the fields you provide are changed.

Parameter Syntax

$result = $client->updateIntegration([
    'credential' => [
        'apiKeyCredential' => [
            'apiKeyValue' => '<string>', // REQUIRED
        ],
        'oauthClientCredential' => [
            'clientId' => '<string>', // REQUIRED
            'clientSecret' => '<string>', // REQUIRED
            'providerId' => '<string>',
        ],
        'oauthCodeCredential' => [
            'authCode' => '<string>', // REQUIRED
        ],
    ],
    'identifier' => [ // REQUIRED
        'integrationArn' => '<string>',
        'integrationId' => '<string>',
        'integrationName' => '<string>',
    ],
    'integrationAttributes' => ['<string>', ...],
    'roleArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'integration' => [
        'authType' => 'NONE|OAUTH2|API_KEY',
        'authorizationUrl' => '<string>',
        'createdAt' => <DateTime>,
        'credentialArn' => '<string>',
        'errorMessage' => '<string>',
        'integrationArn' => '<string>',
        'integrationAttributes' => ['<string>', ...],
        'integrationId' => '<string>',
        'integrationType' => 'AWS_CONFIG_SLREC|SLACK|EXTERNAL_AGENT|AWS_INTEGRATION',
        'name' => '<string>',
        'roleArn' => '<string>',
        'scope' => 'ACCOUNT|ORGANIZATION',
        'status' => 'ACTIVE|DELETED|PENDING|PENDING_OAUTH|ERROR|FAILED',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

Examples

Example 1: Update an integration's attributes

The following example replaces the provider-specific attributes of the integration identified by its id. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->updateIntegration([
    'identifier' => [
        'integrationId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
    ],
    'integrationAttributes' => [
        'notificationChannel' => 'ops-oncall',
    ],
]);

Result syntax:

[
    'integration' => [
        'name' => 'my-aws-integration',
        'createdAt' => ,
        'integrationArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:integration/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'integrationAttributes' => [
            'notificationChannel' => 'ops-oncall',
        ],
        'integrationId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'integrationType' => 'AWS_INTEGRATION',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

UpdateOmniDashboard

$result = $client->updateOmniDashboard([/* ... */]);
$promise = $client->updateOmniDashboardAsync([/* ... */]);

Updates an existing dashboard within a space.

Only the provided fields are changed; omitted fields are left unchanged.

Parameter Syntax

$result = $client->updateOmniDashboard([
    'body' => '<string>',
    'dashboardId' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>',
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'omniDashboard' => [
        'arn' => '<string>',
        'body' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'dashboardId' => '<string>',
        'description' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Update a dashboard body

The following example updates only the body of a dashboard; the name and description are left unchanged. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->updateOmniDashboard([
    'body' => '{"widgets":[{"type":"metric","x":0,"y":0,"width":24,"height":6,"properties":{"metrics":[["AWS/Lambda","Errors","FunctionName","OrderProcessor"],["AWS/Lambda","Throttles","FunctionName","OrderProcessor"]],"region":"us-east-1","title":"Lambda Errors and Throttles"}}]}',
    'dashboardId' => 'c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'omniDashboard' => [
        'name' => 'service-health-overview',
        'arn' => 'arn:aws:cloudwatch:us-east-1:123456789012:omni-dashboard/c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
        'body' => '{"widgets":[{"type":"metric","x":0,"y":0,"width":24,"height":6,"properties":{"metrics":[["AWS/Lambda","Errors","FunctionName","OrderProcessor"],["AWS/Lambda","Throttles","FunctionName","OrderProcessor"]],"region":"us-east-1","title":"Lambda Errors and Throttles"}}]}',
        'createdAt' => ,
        'createdBy' => 'arn:aws:iam::123456789012:role/ObservabilityAdmin',
        'dashboardId' => 'c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f',
        'description' => 'Overview of service health metrics.',
        'tags' => [
            'Team' => 'observability',
        ],
        'updatedAt' => ,
    ],
]

UpdateSpace

$result = $client->updateSpace([/* ... */]);
$promise = $client->updateSpaceAsync([/* ... */]);

Updates a space.

Only the provided fields are changed; omitted fields are left unchanged.

Parameter Syntax

$result = $client->updateSpace([
    'encryptionConfiguration' => [
        'encryptionStrategy' => 'AWS_OWNED|CUSTOMER_MANAGED', // REQUIRED
        'kmsKeyArn' => '<string>',
    ],
    'name' => '<string>',
    'spaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'space' => [
        'agentCoreEvaluationRoleArn' => '<string>',
        'createdAt' => <DateTime>,
        'dataAccessRoleArn' => '<string>',
        'domainArn' => '<string>',
        'encryptionConfiguration' => [
            'encryptionStrategy' => 'AWS_OWNED|CUSTOMER_MANAGED',
            'kmsKeyArn' => '<string>',
        ],
        'name' => '<string>',
        'ownerAccountId' => '<string>',
        'region' => '<string>',
        'spaceArn' => '<string>',
        'spaceId' => '<string>',
        'status' => 'ACTIVE|SUSPENDED|MOVING',
        'statusReason' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.

ServiceQuotaExceededException:

A service quota was exceeded.

Examples

Example 1: Rename a space

The following example updates only the name of a space; omitted fields are left unchanged. The response returns the full space with a later updatedAt timestamp. Payloads are shown as JSON; on the wire they are CBOR-encoded.

$result = $client->updateSpace([
    'name' => 'prod-observability-team',
    'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
]);

Result syntax:

[
    'space' => [
        'name' => 'prod-observability-team',
        'agentCoreEvaluationRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchAgentCoreEvaluationRole',
        'createdAt' => ,
        'dataAccessRoleArn' => 'arn:aws:iam::123456789012:role/CloudWatchSpaceDataAccessRole',
        'domainArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:domain/d-1a2b3c4d5e',
        'encryptionConfiguration' => [
            'encryptionStrategy' => 'CUSTOMER_MANAGED',
            'kmsKeyArn' => 'arn:aws:kms:us-east-1:123456789012:key/1a2b3c4d-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        ],
        'ownerAccountId' => '123456789012',
        'region' => 'us-east-1',
        'spaceArn' => 'arn:aws:cloudwatch:us-east-1:123456789012:space/a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'spaceId' => 'a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d',
        'status' => 'ACTIVE',
        'updatedAt' => ,
    ],
]

UpdateView

$result = $client->updateView([/* ... */]);
$promise = $client->updateViewAsync([/* ... */]);

Updates an existing view's definition and/or description.

Only the fields you provide are changed. Managed views cannot be updated.

Parameter Syntax

$result = $client->updateView([
    'definition' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'definition' => '<string>',
    'description' => '<string>',
    'name' => '<string>',
    'type' => 'USER|MANAGED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ThrottlingException:

The request was throttled due to exceeding the allowed request rate.

ValidationException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The specified resource does not exist.

AccessDeniedException:

The caller is not authorized to perform this action.

InternalServerException:

An unexpected error occurred while processing the request.

ConflictException:

The operation could not be completed because of a conflict with the current state of the resource.