@aws-sdk/client-cloudwatch-logs 3.325.0 → 3.327.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 (49) hide show
  1. package/dist-types/commands/AssociateKmsKeyCommand.d.ts +4 -0
  2. package/dist-types/commands/CancelExportTaskCommand.d.ts +4 -0
  3. package/dist-types/commands/CreateExportTaskCommand.d.ts +6 -0
  4. package/dist-types/commands/CreateLogGroupCommand.d.ts +4 -0
  5. package/dist-types/commands/CreateLogStreamCommand.d.ts +4 -0
  6. package/dist-types/commands/DeleteDataProtectionPolicyCommand.d.ts +4 -0
  7. package/dist-types/commands/DeleteDestinationCommand.d.ts +4 -0
  8. package/dist-types/commands/DeleteLogGroupCommand.d.ts +4 -0
  9. package/dist-types/commands/DeleteLogStreamCommand.d.ts +4 -0
  10. package/dist-types/commands/DeleteMetricFilterCommand.d.ts +4 -0
  11. package/dist-types/commands/DeleteQueryDefinitionCommand.d.ts +6 -0
  12. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
  13. package/dist-types/commands/DeleteRetentionPolicyCommand.d.ts +4 -0
  14. package/dist-types/commands/DeleteSubscriptionFilterCommand.d.ts +4 -0
  15. package/dist-types/commands/DescribeDestinationsCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeExportTasksCommand.d.ts +25 -0
  17. package/dist-types/commands/DescribeLogGroupsCommand.d.ts +18 -0
  18. package/dist-types/commands/DescribeLogStreamsCommand.d.ts +18 -0
  19. package/dist-types/commands/DescribeMetricFiltersCommand.d.ts +26 -0
  20. package/dist-types/commands/DescribeQueriesCommand.d.ts +15 -0
  21. package/dist-types/commands/DescribeQueryDefinitionsCommand.d.ts +17 -0
  22. package/dist-types/commands/DescribeResourcePoliciesCommand.d.ts +13 -0
  23. package/dist-types/commands/DescribeSubscriptionFiltersCommand.d.ts +17 -0
  24. package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +4 -0
  25. package/dist-types/commands/FilterLogEventsCommand.d.ts +21 -0
  26. package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +8 -0
  27. package/dist-types/commands/GetLogEventsCommand.d.ts +14 -0
  28. package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +11 -0
  29. package/dist-types/commands/GetLogRecordCommand.d.ts +8 -0
  30. package/dist-types/commands/GetQueryResultsCommand.d.ts +19 -0
  31. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  32. package/dist-types/commands/ListTagsLogGroupCommand.d.ts +8 -0
  33. package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +8 -0
  34. package/dist-types/commands/PutDestinationCommand.d.ts +13 -0
  35. package/dist-types/commands/PutDestinationPolicyCommand.d.ts +4 -0
  36. package/dist-types/commands/PutLogEventsCommand.d.ts +11 -0
  37. package/dist-types/commands/PutMetricFilterCommand.d.ts +4 -0
  38. package/dist-types/commands/PutQueryDefinitionCommand.d.ts +6 -0
  39. package/dist-types/commands/PutResourcePolicyCommand.d.ts +10 -0
  40. package/dist-types/commands/PutRetentionPolicyCommand.d.ts +4 -0
  41. package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +4 -0
  42. package/dist-types/commands/StartQueryCommand.d.ts +6 -0
  43. package/dist-types/commands/StopQueryCommand.d.ts +6 -0
  44. package/dist-types/commands/TagLogGroupCommand.d.ts +4 -0
  45. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  46. package/dist-types/commands/TestMetricFilterCommand.d.ts +14 -0
  47. package/dist-types/commands/UntagLogGroupCommand.d.ts +4 -0
  48. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  49. package/package.json +7 -7
@@ -45,6 +45,8 @@ export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {
45
45
  * };
46
46
  * const command = new AssociateKmsKeyCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param AssociateKmsKeyCommandInput - {@link AssociateKmsKeyCommandInput}
