@aws-sdk/client-controlcatalog 3.551.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 (111) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +256 -0
  3. package/dist-cjs/ControlCatalog.js +17 -0
  4. package/dist-cjs/ControlCatalogClient.js +56 -0
  5. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
  6. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  7. package/dist-cjs/commands/ListCommonControlsCommand.js +28 -0
  8. package/dist-cjs/commands/ListDomainsCommand.js +28 -0
  9. package/dist-cjs/commands/ListObjectivesCommand.js +28 -0
  10. package/dist-cjs/commands/index.js +6 -0
  11. package/dist-cjs/endpoint/EndpointParameters.js +18 -0
  12. package/dist-cjs/endpoint/endpointResolver.js +14 -0
  13. package/dist-cjs/endpoint/ruleset.js +7 -0
  14. package/dist-cjs/extensionConfiguration.js +2 -0
  15. package/dist-cjs/index.js +11 -0
  16. package/dist-cjs/models/ControlCatalogServiceException.js +12 -0
  17. package/dist-cjs/models/index.js +4 -0
  18. package/dist-cjs/models/models_0.js +64 -0
  19. package/dist-cjs/pagination/Interfaces.js +2 -0
  20. package/dist-cjs/pagination/ListCommonControlsPaginator.js +7 -0
  21. package/dist-cjs/pagination/ListDomainsPaginator.js +7 -0
  22. package/dist-cjs/pagination/ListObjectivesPaginator.js +7 -0
  23. package/dist-cjs/pagination/index.js +7 -0
  24. package/dist-cjs/protocols/Aws_restJson1.js +256 -0
  25. package/dist-cjs/runtimeConfig.browser.js +39 -0
  26. package/dist-cjs/runtimeConfig.js +49 -0
  27. package/dist-cjs/runtimeConfig.native.js +15 -0
  28. package/dist-cjs/runtimeConfig.shared.js +34 -0
  29. package/dist-cjs/runtimeExtensions.js +25 -0
  30. package/dist-es/ControlCatalog.js +13 -0
  31. package/dist-es/ControlCatalogClient.js +52 -0
  32. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  33. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  34. package/dist-es/commands/ListCommonControlsCommand.js +24 -0
  35. package/dist-es/commands/ListDomainsCommand.js +24 -0
  36. package/dist-es/commands/ListObjectivesCommand.js +24 -0
  37. package/dist-es/commands/index.js +3 -0
  38. package/dist-es/endpoint/EndpointParameters.js +14 -0
  39. package/dist-es/endpoint/endpointResolver.js +10 -0
  40. package/dist-es/endpoint/ruleset.js +4 -0
  41. package/dist-es/extensionConfiguration.js +1 -0
  42. package/dist-es/index.js +6 -0
  43. package/dist-es/models/ControlCatalogServiceException.js +8 -0
  44. package/dist-es/models/index.js +1 -0
  45. package/dist-es/models/models_0.js +57 -0
  46. package/dist-es/pagination/Interfaces.js +1 -0
  47. package/dist-es/pagination/ListCommonControlsPaginator.js +4 -0
  48. package/dist-es/pagination/ListDomainsPaginator.js +4 -0
  49. package/dist-es/pagination/ListObjectivesPaginator.js +4 -0
  50. package/dist-es/pagination/index.js +4 -0
  51. package/dist-es/protocols/Aws_restJson1.js +247 -0
  52. package/dist-es/runtimeConfig.browser.js +34 -0
  53. package/dist-es/runtimeConfig.js +44 -0
  54. package/dist-es/runtimeConfig.native.js +11 -0
  55. package/dist-es/runtimeConfig.shared.js +30 -0
  56. package/dist-es/runtimeExtensions.js +21 -0
  57. package/dist-types/ControlCatalog.d.ts +61 -0
  58. package/dist-types/ControlCatalogClient.d.ts +201 -0
  59. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  60. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  61. package/dist-types/commands/ListCommonControlsCommand.d.ts +99 -0
  62. package/dist-types/commands/ListDomainsCommand.d.ts +81 -0
  63. package/dist-types/commands/ListObjectivesCommand.d.ts +94 -0
  64. package/dist-types/commands/index.d.ts +3 -0
  65. package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
  66. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  67. package/dist-types/endpoint/ruleset.d.ts +2 -0
  68. package/dist-types/extensionConfiguration.d.ts +9 -0
  69. package/dist-types/index.d.ts +41 -0
  70. package/dist-types/models/ControlCatalogServiceException.d.ts +13 -0
  71. package/dist-types/models/index.d.ts +1 -0
  72. package/dist-types/models/models_0.d.ts +350 -0
  73. package/dist-types/pagination/Interfaces.d.ts +8 -0
  74. package/dist-types/pagination/ListCommonControlsPaginator.d.ts +7 -0
  75. package/dist-types/pagination/ListDomainsPaginator.d.ts +7 -0
  76. package/dist-types/pagination/ListObjectivesPaginator.d.ts +7 -0
  77. package/dist-types/pagination/index.d.ts +4 -0
  78. package/dist-types/protocols/Aws_restJson1.d.ts +29 -0
  79. package/dist-types/runtimeConfig.browser.d.ts +45 -0
  80. package/dist-types/runtimeConfig.d.ts +45 -0
  81. package/dist-types/runtimeConfig.native.d.ts +44 -0
  82. package/dist-types/runtimeConfig.shared.d.ts +21 -0
  83. package/dist-types/runtimeExtensions.d.ts +17 -0
  84. package/dist-types/ts3.4/ControlCatalog.d.ts +61 -0
  85. package/dist-types/ts3.4/ControlCatalogClient.d.ts +139 -0
  86. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  87. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  88. package/dist-types/ts3.4/commands/ListCommonControlsCommand.d.ts +39 -0
  89. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +35 -0
  90. package/dist-types/ts3.4/commands/ListObjectivesCommand.d.ts +38 -0
  91. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  92. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
  93. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  94. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  95. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  96. package/dist-types/ts3.4/index.d.ts +9 -0
  97. package/dist-types/ts3.4/models/ControlCatalogServiceException.d.ts +8 -0
  98. package/dist-types/ts3.4/models/index.d.ts +1 -0
  99. package/dist-types/ts3.4/models/models_0.d.ts +108 -0
  100. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  101. package/dist-types/ts3.4/pagination/ListCommonControlsPaginator.d.ts +11 -0
  102. package/dist-types/ts3.4/pagination/ListDomainsPaginator.d.ts +11 -0
  103. package/dist-types/ts3.4/pagination/ListObjectivesPaginator.d.ts +11 -0
  104. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  105. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +41 -0
  106. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +85 -0
  107. package/dist-types/ts3.4/runtimeConfig.d.ts +89 -0
  108. package/dist-types/ts3.4/runtimeConfig.native.d.ts +79 -0
  109. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
  110. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  111. package/package.json +101 -0
