File: /var/www/javago_test/node_modules/aws-sdk/clients/amp.d.ts
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Amp extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Amp.Types.ClientConfiguration)
config: Config & Amp.Types.ClientConfiguration;
/**
* Create an alert manager definition.
*/
createAlertManagerDefinition(params: Amp.Types.CreateAlertManagerDefinitionRequest, callback?: (err: AWSError, data: Amp.Types.CreateAlertManagerDefinitionResponse) => void): Request<Amp.Types.CreateAlertManagerDefinitionResponse, AWSError>;
/**
* Create an alert manager definition.
*/
createAlertManagerDefinition(callback?: (err: AWSError, data: Amp.Types.CreateAlertManagerDefinitionResponse) => void): Request<Amp.Types.CreateAlertManagerDefinitionResponse, AWSError>;
/**
* Create logging configuration.
*/
createLoggingConfiguration(params: Amp.Types.CreateLoggingConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.CreateLoggingConfigurationResponse) => void): Request<Amp.Types.CreateLoggingConfigurationResponse, AWSError>;
/**
* Create logging configuration.
*/
createLoggingConfiguration(callback?: (err: AWSError, data: Amp.Types.CreateLoggingConfigurationResponse) => void): Request<Amp.Types.CreateLoggingConfigurationResponse, AWSError>;
/**
* Create a rule group namespace.
*/
createRuleGroupsNamespace(params: Amp.Types.CreateRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: Amp.Types.CreateRuleGroupsNamespaceResponse) => void): Request<Amp.Types.CreateRuleGroupsNamespaceResponse, AWSError>;
/**
* Create a rule group namespace.
*/
createRuleGroupsNamespace(callback?: (err: AWSError, data: Amp.Types.CreateRuleGroupsNamespaceResponse) => void): Request<Amp.Types.CreateRuleGroupsNamespaceResponse, AWSError>;
/**
* Create a scraper.
*/
createScraper(params: Amp.Types.CreateScraperRequest, callback?: (err: AWSError, data: Amp.Types.CreateScraperResponse) => void): Request<Amp.Types.CreateScraperResponse, AWSError>;
/**
* Create a scraper.
*/
createScraper(callback?: (err: AWSError, data: Amp.Types.CreateScraperResponse) => void): Request<Amp.Types.CreateScraperResponse, AWSError>;
/**
* Creates a new AMP workspace.
*/
createWorkspace(params: Amp.Types.CreateWorkspaceRequest, callback?: (err: AWSError, data: Amp.Types.CreateWorkspaceResponse) => void): Request<Amp.Types.CreateWorkspaceResponse, AWSError>;
/**
* Creates a new AMP workspace.
*/
createWorkspace(callback?: (err: AWSError, data: Amp.Types.CreateWorkspaceResponse) => void): Request<Amp.Types.CreateWorkspaceResponse, AWSError>;
/**
* Deletes an alert manager definition.
*/
deleteAlertManagerDefinition(params: Amp.Types.DeleteAlertManagerDefinitionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an alert manager definition.
*/
deleteAlertManagerDefinition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete logging configuration.
*/
deleteLoggingConfiguration(params: Amp.Types.DeleteLoggingConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete logging configuration.
*/
deleteLoggingConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a rule groups namespace.
*/
deleteRuleGroupsNamespace(params: Amp.Types.DeleteRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a rule groups namespace.
*/
deleteRuleGroupsNamespace(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a scraper.
*/
deleteScraper(params: Amp.Types.DeleteScraperRequest, callback?: (err: AWSError, data: Amp.Types.DeleteScraperResponse) => void): Request<Amp.Types.DeleteScraperResponse, AWSError>;
/**
* Deletes a scraper.
*/
deleteScraper(callback?: (err: AWSError, data: Amp.Types.DeleteScraperResponse) => void): Request<Amp.Types.DeleteScraperResponse, AWSError>;
/**
* Deletes an AMP workspace.
*/
deleteWorkspace(params: Amp.Types.DeleteWorkspaceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an AMP workspace.
*/
deleteWorkspace(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Describes an alert manager definition.
*/
describeAlertManagerDefinition(params: Amp.Types.DescribeAlertManagerDefinitionRequest, callback?: (err: AWSError, data: Amp.Types.DescribeAlertManagerDefinitionResponse) => void): Request<Amp.Types.DescribeAlertManagerDefinitionResponse, AWSError>;
/**
* Describes an alert manager definition.
*/
describeAlertManagerDefinition(callback?: (err: AWSError, data: Amp.Types.DescribeAlertManagerDefinitionResponse) => void): Request<Amp.Types.DescribeAlertManagerDefinitionResponse, AWSError>;
/**
* Describes logging configuration.
*/
describeLoggingConfiguration(params: Amp.Types.DescribeLoggingConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.DescribeLoggingConfigurationResponse) => void): Request<Amp.Types.DescribeLoggingConfigurationResponse, AWSError>;
/**
* Describes logging configuration.
*/
describeLoggingConfiguration(callback?: (err: AWSError, data: Amp.Types.DescribeLoggingConfigurationResponse) => void): Request<Amp.Types.DescribeLoggingConfigurationResponse, AWSError>;
/**
* Describe a rule groups namespace.
*/
describeRuleGroupsNamespace(params: Amp.Types.DescribeRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: Amp.Types.DescribeRuleGroupsNamespaceResponse) => void): Request<Amp.Types.DescribeRuleGroupsNamespaceResponse, AWSError>;
/**
* Describe a rule groups namespace.
*/
describeRuleGroupsNamespace(callback?: (err: AWSError, data: Amp.Types.DescribeRuleGroupsNamespaceResponse) => void): Request<Amp.Types.DescribeRuleGroupsNamespaceResponse, AWSError>;
/**
* Describe an existing scraper.
*/
describeScraper(params: Amp.Types.DescribeScraperRequest, callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
/**
* Describe an existing scraper.
*/
describeScraper(callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
/**
* Describes an existing AMP workspace.
*/
describeWorkspace(params: Amp.Types.DescribeWorkspaceRequest, callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
/**
* Describes an existing AMP workspace.
*/
describeWorkspace(callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
/**
* Gets a default configuration.
*/
getDefaultScraperConfiguration(params: Amp.Types.GetDefaultScraperConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.GetDefaultScraperConfigurationResponse) => void): Request<Amp.Types.GetDefaultScraperConfigurationResponse, AWSError>;
/**
* Gets a default configuration.
*/
getDefaultScraperConfiguration(callback?: (err: AWSError, data: Amp.Types.GetDefaultScraperConfigurationResponse) => void): Request<Amp.Types.GetDefaultScraperConfigurationResponse, AWSError>;
/**
* Lists rule groups namespaces.
*/
listRuleGroupsNamespaces(params: Amp.Types.ListRuleGroupsNamespacesRequest, callback?: (err: AWSError, data: Amp.Types.ListRuleGroupsNamespacesResponse) => void): Request<Amp.Types.ListRuleGroupsNamespacesResponse, AWSError>;
/**
* Lists rule groups namespaces.
*/
listRuleGroupsNamespaces(callback?: (err: AWSError, data: Amp.Types.ListRuleGroupsNamespacesResponse) => void): Request<Amp.Types.ListRuleGroupsNamespacesResponse, AWSError>;
/**
* Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.
*/
listScrapers(params: Amp.Types.ListScrapersRequest, callback?: (err: AWSError, data: Amp.Types.ListScrapersResponse) => void): Request<Amp.Types.ListScrapersResponse, AWSError>;
/**
* Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.
*/
listScrapers(callback?: (err: AWSError, data: Amp.Types.ListScrapersResponse) => void): Request<Amp.Types.ListScrapersResponse, AWSError>;
/**
* Lists the tags you have assigned to the resource.
*/
listTagsForResource(params: Amp.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Amp.Types.ListTagsForResourceResponse) => void): Request<Amp.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags you have assigned to the resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Amp.Types.ListTagsForResourceResponse) => void): Request<Amp.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all AMP workspaces, including workspaces being created or deleted.
*/
listWorkspaces(params: Amp.Types.ListWorkspacesRequest, callback?: (err: AWSError, data: Amp.Types.ListWorkspacesResponse) => void): Request<Amp.Types.ListWorkspacesResponse, AWSError>;
/**
* Lists all AMP workspaces, including workspaces being created or deleted.
*/
listWorkspaces(callback?: (err: AWSError, data: Amp.Types.ListWorkspacesResponse) => void): Request<Amp.Types.ListWorkspacesResponse, AWSError>;
/**
* Update an alert manager definition.
*/
putAlertManagerDefinition(params: Amp.Types.PutAlertManagerDefinitionRequest, callback?: (err: AWSError, data: Amp.Types.PutAlertManagerDefinitionResponse) => void): Request<Amp.Types.PutAlertManagerDefinitionResponse, AWSError>;
/**
* Update an alert manager definition.
*/
putAlertManagerDefinition(callback?: (err: AWSError, data: Amp.Types.PutAlertManagerDefinitionResponse) => void): Request<Amp.Types.PutAlertManagerDefinitionResponse, AWSError>;
/**
* Update a rule groups namespace.
*/
putRuleGroupsNamespace(params: Amp.Types.PutRuleGroupsNamespaceRequest, callback?: (err: AWSError, data: Amp.Types.PutRuleGroupsNamespaceResponse) => void): Request<Amp.Types.PutRuleGroupsNamespaceResponse, AWSError>;
/**
* Update a rule groups namespace.
*/
putRuleGroupsNamespace(callback?: (err: AWSError, data: Amp.Types.PutRuleGroupsNamespaceResponse) => void): Request<Amp.Types.PutRuleGroupsNamespaceResponse, AWSError>;
/**
* Creates tags for the specified resource.
*/
tagResource(params: Amp.Types.TagResourceRequest, callback?: (err: AWSError, data: Amp.Types.TagResourceResponse) => void): Request<Amp.Types.TagResourceResponse, AWSError>;
/**
* Creates tags for the specified resource.
*/
tagResource(callback?: (err: AWSError, data: Amp.Types.TagResourceResponse) => void): Request<Amp.Types.TagResourceResponse, AWSError>;
/**
* Deletes tags from the specified resource.
*/
untagResource(params: Amp.Types.UntagResourceRequest, callback?: (err: AWSError, data: Amp.Types.UntagResourceResponse) => void): Request<Amp.Types.UntagResourceResponse, AWSError>;
/**
* Deletes tags from the specified resource.
*/
untagResource(callback?: (err: AWSError, data: Amp.Types.UntagResourceResponse) => void): Request<Amp.Types.UntagResourceResponse, AWSError>;
/**
* Update logging configuration.
*/
updateLoggingConfiguration(params: Amp.Types.UpdateLoggingConfigurationRequest, callback?: (err: AWSError, data: Amp.Types.UpdateLoggingConfigurationResponse) => void): Request<Amp.Types.UpdateLoggingConfigurationResponse, AWSError>;
/**
* Update logging configuration.
*/
updateLoggingConfiguration(callback?: (err: AWSError, data: Amp.Types.UpdateLoggingConfigurationResponse) => void): Request<Amp.Types.UpdateLoggingConfigurationResponse, AWSError>;
/**
* Updates an AMP workspace alias.
*/
updateWorkspaceAlias(params: Amp.Types.UpdateWorkspaceAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates an AMP workspace alias.
*/
updateWorkspaceAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Waits for the scraperActive state by periodically calling the underlying Amp.describeScraperoperation every 2 seconds (at most 60 times). Wait until a scraper reaches ACTIVE status
*/
waitFor(state: "scraperActive", params: Amp.Types.DescribeScraperRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
/**
* Waits for the scraperActive state by periodically calling the underlying Amp.describeScraperoperation every 2 seconds (at most 60 times). Wait until a scraper reaches ACTIVE status
*/
waitFor(state: "scraperActive", callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
/**
* Waits for the scraperDeleted state by periodically calling the underlying Amp.describeScraperoperation every 2 seconds (at most 60 times). Wait until a scraper reaches DELETED status
*/
waitFor(state: "scraperDeleted", params: Amp.Types.DescribeScraperRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
/**
* Waits for the scraperDeleted state by periodically calling the underlying Amp.describeScraperoperation every 2 seconds (at most 60 times). Wait until a scraper reaches DELETED status
*/
waitFor(state: "scraperDeleted", callback?: (err: AWSError, data: Amp.Types.DescribeScraperResponse) => void): Request<Amp.Types.DescribeScraperResponse, AWSError>;
/**
* Waits for the workspaceActive state by periodically calling the underlying Amp.describeWorkspaceoperation every 2 seconds (at most 60 times). Wait until a workspace reaches ACTIVE status
*/
waitFor(state: "workspaceActive", params: Amp.Types.DescribeWorkspaceRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
/**
* Waits for the workspaceActive state by periodically calling the underlying Amp.describeWorkspaceoperation every 2 seconds (at most 60 times). Wait until a workspace reaches ACTIVE status
*/
waitFor(state: "workspaceActive", callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
/**
* Waits for the workspaceDeleted state by periodically calling the underlying Amp.describeWorkspaceoperation every 2 seconds (at most 60 times). Wait until a workspace reaches DELETED status
*/
waitFor(state: "workspaceDeleted", params: Amp.Types.DescribeWorkspaceRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
/**
* Waits for the workspaceDeleted state by periodically calling the underlying Amp.describeWorkspaceoperation every 2 seconds (at most 60 times). Wait until a workspace reaches DELETED status
*/
waitFor(state: "workspaceDeleted", callback?: (err: AWSError, data: Amp.Types.DescribeWorkspaceResponse) => void): Request<Amp.Types.DescribeWorkspaceResponse, AWSError>;
}
declare namespace Amp {
export type AlertManagerDefinitionData = Buffer|Uint8Array|Blob|string;
export interface AlertManagerDefinitionDescription {
/**
* The status of alert manager definition.
*/
status: AlertManagerDefinitionStatus;
/**
* The alert manager definition.
*/
data: AlertManagerDefinitionData;
/**
* The time when the alert manager definition was created.
*/
createdAt: Timestamp;
/**
* The time when the alert manager definition was modified.
*/
modifiedAt: Timestamp;
}
export interface AlertManagerDefinitionStatus {
/**
* Status code of this definition.
*/
statusCode: AlertManagerDefinitionStatusCode;
/**
* The reason for failure if any.
*/
statusReason?: String;
}
export type AlertManagerDefinitionStatusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED"|string;
export interface AmpConfiguration {
/**
* The ARN of an AMP workspace.
*/
workspaceArn: WorkspaceArn;
}
export type _Blob = Buffer|Uint8Array|Blob|string;
export type ClusterArn = string;
export interface CreateAlertManagerDefinitionRequest {
/**
* The ID of the workspace in which to create the alert manager definition.
*/
workspaceId: WorkspaceId;
/**
* The alert manager definition data.
*/
data: AlertManagerDefinitionData;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface CreateAlertManagerDefinitionResponse {
/**
* The status of alert manager definition.
*/
status: AlertManagerDefinitionStatus;
}
export interface CreateLoggingConfigurationRequest {
/**
* The ID of the workspace to vend logs to.
*/
workspaceId: WorkspaceId;
/**
* The ARN of the CW log group to which the vended log data will be published.
*/
logGroupArn: LogGroupArn;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface CreateLoggingConfigurationResponse {
/**
* The status of the logging configuration.
*/
status: LoggingConfigurationStatus;
}
export interface CreateRuleGroupsNamespaceRequest {
/**
* The ID of the workspace in which to create the rule group namespace.
*/
workspaceId: WorkspaceId;
/**
* The rule groups namespace name.
*/
name: RuleGroupsNamespaceName;
/**
* The namespace data that define the rule groups.
*/
data: RuleGroupsNamespaceData;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
/**
* Optional, user-provided tags for this rule groups namespace.
*/
tags?: TagMap;
}
export interface CreateRuleGroupsNamespaceResponse {
/**
* The rule groups namespace name.
*/
name: RuleGroupsNamespaceName;
/**
* The Amazon Resource Name (ARN) of this rule groups namespace.
*/
arn: RuleGroupsNamespaceArn;
/**
* The status of rule groups namespace.
*/
status: RuleGroupsNamespaceStatus;
/**
* The tags of this rule groups namespace.
*/
tags?: TagMap;
}
export interface CreateScraperRequest {
/**
* An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique.
*/
alias?: ScraperAlias;
/**
* The configuration used to create the scraper.
*/
scrapeConfiguration: ScrapeConfiguration;
/**
* The source that the scraper will be discovering and collecting metrics from.
*/
source: Source;
/**
* The destination that the scraper will be producing metrics to.
*/
destination: Destination;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
/**
* Optional, user-provided tags for this scraper.
*/
tags?: TagMap;
}
export interface CreateScraperResponse {
/**
* The generated ID of the scraper that was just created.
*/
scraperId: ScraperId;
/**
* The ARN of the scraper that was just created.
*/
arn: ScraperArn;
/**
* The status of the scraper that was just created (usually CREATING).
*/
status: ScraperStatus;
/**
* The tags of this scraper.
*/
tags?: TagMap;
}
export interface CreateWorkspaceRequest {
/**
* An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.
*/
alias?: WorkspaceAlias;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
/**
* Optional, user-provided tags for this workspace.
*/
tags?: TagMap;
/**
* Optional, customer managed KMS key used to encrypt data for this workspace
*/
kmsKeyArn?: KmsKeyArn;
}
export interface CreateWorkspaceResponse {
/**
* The generated ID of the workspace that was just created.
*/
workspaceId: WorkspaceId;
/**
* The ARN of the workspace that was just created.
*/
arn: WorkspaceArn;
/**
* The status of the workspace that was just created (usually CREATING).
*/
status: WorkspaceStatus;
/**
* The tags of this workspace.
*/
tags?: TagMap;
/**
* Customer managed KMS key ARN for this workspace
*/
kmsKeyArn?: KmsKeyArn;
}
export interface DeleteAlertManagerDefinitionRequest {
/**
* The ID of the workspace in which to delete the alert manager definition.
*/
workspaceId: WorkspaceId;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface DeleteLoggingConfigurationRequest {
/**
* The ID of the workspace to vend logs to.
*/
workspaceId: WorkspaceId;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface DeleteRuleGroupsNamespaceRequest {
/**
* The ID of the workspace to delete rule group definition.
*/
workspaceId: WorkspaceId;
/**
* The rule groups namespace name.
*/
name: RuleGroupsNamespaceName;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface DeleteScraperRequest {
/**
* The ID of the scraper to delete.
*/
scraperId: ScraperId;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface DeleteScraperResponse {
/**
* The ID of the scraper that was deleted.
*/
scraperId: ScraperId;
/**
* The status of the scraper that is being deleted.
*/
status: ScraperStatus;
}
export interface DeleteWorkspaceRequest {
/**
* The ID of the workspace to delete.
*/
workspaceId: WorkspaceId;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface DescribeAlertManagerDefinitionRequest {
/**
* The ID of the workspace to describe.
*/
workspaceId: WorkspaceId;
}
export interface DescribeAlertManagerDefinitionResponse {
/**
* The properties of the selected workspace's alert manager definition.
*/
alertManagerDefinition: AlertManagerDefinitionDescription;
}
export interface DescribeLoggingConfigurationRequest {
/**
* The ID of the workspace to vend logs to.
*/
workspaceId: WorkspaceId;
}
export interface DescribeLoggingConfigurationResponse {
/**
* Metadata object containing information about the logging configuration of a workspace.
*/
loggingConfiguration: LoggingConfigurationMetadata;
}
export interface DescribeRuleGroupsNamespaceRequest {
/**
* The ID of the workspace to describe.
*/
workspaceId: WorkspaceId;
/**
* The rule groups namespace.
*/
name: RuleGroupsNamespaceName;
}
export interface DescribeRuleGroupsNamespaceResponse {
/**
* The selected rule groups namespace.
*/
ruleGroupsNamespace: RuleGroupsNamespaceDescription;
}
export interface DescribeScraperRequest {
/**
* The IDs of the scraper to describe.
*/
scraperId: ScraperId;
}
export interface DescribeScraperResponse {
/**
* The properties of the selected scrapers.
*/
scraper: ScraperDescription;
}
export interface DescribeWorkspaceRequest {
/**
* The ID of the workspace to describe.
*/
workspaceId: WorkspaceId;
}
export interface DescribeWorkspaceResponse {
/**
* The properties of the selected workspace.
*/
workspace: WorkspaceDescription;
}
export interface Destination {
/**
* A representation of an AMP destination.
*/
ampConfiguration?: AmpConfiguration;
}
export interface EksConfiguration {
/**
* The ARN of an EKS cluster.
*/
clusterArn: ClusterArn;
/**
* A list of security group IDs specified for VPC configuration.
*/
securityGroupIds?: SecurityGroupIds;
/**
* A list of subnet IDs specified for VPC configuration.
*/
subnetIds: SubnetIds;
}
export type FilterKey = string;
export type FilterValue = string;
export type FilterValues = FilterValue[];
export interface GetDefaultScraperConfigurationRequest {
}
export interface GetDefaultScraperConfigurationResponse {
/**
* The default configuration.
*/
configuration: _Blob;
}
export type IamRoleArn = string;
export type IdempotencyToken = string;
export type KmsKeyArn = string;
export interface ListRuleGroupsNamespacesRequest {
/**
* The ID of the workspace.
*/
workspaceId: WorkspaceId;
/**
* Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.
*/
name?: RuleGroupsNamespaceName;
/**
* Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.
*/
nextToken?: PaginationToken;
/**
* Maximum results to return in response (default=100, maximum=1000).
*/
maxResults?: ListRuleGroupsNamespacesRequestMaxResultsInteger;
}
export type ListRuleGroupsNamespacesRequestMaxResultsInteger = number;
export interface ListRuleGroupsNamespacesResponse {
/**
* The list of the selected rule groups namespaces.
*/
ruleGroupsNamespaces: RuleGroupsNamespaceSummaryList;
/**
* Pagination token to use when requesting the next page in this list.
*/
nextToken?: PaginationToken;
}
export interface ListScrapersRequest {
/**
* A list of scraper filters.
*/
filters?: ScraperFilters;
/**
* Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.
*/
nextToken?: PaginationToken;
/**
* Maximum results to return in response (default=100, maximum=1000).
*/
maxResults?: ListScrapersRequestMaxResultsInteger;
}
export type ListScrapersRequestMaxResultsInteger = number;
export interface ListScrapersResponse {
/**
* The list of scrapers, filtered down if a set of filters was provided in the request.
*/
scrapers: ScraperSummaryList;
/**
* Pagination token to use when requesting the next page in this list.
*/
nextToken?: PaginationToken;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the resource.
*/
resourceArn: String;
}
export interface ListTagsForResourceResponse {
tags?: TagMap;
}
export interface ListWorkspacesRequest {
/**
* Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
*/
nextToken?: PaginationToken;
/**
* Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
*/
alias?: WorkspaceAlias;
/**
* Maximum results to return in response (default=100, maximum=1000).
*/
maxResults?: ListWorkspacesRequestMaxResultsInteger;
}
export type ListWorkspacesRequestMaxResultsInteger = number;
export interface ListWorkspacesResponse {
/**
* The list of existing workspaces, including those undergoing creation or deletion.
*/
workspaces: WorkspaceSummaryList;
/**
* Pagination token to use when requesting the next page in this list.
*/
nextToken?: PaginationToken;
}
export type LogGroupArn = string;
export interface LoggingConfigurationMetadata {
/**
* The status of the logging configuration.
*/
status: LoggingConfigurationStatus;
/**
* The workspace where the logging configuration exists.
*/
workspace: WorkspaceId;
/**
* The ARN of the CW log group to which the vended log data will be published.
*/
logGroupArn: LogGroupArn;
/**
* The time when the logging configuration was created.
*/
createdAt: Timestamp;
/**
* The time when the logging configuration was modified.
*/
modifiedAt: Timestamp;
}
export interface LoggingConfigurationStatus {
/**
* Status code of the logging configuration.
*/
statusCode: LoggingConfigurationStatusCode;
/**
* The reason for failure if any.
*/
statusReason?: String;
}
export type LoggingConfigurationStatusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED"|string;
export type PaginationToken = string;
export interface PutAlertManagerDefinitionRequest {
/**
* The ID of the workspace in which to update the alert manager definition.
*/
workspaceId: WorkspaceId;
/**
* The alert manager definition data.
*/
data: AlertManagerDefinitionData;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface PutAlertManagerDefinitionResponse {
/**
* The status of alert manager definition.
*/
status: AlertManagerDefinitionStatus;
}
export interface PutRuleGroupsNamespaceRequest {
/**
* The ID of the workspace in which to update the rule group namespace.
*/
workspaceId: WorkspaceId;
/**
* The rule groups namespace name.
*/
name: RuleGroupsNamespaceName;
/**
* The namespace data that define the rule groups.
*/
data: RuleGroupsNamespaceData;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface PutRuleGroupsNamespaceResponse {
/**
* The rule groups namespace name.
*/
name: RuleGroupsNamespaceName;
/**
* The Amazon Resource Name (ARN) of this rule groups namespace.
*/
arn: RuleGroupsNamespaceArn;
/**
* The status of rule groups namespace.
*/
status: RuleGroupsNamespaceStatus;
/**
* The tags of this rule groups namespace.
*/
tags?: TagMap;
}
export type RuleGroupsNamespaceArn = string;
export type RuleGroupsNamespaceData = Buffer|Uint8Array|Blob|string;
export interface RuleGroupsNamespaceDescription {
/**
* The Amazon Resource Name (ARN) of this rule groups namespace.
*/
arn: RuleGroupsNamespaceArn;
/**
* The rule groups namespace name.
*/
name: RuleGroupsNamespaceName;
/**
* The status of rule groups namespace.
*/
status: RuleGroupsNamespaceStatus;
/**
* The rule groups namespace data.
*/
data: RuleGroupsNamespaceData;
/**
* The time when the rule groups namespace was created.
*/
createdAt: Timestamp;
/**
* The time when the rule groups namespace was modified.
*/
modifiedAt: Timestamp;
/**
* The tags of this rule groups namespace.
*/
tags?: TagMap;
}
export type RuleGroupsNamespaceName = string;
export interface RuleGroupsNamespaceStatus {
/**
* Status code of this namespace.
*/
statusCode: RuleGroupsNamespaceStatusCode;
/**
* The reason for failure if any.
*/
statusReason?: String;
}
export type RuleGroupsNamespaceStatusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|"UPDATE_FAILED"|string;
export interface RuleGroupsNamespaceSummary {
/**
* The Amazon Resource Name (ARN) of this rule groups namespace.
*/
arn: RuleGroupsNamespaceArn;
/**
* The rule groups namespace name.
*/
name: RuleGroupsNamespaceName;
/**
* The status of rule groups namespace.
*/
status: RuleGroupsNamespaceStatus;
/**
* The time when the rule groups namespace was created.
*/
createdAt: Timestamp;
/**
* The time when the rule groups namespace was modified.
*/
modifiedAt: Timestamp;
/**
* The tags of this rule groups namespace.
*/
tags?: TagMap;
}
export type RuleGroupsNamespaceSummaryList = RuleGroupsNamespaceSummary[];
export interface ScrapeConfiguration {
/**
* Binary data representing a Prometheus configuration file.
*/
configurationBlob?: _Blob;
}
export type ScraperAlias = string;
export type ScraperArn = string;
export interface ScraperDescription {
/**
* Alias of this scraper.
*/
alias?: ScraperAlias;
/**
* Unique string identifying this scraper.
*/
scraperId: ScraperId;
/**
* The Amazon Resource Name (ARN) of this scraper.
*/
arn: ScraperArn;
/**
* 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: IamRoleArn;
/**
* The status of this scraper.
*/
status: ScraperStatus;
/**
* The time when the scraper was created.
*/
createdAt: Timestamp;
/**
* The time when the scraper was last modified.
*/
lastModifiedAt: Timestamp;
/**
* The tags of this scraper.
*/
tags?: TagMap;
/**
* The reason for failure if any.
*/
statusReason?: StatusReason;
/**
* The configuration used to create the scraper.
*/
scrapeConfiguration: ScrapeConfiguration;
/**
* The source that the scraper is discovering and collecting metrics from.
*/
source: Source;
/**
* The destination that the scraper is producing metrics to.
*/
destination: Destination;
}
export type ScraperFilters = {[key: string]: FilterValues};
export type ScraperId = string;
export interface ScraperStatus {
/**
* Status code of this scraper.
*/
statusCode: ScraperStatusCode;
}
export type ScraperStatusCode = "CREATING"|"ACTIVE"|"DELETING"|"CREATION_FAILED"|"DELETION_FAILED"|string;
export interface ScraperSummary {
/**
* Alias of this scraper.
*/
alias?: ScraperAlias;
/**
* Unique string identifying this scraper.
*/
scraperId: ScraperId;
/**
* The Amazon Resource Name (ARN) of this scraper.
*/
arn: ScraperArn;
/**
* 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: IamRoleArn;
/**
* The status of this scraper.
*/
status: ScraperStatus;
/**
* The time when the scraper was created.
*/
createdAt: Timestamp;
/**
* The time when the scraper was last modified.
*/
lastModifiedAt: Timestamp;
/**
* The tags of this scraper.
*/
tags?: TagMap;
/**
* The reason for failure if any.
*/
statusReason?: StatusReason;
/**
* The source that the scraper is discovering and collecting metrics from.
*/
source: Source;
/**
* The destination that the scraper is producing metrics to.
*/
destination: Destination;
}
export type ScraperSummaryList = ScraperSummary[];
export type SecurityGroupId = string;
export type SecurityGroupIds = SecurityGroupId[];
export interface Source {
/**
* A representation of an EKS source.
*/
eksConfiguration?: EksConfiguration;
}
export type StatusReason = string;
export type String = string;
export type SubnetId = string;
export type SubnetIds = SubnetId[];
export type TagKey = string;
export type TagKeys = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The ARN of the resource.
*/
resourceArn: String;
tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Timestamp = Date;
export interface UntagResourceRequest {
/**
* The ARN of the resource.
*/
resourceArn: String;
/**
* One or more tag keys
*/
tagKeys: TagKeys;
}
export interface UntagResourceResponse {
}
export interface UpdateLoggingConfigurationRequest {
/**
* The ID of the workspace to vend logs to.
*/
workspaceId: WorkspaceId;
/**
* The ARN of the CW log group to which the vended log data will be published.
*/
logGroupArn: LogGroupArn;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export interface UpdateLoggingConfigurationResponse {
/**
* The status of the logging configuration.
*/
status: LoggingConfigurationStatus;
}
export interface UpdateWorkspaceAliasRequest {
/**
* The ID of the workspace being updated.
*/
workspaceId: WorkspaceId;
/**
* The new alias of the workspace.
*/
alias?: WorkspaceAlias;
/**
* Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
*/
clientToken?: IdempotencyToken;
}
export type Uri = string;
export type WorkspaceAlias = string;
export type WorkspaceArn = string;
export interface WorkspaceDescription {
/**
* Unique string identifying this workspace.
*/
workspaceId: WorkspaceId;
/**
* Alias of this workspace.
*/
alias?: WorkspaceAlias;
/**
* The Amazon Resource Name (ARN) of this workspace.
*/
arn: WorkspaceArn;
/**
* The status of this workspace.
*/
status: WorkspaceStatus;
/**
* Prometheus endpoint URI.
*/
prometheusEndpoint?: Uri;
/**
* The time when the workspace was created.
*/
createdAt: Timestamp;
/**
* The tags of this workspace.
*/
tags?: TagMap;
/**
* The customer managed KMS key of this workspace.
*/
kmsKeyArn?: KmsKeyArn;
}
export type WorkspaceId = string;
export interface WorkspaceStatus {
/**
* Status code of this workspace.
*/
statusCode: WorkspaceStatusCode;
}
export type WorkspaceStatusCode = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATION_FAILED"|string;
export interface WorkspaceSummary {
/**
* Unique string identifying this workspace.
*/
workspaceId: WorkspaceId;
/**
* Alias of this workspace.
*/
alias?: WorkspaceAlias;
/**
* The AmazonResourceName of this workspace.
*/
arn: WorkspaceArn;
/**
* The status of this workspace.
*/
status: WorkspaceStatus;
/**
* The time when the workspace was created.
*/
createdAt: Timestamp;
/**
* The tags of this workspace.
*/
tags?: TagMap;
/**
* Customer managed KMS key ARN for this workspace
*/
kmsKeyArn?: KmsKeyArn;
}
export type WorkspaceSummaryList = WorkspaceSummary[];
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2020-08-01"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Amp client.
*/
export import Types = Amp;
}
export = Amp;