@aws-sdk/client-amp 3.509.0 → 3.513.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 (56) hide show
  1. package/README.md +18 -1
  2. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +1 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  4. package/dist-cjs/index.js +103 -45
  5. package/dist-cjs/runtimeConfig.shared.js +10 -0
  6. package/dist-es/AmpClient.js +17 -4
  7. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  8. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  9. package/dist-es/runtimeConfig.shared.js +10 -0
  10. package/dist-es/runtimeExtensions.js +3 -0
  11. package/dist-types/Amp.d.ts +18 -1
  12. package/dist-types/AmpClient.d.ts +31 -12
  13. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  14. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  15. package/dist-types/commands/CreateAlertManagerDefinitionCommand.d.ts +12 -8
  16. package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts +8 -5
  17. package/dist-types/commands/CreateRuleGroupsNamespaceCommand.d.ts +13 -8
  18. package/dist-types/commands/CreateScraperCommand.d.ts +26 -8
  19. package/dist-types/commands/CreateWorkspaceCommand.d.ts +10 -7
  20. package/dist-types/commands/DeleteAlertManagerDefinitionCommand.d.ts +8 -7
  21. package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +7 -6
  22. package/dist-types/commands/DeleteRuleGroupsNamespaceCommand.d.ts +8 -7
  23. package/dist-types/commands/DeleteScraperCommand.d.ts +9 -7
  24. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +12 -7
  25. package/dist-types/commands/DescribeAlertManagerDefinitionCommand.d.ts +8 -6
  26. package/dist-types/commands/DescribeLoggingConfigurationCommand.d.ts +7 -5
  27. package/dist-types/commands/DescribeRuleGroupsNamespaceCommand.d.ts +8 -6
  28. package/dist-types/commands/DescribeScraperCommand.d.ts +8 -6
  29. package/dist-types/commands/DescribeWorkspaceCommand.d.ts +7 -6
  30. package/dist-types/commands/GetDefaultScraperConfigurationCommand.d.ts +5 -4
  31. package/dist-types/commands/ListRuleGroupsNamespacesCommand.d.ts +7 -6
  32. package/dist-types/commands/ListScrapersCommand.d.ts +8 -5
  33. package/dist-types/commands/ListTagsForResourceCommand.d.ts +9 -6
  34. package/dist-types/commands/ListWorkspacesCommand.d.ts +7 -5
  35. package/dist-types/commands/PutAlertManagerDefinitionCommand.d.ts +11 -8
  36. package/dist-types/commands/PutRuleGroupsNamespaceCommand.d.ts +15 -8
  37. package/dist-types/commands/TagResourceCommand.d.ts +13 -6
  38. package/dist-types/commands/UntagResourceCommand.d.ts +8 -6
  39. package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +8 -6
  40. package/dist-types/commands/UpdateWorkspaceAliasCommand.d.ts +9 -8
  41. package/dist-types/extensionConfiguration.d.ts +2 -1
  42. package/dist-types/index.d.ts +18 -1
  43. package/dist-types/models/models_0.d.ts +360 -260
  44. package/dist-types/runtimeConfig.browser.d.ts +5 -3
  45. package/dist-types/runtimeConfig.d.ts +4 -2
  46. package/dist-types/runtimeConfig.native.d.ts +6 -4
  47. package/dist-types/runtimeConfig.shared.d.ts +2 -0
  48. package/dist-types/ts3.4/AmpClient.d.ts +11 -9
  49. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  50. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
  51. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  52. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
  53. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -4
  54. package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -8
  55. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
  56. package/package.json +16 -16
@@ -1,7 +1,9 @@
1
+ import { AwsSdkSigV4Signer } from "@aws-sdk/core";
1
2
  import { NoOpLogger } from "@smithy/smithy-client";
2
3
  import { parseUrl } from "@smithy/url-parser";
3
4
  import { fromBase64, toBase64 } from "@smithy/util-base64";
4
5
  import { fromUtf8, toUtf8 } from "@smithy/util-utf8";
6
+ import { defaultAmpHttpAuthSchemeProvider } from "./auth/httpAuthSchemeProvider";
5
7
  import { defaultEndpointResolver } from "./endpoint/endpointResolver";
