{ "smithy": "2.0", "shapes": { "com.amazonaws.observabilityadmin#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" }, "amznErrorType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "
The name of the exception.
", "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for Amazon Web Services resources in the IAM user guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.observabilityadmin#AccountIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.observabilityadmin#AccountIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AccountIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.observabilityadmin#Action": { "type": "enum", "members": { "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW" } }, "BLOCK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCK" } }, "COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COUNT" } }, "CAPTCHA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CAPTCHA" } }, "CHALLENGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHALLENGE" } }, "EXCLUDED_AS_COUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXCLUDED_AS_COUNT" } } }, "traits": { "smithy.api#documentation": "Enumeration of WAF actions that can be matched in filter conditions.
" } }, "com.amazonaws.observabilityadmin#ActionCondition": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.observabilityadmin#Action", "traits": { "smithy.api#documentation": "The WAF action to match against (ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT).
" } } }, "traits": { "smithy.api#documentation": "Condition that matches based on the specific WAF action taken on the request.
" } }, "com.amazonaws.observabilityadmin#AdvancedEventSelector": { "type": "structure", "members": { "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An optional, descriptive name for an advanced event selector, such as \"Log data events for only two S3 buckets\".
" } }, "FieldSelectors": { "target": "com.amazonaws.observabilityadmin#FieldSelectors", "traits": { "smithy.api#documentation": "Contains all selector statements in an advanced event selector.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Advanced event selectors let you create fine-grained selectors for management, data, and network activity events.
" } }, "com.amazonaws.observabilityadmin#AdvancedEventSelectors": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AdvancedEventSelector" } }, "com.amazonaws.observabilityadmin#AdvancedFieldSelector": { "type": "structure", "members": { "Field": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the field to use for selection.
", "smithy.api#required": {} } }, "Equals": { "target": "com.amazonaws.observabilityadmin#StringList", "traits": { "smithy.api#documentation": "Matches if the field value equals the specified value.
" } }, "StartsWith": { "target": "com.amazonaws.observabilityadmin#StringList", "traits": { "smithy.api#documentation": "Matches if the field value starts with the specified value.
" } }, "EndsWith": { "target": "com.amazonaws.observabilityadmin#StringList", "traits": { "smithy.api#documentation": "Matches if the field value ends with the specified value.
" } }, "NotEquals": { "target": "com.amazonaws.observabilityadmin#StringList", "traits": { "smithy.api#documentation": "Matches if the field value does not equal the specified value.
" } }, "NotStartsWith": { "target": "com.amazonaws.observabilityadmin#StringList", "traits": { "smithy.api#documentation": "Matches if the field value does not start with the specified value.
" } }, "NotEndsWith": { "target": "com.amazonaws.observabilityadmin#StringList", "traits": { "smithy.api#documentation": "Matches if the field value does not end with the specified value.
" } } }, "traits": { "smithy.api#documentation": "Defines criteria for selecting resources based on field values.
" } }, "com.amazonaws.observabilityadmin#AllRegions": { "type": "boolean" }, "com.amazonaws.observabilityadmin#AllSubscriptions": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Selects every Azure subscription that Azure role-based access control (Azure RBAC) allows the connector to read. Subscriptions that the connector can read later are included automatically.
" } }, "com.amazonaws.observabilityadmin#AwsConfigConnectorArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[a-z]+)*:config:[a-z0-9\\-]+:[0-9]{12}:connector/[^\\r\\n]+$" } }, "com.amazonaws.observabilityadmin#AwsResourceExplorerManagedViewArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws([a-z0-9\\-]+)?:resource-explorer-2:([a-z0-9\\-]+)?:([0-9]{12})?:managed-view/(.+)$" } }, "com.amazonaws.observabilityadmin#AzureAwsManagedFlowLogs": { "type": "structure", "members": { "RetentionDays": { "target": "com.amazonaws.observabilityadmin#AzureFlowLogRetentionDays", "traits": { "smithy.api#documentation": "The number of days that the created Storage Accounts keep Flow Logs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for Flow Log Storage Accounts that the setup creates, one in each Region that ingests Flow Logs.
" } }, "com.amazonaws.observabilityadmin#AzureClientIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, "com.amazonaws.observabilityadmin#AzureConnectorConfiguration": { "type": "structure", "members": { "TenantIdentifier": { "target": "com.amazonaws.observabilityadmin#AzureTenantIdentifier", "traits": { "smithy.api#documentation": "The ID of the Microsoft Entra ID tenant.
", "smithy.api#required": {} } }, "ClientIdentifier": { "target": "com.amazonaws.observabilityadmin#AzureClientIdentifier", "traits": { "smithy.api#documentation": "The application (client) ID of the Azure app registration. The app registration must have a federated identity credential that trusts the Amazon Web Services OpenID Connect (OIDC) issuer for your account.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration of a connector to Microsoft Azure.
" } }, "com.amazonaws.observabilityadmin#AzureConnectorQuery": { "type": "union", "members": { "ManagementGroups": { "target": "com.amazonaws.observabilityadmin#AzureManagementGroupsQuery", "traits": { "smithy.api#documentation": "Lists Azure management groups.
" } }, "Subscriptions": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionsQuery", "traits": { "smithy.api#documentation": "Lists Azure subscriptions.
" } }, "ResourceTypes": { "target": "com.amazonaws.observabilityadmin#AzureResourceTypesQuery", "traits": { "smithy.api#documentation": "Lists the Azure resource types that have resources in scope.
" } }, "Regions": { "target": "com.amazonaws.observabilityadmin#AzureRegionsQuery", "traits": { "smithy.api#documentation": "Lists the Azure Regions that have resources in scope.
" } }, "ResourceIds": { "target": "com.amazonaws.observabilityadmin#AzureResourceIdsQuery", "traits": { "smithy.api#documentation": "Lists Azure resources.
" } }, "EventHubs": { "target": "com.amazonaws.observabilityadmin#AzureEventHubsQuery", "traits": { "smithy.api#documentation": "Lists Azure Event Hubs.
" } } }, "traits": { "smithy.api#documentation": "The type of Azure resource to list. Specify one type.
" } }, "com.amazonaws.observabilityadmin#AzureConnectorQueryResults": { "type": "union", "members": { "ManagementGroups": { "target": "com.amazonaws.observabilityadmin#AzureManagementGroupSummaries", "traits": { "smithy.api#documentation": "The Azure management groups.
" } }, "Subscriptions": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionSummaries", "traits": { "smithy.api#documentation": "The Azure subscriptions.
" } }, "ResourceTypes": { "target": "com.amazonaws.observabilityadmin#AzureResourceTypeList", "traits": { "smithy.api#documentation": "The Azure resource types.
" } }, "Regions": { "target": "com.amazonaws.observabilityadmin#AzureRegionList", "traits": { "smithy.api#documentation": "The Azure Regions.
" } }, "ResourceIds": { "target": "com.amazonaws.observabilityadmin#AzureResourceIdentifierSummaries", "traits": { "smithy.api#documentation": "The Azure resources.
" } }, "EventHubs": { "target": "com.amazonaws.observabilityadmin#AzureEventHubSummaries", "traits": { "smithy.api#documentation": "The Azure Event Hubs.
" } } }, "traits": { "smithy.api#documentation": "The results of an Azure discovery query. The populated member matches the member of the query.
" } }, "com.amazonaws.observabilityadmin#AzureCustomerManagedFlowLogs": { "type": "structure", "members": { "StorageAccounts": { "target": "com.amazonaws.observabilityadmin#AzureFlowLogStorageAccountScopeList", "traits": { "smithy.api#documentation": "The Storage Accounts that store your Flow Logs, listed by Azure Region. Each Region can appear only once, and each Storage Account can appear only once across all Regions.
", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for existing Azure Storage Accounts that already receive your Flow Logs.
" } }, "com.amazonaws.observabilityadmin#AzureEventHubConfiguration": { "type": "structure", "members": { "Tier": { "target": "com.amazonaws.observabilityadmin#AzureEventHubTier", "traits": { "smithy.api#documentation": "The Event Hubs namespace tier.
", "smithy.api#required": {} } }, "PartitionCount": { "target": "com.amazonaws.observabilityadmin#AzureEventHubPartitionCount", "traits": { "smithy.api#documentation": "The number of partitions in each Event Hub. The Standard tier allows 1\u201332 partitions and the Premium tier allows 1\u2013100. On the Standard tier, you can't change this value after the setup creates the Event Hub.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration of the Azure Event Hubs that the setup creates to deliver resource logs.
" } }, "com.amazonaws.observabilityadmin#AzureEventHubConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureEventHubConfiguration" } }, "com.amazonaws.observabilityadmin#AzureEventHubNamespaceName": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 50 }, "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9-]{4,48}[A-Za-z0-9]$" } }, "com.amazonaws.observabilityadmin#AzureEventHubPartitionCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#AzureEventHubSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureEventHubSummary" } }, "com.amazonaws.observabilityadmin#AzureEventHubSummary": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.observabilityadmin#AzureResourceId", "traits": { "smithy.api#documentation": "The Azure Resource Manager ID of the Event Hub.
", "smithy.api#required": {} } }, "EventHubName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the Event Hub.
", "smithy.api#required": {} } }, "NamespaceName": { "target": "com.amazonaws.observabilityadmin#AzureEventHubNamespaceName", "traits": { "smithy.api#documentation": "The name of the Event Hubs namespace that contains the Event Hub.
", "smithy.api#required": {} } }, "FullyQualifiedNamespace": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The fully qualified host name of the Event Hubs namespace, for example <namespace>.servicebus.windows.net. The suffix differs in sovereign clouds.
The Azure Region of the Event Hub, for example eastus.
The Azure subscription that contains the Event Hub.
" } } }, "traits": { "smithy.api#documentation": "Information about an Azure Event Hub.
" } }, "com.amazonaws.observabilityadmin#AzureEventHubTier": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Standard" } }, "PREMIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Premium" } } } }, "com.amazonaws.observabilityadmin#AzureEventHubsQuery": { "type": "structure", "members": { "Scope": { "target": "com.amazonaws.observabilityadmin#AzureQueryScope", "traits": { "smithy.api#documentation": "Limits the query to a management group or to specific subscriptions.
" } }, "NamespaceName": { "target": "com.amazonaws.observabilityadmin#AzureEventHubNamespaceName", "traits": { "smithy.api#documentation": "Limits the results to Event Hubs in this namespace.
" } }, "Region": { "target": "com.amazonaws.observabilityadmin#AzureRegion", "traits": { "smithy.api#documentation": "Limits the results to one Azure Region, for example eastus.
A query that lists Azure Event Hubs.
" } }, "com.amazonaws.observabilityadmin#AzureFlowLogRetentionDays": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 365 } } }, "com.amazonaws.observabilityadmin#AzureFlowLogStorageAccountScope": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.observabilityadmin#AzureRegion", "traits": { "smithy.api#documentation": "The Azure Region of the Storage Accounts, for example eastus.
The Azure Resource Manager IDs of the Storage Accounts.
", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Azure Storage Accounts in one Azure Region that store Flow Logs.
" } }, "com.amazonaws.observabilityadmin#AzureFlowLogStorageAccountScopeList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureFlowLogStorageAccountScope" } }, "com.amazonaws.observabilityadmin#AzureFlowLogsInfrastructure": { "type": "union", "members": { "CustomerManaged": { "target": "com.amazonaws.observabilityadmin#AzureCustomerManagedFlowLogs", "traits": { "smithy.api#documentation": "Use your existing Storage Accounts that already store Flow Logs.
" } }, "AwsManaged": { "target": "com.amazonaws.observabilityadmin#AzureAwsManagedFlowLogs", "traits": { "smithy.api#documentation": "Create one Storage Account in each Azure Region that ingests Flow Logs, in the subscription specified by SubscriptionId.
The location of your Flow Logs: your existing Storage Accounts, or Storage Accounts that the setup creates. Specify one.
" } }, "com.amazonaws.observabilityadmin#AzureInfrastructure": { "type": "structure", "members": { "SubscriptionId": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionId", "traits": { "smithy.api#documentation": "The Azure subscription in which the setup creates the Event Hubs namespaces and, for AwsManaged Flow Logs, the Storage Accounts. You must specify this value if an AzureScopeItem collects ResourceLogs, or if you specify EventHubs or AwsManaged Flow Logs.
The Event Hubs configuration. Specify exactly one entry, which applies to the Event Hubs in every Azure Region. This value applies only if an AzureScopeItem collects ResourceLogs. If you omit it, the setup uses default settings.
The location of your Flow Logs. You must specify this value if an AzureScopeItem collects FlowLogs, and you can specify it only in that case.
The choices for the Azure infrastructure that the setup creates.
" } }, "com.amazonaws.observabilityadmin#AzureManagementGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 90 }, "smithy.api#pattern": "^[-\\w._()]+$" } }, "com.amazonaws.observabilityadmin#AzureManagementGroupSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureManagementGroupSummary" } }, "com.amazonaws.observabilityadmin#AzureManagementGroupSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.observabilityadmin#AzureManagementGroupId", "traits": { "smithy.api#documentation": "The ID of the management group.
", "smithy.api#required": {} } }, "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the management group.
" } }, "DisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display name of the management group.
" } } }, "traits": { "smithy.api#documentation": "Information about an Azure management group.
" } }, "com.amazonaws.observabilityadmin#AzureManagementGroupsQuery": { "type": "structure", "members": { "ParentManagementGroupId": { "target": "com.amazonaws.observabilityadmin#AzureManagementGroupId", "traits": { "smithy.api#documentation": "Lists the management groups under this management group. If you omit this value, the query starts at the tenant root group.
" } } }, "traits": { "smithy.api#documentation": "A query that lists Azure management groups.
" } }, "com.amazonaws.observabilityadmin#AzureQueryScope": { "type": "structure", "members": { "ManagementGroupId": { "target": "com.amazonaws.observabilityadmin#AzureManagementGroupId", "traits": { "smithy.api#documentation": "Limits the query to resources under this management group.
" } }, "SubscriptionIds": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionIdList", "traits": { "smithy.api#documentation": "Limits the query to these subscriptions. You can specify 1\u20131000 subscriptions.
", "smithy.api#length": { "min": 1, "max": 1000 } } } }, "traits": { "smithy.api#documentation": "Limits a query to a management group or to specific subscriptions.
" } }, "com.amazonaws.observabilityadmin#AzureRegion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$" } }, "com.amazonaws.observabilityadmin#AzureRegionList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureRegion" } }, "com.amazonaws.observabilityadmin#AzureRegionsQuery": { "type": "structure", "members": { "Scope": { "target": "com.amazonaws.observabilityadmin#AzureQueryScope", "traits": { "smithy.api#documentation": "Limits the query to a management group or to specific subscriptions.
" } } }, "traits": { "smithy.api#documentation": "A query that lists the Azure Regions that have resources in scope.
" } }, "com.amazonaws.observabilityadmin#AzureResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.observabilityadmin#AzureResourceIdList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#ManifestAzureResourceId" } }, "com.amazonaws.observabilityadmin#AzureResourceIdScope": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.observabilityadmin#AzureRegion", "traits": { "smithy.api#documentation": "The Azure Region of the resources, for example eastus. Required because an Azure resource ID doesn't include the Region.
The Azure Resource Manager IDs of the resources.
", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Azure resources in one Azure Region.
" } }, "com.amazonaws.observabilityadmin#AzureResourceIdScopeList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureResourceIdScope" } }, "com.amazonaws.observabilityadmin#AzureResourceIdentifierSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureResourceIdentifierSummary" } }, "com.amazonaws.observabilityadmin#AzureResourceIdentifierSummary": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.observabilityadmin#AzureResourceId", "traits": { "smithy.api#documentation": "The Azure Resource Manager ID of the resource.
", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.observabilityadmin#AzureResourceType", "traits": { "smithy.api#documentation": "The Azure resource type, for example Microsoft.Compute/virtualMachines.
The Azure Region of the resource, for example eastus.
The Azure subscription that contains the resource.
" } }, "Tags": { "target": "com.amazonaws.observabilityadmin#AzureResourceTags", "traits": { "smithy.api#documentation": "The tags on the resource. Absent if the resource has no tags.
" } } }, "traits": { "smithy.api#documentation": "Information about an Azure resource.
" } }, "com.amazonaws.observabilityadmin#AzureResourceIdsQuery": { "type": "structure", "members": { "Scope": { "target": "com.amazonaws.observabilityadmin#AzureQueryScope", "traits": { "smithy.api#documentation": "Limits the query to a management group or to specific subscriptions.
" } }, "ResourceType": { "target": "com.amazonaws.observabilityadmin#AzureResourceType", "traits": { "smithy.api#documentation": "Limits the results to one Azure resource type, for example Microsoft.Compute/virtualMachines.
Limits the results to one Azure Region, for example eastus.
Limits the results to resources that have these tags. A resource must match the filters for all tag keys, and any of the values for each key. The service matches tag keys and values case-insensitively, as Azure does.
", "smithy.api#length": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#documentation": "A query that lists Azure resources.
" } }, "com.amazonaws.observabilityadmin#AzureResourceTagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.observabilityadmin#AzureResourceTagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.observabilityadmin#AzureResourceTags": { "type": "map", "key": { "target": "com.amazonaws.observabilityadmin#AzureResourceTagKey" }, "value": { "target": "com.amazonaws.observabilityadmin#AzureResourceTagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.observabilityadmin#AzureResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9]+\\.[A-Za-z0-9]+/[A-Za-z0-9/]+$" } }, "com.amazonaws.observabilityadmin#AzureResourceTypeList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureResourceType" } }, "com.amazonaws.observabilityadmin#AzureResourceTypesQuery": { "type": "structure", "members": { "Scope": { "target": "com.amazonaws.observabilityadmin#AzureQueryScope", "traits": { "smithy.api#documentation": "Limits the query to a management group or to specific subscriptions.
" } } }, "traits": { "smithy.api#documentation": "A query that lists the Azure resource types that have resources in scope.
" } }, "com.amazonaws.observabilityadmin#AzureScope": { "type": "structure", "members": { "Subscriptions": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionScope", "traits": { "smithy.api#documentation": "The subscriptions to find resources in: all subscriptions that the connector can read, or a list of subscriptions. Required when you use Regions and ResourceTypes.
The Azure Regions to find resources in. Required when you use Subscriptions and ResourceTypes.
The Azure resource types to find. Required when you use Subscriptions and Regions.
Limits the resources found by Subscriptions, Regions, and ResourceTypes to those that have these tags. You can specify up to 50 filters.
Specific Azure resources, listed by Azure Region.
", "smithy.api#length": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#documentation": "The Azure resources to collect telemetry from. These are the resources found by Subscriptions, Regions, and ResourceTypes, optionally narrowed by TagFilters, plus any resources listed in Resources. You can specify:
Subscriptions, Regions, and ResourceTypes together
Resources
Both
The telemetry types to collect.
", "smithy.api#length": { "min": 1, "max": 3 }, "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.observabilityadmin#AzureScope", "traits": { "smithy.api#documentation": "The Azure resources to collect telemetry from.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The telemetry types to collect from a set of Azure resources.
" } }, "com.amazonaws.observabilityadmin#AzureSources": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureScopeItem" } }, "com.amazonaws.observabilityadmin#AzureStorageAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^/[sS][uU][bB][sS][cC][rR][iI][pP][tT][iI][oO][nN][sS]/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/[rR][eE][sS][oO][uU][rR][cC][eE][gG][rR][oO][uU][pP][sS]/[^/${}'\"`\\\\<>%&?#\\s\\u0000-\\u001F\\u007F]+/[pP][rR][oO][vV][iI][dD][eE][rR][sS]/[mM][iI][cC][rR][oO][sS][oO][fF][tT]\\.[sS][tT][oO][rR][aA][gG][eE]/[sS][tT][oO][rR][aA][gG][eE][aA][cC][cC][oO][uU][nN][tT][sS]/[a-z0-9]{3,24}$" } }, "com.amazonaws.observabilityadmin#AzureStorageAccountIdList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureStorageAccountId" } }, "com.amazonaws.observabilityadmin#AzureSubscriptionId": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, "com.amazonaws.observabilityadmin#AzureSubscriptionIdList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionId" } }, "com.amazonaws.observabilityadmin#AzureSubscriptionScope": { "type": "union", "members": { "All": { "target": "com.amazonaws.observabilityadmin#AllSubscriptions", "traits": { "smithy.api#documentation": "All subscriptions that Azure role-based access control (Azure RBAC) allows the connector to read. Subscriptions that the connector can read later are included automatically.
" } }, "Ids": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionIdList", "traits": { "smithy.api#documentation": "A list of 1\u20131000 subscription IDs.
", "smithy.api#length": { "min": 1, "max": 1000 } } } }, "traits": { "smithy.api#documentation": "The subscriptions to find resources in: all subscriptions that the connector can read, or a list of subscriptions. Specify one.
" } }, "com.amazonaws.observabilityadmin#AzureSubscriptionSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionSummary" } }, "com.amazonaws.observabilityadmin#AzureSubscriptionSummary": { "type": "structure", "members": { "SubscriptionId": { "target": "com.amazonaws.observabilityadmin#AzureSubscriptionId", "traits": { "smithy.api#documentation": "The ID of the subscription.
", "smithy.api#required": {} } }, "DisplayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display name of the subscription.
" } }, "State": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The state of the subscription in Azure, for example Enabled.
The ID of the management group that contains the subscription.
" } } }, "traits": { "smithy.api#documentation": "Information about an Azure subscription.
" } }, "com.amazonaws.observabilityadmin#AzureSubscriptionsQuery": { "type": "structure", "members": { "ManagementGroupId": { "target": "com.amazonaws.observabilityadmin#AzureManagementGroupId", "traits": { "smithy.api#documentation": "Limits the results to subscriptions under this management group.
" } } }, "traits": { "smithy.api#documentation": "A query that lists Azure subscriptions.
" } }, "com.amazonaws.observabilityadmin#AzureTelemetrySourceConfigurationInput": { "type": "structure", "members": { "AwsConfigConnectorArn": { "target": "com.amazonaws.observabilityadmin#AwsConfigConnectorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Config connector for the Microsoft Azure tenant to collect resource metadata from.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The Microsoft Azure source configuration for a third-party telemetry enrichment.
" } }, "com.amazonaws.observabilityadmin#AzureTelemetrySourceConfigurationOutput": { "type": "structure", "members": { "AwsConfigConnectorArn": { "target": "com.amazonaws.observabilityadmin#AwsConfigConnectorArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Config connector that the enrichment uses.
" } }, "ServiceLinkedRecorderArn": { "target": "com.amazonaws.observabilityadmin#ServiceLinkedRecorderArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked configuration recorder that CloudWatch created in your account for the enrichment.
" } } }, "traits": { "smithy.api#documentation": "The Microsoft Azure source configuration of a third-party telemetry enrichment.
" } }, "com.amazonaws.observabilityadmin#AzureTelemetryType": { "type": "enum", "members": { "RESOURCE_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ResourceLogs" } }, "METRICS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Metrics" } }, "FLOW_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FlowLogs" } } } }, "com.amazonaws.observabilityadmin#AzureTelemetryTypeList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AzureTelemetryType" }, "traits": { "smithy.api#uniqueItems": {} } }, "com.amazonaws.observabilityadmin#AzureTenantIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" } }, "com.amazonaws.observabilityadmin#CentralizationFailureReason": { "type": "enum", "members": { "TRUSTED_ACCESS_NOT_ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRUSTED_ACCESS_NOT_ENABLED" } }, "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION" } }, "INTERNAL_SERVER_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_SERVER_ERROR" } } } }, "com.amazonaws.observabilityadmin#CentralizationRule": { "type": "structure", "members": { "Source": { "target": "com.amazonaws.observabilityadmin#CentralizationRuleSource", "traits": { "smithy.api#documentation": "Configuration determining the source of the telemetry data to be centralized.
", "smithy.api#required": {} } }, "Destination": { "target": "com.amazonaws.observabilityadmin#CentralizationRuleDestination", "traits": { "smithy.api#documentation": "Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Defines how telemetry data should be centralized across an Amazon Web Services Organization, including source and destination configurations.
" } }, "com.amazonaws.observabilityadmin#CentralizationRuleDestination": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "The primary destination region to which telemetry data should be centralized.
", "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.observabilityadmin#AccountIdentifier", "traits": { "smithy.api#documentation": "The destination account (within the organization) to which the telemetry data should be centralized.
" } }, "DestinationLogsConfiguration": { "target": "com.amazonaws.observabilityadmin#DestinationLogsConfiguration", "traits": { "smithy.api#documentation": "Log specific configuration for centralization destination log groups.
" } }, "DestinationMetricsConfiguration": { "target": "com.amazonaws.observabilityadmin#DestinationMetricsConfiguration", "traits": { "smithy.api#documentation": "Metric specific configuration for centralization destination metrics.
" } }, "DestinationProfilesConfiguration": { "target": "com.amazonaws.observabilityadmin#DestinationProfilesConfiguration", "traits": { "smithy.api#documentation": "Profile-specific configuration for centralization destination profiles.
" } } }, "traits": { "smithy.api#documentation": "Configuration specifying the primary destination for centralized telemetry data.
" } }, "com.amazonaws.observabilityadmin#CentralizationRuleSource": { "type": "structure", "members": { "Regions": { "target": "com.amazonaws.observabilityadmin#Regions", "traits": { "smithy.api#documentation": "The list of source regions from which telemetry data should be centralized.
", "smithy.api#required": {} } }, "Scope": { "target": "com.amazonaws.observabilityadmin#SourceFilterString", "traits": { "smithy.api#documentation": "The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
" } }, "SourceLogsConfiguration": { "target": "com.amazonaws.observabilityadmin#SourceLogsConfiguration", "traits": { "smithy.api#documentation": "Log specific configuration for centralization source log groups.
" } }, "SourceMetricsConfiguration": { "target": "com.amazonaws.observabilityadmin#SourceMetricsConfiguration", "traits": { "smithy.api#documentation": "Metric specific configuration for centralization source metrics.
" } }, "SourceProfilesConfiguration": { "target": "com.amazonaws.observabilityadmin#SourceProfilesConfiguration", "traits": { "smithy.api#documentation": "Profile-specific configuration for centralization source profiles.
" } }, "SourceContextGraphConfiguration": { "target": "com.amazonaws.observabilityadmin#SourceContextGraphConfiguration", "traits": { "smithy.api#documentation": "Configuration that enables centralization of the context graph for the selected sources. Including this configuration in a rule's source opts the rule into centralizing the context graph for the selected sources.
" } } }, "traits": { "smithy.api#documentation": "Configuration specifying the source of telemetry data to be centralized.
" } }, "com.amazonaws.observabilityadmin#CentralizationRuleSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#CentralizationRuleSummary" } }, "com.amazonaws.observabilityadmin#CentralizationRuleSummary": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "The name of the organization centralization rule.
" } }, "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the organization centralization rule.
" } }, "CreatorAccountId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Web Services Account that created the organization centralization rule.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the organization centralization rule was created.
" } }, "CreatedRegion": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "The Amazon Web Services region where the organization centralization rule was created.
" } }, "LastUpdateTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the organization centralization rule was last updated.
" } }, "RuleHealth": { "target": "com.amazonaws.observabilityadmin#RuleHealth", "traits": { "smithy.api#documentation": "The health status of the organization centralization rule.
" } }, "FailureReason": { "target": "com.amazonaws.observabilityadmin#CentralizationFailureReason", "traits": { "smithy.api#documentation": "The reason why an organization centralization rule is marked UNHEALTHY.
" } }, "TagPropagationStatus": { "target": "com.amazonaws.observabilityadmin#TagPropagationStatus", "traits": { "smithy.api#documentation": "The health status of tag propagation for this rule. This status is independent of the overall RuleHealth for log delivery. Returns Healthy when the most recent tag-propagation attempt succeeded, or Unhealthy when the most recent attempt failed.
The reason tag propagation is unhealthy for this rule. Only present when TagPropagationStatus is Unhealthy.
The status of context graph centralization for this rule. Returns Provisioning while the context graph is being set up, Healthy once it is active, or Unhealthy if provisioning failed. This status is independent of the overall RuleHealth for log delivery.
The primary destination account of the organization centralization rule.
" } }, "DestinationRegion": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "The primary destination region of the organization centralization rule.
" } } }, "traits": { "smithy.api#documentation": "A summary of a centralization rule's key properties and status.
" } }, "com.amazonaws.observabilityadmin#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[!-~]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.observabilityadmin#CloudtrailParameters": { "type": "structure", "members": { "AdvancedEventSelectors": { "target": "com.amazonaws.observabilityadmin#AdvancedEventSelectors", "traits": { "smithy.api#documentation": "The advanced event selectors to use for filtering Amazon Web Services CloudTrail events.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Parameters specific to Amazon Web Services CloudTrail telemetry configuration.
" } }, "com.amazonaws.observabilityadmin#Condition": { "type": "structure", "members": { "ActionCondition": { "target": "com.amazonaws.observabilityadmin#ActionCondition", "traits": { "smithy.api#documentation": "Matches log records based on the WAF rule action taken (ALLOW, BLOCK, COUNT, etc.).
" } }, "LabelNameCondition": { "target": "com.amazonaws.observabilityadmin#LabelNameCondition", "traits": { "smithy.api#documentation": "Matches log records based on WAF rule labels applied to the request.
" } } }, "traits": { "smithy.api#documentation": "A single condition that can match based on WAF rule action or label name.
" } }, "com.amazonaws.observabilityadmin#Conditions": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#Condition" }, "traits": { "smithy.api#documentation": "A list of conditions for filter matching, with at least one condition required.
", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.observabilityadmin#ConfigurationSummary": { "type": "structure", "members": { "Sources": { "target": "com.amazonaws.observabilityadmin#Sources", "traits": { "smithy.api#documentation": "The list of data sources configured in the pipeline.
" } }, "DataSources": { "target": "com.amazonaws.observabilityadmin#DataSources", "traits": { "smithy.api#documentation": "The list of data sources that provide telemetry data to the pipeline.
" } }, "Processors": { "target": "com.amazonaws.observabilityadmin#Processors", "traits": { "smithy.api#documentation": "The list of processors configured in the pipeline for data transformation.
" } }, "ProcessorCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total number of processors configured in the pipeline.
" } }, "Sinks": { "target": "com.amazonaws.observabilityadmin#Sinks", "traits": { "smithy.api#documentation": "The list of destinations where processed data is sent.
" } } }, "traits": { "smithy.api#documentation": "Provides a summary of pipeline configuration components including sources, processors, and destinations.
" } }, "com.amazonaws.observabilityadmin#ConflictException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the resource which is in conflict with the requested operation.
" } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource which is in conflict with the requested operation.
" } } }, "traits": { "smithy.api#documentation": "The requested operation conflicts with the current state of the specified resource or with another request.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.observabilityadmin#Connector": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the connector.
", "smithy.api#required": {} } }, "Provider": { "target": "com.amazonaws.observabilityadmin#ConnectorProvider", "traits": { "smithy.api#documentation": "The cloud provider that the connector connects to.
", "smithy.api#required": {} } }, "ConnectorConfiguration": { "target": "com.amazonaws.observabilityadmin#ConnectorConfiguration", "traits": { "smithy.api#documentation": "The configuration for connecting to the third-party cloud provider.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to obtain credentials for the third-party cloud provider.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.observabilityadmin#ConnectorName", "traits": { "smithy.api#documentation": "The name of the connector.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The time when the connector was created, in milliseconds since the Unix epoch.
" } } }, "traits": { "smithy.api#documentation": "A connector to a third-party cloud provider.
" } }, "com.amazonaws.observabilityadmin#ConnectorConfiguration": { "type": "union", "members": { "Azure": { "target": "com.amazonaws.observabilityadmin#AzureConnectorConfiguration", "traits": { "smithy.api#documentation": "The configuration of a connector to Microsoft Azure.
" } } }, "traits": { "smithy.api#documentation": "The configuration for connecting to a third-party cloud provider. Specify one provider.
" } }, "com.amazonaws.observabilityadmin#ConnectorIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^([a-z0-9]+|arn:aws[a-z0-9\\-]*:observabilityadmin:[a-z0-9-]+:[0-9]{12}:connector/(azure/)?[a-z0-9]+)$" } }, "com.amazonaws.observabilityadmin#ConnectorName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-_.]*$" } }, "com.amazonaws.observabilityadmin#ConnectorNextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 }, "smithy.api#pattern": "^[A-Za-z0-9+/=_-]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.observabilityadmin#ConnectorProvider": { "type": "enum", "members": { "AZURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AZURE" } } } }, "com.amazonaws.observabilityadmin#ConnectorQuery": { "type": "union", "members": { "Azure": { "target": "com.amazonaws.observabilityadmin#AzureConnectorQuery", "traits": { "smithy.api#documentation": "The type of Azure resource to list.
" } } }, "traits": { "smithy.api#documentation": "What to list in a cloud provider. Specify one provider.
" } }, "com.amazonaws.observabilityadmin#ConnectorQueryResults": { "type": "union", "members": { "Azure": { "target": "com.amazonaws.observabilityadmin#AzureConnectorQueryResults", "traits": { "smithy.api#documentation": "The results of an Azure discovery query.
" } } }, "traits": { "smithy.api#documentation": "The results of a query. The populated member matches the member of the query.
" } }, "com.amazonaws.observabilityadmin#ConnectorSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#ConnectorSummary" } }, "com.amazonaws.observabilityadmin#ConnectorSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the connector.
", "smithy.api#required": {} } }, "Provider": { "target": "com.amazonaws.observabilityadmin#ConnectorProvider", "traits": { "smithy.api#documentation": "The cloud provider that the connector connects to.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.observabilityadmin#ConnectorName", "traits": { "smithy.api#documentation": "The name of the connector.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The time when the connector was created, in milliseconds since the Unix epoch.
" } } }, "traits": { "smithy.api#documentation": "Summary information about a connector.
" } }, "com.amazonaws.observabilityadmin#ContextGraphStatus": { "type": "enum", "members": { "HEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Healthy" } }, "UNHEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unhealthy" } }, "PROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Provisioning" } } }, "traits": { "smithy.api#documentation": "The status of context graph centralization for a centralization rule. This status is independent of the overall RuleHealth for log delivery. Returns Provisioning while the context graph is being set up, Healthy once it is active, or Unhealthy if provisioning failed.
Creates a centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/CreateCentralizationRuleForOrganization" } } }, "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganizationInput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "A unique name for the organization-wide centralization rule being created.
", "smithy.api#required": {} } }, "Rule": { "target": "com.amazonaws.observabilityadmin#CentralizationRule", "traits": { "smithy.api#documentation": "The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganizationOutput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created organization centralization rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#CreateConnector": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#CreateConnectorInput" }, "output": { "target": "com.amazonaws.observabilityadmin#CreateConnectorOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a connector to a third-party cloud provider. With a connector, you can discover resources in the provider and collect their telemetry. Currently, Microsoft Azure is the only supported provider.
", "smithy.api#http": { "method": "POST", "uri": "/CreateConnector", "code": 201 } } }, "com.amazonaws.observabilityadmin#CreateConnectorInput": { "type": "structure", "members": { "ConnectorConfiguration": { "target": "com.amazonaws.observabilityadmin#ConnectorConfiguration", "traits": { "smithy.api#documentation": "The configuration for connecting to the third-party cloud provider.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#RoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that CloudWatch assumes to get credentials for the third-party cloud provider. The role must trust the Amazon CloudWatch Observability Admin service principal, observabilityadmin.amazonaws.com. The role must also allow sts:GetWebIdentityToken for the provider's token exchange audience.
The name of the connector. The name must be unique in the account and Region (case-sensitive). If another connector already uses the name, the request fails with a ConflictException.
The name can contain letters, digits, hyphens (-), underscores (_) and periods (.), and must start with a letter.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The tags that you want to apply to the connector.
" } }, "ClientToken": { "target": "com.amazonaws.observabilityadmin#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same parameters, the service returns the connector from the first request without an error. If you use the same token with different parameters, including different tags, the service returns a ValidationException. This operation is idempotent when you use the same token and parameters.
The connector that this request created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#CreateDatasetIntegration": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#CreateDatasetIntegrationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#CreateDatasetIntegrationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a dataset integration for the caller's account in the current region and returns its ARN.
To use this operation, you must have permission to access the dataset integration resources through the IAM role specified in the RoleArn parameter.
If a dataset integration already exists for the account, this operation fails with a ConflictException.
The Amazon Resource Name (ARN) of the IAM role that grants Amazon CloudWatch permission to access the resources needed for the dataset integration.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The key-value pairs to associate with the dataset integration resource for categorization and management purposes.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#CreateDatasetIntegrationOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created dataset integration.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the dataset integration.
", "smithy.api#required": {} } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was created.
", "smithy.api#required": {} } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was last updated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#CreateS3TableIntegration": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#CreateS3TableIntegrationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#CreateS3TableIntegrationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an integration between CloudWatch and S3 Tables for analytics. This integration enables querying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache Spark.
", "smithy.api#http": { "method": "POST", "uri": "/CreateS3TableIntegration" } } }, "com.amazonaws.observabilityadmin#CreateS3TableIntegrationInput": { "type": "structure", "members": { "Encryption": { "target": "com.amazonaws.observabilityadmin#Encryption", "traits": { "smithy.api#documentation": "The encryption configuration for the S3 Table integration, including the encryption algorithm and KMS key settings.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that grants permissions for the S3 Table integration to access necessary resources.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The key-value pairs to associate with the S3 Table integration resource for categorization and management purposes.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#CreateS3TableIntegrationOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created S3 Table integration.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#CreateTelemetryPipeline": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#CreateTelemetryPipelineInput" }, "output": { "target": "com.amazonaws.observabilityadmin#CreateTelemetryPipelineOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "requiredActions": [ "iam:PassRole", "logs:PutPipelineRule", "cloudwatch:PutPipelineRule", "observabilityadmin:TagResource", "observabilityadmin:ListTagsForResource", "observabilityadmin:GetTelemetryPipeline", "observabilityadmin:GetConnector", "observabilityadmin:GetConnectorTelemetryManifest" ] }, "smithy.api#documentation": "Creates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.
", "smithy.api#http": { "method": "POST", "uri": "/CreateTelemetryPipeline" } } }, "com.amazonaws.observabilityadmin#CreateTelemetryPipelineInput": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineName", "traits": { "smithy.api#documentation": "The name of the telemetry pipeline to create. The name must be unique within your account.
", "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineConfiguration", "traits": { "smithy.api#documentation": "The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations. For more information about pipeline components, see the Amazon CloudWatch User Guide
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#CreateTelemetryPipelineOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created telemetry pipeline.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#CreateTelemetryRule": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleInput" }, "output": { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.
", "smithy.api#http": { "method": "POST", "uri": "/CreateTelemetryRule" } } }, "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/CreateTelemetryRuleForOrganization" } } }, "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationInput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "A unique name for the organization-wide telemetry rule being created.
", "smithy.api#required": {} } }, "Rule": { "target": "com.amazonaws.observabilityadmin#TelemetryRule", "traits": { "smithy.api#documentation": "The configuration details for the organization-wide telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to across the organization.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganizationOutput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created organization telemetry rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#CreateTelemetryRuleInput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "A unique name for the telemetry rule being created.
", "smithy.api#required": {} } }, "Rule": { "target": "com.amazonaws.observabilityadmin#TelemetryRule", "traits": { "smithy.api#documentation": "The configuration details for the telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The key-value pairs to associate with the telemetry rule resource for categorization and management purposes.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#CreateTelemetryRuleOutput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created telemetry rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#DataSource": { "type": "structure", "members": { "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the data source. For CloudWatch Logs sources, this corresponds to the data_source_name from the log event metadata. For third-party sources, this is either the configured data_source_name or defaults to the plugin name if not specified.
The type of the data source. For CloudWatch Logs sources, this corresponds to the data_source_type from the log event metadata. For third-party sources, this field is empty.
Information about a data source associated with the telemetry pipeline. For CloudWatch Logs sources, this includes both a name and type extracted from the log event metadata. For third-party sources (such as S3), this includes only a name, with the type field left empty.
" } }, "com.amazonaws.observabilityadmin#DataSourceFilterString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.observabilityadmin#DataSources": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#DataSource" } }, "com.amazonaws.observabilityadmin#DatasetIntegrationSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#DatasetIntegrationSummary" } }, "com.amazonaws.observabilityadmin#DatasetIntegrationSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset integration.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the dataset integration.
" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was created.
" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was last updated.
" } } }, "traits": { "smithy.api#documentation": "Contains summary information about a dataset integration, including its ARN, associated IAM role, and creation and update timestamps, as returned by ListDatasetIntegrations.
Deletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteCentralizationRuleForOrganization" } } }, "com.amazonaws.observabilityadmin#DeleteCentralizationRuleForOrganizationInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the organization centralization rule to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#DeleteConnector": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#DeleteConnectorInput" }, "output": { "target": "com.amazonaws.observabilityadmin#DeleteConnectorOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#InvalidStateException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a connector and its telemetry manifest.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteConnector" } } }, "com.amazonaws.observabilityadmin#DeleteConnectorInput": { "type": "structure", "members": { "ConnectorIdentifier": { "target": "com.amazonaws.observabilityadmin#ConnectorIdentifier", "traits": { "smithy.api#documentation": "The connector to delete. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
Deletes a dataset integration for the caller's account in the current region. This operation is idempotent; if you submit the same delete more than once, each call succeeds.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteDatasetIntegration", "code": 204 }, "smithy.api#idempotent": {} } }, "com.amazonaws.observabilityadmin#DeleteDatasetIntegrationInput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset integration to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#DeleteS3TableIntegration": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#DeleteS3TableIntegrationInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#InvalidStateException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an S3 Table integration and its associated data. This operation removes the connection between CloudWatch Observability Admin and S3 Tables.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteS3TableIntegration", "code": 204 } } }, "com.amazonaws.observabilityadmin#DeleteS3TableIntegrationInput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Table integration to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#DeleteTelemetryPipeline": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryPipelineInput" }, "output": { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryPipelineOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "requiredActions": [ "logs:DeletePipelineRule", "cloudwatch:DeletePipelineRule", "observabilityadmin:GetTelemetryPipeline" ] }, "smithy.api#documentation": "Deletes a telemetry pipeline and its associated resources. This operation stops data processing and removes the pipeline configuration.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteTelemetryPipeline" }, "smithy.api#idempotent": {} } }, "com.amazonaws.observabilityadmin#DeleteTelemetryPipelineInput": { "type": "structure", "members": { "PipelineIdentifier": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineIdentifier", "traits": { "smithy.api#documentation": "The ARN of the telemetry pipeline to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#DeleteTelemetryPipelineOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#DeleteTelemetryRule": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRuleInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by this rule.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteTelemetryRule" } } }, "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganizationInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/DeleteTelemetryRuleForOrganization" } } }, "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganizationInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the organization telemetry rule to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#DeleteTelemetryRuleInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the telemetry rule to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#DeletionProtection": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } } }, "traits": { "smithy.api#documentation": "Specifies the deletion protection setting that a rule applies to the log groups that it creates. If you don't specify a value, the rule doesn't enable deletion protection. The following value is supported:
ENABLED \u2013 The rule enables deletion protection on log groups that it creates.
The encryption configuration for centralization destination log groups.
" } }, "BackupConfiguration": { "target": "com.amazonaws.observabilityadmin#LogsBackupConfiguration", "traits": { "smithy.api#documentation": "Configuration defining the backup region and an optional KMS key for the backup destination.
" } }, "LogGroupNameConfiguration": { "target": "com.amazonaws.observabilityadmin#LogGroupNameConfiguration", "traits": { "smithy.api#documentation": "Configuration that specifies a naming pattern for destination log groups created during centralization. The pattern supports static text and dynamic variables that are replaced with source attributes when log groups are created.
" } }, "TagPropagationConfiguration": { "target": "com.amazonaws.observabilityadmin#TagPropagationConfiguration", "traits": { "smithy.api#documentation": "Specifies the tag propagation configuration for this centralization rule. When present, LogGroupNameConfiguration must use a LogGroupNamePattern that contains ${source.logGroup}, ${source.accountId}, and ${source.region}.
Specifies whether this centralization rule enables deletion protection on the destination log groups that it creates. If you don't specify this setting, the rule doesn't enable deletion protection on the log groups that it creates. If you specify a backup Region in BackupConfiguration, the setting also applies to the log groups that the rule creates in the backup Region.
When you set this to ENABLED, the rule enables deletion protection only on log groups that it creates after you enable the setting. It does not add deletion protection to log groups the rule created before you enabled the setting.
If you remove this setting from the rule or delete the rule, deletion protection stays enabled on log groups that already have it. To delete one of these log groups, first disable deletion protection on the log group in the destination account.
" } } }, "traits": { "smithy.api#documentation": "Configuration for centralization destination log groups, including encryption and backup settings.
" } }, "com.amazonaws.observabilityadmin#DestinationMetricsConfiguration": { "type": "structure", "members": { "BackupConfiguration": { "target": "com.amazonaws.observabilityadmin#MetricsBackupConfiguration", "traits": { "smithy.api#documentation": "Configuration defining the backup region for the metrics backup destination.
" } } }, "traits": { "smithy.api#documentation": "Configuration for centralization destination metrics, including backup settings.
" } }, "com.amazonaws.observabilityadmin#DestinationProfilesConfiguration": { "type": "structure", "members": { "BackupConfiguration": { "target": "com.amazonaws.observabilityadmin#ProfilesBackupConfiguration", "traits": { "smithy.api#documentation": "Configuration that defines the backup Region for the profiles backup destination.
" } } }, "traits": { "smithy.api#documentation": "Configuration for centralization destination profiles, including backup settings.
" } }, "com.amazonaws.observabilityadmin#DestinationType": { "type": "enum", "members": { "CLOUDWATCH_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "cloud-watch-logs" } } } }, "com.amazonaws.observabilityadmin#ELBLoadBalancerLoggingParameters": { "type": "structure", "members": { "OutputFormat": { "target": "com.amazonaws.observabilityadmin#OutputFormat", "traits": { "smithy.api#documentation": "The format for ELB access log entries (plain text or JSON format).
" } }, "FieldDelimiter": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The delimiter character used to separate fields in ELB access log entries when using plain text format.
" } } }, "traits": { "smithy.api#documentation": "Configuration parameters for ELB load balancer logging, including output format and field delimiter settings.
" } }, "com.amazonaws.observabilityadmin#EncryptedLogGroupStrategy": { "type": "enum", "members": { "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW" } }, "SKIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIP" } } } }, "com.amazonaws.observabilityadmin#Encryption": { "type": "structure", "members": { "SseAlgorithm": { "target": "com.amazonaws.observabilityadmin#SSEAlgorithm", "traits": { "smithy.api#documentation": "The server-side encryption algorithm used for encrypting data in the S3 Table integration.
", "smithy.api#required": {} } }, "KmsKeyArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key used for encryption when using customer-managed keys.
" } } }, "traits": { "smithy.api#documentation": "Defines the encryption configuration for S3 Table integrations, including the encryption algorithm and KMS key settings.
" } }, "com.amazonaws.observabilityadmin#EncryptionConflictResolutionStrategy": { "type": "enum", "members": { "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW" } }, "SKIP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SKIP" } } } }, "com.amazonaws.observabilityadmin#EncryptionScope": { "type": "enum", "members": { "ENCRYPTED_SOURCE_ONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Only destination log groups whose source log group is encrypted with a customer managed KMS key use the configured KmsKeyArn. This is the default behavior.
Every new destination log group created by this rule uses the configured KmsKeyArn, regardless of whether the source log group is encrypted with a customer managed key or Amazon Web Services owned encryption.
Determines which newly created destination log groups are encrypted with the configured KMS key.
" } }, "com.amazonaws.observabilityadmin#EncryptionStrategy": { "type": "enum", "members": { "CUSTOMER_MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER_MANAGED" } }, "AWS_OWNED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_OWNED" } } } }, "com.amazonaws.observabilityadmin#FailureReason": { "type": "string" }, "com.amazonaws.observabilityadmin#FieldMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.observabilityadmin#FieldSelectors": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#AdvancedFieldSelector" } }, "com.amazonaws.observabilityadmin#FieldToMatch": { "type": "structure", "members": { "SingleHeader": { "target": "com.amazonaws.observabilityadmin#SingleHeader", "traits": { "smithy.api#documentation": "Redacts a specific header field by name from WAF logs.
" } }, "UriPath": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Redacts the URI path from WAF logs.
" } }, "QueryString": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Redacts the entire query string from WAF logs.
" } }, "Method": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Redacts the HTTP method from WAF logs.
" } } }, "traits": { "smithy.api#documentation": "Specifies a field in the request to redact from WAF logs, such as headers, query parameters, or body content.
" } }, "com.amazonaws.observabilityadmin#Filter": { "type": "structure", "members": { "Behavior": { "target": "com.amazonaws.observabilityadmin#FilterBehavior", "traits": { "smithy.api#documentation": "The action to take for log records matching this filter (KEEP or DROP).
" } }, "Requirement": { "target": "com.amazonaws.observabilityadmin#FilterRequirement", "traits": { "smithy.api#documentation": "Whether the log record must meet all conditions (MEETS_ALL) or any condition (MEETS_ANY) to match this filter.
" } }, "Conditions": { "target": "com.amazonaws.observabilityadmin#Conditions", "traits": { "smithy.api#documentation": "The list of conditions that determine if a log record matches this filter.
" } } }, "traits": { "smithy.api#documentation": "A single filter condition that specifies behavior, requirement, and matching conditions for WAF log records.
" } }, "com.amazonaws.observabilityadmin#FilterBehavior": { "type": "enum", "members": { "KEEP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KEEP" } }, "DROP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DROP" } } }, "traits": { "smithy.api#documentation": "Enumeration of filter actions: KEEP to include log records, DROP to exclude them.
" } }, "com.amazonaws.observabilityadmin#FilterRequirement": { "type": "enum", "members": { "MEETS_ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEETS_ALL" } }, "MEETS_ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEETS_ANY" } } }, "traits": { "smithy.api#documentation": "Enumeration of condition matching requirements: MEETS_ALL requires all conditions to match, MEETS_ANY requires at least one.
" } }, "com.amazonaws.observabilityadmin#Filters": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#Filter" }, "traits": { "smithy.api#documentation": "A list of filter conditions, with at least one filter required.
", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/GetCentralizationRuleForOrganization" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the organization centralization rule to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganizationOutput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "The name of the organization centralization rule.
" } }, "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the organization centralization rule.
" } }, "CreatorAccountId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Web Services Account that created the organization centralization rule.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the organization centralization rule was created.
" } }, "CreatedRegion": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "The Amazon Web Services region where the organization centralization rule was created.
" } }, "LastUpdateTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the organization centralization rule was last updated.
" } }, "RuleHealth": { "target": "com.amazonaws.observabilityadmin#RuleHealth", "traits": { "smithy.api#documentation": "The health status of the organization centralization rule.
" } }, "FailureReason": { "target": "com.amazonaws.observabilityadmin#CentralizationFailureReason", "traits": { "smithy.api#documentation": "The reason why an organization centralization rule is marked UNHEALTHY.
" } }, "TagPropagationStatus": { "target": "com.amazonaws.observabilityadmin#TagPropagationStatus", "traits": { "smithy.api#documentation": "The health status of tag propagation for this rule. This status is independent of the overall RuleHealth for log delivery. Returns Healthy when the most recent tag-propagation attempt succeeded, or Unhealthy when the most recent attempt failed.
The reason tag propagation is unhealthy for this rule. Only present when TagPropagationStatus is Unhealthy.
The status of context graph centralization for this rule. Returns Provisioning while the context graph is being set up, Healthy once it is active, or Unhealthy if provisioning failed. This status is independent of the overall RuleHealth for log delivery.
The configuration details for the organization centralization rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetConnector": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetConnectorInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetConnectorOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of a connector.
", "smithy.api#http": { "method": "POST", "uri": "/GetConnector" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetConnectorInput": { "type": "structure", "members": { "ConnectorIdentifier": { "target": "com.amazonaws.observabilityadmin#ConnectorIdentifier", "traits": { "smithy.api#documentation": "The connector. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
The connector.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetConnectorTelemetryManifest": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetConnectorTelemetryManifestInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetConnectorTelemetryManifestOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the telemetry manifest of a connector and its current version. If the connector has no telemetry manifest, this operation returns a ResourceNotFoundException.
The connector. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
The telemetry manifest.
", "smithy.api#required": {} } }, "Version": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The current version of the telemetry manifest. Pass this value as ExpectedVersion when you next call PutConnectorTelemetryManifest.
The time when the telemetry manifest was last updated, in milliseconds since the Unix epoch.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetConnectorTelemetrySetup": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetConnectorTelemetrySetupInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetConnectorTelemetrySetupOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Generates the artifacts that you use to create the infrastructure in your cloud provider that delivers the telemetry declared in the connector's telemetry manifest. This operation doesn't change any resources in your cloud provider or in Amazon Web Services.
", "smithy.api#http": { "method": "POST", "uri": "/GetConnectorTelemetrySetup" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetConnectorTelemetrySetupInput": { "type": "structure", "members": { "ConnectorIdentifier": { "target": "com.amazonaws.observabilityadmin#ConnectorIdentifier", "traits": { "smithy.api#documentation": "The connector whose telemetry manifest you want to generate the setup from. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
The format of the setup artifacts. If you omit this value, the service uses the default format for the connector's provider (BICEP for an Azure connector). If the provider doesn't support the format, the service returns a ValidationException.
The setup artifacts to apply in your cloud provider.
", "smithy.api#required": {} } }, "RequiredPermissionsToApply": { "target": "com.amazonaws.observabilityadmin#PermissionList", "traits": { "smithy.api#documentation": "The permissions or roles in your cloud provider that you need to apply the artifacts, for example Azure Contributor and User Access Administrator.
" } }, "Format": { "target": "com.amazonaws.observabilityadmin#SetupFormat", "traits": { "smithy.api#documentation": "The format of the setup artifacts.
", "smithy.api#required": {} } }, "Provider": { "target": "com.amazonaws.observabilityadmin#ConnectorProvider", "traits": { "smithy.api#documentation": "The cloud provider that the setup artifacts are for.
" } }, "ManifestVersion": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The version of the telemetry manifest that the service generated the setup artifacts from.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetDatasetIntegration": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetDatasetIntegrationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetDatasetIntegrationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the dataset integration for the caller's account in the current region.
", "smithy.api#http": { "method": "POST", "uri": "/GetDatasetIntegration" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetDatasetIntegrationInput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset integration to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#GetDatasetIntegrationOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset integration.
" } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the dataset integration.
" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was created.
" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was last updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetS3TableIntegration": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetS3TableIntegrationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetS3TableIntegrationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.
", "smithy.api#http": { "method": "POST", "uri": "/GetS3TableIntegration" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetS3TableIntegrationInput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Table integration to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#GetS3TableIntegrationOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Table integration.
" } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used by the S3 Table integration.
" } }, "Status": { "target": "com.amazonaws.observabilityadmin#IntegrationStatus", "traits": { "smithy.api#documentation": "The current status of the S3 Table integration.
" } }, "Encryption": { "target": "com.amazonaws.observabilityadmin#Encryption", "traits": { "smithy.api#documentation": "The encryption configuration for the S3 Table integration.
" } }, "DestinationTableBucketArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket used as the destination for the table data.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the S3 Table integration was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryEnrichmentStatus": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.observabilityadmin#GetTelemetryEnrichmentStatusOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Resource Explorer.
", "smithy.api#http": { "method": "POST", "uri": "/GetTelemetryEnrichmentStatus" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryEnrichmentStatusOutput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.observabilityadmin#TelemetryEnrichmentStatus", "traits": { "smithy.api#documentation": " The current status of the resource tags for telemetry feature (Running, Stopped, or Impaired).
The Amazon Resource Name (ARN) of the Resource Explorer managed view used for resource tags for telemetry, if the feature is enabled.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatus": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.
", "smithy.api#http": { "method": "POST", "uri": "/GetTelemetryEvaluationStatus" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetTelemetryEvaluationStatus", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-2" } } ] } }, "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.
", "smithy.api#http": { "method": "POST", "uri": "/GetTelemetryEvaluationStatusForOrganization" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetTelemetryEvaluationStatusForOrganization", "params": {}, "expect": { "failure": { "errorId": "com.amazonaws.observabilityadmin#AccessDeniedException" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-2" } } ] } }, "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusForOrganizationOutput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.observabilityadmin#Status", "traits": { "smithy.api#documentation": "The onboarding status of the telemetry config feature for the organization.
" } }, "FailureReason": { "target": "com.amazonaws.observabilityadmin#FailureReason", "traits": { "smithy.api#documentation": " This field describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.
The Amazon Web Services Region that is designated as the home region for multi-region telemetry evaluation for the organization. The home region is the single management point for all multi-region operations on this organization. This field is only present when multi-region telemetry evaluation is active.
" } }, "RegionStatuses": { "target": "com.amazonaws.observabilityadmin#RegionStatuses", "traits": { "smithy.api#documentation": "A list of per-region telemetry evaluation statuses for the organization. Each entry indicates the evaluation status for a specific spoke region included in the multi-region configuration. This field is only present when multi-region telemetry evaluation is active.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusOutput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.observabilityadmin#Status", "traits": { "smithy.api#documentation": "The onboarding status of the telemetry config feature.
" } }, "FailureReason": { "target": "com.amazonaws.observabilityadmin#FailureReason", "traits": { "smithy.api#documentation": " Describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.
The Amazon Web Services Region that is designated as the home region for multi-region telemetry evaluation. The home region is the single management point for all multi-region operations on this account. This field is only present when multi-region telemetry evaluation is active.
" } }, "RegionStatuses": { "target": "com.amazonaws.observabilityadmin#RegionStatuses", "traits": { "smithy.api#documentation": "A list of per-region telemetry evaluation statuses. Each entry indicates the evaluation status for a specific spoke region included in the multi-region configuration. This field is only present when multi-region telemetry evaluation is active.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryPipeline": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetTelemetryPipelineInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetTelemetryPipelineOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "requiredActions": [ "observabilityadmin:ListTagsForResource" ] }, "smithy.api#documentation": "Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.
", "smithy.api#http": { "method": "POST", "uri": "/GetTelemetryPipeline" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryPipelineInput": { "type": "structure", "members": { "PipelineIdentifier": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the telemetry pipeline to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryPipelineOutput": { "type": "structure", "members": { "Pipeline": { "target": "com.amazonaws.observabilityadmin#TelemetryPipeline", "traits": { "smithy.api#documentation": "The complete telemetry pipeline resource information, including configuration, status, and metadata.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryRule": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of a specific telemetry rule in your account.
", "smithy.api#http": { "method": "POST", "uri": "/GetTelemetryRule" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/GetTelemetryRuleForOrganization" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the organization telemetry rule to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganizationOutput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "The name of the organization telemetry rule.
" } }, "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the organization telemetry rule.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the organization telemetry rule was created.
" } }, "LastUpdateTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the organization telemetry rule was last updated.
" } }, "TelemetryRule": { "target": "com.amazonaws.observabilityadmin#TelemetryRule", "traits": { "smithy.api#documentation": "The configuration details of the organization telemetry rule.
" } }, "HomeRegion": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the organization telemetry rule was originally created. For replicated rules in spoke regions, this indicates the region that manages the rule. For rules created without multi-region scope, this field is not present.
" } }, "IsReplicated": { "target": "com.amazonaws.observabilityadmin#IsReplicated", "traits": { "smithy.api#documentation": "Indicates whether this organization telemetry rule is a replica that was created in this region through multi-region fan-out from the home region. Replicated rules cannot be directly updated or deleted in the spoke region. To modify a replicated rule, make changes in the home region.
" } }, "RegionStatuses": { "target": "com.amazonaws.observabilityadmin#RegionStatuses", "traits": { "smithy.api#documentation": "A list of per-region replication statuses for the organization telemetry rule. Each entry indicates the replication status of the rule in a specific spoke region. This field is only present for rules created with multi-region scope.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryRuleInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the telemetry rule to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#GetTelemetryRuleOutput": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "The name of the telemetry rule.
" } }, "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the telemetry rule.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the telemetry rule was created.
" } }, "LastUpdateTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the telemetry rule was last updated.
" } }, "TelemetryRule": { "target": "com.amazonaws.observabilityadmin#TelemetryRule", "traits": { "smithy.api#documentation": "The configuration details of the telemetry rule.
" } }, "HomeRegion": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "The Amazon Web Services Region where the telemetry rule was originally created. For replicated rules in spoke regions, this indicates the region that manages the rule. For rules created without multi-region scope, this field is not present.
" } }, "IsReplicated": { "target": "com.amazonaws.observabilityadmin#IsReplicated", "traits": { "smithy.api#documentation": "Indicates whether this telemetry rule is a replica that was created in this region through multi-region fan-out from the home region. Replicated rules cannot be directly updated or deleted in the spoke region. To modify a replicated rule, make changes in the home region.
" } }, "RegionStatuses": { "target": "com.amazonaws.observabilityadmin#RegionStatuses", "traits": { "smithy.api#documentation": "A list of per-region replication statuses for the telemetry rule. Each entry indicates the replication status of the rule in a specific spoke region. This field is only present for rules created with multi-region scope.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#GetThirdPartyTelemetryEnrichment": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#GetThirdPartyTelemetryEnrichmentInput" }, "output": { "target": "com.amazonaws.observabilityadmin#GetThirdPartyTelemetryEnrichmentOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the details of a third-party telemetry enrichment, including its status and source configuration.
", "smithy.api#http": { "method": "POST", "uri": "/GetThirdPartyTelemetryEnrichment", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#GetThirdPartyTelemetryEnrichmentInput": { "type": "structure", "members": { "TelemetryEnrichmentIdentifier": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentIdentifier", "traits": { "smithy.api#documentation": "The identifier of the enrichment to return. You can specify one of the following:
The name of the enrichment.
The Amazon Resource Name (ARN) of the enrichment.
The Amazon Resource Name (ARN) of the enrichment.
" } }, "Name": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentName", "traits": { "smithy.api#documentation": "The name of the enrichment.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentStatus", "traits": { "smithy.api#documentation": "The current status of the enrichment. Valid values:
Initializing - CloudWatch is setting up the enrichment. Some telemetry can be enriched before setup completes.
Running - The enrichment is active.
Stopped - The enrichment is stopped.
Impaired - The enrichment has a problem. StatusReason describes the problem.
The reason for the current status. This field is present when the status is Impaired.
The source configuration of the enrichment.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapOutput", "traits": { "smithy.api#documentation": "The tags associated with the enrichment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#IamRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:iam::\\d{12}:role/[\\w+=,.@/-]+$" } }, "com.amazonaws.observabilityadmin#IntegrationStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } } }, "com.amazonaws.observabilityadmin#IntegrationSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#IntegrationSummary" } }, "com.amazonaws.observabilityadmin#IntegrationSummary": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 Table integration.
" } }, "Status": { "target": "com.amazonaws.observabilityadmin#IntegrationStatus", "traits": { "smithy.api#documentation": "The current status of the S3 Table integration.
" } } }, "traits": { "smithy.api#documentation": "Contains summary information about an S3 Table integration for listing operations.
" } }, "com.amazonaws.observabilityadmin#InternalServerException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" }, "amznErrorType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the exception.
", "smithy.api#httpHeader": "x-amzn-ErrorType" } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of seconds to wait before retrying the request.
", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "Indicates the request has failed to process because of an unknown server error, exception, or failure.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.observabilityadmin#InvalidStateException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The requested operation cannot be completed on the specified resource in the current state.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.observabilityadmin#IsReplicated": { "type": "boolean" }, "com.amazonaws.observabilityadmin#KmsKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:\\d{12}:key/(mrk-)?[a-f0-9-]+$" } }, "com.amazonaws.observabilityadmin#LabelNameCondition": { "type": "structure", "members": { "LabelName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The label name to match, supporting alphanumeric characters, underscores, hyphens, and colons.
", "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[0-9A-Za-z_\\-:]+$" } } }, "traits": { "smithy.api#documentation": "Condition that matches based on WAF rule labels, with label names limited to 1024 characters.
" } }, "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/ListCentralizationRulesForOrganization" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "CentralizationRuleSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationInput": { "type": "structure", "members": { "RuleNamePrefix": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A string to filter organization centralization rules whose names begin with the specified prefix.
", "smithy.api#length": { "min": 1, "max": 100 } } }, "AllRegions": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "A flag determining whether to return organization centralization rules from all regions or only the current region.
" } }, "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of organization centralization rules to return in a single call.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. A previous call generates this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganizationOutput": { "type": "structure", "members": { "CentralizationRuleSummaries": { "target": "com.amazonaws.observabilityadmin#CentralizationRuleSummaries", "traits": { "smithy.api#documentation": "A list of centralization rule summaries.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "A token to resume pagination of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListConnectors": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListConnectorsInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListConnectorsOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the connectors in the account and Region. This operation returns results in pages. To get the next page, pass the returned NextToken in the next call. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
The maximum number of connectors to return in one call. The default is 100.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#ConnectorNextToken", "traits": { "smithy.api#documentation": "The token for the next page of results, returned by a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListConnectorsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListConnectorsOutput": { "type": "structure", "members": { "ConnectorSummaries": { "target": "com.amazonaws.observabilityadmin#ConnectorSummaries", "traits": { "smithy.api#documentation": "The connectors in the account and Region.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#ConnectorNextToken", "traits": { "smithy.api#documentation": "The token to use in the next call to get the next page of results. Absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListDatasetIntegrations": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListDatasetIntegrationsInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListDatasetIntegrationsOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the dataset integrations in your account.
", "smithy.api#http": { "method": "POST", "uri": "/ListDatasetIntegrations" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "DatasetIntegrationSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListDatasetIntegrationsInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListDatasetIntegrationsMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return in a single call.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. A previous call generates this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListDatasetIntegrationsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListDatasetIntegrationsOutput": { "type": "structure", "members": { "DatasetIntegrationSummaries": { "target": "com.amazonaws.observabilityadmin#DatasetIntegrationSummaries", "traits": { "smithy.api#documentation": "The dataset integrations in your account.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "A token to resume pagination of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListResourceTelemetry": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.
", "smithy.api#http": { "method": "POST", "uri": "/ListResourceTelemetry" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TelemetryConfigurations" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.
", "smithy.api#http": { "method": "POST", "uri": "/ListResourceTelemetryForOrganization" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TelemetryConfigurations" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationInput": { "type": "structure", "members": { "AccountIdentifiers": { "target": "com.amazonaws.observabilityadmin#AccountIdentifiers", "traits": { "smithy.api#documentation": "A list of Amazon Web Services accounts used to filter the resources to those associated with the specified accounts.
" } }, "ResourceIdentifierPrefix": { "target": "com.amazonaws.observabilityadmin#ResourceIdentifierPrefix", "traits": { "smithy.api#documentation": " A string used to filter resources in the organization which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.
A list of resource types used to filter resources in the organization. If this parameter is provided, the service returns the resources in the same order as specified in the request. Currently supported resource types for discovery are:
AWS::EC2::Instance
AWS::EC2::VPC
AWS::Lambda::Function
AWS::EKS::Cluster
AWS::WAFv2::WebACL
AWS::ElasticLoadBalancingV2::LoadBalancer (Network Load Balancers only)
A key-value pair to filter resources in the organization based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.
" } }, "ResourceTags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "A key-value pair to filter resources in the organization based on tags associated with the resource. Fore more information about tags, see What are tags?
" } }, "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "A number field used to limit the number of results within the returned list.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. A previous call provides this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganizationOutput": { "type": "structure", "members": { "TelemetryConfigurations": { "target": "com.amazonaws.observabilityadmin#TelemetryConfigurations", "traits": { "smithy.api#documentation": "A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. A previous call provides this token.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListResourceTelemetryInput": { "type": "structure", "members": { "ResourceIdentifierPrefix": { "target": "com.amazonaws.observabilityadmin#ResourceIdentifierPrefix", "traits": { "smithy.api#documentation": " A string used to filter resources which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.
A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the service returns the resources in the same order as specified in the request. Currently supported resource types for discovery are:
AWS::EC2::Instance
AWS::EC2::VPC
AWS::Lambda::Function
AWS::EKS::Cluster
AWS::WAFv2::WebACL
AWS::ElasticLoadBalancingV2::LoadBalancer (Network Load Balancers only)
A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.
" } }, "ResourceTags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?
" } }, "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "A number field used to limit the number of results within the returned list.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. A previous call generates this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListResourceTelemetryMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.observabilityadmin#ListResourceTelemetryOutput": { "type": "structure", "members": { "TelemetryConfigurations": { "target": "com.amazonaws.observabilityadmin#TelemetryConfigurations", "traits": { "smithy.api#documentation": "A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the caller's account.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of items to return. A previous call generates this token.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListResourcesByConnector": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListResourcesByConnectorInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListResourcesByConnectorOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists resources in your cloud provider that the connector can access, such as management groups, subscriptions, resource types, Regions, resources, and Event Hubs. Use the results to build a telemetry manifest. This operation returns results in pages. To get the next page, pass the returned NextToken in the next call. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
The connector to use for the query. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
What to list: one cloud provider, and one type of resource in that provider.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListResourcesByConnectorMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return in one call. For an EventHubs query, a page can contain more results than this value.
The token for the next page of results, returned by a previous call.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListResourcesByConnectorMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.observabilityadmin#ListResourcesByConnectorOutput": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.observabilityadmin#ConnectorQueryResults", "traits": { "smithy.api#documentation": "The results, in the same shape as the Selector that you specified.
The token to use in the next call to get the next page of results. Absent when there are no more results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListS3TableIntegrations": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListS3TableIntegrationsInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListS3TableIntegrationsOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all S3 Table integrations in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.
", "smithy.api#http": { "method": "POST", "uri": "/ListS3TableIntegrations" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "IntegrationSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListS3TableIntegrationsInput": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListS3TableIntegrationsMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of S3 Table integrations to return in a single call.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. A previous call generates this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListS3TableIntegrationsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListS3TableIntegrationsOutput": { "type": "structure", "members": { "IntegrationSummaries": { "target": "com.amazonaws.observabilityadmin#IntegrationSummaries", "traits": { "smithy.api#documentation": "A list of S3 Table integration summaries containing key information about each integration.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "A token to resume pagination of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all tags attached to the specified resource. Supports telemetry rule resources, telemetry pipeline resources, and third-party telemetry enrichment resources.
", "smithy.api#http": { "method": "POST", "uri": "/ListTagsForResource" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListTagsForResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the telemetry rule resource whose tags you want to list.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapOutput", "traits": { "smithy.api#documentation": "The list of tags associated with the telemetry rule resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryPipelines": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListTelemetryPipelinesInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListTelemetryPipelinesOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "requiredActions": [ "observabilityadmin:ListTagsForResource" ] }, "smithy.api#documentation": "Returns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the NextToken value from the response to retrieve the next set of results.
The maximum number of telemetry pipelines to return in a single call.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. A previous call generates this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryPipelinesMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListTelemetryPipelinesOutput": { "type": "structure", "members": { "PipelineSummaries": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineSummaries", "traits": { "smithy.api#documentation": "A list of telemetry pipeline summaries containing key information about each pipeline.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "A token to resume pagination of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryRules": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.
", "smithy.api#http": { "method": "POST", "uri": "/ListTelemetryRules" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TelemetryRuleSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/ListTelemetryRulesForOrganization" }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults", "items": "TelemetryRuleSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationInput": { "type": "structure", "members": { "RuleNamePrefix": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A string to filter organization telemetry rules whose names begin with the specified prefix.
" } }, "SourceAccountIds": { "target": "com.amazonaws.observabilityadmin#AccountIdentifiers", "traits": { "smithy.api#documentation": "The list of account IDs to filter organization telemetry rules by their source accounts.
" } }, "SourceOrganizationUnitIds": { "target": "com.amazonaws.observabilityadmin#OrganizationUnitIdentifiers", "traits": { "smithy.api#documentation": "The list of organizational unit IDs to filter organization telemetry rules by their source organizational units.
" } }, "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of organization telemetry rules to return in a single call.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. A previous call generates this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganizationOutput": { "type": "structure", "members": { "TelemetryRuleSummaries": { "target": "com.amazonaws.observabilityadmin#TelemetryRuleSummaries", "traits": { "smithy.api#documentation": "A list of organization telemetry rule summaries.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "A token to resume pagination of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryRulesInput": { "type": "structure", "members": { "RuleNamePrefix": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A string to filter telemetry rules whose names begin with the specified prefix.
" } }, "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of telemetry rules to return in a single call.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. A previous call generates this token.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListTelemetryRulesMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListTelemetryRulesOutput": { "type": "structure", "members": { "TelemetryRuleSummaries": { "target": "com.amazonaws.observabilityadmin#TelemetryRuleSummaries", "traits": { "smithy.api#documentation": "A list of telemetry rule summaries.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "A token to resume pagination of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ListThirdPartyTelemetryEnrichments": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ListThirdPartyTelemetryEnrichmentsInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ListThirdPartyTelemetryEnrichmentsOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a summary of each third-party telemetry enrichment in your account and Region. To get the full configuration of an enrichment, use GetThirdPartyTelemetryEnrichment. The results are paginated. To get the next page of results, use NextToken.
Returns only the enrichments that have this status. Valid values:
Initializing - CloudWatch is setting up the enrichment. Some telemetry can be enriched before setup completes.
Running - The enrichment is active.
Stopped - The enrichment is stopped.
Impaired - The enrichment has a problem. StatusReason describes the problem.
Returns only the enrichments for this third-party telemetry source.
" } }, "MaxResults": { "target": "com.amazonaws.observabilityadmin#ListThirdPartyTelemetryEnrichmentsMaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of results to return in a single call. If you omit this parameter, the operation returns up to 100 results.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results. A previous call generates this token. If you omit this parameter, the operation returns the first page of results.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ListThirdPartyTelemetryEnrichmentsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.observabilityadmin#ListThirdPartyTelemetryEnrichmentsOutput": { "type": "structure", "members": { "TelemetryEnrichments": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentSummaries", "traits": { "smithy.api#documentation": "The enrichments in your account and Region.
" } }, "NextToken": { "target": "com.amazonaws.observabilityadmin#NextToken", "traits": { "smithy.api#documentation": "A token to resume pagination of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#LogDeliveryParameters": { "type": "structure", "members": { "LogTypes": { "target": "com.amazonaws.observabilityadmin#LogTypes", "traits": { "smithy.api#documentation": "The types of logs to collect from the resource.
" } } }, "traits": { "smithy.api#documentation": "The configuration parameters for log delivery, including logType settings. Applies to resource types that support configurable log delivery, such as Amazon Bedrock Knowledge Bases, Amazon Bedrock AgentCore payment managers, and Elastic Load Balancing Application Load Balancers.
The pattern used to generate destination log group names during centralization. The pattern can contain static text and dynamic variables that are replaced with source attributes. If a variable cannot be resolved, it inherits the value from its parent variable in the hierarchy. The pattern must be between 1 and 512 characters.
Supported variables:
${source.logGroup} \u2014 The original log group name from the source account.
${source.accountId} \u2014 The Amazon Web Services account ID where the log originated.
${source.region} \u2014 The Amazon Web Services Region where the log originated.
${source.org.id} \u2014 The Amazon Web Services Organization ID of the source account.
${source.org.ouId} \u2014 The organizational unit ID of the source account.
${source.org.rootId} \u2014 The organization Root ID.
${source.org.path} \u2014 The organizational path from account to root.
Configuration that specifies a naming pattern for destination log groups created during centralization. The pattern supports static text and dynamic variables that are replaced with source attributes when log groups are created.
" } }, "com.amazonaws.observabilityadmin#LogGroupNamePattern": { "type": "string", "traits": { "smithy.api#documentation": "The pattern used to generate destination log group names during centralization. The pattern can contain static text and dynamic variables that are replaced with source attributes. If a variable cannot be resolved, it inherits the value from its parent variable in the hierarchy. The pattern must be between 1 and 512 characters.
Supported variables:
${source.logGroup} \u2014 The original log group name from the source account.
${source.accountId} \u2014 The Amazon Web Services account ID where the log originated.
${source.region} \u2014 The Amazon Web Services Region where the log originated.
${source.org.id} \u2014 The Amazon Web Services Organization ID of the source account.
${source.org.ouId} \u2014 The organizational unit ID of the source account.
${source.org.rootId} \u2014 The organization Root ID.
${source.org.path} \u2014 The organizational path from account to root.
The following log types are supported for log delivery configuration:
APPLICATION_LOGS \u2013 Application-level logs.
USAGE_LOGS \u2013 Resource usage logs.
SECURITY_FINDING_LOGS \u2013 Security finding logs.
ACCESS_LOGS \u2013 Access logs (such as Elastic Load Balancing access logs).
CONNECTION_LOGS \u2013 Connection logs.
S3_SERVER_ACCESS_LOGS \u2013 Amazon S3 server access logs.
A list of filter conditions that determine log record handling behavior.
" } }, "DefaultBehavior": { "target": "com.amazonaws.observabilityadmin#FilterBehavior", "traits": { "smithy.api#documentation": "The default action (KEEP or DROP) for log records that don't match any filter conditions.
" } } }, "traits": { "smithy.api#documentation": "Configuration that determines which WAF log records to keep or drop based on specified conditions.
" } }, "com.amazonaws.observabilityadmin#LogsBackupConfiguration": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "Logs specific backup destination region within the primary destination account to which log data should be centralized.
", "smithy.api#required": {} } }, "KmsKeyArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
" } } }, "traits": { "smithy.api#documentation": "Configuration for backing up centralized log data to a secondary region.
" } }, "com.amazonaws.observabilityadmin#LogsEncryptionConfiguration": { "type": "structure", "members": { "EncryptionStrategy": { "target": "com.amazonaws.observabilityadmin#EncryptionStrategy", "traits": { "smithy.api#documentation": "Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
", "smithy.api#required": {} } }, "KmsKeyArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
" } }, "EncryptionConflictResolutionStrategy": { "target": "com.amazonaws.observabilityadmin#EncryptionConflictResolutionStrategy", "traits": { "smithy.api#documentation": "Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.
" } }, "EncryptionScope": { "target": "com.amazonaws.observabilityadmin#EncryptionScope", "traits": { "smithy.api#documentation": "Determines which newly created destination log groups are encrypted with the configured KmsKeyArn when EncryptionStrategy is CUSTOMER_MANAGED.
If you set this to ENCRYPTED_SOURCE_ONLY (the default), only destination log groups whose source log group is encrypted with a customer managed KMS key use the configured KmsKeyArn. Destination log groups derived from Amazon Web Services owned encrypted source log groups remain Amazon Web Services owned encrypted.
If you set this to NEW_DESTINATION_LOG_GROUPS, every new destination log group created by this rule uses the configured KmsKeyArn, regardless of the source log group's encryption posture.
This field is not valid when EncryptionStrategy is AWS_OWNED.
Configuration for encrypting centralized destination log groups. By default, this configuration applies only to destination log groups whose corresponding source log groups are encrypted using customer managed KMS keys. To encrypt all destination log groups created by the rule, set EncryptionScope to NEW_DESTINATION_LOG_GROUPS.
Metrics specific backup destination region within the primary destination account to which metrics data should be centralized.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for backing up centralized metrics data to a secondary region.
" } }, "com.amazonaws.observabilityadmin#MetricsFilterString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.observabilityadmin#MskEnhancedMonitoringLevel": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "PER_BROKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PER_BROKER" } }, "PER_TOPIC_PER_BROKER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PER_TOPIC_PER_BROKER" } }, "PER_TOPIC_PER_PARTITION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PER_TOPIC_PER_PARTITION" } } }, "traits": { "smithy.api#documentation": "Enumeration of supported enhanced monitoring levels for Amazon MSK clusters: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.
" } }, "com.amazonaws.observabilityadmin#MskMonitoringParameters": { "type": "structure", "members": { "EnhancedMonitoring": { "target": "com.amazonaws.observabilityadmin#MskEnhancedMonitoringLevel", "traits": { "smithy.api#documentation": "The level of enhanced monitoring for the MSK cluster.
" } } }, "traits": { "smithy.api#documentation": "Configuration parameters for Amazon MSK cluster monitoring, including enhanced monitoring level settings.
" } }, "com.amazonaws.observabilityadmin#NextToken": { "type": "string" }, "com.amazonaws.observabilityadmin#ObservabilityAdmin": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.observabilityadmin#CreateCentralizationRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#CreateConnector" }, { "target": "com.amazonaws.observabilityadmin#CreateDatasetIntegration" }, { "target": "com.amazonaws.observabilityadmin#CreateS3TableIntegration" }, { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRule" }, { "target": "com.amazonaws.observabilityadmin#CreateTelemetryRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#DeleteCentralizationRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#DeleteConnector" }, { "target": "com.amazonaws.observabilityadmin#DeleteDatasetIntegration" }, { "target": "com.amazonaws.observabilityadmin#DeleteS3TableIntegration" }, { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRule" }, { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#GetCentralizationRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#GetConnector" }, { "target": "com.amazonaws.observabilityadmin#GetConnectorTelemetryManifest" }, { "target": "com.amazonaws.observabilityadmin#GetConnectorTelemetrySetup" }, { "target": "com.amazonaws.observabilityadmin#GetDatasetIntegration" }, { "target": "com.amazonaws.observabilityadmin#GetS3TableIntegration" }, { "target": "com.amazonaws.observabilityadmin#GetTelemetryEnrichmentStatus" }, { "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatus" }, { "target": "com.amazonaws.observabilityadmin#GetTelemetryEvaluationStatusForOrganization" }, { "target": "com.amazonaws.observabilityadmin#GetTelemetryRule" }, { "target": "com.amazonaws.observabilityadmin#GetTelemetryRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#GetThirdPartyTelemetryEnrichment" }, { "target": "com.amazonaws.observabilityadmin#ListCentralizationRulesForOrganization" }, { "target": "com.amazonaws.observabilityadmin#ListConnectors" }, { "target": "com.amazonaws.observabilityadmin#ListDatasetIntegrations" }, { "target": "com.amazonaws.observabilityadmin#ListResourcesByConnector" }, { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetry" }, { "target": "com.amazonaws.observabilityadmin#ListResourceTelemetryForOrganization" }, { "target": "com.amazonaws.observabilityadmin#ListS3TableIntegrations" }, { "target": "com.amazonaws.observabilityadmin#ListTagsForResource" }, { "target": "com.amazonaws.observabilityadmin#ListTelemetryRules" }, { "target": "com.amazonaws.observabilityadmin#ListTelemetryRulesForOrganization" }, { "target": "com.amazonaws.observabilityadmin#ListThirdPartyTelemetryEnrichments" }, { "target": "com.amazonaws.observabilityadmin#PutConnectorTelemetryManifest" }, { "target": "com.amazonaws.observabilityadmin#StartTelemetryEnrichment" }, { "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluation" }, { "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluationForOrganization" }, { "target": "com.amazonaws.observabilityadmin#StartThirdPartyTelemetryEnrichment" }, { "target": "com.amazonaws.observabilityadmin#StopTelemetryEnrichment" }, { "target": "com.amazonaws.observabilityadmin#StopTelemetryEvaluation" }, { "target": "com.amazonaws.observabilityadmin#StopTelemetryEvaluationForOrganization" }, { "target": "com.amazonaws.observabilityadmin#StopThirdPartyTelemetryEnrichment" }, { "target": "com.amazonaws.observabilityadmin#TagResource" }, { "target": "com.amazonaws.observabilityadmin#TestTelemetryPipeline" }, { "target": "com.amazonaws.observabilityadmin#UntagResource" }, { "target": "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#UpdateDatasetIntegration" }, { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRule" }, { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganization" }, { "target": "com.amazonaws.observabilityadmin#ValidateTelemetryPipelineConfiguration" } ], "resources": [ { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineResource" } ], "traits": { "aws.api#service": { "sdkId": "ObservabilityAdmin", "arnNamespace": "observabilityadmin", "cloudFormationName": "ObservabilityAdmin" }, "aws.api#tagEnabled": {}, "aws.auth#sigv4": { "name": "observabilityadmin" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. For more information, see Auditing CloudWatch telemetry con\ufb01gurations in the CloudWatch User Guide.
For information on the permissions you need to use this API, see Identity and access management for Amazon CloudWatch in the CloudWatch User Guide.
", "smithy.api#title": "CloudWatch Observability Admin Service", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://observabilityadmin-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://observabilityadmin-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://observabilityadmin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://observabilityadmin.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://observabilityadmin-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://observabilityadmin-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://observabilityadmin.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://observabilityadmin.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://observabilityadmin.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://observabilityadmin.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://observabilityadmin.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://observabilityadmin.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.observabilityadmin#OrganizationUnitIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" } }, "com.amazonaws.observabilityadmin#OrganizationUnitIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#OrganizationUnitIdentifier" }, "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.observabilityadmin#OutputFormat": { "type": "enum", "members": { "PLAIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "plain" } }, "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "json" } } }, "traits": { "smithy.api#documentation": "Enumeration of supported output formats for ELB access logs: PLAIN for space-delimited format, JSON for structured JSON format.
" } }, "com.amazonaws.observabilityadmin#Permission": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.observabilityadmin#PermissionList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#Permission" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.observabilityadmin#PipelineOutput": { "type": "structure", "members": { "Record": { "target": "com.amazonaws.observabilityadmin#Record", "traits": { "smithy.api#documentation": "The processed record output from the pipeline test operation.
" } }, "Error": { "target": "com.amazonaws.observabilityadmin#PipelineOutputError", "traits": { "smithy.api#documentation": "Any error that occurred during the pipeline test operation for this record.
" } } }, "traits": { "smithy.api#documentation": "Contains the output from pipeline test operations, including processed records and any errors encountered.
" } }, "com.amazonaws.observabilityadmin#PipelineOutputError": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The detailed error message describing what went wrong during the pipeline test operation for this record.
" } } }, "traits": { "smithy.api#documentation": "Contains detailed error information from pipeline test operations, providing structured error responses for better debugging and troubleshooting capabilities.
" } }, "com.amazonaws.observabilityadmin#PipelineOutputs": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#PipelineOutput" } }, "com.amazonaws.observabilityadmin#Processors": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.observabilityadmin#ProfilesBackupConfiguration": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": "The backup Region for profiles, within the primary destination account, to which the service centralizes profiles data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for backing up centralized profiles data to a secondary Region.
" } }, "com.amazonaws.observabilityadmin#ProfilesFilterString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.observabilityadmin#PutConnectorTelemetryManifest": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#PutConnectorTelemetryManifestInput" }, "output": { "target": "com.amazonaws.observabilityadmin#PutConnectorTelemetryManifestOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or replaces the telemetry manifest of a connector. The telemetry manifest declares which resources in your cloud provider to collect telemetry from and which telemetry types to collect. To avoid overwriting changes made by another caller, specify ExpectedVersion.
The connector. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
The telemetry manifest.
", "smithy.api#required": {} } }, "ExpectedVersion": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The version of the telemetry manifest that you expect to replace, as returned by GetConnectorTelemetryManifest. Omit this value when you create the first telemetry manifest. If the value doesn't match the current version, the request fails with a ConflictException.
A unique, case-sensitive identifier that you provide to ensure the operation completes no more than one time. If you use an Amazon Web Services SDK, the SDK generates this value and reuses it on retries. If this token matches a previous request with the same telemetry manifest, the service returns the stored version without an error. If you use the same token with a different telemetry manifest, the service returns a ValidationException. This operation is idempotent when you use the same token and parameters.
The version of the telemetry manifest after this update.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#Record": { "type": "structure", "members": { "Data": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The data content of the test record used for pipeline validation.
" } }, "Type": { "target": "com.amazonaws.observabilityadmin#RecordFormat", "traits": { "smithy.api#documentation": "The type of the test record, indicating the format or category of the data.
" } } }, "traits": { "smithy.api#documentation": "Represents a test record structure used for pipeline testing operations to validate data processing.
" } }, "com.amazonaws.observabilityadmin#RecordFormat": { "type": "enum", "members": { "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRING" } }, "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } } } }, "com.amazonaws.observabilityadmin#Records": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#Record" } }, "com.amazonaws.observabilityadmin#RedactedFields": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#FieldToMatch" }, "traits": { "smithy.api#documentation": "A list of fields to redact from WAF logs to protect sensitive information, with a maximum of 100 fields.
", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.observabilityadmin#Region": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.observabilityadmin#RegionStatus": { "type": "structure", "members": { "Region": { "target": "com.amazonaws.observabilityadmin#Region", "traits": { "smithy.api#documentation": " The Amazon Web Services Region code (for example, eu-west-1 or us-west-2) that this status applies to.
The status of the operation in this region. For telemetry evaluation, valid values include STARTING, RUNNING, and FAILED_START. For telemetry rules, valid values include PENDING, ACTIVE, and FAILED.
The reason for a failure status in this region. This field is only populated when Status indicates a failure.
The Amazon Resource Name (ARN) of the telemetry rule in this spoke region. This field is only present for telemetry rule region statuses and is populated when the rule has been successfully created in the spoke region (status is ACTIVE).
Represents the status of a multi-region operation in a specific Amazon Web Services Region. This structure is used to report per-region progress for both telemetry evaluation and telemetry rule replication.
" } }, "com.amazonaws.observabilityadmin#RegionStatuses": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#RegionStatus" } }, "com.amazonaws.observabilityadmin#Regions": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#Region" }, "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.observabilityadmin#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$" } }, "com.amazonaws.observabilityadmin#ResourceIdentifier": { "type": "string" }, "com.amazonaws.observabilityadmin#ResourceIdentifierPrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 768 } } }, "com.amazonaws.observabilityadmin#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the resource which could not be found.
" } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource which could not be found.
" } } }, "traits": { "smithy.api#documentation": "The specified resource (such as a telemetry rule) could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.observabilityadmin#ResourceType": { "type": "enum", "members": { "AWS_EC2_INSTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::Instance" } }, "AWS_EC2_VPC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EC2::VPC" } }, "AWS_LAMDBA_FUNCTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::Lambda::Function" } }, "AWS_CLOUDTRAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::CloudTrail" } }, "AWS_EKS_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::EKS::Cluster" } }, "AWS_WAF_V2_WEB_ACL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::WAFv2::WebACL" } }, "AWS_ELB_LOADBALANCER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::ElasticLoadBalancingV2::LoadBalancer" } }, "AWS_ROUTE53_RESOLVER_RESOLVER_ENDPOINT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::Route53Resolver::ResolverEndpoint" } }, "AWS_BEDROCK_AGENTCORE_RUNTIME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::BedrockAgentCore::Runtime" } }, "AWS_BEDROCK_AGENTCORE_BROWSER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::BedrockAgentCore::Browser" } }, "AWS_BEDROCK_AGENTCORE_CODE_INTERPRETER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::BedrockAgentCore::CodeInterpreter" } }, "AWS_BEDROCK_AGENTCORE_GATEWAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::BedrockAgentCore::Gateway" } }, "AWS_BEDROCK_AGENTCORE_MEMORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::BedrockAgentCore::Memory" } }, "AWS_BEDROCK_AGENTCORE_WORKLOAD_IDENTITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::BedrockAgentCore::WorkloadIdentity" } }, "AWS_BEDROCK_AGENTCORE_PAYMENT_MANAGER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::BedrockAgentCore::PaymentManager" } }, "AWS_SECURITY_HUB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::SecurityHub::Hub" } }, "AWS_CLOUDFRONT_DISTRIBUTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::CloudFront::Distribution" } }, "AWS_SECURITY_HUB_HUBV2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::SecurityHub::HubV2" } }, "AWS_OTEL_ENRICHMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::CloudWatch::OTelEnrichment" } }, "AWS_MSK_CLUSTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::MSK::Cluster" } }, "AWS_S3_BUCKET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::S3::Bucket" } }, "AWS_BEDROCK_KNOWLEDGEBASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::Bedrock::KnowledgeBase" } }, "AWS_XRAY_TRANSACTION_SEARCH_CONFIG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS::XRay::TransactionSearchConfig" } } } }, "com.amazonaws.observabilityadmin#ResourceTypes": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#ResourceType" }, "traits": { "smithy.api#length": { "min": 1, "max": 9 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.observabilityadmin#RetentionPeriodInDays": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 3653 } } }, "com.amazonaws.observabilityadmin#RoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 1011 }, "smithy.api#pattern": "^arn:aws([a-z0-9\\-]+)?:([a-zA-Z0-9\\-]+):([a-z0-9\\-]+)?:([0-9]{12})?:(.+)$" } }, "com.amazonaws.observabilityadmin#RuleHealth": { "type": "enum", "members": { "HEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Healthy" } }, "UNHEALTHY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Unhealthy" } }, "PROVISIONING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Provisioning" } } } }, "com.amazonaws.observabilityadmin#RuleIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.observabilityadmin#RuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[0-9A-Za-z-_.#/]+$" } }, "com.amazonaws.observabilityadmin#SSEAlgorithm": { "type": "enum", "members": { "SSE_KMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "aws:kms" } }, "SSE_S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AES256" } } } }, "com.amazonaws.observabilityadmin#ServiceLinkedRecorderArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[a-z]+)*:config:[a-z0-9\\-]+:[0-9]{12}:configuration-recorder/[^\\r\\n]+$" } }, "com.amazonaws.observabilityadmin#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" }, "ResourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the resource which exceeds the service quota.
" } }, "ResourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the resource which exceeds the service quota.
" } }, "ServiceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code for the service of the exceeded quota.
" } }, "QuotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code for the exceeded service quota.
" } }, "amznErrorType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the exception.
", "smithy.api#httpHeader": "x-amzn-ErrorType" } } }, "traits": { "smithy.api#documentation": "The requested operation would exceed the allowed quota for the specified resource type.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.observabilityadmin#SetupArtifact": { "type": "structure", "members": { "FileName": { "target": "com.amazonaws.observabilityadmin#SetupArtifactFileName", "traits": { "smithy.api#documentation": "The suggested file name, for example main.bicep.
The content of the artifact.
", "smithy.api#required": {} } }, "Format": { "target": "com.amazonaws.observabilityadmin#SetupFormat", "traits": { "smithy.api#documentation": "The format of the artifact.
", "smithy.api#required": {} } }, "ContentType": { "target": "com.amazonaws.observabilityadmin#SetupArtifactContentType", "traits": { "smithy.api#documentation": "The content type of the artifact, for example text/plain.
A setup artifact, which is one file in the requested format.
" } }, "com.amazonaws.observabilityadmin#SetupArtifactContent": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 262144 } } }, "com.amazonaws.observabilityadmin#SetupArtifactContentType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 } } }, "com.amazonaws.observabilityadmin#SetupArtifactFileName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.observabilityadmin#SetupArtifactList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#SetupArtifact" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.observabilityadmin#SetupFormat": { "type": "enum", "members": { "BICEP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BICEP" } } } }, "com.amazonaws.observabilityadmin#SignalType": { "type": "enum", "members": { "LOG": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Log signal type. The pipeline processes log records.
", "smithy.api#enumValue": "LOG" } }, "METRIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Metric signal type. The pipeline processes metric records.
", "smithy.api#enumValue": "METRIC" } } } }, "com.amazonaws.observabilityadmin#SingleHeader": { "type": "structure", "members": { "Name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name value, limited to 64 characters.
", "smithy.api#length": { "min": 1, "max": 64 } } } }, "traits": { "smithy.api#documentation": "Structure containing a name field limited to 64 characters for header or query parameter identification.
" } }, "com.amazonaws.observabilityadmin#Sinks": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.observabilityadmin#Source": { "type": "structure", "members": { "Type": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The plugin name of the source, such as cloudwatch_logs or s3.
A list of source plugin types used in the pipeline configuration (such as cloudwatch_logs or s3). Currently supports a single source per pipeline, but is structured as a list to accommodate multiple pipelines in the configuration.
Configuration that enables centralization of the context graph for the selected sources. Including this configuration in a rule's source opts the rule into centralizing the context graph for the selected sources.
" } }, "com.amazonaws.observabilityadmin#SourceFilterString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2000 } } }, "com.amazonaws.observabilityadmin#SourceLogsConfiguration": { "type": "structure", "members": { "LogGroupSelectionCriteria": { "target": "com.amazonaws.observabilityadmin#LogsFilterString", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "*", "smithy.api#documentation": "The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
" } }, "DataSourceSelectionCriteria": { "target": "com.amazonaws.observabilityadmin#DataSourceFilterString", "traits": { "smithy.api#documentation": "The selection criteria that specifies which data sources to centralize. The selection criteria uses the same filter expression format as LogGroupSelectionCriteria, but operates on DataSourceName and DataSourceType operands. When both LogGroupSelectionCriteria and DataSourceSelectionCriteria are specified, a log event must match both criteria to be centralized.
A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for selecting and handling source log groups for centralization.
" } }, "com.amazonaws.observabilityadmin#SourceMetricsConfiguration": { "type": "structure", "members": { "MetricsSelectionCriteria": { "target": "com.amazonaws.observabilityadmin#MetricsFilterString", "traits": { "smithy.api#documentation": "The filter expression that selects which source metrics to centralize. Currently, only * (all metrics) is supported. Other values return a validation error.
Configuration for selecting source metrics for centralization.
" } }, "com.amazonaws.observabilityadmin#SourceProfilesConfiguration": { "type": "structure", "members": { "ProfilesSelectionCriteria": { "target": "com.amazonaws.observabilityadmin#ProfilesFilterString", "traits": { "smithy.api#documentation": "The filter expression that selects which source profiles to centralize.
" } } }, "traits": { "smithy.api#documentation": "Configuration for selecting source profiles for centralization.
" } }, "com.amazonaws.observabilityadmin#SourceProgress": { "type": "structure", "members": { "Active": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of discovered sources that are active and sending telemetry to the pipeline.
", "smithy.api#range": { "min": 0 } } }, "Total": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total number of sources discovered for the pipeline.
", "smithy.api#range": { "min": 0 } } } }, "traits": { "smithy.api#documentation": "A summary of source activation for an external-cloud telemetry pipeline, with the number of active sources and the total number of discovered sources.
" } }, "com.amazonaws.observabilityadmin#Sources": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#Source" } }, "com.amazonaws.observabilityadmin#StartTelemetryEnrichment": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.observabilityadmin#StartTelemetryEnrichmentOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Enables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Resource Explorer to provide richer context for monitoring and observability.
", "smithy.api#http": { "method": "POST", "uri": "/StartTelemetryEnrichment", "code": 202 } } }, "com.amazonaws.observabilityadmin#StartTelemetryEnrichmentOutput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.observabilityadmin#TelemetryEnrichmentStatus", "traits": { "smithy.api#documentation": " The status of the resource tags for telemetry feature after the start operation (Running, Stopped, or Impaired).
The Amazon Resource Name (ARN) of the Resource Explorer managed view created for resource tags for telemetry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#StartTelemetryEvaluation": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluationInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.
", "smithy.api#http": { "method": "POST", "uri": "/StartTelemetryEvaluation" } } }, "com.amazonaws.observabilityadmin#StartTelemetryEvaluationForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#StartTelemetryEvaluationForOrganizationInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "This actions begins onboarding the organization and all member accounts to the telemetry config feature.
", "smithy.api#http": { "method": "POST", "uri": "/StartTelemetryEvaluationForOrganization" } } }, "com.amazonaws.observabilityadmin#StartTelemetryEvaluationForOrganizationInput": { "type": "structure", "members": { "Regions": { "target": "com.amazonaws.observabilityadmin#Regions", "traits": { "smithy.api#documentation": " An optional list of Amazon Web Services Regions to include in multi-region telemetry evaluation for the organization. The current region is always implicitly included and must not be specified in this list. When provided, telemetry evaluation starts in the current region and propagates to all specified regions for the organization. Mutually exclusive with AllRegions. If neither Regions nor AllRegions is provided, the operation applies only to the current region.
If set to true, telemetry evaluation for the organization starts in all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. The current region becomes the home region for managing multi-region evaluation for the organization. When new regions become available, evaluation automatically expands to include them. Mutually exclusive with Regions.
An optional list of Amazon Web Services Regions to include in multi-region telemetry evaluation. The current region is always implicitly included and must not be specified in this list. When provided, telemetry evaluation starts in the current region and propagates to all specified regions. Mutually exclusive with AllRegions. If neither Regions nor AllRegions is provided, the operation applies only to the current region.
If set to true, telemetry evaluation starts in all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. The current region becomes the home region for managing multi-region evaluation. When new regions become available, evaluation automatically expands to include them. Mutually exclusive with Regions.
Starts a refresh of an external-cloud telemetry pipeline. The refresh re-reads the connector's telemetry manifest and re-discovers the sources in scope.
The pipeline must be in the ACTIVE or UPDATE_FAILED state, with no refresh already running. You can use GetTelemetryPipeline to track the refresh.
The Amazon Resource Name (ARN) of the telemetry pipeline to refresh.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#StartTelemetryPipelineRefreshOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#StartThirdPartyTelemetryEnrichment": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#StartThirdPartyTelemetryEnrichmentInput" }, "output": { "target": "com.amazonaws.observabilityadmin#StartThirdPartyTelemetryEnrichmentOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Starts a third-party telemetry enrichment. An enrichment adds resource metadata, such as tags, from a third-party telemetry source to the telemetry that CloudWatch receives from the resources of that source.
You specify an Amazon Web Services Config connector for your third-party environment, such as a Microsoft Azure tenant. You can use each connector for only one enrichment.
To use this operation, you must have the config:PutThirdPartyServiceLinkedConfigurationRecorder permission. If the Amazon Web Services Config service-linked role does not exist in your account, you must also have the iam:CreateServiceLinkedRole permission.
A name for the enrichment. The name must be unique in your account and Region. You can use the name instead of the ARN to identify the enrichment in other operations.
", "smithy.api#required": {} } }, "TelemetrySourceConfiguration": { "target": "com.amazonaws.observabilityadmin#TelemetrySourceConfigurationInput", "traits": { "smithy.api#documentation": "The third-party telemetry source to collect resource metadata from. Specify exactly one telemetry source.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The tags to associate with the enrichment resource.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#StartThirdPartyTelemetryEnrichmentOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the enrichment.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentName", "traits": { "smithy.api#documentation": "The name of the enrichment.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentStatus", "traits": { "smithy.api#documentation": "The status of the enrichment after the start operation. Valid values:
Initializing - CloudWatch is setting up the enrichment. Some telemetry can be enriched before setup completes.
Running - The enrichment is active.
Stopped - The enrichment is stopped.
Impaired - The enrichment has a problem. StatusReason describes the problem.
The reason for the current status. This field is present when the status is Impaired.
The source configuration of the enrichment.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapOutput", "traits": { "smithy.api#documentation": "The tags associated with the enrichment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#Status": { "type": "enum", "members": { "NOT_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_STARTED" } }, "STARTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTING" } }, "FAILED_START": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_START" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "FAILED_STOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_STOP" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } } } }, "com.amazonaws.observabilityadmin#StatusReason": { "type": "string" }, "com.amazonaws.observabilityadmin#StopTelemetryEnrichment": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.observabilityadmin#StopTelemetryEnrichmentOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Disables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.
", "smithy.api#http": { "method": "POST", "uri": "/StopTelemetryEnrichment", "code": 202 } } }, "com.amazonaws.observabilityadmin#StopTelemetryEnrichmentOutput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.observabilityadmin#TelemetryEnrichmentStatus", "traits": { "smithy.api#documentation": " The status of the resource tags for telemetry feature after the stop operation (Running, Stopped, or Impaired).
This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.
", "smithy.api#http": { "method": "POST", "uri": "/StopTelemetryEvaluation" } } }, "com.amazonaws.observabilityadmin#StopTelemetryEvaluationForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.
", "smithy.api#http": { "method": "POST", "uri": "/StopTelemetryEvaluationForOrganization" } } }, "com.amazonaws.observabilityadmin#StopThirdPartyTelemetryEnrichment": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#StopThirdPartyTelemetryEnrichmentInput" }, "output": { "target": "com.amazonaws.observabilityadmin#StopThirdPartyTelemetryEnrichmentOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Stops a third-party telemetry enrichment. CloudWatch stops adding resource metadata from the third-party telemetry source to your telemetry.
To use this operation, you must have the config:DeleteServiceLinkedConfigurationRecorder permission.
The identifier of the enrichment to stop. You can specify one of the following:
The name of the enrichment.
The Amazon Resource Name (ARN) of the enrichment.
The name of the enrichment.
", "smithy.api#required": {} } }, "TelemetrySource": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetrySource", "traits": { "smithy.api#documentation": "The third-party telemetry source of the enrichment.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentStatus", "traits": { "smithy.api#documentation": "The status of the enrichment after the stop operation. Valid values:
Initializing - CloudWatch is setting up the enrichment. Some telemetry can be enriched before setup completes.
Running - The enrichment is active.
Stopped - The enrichment is stopped.
Impaired - The enrichment has a problem. StatusReason describes the problem.
The reason for the current status. This field is present when the status is Impaired.
The strategy for resolving tag conflicts between source and destination log groups.
ADD_ONLY \u2013 Only adds new tags from the source without modifying existing destination tags.
UPDATE_SYNC \u2013 Adds new tags and updates existing tags from the source. Does not remove destination tags that are absent from the source.
IN_SYNC \u2013 Keeps destination tags fully synchronized with source tags, including removing destination tags that do not exist on the source.
The tag key. Up to 512 characters. The characters < > % & \\ ? / $ { } ' \" ` and control characters aren't allowed.
", "smithy.api#required": {} } }, "Values": { "target": "com.amazonaws.observabilityadmin#TagFilterValues", "traits": { "smithy.api#documentation": "The tag values to match. A resource matches if it has any of these values for the tag key.
", "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A tag filter. A resource matches only if it has the tag. Filters for different tag keys must all match; for one tag key, any of the values can match.
" } }, "com.amazonaws.observabilityadmin#TagFilterKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^[^<>%&\\\\?/${}'\"`\\u0000-\\u001F\\u007F]+$" } }, "com.amazonaws.observabilityadmin#TagFilterList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#TagFilter" } }, "com.amazonaws.observabilityadmin#TagFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[^${}'\"`\\\\<>\\u0000-\\u001F\\u007F]*$" } }, "com.amazonaws.observabilityadmin#TagFilterValues": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#TagFilterValue" } }, "com.amazonaws.observabilityadmin#TagKey": { "type": "string", "traits": { "aws.api#data": "tagging", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.observabilityadmin#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.observabilityadmin#TagMapInput": { "type": "map", "key": { "target": "com.amazonaws.observabilityadmin#TagKey" }, "value": { "target": "com.amazonaws.observabilityadmin#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.observabilityadmin#TagMapOutput": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.observabilityadmin#TagPropagationConfiguration": { "type": "structure", "members": { "DestinationRoleArn": { "target": "com.amazonaws.observabilityadmin#IamRoleArn", "traits": { "smithy.api#documentation": "The ARN of a customer-managed IAM role in the destination account. The service assumes this role to propagate tags to destination log groups. You must have iam:PassRole permission on this role.
The strategy for resolving conflicts when a tag key exists on both the source and destination log groups. If not specified, defaults to UPDATE_SYNC.
ADD_ONLY \u2013 Only adds new tags from the source without modifying existing destination tags.
UPDATE_SYNC \u2013 Adds new tags and updates existing tags from the source. Does not remove destination tags that are absent from the source.
IN_SYNC \u2013 Keeps destination tags fully synchronized with source tags, including removing destination tags that do not exist on the source.
Specifies configuration for propagating resource tags from source log groups to centralized destination log groups. The service uses a customer-managed IAM role in the destination account to add, update, and remove tags on destination log groups.
" } }, "com.amazonaws.observabilityadmin#TagPropagationFailureReason": { "type": "enum", "members": { "ROLE_NOT_ASSUMABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RoleNotAssumable" } }, "ROLE_LACKS_PERMISSIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RoleLacksPermissions" } } }, "traits": { "smithy.api#documentation": "The reason tag propagation is unhealthy for a centralization rule.
RoleNotAssumable \u2013 The service cannot assume the destination role due to a trust policy or external ID misconfiguration.
RoleLacksPermissions \u2013 The role was assumed successfully but the tag API call was denied by the role's permissions policy.
The health status of tag propagation for a centralization rule. This status is independent of the overall RuleHealth for log delivery.
Adds or updates tags for a resource. Supports telemetry rule resources, telemetry pipeline resources, and third-party telemetry enrichment resources.
", "smithy.api#http": { "method": "POST", "uri": "/TagResource" } } }, "com.amazonaws.observabilityadmin#TagResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the telemetry rule resource to tag.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapInput", "traits": { "smithy.api#documentation": "The key-value pairs to add or update for the telemetry rule resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#TagValue": { "type": "string", "traits": { "aws.api#data": "tagging", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.observabilityadmin#TelemetryConfiguration": { "type": "structure", "members": { "AccountIdentifier": { "target": "com.amazonaws.observabilityadmin#AccountIdentifier", "traits": { "smithy.api#documentation": " The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is 012345678901.
The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; Insights: NotApplicable; }.
The type of resource, for example Amazon Web Services::EC2::Instance, or Amazon Web Services::EKS::Cluster, etc.
The identifier of the resource, for example for Amazon VPC, it would be vpc-1a2b3c4d5e6f1a2b3.
Tags associated with the resource, for example { Name: \"ExampleInstance\", Environment: \"Development\" }.
The timestamp of the last change to the telemetry configuration for the resource. For example, 1728679196318.
A model representing the state of a resource within an account according to telemetry config.
" } }, "com.amazonaws.observabilityadmin#TelemetryConfigurationState": { "type": "map", "key": { "target": "com.amazonaws.observabilityadmin#TelemetryType" }, "value": { "target": "com.amazonaws.observabilityadmin#TelemetryState" } }, "com.amazonaws.observabilityadmin#TelemetryConfigurations": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#TelemetryConfiguration" } }, "com.amazonaws.observabilityadmin#TelemetryDestinationConfiguration": { "type": "structure", "members": { "DestinationType": { "target": "com.amazonaws.observabilityadmin#DestinationType", "traits": { "smithy.api#documentation": "The type of destination for the telemetry data (e.g., \"Amazon CloudWatch Logs\", \"S3\").
" } }, "DestinationPattern": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.
" } }, "RetentionInDays": { "target": "com.amazonaws.observabilityadmin#RetentionPeriodInDays", "traits": { "smithy.api#documentation": "The number of days to retain the telemetry data in the destination.
" } }, "VPCFlowLogParameters": { "target": "com.amazonaws.observabilityadmin#VPCFlowLogParameters", "traits": { "smithy.api#documentation": "Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
" } }, "CloudtrailParameters": { "target": "com.amazonaws.observabilityadmin#CloudtrailParameters", "traits": { "smithy.api#documentation": "Configuration parameters specific to Amazon Web Services CloudTrail when CloudTrail is the source type.
" } }, "ELBLoadBalancerLoggingParameters": { "target": "com.amazonaws.observabilityadmin#ELBLoadBalancerLoggingParameters", "traits": { "smithy.api#documentation": "Configuration parameters specific to ELB load balancer logging when ELB is the resource type.
" } }, "WAFLoggingParameters": { "target": "com.amazonaws.observabilityadmin#WAFLoggingParameters", "traits": { "smithy.api#documentation": "Configuration parameters specific to WAF logging when WAF is the resource type.
" } }, "LogDeliveryParameters": { "target": "com.amazonaws.observabilityadmin#LogDeliveryParameters", "traits": { "smithy.api#documentation": "The configuration parameters for log delivery when the resource type supports configurable log types, such as Amazon Bedrock Knowledge Bases, Amazon Bedrock AgentCore payment managers, or Elastic Load Balancing Application Load Balancers.
" } }, "MskMonitoringParameters": { "target": "com.amazonaws.observabilityadmin#MskMonitoringParameters", "traits": { "smithy.api#documentation": "Configuration parameters specific to MSK monitoring when MSK is the resource type.
" } }, "KmsKeyArn": { "target": "com.amazonaws.observabilityadmin#KmsKeyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer-managed Amazon Web Services KMS key used to encrypt the log groups created during telemetry rule remediation.
" } } }, "traits": { "smithy.api#documentation": "Configuration specifying where and how telemetry data should be delivered for Amazon Web Services resources.
" } }, "com.amazonaws.observabilityadmin#TelemetryEnrichmentStatus": { "type": "enum", "members": { "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Running" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Stopped" } }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Impaired" } } } }, "com.amazonaws.observabilityadmin#TelemetryManifest": { "type": "structure", "members": { "Source": { "target": "com.amazonaws.observabilityadmin#TelemetryManifestSource", "traits": { "smithy.api#documentation": "The resources to collect telemetry from and the telemetry types to collect.
", "smithy.api#required": {} } }, "Infrastructure": { "target": "com.amazonaws.observabilityadmin#TelemetryManifestInfrastructure", "traits": { "smithy.api#documentation": "The choices for the infrastructure that the setup creates in your cloud provider, such as the subscription that contains the Event Hubs and their size. If you omit this value, the setup uses default settings. If an AzureScopeItem collects ResourceLogs, you must specify at least the Azure SubscriptionId.
Declares which resources in a cloud provider to collect telemetry from and which telemetry types to collect.
" } }, "com.amazonaws.observabilityadmin#TelemetryManifestInfrastructure": { "type": "union", "members": { "Azure": { "target": "com.amazonaws.observabilityadmin#AzureInfrastructure", "traits": { "smithy.api#documentation": "The choices for the Azure infrastructure that the setup creates.
" } } }, "traits": { "smithy.api#documentation": "The choices for the infrastructure that the setup creates. Specify one provider, which must match the provider in Source.
The Azure scope items. Each AzureScopeItem specifies a set of Azure resources and the telemetry types to collect from them. You can specify up to 100 scope items.
The resources to collect telemetry from, for one cloud provider. Specify one provider.
" } }, "com.amazonaws.observabilityadmin#TelemetryPipeline": { "type": "structure", "members": { "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The timestamp when the telemetry pipeline was created.
" } }, "LastUpdateTimeStamp": { "target": "smithy.api#Long", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The timestamp when the telemetry pipeline was last updated.
" } }, "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "aws.cloudformation#cfnMutability": "read", "smithy.api#documentation": "The Amazon Resource Name (ARN) of the telemetry pipeline.
" } }, "Name": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineName", "traits": { "aws.cloudformation#cfnAdditionalIdentifier": {}, "aws.cloudformation#cfnMutability": "create-and-read", "smithy.api#documentation": "The name of the telemetry pipeline.
" } }, "Configuration": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineConfiguration", "traits": { "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The configuration that defines how the telemetry pipeline processes data.
" } }, "Status": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineStatus", "traits": { "aws.cloudformation#cfnMutability": "read", "smithy.api#documentation": "The current status of the telemetry pipeline.
" } }, "StatusReason": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineStatusReason", "traits": { "aws.cloudformation#cfnMutability": "read", "smithy.api#documentation": "Additional information about the pipeline status, including reasons for failure states.
" } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapOutput", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The key-value pairs associated with the telemetry pipeline resource.
" } }, "LastRefreshTimeStamp": { "target": "smithy.api#Long", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The timestamp when the most recent refresh of the telemetry pipeline started. This field is only present for external-cloud pipelines that you have refreshed.
" } }, "SourceProgress": { "target": "com.amazonaws.observabilityadmin#SourceProgress", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "The progress of source activation for the telemetry pipeline. This field is only present for external-cloud pipelines.
" } }, "ConfigurationSummary": { "target": "com.amazonaws.observabilityadmin#ConfigurationSummary", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, "smithy.api#documentation": "A summary of the pipeline configuration components.
" } } }, "traits": { "smithy.api#documentation": "Represents a complete telemetry pipeline resource with configuration, status, and metadata for data processing and transformation.
" } }, "com.amazonaws.observabilityadmin#TelemetryPipelineConfiguration": { "type": "structure", "members": { "Body": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineConfigurationBody", "traits": { "smithy.api#documentation": "The pipeline configuration body that defines the data processing rules and transformations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Defines the configuration for a pipeline, including how data flows from sources through processors to destinations. The configuration is specified in YAML format and must include a valid pipeline definition with required source and sink components. This pipeline enables end-to-end telemetry data collection, transformation, and delivery while supporting optional processing steps and extensions for enhanced functionality.
The primary pipeline configuration section are:
Source: Defines where log data originates from (S3 buckets, CloudWatch Logs, third-party APIs). Each pipeline must have exactly one source.
Processors (optional): Transform, parse, and enrich log data as it flows through the pipeline. Processors are applied sequentially in the order they are defined.
Sink: Defines the destination where processed log data is sent. Each pipeline must have exactly one sink.
Extensions (optional): Provide additional functionality such as Amazon Web Services Secrets Manager integration for credential management.
For more details on each configuration section see CloudWatch pipelines User Guide. Additional comprehensive configuration examples can be found in the CreateTelemetryPipeline API docs.
" } }, "com.amazonaws.observabilityadmin#TelemetryPipelineConfigurationBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 24000 } } }, "com.amazonaws.observabilityadmin#TelemetryPipelineIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.observabilityadmin#TelemetryPipelineName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 28 }, "smithy.api#pattern": "[a-z][a-z0-9\\-]+" } }, "com.amazonaws.observabilityadmin#TelemetryPipelineResource": { "type": "resource", "identifiers": { "PipelineIdentifier": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineIdentifier" } }, "create": { "target": "com.amazonaws.observabilityadmin#CreateTelemetryPipeline" }, "read": { "target": "com.amazonaws.observabilityadmin#GetTelemetryPipeline" }, "update": { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryPipeline" }, "delete": { "target": "com.amazonaws.observabilityadmin#DeleteTelemetryPipeline" }, "list": { "target": "com.amazonaws.observabilityadmin#ListTelemetryPipelines" }, "operations": [ { "target": "com.amazonaws.observabilityadmin#StartTelemetryPipelineRefresh" } ], "traits": { "aws.api#arn": { "template": "telemetry-pipeline/{PipelineIdentifier}" }, "aws.api#taggable": { "property": "Tags" }, "aws.cloudformation#cfnResource": { "name": "TelemetryPipelines", "additionalSchemas": [ "com.amazonaws.observabilityadmin#TelemetryPipeline" ] } } }, "com.amazonaws.observabilityadmin#TelemetryPipelineStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } } } }, "com.amazonaws.observabilityadmin#TelemetryPipelineStatusReason": { "type": "structure", "members": { "Description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the pipeline status reason, providing additional context about the current state.
" } } }, "traits": { "smithy.api#documentation": "Provides detailed information about the status of a telemetry pipeline, including reasons for specific states.
" } }, "com.amazonaws.observabilityadmin#TelemetryPipelineSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineSummary" } }, "com.amazonaws.observabilityadmin#TelemetryPipelineSummary": { "type": "structure", "members": { "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the telemetry pipeline was created.
" } }, "LastUpdateTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the telemetry pipeline was last updated.
" } }, "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the telemetry pipeline.
" } }, "Name": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineName", "traits": { "smithy.api#documentation": "The name of the telemetry pipeline.
" } }, "Status": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineStatus", "traits": { "smithy.api#documentation": "The current status of the telemetry pipeline.
" } }, "Tags": { "target": "com.amazonaws.observabilityadmin#TagMapOutput", "traits": { "smithy.api#documentation": "The key-value pairs associated with the telemetry pipeline resource.
" } }, "ConfigurationSummary": { "target": "com.amazonaws.observabilityadmin#ConfigurationSummary", "traits": { "smithy.api#documentation": "A summary of the pipeline configuration components.
" } } }, "traits": { "smithy.api#documentation": "Contains summary information about a telemetry pipeline for listing operations.
" } }, "com.amazonaws.observabilityadmin#TelemetryRule": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.observabilityadmin#ResourceType", "traits": { "smithy.api#documentation": " The type of Amazon Web Services resource to configure telemetry for (for example, AWS::EC2::VPC, AWS::EKS::Cluster, AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Bedrock::KnowledgeBase, AWS::BedrockAgentCore::PaymentManager, or AWS::XRay::TransactionSearchConfig).
The type of telemetry to collect (Logs, Metrics, Traces, or Insights).
", "smithy.api#required": {} } }, "TelemetrySourceTypes": { "target": "com.amazonaws.observabilityadmin#TelemetrySourceTypes", "traits": { "smithy.api#documentation": "The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.
" } }, "DestinationConfiguration": { "target": "com.amazonaws.observabilityadmin#TelemetryDestinationConfiguration", "traits": { "smithy.api#documentation": "Configuration specifying where and how the telemetry data should be delivered.
" } }, "Scope": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The organizational scope to which the rule applies, specified using accounts or organizational units.
" } }, "SelectionCriteria": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Criteria for selecting which resources the rule applies to, such as resource tags.
" } }, "AllowFieldUpdates": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": " If set to true, Amazon CloudWatch Observability Admin detects and remediates configuration drift in telemetry resources that it manages. For example, if a VPC flow log's format, traffic type, or aggregation interval no longer matches the rule's destination configuration, the flow log is replaced with one that matches. Only Observability Admin-managed resources are updated; customer-created resources are never modified. Currently supported for AWS::EC2::VPC resources (VPC flow logs).
An optional list of Amazon Web Services Regions where this telemetry rule should be replicated. When specified, the rule is created in the home region and automatically replicated to all listed regions. Mutually exclusive with AllRegions.
If set to true, the telemetry rule is replicated to all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. When new regions become available, the rule automatically replicates to them. Mutually exclusive with Regions.
Defines how telemetry should be configured for specific Amazon Web Services resources.
" } }, "com.amazonaws.observabilityadmin#TelemetryRuleSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#TelemetryRuleSummary" } }, "com.amazonaws.observabilityadmin#TelemetryRuleSummary": { "type": "structure", "members": { "RuleName": { "target": "com.amazonaws.observabilityadmin#RuleName", "traits": { "smithy.api#documentation": "The name of the telemetry rule.
" } }, "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the telemetry rule.
" } }, "CreatedTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the telemetry rule was created.
" } }, "LastUpdateTimeStamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the telemetry rule was last modified.
" } }, "ResourceType": { "target": "com.amazonaws.observabilityadmin#ResourceType", "traits": { "smithy.api#documentation": "The type of Amazon Web Services resource the rule applies to.
" } }, "TelemetryType": { "target": "com.amazonaws.observabilityadmin#TelemetryType", "traits": { "smithy.api#documentation": "The type of telemetry (Logs, Metrics, Traces, or Insights) the rule configures.
" } }, "TelemetrySourceTypes": { "target": "com.amazonaws.observabilityadmin#TelemetrySourceTypes", "traits": { "smithy.api#documentation": "The types of telemetry sources configured for this rule, such as VPC Flow Logs or EKS audit logs. TelemetrySourceTypes must be correlated with the specific resource type.
" } } }, "traits": { "smithy.api#documentation": "A summary of a telemetry rule's key properties.
" } }, "com.amazonaws.observabilityadmin#TelemetrySourceConfigurationInput": { "type": "union", "members": { "Azure": { "target": "com.amazonaws.observabilityadmin#AzureTelemetrySourceConfigurationInput", "traits": { "smithy.api#documentation": "The configuration for a Microsoft Azure source.
" } } }, "traits": { "smithy.api#documentation": "The configuration of the third-party telemetry source that a new enrichment collects resource metadata from. Specify exactly one member.
" } }, "com.amazonaws.observabilityadmin#TelemetrySourceConfigurationOutput": { "type": "union", "members": { "Azure": { "target": "com.amazonaws.observabilityadmin#AzureTelemetrySourceConfigurationOutput", "traits": { "smithy.api#documentation": "The configuration of the Microsoft Azure source.
" } } }, "traits": { "smithy.api#documentation": "The third-party source configuration of an enrichment.
" } }, "com.amazonaws.observabilityadmin#TelemetrySourceType": { "type": "enum", "members": { "VPC_FLOW_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VPC_FLOW_LOGS" } }, "ROUTE53_RESOLVER_QUERY_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROUTE53_RESOLVER_QUERY_LOGS" } }, "EKS_AUDIT_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_AUDIT_LOGS" } }, "EKS_AUTHENTICATOR_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_AUTHENTICATOR_LOGS" } }, "EKS_CONTROLLER_MANAGER_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_CONTROLLER_MANAGER_LOGS" } }, "EKS_SCHEDULER_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_SCHEDULER_LOGS" } }, "EKS_API_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EKS_API_LOGS" } } }, "traits": { "smithy.api#documentation": "Specifies the type of telemetry source for a resource, such as EKS cluster logs.
" } }, "com.amazonaws.observabilityadmin#TelemetrySourceTypes": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#TelemetrySourceType" }, "traits": { "smithy.api#documentation": "A list of telemetry source types that specify what kind of telemetry data to collect from a resource.
" } }, "com.amazonaws.observabilityadmin#TelemetryState": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Enabled" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Disabled" } }, "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NotApplicable" } } } }, "com.amazonaws.observabilityadmin#TelemetryType": { "type": "enum", "members": { "LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Logs" } }, "METRICS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Metrics" } }, "TRACES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Traces" } }, "INSIGHTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Insights" } } } }, "com.amazonaws.observabilityadmin#TestTelemetryPipeline": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#TestTelemetryPipelineInput" }, "output": { "target": "com.amazonaws.observabilityadmin#TestTelemetryPipelineOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Tests a pipeline configuration with sample records to validate data processing before deployment. This operation helps ensure your pipeline configuration works as expected.
", "smithy.api#http": { "method": "POST", "uri": "/TestTelemetryPipeline" } } }, "com.amazonaws.observabilityadmin#TestTelemetryPipelineInput": { "type": "structure", "members": { "Records": { "target": "com.amazonaws.observabilityadmin#Records", "traits": { "smithy.api#documentation": "The sample records to process through the pipeline configuration for testing purposes.
", "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineConfiguration", "traits": { "smithy.api#documentation": "The pipeline configuration to test with the provided sample records.
", "smithy.api#required": {} } }, "SignalType": { "target": "com.amazonaws.observabilityadmin#SignalType", "traits": { "smithy.api#default": "LOG", "smithy.api#documentation": "The type of telemetry signal to test. If not specified, defaults to log processing.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#TestTelemetryPipelineOutput": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.observabilityadmin#PipelineOutputs", "traits": { "smithy.api#documentation": "The results of processing the test records through the pipeline configuration, including any outputs or errors.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentArn": { "type": "string", "traits": { "aws.api#arnReference": { "type": "AWS::ObservabilityAdmin::ThirdPartyTelemetryEnrichment" }, "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[a-z]+)*:observabilityadmin:[a-z0-9\\-]+:[0-9]{12}:telemetry-enrichments/[a-z][a-z0-9]{9,63}$" } }, "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" } }, "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentStatus": { "type": "enum", "members": { "INITIALIZING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "CloudWatch is setting up the enrichment. Some telemetry can be enriched before setup completes.
", "smithy.api#enumValue": "Initializing" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The enrichment is active. CloudWatch adds resource metadata from the telemetry source to your telemetry.
", "smithy.api#enumValue": "Running" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The enrichment is stopped. CloudWatch no longer adds resource metadata from the telemetry source to your telemetry.
", "smithy.api#enumValue": "Stopped" } }, "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The enrichment has a problem that prevents it from working as expected. StatusReason describes the problem.
The status of a third-party telemetry enrichment.
" } }, "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentSummaries": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentSummary" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentSummary": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentName", "traits": { "smithy.api#documentation": "The name of the enrichment.
" } }, "TelemetrySource": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetrySource", "traits": { "smithy.api#documentation": "The third-party telemetry source of the enrichment.
" } }, "Status": { "target": "com.amazonaws.observabilityadmin#ThirdPartyTelemetryEnrichmentStatus", "traits": { "smithy.api#documentation": "The current status of the enrichment. Valid values:
Initializing - CloudWatch is setting up the enrichment. Some telemetry can be enriched before setup completes.
Running - The enrichment is active.
Stopped - The enrichment is stopped.
Impaired - The enrichment has a problem. StatusReason describes the problem.
Summary information about a third-party telemetry enrichment, as returned by ListThirdPartyTelemetryEnrichments.
AZURE - Microsoft Azure.
A third-party telemetry source that can provide resource metadata.
" } }, "com.amazonaws.observabilityadmin#TooManyRequestsException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The request throughput limit was exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.observabilityadmin#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#UntagResourceInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes tags from a resource. Supports telemetry rule resources, telemetry pipeline resources, and third-party telemetry enrichment resources.
", "smithy.api#http": { "method": "POST", "uri": "/UntagResource" } } }, "com.amazonaws.observabilityadmin#UntagResourceInput": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the telemetry rule resource to remove tags from.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.observabilityadmin#TagKeyList", "traits": { "smithy.api#documentation": "The list of tag keys to remove from the telemetry rule resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an existing centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateCentralizationRuleForOrganization" } } }, "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the organization centralization rule to update.
", "smithy.api#required": {} } }, "Rule": { "target": "com.amazonaws.observabilityadmin#CentralizationRule", "traits": { "smithy.api#documentation": "The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#UpdateCentralizationRuleForOrganizationOutput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated organization centralization rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#UpdateDatasetIntegration": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#UpdateDatasetIntegrationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#UpdateDatasetIntegrationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a dataset integration for the caller's account in the current region. This operation is idempotent; if you submit the same update more than once, each call succeeds.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateDatasetIntegration" }, "smithy.api#idempotent": {} } }, "com.amazonaws.observabilityadmin#UpdateDatasetIntegrationInput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset integration to update.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the dataset integration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#UpdateDatasetIntegrationOutput": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated dataset integration.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role associated with the updated dataset integration.
", "smithy.api#required": {} } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was created.
", "smithy.api#required": {} } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp when the dataset integration was last updated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#UpdateTelemetryPipeline": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryPipelineInput" }, "output": { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryPipelineOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "aws.iam#iamAction": { "requiredActions": [ "iam:PassRole", "logs:DeletePipelineRule", "logs:PutPipelineRule", "cloudwatch:PutPipelineRule", "observabilityadmin:GetTelemetryPipeline", "observabilityadmin:ListTagsForResource", "observabilityadmin:TagResource", "observabilityadmin:UntagResource" ] }, "smithy.api#documentation": "Updates the configuration of an existing telemetry pipeline.
The following attributes cannot be updated after pipeline creation:
Pipeline name - The pipeline name is immutable
Pipeline ARN - The ARN is automatically generated and cannot be changed
Source type - Once a pipeline is created with a specific source type (such as S3, CloudWatch Logs, GitHub, or third-party sources), it cannot be changed to a different source type
Processors can be added, removed, or modified. However, some processors are not supported for third-party pipelines and cannot be added through updates.
Source-Specific Update Rules
Updatable: sts_role_arn
Fixed: data_source_name, data_source_type, sink (must remain @original)
Updatable: All SQS configuration parameters, sts_role_arn, codec settings, compression type, bucket ownership settings, sink log group
Fixed: notification_type, aws.region
Updatable: All Amazon Web Services Secrets Manager attributes, scope (can switch between ORGANIZATION/ENTERPRISE), organization or enterprise name, range, authentication credentials (PAT or GitHub App)
Updatable: All Amazon Web Services Secrets Manager attributes, tenant_id, workspace_id (Windows only), OAuth2 credentials (client_id, client_secret)
Updatable: All Amazon Web Services Secrets Manager attributes, domain, range, OAuth2 credentials (client_id, client_secret)
Updatable: All Amazon Web Services Secrets Manager attributes, hostname, basic authentication credentials (username, password)
Updatable: All Amazon Web Services Secrets Manager attributes, instance_url, range, OAuth2 credentials (client_id, client_secret)
Updatable: All Amazon Web Services Secrets Manager attributes, region, range, OAuth2 credentials (client_id, client_secret)
The ARN of the telemetry pipeline to update.
", "smithy.api#required": {} } }, "Configuration": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineConfiguration", "traits": { "smithy.api#documentation": "The new configuration for the telemetry pipeline, including updated sources, processors, and destinations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#UpdateTelemetryPipelineOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#UpdateTelemetryRule": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleInput" }, "output": { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#ConflictException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an existing telemetry rule in your account. If multiple users attempt to modify the same telemetry rule simultaneously, a ConflictException is returned to provide specific error information for concurrent modification scenarios.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateTelemetryRule" } } }, "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#ResourceNotFoundException" }, { "target": "com.amazonaws.observabilityadmin#ServiceQuotaExceededException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
", "smithy.api#http": { "method": "POST", "uri": "/UpdateTelemetryRuleForOrganization" } } }, "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the organization telemetry rule to update.
", "smithy.api#required": {} } }, "Rule": { "target": "com.amazonaws.observabilityadmin#TelemetryRule", "traits": { "smithy.api#documentation": "The new configuration details for the organization telemetry rule, including resource type, telemetry type, and destination configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#UpdateTelemetryRuleForOrganizationOutput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated organization telemetry rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#UpdateTelemetryRuleInput": { "type": "structure", "members": { "RuleIdentifier": { "target": "com.amazonaws.observabilityadmin#RuleIdentifier", "traits": { "smithy.api#documentation": "The identifier (name or ARN) of the telemetry rule to update.
", "smithy.api#required": {} } }, "Rule": { "target": "com.amazonaws.observabilityadmin#TelemetryRule", "traits": { "smithy.api#documentation": "The new configuration details for the telemetry rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#UpdateTelemetryRuleOutput": { "type": "structure", "members": { "RuleArn": { "target": "com.amazonaws.observabilityadmin#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated telemetry rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#VPCFlowLogParameters": { "type": "structure", "members": { "LogFormat": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The format in which VPC Flow Log entries should be logged.
" } }, "TrafficType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of traffic to log (ACCEPT, REJECT, or ALL).
" } }, "MaxAggregationInterval": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum interval in seconds between the capture of flow log records.
" } } }, "traits": { "smithy.api#documentation": "Configuration parameters specific to VPC Flow Logs.
" } }, "com.amazonaws.observabilityadmin#ValidateTelemetryPipelineConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.observabilityadmin#ValidateTelemetryPipelineConfigurationInput" }, "output": { "target": "com.amazonaws.observabilityadmin#ValidateTelemetryPipelineConfigurationOutput" }, "errors": [ { "target": "com.amazonaws.observabilityadmin#AccessDeniedException" }, { "target": "com.amazonaws.observabilityadmin#InternalServerException" }, { "target": "com.amazonaws.observabilityadmin#TooManyRequestsException" }, { "target": "com.amazonaws.observabilityadmin#ValidationException" } ], "traits": { "smithy.api#documentation": "Validates a pipeline configuration without creating the pipeline. This operation checks the configuration for syntax errors and compatibility issues.
", "smithy.api#http": { "method": "POST", "uri": "/ValidateTelemetryPipelineConfiguration" } } }, "com.amazonaws.observabilityadmin#ValidateTelemetryPipelineConfigurationInput": { "type": "structure", "members": { "Configuration": { "target": "com.amazonaws.observabilityadmin#TelemetryPipelineConfiguration", "traits": { "smithy.api#documentation": "The pipeline configuration to validate for syntax and compatibility.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.observabilityadmin#ValidateTelemetryPipelineConfigurationOutput": { "type": "structure", "members": { "Errors": { "target": "com.amazonaws.observabilityadmin#ValidationErrors", "traits": { "smithy.api#documentation": "A list of validation errors found in the pipeline configuration, if any.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.observabilityadmin#ValidationError": { "type": "structure", "members": { "Message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The error message describing the validation issue.
" } }, "Reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason code or category for the validation error.
" } }, "FieldMap": { "target": "com.amazonaws.observabilityadmin#FieldMap", "traits": { "smithy.api#documentation": "A mapping of field names to specific validation issues within the configuration.
" } } }, "traits": { "smithy.api#documentation": "Represents a detailed validation error with message, reason, and field mapping for comprehensive error reporting.
" } }, "com.amazonaws.observabilityadmin#ValidationErrors": { "type": "list", "member": { "target": "com.amazonaws.observabilityadmin#ValidationError" } }, "com.amazonaws.observabilityadmin#ValidationException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" }, "Errors": { "target": "com.amazonaws.observabilityadmin#ValidationErrors", "traits": { "smithy.api#documentation": "The errors in the input which caused the exception.
" } } }, "traits": { "smithy.api#documentation": "Indicates input validation failed. Check your request parameters and retry the request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.observabilityadmin#WAFLogType": { "type": "enum", "members": { "WAF_LOGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WAF_LOGS" } } }, "traits": { "smithy.api#documentation": "Enumeration of supported WAF log types. Currently only WAF_LOGS is supported.
" } }, "com.amazonaws.observabilityadmin#WAFLoggingParameters": { "type": "structure", "members": { "RedactedFields": { "target": "com.amazonaws.observabilityadmin#RedactedFields", "traits": { "smithy.api#documentation": "The fields to redact from WAF logs to protect sensitive information.
" } }, "LoggingFilter": { "target": "com.amazonaws.observabilityadmin#LoggingFilter", "traits": { "smithy.api#documentation": "A filter configuration that determines which WAF log records to include or exclude.
" } }, "LogType": { "target": "com.amazonaws.observabilityadmin#WAFLogType", "traits": { "smithy.api#documentation": "The type of WAF logs to collect (currently supports WAF_LOGS).
" } } }, "traits": { "smithy.api#documentation": "Configuration parameters for WAF logging, including redacted fields and logging filters.
" } } } }