@@ -65,6 +67,8 @@ export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {
65
67
  * @throws {@link ServiceUnavailableException} (server fault)
66
68
  * <p>The service cannot complete the request.</p>
67
69
  *
70
+ * @throws {@link CloudWatchLogsServiceException}
71
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
68
72
  *
69
73
  */
70
74
  export declare class AssociateKmsKeyCommand extends $Command<AssociateKmsKeyCommandInput, AssociateKmsKeyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface CancelExportTaskCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new CancelExportTaskCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param CancelExportTaskCommandInput - {@link CancelExportTaskCommandInput}
@@ -52,6 +54,8 @@ export interface CancelExportTaskCommandOutput extends __MetadataBearer {
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The service cannot complete the request.</p>
54
56
  *
57
+ * @throws {@link CloudWatchLogsServiceException}
58
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class CancelExportTaskCommand extends $Command<CancelExportTaskCommandInput, CancelExportTaskCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -56,6 +56,10 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
56
56
  * };
57
57
  * const command = new CreateExportTaskCommand(input);
58
58
  * const response = await client.send(command);
59
+ * // { // CreateExportTaskResponse
60
+ * // taskId: "STRING_VALUE",
61
+ * // };
62
+ *
59
63
  * ```
60
64
  *
61
65
  * @param CreateExportTaskCommandInput - {@link CreateExportTaskCommandInput}
@@ -82,6 +86,8 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
82
86
  * @throws {@link ServiceUnavailableException} (server fault)
83
87
  * <p>The service cannot complete the request.</p>
84
88
  *
89
+ * @throws {@link CloudWatchLogsServiceException}
90
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
85
91
  *
86
92
  */
87
93
  export declare class CreateExportTaskCommand extends $Command<CreateExportTaskCommandInput, CreateExportTaskCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -63,6 +63,8 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {
63
63
  * };
64
64
  * const command = new CreateLogGroupCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // {};
67
+ *
66
68
  * ```
67
69
  *
68
70
  * @param CreateLogGroupCommandInput - {@link CreateLogGroupCommandInput}
@@ -86,6 +88,8 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {
86
88
  * @throws {@link ServiceUnavailableException} (server fault)
87
89
  * <p>The service cannot complete the request.</p>
88
90
  *
91
+ * @throws {@link CloudWatchLogsServiceException}
92
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
89
93
  *
90
94
  */
91
95
  export declare class CreateLogGroupCommand extends $Command<CreateLogGroupCommandInput, CreateLogGroupCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -48,6 +48,8 @@ export interface CreateLogStreamCommandOutput extends __MetadataBearer {
48
48
  * };
49
49
  * const command = new CreateLogStreamCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // {};
52
+ *
51
53
  * ```
52
54
  *
53
55
  * @param CreateLogStreamCommandInput - {@link CreateLogStreamCommandInput}
@@ -68,6 +70,8 @@ export interface CreateLogStreamCommandOutput extends __MetadataBearer {
68
70
  * @throws {@link ServiceUnavailableException} (server fault)
69
71
  * <p>The service cannot complete the request.</p>
70
72
  *
73
+ * @throws {@link CloudWatchLogsServiceException}
74
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
71
75
  *
72
76
  */
73
77
  export declare class CreateLogStreamCommand extends $Command<CreateLogStreamCommandInput, CreateLogStreamCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteDataProtectionPolicyCommandOutput extends __MetadataBeare
32
32
  * };
33
33
  * const command = new DeleteDataProtectionPolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteDataProtectionPolicyCommandInput - {@link DeleteDataProtectionPolicyCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteDataProtectionPolicyCommandOutput extends __MetadataBeare
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The service cannot complete the request.</p>
54
56
  *
57
+ * @throws {@link CloudWatchLogsServiceException}
58
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteDataProtectionPolicyCommand extends $Command<DeleteDataProtectionPolicyCommandInput, DeleteDataProtectionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteDestinationCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteDestinationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteDestinationCommandInput - {@link DeleteDestinationCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteDestinationCommandOutput extends __MetadataBearer {
53
55
  * @throws {@link ServiceUnavailableException} (server fault)
54
56
  * <p>The service cannot complete the request.</p>
55
57
  *
58
+ * @throws {@link CloudWatchLogsServiceException}
59
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeleteDestinationCommand extends $Command<DeleteDestinationCommandInput, DeleteDestinationCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteLogGroupCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteLogGroupCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteLogGroupCommandInput - {@link DeleteLogGroupCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteLogGroupCommandOutput extends __MetadataBearer {
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The service cannot complete the request.</p>
54
56
  *
57
+ * @throws {@link CloudWatchLogsServiceException}
58
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteLogGroupCommand extends $Command<DeleteLogGroupCommandInput, DeleteLogGroupCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteLogStreamCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteLogStreamCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteLogStreamCommandInput - {@link DeleteLogStreamCommandInput}
@@ -53,6 +55,8 @@ export interface DeleteLogStreamCommandOutput extends __MetadataBearer {
53
55
  * @throws {@link ServiceUnavailableException} (server fault)
54
56
  * <p>The service cannot complete the request.</p>
55
57
  *
58
+ * @throws {@link CloudWatchLogsServiceException}
59
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
56
60
  *
57
61
  */
58
62
  export declare class DeleteLogStreamCommand extends $Command<DeleteLogStreamCommandInput, DeleteLogStreamCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteMetricFilterCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteMetricFilterCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteMetricFilterCommandInput - {@link DeleteMetricFilterCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteMetricFilterCommandOutput extends __MetadataBearer {
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The service cannot complete the request.</p>
54
56
  *
57
+ * @throws {@link CloudWatchLogsServiceException}
58
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteMetricFilterCommand extends $Command<DeleteMetricFilterCommandInput, DeleteMetricFilterCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -35,6 +35,10 @@ export interface DeleteQueryDefinitionCommandOutput extends DeleteQueryDefinitio
35
35
  * };
36
36
  * const command = new DeleteQueryDefinitionCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DeleteQueryDefinitionResponse
39
+ * // success: true || false,
40
+ * // };
41
+ *
38
42
  * ```
39
43
  *
40
44
  * @param DeleteQueryDefinitionCommandInput - {@link DeleteQueryDefinitionCommandInput}
@@ -52,6 +56,8 @@ export interface DeleteQueryDefinitionCommandOutput extends DeleteQueryDefinitio
52
56
  * @throws {@link ServiceUnavailableException} (server fault)
53
57
  * <p>The service cannot complete the request.</p>
54
58
  *
59
+ * @throws {@link CloudWatchLogsServiceException}
60
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
61
  *
56
62
  */
57
63
  export declare class DeleteQueryDefinitionCommand extends $Command<DeleteQueryDefinitionCommandInput, DeleteQueryDefinitionCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteResourcePolicyCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteResourcePolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
@@ -49,6 +51,8 @@ export interface DeleteResourcePolicyCommandOutput extends __MetadataBearer {
49
51
  * @throws {@link ServiceUnavailableException} (server fault)
50
52
  * <p>The service cannot complete the request.</p>
51
53
  *
54
+ * @throws {@link CloudWatchLogsServiceException}
55
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
52
56
  *
53
57
  */
54
58
  export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteRetentionPolicyCommandOutput extends __MetadataBearer {
32
32
  * };
33
33
  * const command = new DeleteRetentionPolicyCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteRetentionPolicyCommandInput - {@link DeleteRetentionPolicyCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteRetentionPolicyCommandOutput extends __MetadataBearer {
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The service cannot complete the request.</p>
54
56
  *
57
+ * @throws {@link CloudWatchLogsServiceException}
58
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteRetentionPolicyCommand extends $Command<DeleteRetentionPolicyCommandInput, DeleteRetentionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,8 @@ export interface DeleteSubscriptionFilterCommandOutput extends __MetadataBearer
32
32
  * };
33
33
  * const command = new DeleteSubscriptionFilterCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param DeleteSubscriptionFilterCommandInput - {@link DeleteSubscriptionFilterCommandInput}
@@ -52,6 +54,8 @@ export interface DeleteSubscriptionFilterCommandOutput extends __MetadataBearer
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The service cannot complete the request.</p>
54
56
  *
57
+ * @throws {@link CloudWatchLogsServiceException}
58
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class DeleteSubscriptionFilterCommand extends $Command<DeleteSubscriptionFilterCommandInput, DeleteSubscriptionFilterCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -33,6 +33,20 @@ export interface DescribeDestinationsCommandOutput extends DescribeDestinationsR
33
33
  * };
34
34
  * const command = new DescribeDestinationsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // DescribeDestinationsResponse
37
+ * // destinations: [ // Destinations
38
+ * // { // Destination
39
+ * // destinationName: "STRING_VALUE",
40
+ * // targetArn: "STRING_VALUE",
41
+ * // roleArn: "STRING_VALUE",
42
+ * // accessPolicy: "STRING_VALUE",
43
+ * // arn: "STRING_VALUE",
44
+ * // creationTime: Number("long"),
45
+ * // },
46
+ * // ],
47
+ * // nextToken: "STRING_VALUE",
48
+ * // };
49
+ *
36
50
  * ```
37
51
  *
38
52
  * @param DescribeDestinationsCommandInput - {@link DescribeDestinationsCommandInput}
@@ -47,6 +61,8 @@ export interface DescribeDestinationsCommandOutput extends DescribeDestinationsR
47
61
  * @throws {@link ServiceUnavailableException} (server fault)
48
62
  * <p>The service cannot complete the request.</p>
49
63
  *
64
+ * @throws {@link CloudWatchLogsServiceException}
65
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
50
66
  *
51
67
  */
52
68
  export declare class DescribeDestinationsCommand extends $Command<DescribeDestinationsCommandInput, DescribeDestinationsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -35,6 +35,29 @@ export interface DescribeExportTasksCommandOutput extends DescribeExportTasksRes
35
35
  * };
36
36
  * const command = new DescribeExportTasksCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeExportTasksResponse
39
+ * // exportTasks: [ // ExportTasks
40
+ * // { // ExportTask
41
+ * // taskId: "STRING_VALUE",
42
+ * // taskName: "STRING_VALUE",
43
+ * // logGroupName: "STRING_VALUE",
44
+ * // from: Number("long"),
45
+ * // to: Number("long"),
46
+ * // destination: "STRING_VALUE",
47
+ * // destinationPrefix: "STRING_VALUE",
48
+ * // status: { // ExportTaskStatus
49
+ * // code: "CANCELLED" || "COMPLETED" || "FAILED" || "PENDING" || "PENDING_CANCEL" || "RUNNING",
50
+ * // message: "STRING_VALUE",
51
+ * // },
52
+ * // executionInfo: { // ExportTaskExecutionInfo
53
+ * // creationTime: Number("long"),
54
+ * // completionTime: Number("long"),
55
+ * // },
56
+ * // },
57
+ * // ],
58
+ * // nextToken: "STRING_VALUE",
59
+ * // };
60
+ *
38
61
  * ```
39
62
  *
40
63
  * @param DescribeExportTasksCommandInput - {@link DescribeExportTasksCommandInput}
@@ -49,6 +72,8 @@ export interface DescribeExportTasksCommandOutput extends DescribeExportTasksRes
49
72
  * @throws {@link ServiceUnavailableException} (server fault)
50
73
  * <p>The service cannot complete the request.</p>
51
74
  *
75
+ * @throws {@link CloudWatchLogsServiceException}
76
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
52
77
  *
53
78
  */
54
79
  export declare class DescribeExportTasksCommand extends $Command<DescribeExportTasksCommandInput, DescribeExportTasksCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -49,6 +49,22 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons
49
49
  * };
50
50
  * const command = new DescribeLogGroupsCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // DescribeLogGroupsResponse
53
+ * // logGroups: [ // LogGroups
54
+ * // { // LogGroup
55
+ * // logGroupName: "STRING_VALUE",
56
+ * // creationTime: Number("long"),
57
+ * // retentionInDays: Number("int"),
58
+ * // metricFilterCount: Number("int"),
59
+ * // arn: "STRING_VALUE",
60
+ * // storedBytes: Number("long"),
61
+ * // kmsKeyId: "STRING_VALUE",
62
+ * // dataProtectionStatus: "ACTIVATED" || "DELETED" || "ARCHIVED" || "DISABLED",
63
+ * // },
64
+ * // ],
65
+ * // nextToken: "STRING_VALUE",
66
+ * // };
67
+ *
52
68
  * ```
53
69
  *
54
70
  * @param DescribeLogGroupsCommandInput - {@link DescribeLogGroupsCommandInput}
@@ -63,6 +79,8 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons
63
79
  * @throws {@link ServiceUnavailableException} (server fault)
64
80
  * <p>The service cannot complete the request.</p>
65
81
  *
82
+ * @throws {@link CloudWatchLogsServiceException}
83
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
66
84
  *
67
85
  */
68
86
  export declare class DescribeLogGroupsCommand extends $Command<DescribeLogGroupsCommandInput, DescribeLogGroupsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -46,6 +46,22 @@ export interface DescribeLogStreamsCommandOutput extends DescribeLogStreamsRespo
46
46
  * };
47
47
  * const command = new DescribeLogStreamsCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // DescribeLogStreamsResponse
50
+ * // logStreams: [ // LogStreams
51
+ * // { // LogStream
52
+ * // logStreamName: "STRING_VALUE",
53
+ * // creationTime: Number("long"),
54
+ * // firstEventTimestamp: Number("long"),
55
+ * // lastEventTimestamp: Number("long"),
56
+ * // lastIngestionTime: Number("long"),
57
+ * // uploadSequenceToken: "STRING_VALUE",
58
+ * // arn: "STRING_VALUE",
59
+ * // storedBytes: Number("long"),
60
+ * // },
61
+ * // ],
62
+ * // nextToken: "STRING_VALUE",
63
+ * // };
64
+ *
49
65
  * ```
50
66
  *
51
67
  * @param DescribeLogStreamsCommandInput - {@link DescribeLogStreamsCommandInput}
@@ -63,6 +79,8 @@ export interface DescribeLogStreamsCommandOutput extends DescribeLogStreamsRespo
63
79
  * @throws {@link ServiceUnavailableException} (server fault)
64
80
  * <p>The service cannot complete the request.</p>
65
81
  *
82
+ * @throws {@link CloudWatchLogsServiceException}
83
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
66
84
  *
67
85
  */
68
86
  export declare class DescribeLogStreamsCommand extends $Command<DescribeLogStreamsCommandInput, DescribeLogStreamsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -38,6 +38,30 @@ export interface DescribeMetricFiltersCommandOutput extends DescribeMetricFilter
38
38
  * };
39
39
  * const command = new DescribeMetricFiltersCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DescribeMetricFiltersResponse
42
+ * // metricFilters: [ // MetricFilters
43
+ * // { // MetricFilter
44
+ * // filterName: "STRING_VALUE",
45
+ * // filterPattern: "STRING_VALUE",
46
+ * // metricTransformations: [ // MetricTransformations
47
+ * // { // MetricTransformation
48
+ * // metricName: "STRING_VALUE", // required
49
+ * // metricNamespace: "STRING_VALUE", // required
50
+ * // metricValue: "STRING_VALUE", // required
51
+ * // defaultValue: Number("double"),
52
+ * // dimensions: { // Dimensions
53
+ * // "<keys>": "STRING_VALUE",
54
+ * // },
55
+ * // unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None",
56
+ * // },
57
+ * // ],
58
+ * // creationTime: Number("long"),
59
+ * // logGroupName: "STRING_VALUE",
60
+ * // },
61
+ * // ],
62
+ * // nextToken: "STRING_VALUE",
63
+ * // };
64
+ *
41
65
  * ```
42
66
  *
43
67
  * @param DescribeMetricFiltersCommandInput - {@link DescribeMetricFiltersCommandInput}
@@ -55,6 +79,8 @@ export interface DescribeMetricFiltersCommandOutput extends DescribeMetricFilter
55
79
  * @throws {@link ServiceUnavailableException} (server fault)
56
80
  * <p>The service cannot complete the request.</p>
57
81
  *
82
+ * @throws {@link CloudWatchLogsServiceException}
83
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
58
84
  *
59
85
  */
60
86
  export declare class DescribeMetricFiltersCommand extends $Command<DescribeMetricFiltersCommandInput, DescribeMetricFiltersCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -36,6 +36,19 @@ export interface DescribeQueriesCommandOutput extends DescribeQueriesResponse, _
36
36
  * };
37
37
  * const command = new DescribeQueriesCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeQueriesResponse
40
+ * // queries: [ // QueryInfoList
41
+ * // { // QueryInfo
42
+ * // queryId: "STRING_VALUE",
43
+ * // queryString: "STRING_VALUE",
44
+ * // status: "Scheduled" || "Running" || "Complete" || "Failed" || "Cancelled" || "Timeout" || "Unknown",
45
+ * // createTime: Number("long"),
46
+ * // logGroupName: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // nextToken: "STRING_VALUE",
50
+ * // };
51
+ *
39
52
  * ```
40
53
  *
41
54
  * @param DescribeQueriesCommandInput - {@link DescribeQueriesCommandInput}
@@ -53,6 +66,8 @@ export interface DescribeQueriesCommandOutput extends DescribeQueriesResponse, _
53
66
  * @throws {@link ServiceUnavailableException} (server fault)
54
67
  * <p>The service cannot complete the request.</p>
55
68
  *
69
+ * @throws {@link CloudWatchLogsServiceException}
70
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
56
71
  *
57
72
  */
58
73
  export declare class DescribeQueriesCommand extends $Command<DescribeQueriesCommandInput, DescribeQueriesCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -35,6 +35,21 @@ export interface DescribeQueryDefinitionsCommandOutput extends DescribeQueryDefi
35
35
  * };