6
8
  export const getRuntimeConfig = (config) => {
7
9
  return {
@@ -11,6 +13,14 @@ export const getRuntimeConfig = (config) => {
11
13
  disableHostPrefix: config?.disableHostPrefix ?? false,
12
14
  endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
13
15
  extensions: config?.extensions ?? [],
16
+ httpAuthSchemeProvider: config?.httpAuthSchemeProvider ?? defaultAmpHttpAuthSchemeProvider,
17
+ httpAuthSchemes: config?.httpAuthSchemes ?? [
18
+ {
19
+ schemeId: "aws.auth#sigv4",
20
+ identityProvider: (ipc) => ipc.getIdentityProvider("aws.auth#sigv4"),
21
+ signer: new AwsSdkSigV4Signer(),
22
+ },
23
+ ],
14
24
  logger: config?.logger ?? new NoOpLogger(),
15
25
  serviceId: config?.serviceId ?? "amp",
16
26
  urlParser: config?.urlParser ?? parseUrl,
@@ -1,12 +1,14 @@
1
1
  import { getAwsRegionExtensionConfiguration, resolveAwsRegionExtensionConfiguration, } from "@aws-sdk/region-config-resolver";
2
2
  import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig } from "@smithy/protocol-http";
3
3
  import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
4
+ import { getHttpAuthExtensionConfiguration, resolveHttpAuthRuntimeConfig } from "./auth/httpAuthExtensionConfiguration";
4
5
  const asPartial = (t) => t;
5
6
  export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
6
7
  const extensionConfiguration = {
7
8
  ...asPartial(getAwsRegionExtensionConfiguration(runtimeConfig)),
8
9
  ...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
9
10
  ...asPartial(getHttpHandlerExtensionConfiguration(runtimeConfig)),
11
+ ...asPartial(getHttpAuthExtensionConfiguration(runtimeConfig)),
10
12
  };
11
13
  extensions.forEach((extension) => extension.configure(extensionConfiguration));
12
14
  return {
@@ -14,5 +16,6 @@ export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
14
16
  ...resolveAwsRegionExtensionConfiguration(extensionConfiguration),
15
17
  ...resolveDefaultRuntimeConfig(extensionConfiguration),
16
18
  ...resolveHttpHandlerRuntimeConfig(extensionConfiguration),
19
+ ...resolveHttpAuthRuntimeConfig(extensionConfiguration),
17
20
  };
18
21
  };
@@ -186,7 +186,24 @@ export interface Amp {
186
186
  }
187
187
  /**
188
188
  * @public
189
- * Amazon Managed Service for Prometheus
189
+ * <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
190
+ * container metrics that makes it easier to securely monitor container environments at
191
+ * scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
192
+ * model and query language that you use today to monitor the performance of your
193
+ * containerized workloads, and also enjoy improved scalability, availability, and security
194
+ * without having to manage the underlying infrastructure.</p>
195
+ * <p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
196
+ * <p>Amazon Managed Service for Prometheus includes two APIs.</p>
197
+ * <ul>
198
+ * <li>
199
+ * <p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
200
+ * managers.</p>
201
+ * </li>
202
+ * <li>
203
+ * <p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
204
+ * workspace.</p>
205
+ * </li>
206
+ * </ul>
190
207
  */
191
208
  export declare class Amp extends AmpClient implements Amp {
192
209
  }
@@ -1,13 +1,12 @@
1
1
  import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
2
- import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
3
2
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
4
- import { Credentials as __Credentials } from "@aws-sdk/types";
5
3
  import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
6
4
  import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
7
5
  import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
8
6
  import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
9
7
  import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
10
- import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
8
+ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
+ import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
11
10
  import { CreateAlertManagerDefinitionCommandInput, CreateAlertManagerDefinitionCommandOutput } from "./commands/CreateAlertManagerDefinitionCommand";
12
11
  import { CreateLoggingConfigurationCommandInput, CreateLoggingConfigurationCommandOutput } from "./commands/CreateLoggingConfigurationCommand";
13
12
  import { CreateRuleGroupsNamespaceCommandInput, CreateRuleGroupsNamespaceCommandOutput } from "./commands/CreateRuleGroupsNamespaceCommand";
@@ -117,20 +116,21 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
117
116
  * Enables FIPS compatible endpoints.
118
117
  */
119
118
  useFipsEndpoint?: boolean | __Provider<boolean>;
119
+ /**
120
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
121
+ * @internal
122
+ */
123
+ defaultUserAgentProvider?: Provider<__UserAgent>;
120
124
  /**
121
125
  * The AWS region to which this client will send requests
122
126
  */
123
127
  region?: string | __Provider<string>;
124
128
  /**
125
129
  * Default credentials provider; Not available in browser runtime.
130
+ * @deprecated
126
131
  * @internal
127
132
  */
128
- credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
129
- /**
130
- * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
131
- * @internal
132
- */
133
- defaultUserAgentProvider?: Provider<__UserAgent>;
133
+ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
134
134
  /**
135
135
  * Value for how many times a request will be made at most in case of retry.
136
136
  */
@@ -157,7 +157,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
157
157
  /**
158
158
  * @public
159
159
  */
160
- export type AmpClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
160
+ export type AmpClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
161
161
  /**
162
162
  * @public
163
163
  *
@@ -168,7 +168,7 @@ export interface AmpClientConfig extends AmpClientConfigType {
168
168
  /**
169
169
  * @public
170
170
  */
171
- export type AmpClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
171
+ export type AmpClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
172
172
  /**
173
173
  * @public
174
174
  *
@@ -178,7 +178,24 @@ export interface AmpClientResolvedConfig extends AmpClientResolvedConfigType {
178
178
  }
179
179
  /**
180
180
  * @public
181
- * Amazon Managed Service for Prometheus
181
+ * <p>Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for
182
+ * container metrics that makes it easier to securely monitor container environments at
183
+ * scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data
184
+ * model and query language that you use today to monitor the performance of your
185
+ * containerized workloads, and also enjoy improved scalability, availability, and security
186
+ * without having to manage the underlying infrastructure.</p>
187
+ * <p>For more information about Amazon Managed Service for Prometheus, see the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html">Amazon Managed Service for Prometheus</a> User Guide.</p>
188
+ * <p>Amazon Managed Service for Prometheus includes two APIs.</p>
189
+ * <ul>
190
+ * <li>
191
+ * <p>Use the Amazon Web Services API described in this guide to manage Amazon Managed Service for Prometheus resources, such as workspaces, rule groups, and alert
192
+ * managers.</p>
193
+ * </li>
194
+ * <li>
195
+ * <p>Use the <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis">Prometheus-compatible API</a> to work within your Prometheus
196
+ * workspace.</p>
197
+ * </li>
198
+ * </ul>
182
199
  */
183
200
  export declare class AmpClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, AmpClientResolvedConfig> {
184
201
  /**
@@ -192,4 +209,6 @@ export declare class AmpClient extends __Client<__HttpHandlerOptions, ServiceInp
192
209
  * Otherwise, sockets might stay open for quite a long time before the server terminates them.
193
210
  */
194
211
  destroy(): void;
212
+ private getDefaultHttpAuthSchemeParametersProvider;
213
+ private getIdentityProviderConfigProvider;
195
214
  }
@@ -0,0 +1,29 @@
1
+ import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
2
+ import { AmpHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
3
+ /**
4
+ * @internal
5
+ */
6
+ export interface HttpAuthExtensionConfiguration {
7
+ setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
8
+ httpAuthSchemes(): HttpAuthScheme[];
9
+ setHttpAuthSchemeProvider(httpAuthSchemeProvider: AmpHttpAuthSchemeProvider): void;
10
+ httpAuthSchemeProvider(): AmpHttpAuthSchemeProvider;
11
+ setCredentials(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider): void;
12
+ credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider | undefined;
13
+ }
14
+ /**
15
+ * @internal
16
+ */
17
+ export type HttpAuthRuntimeConfig = Partial<{
18
+ httpAuthSchemes: HttpAuthScheme[];
19
+ httpAuthSchemeProvider: AmpHttpAuthSchemeProvider;
20
+ credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
21
+ }>;
22
+ /**
23
+ * @internal
24
+ */
25
+ export declare const getHttpAuthExtensionConfiguration: (runtimeConfig: HttpAuthRuntimeConfig) => HttpAuthExtensionConfiguration;
26
+ /**
27
+ * @internal
28
+ */
29
+ export declare const resolveHttpAuthRuntimeConfig: (config: HttpAuthExtensionConfiguration) => HttpAuthRuntimeConfig;
@@ -0,0 +1,61 @@
1
+ import { AwsSdkSigV4AuthInputConfig, AwsSdkSigV4AuthResolvedConfig, AwsSdkSigV4PreviouslyResolved } from "@aws-sdk/core";
2
+ import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider } from "@smithy/types";
3
+ import { AmpClientResolvedConfig } from "../AmpClient";
4
+ /**
5
+ * @internal
6
+ */
7
+ export interface AmpHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
8
+ region?: string;
9
+ }
10
+ /**
11
+ * @internal
12
+ */
13
+ export interface AmpHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<AmpClientResolvedConfig, HandlerExecutionContext, AmpHttpAuthSchemeParameters, object> {
14
+ }
15
+ /**
16
+ * @internal
17
+ */
18
+ export declare const defaultAmpHttpAuthSchemeParametersProvider: (config: AmpClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<AmpHttpAuthSchemeParameters>;
19
+ /**
20
+ * @internal
21
+ */
22
+ export interface AmpHttpAuthSchemeProvider extends HttpAuthSchemeProvider<AmpHttpAuthSchemeParameters> {
23
+ }
24
+ /**
25
+ * @internal
26
+ */
27
+ export declare const defaultAmpHttpAuthSchemeProvider: AmpHttpAuthSchemeProvider;
28
+ /**
29
+ * @internal
30
+ */
31
+ export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
32
+ /**
33
+ * experimentalIdentityAndAuth: Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
34
+ * @internal
35
+ */
36
+ httpAuthSchemes?: HttpAuthScheme[];
37
+ /**
38
+ * experimentalIdentityAndAuth: Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
39
+ * @internal
40
+ */
41
+ httpAuthSchemeProvider?: AmpHttpAuthSchemeProvider;
42
+ }
43
+ /**
44
+ * @internal
45
+ */
46
+ export interface HttpAuthSchemeResolvedConfig extends AwsSdkSigV4AuthResolvedConfig {
47
+ /**
48
+ * experimentalIdentityAndAuth: Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
49
+ * @internal
50
+ */
51
+ readonly httpAuthSchemes: HttpAuthScheme[];
52
+ /**
53
+ * experimentalIdentityAndAuth: Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
54
+ * @internal
55
+ */
56
+ readonly httpAuthSchemeProvider: AmpHttpAuthSchemeProvider;
57
+ }
58
+ /**
59
+ * @internal
60
+ */
61
+ export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;
@@ -26,7 +26,10 @@ declare const CreateAlertManagerDefinitionCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Create an alert manager definition.
29
+ * <p>The <code>CreateAlertManagerDefinition</code> operation creates the alert manager
30
+ * definition in a workspace. If a workspace already has an alert manager definition, don't
31
+ * use this operation to update it. Instead, use
32
+ * <code>PutAlertManagerDefinition</code>.</p>
30
33
  * @example
