2026/11/17 - CloudWatch Observability Admin Service - 13 new 4 updated api methods
Changes This release adds Microsoft Azure connectors, third-party telemetry enrichment and StartTelemetryPipelineRefresh, to discover Azure resources, enrich their telemetry and refresh external-cloud pipelines.
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.
See also: AWS API Documentation
Request Syntax
client.start_telemetry_pipeline_refresh(
PipelineIdentifier='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the telemetry pipeline to refresh.
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.start_third_party_telemetry_enrichment(
Name='string',
TelemetrySourceConfiguration={
'Azure': {
'AwsConfigConnectorArn': 'string'
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
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.
dict
[REQUIRED]
The third-party telemetry source to collect resource metadata from. Specify exactly one telemetry source.
Azure (dict) --
The configuration for a Microsoft Azure source.
AwsConfigConnectorArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Web Services Config connector for the Microsoft Azure tenant to collect resource metadata from.
dict
The tags to associate with the enrichment resource.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'Status': 'Initializing'|'Running'|'Stopped'|'Impaired',
'StatusReason': 'string',
'TelemetrySourceConfiguration': {
'Azure': {
'AwsConfigConnectorArn': 'string',
'ServiceLinkedRecorderArn': 'string'
}
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the enrichment.
Name (string) --
The name of the enrichment.
Status (string) --
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.
StatusReason (string) --
The reason for the current status. This field is present when the status is Impaired.
TelemetrySourceConfiguration (dict) --
The source configuration of the enrichment.
Azure (dict) --
The configuration of the Microsoft Azure source.
AwsConfigConnectorArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Config connector that the enrichment uses.
ServiceLinkedRecorderArn (string) --
The Amazon Resource Name (ARN) of the service-linked configuration recorder that CloudWatch created in your account for the enrichment.
Tags (dict) --
The tags associated with the enrichment.
(string) --
(string) --
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.
See also: AWS API Documentation
Request Syntax
client.create_connector(
ConnectorConfiguration={
'Azure': {
'TenantIdentifier': 'string',
'ClientIdentifier': 'string'
}
},
RoleArn='string',
Name='string',
Tags={
'string': 'string'
},
ClientToken='string'
)
dict
[REQUIRED]
The configuration for connecting to the third-party cloud provider.
Azure (dict) --
The configuration of a connector to Microsoft Azure.
TenantIdentifier (string) -- [REQUIRED]
The ID of the Microsoft Entra ID tenant.
ClientIdentifier (string) -- [REQUIRED]
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.
string
[REQUIRED]
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.
string
[REQUIRED]
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.
dict
The tags that you want to apply to the connector.
(string) --
(string) --
string
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.
dict
Response Syntax
{
'Connector': {
'Arn': 'string',
'Provider': 'AZURE',
'ConnectorConfiguration': {
'Azure': {
'TenantIdentifier': 'string',
'ClientIdentifier': 'string'
}
},
'RoleArn': 'string',
'Name': 'string',
'CreatedTimeStamp': 123
}
}
Response Structure
(dict) --
Connector (dict) --
The connector that this request created.
Arn (string) --
The Amazon Resource Name (ARN) of the connector.
Provider (string) --
The cloud provider that the connector connects to.
ConnectorConfiguration (dict) --
The configuration for connecting to the third-party cloud provider.
Azure (dict) --
The configuration of a connector to Microsoft Azure.
TenantIdentifier (string) --
The ID of the Microsoft Entra ID tenant.
ClientIdentifier (string) --
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.
RoleArn (string) --
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.
Name (string) --
The name of the connector.
CreatedTimeStamp (integer) --
The time when the connector was created, in milliseconds since the Unix epoch.
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.
See also: AWS API Documentation
Request Syntax
client.list_third_party_telemetry_enrichments(
Status='Initializing'|'Running'|'Stopped'|'Impaired',
TelemetrySource='Azure',
MaxResults=123,
NextToken='string'
)
string
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.
string
Returns only the enrichments for this third-party telemetry source.
integer
The maximum number of results to return in a single call. If you omit this parameter, the operation returns up to 100 results.
string
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.
dict
Response Syntax
{
'TelemetryEnrichments': [
{
'Name': 'string',
'TelemetrySource': 'Azure',
'Status': 'Initializing'|'Running'|'Stopped'|'Impaired'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TelemetryEnrichments (list) --
The enrichments in your account and Region.
(dict) --
Summary information about a third-party telemetry enrichment, as returned by ListThirdPartyTelemetryEnrichments.
Name (string) --
The name of the enrichment.
TelemetrySource (string) --
The third-party telemetry source of the enrichment.
Status (string) --
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.
NextToken (string) --
A token to resume pagination of results.
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.
See also: AWS API Documentation
Request Syntax
client.get_connector_telemetry_setup(
ConnectorIdentifier='string',
Format='BICEP'
)
string
[REQUIRED]
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
string
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.
dict
Response Syntax
{
'Artifacts': [
{
'FileName': 'string',
'Content': 'string',
'Format': 'BICEP',
'ContentType': 'string'
},
],
'RequiredPermissionsToApply': [
'string',
],
'Format': 'BICEP',
'Provider': 'AZURE',
'ManifestVersion': 123
}
Response Structure
(dict) --
Artifacts (list) --
The setup artifacts to apply in your cloud provider.
(dict) --
A setup artifact, which is one file in the requested format.
FileName (string) --
The suggested file name, for example main.bicep.
Content (string) --
The content of the artifact.
Format (string) --
The format of the artifact.
ContentType (string) --
The content type of the artifact, for example text/plain.
RequiredPermissionsToApply (list) --
The permissions or roles in your cloud provider that you need to apply the artifacts, for example Azure Contributor and User Access Administrator.
(string) --
Format (string) --
The format of the setup artifacts.
Provider (string) --
The cloud provider that the setup artifacts are for.
ManifestVersion (integer) --
The version of the telemetry manifest that the service generated the setup artifacts from.
Retrieves the telemetry manifest of a connector and its current version. If the connector has no telemetry manifest, this operation returns a ResourceNotFoundException.
See also: AWS API Documentation
Request Syntax
client.get_connector_telemetry_manifest(
ConnectorIdentifier='string'
)
string
[REQUIRED]
The connector. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
dict
Response Syntax
{
'Manifest': {
'Source': {
'Azure': [
{
'TelemetryTypes': [
'ResourceLogs'|'Metrics'|'FlowLogs',
],
'Scope': {
'Subscriptions': {
'All': {},
'Ids': [
'string',
]
},
'Regions': [
'string',
],
'ResourceTypes': [
'string',
],
'TagFilters': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'Resources': [
{
'Region': 'string',
'ResourceIds': [
'string',
]
},
]
}
},
]
},
'Infrastructure': {
'Azure': {
'SubscriptionId': 'string',
'EventHubs': [
{
'Tier': 'Standard'|'Premium',
'PartitionCount': 123
},
],
'FlowLogs': {
'CustomerManaged': {
'StorageAccounts': [
{
'Region': 'string',
'StorageAccountIds': [
'string',
]
},
]
},
'AwsManaged': {
'RetentionDays': 123
}
}
}
}
},
'Version': 123,
'LastUpdateTimeStamp': 123
}
Response Structure
(dict) --
Manifest (dict) --
The telemetry manifest.
Source (dict) --
The resources to collect telemetry from and the telemetry types to collect.
Azure (list) --
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.
(dict) --
The telemetry types to collect from a set of Azure resources.
TelemetryTypes (list) --
The telemetry types to collect.
(string) --
Scope (dict) --
The Azure resources to collect telemetry from.
Subscriptions (dict) --
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.
All (dict) --
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 (list) --
A list of 1–1000 subscription IDs.
(string) --
Regions (list) --
The Azure Regions to find resources in. Required when you use Subscriptions and ResourceTypes.
(string) --
ResourceTypes (list) --
The Azure resource types to find. Required when you use Subscriptions and Regions.
(string) --
TagFilters (list) --
Limits the resources found by Subscriptions, Regions, and ResourceTypes to those that have these tags. You can specify up to 50 filters.
(dict) --
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.
Key (string) --
The tag key. Up to 512 characters. The characters < > % & ? / $ { } ' " ` and control characters aren't allowed.
Values (list) --
The tag values to match. A resource matches if it has any of these values for the tag key.
(string) --
Resources (list) --
Specific Azure resources, listed by Azure Region.
(dict) --
Azure resources in one Azure Region.
Region (string) --
The Azure Region of the resources, for example eastus. Required because an Azure resource ID doesn't include the Region.
ResourceIds (list) --
The Azure Resource Manager IDs of the resources.
(string) --
Infrastructure (dict) --
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.
Azure (dict) --
The choices for the Azure infrastructure that the setup creates.
SubscriptionId (string) --
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.
EventHubs (list) --
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.
(dict) --
Configuration of the Azure Event Hubs that the setup creates to deliver resource logs.
Tier (string) --
The Event Hubs namespace tier.
PartitionCount (integer) --
The number of partitions in each Event Hub. The Standard tier allows 1–32 partitions and the Premium tier allows 1–100. On the Standard tier, you can't change this value after the setup creates the Event Hub.
FlowLogs (dict) --
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.
CustomerManaged (dict) --
Use your existing Storage Accounts that already store Flow Logs.
StorageAccounts (list) --
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.
(dict) --
The Azure Storage Accounts in one Azure Region that store Flow Logs.
Region (string) --
The Azure Region of the Storage Accounts, for example eastus.
StorageAccountIds (list) --
The Azure Resource Manager IDs of the Storage Accounts.
(string) --
AwsManaged (dict) --
Create one Storage Account in each Azure Region that ingests Flow Logs, in the subscription specified by SubscriptionId.
RetentionDays (integer) --
The number of days that the created Storage Accounts keep Flow Logs.
Version (integer) --
The current version of the telemetry manifest. Pass this value as ExpectedVersion when you next call PutConnectorTelemetryManifest.
LastUpdateTimeStamp (integer) --
The time when the telemetry manifest was last updated, in milliseconds since the Unix epoch.
Retrieves the details of a connector.
See also: AWS API Documentation
Request Syntax
client.get_connector(
ConnectorIdentifier='string'
)
string
[REQUIRED]
The connector. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
dict
Response Syntax
{
'Connector': {
'Arn': 'string',
'Provider': 'AZURE',
'ConnectorConfiguration': {
'Azure': {
'TenantIdentifier': 'string',
'ClientIdentifier': 'string'
}
},
'RoleArn': 'string',
'Name': 'string',
'CreatedTimeStamp': 123
}
}
Response Structure
(dict) --
Connector (dict) --
The connector.
Arn (string) --
The Amazon Resource Name (ARN) of the connector.
Provider (string) --
The cloud provider that the connector connects to.
ConnectorConfiguration (dict) --
The configuration for connecting to the third-party cloud provider.
Azure (dict) --
The configuration of a connector to Microsoft Azure.
TenantIdentifier (string) --
The ID of the Microsoft Entra ID tenant.
ClientIdentifier (string) --
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.
RoleArn (string) --
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.
Name (string) --
The name of the connector.
CreatedTimeStamp (integer) --
The time when the connector was created, in milliseconds since the Unix epoch.
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.
See also: AWS API Documentation
Request Syntax
client.list_resources_by_connector(
ConnectorIdentifier='string',
Selector={
'Azure': {
'ManagementGroups': {
'ParentManagementGroupId': 'string'
},
'Subscriptions': {
'ManagementGroupId': 'string'
},
'ResourceTypes': {
'Scope': {
'ManagementGroupId': 'string',
'SubscriptionIds': [
'string',
]
}
},
'Regions': {
'Scope': {
'ManagementGroupId': 'string',
'SubscriptionIds': [
'string',
]
}
},
'ResourceIds': {
'Scope': {
'ManagementGroupId': 'string',
'SubscriptionIds': [
'string',
]
},
'ResourceType': 'string',
'Region': 'string',
'TagFilters': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
'EventHubs': {
'Scope': {
'ManagementGroupId': 'string',
'SubscriptionIds': [
'string',
]
},
'NamespaceName': 'string',
'Region': 'string'
}
}
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
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
dict
[REQUIRED]
What to list: one cloud provider, and one type of resource in that provider.
Azure (dict) --
The type of Azure resource to list.
ManagementGroups (dict) --
Lists Azure management groups.
ParentManagementGroupId (string) --
Lists the management groups under this management group. If you omit this value, the query starts at the tenant root group.
Subscriptions (dict) --
Lists Azure subscriptions.
ManagementGroupId (string) --
Limits the results to subscriptions under this management group.
ResourceTypes (dict) --
Lists the Azure resource types that have resources in scope.
Scope (dict) --
Limits the query to a management group or to specific subscriptions.
ManagementGroupId (string) --
Limits the query to resources under this management group.
SubscriptionIds (list) --
Limits the query to these subscriptions. You can specify 1–1000 subscriptions.
(string) --
Regions (dict) --
Lists the Azure Regions that have resources in scope.
Scope (dict) --
Limits the query to a management group or to specific subscriptions.
ManagementGroupId (string) --
Limits the query to resources under this management group.
SubscriptionIds (list) --
Limits the query to these subscriptions. You can specify 1–1000 subscriptions.
(string) --
ResourceIds (dict) --
Lists Azure resources.
Scope (dict) --
Limits the query to a management group or to specific subscriptions.
ManagementGroupId (string) --
Limits the query to resources under this management group.
SubscriptionIds (list) --
Limits the query to these subscriptions. You can specify 1–1000 subscriptions.
(string) --
ResourceType (string) --
Limits the results to one Azure resource type, for example Microsoft.Compute/virtualMachines.
Region (string) --
Limits the results to one Azure Region, for example eastus.
TagFilters (list) --
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.
(dict) --
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.
Key (string) -- [REQUIRED]
The tag key. Up to 512 characters. The characters < > % & ? / $ { } ' " ` and control characters aren't allowed.
Values (list) -- [REQUIRED]
The tag values to match. A resource matches if it has any of these values for the tag key.
(string) --
EventHubs (dict) --
Lists Azure Event Hubs.
Scope (dict) --
Limits the query to a management group or to specific subscriptions.
ManagementGroupId (string) --
Limits the query to resources under this management group.
SubscriptionIds (list) --
Limits the query to these subscriptions. You can specify 1–1000 subscriptions.
(string) --
NamespaceName (string) --
Limits the results to Event Hubs in this namespace.
Region (string) --
Limits the results to one Azure Region, for example eastus.
integer
The maximum number of results to return in one call. For an EventHubs query, a page can contain more results than this value.
string
The token for the next page of results, returned by a previous call.
dict
Response Syntax
{
'Results': {
'Azure': {
'ManagementGroups': [
{
'Id': 'string',
'Name': 'string',
'DisplayName': 'string'
},
],
'Subscriptions': [
{
'SubscriptionId': 'string',
'DisplayName': 'string',
'State': 'string',
'ManagementGroupId': 'string'
},
],
'ResourceTypes': [
'string',
],
'Regions': [
'string',
],
'ResourceIds': [
{
'ResourceId': 'string',
'ResourceType': 'string',
'Region': 'string',
'SubscriptionId': 'string',
'Tags': {
'string': 'string'
}
},
],
'EventHubs': [
{
'ResourceId': 'string',
'EventHubName': 'string',
'NamespaceName': 'string',
'FullyQualifiedNamespace': 'string',
'Region': 'string',
'SubscriptionId': 'string'
},
]
}
},
'NextToken': 'string'
}
Response Structure
(dict) --
Results (dict) --
The results, in the same shape as the Selector that you specified.
Azure (dict) --
The results of an Azure discovery query.
ManagementGroups (list) --
The Azure management groups.
(dict) --
Information about an Azure management group.
Id (string) --
The ID of the management group.
Name (string) --
The name of the management group.
DisplayName (string) --
The display name of the management group.
Subscriptions (list) --
The Azure subscriptions.
(dict) --
Information about an Azure subscription.
SubscriptionId (string) --
The ID of the subscription.
DisplayName (string) --
The display name of the subscription.
State (string) --
The state of the subscription in Azure, for example Enabled.
ManagementGroupId (string) --
The ID of the management group that contains the subscription.
ResourceTypes (list) --
The Azure resource types.
(string) --
Regions (list) --
The Azure Regions.
(string) --
ResourceIds (list) --
The Azure resources.
(dict) --
Information about an Azure resource.
ResourceId (string) --
The Azure Resource Manager ID of the resource.
ResourceType (string) --
The Azure resource type, for example Microsoft.Compute/virtualMachines.
Region (string) --
The Azure Region of the resource, for example eastus.
SubscriptionId (string) --
The Azure subscription that contains the resource.
Tags (dict) --
The tags on the resource. Absent if the resource has no tags.
(string) --
(string) --
EventHubs (list) --
The Azure Event Hubs.
(dict) --
Information about an Azure Event Hub.
ResourceId (string) --
The Azure Resource Manager ID of the Event Hub.
EventHubName (string) --
The name of the Event Hub.
NamespaceName (string) --
The name of the Event Hubs namespace that contains the Event Hub.
FullyQualifiedNamespace (string) --
The fully qualified host name of the Event Hubs namespace, for example <namespace>.servicebus.windows.net. The suffix differs in sovereign clouds.
Region (string) --
The Azure Region of the Event Hub, for example eastus.
SubscriptionId (string) --
The Azure subscription that contains the Event Hub.
NextToken (string) --
The token to use in the next call to get the next page of results. Absent when there are no more results.
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.
See also: AWS API Documentation
Request Syntax
client.put_connector_telemetry_manifest(
ConnectorIdentifier='string',
Manifest={
'Source': {
'Azure': [
{
'TelemetryTypes': [
'ResourceLogs'|'Metrics'|'FlowLogs',
],
'Scope': {
'Subscriptions': {
'All': {}
,
'Ids': [
'string',
]
},
'Regions': [
'string',
],
'ResourceTypes': [
'string',
],
'TagFilters': [
{
'Key': 'string',
'Values': [
'string',
]
},
],
'Resources': [
{
'Region': 'string',
'ResourceIds': [
'string',
]
},
]
}
},
]
},
'Infrastructure': {
'Azure': {
'SubscriptionId': 'string',
'EventHubs': [
{
'Tier': 'Standard'|'Premium',
'PartitionCount': 123
},
],
'FlowLogs': {
'CustomerManaged': {
'StorageAccounts': [
{
'Region': 'string',
'StorageAccountIds': [
'string',
]
},
]
},
'AwsManaged': {
'RetentionDays': 123
}
}
}
}
},
ExpectedVersion=123,
ClientToken='string'
)
string
[REQUIRED]
The connector. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
dict
[REQUIRED]
The telemetry manifest.
Source (dict) -- [REQUIRED]
The resources to collect telemetry from and the telemetry types to collect.
Azure (list) --
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.
(dict) --
The telemetry types to collect from a set of Azure resources.
TelemetryTypes (list) -- [REQUIRED]
The telemetry types to collect.
(string) --
Scope (dict) -- [REQUIRED]
The Azure resources to collect telemetry from.
Subscriptions (dict) --
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.
All (dict) --
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 (list) --
A list of 1–1000 subscription IDs.
(string) --
Regions (list) --
The Azure Regions to find resources in. Required when you use Subscriptions and ResourceTypes.
(string) --
ResourceTypes (list) --
The Azure resource types to find. Required when you use Subscriptions and Regions.
(string) --
TagFilters (list) --
Limits the resources found by Subscriptions, Regions, and ResourceTypes to those that have these tags. You can specify up to 50 filters.
(dict) --
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.
Key (string) -- [REQUIRED]
The tag key. Up to 512 characters. The characters < > % & ? / $ { } ' " ` and control characters aren't allowed.
Values (list) -- [REQUIRED]
The tag values to match. A resource matches if it has any of these values for the tag key.
(string) --
Resources (list) --
Specific Azure resources, listed by Azure Region.
(dict) --
Azure resources in one Azure Region.
Region (string) -- [REQUIRED]
The Azure Region of the resources, for example eastus. Required because an Azure resource ID doesn't include the Region.
ResourceIds (list) -- [REQUIRED]
The Azure Resource Manager IDs of the resources.
(string) --
Infrastructure (dict) --
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.
Azure (dict) --
The choices for the Azure infrastructure that the setup creates.
SubscriptionId (string) --
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.
EventHubs (list) --
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.
(dict) --
Configuration of the Azure Event Hubs that the setup creates to deliver resource logs.
Tier (string) -- [REQUIRED]
The Event Hubs namespace tier.
PartitionCount (integer) -- [REQUIRED]
The number of partitions in each Event Hub. The Standard tier allows 1–32 partitions and the Premium tier allows 1–100. On the Standard tier, you can't change this value after the setup creates the Event Hub.
FlowLogs (dict) --
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.
CustomerManaged (dict) --
Use your existing Storage Accounts that already store Flow Logs.
StorageAccounts (list) -- [REQUIRED]
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.
(dict) --
The Azure Storage Accounts in one Azure Region that store Flow Logs.
Region (string) -- [REQUIRED]
The Azure Region of the Storage Accounts, for example eastus.
StorageAccountIds (list) -- [REQUIRED]
The Azure Resource Manager IDs of the Storage Accounts.
(string) --
AwsManaged (dict) --
Create one Storage Account in each Azure Region that ingests Flow Logs, in the subscription specified by SubscriptionId.
RetentionDays (integer) -- [REQUIRED]
The number of days that the created Storage Accounts keep Flow Logs.
integer
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.
string
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.
dict
Response Syntax
{
'Version': 123
}
Response Structure
(dict) --
Version (integer) --
The version of the telemetry manifest after this update.
Deletes a connector and its telemetry manifest.
See also: AWS API Documentation
Request Syntax
client.delete_connector(
ConnectorIdentifier='string'
)
string
[REQUIRED]
The connector to delete. Specify one of the following:
The Amazon Resource Name (ARN) of the connector
The ID of the connector
dict
Response Syntax
{}
Response Structure
(dict) --
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.
See also: AWS API Documentation
Request Syntax
client.stop_third_party_telemetry_enrichment(
TelemetryEnrichmentIdentifier='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'Name': 'string',
'TelemetrySource': 'Azure',
'Status': 'Initializing'|'Running'|'Stopped'|'Impaired',
'StatusReason': 'string'
}
Response Structure
(dict) --
Name (string) --
The name of the enrichment.
TelemetrySource (string) --
The third-party telemetry source of the enrichment.
Status (string) --
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.
StatusReason (string) --
The reason for the current status. This field is present when the status is Impaired.
Returns the details of a third-party telemetry enrichment, including its status and source configuration.
See also: AWS API Documentation
Request Syntax
client.get_third_party_telemetry_enrichment(
TelemetryEnrichmentIdentifier='string'
)
string
[REQUIRED]
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.
dict
Response Syntax
{
'Arn': 'string',
'Name': 'string',
'Status': 'Initializing'|'Running'|'Stopped'|'Impaired',
'StatusReason': 'string',
'TelemetrySourceConfiguration': {
'Azure': {
'AwsConfigConnectorArn': 'string',
'ServiceLinkedRecorderArn': 'string'
}
},
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the enrichment.
Name (string) --
The name of the enrichment.
Status (string) --
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.
StatusReason (string) --
The reason for the current status. This field is present when the status is Impaired.
TelemetrySourceConfiguration (dict) --
The source configuration of the enrichment.
Azure (dict) --
The configuration of the Microsoft Azure source.
AwsConfigConnectorArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Config connector that the enrichment uses.
ServiceLinkedRecorderArn (string) --
The Amazon Resource Name (ARN) of the service-linked configuration recorder that CloudWatch created in your account for the enrichment.
Tags (dict) --
The tags associated with the enrichment.
(string) --
(string) --
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.
See also: AWS API Documentation
Request Syntax
client.list_connectors(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of connectors to return in one call. The default is 100.
string
The token for the next page of results, returned by a previous call.
dict
Response Syntax
{
'ConnectorSummaries': [
{
'Arn': 'string',
'Provider': 'AZURE',
'Name': 'string',
'CreatedTimeStamp': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConnectorSummaries (list) --
The connectors in the account and Region.
(dict) --
Summary information about a connector.
Arn (string) --
The Amazon Resource Name (ARN) of the connector.
Provider (string) --
The cloud provider that the connector connects to.
Name (string) --
The name of the connector.
CreatedTimeStamp (integer) --
The time when the connector was created, in milliseconds since the Unix epoch.
NextToken (string) --
The token to use in the next call to get the next page of results. Absent when there are no more results.
{'Rule': {'Destination': {'DestinationProfilesConfiguration': {'BackupConfiguration': {'Region': 'string'}}},
'Source': {'SourceProfilesConfiguration': {'ProfilesSelectionCriteria': 'string'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.create_centralization_rule_for_organization(
RuleName='string',
Rule={
'Source': {
'Regions': [
'string',
],
'Scope': 'string',
'SourceLogsConfiguration': {
'LogGroupSelectionCriteria': 'string',
'DataSourceSelectionCriteria': 'string',
'EncryptedLogGroupStrategy': 'ALLOW'|'SKIP'
},
'SourceMetricsConfiguration': {
'MetricsSelectionCriteria': 'string'
},
'SourceProfilesConfiguration': {
'ProfilesSelectionCriteria': 'string'
},
'SourceContextGraphConfiguration': {}
},
'Destination': {
'Region': 'string',
'Account': 'string',
'DestinationLogsConfiguration': {
'LogsEncryptionConfiguration': {
'EncryptionStrategy': 'CUSTOMER_MANAGED'|'AWS_OWNED',
'KmsKeyArn': 'string',
'EncryptionConflictResolutionStrategy': 'ALLOW'|'SKIP',
'EncryptionScope': 'ENCRYPTED_SOURCE_ONLY'|'NEW_DESTINATION_LOG_GROUPS'
},
'BackupConfiguration': {
'Region': 'string',
'KmsKeyArn': 'string'
},
'LogGroupNameConfiguration': {
'LogGroupNamePattern': 'string'
},
'TagPropagationConfiguration': {
'DestinationRoleArn': 'string',
'TagConflictResolutionStrategy': 'IN_SYNC'|'ADD_ONLY'|'UPDATE_SYNC'
},
'LogGroupDeletionProtection': 'ENABLED'
},
'DestinationMetricsConfiguration': {
'BackupConfiguration': {
'Region': 'string'
}
},
'DestinationProfilesConfiguration': {
'BackupConfiguration': {
'Region': 'string'
}
}
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
A unique name for the organization-wide centralization rule being created.
dict
[REQUIRED]
The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
Source (dict) -- [REQUIRED]
Configuration determining the source of the telemetry data to be centralized.
Regions (list) -- [REQUIRED]
The list of source regions from which telemetry data should be centralized.
(string) --
Scope (string) --
The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
SourceLogsConfiguration (dict) --
Log specific configuration for centralization source log groups.
LogGroupSelectionCriteria (string) --
The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
DataSourceSelectionCriteria (string) --
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.
EncryptedLogGroupStrategy (string) -- [REQUIRED]
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.
SourceMetricsConfiguration (dict) --
Metric specific configuration for centralization source metrics.
MetricsSelectionCriteria (string) --
The filter expression that selects which source metrics to centralize. Currently, only * (all metrics) is supported. Other values return a validation error.
SourceProfilesConfiguration (dict) --
Profile-specific configuration for centralization source profiles.
ProfilesSelectionCriteria (string) --
The filter expression that selects which source profiles to centralize.
SourceContextGraphConfiguration (dict) --
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.
Destination (dict) -- [REQUIRED]
Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
Region (string) -- [REQUIRED]
The primary destination region to which telemetry data should be centralized.
Account (string) --
The destination account (within the organization) to which the telemetry data should be centralized.
DestinationLogsConfiguration (dict) --
Log specific configuration for centralization destination log groups.
LogsEncryptionConfiguration (dict) --
The encryption configuration for centralization destination log groups.
EncryptionStrategy (string) -- [REQUIRED]
Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
KmsKeyArn (string) --
KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
EncryptionConflictResolutionStrategy (string) --
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 (string) --
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.
BackupConfiguration (dict) --
Configuration defining the backup region and an optional KMS key for the backup destination.
Region (string) -- [REQUIRED]
Logs specific backup destination region within the primary destination account to which log data should be centralized.
KmsKeyArn (string) --
KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
LogGroupNameConfiguration (dict) --
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.
LogGroupNamePattern (string) -- [REQUIRED]
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} — The original log group name from the source account.
${source.accountId} — The Amazon Web Services account ID where the log originated.
${source.region} — The Amazon Web Services Region where the log originated.
${source.org.id} — The Amazon Web Services Organization ID of the source account.
${source.org.ouId} — The organizational unit ID of the source account.
${source.org.rootId} — The organization Root ID.
${source.org.path} — The organizational path from account to root.
TagPropagationConfiguration (dict) --
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}.
DestinationRoleArn (string) -- [REQUIRED]
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.
TagConflictResolutionStrategy (string) --
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 – Only adds new tags from the source without modifying existing destination tags.
UPDATE_SYNC – Adds new tags and updates existing tags from the source. Does not remove destination tags that are absent from the source.
IN_SYNC – Keeps destination tags fully synchronized with source tags, including removing destination tags that do not exist on the source.
LogGroupDeletionProtection (string) --
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.
DestinationMetricsConfiguration (dict) --
Metric specific configuration for centralization destination metrics.
BackupConfiguration (dict) --
Configuration defining the backup region for the metrics backup destination.
Region (string) -- [REQUIRED]
Metrics specific backup destination region within the primary destination account to which metrics data should be centralized.
DestinationProfilesConfiguration (dict) --
Profile-specific configuration for centralization destination profiles.
BackupConfiguration (dict) --
Configuration that defines the backup Region for the profiles backup destination.
Region (string) -- [REQUIRED]
The backup Region for profiles, within the primary destination account, to which the service centralizes profiles data.
dict
The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
(string) --
(string) --
dict
Response Syntax
{
'RuleArn': 'string'
}
Response Structure
(dict) --
RuleArn (string) --
The Amazon Resource Name (ARN) of the created organization centralization rule.
{'CentralizationRule': {'Destination': {'DestinationProfilesConfiguration': {'BackupConfiguration': {'Region': 'string'}}},
'Source': {'SourceProfilesConfiguration': {'ProfilesSelectionCriteria': 'string'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.get_centralization_rule_for_organization(
RuleIdentifier='string'
)
string
[REQUIRED]
The identifier (name or ARN) of the organization centralization rule to retrieve.
dict
Response Syntax
{
'RuleName': 'string',
'RuleArn': 'string',
'CreatorAccountId': 'string',
'CreatedTimeStamp': 123,
'CreatedRegion': 'string',
'LastUpdateTimeStamp': 123,
'RuleHealth': 'Healthy'|'Unhealthy'|'Provisioning',
'FailureReason': 'TRUSTED_ACCESS_NOT_ENABLED'|'DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION'|'INTERNAL_SERVER_ERROR',
'TagPropagationStatus': 'Healthy'|'Unhealthy',
'TagPropagationFailureReason': 'RoleNotAssumable'|'RoleLacksPermissions',
'ContextGraphStatus': 'Healthy'|'Unhealthy'|'Provisioning',
'CentralizationRule': {
'Source': {
'Regions': [
'string',
],
'Scope': 'string',
'SourceLogsConfiguration': {
'LogGroupSelectionCriteria': 'string',
'DataSourceSelectionCriteria': 'string',
'EncryptedLogGroupStrategy': 'ALLOW'|'SKIP'
},
'SourceMetricsConfiguration': {
'MetricsSelectionCriteria': 'string'
},
'SourceProfilesConfiguration': {
'ProfilesSelectionCriteria': 'string'
},
'SourceContextGraphConfiguration': {}
},
'Destination': {
'Region': 'string',
'Account': 'string',
'DestinationLogsConfiguration': {
'LogsEncryptionConfiguration': {
'EncryptionStrategy': 'CUSTOMER_MANAGED'|'AWS_OWNED',
'KmsKeyArn': 'string',
'EncryptionConflictResolutionStrategy': 'ALLOW'|'SKIP',
'EncryptionScope': 'ENCRYPTED_SOURCE_ONLY'|'NEW_DESTINATION_LOG_GROUPS'
},
'BackupConfiguration': {
'Region': 'string',
'KmsKeyArn': 'string'
},
'LogGroupNameConfiguration': {
'LogGroupNamePattern': 'string'
},
'TagPropagationConfiguration': {
'DestinationRoleArn': 'string',
'TagConflictResolutionStrategy': 'IN_SYNC'|'ADD_ONLY'|'UPDATE_SYNC'
},
'LogGroupDeletionProtection': 'ENABLED'
},
'DestinationMetricsConfiguration': {
'BackupConfiguration': {
'Region': 'string'
}
},
'DestinationProfilesConfiguration': {
'BackupConfiguration': {
'Region': 'string'
}
}
}
}
}
Response Structure
(dict) --
RuleName (string) --
The name of the organization centralization rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the organization centralization rule.
CreatorAccountId (string) --
The Amazon Web Services Account that created the organization centralization rule.
CreatedTimeStamp (integer) --
The timestamp when the organization centralization rule was created.
CreatedRegion (string) --
The Amazon Web Services region where the organization centralization rule was created.
LastUpdateTimeStamp (integer) --
The timestamp when the organization centralization rule was last updated.
RuleHealth (string) --
The health status of the organization centralization rule.
FailureReason (string) --
The reason why an organization centralization rule is marked UNHEALTHY.
TagPropagationStatus (string) --
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.
TagPropagationFailureReason (string) --
The reason tag propagation is unhealthy for this rule. Only present when TagPropagationStatus is Unhealthy.
ContextGraphStatus (string) --
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.
CentralizationRule (dict) --
The configuration details for the organization centralization rule.
Source (dict) --
Configuration determining the source of the telemetry data to be centralized.
Regions (list) --
The list of source regions from which telemetry data should be centralized.
(string) --
Scope (string) --
The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
SourceLogsConfiguration (dict) --
Log specific configuration for centralization source log groups.
LogGroupSelectionCriteria (string) --
The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
DataSourceSelectionCriteria (string) --
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.
EncryptedLogGroupStrategy (string) --
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.
SourceMetricsConfiguration (dict) --
Metric specific configuration for centralization source metrics.
MetricsSelectionCriteria (string) --
The filter expression that selects which source metrics to centralize. Currently, only * (all metrics) is supported. Other values return a validation error.
SourceProfilesConfiguration (dict) --
Profile-specific configuration for centralization source profiles.
ProfilesSelectionCriteria (string) --
The filter expression that selects which source profiles to centralize.
SourceContextGraphConfiguration (dict) --
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.
Destination (dict) --
Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
Region (string) --
The primary destination region to which telemetry data should be centralized.
Account (string) --
The destination account (within the organization) to which the telemetry data should be centralized.
DestinationLogsConfiguration (dict) --
Log specific configuration for centralization destination log groups.
LogsEncryptionConfiguration (dict) --
The encryption configuration for centralization destination log groups.
EncryptionStrategy (string) --
Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
KmsKeyArn (string) --
KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
EncryptionConflictResolutionStrategy (string) --
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 (string) --
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.
BackupConfiguration (dict) --
Configuration defining the backup region and an optional KMS key for the backup destination.
Region (string) --
Logs specific backup destination region within the primary destination account to which log data should be centralized.
KmsKeyArn (string) --
KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
LogGroupNameConfiguration (dict) --
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.
LogGroupNamePattern (string) --
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} — The original log group name from the source account.
${source.accountId} — The Amazon Web Services account ID where the log originated.
${source.region} — The Amazon Web Services Region where the log originated.
${source.org.id} — The Amazon Web Services Organization ID of the source account.
${source.org.ouId} — The organizational unit ID of the source account.
${source.org.rootId} — The organization Root ID.
${source.org.path} — The organizational path from account to root.
TagPropagationConfiguration (dict) --
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}.
DestinationRoleArn (string) --
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.
TagConflictResolutionStrategy (string) --
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 – Only adds new tags from the source without modifying existing destination tags.
UPDATE_SYNC – Adds new tags and updates existing tags from the source. Does not remove destination tags that are absent from the source.
IN_SYNC – Keeps destination tags fully synchronized with source tags, including removing destination tags that do not exist on the source.
LogGroupDeletionProtection (string) --
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.
DestinationMetricsConfiguration (dict) --
Metric specific configuration for centralization destination metrics.
BackupConfiguration (dict) --
Configuration defining the backup region for the metrics backup destination.
Region (string) --
Metrics specific backup destination region within the primary destination account to which metrics data should be centralized.
DestinationProfilesConfiguration (dict) --
Profile-specific configuration for centralization destination profiles.
BackupConfiguration (dict) --
Configuration that defines the backup Region for the profiles backup destination.
Region (string) --
The backup Region for profiles, within the primary destination account, to which the service centralizes profiles data.
{'Pipeline': {'ConfigurationSummary': {'DataSources': [{'Name': 'string',
'Type': 'string'}],
'ProcessorCount': 'integer',
'Processors': ['string'],
'Sinks': ['string'],
'Sources': [{'Type': 'string'}]},
'LastRefreshTimeStamp': 'long',
'SourceProgress': {'Active': 'integer', 'Total': 'integer'}}}
Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.
See also: AWS API Documentation
Request Syntax
client.get_telemetry_pipeline(
PipelineIdentifier='string'
)
string
[REQUIRED]
The identifier (name or ARN) of the telemetry pipeline to retrieve.
dict
Response Syntax
{
'Pipeline': {
'CreatedTimeStamp': 123,
'LastUpdateTimeStamp': 123,
'Arn': 'string',
'Name': 'string',
'Configuration': {
'Body': 'string'
},
'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED',
'StatusReason': {
'Description': 'string'
},
'Tags': {
'string': 'string'
},
'LastRefreshTimeStamp': 123,
'SourceProgress': {
'Active': 123,
'Total': 123
},
'ConfigurationSummary': {
'Sources': [
{
'Type': 'string'
},
],
'DataSources': [
{
'Name': 'string',
'Type': 'string'
},
],
'Processors': [
'string',
],
'ProcessorCount': 123,
'Sinks': [
'string',
]
}
}
}
Response Structure
(dict) --
Pipeline (dict) --
The complete telemetry pipeline resource information, including configuration, status, and metadata.
CreatedTimeStamp (integer) --
The timestamp when the telemetry pipeline was created.
LastUpdateTimeStamp (integer) --
The timestamp when the telemetry pipeline was last updated.
Arn (string) --
The Amazon Resource Name (ARN) of the telemetry pipeline.
Name (string) --
The name of the telemetry pipeline.
Configuration (dict) --
The configuration that defines how the telemetry pipeline processes data.
Body (string) --
The pipeline configuration body that defines the data processing rules and transformations.
Status (string) --
The current status of the telemetry pipeline.
StatusReason (dict) --
Additional information about the pipeline status, including reasons for failure states.
Description (string) --
A description of the pipeline status reason, providing additional context about the current state.
Tags (dict) --
The key-value pairs associated with the telemetry pipeline resource.
(string) --
(string) --
LastRefreshTimeStamp (integer) --
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 (dict) --
The progress of source activation for the telemetry pipeline. This field is only present for external-cloud pipelines.
Active (integer) --
The number of discovered sources that are active and sending telemetry to the pipeline.
Total (integer) --
The total number of sources discovered for the pipeline.
ConfigurationSummary (dict) --
A summary of the pipeline configuration components.
Sources (list) --
The list of data sources configured in the pipeline.
(dict) --
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.
Type (string) --
The plugin name of the source, such as cloudwatch_logs or s3.
DataSources (list) --
The list of data sources that provide telemetry data to the pipeline.
(dict) --
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.
Name (string) --
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.
Type (string) --
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.
Processors (list) --
The list of processors configured in the pipeline for data transformation.
(string) --
ProcessorCount (integer) --
The total number of processors configured in the pipeline.
Sinks (list) --
The list of destinations where processed data is sent.
(string) --
{'Rule': {'Destination': {'DestinationProfilesConfiguration': {'BackupConfiguration': {'Region': 'string'}}},
'Source': {'SourceProfilesConfiguration': {'ProfilesSelectionCriteria': 'string'}}}}
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.
See also: AWS API Documentation
Request Syntax
client.update_centralization_rule_for_organization(
RuleIdentifier='string',
Rule={
'Source': {
'Regions': [
'string',
],
'Scope': 'string',
'SourceLogsConfiguration': {
'LogGroupSelectionCriteria': 'string',
'DataSourceSelectionCriteria': 'string',
'EncryptedLogGroupStrategy': 'ALLOW'|'SKIP'
},
'SourceMetricsConfiguration': {
'MetricsSelectionCriteria': 'string'
},
'SourceProfilesConfiguration': {
'ProfilesSelectionCriteria': 'string'
},
'SourceContextGraphConfiguration': {}
},
'Destination': {
'Region': 'string',
'Account': 'string',
'DestinationLogsConfiguration': {
'LogsEncryptionConfiguration': {
'EncryptionStrategy': 'CUSTOMER_MANAGED'|'AWS_OWNED',
'KmsKeyArn': 'string',
'EncryptionConflictResolutionStrategy': 'ALLOW'|'SKIP',
'EncryptionScope': 'ENCRYPTED_SOURCE_ONLY'|'NEW_DESTINATION_LOG_GROUPS'
},
'BackupConfiguration': {
'Region': 'string',
'KmsKeyArn': 'string'
},
'LogGroupNameConfiguration': {
'LogGroupNamePattern': 'string'
},
'TagPropagationConfiguration': {
'DestinationRoleArn': 'string',
'TagConflictResolutionStrategy': 'IN_SYNC'|'ADD_ONLY'|'UPDATE_SYNC'
},
'LogGroupDeletionProtection': 'ENABLED'
},
'DestinationMetricsConfiguration': {
'BackupConfiguration': {
'Region': 'string'
}
},
'DestinationProfilesConfiguration': {
'BackupConfiguration': {
'Region': 'string'
}
}
}
}
)
string
[REQUIRED]
The identifier (name or ARN) of the organization centralization rule to update.
dict
[REQUIRED]
The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
Source (dict) -- [REQUIRED]
Configuration determining the source of the telemetry data to be centralized.
Regions (list) -- [REQUIRED]
The list of source regions from which telemetry data should be centralized.
(string) --
Scope (string) --
The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
SourceLogsConfiguration (dict) --
Log specific configuration for centralization source log groups.
LogGroupSelectionCriteria (string) --
The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
DataSourceSelectionCriteria (string) --
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.
EncryptedLogGroupStrategy (string) -- [REQUIRED]
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.
SourceMetricsConfiguration (dict) --
Metric specific configuration for centralization source metrics.
MetricsSelectionCriteria (string) --
The filter expression that selects which source metrics to centralize. Currently, only * (all metrics) is supported. Other values return a validation error.
SourceProfilesConfiguration (dict) --
Profile-specific configuration for centralization source profiles.
ProfilesSelectionCriteria (string) --
The filter expression that selects which source profiles to centralize.
SourceContextGraphConfiguration (dict) --
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.
Destination (dict) -- [REQUIRED]
Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
Region (string) -- [REQUIRED]
The primary destination region to which telemetry data should be centralized.
Account (string) --
The destination account (within the organization) to which the telemetry data should be centralized.
DestinationLogsConfiguration (dict) --
Log specific configuration for centralization destination log groups.
LogsEncryptionConfiguration (dict) --
The encryption configuration for centralization destination log groups.
EncryptionStrategy (string) -- [REQUIRED]
Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
KmsKeyArn (string) --
KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
EncryptionConflictResolutionStrategy (string) --
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 (string) --
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.
BackupConfiguration (dict) --
Configuration defining the backup region and an optional KMS key for the backup destination.
Region (string) -- [REQUIRED]
Logs specific backup destination region within the primary destination account to which log data should be centralized.
KmsKeyArn (string) --
KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
LogGroupNameConfiguration (dict) --
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.
LogGroupNamePattern (string) -- [REQUIRED]
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} — The original log group name from the source account.
${source.accountId} — The Amazon Web Services account ID where the log originated.
${source.region} — The Amazon Web Services Region where the log originated.
${source.org.id} — The Amazon Web Services Organization ID of the source account.
${source.org.ouId} — The organizational unit ID of the source account.
${source.org.rootId} — The organization Root ID.
${source.org.path} — The organizational path from account to root.
TagPropagationConfiguration (dict) --
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}.
DestinationRoleArn (string) -- [REQUIRED]
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.
TagConflictResolutionStrategy (string) --
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 – Only adds new tags from the source without modifying existing destination tags.
UPDATE_SYNC – Adds new tags and updates existing tags from the source. Does not remove destination tags that are absent from the source.
IN_SYNC – Keeps destination tags fully synchronized with source tags, including removing destination tags that do not exist on the source.
LogGroupDeletionProtection (string) --
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.
DestinationMetricsConfiguration (dict) --
Metric specific configuration for centralization destination metrics.
BackupConfiguration (dict) --
Configuration defining the backup region for the metrics backup destination.
Region (string) -- [REQUIRED]
Metrics specific backup destination region within the primary destination account to which metrics data should be centralized.
DestinationProfilesConfiguration (dict) --
Profile-specific configuration for centralization destination profiles.
BackupConfiguration (dict) --
Configuration that defines the backup Region for the profiles backup destination.
Region (string) -- [REQUIRED]
The backup Region for profiles, within the primary destination account, to which the service centralizes profiles data.
dict
Response Syntax
{
'RuleArn': 'string'
}
Response Structure
(dict) --
RuleArn (string) --
The Amazon Resource Name (ARN) of the updated organization centralization rule.