36
36
  * const command = new DescribeQueryDefinitionsCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeQueryDefinitionsResponse
39
+ * // queryDefinitions: [ // QueryDefinitionList
40
+ * // { // QueryDefinition
41
+ * // queryDefinitionId: "STRING_VALUE",
42
+ * // name: "STRING_VALUE",
43
+ * // queryString: "STRING_VALUE",
44
+ * // lastModified: Number("long"),
45
+ * // logGroupNames: [ // LogGroupNames
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // },
49
+ * // ],
50
+ * // nextToken: "STRING_VALUE",
51
+ * // };
52
+ *
38
53
  * ```
39
54
  *
40
55
  * @param DescribeQueryDefinitionsCommandInput - {@link DescribeQueryDefinitionsCommandInput}
@@ -49,6 +64,8 @@ export interface DescribeQueryDefinitionsCommandOutput extends DescribeQueryDefi
49
64
  * @throws {@link ServiceUnavailableException} (server fault)
50
65
  * <p>The service cannot complete the request.</p>
51
66
  *
67
+ * @throws {@link CloudWatchLogsServiceException}
68
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
52
69
  *
53
70
  */
54
71
  export declare class DescribeQueryDefinitionsCommand extends $Command<DescribeQueryDefinitionsCommandInput, DescribeQueryDefinitionsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,17 @@ export interface DescribeResourcePoliciesCommandOutput extends DescribeResourceP
32
32
  * };
33
33
  * const command = new DescribeResourcePoliciesCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeResourcePoliciesResponse
36
+ * // resourcePolicies: [ // ResourcePolicies
37
+ * // { // ResourcePolicy
38
+ * // policyName: "STRING_VALUE",
39
+ * // policyDocument: "STRING_VALUE",
40
+ * // lastUpdatedTime: Number("long"),
41
+ * // },
42
+ * // ],
43
+ * // nextToken: "STRING_VALUE",
44
+ * // };
45
+ *
35
46
  * ```
