Package-level declarations

Types

Link copied to clipboard

The caller is not authorized to perform this action.

Link copied to clipboard

Full AccessGrant structure returned by API operations.

Link copied to clipboard

Permission levels for AccessGrants. SPACE_ADMIN can manage grants within a space but cannot create spaces.

Link copied to clipboard

The principal receiving the grant. Specify principalId, principalAttributes, or both.

Link copied to clipboard

A single attribute condition used to match principals for attribute-based access.

Link copied to clipboard

Type of principal receiving the grant.

Link copied to clipboard

Summary of an AccessGrant. Call GetAccessGrant for the full grant.

Link copied to clipboard
sealed class AccessGrantType

Who manages an access grant.

Link copied to clipboard

An Access Profile.

Link copied to clipboard

Summary of an access profile. Call GetAccessProfile for the full profile.

Link copied to clipboard
sealed class AccessProfileType

Who manages an access profile.

Link copied to clipboard
class Alert

Full alert entity, returned by both CreateAlert and GetAlert. A create and a read of the same alert describe it identically except for {@code state}, which only the read paths populate. UpdateAlert returns an empty response.

Link copied to clipboard

The condition that determines when the alert fires. On UpdateAlert a supplied condition is replaced whole, not merged: an omitted {@code warningThreshold} or {@code criticalThreshold} removes that tier, and an omitted {@code thresholdField} clears it. A condition must keep at least one tier. {@code thresholdMode} and {@code comparator} are optional at the Smithy level (so a single-tier condition is expressible) but are required whenever a threshold is present; enforced by the service-side validator.

Link copied to clipboard

Evaluation cadence. {@code intervalSeconds} must be one of {30, 60, 120, 300, 600, 900, 1800, 3600}; {@code pendingDurationSeconds} and {@code recoveryDurationSeconds} must be multiples of {@code intervalSeconds}. A duration of 0 means fire/clear immediately with no delay. On UpdateAlert a supplied evaluation block is replaced whole, not merged: an omitted {@code pendingDurationSeconds} or {@code recoveryDurationSeconds} is cleared to unset (no such duration), not preserved and not defaulted to 0. {@code intervalSeconds} is required whenever the block is present. All enforced server-side / by the front-door validator.

Link copied to clipboard

Filter criteria for ListAlerts. All members are optional; each omitted member is unconstrained. At most one of {@code names}, {@code namePrefix}, {@code ids} may be provided (mutually exclusive; the service rejects more than one). The remaining members combine with AND.

Link copied to clipboard

Query expression and the language it's written in.

Link copied to clipboard
sealed class AlertSortField

Field by which alerts can be sorted.

Link copied to clipboard
sealed class AlertSortOrder

Sort order for list results.

Link copied to clipboard
sealed class AlertState

