CloudWatchObservabilityAdminService *********************************** Client ====== class CloudWatchObservabilityAdminService.Client A low-level client representing CloudWatch Observability Admin Service 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 configurations 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. import boto3 client = boto3.client('observabilityadmin') These are the available methods: * can_paginate * close * create_telemetry_rule * create_telemetry_rule_for_organization * delete_telemetry_rule * delete_telemetry_rule_for_organization * get_paginator * get_telemetry_evaluation_status * get_telemetry_evaluation_status_for_organization * get_telemetry_rule * get_telemetry_rule_for_organization * get_waiter * list_resource_telemetry * list_resource_telemetry_for_organization * list_tags_for_resource * list_telemetry_rules * list_telemetry_rules_for_organization * start_telemetry_evaluation * start_telemetry_evaluation_for_organization * stop_telemetry_evaluation * stop_telemetry_evaluation_for_organization * tag_resource * untag_resource * update_telemetry_rule * update_telemetry_rule_for_organization Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListResourceTelemetry * ListResourceTelemetryForOrganization * ListTelemetryRules * ListTelemetryRulesForOrganization CloudWatchObservabilityAdminService / Paginator / ListTelemetryRulesForOrganization ListTelemetryRulesForOrganization ********************************* class CloudWatchObservabilityAdminService.Paginator.ListTelemetryRulesForOrganization paginator = client.get_paginator('list_telemetry_rules_for_organization') paginate(**kwargs) Creates an iterator that will paginate through responses from " CloudWatchObservabilityAdminService.Client.list_telemetry_rules _for_organization()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RuleNamePrefix='string', SourceAccountIds=[ 'string', ], SourceOrganizationUnitIds=[ 'string', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RuleNamePrefix** (*string*) -- A string to filter organization telemetry rules whose names begin with the specified prefix. * **SourceAccountIds** (*list*) -- The list of account IDs to filter organization telemetry rules by their source accounts. * *(string) --* * **SourceOrganizationUnitIds** (*list*) -- The list of organizational unit IDs to filter organization telemetry rules by their source organizational units. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TelemetryRuleSummaries': [ { 'RuleName': 'string', 'RuleArn': 'string', 'CreatedTimeStamp': 123, 'LastUpdateTimeStamp': 123, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces' }, ], } **Response Structure** * *(dict) --* * **TelemetryRuleSummaries** *(list) --* A list of organization telemetry rule summaries. * *(dict) --* A summary of a telemetry rule's key properties. * **RuleName** *(string) --* The name of the telemetry rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the telemetry rule. * **CreatedTimeStamp** *(integer) --* The timestamp when the telemetry rule was created. * **LastUpdateTimeStamp** *(integer) --* The timestamp when the telemetry rule was last modified. * **ResourceType** *(string) --* The type of Amazon Web Services resource the rule applies to. * **TelemetryType** *(string) --* The type of telemetry (Logs, Metrics, or Traces) the rule configures. CloudWatchObservabilityAdminService / Paginator / ListResourceTelemetryForOrganization ListResourceTelemetryForOrganization ************************************ class CloudWatchObservabilityAdminService.Paginator.ListResourceTelemetryForOrganization paginator = client.get_paginator('list_resource_telemetry_for_organization') paginate(**kwargs) Creates an iterator that will paginate through responses from " CloudWatchObservabilityAdminService.Client.list_resource_teleme try_for_organization()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( AccountIdentifiers=[ 'string', ], ResourceIdentifierPrefix='string', ResourceTypes=[ 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', ], TelemetryConfigurationState={ 'string': 'Enabled'|'Disabled'|'NotApplicable' }, ResourceTags={ 'string': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **AccountIdentifiers** (*list*) -- A list of Amazon Web Services accounts used to filter the resources to those associated with the specified accounts. * *(string) --* * **ResourceIdentifierPrefix** (*string*) -- A string used to filter resources in the organization which have a "ResourceIdentifier" starting with the "ResourceIdentifierPrefix". * **ResourceTypes** (*list*) -- A list of resource types used to filter resources in the organization. If this parameter is provided, the resources will be returned in the same order used in the request. * *(string) --* * **TelemetryConfigurationState** (*dict*) -- 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. * *(string) --* * *(string) --* * **ResourceTags** (*dict*) -- 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? * *(string) --* * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TelemetryConfigurations': [ { 'AccountIdentifier': 'string', 'TelemetryConfigurationState': { 'string': 'Enabled'|'Disabled'|'NotApplicable' }, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'ResourceIdentifier': 'string', 'ResourceTags': { 'string': 'string' }, 'LastUpdateTimeStamp': 123 }, ], } **Response Structure** * *(dict) --* * **TelemetryConfigurations** *(list) --* A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization. * *(dict) --* A model representing the state of a resource within an account according to telemetry config. * **AccountIdentifier** *(string) --* The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is "012345678901". * **TelemetryConfigurationState** *(dict) --* The configuration state for the resource, for example "{ Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }". * *(string) --* * *(string) --* * **ResourceType** *(string) --* The type of resource, for example "Amazon Web Services::EC2::Instance". * **ResourceIdentifier** *(string) --* The identifier of the resource, for example "i-0b22a22eec53b9321". * **ResourceTags** *(dict) --* Tags associated with the resource, for example "{ Name: "ExampleInstance", Environment: "Development" }". * *(string) --* * *(string) --* * **LastUpdateTimeStamp** *(integer) --* The timestamp of the last change to the telemetry configuration for the resource. For example, "1728679196318". CloudWatchObservabilityAdminService / Paginator / ListTelemetryRules ListTelemetryRules ****************** class CloudWatchObservabilityAdminService.Paginator.ListTelemetryRules paginator = client.get_paginator('list_telemetry_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from " CloudWatchObservabilityAdminService.Client.list_telemetry_rules ()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RuleNamePrefix='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RuleNamePrefix** (*string*) -- A string to filter telemetry rules whose names begin with the specified prefix. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TelemetryRuleSummaries': [ { 'RuleName': 'string', 'RuleArn': 'string', 'CreatedTimeStamp': 123, 'LastUpdateTimeStamp': 123, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces' }, ], } **Response Structure** * *(dict) --* * **TelemetryRuleSummaries** *(list) --* A list of telemetry rule summaries. * *(dict) --* A summary of a telemetry rule's key properties. * **RuleName** *(string) --* The name of the telemetry rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the telemetry rule. * **CreatedTimeStamp** *(integer) --* The timestamp when the telemetry rule was created. * **LastUpdateTimeStamp** *(integer) --* The timestamp when the telemetry rule was last modified. * **ResourceType** *(string) --* The type of Amazon Web Services resource the rule applies to. * **TelemetryType** *(string) --* The type of telemetry (Logs, Metrics, or Traces) the rule configures. CloudWatchObservabilityAdminService / Paginator / ListResourceTelemetry ListResourceTelemetry ********************* class CloudWatchObservabilityAdminService.Paginator.ListResourceTelemetry paginator = client.get_paginator('list_resource_telemetry') paginate(**kwargs) Creates an iterator that will paginate through responses from " CloudWatchObservabilityAdminService.Client.list_resource_teleme try()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ResourceIdentifierPrefix='string', ResourceTypes=[ 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', ], TelemetryConfigurationState={ 'string': 'Enabled'|'Disabled'|'NotApplicable' }, ResourceTags={ 'string': 'string' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ResourceIdentifierPrefix** (*string*) -- A string used to filter resources which have a "ResourceIdentifier" starting with the "ResourceIdentifierPrefix". * **ResourceTypes** (*list*) -- A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used in the request. * *(string) --* * **TelemetryConfigurationState** (*dict*) -- 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. * *(string) --* * *(string) --* * **ResourceTags** (*dict*) -- A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags? * *(string) --* * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TelemetryConfigurations': [ { 'AccountIdentifier': 'string', 'TelemetryConfigurationState': { 'string': 'Enabled'|'Disabled'|'NotApplicable' }, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'ResourceIdentifier': 'string', 'ResourceTags': { 'string': 'string' }, 'LastUpdateTimeStamp': 123 }, ], } **Response Structure** * *(dict) --* * **TelemetryConfigurations** *(list) --* A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the caller's account. * *(dict) --* A model representing the state of a resource within an account according to telemetry config. * **AccountIdentifier** *(string) --* The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is "012345678901". * **TelemetryConfigurationState** *(dict) --* The configuration state for the resource, for example "{ Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }". * *(string) --* * *(string) --* * **ResourceType** *(string) --* The type of resource, for example "Amazon Web Services::EC2::Instance". * **ResourceIdentifier** *(string) --* The identifier of the resource, for example "i-0b22a22eec53b9321". * **ResourceTags** *(dict) --* Tags associated with the resource, for example "{ Name: "ExampleInstance", Environment: "Development" }". * *(string) --* * *(string) --* * **LastUpdateTimeStamp** *(integer) --* The timestamp of the last change to the telemetry configuration for the resource. For example, "1728679196318". CloudWatchObservabilityAdminService / Client / update_telemetry_rule update_telemetry_rule ********************* CloudWatchObservabilityAdminService.Client.update_telemetry_rule(**kwargs) Updates an existing telemetry rule in your account. See also: AWS API Documentation **Request Syntax** response = client.update_telemetry_rule( RuleIdentifier='string', Rule={ 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces', 'DestinationConfiguration': { 'DestinationType': 'cloud-watch-logs', 'DestinationPattern': 'string', 'RetentionInDays': 123, 'VPCFlowLogParameters': { 'LogFormat': 'string', 'TrafficType': 'string', 'MaxAggregationInterval': 123 } }, 'Scope': 'string', 'SelectionCriteria': 'string' } ) Parameters: * **RuleIdentifier** (*string*) -- **[REQUIRED]** The identifier (name or ARN) of the telemetry rule to update. * **Rule** (*dict*) -- **[REQUIRED]** The new configuration details for the telemetry rule. * **ResourceType** *(string) --* The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC"). * **TelemetryType** *(string) --* **[REQUIRED]** The type of telemetry to collect (Logs, Metrics, or Traces). * **DestinationConfiguration** *(dict) --* Configuration specifying where and how the telemetry data should be delivered. * **DestinationType** *(string) --* The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3"). * **DestinationPattern** *(string) --* The pattern used to generate the destination path or name, supporting macros like and . * **RetentionInDays** *(integer) --* The number of days to retain the telemetry data in the destination. * **VPCFlowLogParameters** *(dict) --* Configuration parameters specific to VPC Flow Logs when VPC is the resource type. * **LogFormat** *(string) --* The format in which VPC Flow Log entries should be logged. * **TrafficType** *(string) --* The type of traffic to log (ACCEPT, REJECT, or ALL). * **MaxAggregationInterval** *(integer) --* The maximum interval in seconds between the capture of flow log records. * **Scope** *(string) --* The organizational scope to which the rule applies, specified using accounts or organizational units. * **SelectionCriteria** *(string) --* Criteria for selecting which resources the rule applies to, such as resource tags. Return type: dict Returns: **Response Syntax** { 'RuleArn': 'string' } **Response Structure** * *(dict) --* * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the updated telemetry rule. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ServiceQu otaExceededException" * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / get_paginator get_paginator ************* CloudWatchObservabilityAdminService.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. CloudWatchObservabilityAdminService / Client / list_resource_telemetry_for_organization list_resource_telemetry_for_organization **************************************** CloudWatchObservabilityAdminService.Client.list_resource_telemetry_for_organization(**kwargs) Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization. See also: AWS API Documentation **Request Syntax** response = client.list_resource_telemetry_for_organization( AccountIdentifiers=[ 'string', ], ResourceIdentifierPrefix='string', ResourceTypes=[ 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', ], TelemetryConfigurationState={ 'string': 'Enabled'|'Disabled'|'NotApplicable' }, ResourceTags={ 'string': 'string' }, MaxResults=123, NextToken='string' ) Parameters: * **AccountIdentifiers** (*list*) -- A list of Amazon Web Services accounts used to filter the resources to those associated with the specified accounts. * *(string) --* * **ResourceIdentifierPrefix** (*string*) -- A string used to filter resources in the organization which have a "ResourceIdentifier" starting with the "ResourceIdentifierPrefix". * **ResourceTypes** (*list*) -- A list of resource types used to filter resources in the organization. If this parameter is provided, the resources will be returned in the same order used in the request. * *(string) --* * **TelemetryConfigurationState** (*dict*) -- 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. * *(string) --* * *(string) --* * **ResourceTags** (*dict*) -- 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? * *(string) --* * *(string) --* * **MaxResults** (*integer*) -- A number field used to limit the number of results within the returned list. * **NextToken** (*string*) -- The token for the next set of items to return. A previous call provides this token. Return type: dict Returns: **Response Syntax** { 'TelemetryConfigurations': [ { 'AccountIdentifier': 'string', 'TelemetryConfigurationState': { 'string': 'Enabled'|'Disabled'|'NotApplicable' }, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'ResourceIdentifier': 'string', 'ResourceTags': { 'string': 'string' }, 'LastUpdateTimeStamp': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TelemetryConfigurations** *(list) --* A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization. * *(dict) --* A model representing the state of a resource within an account according to telemetry config. * **AccountIdentifier** *(string) --* The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is "012345678901". * **TelemetryConfigurationState** *(dict) --* The configuration state for the resource, for example "{ Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }". * *(string) --* * *(string) --* * **ResourceType** *(string) --* The type of resource, for example "Amazon Web Services::EC2::Instance". * **ResourceIdentifier** *(string) --* The identifier of the resource, for example "i-0b22a22eec53b9321". * **ResourceTags** *(dict) --* Tags associated with the resource, for example "{ Name: "ExampleInstance", Environment: "Development" }". * *(string) --* * *(string) --* * **LastUpdateTimeStamp** *(integer) --* The timestamp of the last change to the telemetry configuration for the resource. For example, "1728679196318". * **NextToken** *(string) --* The token for the next set of items to return. A previous call provides this token. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / start_telemetry_evaluation_for_organization start_telemetry_evaluation_for_organization ******************************************* CloudWatchObservabilityAdminService.Client.start_telemetry_evaluation_for_organization() This actions begins onboarding the organization and all member accounts to the telemetry config feature. See also: AWS API Documentation **Request Syntax** response = client.start_telemetry_evaluation_for_organization() Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / delete_telemetry_rule_for_organization delete_telemetry_rule_for_organization ************************************** CloudWatchObservabilityAdminService.Client.delete_telemetry_rule_for_organization(**kwargs) Deletes an organization-wide telemetry 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** response = client.delete_telemetry_rule_for_organization( RuleIdentifier='string' ) Parameters: **RuleIdentifier** (*string*) -- **[REQUIRED]** The identifier (name or ARN) of the organization telemetry rule to delete. Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / can_paginate can_paginate ************ CloudWatchObservabilityAdminService.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. CloudWatchObservabilityAdminService / Client / list_telemetry_rules_for_organization list_telemetry_rules_for_organization ************************************* CloudWatchObservabilityAdminService.Client.list_telemetry_rules_for_organization(**kwargs) Lists all telemetry rules in your 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** response = client.list_telemetry_rules_for_organization( RuleNamePrefix='string', SourceAccountIds=[ 'string', ], SourceOrganizationUnitIds=[ 'string', ], MaxResults=123, NextToken='string' ) Parameters: * **RuleNamePrefix** (*string*) -- A string to filter organization telemetry rules whose names begin with the specified prefix. * **SourceAccountIds** (*list*) -- The list of account IDs to filter organization telemetry rules by their source accounts. * *(string) --* * **SourceOrganizationUnitIds** (*list*) -- The list of organizational unit IDs to filter organization telemetry rules by their source organizational units. * *(string) --* * **MaxResults** (*integer*) -- The maximum number of organization telemetry rules to return in a single call. * **NextToken** (*string*) -- The token for the next set of results. A previous call generates this token. Return type: dict Returns: **Response Syntax** { 'TelemetryRuleSummaries': [ { 'RuleName': 'string', 'RuleArn': 'string', 'CreatedTimeStamp': 123, 'LastUpdateTimeStamp': 123, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TelemetryRuleSummaries** *(list) --* A list of organization telemetry rule summaries. * *(dict) --* A summary of a telemetry rule's key properties. * **RuleName** *(string) --* The name of the telemetry rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the telemetry rule. * **CreatedTimeStamp** *(integer) --* The timestamp when the telemetry rule was created. * **LastUpdateTimeStamp** *(integer) --* The timestamp when the telemetry rule was last modified. * **ResourceType** *(string) --* The type of Amazon Web Services resource the rule applies to. * **TelemetryType** *(string) --* The type of telemetry (Logs, Metrics, or Traces) the rule configures. * **NextToken** *(string) --* A token to resume pagination of results. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / start_telemetry_evaluation start_telemetry_evaluation ************************** CloudWatchObservabilityAdminService.Client.start_telemetry_evaluation() This action begins onboarding the caller Amazon Web Services account to the telemetry config feature. See also: AWS API Documentation **Request Syntax** response = client.start_telemetry_evaluation() Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / list_resource_telemetry list_resource_telemetry *********************** CloudWatchObservabilityAdminService.Client.list_resource_telemetry(**kwargs) Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations. See also: AWS API Documentation **Request Syntax** response = client.list_resource_telemetry( ResourceIdentifierPrefix='string', ResourceTypes=[ 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', ], TelemetryConfigurationState={ 'string': 'Enabled'|'Disabled'|'NotApplicable' }, ResourceTags={ 'string': 'string' }, MaxResults=123, NextToken='string' ) Parameters: * **ResourceIdentifierPrefix** (*string*) -- A string used to filter resources which have a "ResourceIdentifier" starting with the "ResourceIdentifierPrefix". * **ResourceTypes** (*list*) -- A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used in the request. * *(string) --* * **TelemetryConfigurationState** (*dict*) -- 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. * *(string) --* * *(string) --* * **ResourceTags** (*dict*) -- A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags? * *(string) --* * *(string) --* * **MaxResults** (*integer*) -- A number field used to limit the number of results within the returned list. * **NextToken** (*string*) -- The token for the next set of items to return. A previous call generates this token. Return type: dict Returns: **Response Syntax** { 'TelemetryConfigurations': [ { 'AccountIdentifier': 'string', 'TelemetryConfigurationState': { 'string': 'Enabled'|'Disabled'|'NotApplicable' }, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'ResourceIdentifier': 'string', 'ResourceTags': { 'string': 'string' }, 'LastUpdateTimeStamp': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TelemetryConfigurations** *(list) --* A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the caller's account. * *(dict) --* A model representing the state of a resource within an account according to telemetry config. * **AccountIdentifier** *(string) --* The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is "012345678901". * **TelemetryConfigurationState** *(dict) --* The configuration state for the resource, for example "{ Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }". * *(string) --* * *(string) --* * **ResourceType** *(string) --* The type of resource, for example "Amazon Web Services::EC2::Instance". * **ResourceIdentifier** *(string) --* The identifier of the resource, for example "i-0b22a22eec53b9321". * **ResourceTags** *(dict) --* Tags associated with the resource, for example "{ Name: "ExampleInstance", Environment: "Development" }". * *(string) --* * *(string) --* * **LastUpdateTimeStamp** *(integer) --* The timestamp of the last change to the telemetry configuration for the resource. For example, "1728679196318". * **NextToken** *(string) --* The token for the next set of items to return. A previous call generates this token. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / list_tags_for_resource list_tags_for_resource ********************** CloudWatchObservabilityAdminService.Client.list_tags_for_resource(**kwargs) Lists all tags attached to the specified telemetry rule resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceARN='string' ) Parameters: **ResourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the telemetry rule resource whose tags you want to list. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* The list of tags associated with the telemetry rule resource. * *(string) --* * *(string) --* **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / untag_resource untag_resource ************** CloudWatchObservabilityAdminService.Client.untag_resource(**kwargs) Removes tags from a telemetry rule resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the telemetry rule resource to remove tags from. * **TagKeys** (*list*) -- **[REQUIRED]** The list of tag keys to remove from the telemetry rule resource. * *(string) --* Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / get_telemetry_evaluation_status get_telemetry_evaluation_status ******************************* CloudWatchObservabilityAdminService.Client.get_telemetry_evaluation_status() 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. See also: AWS API Documentation **Request Syntax** response = client.get_telemetry_evaluation_status() Return type: dict Returns: **Response Syntax** { 'Status': 'NOT_STARTED'|'STARTING'|'FAILED_START'|'RUNNING'|'STOPPING'|'FAILED_STOP'|'STOPPED', 'FailureReason': 'string' } **Response Structure** * *(dict) --* * **Status** *(string) --* The onboarding status of the telemetry config feature. * **FailureReason** *(string) --* Describes the reason for the failure status. The field will only be populated if "Status" is "FAILED_START" or "FAILED_STOP". **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / get_waiter get_waiter ********** CloudWatchObservabilityAdminService.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" CloudWatchObservabilityAdminService / Client / get_telemetry_rule get_telemetry_rule ****************** CloudWatchObservabilityAdminService.Client.get_telemetry_rule(**kwargs) Retrieves the details of a specific telemetry rule in your account. See also: AWS API Documentation **Request Syntax** response = client.get_telemetry_rule( RuleIdentifier='string' ) Parameters: **RuleIdentifier** (*string*) -- **[REQUIRED]** The identifier (name or ARN) of the telemetry rule to retrieve. Return type: dict Returns: **Response Syntax** { 'RuleName': 'string', 'RuleArn': 'string', 'CreatedTimeStamp': 123, 'LastUpdateTimeStamp': 123, 'TelemetryRule': { 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces', 'DestinationConfiguration': { 'DestinationType': 'cloud-watch-logs', 'DestinationPattern': 'string', 'RetentionInDays': 123, 'VPCFlowLogParameters': { 'LogFormat': 'string', 'TrafficType': 'string', 'MaxAggregationInterval': 123 } }, 'Scope': 'string', 'SelectionCriteria': 'string' } } **Response Structure** * *(dict) --* * **RuleName** *(string) --* The name of the telemetry rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the telemetry rule. * **CreatedTimeStamp** *(integer) --* The timestamp when the telemetry rule was created. * **LastUpdateTimeStamp** *(integer) --* The timestamp when the telemetry rule was last updated. * **TelemetryRule** *(dict) --* The configuration details of the telemetry rule. * **ResourceType** *(string) --* The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC"). * **TelemetryType** *(string) --* The type of telemetry to collect (Logs, Metrics, or Traces). * **DestinationConfiguration** *(dict) --* Configuration specifying where and how the telemetry data should be delivered. * **DestinationType** *(string) --* The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3"). * **DestinationPattern** *(string) --* The pattern used to generate the destination path or name, supporting macros like and . * **RetentionInDays** *(integer) --* The number of days to retain the telemetry data in the destination. * **VPCFlowLogParameters** *(dict) --* Configuration parameters specific to VPC Flow Logs when VPC is the resource type. * **LogFormat** *(string) --* The format in which VPC Flow Log entries should be logged. * **TrafficType** *(string) --* The type of traffic to log (ACCEPT, REJECT, or ALL). * **MaxAggregationInterval** *(integer) --* The maximum interval in seconds between the capture of flow log records. * **Scope** *(string) --* The organizational scope to which the rule applies, specified using accounts or organizational units. * **SelectionCriteria** *(string) --* Criteria for selecting which resources the rule applies to, such as resource tags. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / create_telemetry_rule_for_organization create_telemetry_rule_for_organization ************************************** CloudWatchObservabilityAdminService.Client.create_telemetry_rule_for_organization(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_telemetry_rule_for_organization( RuleName='string', Rule={ 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces', 'DestinationConfiguration': { 'DestinationType': 'cloud-watch-logs', 'DestinationPattern': 'string', 'RetentionInDays': 123, 'VPCFlowLogParameters': { 'LogFormat': 'string', 'TrafficType': 'string', 'MaxAggregationInterval': 123 } }, 'Scope': 'string', 'SelectionCriteria': 'string' }, Tags={ 'string': 'string' } ) Parameters: * **RuleName** (*string*) -- **[REQUIRED]** A unique name for the organization-wide telemetry rule being created. * **Rule** (*dict*) -- **[REQUIRED]** 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. * **ResourceType** *(string) --* The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC"). * **TelemetryType** *(string) --* **[REQUIRED]** The type of telemetry to collect (Logs, Metrics, or Traces). * **DestinationConfiguration** *(dict) --* Configuration specifying where and how the telemetry data should be delivered. * **DestinationType** *(string) --* The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3"). * **DestinationPattern** *(string) --* The pattern used to generate the destination path or name, supporting macros like and . * **RetentionInDays** *(integer) --* The number of days to retain the telemetry data in the destination. * **VPCFlowLogParameters** *(dict) --* Configuration parameters specific to VPC Flow Logs when VPC is the resource type. * **LogFormat** *(string) --* The format in which VPC Flow Log entries should be logged. * **TrafficType** *(string) --* The type of traffic to log (ACCEPT, REJECT, or ALL). * **MaxAggregationInterval** *(integer) --* The maximum interval in seconds between the capture of flow log records. * **Scope** *(string) --* The organizational scope to which the rule applies, specified using accounts or organizational units. * **SelectionCriteria** *(string) --* Criteria for selecting which resources the rule applies to, such as resource tags. * **Tags** (*dict*) -- The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'RuleArn': 'string' } **Response Structure** * *(dict) --* * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the created organization telemetry rule. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ServiceQu otaExceededException" * "CloudWatchObservabilityAdminService.Client.exceptions.ConflictE xception" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / get_telemetry_rule_for_organization get_telemetry_rule_for_organization *********************************** CloudWatchObservabilityAdminService.Client.get_telemetry_rule_for_organization(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.get_telemetry_rule_for_organization( RuleIdentifier='string' ) Parameters: **RuleIdentifier** (*string*) -- **[REQUIRED]** The identifier (name or ARN) of the organization telemetry rule to retrieve. Return type: dict Returns: **Response Syntax** { 'RuleName': 'string', 'RuleArn': 'string', 'CreatedTimeStamp': 123, 'LastUpdateTimeStamp': 123, 'TelemetryRule': { 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces', 'DestinationConfiguration': { 'DestinationType': 'cloud-watch-logs', 'DestinationPattern': 'string', 'RetentionInDays': 123, 'VPCFlowLogParameters': { 'LogFormat': 'string', 'TrafficType': 'string', 'MaxAggregationInterval': 123 } }, 'Scope': 'string', 'SelectionCriteria': 'string' } } **Response Structure** * *(dict) --* * **RuleName** *(string) --* The name of the organization telemetry rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the organization telemetry rule. * **CreatedTimeStamp** *(integer) --* The timestamp when the organization telemetry rule was created. * **LastUpdateTimeStamp** *(integer) --* The timestamp when the organization telemetry rule was last updated. * **TelemetryRule** *(dict) --* The configuration details of the organization telemetry rule. * **ResourceType** *(string) --* The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC"). * **TelemetryType** *(string) --* The type of telemetry to collect (Logs, Metrics, or Traces). * **DestinationConfiguration** *(dict) --* Configuration specifying where and how the telemetry data should be delivered. * **DestinationType** *(string) --* The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3"). * **DestinationPattern** *(string) --* The pattern used to generate the destination path or name, supporting macros like and . * **RetentionInDays** *(integer) --* The number of days to retain the telemetry data in the destination. * **VPCFlowLogParameters** *(dict) --* Configuration parameters specific to VPC Flow Logs when VPC is the resource type. * **LogFormat** *(string) --* The format in which VPC Flow Log entries should be logged. * **TrafficType** *(string) --* The type of traffic to log (ACCEPT, REJECT, or ALL). * **MaxAggregationInterval** *(integer) --* The maximum interval in seconds between the capture of flow log records. * **Scope** *(string) --* The organizational scope to which the rule applies, specified using accounts or organizational units. * **SelectionCriteria** *(string) --* Criteria for selecting which resources the rule applies to, such as resource tags. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / create_telemetry_rule create_telemetry_rule ********************* CloudWatchObservabilityAdminService.Client.create_telemetry_rule(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_telemetry_rule( RuleName='string', Rule={ 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces', 'DestinationConfiguration': { 'DestinationType': 'cloud-watch-logs', 'DestinationPattern': 'string', 'RetentionInDays': 123, 'VPCFlowLogParameters': { 'LogFormat': 'string', 'TrafficType': 'string', 'MaxAggregationInterval': 123 } }, 'Scope': 'string', 'SelectionCriteria': 'string' }, Tags={ 'string': 'string' } ) Parameters: * **RuleName** (*string*) -- **[REQUIRED]** A unique name for the telemetry rule being created. * **Rule** (*dict*) -- **[REQUIRED]** 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. * **ResourceType** *(string) --* The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC"). * **TelemetryType** *(string) --* **[REQUIRED]** The type of telemetry to collect (Logs, Metrics, or Traces). * **DestinationConfiguration** *(dict) --* Configuration specifying where and how the telemetry data should be delivered. * **DestinationType** *(string) --* The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3"). * **DestinationPattern** *(string) --* The pattern used to generate the destination path or name, supporting macros like and . * **RetentionInDays** *(integer) --* The number of days to retain the telemetry data in the destination. * **VPCFlowLogParameters** *(dict) --* Configuration parameters specific to VPC Flow Logs when VPC is the resource type. * **LogFormat** *(string) --* The format in which VPC Flow Log entries should be logged. * **TrafficType** *(string) --* The type of traffic to log (ACCEPT, REJECT, or ALL). * **MaxAggregationInterval** *(integer) --* The maximum interval in seconds between the capture of flow log records. * **Scope** *(string) --* The organizational scope to which the rule applies, specified using accounts or organizational units. * **SelectionCriteria** *(string) --* Criteria for selecting which resources the rule applies to, such as resource tags. * **Tags** (*dict*) -- The key-value pairs to associate with the telemetry rule resource for categorization and management purposes. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'RuleArn': 'string' } **Response Structure** * *(dict) --* * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the created telemetry rule. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ServiceQu otaExceededException" * "CloudWatchObservabilityAdminService.Client.exceptions.ConflictE xception" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / list_telemetry_rules list_telemetry_rules ******************** CloudWatchObservabilityAdminService.Client.list_telemetry_rules(**kwargs) Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix. See also: AWS API Documentation **Request Syntax** response = client.list_telemetry_rules( RuleNamePrefix='string', MaxResults=123, NextToken='string' ) Parameters: * **RuleNamePrefix** (*string*) -- A string to filter telemetry rules whose names begin with the specified prefix. * **MaxResults** (*integer*) -- The maximum number of telemetry rules to return in a single call. * **NextToken** (*string*) -- The token for the next set of results. A previous call generates this token. Return type: dict Returns: **Response Syntax** { 'TelemetryRuleSummaries': [ { 'RuleName': 'string', 'RuleArn': 'string', 'CreatedTimeStamp': 123, 'LastUpdateTimeStamp': 123, 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TelemetryRuleSummaries** *(list) --* A list of telemetry rule summaries. * *(dict) --* A summary of a telemetry rule's key properties. * **RuleName** *(string) --* The name of the telemetry rule. * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the telemetry rule. * **CreatedTimeStamp** *(integer) --* The timestamp when the telemetry rule was created. * **LastUpdateTimeStamp** *(integer) --* The timestamp when the telemetry rule was last modified. * **ResourceType** *(string) --* The type of Amazon Web Services resource the rule applies to. * **TelemetryType** *(string) --* The type of telemetry (Logs, Metrics, or Traces) the rule configures. * **NextToken** *(string) --* A token to resume pagination of results. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / delete_telemetry_rule delete_telemetry_rule ********************* CloudWatchObservabilityAdminService.Client.delete_telemetry_rule(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_telemetry_rule( RuleIdentifier='string' ) Parameters: **RuleIdentifier** (*string*) -- **[REQUIRED]** The identifier (name or ARN) of the telemetry rule to delete. Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / update_telemetry_rule_for_organization update_telemetry_rule_for_organization ************************************** CloudWatchObservabilityAdminService.Client.update_telemetry_rule_for_organization(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_telemetry_rule_for_organization( RuleIdentifier='string', Rule={ 'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function', 'TelemetryType': 'Logs'|'Metrics'|'Traces', 'DestinationConfiguration': { 'DestinationType': 'cloud-watch-logs', 'DestinationPattern': 'string', 'RetentionInDays': 123, 'VPCFlowLogParameters': { 'LogFormat': 'string', 'TrafficType': 'string', 'MaxAggregationInterval': 123 } }, 'Scope': 'string', 'SelectionCriteria': 'string' } ) Parameters: * **RuleIdentifier** (*string*) -- **[REQUIRED]** The identifier (name or ARN) of the organization telemetry rule to update. * **Rule** (*dict*) -- **[REQUIRED]** The new configuration details for the organization telemetry rule, including resource type, telemetry type, and destination configuration. * **ResourceType** *(string) --* The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC"). * **TelemetryType** *(string) --* **[REQUIRED]** The type of telemetry to collect (Logs, Metrics, or Traces). * **DestinationConfiguration** *(dict) --* Configuration specifying where and how the telemetry data should be delivered. * **DestinationType** *(string) --* The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3"). * **DestinationPattern** *(string) --* The pattern used to generate the destination path or name, supporting macros like and . * **RetentionInDays** *(integer) --* The number of days to retain the telemetry data in the destination. * **VPCFlowLogParameters** *(dict) --* Configuration parameters specific to VPC Flow Logs when VPC is the resource type. * **LogFormat** *(string) --* The format in which VPC Flow Log entries should be logged. * **TrafficType** *(string) --* The type of traffic to log (ACCEPT, REJECT, or ALL). * **MaxAggregationInterval** *(integer) --* The maximum interval in seconds between the capture of flow log records. * **Scope** *(string) --* The organizational scope to which the rule applies, specified using accounts or organizational units. * **SelectionCriteria** *(string) --* Criteria for selecting which resources the rule applies to, such as resource tags. Return type: dict Returns: **Response Syntax** { 'RuleArn': 'string' } **Response Structure** * *(dict) --* * **RuleArn** *(string) --* The Amazon Resource Name (ARN) of the updated organization telemetry rule. **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ServiceQu otaExceededException" * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / close close ***** CloudWatchObservabilityAdminService.Client.close() Closes underlying endpoint connections. CloudWatchObservabilityAdminService / Client / stop_telemetry_evaluation stop_telemetry_evaluation ************************* CloudWatchObservabilityAdminService.Client.stop_telemetry_evaluation() This action begins offboarding the caller Amazon Web Services account from the telemetry config feature. See also: AWS API Documentation **Request Syntax** response = client.stop_telemetry_evaluation() Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / get_telemetry_evaluation_status_for_organization get_telemetry_evaluation_status_for_organization ************************************************ CloudWatchObservabilityAdminService.Client.get_telemetry_evaluation_status_for_organization() 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. See also: AWS API Documentation **Request Syntax** response = client.get_telemetry_evaluation_status_for_organization() Return type: dict Returns: **Response Syntax** { 'Status': 'NOT_STARTED'|'STARTING'|'FAILED_START'|'RUNNING'|'STOPPING'|'FAILED_STOP'|'STOPPED', 'FailureReason': 'string' } **Response Structure** * *(dict) --* * **Status** *(string) --* The onboarding status of the telemetry config feature for the organization. * **FailureReason** *(string) --* This field describes the reason for the failure status. The field will only be populated if "Status" is "FAILED_START" or "FAILED_STOP". **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / tag_resource tag_resource ************ CloudWatchObservabilityAdminService.Client.tag_resource(**kwargs) Adds or updates tags for a telemetry rule resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceARN='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the telemetry rule resource to tag. * **Tags** (*dict*) -- **[REQUIRED]** The key-value pairs to add or update for the telemetry rule resource. * *(string) --* * *(string) --* Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.ServiceQu otaExceededException" * "CloudWatchObservabilityAdminService.Client.exceptions.ResourceN otFoundException" * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException" CloudWatchObservabilityAdminService / Client / stop_telemetry_evaluation_for_organization stop_telemetry_evaluation_for_organization ****************************************** CloudWatchObservabilityAdminService.Client.stop_telemetry_evaluation_for_organization() This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature. See also: AWS API Documentation **Request Syntax** response = client.stop_telemetry_evaluation_for_organization() Returns: None **Exceptions** * "CloudWatchObservabilityAdminService.Client.exceptions.AccessDen iedException" * "CloudWatchObservabilityAdminService.Client.exceptions.InternalS erverException" * "CloudWatchObservabilityAdminService.Client.exceptions.Validatio nException" * "CloudWatchObservabilityAdminService.Client.exceptions.TooManyRe questsException"