36
47
  *
37
48
  * @param DescribeResourcePoliciesCommandInput - {@link DescribeResourcePoliciesCommandInput}
@@ -46,6 +57,8 @@ export interface DescribeResourcePoliciesCommandOutput extends DescribeResourceP
46
57
  * @throws {@link ServiceUnavailableException} (server fault)
47
58
  * <p>The service cannot complete the request.</p>
48
59
  *
60
+ * @throws {@link CloudWatchLogsServiceException}
61
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
49
62
  *
50
63
  */
51
64
  export declare class DescribeResourcePoliciesCommand extends $Command<DescribeResourcePoliciesCommandInput, DescribeResourcePoliciesCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -35,6 +35,21 @@ export interface DescribeSubscriptionFiltersCommandOutput extends DescribeSubscr
35
35
  * };
36
36
  * const command = new DescribeSubscriptionFiltersCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // DescribeSubscriptionFiltersResponse
39
+ * // subscriptionFilters: [ // SubscriptionFilters
40
+ * // { // SubscriptionFilter
41
+ * // filterName: "STRING_VALUE",
42
+ * // logGroupName: "STRING_VALUE",
43
+ * // filterPattern: "STRING_VALUE",
44
+ * // destinationArn: "STRING_VALUE",
45
+ * // roleArn: "STRING_VALUE",
46
+ * // distribution: "Random" || "ByLogStream",
47
+ * // creationTime: Number("long"),
48
+ * // },
49
+ * // ],
50
+ * // nextToken: "STRING_VALUE",
51
+ * // };
52
+ *
38
53
  * ```
39
54
  *
40
55
  * @param DescribeSubscriptionFiltersCommandInput - {@link DescribeSubscriptionFiltersCommandInput}
@@ -52,6 +67,8 @@ export interface DescribeSubscriptionFiltersCommandOutput extends DescribeSubscr
52
67
  * @throws {@link ServiceUnavailableException} (server fault)
53
68
  * <p>The service cannot complete the request.</p>
54
69
  *
70
+ * @throws {@link CloudWatchLogsServiceException}
71
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
72
  *
56
73
  */
57
74
  export declare class DescribeSubscriptionFiltersCommand extends $Command<DescribeSubscriptionFiltersCommandInput, DescribeSubscriptionFiltersCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -36,6 +36,8 @@ export interface DisassociateKmsKeyCommandOutput extends __MetadataBearer {
36
36
  * };
37
37
  * const command = new DisassociateKmsKeyCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // {};
40
+ *
39
41
  * ```
