@aws-sdk/client-observabilityadmin 3.908.0 → 3.910.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/README.md +25 -4
  2. package/dist-cjs/endpoint/ruleset.js +1 -1
  3. package/dist-cjs/index.js +131 -0
  4. package/dist-es/ObservabilityAdmin.js +6 -0
  5. package/dist-es/commands/GetTelemetryEnrichmentStatusCommand.js +22 -0
  6. package/dist-es/commands/StartTelemetryEnrichmentCommand.js +22 -0
  7. package/dist-es/commands/StopTelemetryEnrichmentCommand.js +22 -0
  8. package/dist-es/commands/index.js +3 -0
  9. package/dist-es/endpoint/ruleset.js +1 -1
  10. package/dist-es/models/models_0.js +5 -0
  11. package/dist-es/protocols/Aws_restJson1.js +68 -0
  12. package/dist-types/ObservabilityAdmin.d.ts +25 -4
  13. package/dist-types/ObservabilityAdminClient.d.ts +6 -6
  14. package/dist-types/commands/CreateCentralizationRuleForOrganizationCommand.d.ts +6 -18
  15. package/dist-types/commands/CreateTelemetryRuleCommand.d.ts +7 -21
  16. package/dist-types/commands/CreateTelemetryRuleForOrganizationCommand.d.ts +7 -21
  17. package/dist-types/commands/DeleteCentralizationRuleForOrganizationCommand.d.ts +5 -15
  18. package/dist-types/commands/DeleteTelemetryRuleCommand.d.ts +6 -18
  19. package/dist-types/commands/DeleteTelemetryRuleForOrganizationCommand.d.ts +6 -18
  20. package/dist-types/commands/GetCentralizationRuleForOrganizationCommand.d.ts +5 -15
  21. package/dist-types/commands/GetTelemetryEnrichmentStatusCommand.d.ts +85 -0
  22. package/dist-types/commands/GetTelemetryEvaluationStatusCommand.d.ts +4 -12
  23. package/dist-types/commands/GetTelemetryEvaluationStatusForOrganizationCommand.d.ts +5 -15
  24. package/dist-types/commands/GetTelemetryRuleCommand.d.ts +6 -18
  25. package/dist-types/commands/GetTelemetryRuleForOrganizationCommand.d.ts +6 -18
  26. package/dist-types/commands/ListCentralizationRulesForOrganizationCommand.d.ts +4 -12
  27. package/dist-types/commands/ListResourceTelemetryCommand.d.ts +5 -15
  28. package/dist-types/commands/ListResourceTelemetryForOrganizationCommand.d.ts +5 -15
  29. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -18
  30. package/dist-types/commands/ListTelemetryRulesCommand.d.ts +5 -15
  31. package/dist-types/commands/ListTelemetryRulesForOrganizationCommand.d.ts +5 -15
  32. package/dist-types/commands/StartTelemetryEnrichmentCommand.d.ts +85 -0
  33. package/dist-types/commands/StartTelemetryEvaluationCommand.d.ts +5 -15
  34. package/dist-types/commands/StartTelemetryEvaluationForOrganizationCommand.d.ts +5 -15
  35. package/dist-types/commands/StopTelemetryEnrichmentCommand.d.ts +84 -0
  36. package/dist-types/commands/StopTelemetryEvaluationCommand.d.ts +5 -15
  37. package/dist-types/commands/StopTelemetryEvaluationForOrganizationCommand.d.ts +5 -15
  38. package/dist-types/commands/TagResourceCommand.d.ts +7 -21
  39. package/dist-types/commands/UntagResourceCommand.d.ts +6 -18
  40. package/dist-types/commands/UpdateCentralizationRuleForOrganizationCommand.d.ts +6 -18
  41. package/dist-types/commands/UpdateTelemetryRuleCommand.d.ts +7 -21
  42. package/dist-types/commands/UpdateTelemetryRuleForOrganizationCommand.d.ts +7 -21
  43. package/dist-types/commands/index.d.ts +3 -0
  44. package/dist-types/index.d.ts +1 -4
  45. package/dist-types/models/models_0.d.ts +159 -318
  46. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  47. package/dist-types/ts3.4/ObservabilityAdmin.d.ts +54 -0
  48. package/dist-types/ts3.4/ObservabilityAdminClient.d.ts +18 -0
  49. package/dist-types/ts3.4/commands/GetTelemetryEnrichmentStatusCommand.d.ts +47 -0
  50. package/dist-types/ts3.4/commands/StartTelemetryEnrichmentCommand.d.ts +47 -0
  51. package/dist-types/ts3.4/commands/StopTelemetryEnrichmentCommand.d.ts +47 -0
  52. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  53. package/dist-types/ts3.4/models/models_0.d.ts +18 -0
  54. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  55. package/package.json +33 -33