31
34
  * Use a bare-bones client and the command you need to make an API call.
32
35
  * ```javascript
@@ -56,25 +59,26 @@ declare const CreateAlertManagerDefinitionCommand_base: {
56
59
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
57
60
  *
58
61
  * @throws {@link AccessDeniedException} (client fault)
59
- * User does not have sufficient access to perform this action.
62
+ * <p>You do not have sufficient access to perform this action.</p>
60
63
  *
61
64
  * @throws {@link ConflictException} (client fault)
62
- * Updating or deleting a resource can cause an inconsistent state.
65
+ * <p>The request would cause an inconsistent state.</p>
63
66
  *
64
67
  * @throws {@link InternalServerException} (server fault)
65
- * Unexpected error during processing of request.
68
+ * <p>An unexpected error occurred during the processing of the request.</p>
66
69
  *
67
70
  * @throws {@link ResourceNotFoundException} (client fault)
68
- * Request references a resource which does not exist.
71
+ * <p>The request references a resources that doesn't exist.</p>
69
72
  *
70
73
  * @throws {@link ServiceQuotaExceededException} (client fault)
71
- * Request would cause a service quota to be exceeded.
74
+ * <p>Completing the request would cause a service quota to be exceeded.</p>
72
75
  *
73
76
  * @throws {@link ThrottlingException} (client fault)
74
- * Request was denied due to request throttling.
77
+ * <p>The request was denied due to request throttling.</p>
75
78
  *
76
79
  * @throws {@link ValidationException} (client fault)
77
- * The input fails to satisfy the constraints specified by an AWS service.
80
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
81
+ * service.</p>
78
82
  *
79
83
  * @throws {@link AmpServiceException}
80
84
  * <p>Base exception class for all service exceptions from Amp service.</p>
@@ -26,7 +26,9 @@ declare const CreateLoggingConfigurationCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Create logging configuration.
29
+ * <p>The <code>CreateLoggingConfiguration</code> operation creates a logging configuration
30
+ * for the workspace. Use this operation to set the CloudWatch log group to which
31
+ * the logs will be published to.</p>
30
32
  * @example
31
33
  * Use a bare-bones client and the command you need to make an API call.
32
34
  * ```javascript