40
42
  *
41
43
  * @param DisassociateKmsKeyCommandInput - {@link DisassociateKmsKeyCommandInput}
@@ -56,6 +58,8 @@ export interface DisassociateKmsKeyCommandOutput extends __MetadataBearer {
56
58
  * @throws {@link ServiceUnavailableException} (server fault)
57
59
  * <p>The service cannot complete the request.</p>
58
60
  *
61
+ * @throws {@link CloudWatchLogsServiceException}
62
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
59
63
  *
60
64
  */
61
65
  export declare class DisassociateKmsKeyCommand extends $Command<DisassociateKmsKeyCommandInput, DisassociateKmsKeyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -58,6 +58,25 @@ export interface FilterLogEventsCommandOutput extends FilterLogEventsResponse, _
58
58
  * };
59
59
  * const command = new FilterLogEventsCommand(input);
60
60
  * const response = await client.send(command);
61
+ * // { // FilterLogEventsResponse
62
+ * // events: [ // FilteredLogEvents
63
+ * // { // FilteredLogEvent
64
+ * // logStreamName: "STRING_VALUE",
65
+ * // timestamp: Number("long"),
66
+ * // message: "STRING_VALUE",
67
+ * // ingestionTime: Number("long"),
68
+ * // eventId: "STRING_VALUE",
69
+ * // },
70
+ * // ],
71
+ * // searchedLogStreams: [ // SearchedLogStreams
72
+ * // { // SearchedLogStream
73
+ * // logStreamName: "STRING_VALUE",
74
+ * // searchedCompletely: true || false,
75
+ * // },
76
+ * // ],
77
+ * // nextToken: "STRING_VALUE",
78
+ * // };
79
+ *
61
80
  * ```
62
81
  *
63
82
  * @param FilterLogEventsCommandInput - {@link FilterLogEventsCommandInput}
@@ -75,6 +94,8 @@ export interface FilterLogEventsCommandOutput extends FilterLogEventsResponse, _
75
94
  * @throws {@link ServiceUnavailableException} (server fault)
76
95
  * <p>The service cannot complete the request.</p>
77
96
  *
97
+ * @throws {@link CloudWatchLogsServiceException}
98
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
78
99
  *
79
100
  */
80
101
  export declare class FilterLogEventsCommand extends $Command<FilterLogEventsCommandInput, FilterLogEventsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -31,6 +31,12 @@ export interface GetDataProtectionPolicyCommandOutput extends GetDataProtectionP
31
31
  * };
32
32
  * const command = new GetDataProtectionPolicyCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // { // GetDataProtectionPolicyResponse
35
+ * // logGroupIdentifier: "STRING_VALUE",
36
+ * // policyDocument: "STRING_VALUE",
37
+ * // lastUpdatedTime: Number("long"),
38
+ * // };
39
+ *
34
40
  * ```
35
41
  *
36
42
  * @param GetDataProtectionPolicyCommandInput - {@link GetDataProtectionPolicyCommandInput}
@@ -51,6 +57,8 @@ export interface GetDataProtectionPolicyCommandOutput extends GetDataProtectionP
51
57
  * @throws {@link ServiceUnavailableException} (server fault)
52
58
  * <p>The service cannot complete the request.</p>
53
59
  *
60
+ * @throws {@link CloudWatchLogsServiceException}
61
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
54
62
  *
55
63
  */
56
64
  export declare class GetDataProtectionPolicyCommand extends $Command<GetDataProtectionPolicyCommandInput, GetDataProtectionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -49,6 +49,18 @@ export interface GetLogEventsCommandOutput extends GetLogEventsResponse, __Metad
49
49
  * };
50
50
  * const command = new GetLogEventsCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // GetLogEventsResponse
53
+ * // events: [ // OutputLogEvents
54
+ * // { // OutputLogEvent
55
+ * // timestamp: Number("long"),
56
+ * // message: "STRING_VALUE",
57
+ * // ingestionTime: Number("long"),
58
+ * // },
59
+ * // ],
60
+ * // nextForwardToken: "STRING_VALUE",
61
+ * // nextBackwardToken: "STRING_VALUE",
62
+ * // };
63
+ *
52
64
  * ```
53
65
  *
54
66
  * @param GetLogEventsCommandInput - {@link GetLogEventsCommandInput}
@@ -66,6 +78,8 @@ export interface GetLogEventsCommandOutput extends GetLogEventsResponse, __Metad
66
78
  * @throws {@link ServiceUnavailableException} (server fault)
67
79
  * <p>The service cannot complete the request.</p>
68
80
  *
81
+ * @throws {@link CloudWatchLogsServiceException}
82
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
69
83
  *
70
84
  */
71
85
  export declare class GetLogEventsCommand extends $Command<GetLogEventsCommandInput, GetLogEventsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -47,6 +47,15 @@ export interface GetLogGroupFieldsCommandOutput extends GetLogGroupFieldsRespons
47
47
  * };
48
48
  * const command = new GetLogGroupFieldsCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // GetLogGroupFieldsResponse
51
+ * // logGroupFields: [ // LogGroupFieldList
52
+ * // { // LogGroupField
53
+ * // name: "STRING_VALUE",
54
+ * // percent: Number("int"),
55
+ * // },
56
+ * // ],
57
+ * // };
58
+ *
50
59
  * ```
51
60
  *
52
61
  * @param GetLogGroupFieldsCommandInput - {@link GetLogGroupFieldsCommandInput}
@@ -67,6 +76,8 @@ export interface GetLogGroupFieldsCommandOutput extends GetLogGroupFieldsRespons
67
76
  * @throws {@link ServiceUnavailableException} (server fault)
68
77
  * <p>The service cannot complete the request.</p>
69
78
  *
79
+ * @throws {@link CloudWatchLogsServiceException}
80
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
70
81
  *
71
82
  */
