diff --git a/awscli/examples/observabilityadmin/get-telemetry-evaluation-status-for-organization.rst b/awscli/examples/observabilityadmin/get-telemetry-evaluation-status-for-organization.rst new file mode 100644 index 000000000000..59c574403504 --- /dev/null +++ b/awscli/examples/observabilityadmin/get-telemetry-evaluation-status-for-organization.rst @@ -0,0 +1,13 @@ +**To get telemetry onboarding status for the organization** + +The following ``get-telemetry-evaluation-status-for-organization`` example returns the current onboarding status of the telemetry config feature for the organization. :: + + aws observabilityadmin get-telemetry-evaluation-status-for-organization + +Output:: + + { + "Status": "RUNNING" + } + +For more information, see `Auditing CloudWatch telemetry configurations `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file diff --git a/awscli/examples/observabilityadmin/get-telemetry-evaluation-status.rst b/awscli/examples/observabilityadmin/get-telemetry-evaluation-status.rst new file mode 100644 index 000000000000..f953b8dea072 --- /dev/null +++ b/awscli/examples/observabilityadmin/get-telemetry-evaluation-status.rst @@ -0,0 +1,13 @@ +**To get telemetry onboarding status for the account** + +The following ``get-telemetry-evaluation-status`` example returns the current onboarding status of the telemetry config feature in the specified account. :: + + aws observabilityadmin get-telemetry-evaluation-status + +Output:: + + { + "Status": "RUNNING" + } + +For more information, see `Auditing CloudWatch telemetry configurations `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file diff --git a/awscli/examples/observabilityadmin/list-resource-telemetry-for-organization.rst b/awscli/examples/observabilityadmin/list-resource-telemetry-for-organization.rst new file mode 100644 index 000000000000..db79eb32d366 --- /dev/null +++ b/awscli/examples/observabilityadmin/list-resource-telemetry-for-organization.rst @@ -0,0 +1,43 @@ +**To retrieve the telemetry configurations for the organization** + +The following ``list-resource-telemetry-for-organization`` example returns a list of telemetry configurations in the organization for AWS resources supported by telemetry config. :: + + aws observabilityadmin list-resource-telemetry-for-organization \ + --resource-types AWS::EC2::Instance + +Output:: + + { + "TelemetryConfigurations": [ + { + "AccountIdentifier": "111111111111", + "TelemetryConfigurationState": { + "Logs": "NotApplicable", + "Metrics": "Disabled", + "Traces": "NotApplicable" + }, + "ResourceType": "AWS::EC2::Instance", + "ResourceIdentifier": "i-a166400b", + "ResourceTags": { + "Name": "dev" + }, + "LastUpdateTimeStamp": 1733168548521 + }, + { + "AccountIdentifier": "222222222222", + "TelemetryConfigurationState": { + "Logs": "NotApplicable", + "Metrics": "Disabled", + "Traces": "NotApplicable" + }, + "ResourceType": "AWS::EC2::Instance", + "ResourceIdentifier": "i-b188560f", + "ResourceTags": { + "Name": "apache" + }, + "LastUpdateTimeStamp": 1732744260182 + } + ] + } + +For more information, see `Auditing CloudWatch telemetry configurations `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file diff --git a/awscli/examples/observabilityadmin/list-resource-telemetry.rst b/awscli/examples/observabilityadmin/list-resource-telemetry.rst new file mode 100644 index 000000000000..f175e1143d46 --- /dev/null +++ b/awscli/examples/observabilityadmin/list-resource-telemetry.rst @@ -0,0 +1,29 @@ +**To retrieve the telemetry configurations for the account** + +The following ``list-resource-telemetry`` example returns a list of telemetry configurations for AWS resources supported by telemetry config in the specified account. :: + + aws observabilityadmin list-resource-telemetry \ + --resource-types AWS::EC2::Instance + +Output:: + + { + "TelemetryConfigurations": [ + { + "AccountIdentifier": "111111111111", + "TelemetryConfigurationState": { + "Logs": "NotApplicable", + "Metrics": "Disabled", + "Traces": "NotApplicable" + }, + "ResourceType": "AWS::EC2::Instance", + "ResourceIdentifier": "i-0e979d278b040f856", + "ResourceTags": { + "Name": "apache" + }, + "LastUpdateTimeStamp": 1732744260182 + } + ] + } + +For more information, see `Auditing CloudWatch telemetry configurations `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file diff --git a/awscli/examples/observabilityadmin/start-telemetry-evaluation-for-organization.rst b/awscli/examples/observabilityadmin/start-telemetry-evaluation-for-organization.rst new file mode 100644 index 000000000000..feb8bcf93fbf --- /dev/null +++ b/awscli/examples/observabilityadmin/start-telemetry-evaluation-for-organization.rst @@ -0,0 +1,9 @@ +**To enable the telemetry config feature** + +The following ``start-telemetry-evaluation-for-organization`` example enables the telemetry config feature for the organization. :: + + aws observabilityadmin start-telemetry-evaluation-for-organization + +This command produces no output. + +For more information, see `Turning on CloudWatch telemetry auditing `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file diff --git a/awscli/examples/observabilityadmin/start-telemetry-evaluation.rst b/awscli/examples/observabilityadmin/start-telemetry-evaluation.rst new file mode 100644 index 000000000000..e3f7051232a9 --- /dev/null +++ b/awscli/examples/observabilityadmin/start-telemetry-evaluation.rst @@ -0,0 +1,9 @@ +**To enable the telemetry config feature** + +The following ``start-telemetry-evaluation`` example enables the telemetry config feature in the specified account. :: + + aws observabilityadmin start-telemetry-evaluation + +This command produces no output. + +For more information, see `Turning on CloudWatch telemetry auditing `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file diff --git a/awscli/examples/observabilityadmin/stop-telemetry-evaluation-for-organization.rst b/awscli/examples/observabilityadmin/stop-telemetry-evaluation-for-organization.rst new file mode 100644 index 000000000000..fc86280e7292 --- /dev/null +++ b/awscli/examples/observabilityadmin/stop-telemetry-evaluation-for-organization.rst @@ -0,0 +1,9 @@ +**To disable the telemetry config feature** + +The following ``stop-telemetry-evaluation-for-organization`` example disables the telemetry config feature for the organization. :: + + aws observabilityadmin stop-telemetry-evaluation-for-organization + +This command produces no output. + +For more information, see `Turning off CloudWatch telemetry auditing `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file diff --git a/awscli/examples/observabilityadmin/stop-telemetry-evaluation.rst b/awscli/examples/observabilityadmin/stop-telemetry-evaluation.rst new file mode 100644 index 000000000000..28957c59728e --- /dev/null +++ b/awscli/examples/observabilityadmin/stop-telemetry-evaluation.rst @@ -0,0 +1,9 @@ +**To disable the telemetry config feature** + +The following ``stop-telemetry-evaluation`` example disables the telemetry config feature in the specified account. :: + + aws observabilityadmin stop-telemetry-evaluation + +This command produces no output. + +For more information, see `Turning off CloudWatch telemetry auditing `__ in the *Amazon CloudWatch User Guide*. \ No newline at end of file