Flat alert state. Severity is folded in: a WARNING/CRITICAL alert reports that state directly. {@code NODATA} indicates the evaluation produced no data (subject to the rule's noData.treatAs handling).

Link copied to clipboard

Structured detail about the current evaluation.

Link copied to clipboard

Live evaluation state for an alert. Read-only, system-managed.

Link copied to clipboard

Summary representation of an alert used in list responses.

Link copied to clipboard

An API key used to authenticate an integration with its external system.

Link copied to clipboard
sealed class AssumeStatus

The calling principal's authorization to assume an access profile.

Link copied to clipboard
sealed class AuthType

The authentication method that an integration uses to connect to its external system.

Link copied to clipboard

A set of temporary AWS credentials.

Link copied to clipboard

Base class for all service related exceptions thrown by the CloudWatchOmni client

Link copied to clipboard
sealed class Comparator

Comparison operator for a threshold.

Link copied to clipboard

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

Link copied to clipboard

Counts of contributors currently breaching each severity threshold.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request for creating an integration with a third-party provider.

Link copied to clipboard

The response from creating an integration.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request for deleting an integration.

Link copied to clipboard

The response from deleting an integration. Empty by contract — a successful call indicates the deletion was accepted (DeleteIntegration is idempotent).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class Domain

Detailed information about a domain.

Link copied to clipboard
sealed class DomainStatus

Current status of a domain.

Link copied to clipboard

Summary of a domain. Call GetDomain for the full domain.

Link copied to clipboard
class Edge

A directed edge in the context graph connecting two nodes.

Link copied to clipboard

Criteria for filtering edges in a context graph query.

Link copied to clipboard

Edge attributes promoted out of the flat attribute map onto typed members. Which members are present depends entirely on what produced the edge, so most edges carry only a few of them.

Link copied to clipboard

Additive traffic counters accumulated over an edge's observation window. Which counters are populated depends on what produced the edge.

Link copied to clipboard
sealed class EdgeType

Context graph edge types.

Link copied to clipboard

How a resource's data at rest is encrypted. kmsKeyArn is required when encryptionStrategy is CUSTOMER_MANAGED and must be absent when it is AWS_OWNED; a mismatch is a ValidationException rather than a silently ignored field, so a caller that selects AWS_OWNED while still passing a key learns that the key was not applied.

Link copied to clipboard
sealed class EncryptionStrategy

Which kind of KMS key protects a resource's data at rest.

Link copied to clipboard
class Field

A telemetry field available for use in query expressions.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request for retrieving a slice of the context graph.

Link copied to clipboard

The response containing the requested slice of the context graph.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request for retrieving a single integration.

Link copied to clipboard

The response containing the requested integration.

Link copied to clipboard

The request for retrieving the intelligence configuration of the calling account.

Link copied to clipboard

The intelligence configuration for the calling account.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Identity Center specific configuration.

Link copied to clipboard
sealed class IdentityProvider

Identity provider type for a domain. Determines which identity mechanisms are active for authentication.

Link copied to clipboard

Identity provider configuration for domain authentication. Contains provider-specific configuration blocks.

Link copied to clipboard

A connection between CloudWatch and an external system — such as a source of telemetry or configuration data, a messaging destination, or a model provider.

Link copied to clipboard

The credential that an integration uses to authenticate with its external system. Exactly one member is set, matching the integration's authentication type.

Link copied to clipboard

Identifies a single integration by exactly one of its unique keys: the integration id, the integration ARN, or the integration name.

Link copied to clipboard
sealed class IntegrationStatus

The current lifecycle state of an integration.

Link copied to clipboard
sealed class IntegrationType

The type of external system that an integration connects to, such as a source of configuration data, a messaging destination, or a model provider.

Link copied to clipboard

An unexpected error occurred while processing the request.

Link copied to clipboard
class KeyFilter

Key-value filter used for tags and attributes filtering. Multiple KeyFilters are AND'ed. Multiple values within a single KeyFilter are OR'ed. Values support pattern syntax: exact, negation (!value), wildcard (value, value*, *value).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request for listing the integrations in an account.

Link copied to clipboard

The response containing a page of integrations.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

One LOGS query selector block on a node. The attributes map's keys are AND'd; each selects with col = value. Deliberately RAW/un-normalized so the selector matches the store, not the node's merged identity.

Link copied to clipboard
class Metadata

Descriptive information about a context graph node or edge, as opposed to its identity and structure. Returned only when the request sets includeMetadata.

Link copied to clipboard

A single metric observed on a context graph node.

Link copied to clipboard

The meaning and unit of a single metric.

Link copied to clipboard
class NoData

Configures how the alert reacts when an evaluation produces no data. {@code treatAs} carries the resulting state; defaults to {@code NODATA} when omitted.

Link copied to clipboard
class Node

A node in the context graph representing a service, resource, or remote service.

Link copied to clipboard
sealed class NodeCategory

Coarse classification of what a node is. Orthogonal to NodeType, which says whether the node is a service, a resource, or a remote service. Absent on most nodes today because few producers emit the source attribute.

Link copied to clipboard

Criteria for selecting nodes in a context graph query.

Link copied to clipboard

Node identity attributes promoted out of the flat attribute map onto typed members. The first four are part of the node's merge key, so a node that merged across sources reports one resolved value for each.

Link copied to clipboard

Semantic description of the service a context graph node represents.

Link copied to clipboard
sealed class NodeType

Context graph node types.

Link copied to clipboard

Single notification rule: which transitions trigger this rule and where the resulting notification should be sent.

Link copied to clipboard
sealed class NotificationStatus
Link copied to clipboard

The destination for a notification.

Link copied to clipboard

Supported notification target type.

Link copied to clipboard

Trigger conditions for a notification rule. {@code stateValues} entries combine with OR semantics; empty / omitted = any state.

Link copied to clipboard

Credentials for an OAuth 2.0 client-credentials grant used to authenticate an integration with its external system.

Link copied to clipboard

Credentials for an OAuth 2.0 authorization-code grant, supplied when completing the authorization of an integration.

Link copied to clipboard

A dashboard within a space, including its body.

Link copied to clipboard

Summary of a dashboard. Call GetOmniDashboard for the full dashboard.

Link copied to clipboard

An organization-scoped access grant.

Link copied to clipboard

The principal receiving an organization-level domain access grant. Specify principalId, principalAttributes, or both.

Link copied to clipboard

Summary of an organization access grant. Call GetDomainAccessGrantForOrganization for the full grant.

Link copied to clipboard

Selects which member-account credential GetSpaceCredentialsForOrganization returns.

Link copied to clipboard

Detailed information about an organization domain.

Link copied to clipboard

Permission level for an organization-scoped grant.

Link copied to clipboard

Principal types valid for organization-level domain access grants.

Link copied to clipboard

Indicates whether a query returned partial results.

Link copied to clipboard

A user or group matched by SearchPrincipals.

Link copied to clipboard
sealed class PrincipalType

Whether a principal is a user or a group.

Link copied to clipboard

The request for updating the intelligence configuration of the calling account.

Link copied to clipboard

The intelligence configuration for the calling account after the update.

Link copied to clipboard
sealed class QueryLanguage

Query language for an alert rule expression.

Link copied to clipboard

Statistics about a telemetry query execution.

Link copied to clipboard
sealed class QueryStatus

The current status of a telemetry query.

Link copied to clipboard

The specified resource does not exist.

Link copied to clipboard

A single resource scope entry within an AccessGrant. Associates a resource type with optional ARN patterns, tag conditions, and row-level filters.

Link copied to clipboard
class RowScope

A single additive row-level filter on an AccessGrant. A row is visible when its value for the given field matches the filter's values. Row filters are additive: the visible rows are the union of all row filters across a principal's matching grants.

Link copied to clipboard
sealed class RowScopeOperator

Match operator for a row-scope filter. Only IN is supported.

Link copied to clipboard
sealed class Rule

Top-level rule definition. {@code telemetryRule} members are optional at the Smithy level to support PATCH semantics on UpdateAlert (send only the sub-blocks you want to change). On CreateAlert, presence is enforced by the service-side validator.

Link copied to clipboard
sealed class Scope

Whether an integration is account-scoped (customer-created) or organization-scoped (created by an org-enablement rule on behalf of the destination account). Mirrors the {@code Scope} discriminator used by CloudWatch Centralization / Observability Admin.

Link copied to clipboard

A group of actions within an access grant, together with the resource scopes and context conditions that apply to exactly those actions.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A service quota was exceeded.

Link copied to clipboard

Summary information about a query session, including its identifier, name, and activity timestamps.

Link copied to clipboard
sealed class Signal

Signal enum for context graph queries.

Link copied to clipboard
sealed class SignalType

Telemetry signal type that row-scoped access control applies to.

Link copied to clipboard
sealed class Source

Data source enum for context graph queries.

Link copied to clipboard
class Space

Detailed information about a space.

Link copied to clipboard

Identifies what the credentials are for: either an existing space, or a target account in a domain. Specify spaceId, or both domainId and targetAccountId.

Link copied to clipboard
sealed class SpaceStatus

Status of a space.

Link copied to clipboard

Summary of a space. Call GetSpace for the full space.

Link copied to clipboard
Link copied to clipboard

Telemetry-based rule: what to query, how to evaluate the result, what condition makes it fire, and what to do on missing data.

Link copied to clipboard
sealed class TelemetryType

The type of telemetry data.

Link copied to clipboard
sealed class ThresholdMode

How a threshold is applied to query results.

Link copied to clipboard

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

Link copied to clipboard

One TRACES query selector block on a node/edge (see LogMetadata).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The request for updating an existing integration.

Link copied to clipboard

The response from updating an integration.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

A parameter is specified incorrectly.

Link copied to clipboard

Summary information about a view. Does not include the view definition.

Link copied to clipboard
sealed class ViewType

The ownership category of a view.