72
83
  export declare class GetLogGroupFieldsCommand extends $Command<GetLogGroupFieldsCommandInput, GetLogGroupFieldsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -35,6 +35,12 @@ export interface GetLogRecordCommandOutput extends GetLogRecordResponse, __Metad
35
35
  * };
36
36
  * const command = new GetLogRecordCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // GetLogRecordResponse
39
+ * // logRecord: { // LogRecord
40
+ * // "<keys>": "STRING_VALUE",
41
+ * // },
42
+ * // };
43
+ *
38
44
  * ```
39
45
  *
40
46
  * @param GetLogRecordCommandInput - {@link GetLogRecordCommandInput}
@@ -55,6 +61,8 @@ export interface GetLogRecordCommandOutput extends GetLogRecordResponse, __Metad
55
61
  * @throws {@link ServiceUnavailableException} (server fault)
56
62
  * <p>The service cannot complete the request.</p>
57
63
  *
64
+ * @throws {@link CloudWatchLogsServiceException}
65
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
58
66
  *
59
67
  */
60
68
  export declare class GetLogRecordCommand extends $Command<GetLogRecordCommandInput, GetLogRecordCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -43,6 +43,23 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsResponse, _
43
43
  * };
44
44
  * const command = new GetQueryResultsCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // GetQueryResultsResponse
47
+ * // results: [ // QueryResults
48
+ * // [ // ResultRows
49
+ * // { // ResultField
50
+ * // field: "STRING_VALUE",
51
+ * // value: "STRING_VALUE",
52
+ * // },
53
+ * // ],
54
+ * // ],
55
+ * // statistics: { // QueryStatistics
56
+ * // recordsMatched: Number("double"),
57
+ * // recordsScanned: Number("double"),
58
+ * // bytesScanned: Number("double"),
59
+ * // },
60
+ * // status: "Scheduled" || "Running" || "Complete" || "Failed" || "Cancelled" || "Timeout" || "Unknown",
61
+ * // };
62
+ *
46
63
  * ```
47
64
  *
48
65
  * @param GetQueryResultsCommandInput - {@link GetQueryResultsCommandInput}
@@ -60,6 +77,8 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsResponse, _
60
77
  * @throws {@link ServiceUnavailableException} (server fault)
61
78
  * <p>The service cannot complete the request.</p>
62
79
  *
80
+ * @throws {@link CloudWatchLogsServiceException}
81
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
63
82
  *
64
83
  */
65
84
  export declare class GetQueryResultsCommand extends $Command<GetQueryResultsCommandInput, GetQueryResultsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
32
32
  * };
33
33
  * const command = new ListTagsForResourceCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ListTagsForResourceResponse
36
+ * // tags: { // Tags
37
+ * // "<keys>": "STRING_VALUE",
38
+ * // },
39
+ * // };
40
+ *
35
41
  * ```
36
42
  *
37
43
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -49,6 +55,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
49
55
  * @throws {@link ServiceUnavailableException} (server fault)
50
56
  * <p>The service cannot complete the request.</p>
51
57
  *
58
+ * @throws {@link CloudWatchLogsServiceException}
59
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
52
60
  *
53
61
  */
54
62
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -37,6 +37,12 @@ export interface ListTagsLogGroupCommandOutput extends ListTagsLogGroupResponse,
37
37
  * };
38
38
  * const command = new ListTagsLogGroupCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ListTagsLogGroupResponse
41
+ * // tags: { // Tags
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // };
45
+ *
40
46
  * ```
41
47
  *
42
48
  * @param ListTagsLogGroupCommandInput - {@link ListTagsLogGroupCommandInput}
@@ -51,6 +57,8 @@ export interface ListTagsLogGroupCommandOutput extends ListTagsLogGroupResponse,
51
57
  * @throws {@link ServiceUnavailableException} (server fault)
52
58
  * <p>The service cannot complete the request.</p>
53
59
  *
60
+ * @throws {@link CloudWatchLogsServiceException}
61
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
54
62
  *
55
63
  */
56
64
  export declare class ListTagsLogGroupCommand extends $Command<ListTagsLogGroupCommandInput, ListTagsLogGroupCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -46,6 +46,12 @@ export interface PutDataProtectionPolicyCommandOutput extends PutDataProtectionP
46
46
  * };
47
47
  * const command = new PutDataProtectionPolicyCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // PutDataProtectionPolicyResponse
50
+ * // logGroupIdentifier: "STRING_VALUE",
51
+ * // policyDocument: "STRING_VALUE",
52
+ * // lastUpdatedTime: Number("long"),
53
+ * // };
54
+ *
49
55
  * ```
50
56
  *
51
57
  * @param PutDataProtectionPolicyCommandInput - {@link PutDataProtectionPolicyCommandInput}
@@ -69,6 +75,8 @@ export interface PutDataProtectionPolicyCommandOutput extends PutDataProtectionP
69
75
  * @throws {@link ServiceUnavailableException} (server fault)
70
76
  * <p>The service cannot complete the request.</p>
71
77
  *
78
+ * @throws {@link CloudWatchLogsServiceException}
79
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
72
80
  *
73
81
  */
74
82
  export declare class PutDataProtectionPolicyCommand extends $Command<PutDataProtectionPolicyCommandInput, PutDataProtectionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -45,6 +45,17 @@ export interface PutDestinationCommandOutput extends PutDestinationResponse, __M
45
45
  * };
46
46
  * const command = new PutDestinationCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // PutDestinationResponse
49
+ * // destination: { // Destination
50
+ * // destinationName: "STRING_VALUE",
51
+ * // targetArn: "STRING_VALUE",
52
+ * // roleArn: "STRING_VALUE",
53
+ * // accessPolicy: "STRING_VALUE",
54
+ * // arn: "STRING_VALUE",
55
+ * // creationTime: Number("long"),
56
+ * // },
57
+ * // };
58
+ *
48
59
  * ```
49
60
  *
50
61
  * @param PutDestinationCommandInput - {@link PutDestinationCommandInput}
@@ -62,6 +73,8 @@ export interface PutDestinationCommandOutput extends PutDestinationResponse, __M
62
73
  * @throws {@link ServiceUnavailableException} (server fault)
63
74
  * <p>The service cannot complete the request.</p>
64
75
  *
76
+ * @throws {@link CloudWatchLogsServiceException}
77
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
65
78
  *
66
79
  */
67
80
  export declare class PutDestinationCommand extends $Command<PutDestinationCommandInput, PutDestinationCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -35,6 +35,8 @@ export interface PutDestinationPolicyCommandOutput extends __MetadataBearer {
35
35
  * };
