@aws-sdk/client-amp 3.451.0 → 3.458.0

package/dist-types/models/models_0.d.ts

@@ -364,6 +364,23 @@ export interface PutAlertManagerDefinitionResponse {
      */
     status: AlertManagerDefinitionStatus | undefined;
 }
+/**
+ * @public
+ * Represents the input of a GetDefaultScraperConfiguration operation.
+ */
+export interface GetDefaultScraperConfigurationRequest {
+}
+/**
+ * @public
+ * Represents the output of a GetDefaultScraperConfiguration operation.
+ */
+export interface GetDefaultScraperConfigurationResponse {
+    /**
+     * @public
+     * The default configuration.
+     */
+    configuration: Uint8Array | undefined;
+}
 /**
  * @public
  */
@@ -384,6 +401,449 @@ export interface ListTagsForResourceResponse {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ * A representation of an AMP destination.
+ */
+export interface AmpConfiguration {
+    /**
+     * @public
+     * The ARN of an AMP workspace.
+     */
+    workspaceArn: string | undefined;
+}
+/**
+ * @public
+ * A representation of a destination that a scraper can produce metrics to.
+ */
+export type Destination = Destination.AmpConfigurationMember | Destination.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace Destination {
+    /**
+     * @public
+     * A representation of an AMP destination.
+     */
+    interface AmpConfigurationMember {
+        ampConfiguration: AmpConfiguration;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        ampConfiguration?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        ampConfiguration: (value: AmpConfiguration) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: Destination, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * A representation of a Prometheus configuration file.
+ */
+export type ScrapeConfiguration = ScrapeConfiguration.ConfigurationBlobMember | ScrapeConfiguration.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace ScrapeConfiguration {
+    /**
+     * @public
+     * Binary data representing a Prometheus configuration file.
+     */
+    interface ConfigurationBlobMember {
+        configurationBlob: Uint8Array;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        configurationBlob?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        configurationBlob: (value: Uint8Array) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: ScrapeConfiguration, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * A representation of an EKS source.
+ */
+export interface EksConfiguration {
+    /**
+     * @public
+     * The ARN of an EKS cluster.
+     */
+    clusterArn: string | undefined;
+    /**
+     * @public
+     * A list of security group IDs specified for VPC configuration.
+     */
+    securityGroupIds?: string[];
+    /**
+     * @public
+     * A list of subnet IDs specified for VPC configuration.
+     */
+    subnetIds: string[] | undefined;
+}
+/**
+ * @public
+ * A representation of a source that a scraper can discover and collect metrics from.
+ */
+export type Source = Source.EksConfigurationMember | Source.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace Source {
+    /**
+     * @public
+     * A representation of an EKS source.
+     */
+    interface EksConfigurationMember {
+        eksConfiguration: EksConfiguration;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        eksConfiguration?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        eksConfiguration: (value: EksConfiguration) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: Source, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * Represents the input of a CreateScraper operation.
+ */
+export interface CreateScraperRequest {
+    /**
+     * @public
+     * An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique.
+     */
+    alias?: string;
+    /**
+     * @public
+     * The configuration used to create the scraper.
+     */
+    scrapeConfiguration: ScrapeConfiguration | undefined;
+    /**
+     * @public
+     * The source that the scraper will be discovering and collecting metrics from.
+     */
+    source: Source | undefined;
+    /**
+     * @public
+     * The destination that the scraper will be producing metrics to.
+     */
+    destination: Destination | undefined;
+    /**
+     * @public
+     * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
+     */
+    clientToken?: string;
+    /**
+     * @public
+     * Optional, user-provided tags for this scraper.
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ScraperStatusCode: {
+    /**
+     * Scraper has been created and is usable.
+     */
+    readonly ACTIVE: "ACTIVE";
+    /**
+     * Scraper is being created. Deletion is disallowed until status is ACTIVE.
+     */
+    readonly CREATING: "CREATING";
+    /**
+     * Scraper creation failed.
+     */
+    readonly CREATION_FAILED: "CREATION_FAILED";
+    /**
+     * Scraper is being deleted. Deletions are allowed only when status is ACTIVE.
+     */
+    readonly DELETING: "DELETING";
+    /**
+     * Scraper deletion failed.
+     */
+    readonly DELETION_FAILED: "DELETION_FAILED";
+};
+/**
+ * @public
+ */
+export type ScraperStatusCode = (typeof ScraperStatusCode)[keyof typeof ScraperStatusCode];
+/**
+ * @public
+ * Represents the status of a scraper.
+ */
+export interface ScraperStatus {
+    /**
+     * @public
+     * Status code of this scraper.
+     */
+    statusCode: ScraperStatusCode | undefined;
+}
+/**
+ * @public
+ * Represents the output of a CreateScraper operation.
+ */
+export interface CreateScraperResponse {
+    /**
+     * @public
+     * The generated ID of the scraper that was just created.
+     */
+    scraperId: string | undefined;
+    /**
+     * @public
+     * The ARN of the scraper that was just created.
+     */
+    arn: string | undefined;
+    /**
+     * @public
+     * The status of the scraper that was just created (usually CREATING).
+     */
+    status: ScraperStatus | undefined;
+    /**
+     * @public
+     * The tags of this scraper.
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ * Represents the input of a DeleteScraper operation.
+ */
+export interface DeleteScraperRequest {
+    /**
+     * @public
+     * The ID of the scraper to delete.
+     */
+    scraperId: string | undefined;
+    /**
+     * @public
+     * Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
+     */
+    clientToken?: string;
+}
+/**
+ * @public
+ * Represents the output of a DeleteScraper operation.
+ */
+export interface DeleteScraperResponse {
+    /**
+     * @public
+     * The ID of the scraper that was deleted.
+     */
+    scraperId: string | undefined;
+    /**
+     * @public
+     * The status of the scraper that is being deleted.
+     */
+    status: ScraperStatus | undefined;
+}
+/**
+ * @public
+ * Represents the input of a DescribeScraper operation.
+ */
+export interface DescribeScraperRequest {
+    /**
+     * @public
+     * The IDs of the scraper to describe.
+     */
+    scraperId: string | undefined;
+}
+/**
+ * @public
+ * Represents the properties of a scraper.
+ */
+export interface ScraperDescription {
+    /**
+     * @public
+     * Alias of this scraper.
+     */
+    alias?: string;
+    /**
+     * @public
+     * Unique string identifying this scraper.
+     */
+    scraperId: string | undefined;
+    /**
+     * @public
+     * The Amazon Resource Name (ARN) of this scraper.
+     */
+    arn: string | undefined;
+    /**
+     * @public
+     * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
+     */
+    roleArn: string | undefined;
+    /**
+     * @public
+     * The status of this scraper.
+     */
+    status: ScraperStatus | undefined;
+    /**
+     * @public
+     * The time when the scraper was created.
+     */
+    createdAt: Date | undefined;
+    /**
+     * @public
+     * The time when the scraper was last modified.
+     */
+    lastModifiedAt: Date | undefined;
+    /**
+     * @public
+     * The tags of this scraper.
+     */
+    tags?: Record<string, string>;
+    /**
+     * @public
+     * The reason for failure if any.
+     */
+    statusReason?: string;
+    /**
+     * @public
+     * The configuration used to create the scraper.
+     */
+    scrapeConfiguration: ScrapeConfiguration | undefined;
+    /**
+     * @public
+     * The source that the scraper is discovering and collecting metrics from.
+     */
+    source: Source | undefined;
+    /**
+     * @public
+     * The destination that the scraper is producing metrics to.
+     */
+    destination: Destination | undefined;
+}
+/**
+ * @public
+ * Represents the output of a DescribeScraper operation.
+ */
+export interface DescribeScraperResponse {
+    /**
+     * @public
+     * The properties of the selected scrapers.
+     */
+    scraper: ScraperDescription | undefined;
+}
+/**
+ * @public
+ * Represents the input of a ListScrapers operation.
+ */
+export interface ListScrapersRequest {
+    /**
+     * @public
+     * A list of scraper filters.
+     */
+    filters?: Record<string, string[]>;
+    /**
+     * @public
+     * Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.
+     */
+    nextToken?: string;
+    /**
+     * @public
+     * Maximum results to return in response (default=100, maximum=1000).
+     */
+    maxResults?: number;
+}
+/**
+ * @public
+ * Represents a summary of the properties of a scraper.
+ */
+export interface ScraperSummary {
+    /**
+     * @public
+     * Alias of this scraper.
+     */
+    alias?: string;
+    /**
+     * @public
+     * Unique string identifying this scraper.
+     */
+    scraperId: string | undefined;
+    /**
+     * @public
+     * The Amazon Resource Name (ARN) of this scraper.
+     */
+    arn: string | undefined;
+    /**
+     * @public
+     * The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
+     */
+    roleArn: string | undefined;
+    /**
+     * @public
+     * The status of this scraper.
+     */
+    status: ScraperStatus | undefined;
+    /**
+     * @public
+     * The time when the scraper was created.
+     */
+    createdAt: Date | undefined;
+    /**
+     * @public
+     * The time when the scraper was last modified.
+     */
+    lastModifiedAt: Date | undefined;
+    /**
+     * @public
+     * The tags of this scraper.
+     */
+    tags?: Record<string, string>;
+    /**
+     * @public
+     * The reason for failure if any.
+     */
+    statusReason?: string;
+    /**
+     * @public
+     * The source that the scraper is discovering and collecting metrics from.
+     */
+    source: Source | undefined;
+    /**
+     * @public
+     * The destination that the scraper is producing metrics to.
+     */
+    destination: Destination | undefined;
+}
+/**
+ * @public
+ * Represents the output of a ListScrapers operation.
+ */
+export interface ListScrapersResponse {
+    /**
+     * @public
+     * The list of scrapers, filtered down if a set of filters was provided in the request.
+     */
+    scrapers: ScraperSummary[] | undefined;
+    /**
+     * @public
+     * Pagination token to use when requesting the next page in this list.
+     */
+    nextToken?: string;
+}
 /**
  * @public
  */

package/dist-types/pagination/ListScrapersPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { ListScrapersCommandInput, ListScrapersCommandOutput } from "../commands/ListScrapersCommand";
+import { AmpPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateListScrapers(config: AmpPaginationConfiguration, input: ListScrapersCommandInput, ...additionalArguments: any): Paginator<ListScrapersCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./Interfaces";
 export * from "./ListRuleGroupsNamespacesPaginator";
+export * from "./ListScrapersPaginator";
 export * from "./ListWorkspacesPaginator";

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -3,16 +3,21 @@ import { SerdeContext as __SerdeContext } from "@smithy/types";
 import { CreateAlertManagerDefinitionCommandInput, CreateAlertManagerDefinitionCommandOutput } from "../commands/CreateAlertManagerDefinitionCommand";
 import { CreateLoggingConfigurationCommandInput, CreateLoggingConfigurationCommandOutput } from "../commands/CreateLoggingConfigurationCommand";
 import { CreateRuleGroupsNamespaceCommandInput, CreateRuleGroupsNamespaceCommandOutput } from "../commands/CreateRuleGroupsNamespaceCommand";
+import { CreateScraperCommandInput, CreateScraperCommandOutput } from "../commands/CreateScraperCommand";
 import { CreateWorkspaceCommandInput, CreateWorkspaceCommandOutput } from "../commands/CreateWorkspaceCommand";
 import { DeleteAlertManagerDefinitionCommandInput, DeleteAlertManagerDefinitionCommandOutput } from "../commands/DeleteAlertManagerDefinitionCommand";
 import { DeleteLoggingConfigurationCommandInput, DeleteLoggingConfigurationCommandOutput } from "../commands/DeleteLoggingConfigurationCommand";
 import { DeleteRuleGroupsNamespaceCommandInput, DeleteRuleGroupsNamespaceCommandOutput } from "../commands/DeleteRuleGroupsNamespaceCommand";
+import { DeleteScraperCommandInput, DeleteScraperCommandOutput } from "../commands/DeleteScraperCommand";
 import { DeleteWorkspaceCommandInput, DeleteWorkspaceCommandOutput } from "../commands/DeleteWorkspaceCommand";
 import { DescribeAlertManagerDefinitionCommandInput, DescribeAlertManagerDefinitionCommandOutput } from "../commands/DescribeAlertManagerDefinitionCommand";
 import { DescribeLoggingConfigurationCommandInput, DescribeLoggingConfigurationCommandOutput } from "../commands/DescribeLoggingConfigurationCommand";
 import { DescribeRuleGroupsNamespaceCommandInput, DescribeRuleGroupsNamespaceCommandOutput } from "../commands/DescribeRuleGroupsNamespaceCommand";
+import { DescribeScraperCommandInput, DescribeScraperCommandOutput } from "../commands/DescribeScraperCommand";
 import { DescribeWorkspaceCommandInput, DescribeWorkspaceCommandOutput } from "../commands/DescribeWorkspaceCommand";
+import { GetDefaultScraperConfigurationCommandInput, GetDefaultScraperConfigurationCommandOutput } from "../commands/GetDefaultScraperConfigurationCommand";
 import { ListRuleGroupsNamespacesCommandInput, ListRuleGroupsNamespacesCommandOutput } from "../commands/ListRuleGroupsNamespacesCommand";
+import { ListScrapersCommandInput, ListScrapersCommandOutput } from "../commands/ListScrapersCommand";
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
 import { ListWorkspacesCommandInput, ListWorkspacesCommandOutput } from "../commands/ListWorkspacesCommand";
 import { PutAlertManagerDefinitionCommandInput, PutAlertManagerDefinitionCommandOutput } from "../commands/PutAlertManagerDefinitionCommand";
@@ -33,6 +38,10 @@ export declare const se_CreateLoggingConfigurationCommand: (input: CreateLogging
  * serializeAws_restJson1CreateRuleGroupsNamespaceCommand
  */
 export declare const se_CreateRuleGroupsNamespaceCommand: (input: CreateRuleGroupsNamespaceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1CreateScraperCommand
+ */
+export declare const se_CreateScraperCommand: (input: CreateScraperCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1CreateWorkspaceCommand
  */
@@ -49,6 +58,10 @@ export declare const se_DeleteLoggingConfigurationCommand: (input: DeleteLogging
  * serializeAws_restJson1DeleteRuleGroupsNamespaceCommand
  */
 export declare const se_DeleteRuleGroupsNamespaceCommand: (input: DeleteRuleGroupsNamespaceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1DeleteScraperCommand
+ */
+export declare const se_DeleteScraperCommand: (input: DeleteScraperCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1DeleteWorkspaceCommand
  */
@@ -65,14 +78,26 @@ export declare const se_DescribeLoggingConfigurationCommand: (input: DescribeLog
  * serializeAws_restJson1DescribeRuleGroupsNamespaceCommand
  */
 export declare const se_DescribeRuleGroupsNamespaceCommand: (input: DescribeRuleGroupsNamespaceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1DescribeScraperCommand
+ */
+export declare const se_DescribeScraperCommand: (input: DescribeScraperCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1DescribeWorkspaceCommand
  */
 export declare const se_DescribeWorkspaceCommand: (input: DescribeWorkspaceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetDefaultScraperConfigurationCommand
+ */
+export declare const se_GetDefaultScraperConfigurationCommand: (input: GetDefaultScraperConfigurationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1ListRuleGroupsNamespacesCommand
  */
 export declare const se_ListRuleGroupsNamespacesCommand: (input: ListRuleGroupsNamespacesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1ListScrapersCommand
+ */
+export declare const se_ListScrapersCommand: (input: ListScrapersCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1ListTagsForResourceCommand
  */
@@ -117,6 +142,10 @@ export declare const de_CreateLoggingConfigurationCommand: (output: __HttpRespon
  * deserializeAws_restJson1CreateRuleGroupsNamespaceCommand
  */
 export declare const de_CreateRuleGroupsNamespaceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateRuleGroupsNamespaceCommandOutput>;
+/**
+ * deserializeAws_restJson1CreateScraperCommand
+ */
+export declare const de_CreateScraperCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateScraperCommandOutput>;
 /**
  * deserializeAws_restJson1CreateWorkspaceCommand
  */
@@ -133,6 +162,10 @@ export declare const de_DeleteLoggingConfigurationCommand: (output: __HttpRespon
  * deserializeAws_restJson1DeleteRuleGroupsNamespaceCommand
  */
 export declare const de_DeleteRuleGroupsNamespaceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteRuleGroupsNamespaceCommandOutput>;
+/**
+ * deserializeAws_restJson1DeleteScraperCommand
+ */
+export declare const de_DeleteScraperCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteScraperCommandOutput>;
 /**
  * deserializeAws_restJson1DeleteWorkspaceCommand
  */
@@ -149,14 +182,26 @@ export declare const de_DescribeLoggingConfigurationCommand: (output: __HttpResp
  * deserializeAws_restJson1DescribeRuleGroupsNamespaceCommand
  */
 export declare const de_DescribeRuleGroupsNamespaceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeRuleGroupsNamespaceCommandOutput>;
+/**
+ * deserializeAws_restJson1DescribeScraperCommand
+ */
+export declare const de_DescribeScraperCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeScraperCommandOutput>;
 /**
  * deserializeAws_restJson1DescribeWorkspaceCommand
  */
 export declare const de_DescribeWorkspaceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DescribeWorkspaceCommandOutput>;
+/**
+ * deserializeAws_restJson1GetDefaultScraperConfigurationCommand
+ */
+export declare const de_GetDefaultScraperConfigurationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetDefaultScraperConfigurationCommandOutput>;
 /**
  * deserializeAws_restJson1ListRuleGroupsNamespacesCommand
  */
 export declare const de_ListRuleGroupsNamespacesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListRuleGroupsNamespacesCommandOutput>;
+/**
+ * deserializeAws_restJson1ListScrapersCommand
+ */
+export declare const de_ListScrapersCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListScrapersCommandOutput>;
 /**
  * deserializeAws_restJson1ListTagsForResourceCommand
  */