|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { ListLogGroupsRequest, ListLogGroupsResponse } from "../models/models_0"; |
| 10 | +import { de_ListLogGroupsCommand, se_ListLogGroupsCommand } from "../protocols/Aws_json1_1"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link ListLogGroupsCommand}. |
| 21 | + */ |
| 22 | +export interface ListLogGroupsCommandInput extends ListLogGroupsRequest {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link ListLogGroupsCommand}. |
| 27 | + */ |
| 28 | +export interface ListLogGroupsCommandOutput extends ListLogGroupsResponse, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Returns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can |
| 32 | + * choose to also return log groups from source accounts that are linked to the monitoring account. For more information about using cross-account |
| 33 | + * observability to set up monitoring accounts and source accounts, see |
| 34 | + * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html"> |
| 35 | + * CloudWatch cross-account observability</a>.</p> |
| 36 | + * <p>You can optionally filter the list by log group class and by using regular expressions in your request to match strings in the log group names.</p> |
| 37 | + * <p>This operation is paginated. By default, your first use of this operation returns 50 results, and includes a token to use in a subsequent operation to return |
| 38 | + * more results.</p> |
| 39 | + * @example |
| 40 | + * Use a bare-bones client and the command you need to make an API call. |
| 41 | + * ```javascript |
| 42 | + * import { CloudWatchLogsClient, ListLogGroupsCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import |
| 43 | + * // const { CloudWatchLogsClient, ListLogGroupsCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import |
| 44 | + * const client = new CloudWatchLogsClient(config); |
| 45 | + * const input = { // ListLogGroupsRequest |
| 46 | + * logGroupNamePattern: "STRING_VALUE", |
| 47 | + * logGroupClass: "STANDARD" || "INFREQUENT_ACCESS" || "DELIVERY", |
| 48 | + * includeLinkedAccounts: true || false, |
| 49 | + * accountIdentifiers: [ // AccountIds |
| 50 | + * "STRING_VALUE", |
| 51 | + * ], |
| 52 | + * nextToken: "STRING_VALUE", |
| 53 | + * limit: Number("int"), |
| 54 | + * }; |
| 55 | + * const command = new ListLogGroupsCommand(input); |
| 56 | + * const response = await client.send(command); |
| 57 | + * // { // ListLogGroupsResponse |
| 58 | + * // logGroups: [ // LogGroupSummaries |
| 59 | + * // { // LogGroupSummary |
| 60 | + * // logGroupName: "STRING_VALUE", |
| 61 | + * // logGroupArn: "STRING_VALUE", |
| 62 | + * // logGroupClass: "STANDARD" || "INFREQUENT_ACCESS" || "DELIVERY", |
| 63 | + * // }, |
| 64 | + * // ], |
| 65 | + * // nextToken: "STRING_VALUE", |
| 66 | + * // }; |
| 67 | + * |
| 68 | + * ``` |
| 69 | + * |
| 70 | + * @param ListLogGroupsCommandInput - {@link ListLogGroupsCommandInput} |
| 71 | + * @returns {@link ListLogGroupsCommandOutput} |
| 72 | + * @see {@link ListLogGroupsCommandInput} for command's `input` shape. |
| 73 | + * @see {@link ListLogGroupsCommandOutput} for command's `response` shape. |
| 74 | + * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape. |
| 75 | + * |
| 76 | + * @throws {@link InvalidParameterException} (client fault) |
| 77 | + * <p>A parameter is specified incorrectly.</p> |
| 78 | + * |
| 79 | + * @throws {@link ServiceUnavailableException} (server fault) |
| 80 | + * <p>The service cannot complete the request.</p> |
| 81 | + * |
| 82 | + * @throws {@link CloudWatchLogsServiceException} |
| 83 | + * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p> |
| 84 | + * |
| 85 | + * |
| 86 | + * @public |
| 87 | + */ |
| 88 | +export class ListLogGroupsCommand extends $Command |
| 89 | + .classBuilder< |
| 90 | + ListLogGroupsCommandInput, |
| 91 | + ListLogGroupsCommandOutput, |
| 92 | + CloudWatchLogsClientResolvedConfig, |
| 93 | + ServiceInputTypes, |
| 94 | + ServiceOutputTypes |
| 95 | + >() |
| 96 | + .ep(commonParams) |
| 97 | + .m(function (this: any, Command: any, cs: any, config: CloudWatchLogsClientResolvedConfig, o: any) { |
| 98 | + return [ |
| 99 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 100 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 101 | + ]; |
| 102 | + }) |
| 103 | + .s("Logs_20140328", "ListLogGroups", {}) |
| 104 | + .n("CloudWatchLogsClient", "ListLogGroupsCommand") |
| 105 | + .f(void 0, void 0) |
| 106 | + .ser(se_ListLogGroupsCommand) |
| 107 | + .de(de_ListLogGroupsCommand) |
| 108 | + .build() { |
| 109 | + /** @internal type navigation helper, not in runtime. */ |
| 110 | + protected declare static __types: { |
| 111 | + api: { |
| 112 | + input: ListLogGroupsRequest; |
| 113 | + output: ListLogGroupsResponse; |
| 114 | + }; |
| 115 | + sdk: { |
| 116 | + input: ListLogGroupsCommandInput; |
| 117 | + output: ListLogGroupsCommandOutput; |
| 118 | + }; |
| 119 | + }; |
| 120 | +} |
0 commit comments