36
36
  * const command = new PutDestinationPolicyCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // {};
39
+ *
38
40
  * ```
39
41
  *
40
42
  * @param PutDestinationPolicyCommandInput - {@link PutDestinationPolicyCommandInput}
@@ -52,6 +54,8 @@ export interface PutDestinationPolicyCommandOutput extends __MetadataBearer {
52
54
  * @throws {@link ServiceUnavailableException} (server fault)
53
55
  * <p>The service cannot complete the request.</p>
54
56
  *
57
+ * @throws {@link CloudWatchLogsServiceException}
58
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
55
59
  *
56
60
  */
57
61
  export declare class PutDestinationPolicyCommand extends $Command<PutDestinationPolicyCommandInput, PutDestinationPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -84,6 +84,15 @@ export interface PutLogEventsCommandOutput extends PutLogEventsResponse, __Metad
84
84
  * };
85
85
  * const command = new PutLogEventsCommand(input);
86
86
  * const response = await client.send(command);
87
+ * // { // PutLogEventsResponse
88
+ * // nextSequenceToken: "STRING_VALUE",
89
+ * // rejectedLogEventsInfo: { // RejectedLogEventsInfo
90
+ * // tooNewLogEventStartIndex: Number("int"),
91
+ * // tooOldLogEventEndIndex: Number("int"),
92
+ * // expiredLogEventEndIndex: Number("int"),
93
+ * // },
94
+ * // };
95
+ *
87
96
  * ```
88
97
  *
89
98
  * @param PutLogEventsCommandInput - {@link PutLogEventsCommandInput}
@@ -126,6 +135,8 @@ export interface PutLogEventsCommandOutput extends PutLogEventsResponse, __Metad
126
135
  * <p>The most likely cause is an Amazon Web Services access key ID or secret key that's not
127
136
  * valid.</p>
128
137
  *
138
+ * @throws {@link CloudWatchLogsServiceException}
139
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
129
140
  *
130
141
  */
131
142
  export declare class PutLogEventsCommand extends $Command<PutLogEventsCommandInput, PutLogEventsCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -67,6 +67,8 @@ export interface PutMetricFilterCommandOutput extends __MetadataBearer {
67
67
  * };
68
68
  * const command = new PutMetricFilterCommand(input);
69
69
  * const response = await client.send(command);
70
+ * // {};
71
+ *
70
72
  * ```
71
73
  *
72
74
  * @param PutMetricFilterCommandInput - {@link PutMetricFilterCommandInput}
@@ -90,6 +92,8 @@ export interface PutMetricFilterCommandOutput extends __MetadataBearer {
90
92
  * @throws {@link ServiceUnavailableException} (server fault)
91
93
  * <p>The service cannot complete the request.</p>
92
94
  *
95
+ * @throws {@link CloudWatchLogsServiceException}
96
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
93
97
  *
94
98
  */
95
99
  export declare class PutMetricFilterCommand extends $Command<PutMetricFilterCommandInput, PutMetricFilterCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -46,6 +46,10 @@ export interface PutQueryDefinitionCommandOutput extends PutQueryDefinitionRespo
46
46
  * };
47
47
  * const command = new PutQueryDefinitionCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // PutQueryDefinitionResponse
50
+ * // queryDefinitionId: "STRING_VALUE",
51
+ * // };
52
+ *
49
53
  * ```
50
54
  *
51
55
  * @param PutQueryDefinitionCommandInput - {@link PutQueryDefinitionCommandInput}
@@ -66,6 +70,8 @@ export interface PutQueryDefinitionCommandOutput extends PutQueryDefinitionRespo
66
70
  * @throws {@link ServiceUnavailableException} (server fault)
67
71
  * <p>The service cannot complete the request.</p>
68
72
  *
73
+ * @throws {@link CloudWatchLogsServiceException}
74
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
69
75
  *
70
76
  */
71
77
  export declare class PutQueryDefinitionCommand extends $Command<PutQueryDefinitionCommandInput, PutQueryDefinitionCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -34,6 +34,14 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
34
34
  * };
35
35
  * const command = new PutResourcePolicyCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // PutResourcePolicyResponse
38
+ * // resourcePolicy: { // ResourcePolicy
39
+ * // policyName: "STRING_VALUE",
40
+ * // policyDocument: "STRING_VALUE",
41
+ * // lastUpdatedTime: Number("long"),
42
+ * // },
43
+ * // };
44
+ *
37
45
  * ```
38
46
  *
39
47
  * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
@@ -51,6 +59,8 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
51
59
  * @throws {@link ServiceUnavailableException} (server fault)
52
60
  * <p>The service cannot complete the request.</p>
53
61
  *
62
+ * @throws {@link CloudWatchLogsServiceException}
63
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
54
64
  *
55
65
  */
56
66
  export declare class PutResourcePolicyCommand extends $Command<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -46,6 +46,8 @@ export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {
46
46
  * };
47
47
  * const command = new PutRetentionPolicyCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // {};
50
+ *
49
51
  * ```
50
52
  *
51
53
  * @param PutRetentionPolicyCommandInput - {@link PutRetentionPolicyCommandInput}
@@ -66,6 +68,8 @@ export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {
66
68
  * @throws {@link ServiceUnavailableException} (server fault)
67
69
  * <p>The service cannot complete the request.</p>
68
70
  *
71
+ * @throws {@link CloudWatchLogsServiceException}
72
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
69
73
  *
70
74
  */
71
75
  export declare class PutRetentionPolicyCommand extends $Command<PutRetentionPolicyCommandInput, PutRetentionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -63,6 +63,8 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {
63
63
  * };
64
64
  * const command = new PutSubscriptionFilterCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // {};
67
+ *
66
68
  * ```
67
69
  *
68
70
  * @param PutSubscriptionFilterCommandInput - {@link PutSubscriptionFilterCommandInput}
@@ -86,6 +88,8 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {
86
88
  * @throws {@link ServiceUnavailableException} (server fault)
87
89
  * <p>The service cannot complete the request.</p>
88
90
  *
91
+ * @throws {@link CloudWatchLogsServiceException}
92
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
89
93
  *
90
94
  */
91
95
  export declare class PutSubscriptionFilterCommand extends $Command<PutSubscriptionFilterCommandInput, PutSubscriptionFilterCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -52,6 +52,10 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
52
52
  * };
53
53
  * const command = new StartQueryCommand(input);
54
54
  * const response = await client.send(command);
55
+ * // { // StartQueryResponse
56
+ * // queryId: "STRING_VALUE",
57
+ * // };
58
+ *
55
59
  * ```
56
60
  *
57
61
  * @param StartQueryCommandInput - {@link StartQueryCommandInput}
@@ -79,6 +83,8 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
79
83
  * @throws {@link ServiceUnavailableException} (server fault)
80
84
  * <p>The service cannot complete the request.</p>
81
85
  *
86
+ * @throws {@link CloudWatchLogsServiceException}
87
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
82
88
  *
83
89
  */
84
90
  export declare class StartQueryCommand extends $Command<StartQueryCommandInput, StartQueryCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -32,6 +32,10 @@ export interface StopQueryCommandOutput extends StopQueryResponse, __MetadataBea
32
32
  * };