@@ -27,9 +27,7 @@ declare const TagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Adds or updates tags for a telemetry rule resource.
32
- * </p>
30
+ * <p> Adds or updates tags for a telemetry rule resource. </p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -57,34 +55,22 @@ declare const TagResourceCommand_base: {
57
55
  * @see {@link ObservabilityAdminClientResolvedConfig | config} for ObservabilityAdminClient's `config` shape.
58
56
  *
59
57
  * @throws {@link AccessDeniedException} (client fault)
60
- * <p>
61
- * 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide.
62
- * </p>
58
+ * <p> 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
63
59
  *
64
60
  * @throws {@link InternalServerException} (server fault)
65
- * <p>
66
- * Indicates the request has failed to process because of an unknown server error, exception, or failure.
67
- * </p>
61
+ * <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
68
62
  *
69
63
  * @throws {@link ResourceNotFoundException} (client fault)
70
- * <p>
71
- * The specified resource (such as a telemetry rule) could not be found.
72
- * </p>
64
+ * <p> The specified resource (such as a telemetry rule) could not be found. </p>
73
65
  *
74
66
  * @throws {@link ServiceQuotaExceededException} (client fault)
75
- * <p>
76
- * The requested operation would exceed the allowed quota for the specified resource type.
77
- * </p>
67
+ * <p> The requested operation would exceed the allowed quota for the specified resource type. </p>
78
68
  *
79
69
  * @throws {@link TooManyRequestsException} (client fault)
80
- * <p>
81
- * The request throughput limit was exceeded.
82
- * </p>
70
+ * <p> The request throughput limit was exceeded. </p>
83
71
  *
84
72
  * @throws {@link ValidationException} (client fault)
85
- * <p>
86
- * Indicates input validation failed. Check your request parameters and retry the request.
87
- * </p>
73
+ * <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
88
74
  *
89
75
  * @throws {@link ObservabilityAdminServiceException}
90
76
  * <p>Base exception class for all service exceptions from ObservabilityAdmin service.</p>
@@ -27,9 +27,7 @@ declare const UntagResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Removes tags from a telemetry rule resource.
32
- * </p>
30
+ * <p> Removes tags from a telemetry rule resource. </p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -57,29 +55,19 @@ declare const UntagResourceCommand_base: {
57
55
  * @see {@link ObservabilityAdminClientResolvedConfig | config} for ObservabilityAdminClient's `config` shape.
58
56
  *
59
57
  * @throws {@link AccessDeniedException} (client fault)
60
- * <p>
61
- * 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide.
62
- * </p>
58
+ * <p> 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
63
59
  *
64
60
  * @throws {@link InternalServerException} (server fault)
65
- * <p>
66
- * Indicates the request has failed to process because of an unknown server error, exception, or failure.
67
- * </p>
61
+ * <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
68
62
  *
69
63
  * @throws {@link ResourceNotFoundException} (client fault)
70
- * <p>
71
- * The specified resource (such as a telemetry rule) could not be found.
72
- * </p>
64
+ * <p> The specified resource (such as a telemetry rule) could not be found. </p>
73
65
  *
74
66
  * @throws {@link TooManyRequestsException} (client fault)
75
- * <p>
76
- * The request throughput limit was exceeded.
77
- * </p>
67
+ * <p> The request throughput limit was exceeded. </p>
78
68
  *
79
69
  * @throws {@link ValidationException} (client fault)
80
- * <p>
81
- * Indicates input validation failed. Check your request parameters and retry the request.
82
- * </p>
70
+ * <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
83
71
  *
84
72
  * @throws {@link ObservabilityAdminServiceException}
85
73
  * <p>Base exception class for all service exceptions from ObservabilityAdmin service.</p>
@@ -81,34 +81,22 @@ declare const UpdateCentralizationRuleForOrganizationCommand_base: {
81
81
  * @see {@link ObservabilityAdminClientResolvedConfig | config} for ObservabilityAdminClient's `config` shape.
82
82
  *
83
83
  * @throws {@link AccessDeniedException} (client fault)
84
- * <p>
85
- * 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide.
86
- * </p>
84
+ * <p> 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
87
85
  *
88
86
  * @throws {@link InternalServerException} (server fault)
89
- * <p>
90
- * Indicates the request has failed to process because of an unknown server error, exception, or failure.
91
- * </p>
87
+ * <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
92
88
  *
93
89
  * @throws {@link ResourceNotFoundException} (client fault)
94
- * <p>
95
- * The specified resource (such as a telemetry rule) could not be found.
96
- * </p>
90
+ * <p> The specified resource (such as a telemetry rule) could not be found. </p>
97
91
  *
98
92
  * @throws {@link ServiceQuotaExceededException} (client fault)
99
- * <p>
100
- * The requested operation would exceed the allowed quota for the specified resource type.
101
- * </p>
93
+ * <p> The requested operation would exceed the allowed quota for the specified resource type. </p>
102
94
  *
103
95
  * @throws {@link TooManyRequestsException} (client fault)
104
- * <p>
105
- * The request throughput limit was exceeded.
106
- * </p>
96
+ * <p> The request throughput limit was exceeded. </p>
107
97
  *
108
98
  * @throws {@link ValidationException} (client fault)
109
- * <p>
110
- * Indicates input validation failed. Check your request parameters and retry the request.
111
- * </p>
99
+ * <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
112
100
  *
113
101
  * @throws {@link ObservabilityAdminServiceException}
114
102
  * <p>Base exception class for all service exceptions from ObservabilityAdmin service.</p>
@@ -27,9 +27,7 @@ declare const UpdateTelemetryRuleCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * Updates an existing telemetry rule in your account.
32
- * </p>
30
+ * <p> Updates an existing telemetry rule in your account. </p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -72,34 +70,22 @@ declare const UpdateTelemetryRuleCommand_base: {
72
70
  * @see {@link ObservabilityAdminClientResolvedConfig | config} for ObservabilityAdminClient's `config` shape.
73
71
  *
74
72
  * @throws {@link AccessDeniedException} (client fault)
75
- * <p>
76
- * 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide.
77
- * </p>
73
+ * <p> 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
78
74
  *
79
75
  * @throws {@link InternalServerException} (server fault)
80
- * <p>
81
- * Indicates the request has failed to process because of an unknown server error, exception, or failure.
82
- * </p>
76
+ * <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
83
77
  *
84
78
  * @throws {@link ResourceNotFoundException} (client fault)
85
- * <p>
86
- * The specified resource (such as a telemetry rule) could not be found.
87
- * </p>
79
+ * <p> The specified resource (such as a telemetry rule) could not be found. </p>
88
80
  *
89
81
  * @throws {@link ServiceQuotaExceededException} (client fault)
90
- * <p>
91
- * The requested operation would exceed the allowed quota for the specified resource type.
92
- * </p>
82
+ * <p> The requested operation would exceed the allowed quota for the specified resource type. </p>
93
83
  *
94
84
  * @throws {@link TooManyRequestsException} (client fault)
95
- * <p>
96
- * The request throughput limit was exceeded.
97
- * </p>
85
+ * <p> The request throughput limit was exceeded. </p>
98
86
  *
99
87
  * @throws {@link ValidationException} (client fault)
100
- * <p>
101
- * Indicates input validation failed. Check your request parameters and retry the request.
102
- * </p>
88
+ * <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
103
89
  *
104
90
  * @throws {@link ObservabilityAdminServiceException}
105
91
  * <p>Base exception class for all service exceptions from ObservabilityAdmin service.</p>
@@ -27,9 +27,7 @@ declare const UpdateTelemetryRuleForOrganizationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * 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.
32
- * </p>
30
+ * <p> 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. </p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -72,34 +70,22 @@ declare const UpdateTelemetryRuleForOrganizationCommand_base: {
72
70
  * @see {@link ObservabilityAdminClientResolvedConfig | config} for ObservabilityAdminClient's `config` shape.
73
71
  *
74
72
  * @throws {@link AccessDeniedException} (client fault)
75
- * <p>
76
- * 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide.
77
- * </p>
73
+ * <p> 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 <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management for Amazon Web Services resources</a> in the IAM user guide. </p>
78
74
  *
79
75
  * @throws {@link InternalServerException} (server fault)
80
- * <p>
81
- * Indicates the request has failed to process because of an unknown server error, exception, or failure.
82
- * </p>
76
+ * <p> Indicates the request has failed to process because of an unknown server error, exception, or failure. </p>
83
77
  *
84
78
  * @throws {@link ResourceNotFoundException} (client fault)
85
- * <p>
86
- * The specified resource (such as a telemetry rule) could not be found.
87
- * </p>
79
+ * <p> The specified resource (such as a telemetry rule) could not be found. </p>
88
80
  *
89
81
  * @throws {@link ServiceQuotaExceededException} (client fault)
90
- * <p>
91
- * The requested operation would exceed the allowed quota for the specified resource type.
92
- * </p>
82
+ * <p> The requested operation would exceed the allowed quota for the specified resource type. </p>
93
83
  *
94
84
  * @throws {@link TooManyRequestsException} (client fault)
95
- * <p>
96
- * The request throughput limit was exceeded.
97
- * </p>
85
+ * <p> The request throughput limit was exceeded. </p>
98
86
  *
99
87
  * @throws {@link ValidationException} (client fault)
100
- * <p>
101
- * Indicates input validation failed. Check your request parameters and retry the request.
102
- * </p>
88
+ * <p> Indicates input validation failed. Check your request parameters and retry the request. </p>
103
89
  *
104
90
  * @throws {@link ObservabilityAdminServiceException}
105
91
  * <p>Base exception class for all service exceptions from ObservabilityAdmin service.</p>
@@ -5,6 +5,7 @@ export * from "./DeleteCentralizationRuleForOrganizationCommand";
5
5
  export * from "./DeleteTelemetryRuleCommand";
6
6
  export * from "./DeleteTelemetryRuleForOrganizationCommand";
7
7
  export * from "./GetCentralizationRuleForOrganizationCommand";
8
+ export * from "./GetTelemetryEnrichmentStatusCommand";
8
9
  export * from "./GetTelemetryEvaluationStatusCommand";
9
10
  export * from "./GetTelemetryEvaluationStatusForOrganizationCommand";
10
11
  export * from "./GetTelemetryRuleCommand";
@@ -15,8 +16,10 @@ export * from "./ListResourceTelemetryForOrganizationCommand";
15
16
  export * from "./ListTagsForResourceCommand";
16
17
  export * from "./ListTelemetryRulesCommand";
17
18
  export * from "./ListTelemetryRulesForOrganizationCommand";
19
+ export * from "./StartTelemetryEnrichmentCommand";
18
20
  export * from "./StartTelemetryEvaluationCommand";
19
21
  export * from "./StartTelemetryEvaluationForOrganizationCommand";
22
+ export * from "./StopTelemetryEnrichmentCommand";
20
23
  export * from "./StopTelemetryEvaluationCommand";
21
24
  export * from "./StopTelemetryEvaluationForOrganizationCommand";
22
25
  export * from "./TagResourceCommand";
@@ -1,8 +1,5 @@
1
1
  /**
2
- * <p>
3
- * 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.
4
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p>
5
- * <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
2
+ * <p> 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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html">Auditing CloudWatch telemetry configurations</a> in the CloudWatch User Guide.</p> <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html">Identity and access management for Amazon CloudWatch</a> in the CloudWatch User Guide.</p>
6
3
  *
7
4
  * @packageDocumentation
8
5
  */