@aws-sdk/client-amp 3.775.0 → 3.782.0

package/dist-types/commands/CreateAlertManagerDefinitionCommand.d.ts

@@ -84,6 +84,7 @@ declare const CreateAlertManagerDefinitionCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class CreateAlertManagerDefinitionCommand extends CreateAlertManagerDefinitionCommand_base {

package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts

@@ -74,6 +74,7 @@ declare const CreateLoggingConfigurationCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class CreateLoggingConfigurationCommand extends CreateLoggingConfigurationCommand_base {

package/dist-types/commands/CreateRuleGroupsNamespaceCommand.d.ts

@@ -94,6 +94,7 @@ declare const CreateRuleGroupsNamespaceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class CreateRuleGroupsNamespaceCommand extends CreateRuleGroupsNamespaceCommand_base {

package/dist-types/commands/CreateScraperCommand.d.ts

@@ -127,6 +127,52 @@ declare const CreateScraperCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
+ * @example CreateScraper with optional alias input, optional clientToken input, and one set of tags
+ * ```javascript
+ * //
+ * const input = {
+ *   alias: "alias",
+ *   clientToken: "token",
+ *   destination: {
+ *     ampConfiguration: {
+ *       workspaceArn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234"
+ *     }
+ *   },
+ *   scrapeConfiguration: {
+ *     configurationBlob: "blob"
+ *   },
+ *   source: {
+ *     eksConfiguration: {
+ *       clusterArn: "arn:aws:eks:us-west-2:123456789012:cluster/example",
+ *       securityGroupIds: [
+ *         "sg-abc123"
+ *       ],
+ *       subnetIds: [
+ *         "subnet-abc123"
+ *       ]
+ *     }
+ *   },
+ *   tags: {
+ *     exampleTag: "exampleValue"
+ *   }
+ * };
+ * const command = new CreateScraperCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123",
+ *   scraperId: "scraper-123",
+ *   status: {
+ *     statusCode: "CREATING"
+ *   },
+ *   tags: {
+ *     exampleTag: "exampleValue"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class CreateScraperCommand extends CreateScraperCommand_base {

package/dist-types/commands/CreateWorkspaceCommand.d.ts

@@ -88,6 +88,7 @@ declare const CreateWorkspaceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class CreateWorkspaceCommand extends CreateWorkspaceCommand_base {

package/dist-types/commands/DeleteAlertManagerDefinitionCommand.d.ts

@@ -72,6 +72,7 @@ declare const DeleteAlertManagerDefinitionCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteAlertManagerDefinitionCommand extends DeleteAlertManagerDefinitionCommand_base {

package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts

@@ -69,6 +69,7 @@ declare const DeleteLoggingConfigurationCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteLoggingConfigurationCommand extends DeleteLoggingConfigurationCommand_base {

package/dist-types/commands/DeleteRuleGroupsNamespaceCommand.d.ts

@@ -73,6 +73,7 @@ declare const DeleteRuleGroupsNamespaceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteRuleGroupsNamespaceCommand extends DeleteRuleGroupsNamespaceCommand_base {

package/dist-types/commands/DeleteScraperCommand.d.ts

@@ -78,6 +78,26 @@ declare const DeleteScraperCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
+ * @example DeleteScraper with optional clientToken input
+ * ```javascript
+ * //
+ * const input = {
+ *   clientToken: "token",
+ *   scraperId: "scraper-123"
+ * };
+ * const command = new DeleteScraperCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   scraperId: "scraper-123",
+ *   status: {
+ *     statusCode: "DELETING"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DeleteScraperCommand extends DeleteScraperCommand_base {

package/dist-types/commands/DeleteWorkspaceCommand.d.ts

@@ -76,6 +76,7 @@ declare const DeleteWorkspaceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DeleteWorkspaceCommand extends DeleteWorkspaceCommand_base {

package/dist-types/commands/DescribeAlertManagerDefinitionCommand.d.ts

@@ -79,6 +79,7 @@ declare const DescribeAlertManagerDefinitionCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeAlertManagerDefinitionCommand extends DescribeAlertManagerDefinitionCommand_base {

package/dist-types/commands/DescribeLoggingConfigurationCommand.d.ts

@@ -77,6 +77,7 @@ declare const DescribeLoggingConfigurationCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeLoggingConfigurationCommand extends DescribeLoggingConfigurationCommand_base {

package/dist-types/commands/DescribeRuleGroupsNamespaceCommand.d.ts

@@ -85,6 +85,7 @@ declare const DescribeRuleGroupsNamespaceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeRuleGroupsNamespaceCommand extends DescribeRuleGroupsNamespaceCommand_base {

package/dist-types/commands/DescribeScraperCommand.d.ts

@@ -108,6 +108,54 @@ declare const DescribeScraperCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
+ * @example DescribeScraper, with no statusReason to report
+ * ```javascript
+ * //
+ * const input = {
+ *   scraperId: "scraper-123"
+ * };
+ * const command = new DescribeScraperCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   scraper: {
+ *     alias: "alias",
+ *     arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123",
+ *     createdAt: "2023-01-01T00:00:00Z",
+ *     destination: {
+ *       ampConfiguration: {
+ *         workspaceArn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234"
+ *       }
+ *     },
+ *     lastModifiedAt: "2020-01-02T00:00:00Z",
+ *     roleArn: "arn:aws:iam::123456789012:role/exampleRole",
+ *     scrapeConfiguration: {
+ *       configurationBlob: "blob"
+ *     },
+ *     scraperId: "scraper-123",
+ *     source: {
+ *       eksConfiguration: {
+ *         clusterArn: "arn:aws:eks:us-west-2:123456789012:cluster/example",
+ *         securityGroupIds: [
+ *           "sg-abc123"
+ *         ],
+ *         subnetIds: [
+ *           "subnet-abc123"
+ *         ]
+ *       }
+ *     },
+ *     status: {
+ *       statusCode: "ACTIVE"
+ *     },
+ *     tags: {
+ *       exampleTag: "exampleValue"
+ *     }
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DescribeScraperCommand extends DescribeScraperCommand_base {

package/dist-types/commands/DescribeWorkspaceCommand.d.ts

@@ -83,6 +83,7 @@ declare const DescribeWorkspaceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeWorkspaceCommand extends DescribeWorkspaceCommand_base {

package/dist-types/commands/GetDefaultScraperConfigurationCommand.d.ts

@@ -62,6 +62,20 @@ declare const GetDefaultScraperConfigurationCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
+ * @example GetDefaultScraperConfiguration
+ * ```javascript
+ * //
+ * const input = { /* empty *\/ };
+ * const command = new GetDefaultScraperConfigurationCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   configuration: "blob"
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class GetDefaultScraperConfigurationCommand extends GetDefaultScraperConfigurationCommand_base {

package/dist-types/commands/ListRuleGroupsNamespacesCommand.d.ts

@@ -88,6 +88,7 @@ declare const ListRuleGroupsNamespacesCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class ListRuleGroupsNamespacesCommand extends ListRuleGroupsNamespacesCommand_base {

package/dist-types/commands/ListScrapersCommand.d.ts

@@ -112,6 +112,140 @@ declare const ListScrapersCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
+ * @example ListScrapers, with a max result of 2, using a pagination token from a previous call to ListScrapers
+ * ```javascript
+ * //
+ * const input = {
+ *   maxResults: 2,
+ *   nextToken: "previouslyGeneratedToken"
+ * };
+ * const command = new ListScrapersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   scrapers: [
+ *     {
+ *       alias: "alias1",
+ *       arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123",
+ *       createdAt: "2023-01-01T00:00:00Z",
+ *       destination: {
+ *         ampConfiguration: {
+ *           workspaceArn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234"
+ *         }
+ *       },
+ *       lastModifiedAt: "2020-01-02T00:00:00Z",
+ *       roleArn: "arn:aws:iam::123456789012:role/exampleRole",
+ *       scraperId: "scraper-123",
+ *       source: {
+ *         eksConfiguration: {
+ *           clusterArn: "arn:aws:eks:us-west-2:123456789012:cluster/example1",
+ *           securityGroupIds: [
+ *             "sg-abc123"
+ *           ],
+ *           subnetIds: [
+ *             "subnet-abc123"
+ *           ]
+ *         }
+ *       },
+ *       status: {
+ *         statusCode: "ACTIVE"
+ *       },
+ *       tags: {
+ *         exampleTag: "exampleValue"
+ *       }
+ *     },
+ *     {
+ *       alias: "alias2",
+ *       arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-456",
+ *       createdAt: "2023-01-01T00:00:00Z",
+ *       destination: {
+ *         ampConfiguration: {
+ *           workspaceArn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234"
+ *         }
+ *       },
+ *       lastModifiedAt: "2020-01-02T00:00:00Z",
+ *       roleArn: "arn:aws:iam::123456789012:role/exampleRole",
+ *       scraperId: "scraper-456",
+ *       source: {
+ *         eksConfiguration: {
+ *           clusterArn: "arn:aws:eks:us-west-2:123456789012:cluster/example2",
+ *           securityGroupIds: [
+ *             "sg-abc456"
+ *           ],
+ *           subnetIds: [
+ *             "subnet-abc456"
+ *           ]
+ *         }
+ *       },
+ *       status: {
+ *         statusCode: "CREATING"
+ *       },
+ *       tags: {
+ *         exampleTag: "exampleValue"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example ListScrapers, with filters
+ * ```javascript
+ * //
+ * const input = {
+ *   filters: {
+ *     alias: [
+ *       "alias1"
+ *     ],
+ *     sourceArn: [
+ *       "arn:aws:eks:us-west-2:123456789012:cluster/example1"
+ *     ],
+ *     status: [
+ *       "ACTIVE"
+ *     ]
+ *   }
+ * };
+ * const command = new ListScrapersCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   scrapers: [
+ *     {
+ *       alias: "alias1",
+ *       arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123",
+ *       createdAt: "2023-01-01T00:00:00Z",
+ *       destination: {
+ *         ampConfiguration: {
+ *           workspaceArn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234"
+ *         }
+ *       },
+ *       lastModifiedAt: "2020-01-02T00:00:00Z",
+ *       roleArn: "arn:aws:iam::123456789012:role/exampleRole",
+ *       scraperId: "scraper-123",
+ *       source: {
+ *         eksConfiguration: {
+ *           clusterArn: "arn:aws:eks:us-west-2:123456789012:cluster/example1",
+ *           securityGroupIds: [
+ *             "sg-abc123"
+ *           ],
+ *           subnetIds: [
+ *             "subnet-abc123"
+ *           ]
+ *         }
+ *       },
+ *       status: {
+ *         statusCode: "ACTIVE"
+ *       },
+ *       tags: {
+ *         exampleTag: "exampleValue"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class ListScrapersCommand extends ListScrapersCommand_base {

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -74,6 +74,7 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {

package/dist-types/commands/ListWorkspacesCommand.d.ts

@@ -85,6 +85,7 @@ declare const ListWorkspacesCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class ListWorkspacesCommand extends ListWorkspacesCommand_base {

package/dist-types/commands/PutAlertManagerDefinitionCommand.d.ts

@@ -83,6 +83,7 @@ declare const PutAlertManagerDefinitionCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class PutAlertManagerDefinitionCommand extends PutAlertManagerDefinitionCommand_base {

package/dist-types/commands/PutRuleGroupsNamespaceCommand.d.ts

@@ -93,6 +93,7 @@ declare const PutRuleGroupsNamespaceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class PutRuleGroupsNamespaceCommand extends PutRuleGroupsNamespaceCommand_base {

package/dist-types/commands/TagResourceCommand.d.ts

@@ -77,6 +77,7 @@ declare const TagResourceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -72,6 +72,7 @@ declare const UntagResourceCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {

package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts

@@ -76,6 +76,7 @@ declare const UpdateLoggingConfigurationCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateLoggingConfigurationCommand extends UpdateLoggingConfigurationCommand_base {

package/dist-types/commands/UpdateScraperCommand.d.ts

@@ -100,6 +100,39 @@ declare const UpdateScraperCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
+ * @example UpdateScraper with all optional parameters
+ * ```javascript
+ * //
+ * const input = {
+ *   alias: "alias-update",
+ *   clientToken: "token",
+ *   destination: {
+ *     ampConfiguration: {
+ *       workspaceArn: "arn:aws:aps:us-west-2:123456789012:workspace/ws-ogh2u499-ce12-hg89-v6c7-123412341234-update"
+ *     }
+ *   },
+ *   scrapeConfiguration: {
+ *     configurationBlob: "blob-update"
+ *   },
+ *   scraperId: "scraper-123"
+ * };
+ * const command = new UpdateScraperCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   arn: "arn:aws:aps:us-west-2:123456789012:scraper/scraper-123",
+ *   scraperId: "scraper-123",
+ *   status: {
+ *     statusCode: "UPDATING"
+ *   },
+ *   tags: {
+ *     exampleTag: "exampleValue"
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class UpdateScraperCommand extends UpdateScraperCommand_base {

package/dist-types/commands/UpdateWorkspaceAliasCommand.d.ts

@@ -76,6 +76,7 @@ declare const UpdateWorkspaceAliasCommand_base: {
  * @throws {@link AmpServiceException}
  * <p>Base exception class for all service exceptions from Amp service.</p>
  *
+ *
  * @public
  */
 export declare class UpdateWorkspaceAliasCommand extends UpdateWorkspaceAliasCommand_base {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-amp",
   "description": "AWS SDK for JavaScript Amp Client for Node.js, Browser and React Native",
-  "version": "3.775.0",
+  "version": "3.782.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-amp",
@@ -21,16 +21,16 @@
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
     "@aws-sdk/core": "3.775.0",
-    "@aws-sdk/credential-provider-node": "3.775.0",
+    "@aws-sdk/credential-provider-node": "3.782.0",
     "@aws-sdk/middleware-host-header": "3.775.0",
     "@aws-sdk/middleware-logger": "3.775.0",
     "@aws-sdk/middleware-recursion-detection": "3.775.0",
-    "@aws-sdk/middleware-user-agent": "3.775.0",
+    "@aws-sdk/middleware-user-agent": "3.782.0",
     "@aws-sdk/region-config-resolver": "3.775.0",
     "@aws-sdk/types": "3.775.0",
-    "@aws-sdk/util-endpoints": "3.775.0",
+    "@aws-sdk/util-endpoints": "3.782.0",
     "@aws-sdk/util-user-agent-browser": "3.775.0",
-    "@aws-sdk/util-user-agent-node": "3.775.0",
+    "@aws-sdk/util-user-agent-node": "3.782.0",
     "@smithy/config-resolver": "^4.1.0",
     "@smithy/core": "^3.2.0",
     "@smithy/fetch-http-handler": "^5.0.2",