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.
", "operations": { "CreateTelemetryRule": "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.
", "CreateTelemetryRuleForOrganization": "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.
", "DeleteTelemetryRule": "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.
", "DeleteTelemetryRuleForOrganization": "Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.
", "GetTelemetryEvaluationStatus": "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.
", "GetTelemetryEvaluationStatusForOrganization": "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.
", "GetTelemetryRule": "Retrieves the details of a specific telemetry rule in your account.
", "GetTelemetryRuleForOrganization": "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.
", "ListResourceTelemetry": "Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.
", "ListResourceTelemetryForOrganization": "Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.
", "ListTagsForResource": "Lists all tags attached to the specified telemetry rule resource.
", "ListTelemetryRules": "Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.
", "ListTelemetryRulesForOrganization": "Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.
", "StartTelemetryEvaluation": "This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.
", "StartTelemetryEvaluationForOrganization": "This actions begins onboarding the organization and all member accounts to the telemetry config feature.
", "StopTelemetryEvaluation": "This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.
", "StopTelemetryEvaluationForOrganization": "This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.
", "TagResource": "Adds or updates tags for a telemetry rule resource.
", "UntagResource": "Removes tags from a telemetry rule resource.
", "UpdateTelemetryRule": "Updates an existing telemetry rule in your account.
", "UpdateTelemetryRuleForOrganization": "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.
" }, "shapes": { "AccessDeniedException": { "base": "Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for Amazon Web Services resources in the IAM user guide.
", "refs": { } }, "AccountIdentifier": { "base": null, "refs": { "AccountIdentifiers$member": null, "TelemetryConfiguration$AccountIdentifier": " The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is 012345678901.
A list of Amazon Web Services accounts used to filter the resources to those associated with the specified accounts.
", "ListTelemetryRulesForOrganizationInput$SourceAccountIds": "The list of account IDs to filter organization telemetry rules by their source accounts.
" } }, "ConflictException": { "base": "The requested operation conflicts with the current state of the specified resource or with another request.
", "refs": { } }, "CreateTelemetryRuleForOrganizationInput": { "base": null, "refs": { } }, "CreateTelemetryRuleForOrganizationOutput": { "base": null, "refs": { } }, "CreateTelemetryRuleInput": { "base": null, "refs": { } }, "CreateTelemetryRuleOutput": { "base": null, "refs": { } }, "DeleteTelemetryRuleForOrganizationInput": { "base": null, "refs": { } }, "DeleteTelemetryRuleInput": { "base": null, "refs": { } }, "DestinationType": { "base": null, "refs": { "TelemetryDestinationConfiguration$DestinationType": "The type of destination for the telemetry data (e.g., \"Amazon CloudWatch Logs\", \"S3\").
" } }, "FailureReason": { "base": null, "refs": { "GetTelemetryEvaluationStatusForOrganizationOutput$FailureReason": " This field describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.
Describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.
The maximum interval in seconds between the capture of flow log records.
" } }, "InternalServerException": { "base": "Indicates the request has failed to process because of an unknown server error, exception, or failure.
", "refs": { } }, "ListResourceTelemetryForOrganizationInput": { "base": null, "refs": { } }, "ListResourceTelemetryForOrganizationMaxResults": { "base": null, "refs": { "ListResourceTelemetryForOrganizationInput$MaxResults": "A number field used to limit the number of results within the returned list.
" } }, "ListResourceTelemetryForOrganizationOutput": { "base": null, "refs": { } }, "ListResourceTelemetryInput": { "base": null, "refs": { } }, "ListResourceTelemetryMaxResults": { "base": null, "refs": { "ListResourceTelemetryInput$MaxResults": "A number field used to limit the number of results within the returned list.
" } }, "ListResourceTelemetryOutput": { "base": null, "refs": { } }, "ListTagsForResourceInput": { "base": null, "refs": { } }, "ListTagsForResourceOutput": { "base": null, "refs": { } }, "ListTelemetryRulesForOrganizationInput": { "base": null, "refs": { } }, "ListTelemetryRulesForOrganizationMaxResults": { "base": null, "refs": { "ListTelemetryRulesForOrganizationInput$MaxResults": "The maximum number of organization telemetry rules to return in a single call.
" } }, "ListTelemetryRulesForOrganizationOutput": { "base": null, "refs": { } }, "ListTelemetryRulesInput": { "base": null, "refs": { } }, "ListTelemetryRulesMaxResults": { "base": null, "refs": { "ListTelemetryRulesInput$MaxResults": "The maximum number of telemetry rules to return in a single call.
" } }, "ListTelemetryRulesOutput": { "base": null, "refs": { } }, "Long": { "base": null, "refs": { "GetTelemetryRuleForOrganizationOutput$CreatedTimeStamp": "The timestamp when the organization telemetry rule was created.
", "GetTelemetryRuleForOrganizationOutput$LastUpdateTimeStamp": "The timestamp when the organization telemetry rule was last updated.
", "GetTelemetryRuleOutput$CreatedTimeStamp": "The timestamp when the telemetry rule was created.
", "GetTelemetryRuleOutput$LastUpdateTimeStamp": "The timestamp when the telemetry rule was last updated.
", "TelemetryConfiguration$LastUpdateTimeStamp": " The timestamp of the last change to the telemetry configuration for the resource. For example, 1728679196318.
The timestamp when the telemetry rule was created.
", "TelemetryRuleSummary$LastUpdateTimeStamp": "The timestamp when the telemetry rule was last modified.
" } }, "NextToken": { "base": null, "refs": { "ListResourceTelemetryForOrganizationInput$NextToken": "The token for the next set of items to return. A previous call provides this token.
", "ListResourceTelemetryForOrganizationOutput$NextToken": "The token for the next set of items to return. A previous call provides this token.
", "ListResourceTelemetryInput$NextToken": "The token for the next set of items to return. A previous call generates this token.
", "ListResourceTelemetryOutput$NextToken": "The token for the next set of items to return. A previous call generates this token.
", "ListTelemetryRulesForOrganizationInput$NextToken": "The token for the next set of results. A previous call generates this token.
", "ListTelemetryRulesForOrganizationOutput$NextToken": "A token to resume pagination of results.
", "ListTelemetryRulesInput$NextToken": "The token for the next set of results. A previous call generates this token.
", "ListTelemetryRulesOutput$NextToken": "A token to resume pagination of results.
" } }, "OrganizationUnitIdentifier": { "base": null, "refs": { "OrganizationUnitIdentifiers$member": null } }, "OrganizationUnitIdentifiers": { "base": null, "refs": { "ListTelemetryRulesForOrganizationInput$SourceOrganizationUnitIds": "The list of organizational unit IDs to filter organization telemetry rules by their source organizational units.
" } }, "ResourceArn": { "base": null, "refs": { "CreateTelemetryRuleForOrganizationOutput$RuleArn": "The Amazon Resource Name (ARN) of the created organization telemetry rule.
", "CreateTelemetryRuleOutput$RuleArn": "The Amazon Resource Name (ARN) of the created telemetry rule.
", "GetTelemetryRuleForOrganizationOutput$RuleArn": "The Amazon Resource Name (ARN) of the organization telemetry rule.
", "GetTelemetryRuleOutput$RuleArn": "The Amazon Resource Name (ARN) of the telemetry rule.
", "ListTagsForResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the telemetry rule resource whose tags you want to list.
", "TagResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the telemetry rule resource to tag.
", "TelemetryRuleSummary$RuleArn": "The Amazon Resource Name (ARN) of the telemetry rule.
", "UntagResourceInput$ResourceARN": "The Amazon Resource Name (ARN) of the telemetry rule resource to remove tags from.
", "UpdateTelemetryRuleForOrganizationOutput$RuleArn": "The Amazon Resource Name (ARN) of the updated organization telemetry rule.
", "UpdateTelemetryRuleOutput$RuleArn": "The Amazon Resource Name (ARN) of the updated telemetry rule.
" } }, "ResourceIdentifier": { "base": null, "refs": { "TelemetryConfiguration$ResourceIdentifier": " The identifier of the resource, for example i-0b22a22eec53b9321.
A string used to filter resources in the organization which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.
A string used to filter resources which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.
The specified resource (such as a telemetry rule) could not be found.
", "refs": { } }, "ResourceType": { "base": null, "refs": { "ResourceTypes$member": null, "TelemetryConfiguration$ResourceType": " The type of resource, for example Amazon Web Services::EC2::Instance.
The type of Amazon Web Services resource to configure telemetry for (e.g., \"AWS::EC2::VPC\").
", "TelemetryRuleSummary$ResourceType": "The type of Amazon Web Services resource the rule applies to.
" } }, "ResourceTypes": { "base": null, "refs": { "ListResourceTelemetryForOrganizationInput$ResourceTypes": "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.
", "ListResourceTelemetryInput$ResourceTypes": "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.
" } }, "RetentionPeriodInDays": { "base": null, "refs": { "TelemetryDestinationConfiguration$RetentionInDays": "The number of days to retain the telemetry data in the destination.
" } }, "RuleIdentifier": { "base": null, "refs": { "DeleteTelemetryRuleForOrganizationInput$RuleIdentifier": "The identifier (name or ARN) of the organization telemetry rule to delete.
", "DeleteTelemetryRuleInput$RuleIdentifier": "The identifier (name or ARN) of the telemetry rule to delete.
", "GetTelemetryRuleForOrganizationInput$RuleIdentifier": "The identifier (name or ARN) of the organization telemetry rule to retrieve.
", "GetTelemetryRuleInput$RuleIdentifier": "The identifier (name or ARN) of the telemetry rule to retrieve.
", "UpdateTelemetryRuleForOrganizationInput$RuleIdentifier": "The identifier (name or ARN) of the organization telemetry rule to update.
", "UpdateTelemetryRuleInput$RuleIdentifier": "The identifier (name or ARN) of the telemetry rule to update.
" } }, "RuleName": { "base": null, "refs": { "CreateTelemetryRuleForOrganizationInput$RuleName": "A unique name for the organization-wide telemetry rule being created.
", "CreateTelemetryRuleInput$RuleName": "A unique name for the telemetry rule being created.
", "GetTelemetryRuleForOrganizationOutput$RuleName": "The name of the organization telemetry rule.
", "GetTelemetryRuleOutput$RuleName": "The name of the telemetry rule.
", "TelemetryRuleSummary$RuleName": "The name of the telemetry rule.
" } }, "ServiceQuotaExceededException": { "base": "The requested operation would exceed the allowed quota for the specified resource type.
", "refs": { } }, "Status": { "base": null, "refs": { "GetTelemetryEvaluationStatusForOrganizationOutput$Status": "The onboarding status of the telemetry config feature for the organization.
", "GetTelemetryEvaluationStatusOutput$Status": "The onboarding status of the telemetry config feature.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$Message": null, "AccessDeniedException$amznErrorType": "The name of the exception.
", "ConflictException$Message": null, "InternalServerException$Message": null, "InternalServerException$amznErrorType": "The name of the exception.
", "ListTelemetryRulesForOrganizationInput$RuleNamePrefix": "A string to filter organization telemetry rules whose names begin with the specified prefix.
", "ListTelemetryRulesInput$RuleNamePrefix": "A string to filter telemetry rules whose names begin with the specified prefix.
", "ResourceNotFoundException$Message": null, "ServiceQuotaExceededException$Message": null, "ServiceQuotaExceededException$amznErrorType": "The name of the exception.
", "TagMapOutput$key": null, "TagMapOutput$value": null, "TelemetryDestinationConfiguration$DestinationPattern": "The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.
", "TelemetryRule$Scope": "The organizational scope to which the rule applies, specified using accounts or organizational units.
", "TelemetryRule$SelectionCriteria": "Criteria for selecting which resources the rule applies to, such as resource tags.
", "TooManyRequestsException$Message": null, "VPCFlowLogParameters$LogFormat": "The format in which VPC Flow Log entries should be logged.
", "VPCFlowLogParameters$TrafficType": "The type of traffic to log (ACCEPT, REJECT, or ALL).
", "ValidationException$Message": null } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMapInput$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceInput$TagKeys": "The list of tag keys to remove from the telemetry rule resource.
" } }, "TagMapInput": { "base": null, "refs": { "CreateTelemetryRuleForOrganizationInput$Tags": "The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
", "CreateTelemetryRuleInput$Tags": "The key-value pairs to associate with the telemetry rule resource for categorization and management purposes.
", "ListResourceTelemetryForOrganizationInput$ResourceTags": "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?
", "ListResourceTelemetryInput$ResourceTags": "A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?
", "TagResourceInput$Tags": "The key-value pairs to add or update for the telemetry rule resource.
" } }, "TagMapOutput": { "base": null, "refs": { "ListTagsForResourceOutput$Tags": "The list of tags associated with the telemetry rule resource.
", "TelemetryConfiguration$ResourceTags": " Tags associated with the resource, for example { Name: \"ExampleInstance\", Environment: \"Development\" }.
A model representing the state of a resource within an account according to telemetry config.
", "refs": { "TelemetryConfigurations$member": null } }, "TelemetryConfigurationState": { "base": null, "refs": { "ListResourceTelemetryForOrganizationInput$TelemetryConfigurationState": "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.
", "ListResourceTelemetryInput$TelemetryConfigurationState": "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.
", "TelemetryConfiguration$TelemetryConfigurationState": " The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.
A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.
", "ListResourceTelemetryOutput$TelemetryConfigurations": "A list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the caller's account.
" } }, "TelemetryDestinationConfiguration": { "base": "Configuration specifying where and how telemetry data should be delivered for Amazon Web Services resources.
", "refs": { "TelemetryRule$DestinationConfiguration": "Configuration specifying where and how the telemetry data should be delivered.
" } }, "TelemetryRule": { "base": "Defines how telemetry should be configured for specific Amazon Web Services resources.
", "refs": { "CreateTelemetryRuleForOrganizationInput$Rule": "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.
", "CreateTelemetryRuleInput$Rule": "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.
", "GetTelemetryRuleForOrganizationOutput$TelemetryRule": "The configuration details of the organization telemetry rule.
", "GetTelemetryRuleOutput$TelemetryRule": "The configuration details of the telemetry rule.
", "UpdateTelemetryRuleForOrganizationInput$Rule": "The new configuration details for the organization telemetry rule, including resource type, telemetry type, and destination configuration.
", "UpdateTelemetryRuleInput$Rule": "The new configuration details for the telemetry rule.
" } }, "TelemetryRuleSummaries": { "base": null, "refs": { "ListTelemetryRulesForOrganizationOutput$TelemetryRuleSummaries": "A list of organization telemetry rule summaries.
", "ListTelemetryRulesOutput$TelemetryRuleSummaries": "A list of telemetry rule summaries.
" } }, "TelemetryRuleSummary": { "base": "A summary of a telemetry rule's key properties.
", "refs": { "TelemetryRuleSummaries$member": null } }, "TelemetryState": { "base": null, "refs": { "TelemetryConfigurationState$value": null } }, "TelemetryType": { "base": null, "refs": { "TelemetryConfigurationState$key": null, "TelemetryRule$TelemetryType": "The type of telemetry to collect (Logs, Metrics, or Traces).
", "TelemetryRuleSummary$TelemetryType": "The type of telemetry (Logs, Metrics, or Traces) the rule configures.
" } }, "TooManyRequestsException": { "base": "The request throughput limit was exceeded.
", "refs": { } }, "UntagResourceInput": { "base": null, "refs": { } }, "UpdateTelemetryRuleForOrganizationInput": { "base": null, "refs": { } }, "UpdateTelemetryRuleForOrganizationOutput": { "base": null, "refs": { } }, "UpdateTelemetryRuleInput": { "base": null, "refs": { } }, "UpdateTelemetryRuleOutput": { "base": null, "refs": { } }, "VPCFlowLogParameters": { "base": "Configuration parameters specific to VPC Flow Logs.
", "refs": { "TelemetryDestinationConfiguration$VPCFlowLogParameters": "Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
" } }, "ValidationException": { "base": "Indicates input validation failed. Check your request parameters and retry the request.
", "refs": { } } } }