@@ -0,0 +1,34 @@
1
+ import packageInfo from "../package.json";
2
+ import { Sha256 } from "@aws-crypto/sha256-browser";
3
+ import { defaultUserAgent } from "@aws-sdk/util-user-agent-browser";
4
+ import { DEFAULT_USE_DUALSTACK_ENDPOINT, DEFAULT_USE_FIPS_ENDPOINT } from "@smithy/config-resolver";
5
+ import { FetchHttpHandler as RequestHandler, streamCollector } from "@smithy/fetch-http-handler";
6
+ import { invalidProvider } from "@smithy/invalid-dependency";
7
+ import { calculateBodyLength } from "@smithy/util-body-length-browser";
8
+ import { DEFAULT_MAX_ATTEMPTS, DEFAULT_RETRY_MODE } from "@smithy/util-retry";
9
+ import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
10
+ import { loadConfigsForDefaultMode } from "@smithy/smithy-client";
11
+ import { resolveDefaultsModeConfig } from "@smithy/util-defaults-mode-browser";
12
+ export const getRuntimeConfig = (config) => {
13
+ const defaultsMode = resolveDefaultsModeConfig(config);
14
+ const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
15
+ const clientSharedValues = getSharedRuntimeConfig(config);
16
+ return {
17
+ ...clientSharedValues,
18
+ ...config,
19
+ runtime: "browser",
20
+ defaultsMode,
21
+ bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
22
+ credentialDefaultProvider: config?.credentialDefaultProvider ?? ((_) => () => Promise.reject(new Error("Credential is missing"))),
23
+ defaultUserAgentProvider: config?.defaultUserAgentProvider ??
24
+ defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
25
+ maxAttempts: config?.maxAttempts ?? DEFAULT_MAX_ATTEMPTS,
26
+ region: config?.region ?? invalidProvider("Region is missing"),
27
+ requestHandler: RequestHandler.create(config?.requestHandler ?? defaultConfigProvider),
28
+ retryMode: config?.retryMode ?? (async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE),
29
+ sha256: config?.sha256 ?? Sha256,
30
+ streamCollector: config?.streamCollector ?? streamCollector,
31
+ useDualstackEndpoint: config?.useDualstackEndpoint ?? (() => Promise.resolve(DEFAULT_USE_DUALSTACK_ENDPOINT)),
32
+ useFipsEndpoint: config?.useFipsEndpoint ?? (() => Promise.resolve(DEFAULT_USE_FIPS_ENDPOINT)),
33
+ };
34
+ };
@@ -0,0 +1,44 @@
1
+ import packageInfo from "../package.json";
2
+ import { emitWarningIfUnsupportedVersion as awsCheckVersion } from "@aws-sdk/core";
3
+ import { defaultProvider as credentialDefaultProvider } from "@aws-sdk/credential-provider-node";
4
+ import { defaultUserAgent } from "@aws-sdk/util-user-agent-node";
5
+ import { NODE_REGION_CONFIG_FILE_OPTIONS, NODE_REGION_CONFIG_OPTIONS, NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS, NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS, } from "@smithy/config-resolver";
6
+ import { Hash } from "@smithy/hash-node";
7
+ import { NODE_MAX_ATTEMPT_CONFIG_OPTIONS, NODE_RETRY_MODE_CONFIG_OPTIONS } from "@smithy/middleware-retry";
8
+ import { loadConfig as loadNodeConfig } from "@smithy/node-config-provider";
9
+ import { NodeHttpHandler as RequestHandler, streamCollector } from "@smithy/node-http-handler";
10
+ import { calculateBodyLength } from "@smithy/util-body-length-node";
11
+ import { DEFAULT_RETRY_MODE } from "@smithy/util-retry";
12
+ import { getRuntimeConfig as getSharedRuntimeConfig } from "./runtimeConfig.shared";
13
+ import { loadConfigsForDefaultMode } from "@smithy/smithy-client";
14
+ import { resolveDefaultsModeConfig } from "@smithy/util-defaults-mode-node";
15
+ import { emitWarningIfUnsupportedVersion } from "@smithy/smithy-client";
16
+ export const getRuntimeConfig = (config) => {
17
+ emitWarningIfUnsupportedVersion(process.version);
18
+ const defaultsMode = resolveDefaultsModeConfig(config);
19
+ const defaultConfigProvider = () => defaultsMode().then(loadConfigsForDefaultMode);
20
+ const clientSharedValues = getSharedRuntimeConfig(config);
21
+ awsCheckVersion(process.version);
22
+ return {
23
+ ...clientSharedValues,
24
+ ...config,
25
+ runtime: "node",
26
+ defaultsMode,
27
+ bodyLengthChecker: config?.bodyLengthChecker ?? calculateBodyLength,
28
+ credentialDefaultProvider: config?.credentialDefaultProvider ?? credentialDefaultProvider,
29
+ defaultUserAgentProvider: config?.defaultUserAgentProvider ??
30
+ defaultUserAgent({ serviceId: clientSharedValues.serviceId, clientVersion: packageInfo.version }),
31
+ maxAttempts: config?.maxAttempts ?? loadNodeConfig(NODE_MAX_ATTEMPT_CONFIG_OPTIONS),
32
+ region: config?.region ?? loadNodeConfig(NODE_REGION_CONFIG_OPTIONS, NODE_REGION_CONFIG_FILE_OPTIONS),
33
+ requestHandler: RequestHandler.create(config?.requestHandler ?? defaultConfigProvider),
34
+ retryMode: config?.retryMode ??
35
+ loadNodeConfig({
36
+ ...NODE_RETRY_MODE_CONFIG_OPTIONS,
37
+ default: async () => (await defaultConfigProvider()).retryMode || DEFAULT_RETRY_MODE,
38
+ }),
39
+ sha256: config?.sha256 ?? Hash.bind(null, "sha256"),
40
+ streamCollector: config?.streamCollector ?? streamCollector,
41
+ useDualstackEndpoint: config?.useDualstackEndpoint ?? loadNodeConfig(NODE_USE_DUALSTACK_ENDPOINT_CONFIG_OPTIONS),
42
+ useFipsEndpoint: config?.useFipsEndpoint ?? loadNodeConfig(NODE_USE_FIPS_ENDPOINT_CONFIG_OPTIONS),
43
+ };
44
+ };
@@ -0,0 +1,11 @@
1
+ import { Sha256 } from "@aws-crypto/sha256-js";
2
+ import { getRuntimeConfig as getBrowserRuntimeConfig } from "./runtimeConfig.browser";
3
+ export const getRuntimeConfig = (config) => {
4
+ const browserDefaults = getBrowserRuntimeConfig(config);
5
+ return {
6
+ ...browserDefaults,
7
+ ...config,
8
+ runtime: "react-native",
9
+ sha256: config?.sha256 ?? Sha256,
10
+ };
11
+ };
@@ -0,0 +1,30 @@
1
+ import { AwsSdkSigV4Signer } from "@aws-sdk/core";
2
+ import { NoOpLogger } from "@smithy/smithy-client";
3
+ import { parseUrl } from "@smithy/url-parser";
4
+ import { fromBase64, toBase64 } from "@smithy/util-base64";
5
+ import { fromUtf8, toUtf8 } from "@smithy/util-utf8";
6
+ import { defaultControlCatalogHttpAuthSchemeProvider } from "./auth/httpAuthSchemeProvider";
7
+ import { defaultEndpointResolver } from "./endpoint/endpointResolver";
8
+ export const getRuntimeConfig = (config) => {
9
+ return {
10
+ apiVersion: "2018-05-10",
11
+ base64Decoder: config?.base64Decoder ?? fromBase64,
12
+ base64Encoder: config?.base64Encoder ?? toBase64,
13
+ disableHostPrefix: config?.disableHostPrefix ?? false,
14
+ endpointProvider: config?.endpointProvider ?? defaultEndpointResolver,
15
+ extensions: config?.extensions ?? [],
16
+ httpAuthSchemeProvider: config?.httpAuthSchemeProvider ?? defaultControlCatalogHttpAuthSchemeProvider,
17
+ httpAuthSchemes: config?.httpAuthSchemes ?? [
18
+ {
19
+ schemeId: "aws.auth#sigv4",
20
+ identityProvider: (ipc) => ipc.getIdentityProvider("aws.auth#sigv4"),
21
+ signer: new AwsSdkSigV4Signer(),
22
+ },
23
+ ],
24
+ logger: config?.logger ?? new NoOpLogger(),
25
+ serviceId: config?.serviceId ?? "ControlCatalog",
26
+ urlParser: config?.urlParser ?? parseUrl,
27
+ utf8Decoder: config?.utf8Decoder ?? fromUtf8,
28
+ utf8Encoder: config?.utf8Encoder ?? toUtf8,
29
+ };
30
+ };
@@ -0,0 +1,21 @@
1
+ import { getAwsRegionExtensionConfiguration, resolveAwsRegionExtensionConfiguration, } from "@aws-sdk/region-config-resolver";
2
+ import { getHttpHandlerExtensionConfiguration, resolveHttpHandlerRuntimeConfig } from "@smithy/protocol-http";
3
+ import { getDefaultExtensionConfiguration, resolveDefaultRuntimeConfig } from "@smithy/smithy-client";
4
+ import { getHttpAuthExtensionConfiguration, resolveHttpAuthRuntimeConfig } from "./auth/httpAuthExtensionConfiguration";
5
+ const asPartial = (t) => t;
6
+ export const resolveRuntimeExtensions = (runtimeConfig, extensions) => {
7
+ const extensionConfiguration = {
8
+ ...asPartial(getAwsRegionExtensionConfiguration(runtimeConfig)),
9
+ ...asPartial(getDefaultExtensionConfiguration(runtimeConfig)),
10
+ ...asPartial(getHttpHandlerExtensionConfiguration(runtimeConfig)),
11
+ ...asPartial(getHttpAuthExtensionConfiguration(runtimeConfig)),
12
+ };
13
+ extensions.forEach((extension) => extension.configure(extensionConfiguration));
14
+ return {
15
+ ...runtimeConfig,
16
+ ...resolveAwsRegionExtensionConfiguration(extensionConfiguration),
17
+ ...resolveDefaultRuntimeConfig(extensionConfiguration),
18
+ ...resolveHttpHandlerRuntimeConfig(extensionConfiguration),
19
+ ...resolveHttpAuthRuntimeConfig(extensionConfiguration),
20
+ };
21
+ };
@@ -0,0 +1,61 @@
1
+ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import { ListCommonControlsCommandInput, ListCommonControlsCommandOutput } from "./commands/ListCommonControlsCommand";
3
+ import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
4
+ import { ListObjectivesCommandInput, ListObjectivesCommandOutput } from "./commands/ListObjectivesCommand";
5
+ import { ControlCatalogClient } from "./ControlCatalogClient";
6
+ export interface ControlCatalog {
7
+ /**
8
+ * @see {@link ListCommonControlsCommand}
9
+ */
10
+ listCommonControls(): Promise<ListCommonControlsCommandOutput>;
11
+ listCommonControls(args: ListCommonControlsCommandInput, options?: __HttpHandlerOptions): Promise<ListCommonControlsCommandOutput>;
12
+ listCommonControls(args: ListCommonControlsCommandInput, cb: (err: any, data?: ListCommonControlsCommandOutput) => void): void;
13
+ listCommonControls(args: ListCommonControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCommonControlsCommandOutput) => void): void;
14
+ /**
15
+ * @see {@link ListDomainsCommand}
16
+ */
17
+ listDomains(): Promise<ListDomainsCommandOutput>;
18
+ listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainsCommandOutput>;
19
+ listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
20
+ listDomains(args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
21
+ /**
22
+ * @see {@link ListObjectivesCommand}
23
+ */
24
+ listObjectives(): Promise<ListObjectivesCommandOutput>;
25
+ listObjectives(args: ListObjectivesCommandInput, options?: __HttpHandlerOptions): Promise<ListObjectivesCommandOutput>;
26
+ listObjectives(args: ListObjectivesCommandInput, cb: (err: any, data?: ListObjectivesCommandOutput) => void): void;
27
+ listObjectives(args: ListObjectivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectivesCommandOutput) => void): void;
28
+ }
29
+ /**
30
+ * <p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
31
+ * developers who need detailed information about how to programmatically identify and filter
32
+ * the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
33
+ * descriptions, syntax, and usage examples for each of the actions and data types that are
34
+ * supported by Amazon Web Services Control Catalog. </p>
35
+ * <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>
39
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
40
+ * alphabetical list of all Control Catalog API operations.</p>
41
+ * </li>
42
+ * <li>
43
+ * <p>
44
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
45
+ * alphabetical list of all Control Catalog data types.</p>
46
+ * </li>
47
+ * <li>
48
+ * <p>
49
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
50
+ * parameters</a>: Parameters that all operations can use.</p>
51
+ * </li>
52
+ * <li>
53
+ * <p>
54
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
55
+ * Client and server errors that all operations can return.</p>
56
+ * </li>
57
+ * </ul>
58
+ * @public
59
+ */
60
+ export declare class ControlCatalog extends ControlCatalogClient implements ControlCatalog {
61
+ }
@@ -0,0 +1,201 @@
1
+ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
2
+ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
3
+ import { RegionInputConfig, RegionResolvedConfig } from "@smithy/config-resolver";
4
+ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-endpoint";
5
+ import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
6
+ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http";
7
+ import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
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";
10
+ import { ListCommonControlsCommandInput, ListCommonControlsCommandOutput } from "./commands/ListCommonControlsCommand";
11
+ import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
12
+ import { ListObjectivesCommandInput, ListObjectivesCommandOutput } from "./commands/ListObjectivesCommand";
13
+ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
14
+ import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
15
+ export { __Client };
16
+ /**
17
+ * @public
18
+ */
19
+ export type ServiceInputTypes = ListCommonControlsCommandInput | ListDomainsCommandInput | ListObjectivesCommandInput;
20
+ /**
21
+ * @public
22
+ */
23
+ export type ServiceOutputTypes = ListCommonControlsCommandOutput | ListDomainsCommandOutput | ListObjectivesCommandOutput;
24
+ /**
25
+ * @public
26
+ */
27
+ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
28
+ /**
29
+ * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
30
+ */
31
+ requestHandler?: __HttpHandlerUserInput;
32
+ /**
33
+ * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface
34
+ * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
35
+ * @internal
36
+ */
37
+ sha256?: __ChecksumConstructor | __HashConstructor;
38
+ /**
39
+ * The function that will be used to convert strings into HTTP endpoints.
40
+ * @internal
41
+ */
42
+ urlParser?: __UrlParser;
43
+ /**
44
+ * A function that can calculate the length of a request body.
45
+ * @internal
46
+ */
47
+ bodyLengthChecker?: __BodyLengthCalculator;
48
+ /**
49
+ * A function that converts a stream into an array of bytes.
50
+ * @internal
51
+ */
52
+ streamCollector?: __StreamCollector;
53
+ /**
54
+ * The function that will be used to convert a base64-encoded string to a byte array.
55
+ * @internal
56
+ */
57
+ base64Decoder?: __Decoder;
58
+ /**
59
+ * The function that will be used to convert binary data to a base64-encoded string.
60
+ * @internal
61
+ */
62
+ base64Encoder?: __Encoder;
63
+ /**
64
+ * The function that will be used to convert a UTF8-encoded string to a byte array.
65
+ * @internal
66
+ */
67
+ utf8Decoder?: __Decoder;
68
+ /**
69
+ * The function that will be used to convert binary data to a UTF-8 encoded string.
70
+ * @internal
71
+ */
72
+ utf8Encoder?: __Encoder;
73
+ /**
74
+ * The runtime environment.
75
+ * @internal
76
+ */
77
+ runtime?: string;
78
+ /**
79
+ * Disable dynamically changing the endpoint of the client based on the hostPrefix
80
+ * trait of an operation.
81
+ */
82
+ disableHostPrefix?: boolean;
83
+ /**
84
+ * Unique service identifier.
85
+ * @internal
86
+ */
87
+ serviceId?: string;
88
+ /**
89
+ * Enables IPv6/IPv4 dualstack endpoint.
90
+ */
91
+ useDualstackEndpoint?: boolean | __Provider<boolean>;
92
+ /**
93
+ * Enables FIPS compatible endpoints.
94
+ */
95
+ useFipsEndpoint?: boolean | __Provider<boolean>;
96
+ /**
97
+ * The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
98
+ * @internal
99
+ */
100
+ defaultUserAgentProvider?: Provider<__UserAgent>;
101
+ /**
102
+ * The AWS region to which this client will send requests
103
+ */
104
+ region?: string | __Provider<string>;
105
+ /**
106
+ * Default credentials provider; Not available in browser runtime.
107
+ * @deprecated
108
+ * @internal
109
+ */
110
+ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
111
+ /**
112
+ * Value for how many times a request will be made at most in case of retry.
113
+ */
114
+ maxAttempts?: number | __Provider<number>;
115
+ /**
116
+ * Specifies which retry algorithm to use.
117
+ * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/
118
+ *
119
+ */
120
+ retryMode?: string | __Provider<string>;
121
+ /**
122
+ * Optional logger for logging debug/info/warn/error.
123
+ */
124
+ logger?: __Logger;
125
+ /**
126
+ * Optional extensions
127
+ */
128
+ extensions?: RuntimeExtension[];
129
+ /**
130
+ * The {@link @smithy/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
131
+ */
132
+ defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
133
+ }
134
+ /**
135
+ * @public
136
+ */
137
+ export type ControlCatalogClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & UserAgentInputConfig & HttpAuthSchemeInputConfig & ClientInputEndpointParameters;
138
+ /**
139
+ * @public
140
+ *
141
+ * The configuration interface of ControlCatalogClient class constructor that set the region, credentials and other options.
142
+ */
143
+ export interface ControlCatalogClientConfig extends ControlCatalogClientConfigType {
144
+ }
145
+ /**
146
+ * @public
147
+ */
148
+ export type ControlCatalogClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RuntimeExtensionsConfig & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & UserAgentResolvedConfig & HttpAuthSchemeResolvedConfig & ClientResolvedEndpointParameters;
149
+ /**
150
+ * @public
151
+ *
152
+ * The resolved configuration interface of ControlCatalogClient class. This is resolved and normalized from the {@link ControlCatalogClientConfig | constructor configuration interface}.
153
+ */
154
+ export interface ControlCatalogClientResolvedConfig extends ControlCatalogClientResolvedConfigType {
155
+ }
156
+ /**
157
+ * <p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
158
+ * developers who need detailed information about how to programmatically identify and filter
159
+ * the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
160
+ * descriptions, syntax, and usage examples for each of the actions and data types that are
161
+ * supported by Amazon Web Services Control Catalog. </p>
162
+ * <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
163
+ * <ul>
164
+ * <li>
165
+ * <p>
166
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
167
+ * alphabetical list of all Control Catalog API operations.</p>
168
+ * </li>
169
+ * <li>
170
+ * <p>
171
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
172
+ * alphabetical list of all Control Catalog data types.</p>
173
+ * </li>
174
+ * <li>
175
+ * <p>
176
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
177
+ * parameters</a>: Parameters that all operations can use.</p>
178
+ * </li>
179
+ * <li>
180
+ * <p>
181
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
182
+ * Client and server errors that all operations can return.</p>
183
+ * </li>
184
+ * </ul>
185
+ * @public
186
+ */
187
+ export declare class ControlCatalogClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ControlCatalogClientResolvedConfig> {
188
+ /**
189
+ * The resolved configuration of ControlCatalogClient class. This is resolved and normalized from the {@link ControlCatalogClientConfig | constructor configuration interface}.
190
+ */
191
+ readonly config: ControlCatalogClientResolvedConfig;
192
+ constructor(...[configuration]: __CheckOptionalClientConfig<ControlCatalogClientConfig>);
193
+ /**
194
+ * Destroy underlying resources, like sockets. It's usually not necessary to do this.
195
+ * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
196
+ * Otherwise, sockets might stay open for quite a long time before the server terminates them.
197
+ */
198
+ destroy(): void;
199
+ private getDefaultHttpAuthSchemeParametersProvider;
200
+ private getIdentityProviderConfigProvider;
201
+ }
@@ -0,0 +1,29 @@
1
+ import { AwsCredentialIdentity, AwsCredentialIdentityProvider, HttpAuthScheme } from "@smithy/types";
2
+ import { ControlCatalogHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
3
+ /**
4
+ * @internal
5
+ */
6
+ export interface HttpAuthExtensionConfiguration {
7
+ setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
8
+ httpAuthSchemes(): HttpAuthScheme[];
9
+ setHttpAuthSchemeProvider(httpAuthSchemeProvider: ControlCatalogHttpAuthSchemeProvider): void;
10
+ httpAuthSchemeProvider(): ControlCatalogHttpAuthSchemeProvider;
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: ControlCatalogHttpAuthSchemeProvider;
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 { ControlCatalogClientResolvedConfig } from "../ControlCatalogClient";
4
+ /**
5
+ * @internal
6
+ */
7
+ export interface ControlCatalogHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
8
+ region?: string;
9
+ }
10
+ /**
11
+ * @internal
12
+ */
13
+ export interface ControlCatalogHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<ControlCatalogClientResolvedConfig, HandlerExecutionContext, ControlCatalogHttpAuthSchemeParameters, object> {
14
+ }
15
+ /**
16
+ * @internal
17
+ */
18
+ export declare const defaultControlCatalogHttpAuthSchemeParametersProvider: (config: ControlCatalogClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<ControlCatalogHttpAuthSchemeParameters>;
19
+ /**
20
+ * @internal
21
+ */
22
+ export interface ControlCatalogHttpAuthSchemeProvider extends HttpAuthSchemeProvider<ControlCatalogHttpAuthSchemeParameters> {
23
+ }
24
+ /**
25
+ * @internal
26
+ */
27
+ export declare const defaultControlCatalogHttpAuthSchemeProvider: ControlCatalogHttpAuthSchemeProvider;
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?: ControlCatalogHttpAuthSchemeProvider;
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: ControlCatalogHttpAuthSchemeProvider;
57
+ }
58
+ /**
59
+ * @internal
60
+ */
61
+ export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig & AwsSdkSigV4PreviouslyResolved) => T & HttpAuthSchemeResolvedConfig;
@@ -0,0 +1,99 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlCatalogClient";
4
+ import { ListCommonControlsRequest, ListCommonControlsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link ListCommonControlsCommand}.
13
+ */
14
+ export interface ListCommonControlsCommandInput extends ListCommonControlsRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ListCommonControlsCommand}.
20
+ */
21
+ export interface ListCommonControlsCommandOutput extends ListCommonControlsResponse, __MetadataBearer {
22
+ }
23
+ declare const ListCommonControlsCommand_base: {
24
+ new (input: ListCommonControlsCommandInput): import("@smithy/smithy-client").CommandImpl<ListCommonControlsCommandInput, ListCommonControlsCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [ListCommonControlsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListCommonControlsCommandInput, ListCommonControlsCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Returns a paginated list of common controls from the Amazon Web Services Control
30
+ * Catalog.</p>
31
+ * <p>You can apply an optional filter to see common controls that have a specific objective. If
32
+ * you don’t provide a filter, the operation returns all common controls. </p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { ControlCatalogClient, ListCommonControlsCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import
37
+ * // const { ControlCatalogClient, ListCommonControlsCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import
38
+ * const client = new ControlCatalogClient(config);
39
+ * const input = { // ListCommonControlsRequest
40
+ * MaxResults: Number("int"),
41
+ * NextToken: "STRING_VALUE",
42
+ * CommonControlFilter: { // CommonControlFilter
43
+ * Objectives: [ // ObjectiveResourceFilterList
44
+ * { // ObjectiveResourceFilter
45
+ * Arn: "STRING_VALUE",
46
+ * },
47
+ * ],
48
+ * },
49
+ * };
50
+ * const command = new ListCommonControlsCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // ListCommonControlsResponse
53
+ * // CommonControls: [ // CommonControlSummaryList // required
54
+ * // { // CommonControlSummary
55
+ * // Arn: "STRING_VALUE", // required
56
+ * // Name: "STRING_VALUE", // required
57
+ * // Description: "STRING_VALUE", // required
58
+ * // Domain: { // AssociatedDomainSummary
59
+ * // Arn: "STRING_VALUE",
60
+ * // Name: "STRING_VALUE",
61
+ * // },
62
+ * // Objective: { // AssociatedObjectiveSummary
63
+ * // Arn: "STRING_VALUE",
64
+ * // Name: "STRING_VALUE",
65
+ * // },
66
+ * // CreateTime: new Date("TIMESTAMP"), // required
67
+ * // LastUpdateTime: new Date("TIMESTAMP"), // required
68
+ * // },
69
+ * // ],
70
+ * // NextToken: "STRING_VALUE",
71
+ * // };
72
+ *
73
+ * ```
74
+ *
75
+ * @param ListCommonControlsCommandInput - {@link ListCommonControlsCommandInput}
76
+ * @returns {@link ListCommonControlsCommandOutput}
77
+ * @see {@link ListCommonControlsCommandInput} for command's `input` shape.
78
+ * @see {@link ListCommonControlsCommandOutput} for command's `response` shape.
79
+ * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape.
80
+ *
81
+ * @throws {@link AccessDeniedException} (client fault)
82
+ * <p>You do not have sufficient access to perform this action.</p>
83
+ *
84
+ * @throws {@link InternalServerException} (server fault)
85
+ * <p>An internal service error occurred during the processing of your request. Try again later.</p>
86
+ *
87
+ * @throws {@link ThrottlingException} (client fault)
88
+ * <p>The request was denied due to request throttling.</p>
89
+ *
90
+ * @throws {@link ValidationException} (client fault)
91
+ * <p>The request has invalid or missing parameters.</p>
92
+ *
93
+ * @throws {@link ControlCatalogServiceException}
94
+ * <p>Base exception class for all service exceptions from ControlCatalog service.</p>
95
+ *
96
+ * @public
97
+ */
98
+ export declare class ListCommonControlsCommand extends ListCommonControlsCommand_base {
99
+ }