33
33
  * const command = new StopQueryCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // StopQueryResponse
36
+ * // success: true || false,
37
+ * // };
38
+ *
35
39
  * ```
36
40
  *
37
41
  * @param StopQueryCommandInput - {@link StopQueryCommandInput}
@@ -49,6 +53,8 @@ export interface StopQueryCommandOutput extends StopQueryResponse, __MetadataBea
49
53
  * @throws {@link ServiceUnavailableException} (server fault)
50
54
  * <p>The service cannot complete the request.</p>
51
55
  *
56
+ * @throws {@link CloudWatchLogsServiceException}
57
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
52
58
  *
53
59
  */
54
60
  export declare class StopQueryCommand extends $Command<StopQueryCommandInput, StopQueryCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -49,6 +49,8 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {
49
49
  * };
50
50
  * const command = new TagLogGroupCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // {};
53
+ *
52
54
  * ```
53
55
  *
54
56
  * @param TagLogGroupCommandInput - {@link TagLogGroupCommandInput}
@@ -63,6 +65,8 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {
63
65
  * @throws {@link ResourceNotFoundException} (client fault)
64
66
  * <p>The specified resource does not exist.</p>
65
67
  *
68
+ * @throws {@link CloudWatchLogsServiceException}
69
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
66
70
  *
67
71
  */
68
72
  export declare class TagLogGroupCommand extends $Command<TagLogGroupCommandInput, TagLogGroupCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -45,6 +45,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
45
45
  * };
46
46
  * const command = new TagResourceCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // {};
49
+ *
48
50
  * ```
49
51
  *
50
52
  * @param TagResourceCommandInput - {@link TagResourceCommandInput}
@@ -65,6 +67,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
65
67
  * @throws {@link TooManyTagsException} (client fault)
66
68
  * <p>A resource can have no more than 50 tags.</p>
67
69
  *
70
+ * @throws {@link CloudWatchLogsServiceException}
71
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
68
72
  *
69
73
  */
70
74
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -35,6 +35,18 @@ export interface TestMetricFilterCommandOutput extends TestMetricFilterResponse,
35
35
  * };
36
36
  * const command = new TestMetricFilterCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // TestMetricFilterResponse
39
+ * // matches: [ // MetricFilterMatches
40
+ * // { // MetricFilterMatchRecord
41
+ * // eventNumber: Number("long"),
42
+ * // eventMessage: "STRING_VALUE",
43
+ * // extractedValues: { // ExtractedValues
44
+ * // "<keys>": "STRING_VALUE",
45
+ * // },
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
38
50
  * ```
39
51
  *
40
52
  * @param TestMetricFilterCommandInput - {@link TestMetricFilterCommandInput}
@@ -49,6 +61,8 @@ export interface TestMetricFilterCommandOutput extends TestMetricFilterResponse,
49
61
  * @throws {@link ServiceUnavailableException} (server fault)
50
62
  * <p>The service cannot complete the request.</p>
51
63
  *
64
+ * @throws {@link CloudWatchLogsServiceException}
65
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
52
66
  *
53
67
  */
54
68
  export declare class TestMetricFilterCommand extends $Command<TestMetricFilterCommandInput, TestMetricFilterCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -46,6 +46,8 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {
46
46
  * };
47
47
  * const command = new UntagLogGroupCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // {};
50
+ *
49
51
  * ```
50
52
  *
51
53
  * @param UntagLogGroupCommandInput - {@link UntagLogGroupCommandInput}
@@ -57,6 +59,8 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {
57
59
  * @throws {@link ResourceNotFoundException} (client fault)
58
60
  * <p>The specified resource does not exist.</p>
59
61
  *
62
+ * @throws {@link CloudWatchLogsServiceException}
63
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
60
64
  *
61
65
  */
62
66
  export declare class UntagLogGroupCommand extends $Command<UntagLogGroupCommandInput, UntagLogGroupCommandOutput, CloudWatchLogsClientResolvedConfig> {
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -51,6 +53,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
51
53
  * @throws {@link ServiceUnavailableException} (server fault)
52
54
  * <p>The service cannot complete the request.</p>
53
55
  *
56
+ * @throws {@link CloudWatchLogsServiceException}
57
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
54
58
  *
55
59
  */
56
60
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CloudWatchLogsClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudwatch-logs",
3
3
  "description": "AWS SDK for JavaScript Cloudwatch Logs Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.327.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.327.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.327.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -32,11 +32,11 @@
32
32
  "@aws-sdk/middleware-host-header": "3.325.0",
33
33
  "@aws-sdk/middleware-logger": "3.325.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.325.0",
35
- "@aws-sdk/middleware-retry": "3.325.0",
35
+ "@aws-sdk/middleware-retry": "3.327.0",
36
36
  "@aws-sdk/middleware-serde": "3.325.0",
37
37
  "@aws-sdk/middleware-signing": "3.325.0",
38
38
  "@aws-sdk/middleware-stack": "3.325.0",
39
- "@aws-sdk/middleware-user-agent": "3.325.0",
39
+ "@aws-sdk/middleware-user-agent": "3.327.0",
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.321.1",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
@@ -48,8 +48,8 @@
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
49
  "@aws-sdk/util-defaults-mode-browser": "3.325.0",
50
50
  "@aws-sdk/util-defaults-mode-node": "3.325.0",
51
- "@aws-sdk/util-endpoints": "3.319.0",
52
- "@aws-sdk/util-retry": "3.310.0",
51
+ "@aws-sdk/util-endpoints": "3.327.0",
52
+ "@aws-sdk/util-retry": "3.327.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",
54
54
  "@aws-sdk/util-user-agent-node": "3.310.0",
55
55
  "@aws-sdk/util-utf8": "3.310.0",