@@ -56,16 +58,17 @@ declare const CreateLoggingConfigurationCommand_base: {
56
58
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
57
59
  *
58
60
  * @throws {@link AccessDeniedException} (client fault)
59
- * User does not have sufficient access to perform this action.
61
+ * <p>You do not have sufficient access to perform this action.</p>
60
62
  *
61
63
  * @throws {@link InternalServerException} (server fault)
62
- * Unexpected error during processing of request.
64
+ * <p>An unexpected error occurred during the processing of the request.</p>
63
65
  *
64
66
  * @throws {@link ResourceNotFoundException} (client fault)
65
- * Request references a resource which does not exist.
67
+ * <p>The request references a resources that doesn't exist.</p>
66
68
  *
67
69
  * @throws {@link ValidationException} (client fault)
68
- * The input fails to satisfy the constraints specified by an AWS service.
70
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
71
+ * service.</p>
69
72
  *
70
73
  * @throws {@link AmpServiceException}
71
74
  * <p>Base exception class for all service exceptions from Amp service.</p>
@@ -26,7 +26,11 @@ declare const CreateRuleGroupsNamespaceCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Create a rule group namespace.
29
+ * <p>The <code>CreateRuleGroupsNamespace</code> operation creates a rule groups namespace
30
+ * within a workspace. A rule groups namespace is associated with exactly one rules file. A
31
+ * workspace can have multiple rule groups namespaces.</p>
32
+ * <p>Use this operation only to create new rule groups namespaces. To update an existing
33
+ * rule groups namespace, use <code>PutRuleGroupsNamespace</code>.</p>
30
34
  * @example
31
35
  * Use a bare-bones client and the command you need to make an API call.
32
36
  * ```javascript
@@ -65,25 +69,26 @@ declare const CreateRuleGroupsNamespaceCommand_base: {
65
69
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
66
70
  *
67
71
  * @throws {@link AccessDeniedException} (client fault)
68
- * User does not have sufficient access to perform this action.
72
+ * <p>You do not have sufficient access to perform this action.</p>
69
73
  *
70
74
  * @throws {@link ConflictException} (client fault)
71
- * Updating or deleting a resource can cause an inconsistent state.
75
+ * <p>The request would cause an inconsistent state.</p>
72
76
  *
73
77
  * @throws {@link InternalServerException} (server fault)
74
- * Unexpected error during processing of request.
78
+ * <p>An unexpected error occurred during the processing of the request.</p>
75
79
  *
76
80
  * @throws {@link ResourceNotFoundException} (client fault)
77
- * Request references a resource which does not exist.
81
+ * <p>The request references a resources that doesn't exist.</p>
78
82
  *
79
83
  * @throws {@link ServiceQuotaExceededException} (client fault)
80
- * Request would cause a service quota to be exceeded.
84
+ * <p>Completing the request would cause a service quota to be exceeded.</p>
81
85
  *
82
86
  * @throws {@link ThrottlingException} (client fault)
83
- * Request was denied due to request throttling.
87
+ * <p>The request was denied due to request throttling.</p>
84
88
  *
85
89
  * @throws {@link ValidationException} (client fault)
86
- * The input fails to satisfy the constraints specified by an AWS service.
90
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
91
+ * service.</p>
87
92
  *
88
93
  * @throws {@link AmpServiceException}
89
94
  * <p>Base exception class for all service exceptions from Amp service.</p>
@@ -26,7 +26,24 @@ declare const CreateScraperCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Create a scraper.
29
+ * <p>The <code>CreateScraper</code> operation creates a scraper to collect metrics. A
30
+ * scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS
31
+ * cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the
32
+ * scraper to control what metrics are collected, and what transformations are applied
33
+ * prior to sending them to your workspace.</p>
34
+ * <p>If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see
35
+ * <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper">Using roles for scraping metrics from EKS</a> in the <i>Amazon Managed Service for Prometheus User
36
+ * Guide</i>.</p>
37
+ * <p>You cannot update a scraper. If you want to change the configuration of the scraper,
38
+ * create a new scraper and delete the old one.</p>
39
+ * <p>The <code>scrapeConfiguration</code> parameter contains the base64-encoded version of
40
+ * the YAML configuration file.</p>
41
+ * <note>
42
+ * <p>For more information about collectors, including what metrics are collected, and
43
+ * how to configure the scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html">Amazon Web Services managed
44
+ * collectors</a> in the <i>Amazon Managed Service for Prometheus User
45
+ * Guide</i>.</p>
46
+ * </note>
30
47
  * @example
31
48
  * Use a bare-bones client and the command you need to make an API call.
32
49
  * ```javascript
@@ -81,25 +98,26 @@ declare const CreateScraperCommand_base: {
81
98
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
82
99
  *
83
100
  * @throws {@link AccessDeniedException} (client fault)
84
- * User does not have sufficient access to perform this action.
101
+ * <p>You do not have sufficient access to perform this action.</p>
85
102
  *
86
103
  * @throws {@link ConflictException} (client fault)
87
- * Updating or deleting a resource can cause an inconsistent state.
104
+ * <p>The request would cause an inconsistent state.</p>
88
105
  *
89
106
  * @throws {@link InternalServerException} (server fault)
90
- * Unexpected error during processing of request.
107
+ * <p>An unexpected error occurred during the processing of the request.</p>
91
108
  *
92
109
  * @throws {@link ResourceNotFoundException} (client fault)
93
- * Request references a resource which does not exist.
110
+ * <p>The request references a resources that doesn't exist.</p>
94
111
  *
95
112
  * @throws {@link ServiceQuotaExceededException} (client fault)
96
- * Request would cause a service quota to be exceeded.
113
+ * <p>Completing the request would cause a service quota to be exceeded.</p>
97
114
  *
98
115
  * @throws {@link ThrottlingException} (client fault)
99
- * Request was denied due to request throttling.
116
+ * <p>The request was denied due to request throttling.</p>
100
117
  *
101
118
  * @throws {@link ValidationException} (client fault)
102
- * The input fails to satisfy the constraints specified by an AWS service.
119
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
120
+ * service.</p>
103
121
  *
104
122
  * @throws {@link AmpServiceException}
105
123
  * <p>Base exception class for all service exceptions from Amp service.</p>
@@ -26,7 +26,9 @@ declare const CreateWorkspaceCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Creates a new AMP workspace.
29
+ * <p>Creates a Prometheus workspace. A workspace is a logical space dedicated to the
30
+ * storage and querying of Prometheus metrics. You can have one or more workspaces in each
31
+ * Region in your account.</p>
30
32
  * @example
31
33
  * Use a bare-bones client and the command you need to make an API call.
32
34
  * ```javascript
@@ -64,22 +66,23 @@ declare const CreateWorkspaceCommand_base: {
64
66
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
65
67
  *
66
68
  * @throws {@link AccessDeniedException} (client fault)
67
- * User does not have sufficient access to perform this action.
69
+ * <p>You do not have sufficient access to perform this action.</p>
68
70
  *
69
71
  * @throws {@link ConflictException} (client fault)
70
- * Updating or deleting a resource can cause an inconsistent state.
72
+ * <p>The request would cause an inconsistent state.</p>
71
73
  *
72
74
  * @throws {@link InternalServerException} (server fault)
73
- * Unexpected error during processing of request.
75
+ * <p>An unexpected error occurred during the processing of the request.</p>
74
76
  *
75
77
  * @throws {@link ServiceQuotaExceededException} (client fault)
76
- * Request would cause a service quota to be exceeded.
78
+ * <p>Completing the request would cause a service quota to be exceeded.</p>
77
79
  *
78
80
  * @throws {@link ThrottlingException} (client fault)
79
- * Request was denied due to request throttling.
81
+ * <p>The request was denied due to request throttling.</p>
80
82
  *
81
83
  * @throws {@link ValidationException} (client fault)
82
- * The input fails to satisfy the constraints specified by an AWS service.
84
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
85
+ * service.</p>
83
86
  *
84
87
  * @throws {@link AmpServiceException}
85
88
  * <p>Base exception class for all service exceptions from Amp service.</p>
@@ -26,7 +26,7 @@ declare const DeleteAlertManagerDefinitionCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Deletes an alert manager definition.
29
+ * <p>Deletes the alert manager definition from a workspace.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -50,22 +50,23 @@ declare const DeleteAlertManagerDefinitionCommand_base: {
50
50
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
51
51
  *
52
52
  * @throws {@link AccessDeniedException} (client fault)
53
- * User does not have sufficient access to perform this action.
53
+ * <p>You do not have sufficient access to perform this action.</p>
54
54
  *
55
55
  * @throws {@link ConflictException} (client fault)
56
- * Updating or deleting a resource can cause an inconsistent state.
56
+ * <p>The request would cause an inconsistent state.</p>
57
57
  *
58
58
  * @throws {@link InternalServerException} (server fault)
59
- * Unexpected error during processing of request.
59
+ * <p>An unexpected error occurred during the processing of the request.</p>
60
60
  *
61
61
  * @throws {@link ResourceNotFoundException} (client fault)
62
- * Request references a resource which does not exist.
62
+ * <p>The request references a resources that doesn't exist.</p>
63
63
  *
64
64
  * @throws {@link ThrottlingException} (client fault)
65
- * Request was denied due to request throttling.
65
+ * <p>The request was denied due to request throttling.</p>
66
66
  *
67
67
  * @throws {@link ValidationException} (client fault)
68
- * The input fails to satisfy the constraints specified by an AWS service.
68
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
69
+ * service.</p>
69
70
  *
70
71
  * @throws {@link AmpServiceException}
71
72
  * <p>Base exception class for all service exceptions from Amp service.</p>
@@ -26,7 +26,7 @@ declare const DeleteLoggingConfigurationCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Delete logging configuration.
29
+ * <p>Deletes the logging configuration for a workspace.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -50,19 +50,20 @@ declare const DeleteLoggingConfigurationCommand_base: {
50
50
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
51
51
  *
52
52
  * @throws {@link AccessDeniedException} (client fault)
53
- * User does not have sufficient access to perform this action.
53
+ * <p>You do not have sufficient access to perform this action.</p>
54
54
  *
55
55
  * @throws {@link ConflictException} (client fault)
56
- * Updating or deleting a resource can cause an inconsistent state.
56
+ * <p>The request would cause an inconsistent state.</p>
57
57
  *
58
58
  * @throws {@link InternalServerException} (server fault)
59
- * Unexpected error during processing of request.
59
+ * <p>An unexpected error occurred during the processing of the request.</p>
60
60
  *
61
61
  * @throws {@link ResourceNotFoundException} (client fault)
62
- * Request references a resource which does not exist.
62
+ * <p>The request references a resources that doesn't exist.</p>
63
63
  *
64
64
  * @throws {@link ValidationException} (client fault)
65
- * The input fails to satisfy the constraints specified by an AWS service.
65
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
66
+ * service.</p>
66
67
  *
67
68
  * @throws {@link AmpServiceException}
68
69
  * <p>Base exception class for all service exceptions from Amp service.</p>
@@ -26,7 +26,7 @@ declare const DeleteRuleGroupsNamespaceCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * Delete a rule groups namespace.
29
+ * <p>Deletes one rule groups namespace and its associated rule groups definition.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -51,22 +51,23 @@ declare const DeleteRuleGroupsNamespaceCommand_base: {
51
51
  * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
52
52
  *
53
53
  * @throws {@link AccessDeniedException} (client fault)
54
- * User does not have sufficient access to perform this action.
54
+ * <p>You do not have sufficient access to perform this action.</p>
55
55
  *
56
56
  * @throws {@link ConflictException} (client fault)
57
- * Updating or deleting a resource can cause an inconsistent state.
57
+ * <p>The request would cause an inconsistent state.</p>
58
58
  *
59
59
  * @throws {@link InternalServerException} (server fault)
60
- * Unexpected error during processing of request.
60
+ * <p>An unexpected error occurred during the processing of the request.</p>
61
61
  *
62
62
  * @throws {@link ResourceNotFoundException} (client fault)
63
- * Request references a resource which does not exist.
63
+ * <p>The request references a resources that doesn't exist.</p>
64
64
  *
65
65
  * @throws {@link ThrottlingException} (client fault)
66
- * Request was denied due to request throttling.
66
+ * <p>The request was denied due to request throttling.</p>
67
67
  *
68
68
  * @throws {@link ValidationException} (client fault)
69
- * The input fails to satisfy the constraints specified by an AWS service.
69
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services
70
+ * service.</p>
70
71
  *
71
72
  * @throws {@link AmpServiceException}
72
73
  * <p>Base exception class for all service exceptions from Amp service.</p>