@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,81 @@
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 { ListDomainsRequest, ListDomainsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link ListDomainsCommand}.
13
+ */
14
+ export interface ListDomainsCommandInput extends ListDomainsRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ListDomainsCommand}.
20
+ */
21
+ export interface ListDomainsCommandOutput extends ListDomainsResponse, __MetadataBearer {
22
+ }
23
+ declare const ListDomainsCommand_base: {
24
+ new (input: ListDomainsCommandInput): import("@smithy/smithy-client").CommandImpl<ListDomainsCommandInput, ListDomainsCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [ListDomainsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListDomainsCommandInput, ListDomainsCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Returns a paginated list of domains from the Amazon Web Services Control Catalog.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { ControlCatalogClient, ListDomainsCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import
34
+ * // const { ControlCatalogClient, ListDomainsCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import
35
+ * const client = new ControlCatalogClient(config);
36
+ * const input = { // ListDomainsRequest
37
+ * MaxResults: Number("int"),
38
+ * NextToken: "STRING_VALUE",
39
+ * };
40
+ * const command = new ListDomainsCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ListDomainsResponse
43
+ * // Domains: [ // DomainSummaryList // required
44
+ * // { // DomainSummary
45
+ * // Arn: "STRING_VALUE", // required
46
+ * // Name: "STRING_VALUE", // required
47
+ * // Description: "STRING_VALUE", // required
48
+ * // CreateTime: new Date("TIMESTAMP"), // required
49
+ * // LastUpdateTime: new Date("TIMESTAMP"), // required
50
+ * // },
51
+ * // ],
52
+ * // NextToken: "STRING_VALUE",
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param ListDomainsCommandInput - {@link ListDomainsCommandInput}
58
+ * @returns {@link ListDomainsCommandOutput}
59
+ * @see {@link ListDomainsCommandInput} for command's `input` shape.
60
+ * @see {@link ListDomainsCommandOutput} for command's `response` shape.
61
+ * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape.
62
+ *
63
+ * @throws {@link AccessDeniedException} (client fault)
64
+ * <p>You do not have sufficient access to perform this action.</p>
65
+ *
66
+ * @throws {@link InternalServerException} (server fault)
67
+ * <p>An internal service error occurred during the processing of your request. Try again later.</p>
68
+ *
69
+ * @throws {@link ThrottlingException} (client fault)
70
+ * <p>The request was denied due to request throttling.</p>
71
+ *
72
+ * @throws {@link ValidationException} (client fault)
73
+ * <p>The request has invalid or missing parameters.</p>
74
+ *
75
+ * @throws {@link ControlCatalogServiceException}
76
+ * <p>Base exception class for all service exceptions from ControlCatalog service.</p>
77
+ *
78
+ * @public
79
+ */
80
+ export declare class ListDomainsCommand extends ListDomainsCommand_base {
81
+ }
@@ -0,0 +1,94 @@
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 { ListObjectivesRequest, ListObjectivesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link ListObjectivesCommand}.
13
+ */
14
+ export interface ListObjectivesCommandInput extends ListObjectivesRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ListObjectivesCommand}.
20
+ */
21
+ export interface ListObjectivesCommandOutput extends ListObjectivesResponse, __MetadataBearer {
22
+ }
23
+ declare const ListObjectivesCommand_base: {
24
+ new (input: ListObjectivesCommandInput): import("@smithy/smithy-client").CommandImpl<ListObjectivesCommandInput, ListObjectivesCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [ListObjectivesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListObjectivesCommandInput, ListObjectivesCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Returns a paginated list of objectives from the Amazon Web Services Control Catalog.</p>
30
+ * <p>You can apply an optional filter to see the objectives that belong to a specific domain.
31
+ * If you don’t provide a filter, the operation returns all objectives. </p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { ControlCatalogClient, ListObjectivesCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import
36
+ * // const { ControlCatalogClient, ListObjectivesCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import
37
+ * const client = new ControlCatalogClient(config);
38
+ * const input = { // ListObjectivesRequest
39
+ * MaxResults: Number("int"),
40
+ * NextToken: "STRING_VALUE",
41
+ * ObjectiveFilter: { // ObjectiveFilter
42
+ * Domains: [ // DomainResourceFilterList
43
+ * { // DomainResourceFilter
44
+ * Arn: "STRING_VALUE",
45
+ * },
46
+ * ],
47
+ * },
48
+ * };
49
+ * const command = new ListObjectivesCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // ListObjectivesResponse
52
+ * // Objectives: [ // ObjectiveSummaryList // required
53
+ * // { // ObjectiveSummary
54
+ * // Arn: "STRING_VALUE", // required
55
+ * // Name: "STRING_VALUE", // required
56
+ * // Description: "STRING_VALUE", // required
57
+ * // Domain: { // AssociatedDomainSummary
58
+ * // Arn: "STRING_VALUE",
59
+ * // Name: "STRING_VALUE",
60
+ * // },
61
+ * // CreateTime: new Date("TIMESTAMP"), // required
62
+ * // LastUpdateTime: new Date("TIMESTAMP"), // required
63
+ * // },
64
+ * // ],
65
+ * // NextToken: "STRING_VALUE",
66
+ * // };
67
+ *
68
+ * ```
69
+ *
70
+ * @param ListObjectivesCommandInput - {@link ListObjectivesCommandInput}
71
+ * @returns {@link ListObjectivesCommandOutput}
72
+ * @see {@link ListObjectivesCommandInput} for command's `input` shape.
73
+ * @see {@link ListObjectivesCommandOutput} for command's `response` shape.
74
+ * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape.
75
+ *
76
+ * @throws {@link AccessDeniedException} (client fault)
77
+ * <p>You do not have sufficient access to perform this action.</p>
78
+ *
79
+ * @throws {@link InternalServerException} (server fault)
80
+ * <p>An internal service error occurred during the processing of your request. Try again later.</p>
81
+ *
82
+ * @throws {@link ThrottlingException} (client fault)
83
+ * <p>The request was denied due to request throttling.</p>
84
+ *
85
+ * @throws {@link ValidationException} (client fault)
86
+ * <p>The request has invalid or missing parameters.</p>
87
+ *
88
+ * @throws {@link ControlCatalogServiceException}
89
+ * <p>Base exception class for all service exceptions from ControlCatalog service.</p>
90
+ *
91
+ * @public
92
+ */
93
+ export declare class ListObjectivesCommand extends ListObjectivesCommand_base {
94
+ }
@@ -0,0 +1,3 @@
1
+ export * from "./ListCommonControlsCommand";
2
+ export * from "./ListDomainsCommand";
3
+ export * from "./ListObjectivesCommand";
@@ -0,0 +1,40 @@
1
+ import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface ClientInputEndpointParameters {
6
+ region?: string | Provider<string>;
7
+ useDualstackEndpoint?: boolean | Provider<boolean>;
8
+ useFipsEndpoint?: boolean | Provider<boolean>;
9
+ endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
10
+ }
11
+ export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
12
+ defaultSigningName: string;
13
+ };
14
+ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
15
+ defaultSigningName: string;
16
+ };
17
+ export declare const commonParams: {
18
+ readonly UseFIPS: {
19
+ readonly type: "builtInParams";
20
+ readonly name: "useFipsEndpoint";
21
+ };
22
+ readonly Endpoint: {
23
+ readonly type: "builtInParams";
24
+ readonly name: "endpoint";
25
+ };
26
+ readonly Region: {
27
+ readonly type: "builtInParams";
28
+ readonly name: "region";
29
+ };
30
+ readonly UseDualStack: {
31
+ readonly type: "builtInParams";
32
+ readonly name: "useDualstackEndpoint";
33
+ };
34
+ };
35
+ export interface EndpointParameters extends __EndpointParameters {
36
+ Region?: string;
37
+ UseDualStack?: boolean;
38
+ UseFIPS?: boolean;
39
+ Endpoint?: string;
40
+ }
@@ -0,0 +1,5 @@
1
+ import { EndpointV2, Logger } from "@smithy/types";
2
+ import { EndpointParameters } from "./EndpointParameters";
3
+ export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
4
+ logger?: Logger;
5
+ }) => EndpointV2;
@@ -0,0 +1,2 @@
1
+ import { RuleSetObject } from "@smithy/types";
2
+ export declare const ruleSet: RuleSetObject;
@@ -0,0 +1,9 @@
1
+ import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
2
+ import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
3
+ import { DefaultExtensionConfiguration } from "@smithy/types";
4
+ import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
5
+ /**
6
+ * @internal
7
+ */
8
+ export interface ControlCatalogExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
9
+ }
@@ -0,0 +1,41 @@
1
+ /**
2
+ * <p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
3
+ * developers who need detailed information about how to programmatically identify and filter
4
+ * the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
5
+ * descriptions, syntax, and usage examples for each of the actions and data types that are
6
+ * supported by Amazon Web Services Control Catalog. </p>
7
+ * <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
8
+ * <ul>
9
+ * <li>
10
+ * <p>
11
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
12
+ * alphabetical list of all Control Catalog API operations.</p>
13
+ * </li>
14
+ * <li>
15
+ * <p>
16
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
17
+ * alphabetical list of all Control Catalog data types.</p>
18
+ * </li>
19
+ * <li>
20
+ * <p>
21
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
22
+ * parameters</a>: Parameters that all operations can use.</p>
23
+ * </li>
24
+ * <li>
25
+ * <p>
26
+ * <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
27
+ * Client and server errors that all operations can return.</p>
28
+ * </li>
29
+ * </ul>
30
+ *
31
+ * @packageDocumentation
32
+ */
33
+ export * from "./ControlCatalogClient";
34
+ export * from "./ControlCatalog";
35
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
36
+ export { RuntimeExtension } from "./runtimeExtensions";
37
+ export { ControlCatalogExtensionConfiguration } from "./extensionConfiguration";
38
+ export * from "./commands";
39
+ export * from "./pagination";
40
+ export * from "./models";
41
+ export { ControlCatalogServiceException } from "./models/ControlCatalogServiceException";
@@ -0,0 +1,13 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
2
+ export { __ServiceException, __ServiceExceptionOptions };
3
+ /**
4
+ * @public
5
+ *
6
+ * Base exception class for all service exceptions from ControlCatalog service.
7
+ */
8
+ export declare class ControlCatalogServiceException extends __ServiceException {
9
+ /**
10
+ * @internal
11
+ */
12
+ constructor(options: __ServiceExceptionOptions);
13
+ }
@@ -0,0 +1 @@
1
+ export * from "./models_0";
@@ -0,0 +1,350 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { ControlCatalogServiceException as __BaseException } from "./ControlCatalogServiceException";
3
+ /**
4
+ * <p>You do not have sufficient access to perform this action.</p>
5
+ * @public
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ Message?: string;
11
+ /**
12
+ * @internal
13
+ */
14
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
+ }
16
+ /**
17
+ * <p>A summary of the domain that a common control or an objective belongs to.</p>
18
+ * @public
19
+ */
20
+ export interface AssociatedDomainSummary {
21
+ /**
22
+ * <p>The Amazon Resource Name (ARN) of the related domain.</p>
23
+ * @public
24
+ */
25
+ Arn?: string;
26
+ /**
27
+ * <p>The name of the related domain.</p>
28
+ * @public
29
+ */
30
+ Name?: string;
31
+ }
32
+ /**
33
+ * <p>A summary of the objective that a common control supports.</p>
34
+ * @public
35
+ */
36
+ export interface AssociatedObjectiveSummary {
37
+ /**
38
+ * <p>The Amazon Resource Name (ARN) of the related objective.</p>
39
+ * @public
40
+ */
41
+ Arn?: string;
42
+ /**
43
+ * <p>The name of the related objective.</p>
44
+ * @public
45
+ */
46
+ Name?: string;
47
+ }
48
+ /**
49
+ * <p>The objective resource that's being used as a filter.</p>
50
+ * @public
51
+ */
52
+ export interface ObjectiveResourceFilter {
53
+ /**
54
+ * <p>The Amazon Resource Name (ARN) of the objective.</p>
55
+ * @public
56
+ */
57
+ Arn?: string;
58
+ }
59
+ /**
60
+ * <p>An optional filter that narrows the results to a specific objective.</p>
61
+ * @public
62
+ */
63
+ export interface CommonControlFilter {
64
+ /**
65
+ * <p>The objective that's used as filter criteria.</p>
66
+ * <p>You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs
67
+ * in the <code>CommonControlFilter</code> isn’t currently supported.</p>
68
+ * @public
69
+ */
70
+ Objectives?: ObjectiveResourceFilter[];
71
+ }
72
+ /**
73
+ * <p>An internal service error occurred during the processing of your request. Try again later.</p>
74
+ * @public
75
+ */
76
+ export declare class InternalServerException extends __BaseException {
77
+ readonly name: "InternalServerException";
78
+ readonly $fault: "server";
79
+ $retryable: {};
80
+ Message?: string;
81
+ /**
82
+ * @internal
83
+ */
84
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
85
+ }
86
+ /**
87
+ * @public
88
+ */
89
+ export interface ListCommonControlsRequest {
90
+ /**
91
+ * <p>The maximum number of results on a page or for an API request call.</p>
92
+ * @public
93
+ */
94
+ MaxResults?: number;
95
+ /**
96
+ * <p>The pagination token that's used to fetch the next set of results.</p>
97
+ * @public
98
+ */
99
+ NextToken?: string;
100
+ /**
101
+ * <p>An optional filter that narrows the results to a specific objective.</p>
102
+ * <p>This filter allows you to specify one objective ARN at a time. Passing multiple ARNs in
103
+ * the <code>CommonControlFilter</code> isn’t currently supported.</p>
104
+ * @public
105
+ */
106
+ CommonControlFilter?: CommonControlFilter;
107
+ }
108
+ /**
109
+ * <p>A summary of metadata for a common control.</p>
110
+ * @public
111
+ */
112
+ export interface CommonControlSummary {
113
+ /**
114
+ * <p>The Amazon Resource Name (ARN) that identifies the common control.</p>
115
+ * @public
116
+ */
117
+ Arn: string | undefined;
118
+ /**
119
+ * <p>The name of the common control.</p>
120
+ * @public
121
+ */
122
+ Name: string | undefined;
123
+ /**
124
+ * <p>The description of the common control.</p>
125
+ * @public
126
+ */
127
+ Description: string | undefined;
128
+ /**
129
+ * <p>The domain that the common control belongs to.</p>
130
+ * @public
131
+ */
132
+ Domain: AssociatedDomainSummary | undefined;
133
+ /**
134
+ * <p>The objective that the common control belongs to.</p>
135
+ * @public
136
+ */
137
+ Objective: AssociatedObjectiveSummary | undefined;
138
+ /**
139
+ * <p>The time when the common control was created.</p>
140
+ * @public
141
+ */
142
+ CreateTime: Date | undefined;
143
+ /**
144
+ * <p>The time when the common control was most recently updated.</p>
145
+ * @public
146
+ */
147
+ LastUpdateTime: Date | undefined;
148
+ }
149
+ /**
150
+ * @public
151
+ */
152
+ export interface ListCommonControlsResponse {
153
+ /**
154
+ * <p>The list of common controls that the <code>ListCommonControls</code> API returns.</p>
155
+ * @public
156
+ */
157
+ CommonControls: CommonControlSummary[] | undefined;
158
+ /**
159
+ * <p>The pagination token that's used to fetch the next set of results.</p>
160
+ * @public
161
+ */
162
+ NextToken?: string;
163
+ }
164
+ /**
165
+ * <p>The request was denied due to request throttling.</p>
166
+ * @public
167
+ */
168
+ export declare class ThrottlingException extends __BaseException {
169
+ readonly name: "ThrottlingException";
170
+ readonly $fault: "client";
171
+ $retryable: {
172
+ throttling: boolean;
173
+ };
174
+ Message?: string;
175
+ /**
176
+ * @internal
177
+ */
178
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
179
+ }
180
+ /**
181
+ * <p>The request has invalid or missing parameters.</p>
182
+ * @public
183
+ */
184
+ export declare class ValidationException extends __BaseException {
185
+ readonly name: "ValidationException";
186
+ readonly $fault: "client";
187
+ Message?: string;
188
+ /**
189
+ * @internal
190
+ */
191
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
192
+ }
193
+ /**
194
+ * @public
195
+ */
196
+ export interface ListDomainsRequest {
197
+ /**
198
+ * <p>The maximum number of results on a page or for an API request call.</p>
199
+ * @public
200
+ */
201
+ MaxResults?: number;
202
+ /**
203
+ * <p>The pagination token that's used to fetch the next set of results.</p>
204
+ * @public
205
+ */
206
+ NextToken?: string;
207
+ }
208
+ /**
209
+ * <p>A summary of metadata for a domain.</p>
210
+ * @public
211
+ */
212
+ export interface DomainSummary {
213
+ /**
214
+ * <p>The Amazon Resource Name (ARN) that identifies the domain.</p>
215
+ * @public
216
+ */
217
+ Arn: string | undefined;
218
+ /**
219
+ * <p>The name of the domain.</p>
220
+ * @public
221
+ */
222
+ Name: string | undefined;
223
+ /**
224
+ * <p>The description of the domain.</p>
225
+ * @public
226
+ */
227
+ Description: string | undefined;
228
+ /**
229
+ * <p>The time when the domain was created.</p>
230
+ * @public
231
+ */
232
+ CreateTime: Date | undefined;
233
+ /**
234
+ * <p>The time when the domain was most recently updated.</p>
235
+ * @public
236
+ */
237
+ LastUpdateTime: Date | undefined;
238
+ }
239
+ /**
240
+ * @public
241
+ */
242
+ export interface ListDomainsResponse {
243
+ /**
244
+ * <p>The list of domains that the <code>ListDomains</code> API returns.</p>
245
+ * @public
246
+ */
247
+ Domains: DomainSummary[] | undefined;
248
+ /**
249
+ * <p>The pagination token that's used to fetch the next set of results.</p>
250
+ * @public
251
+ */
252
+ NextToken?: string;
253
+ }
254
+ /**
255
+ * <p>The domain resource that's being used as a filter.</p>
256
+ * @public
257
+ */
258
+ export interface DomainResourceFilter {
259
+ /**
260
+ * <p>The Amazon Resource Name (ARN) of the domain.</p>
261
+ * @public
262
+ */
263
+ Arn?: string;
264
+ }
265
+ /**
266
+ * <p>An optional filter that narrows the list of objectives to a specific domain.</p>
267
+ * @public
268
+ */
269
+ export interface ObjectiveFilter {
270
+ /**
271
+ * <p>The domain that's used as filter criteria.</p>
272
+ * <p>You can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in
273
+ * the <code>ObjectiveFilter</code> isn’t currently supported.</p>
274
+ * @public
275
+ */
276
+ Domains?: DomainResourceFilter[];
277
+ }
278
+ /**
279
+ * @public
280
+ */
281
+ export interface ListObjectivesRequest {
282
+ /**
283
+ * <p>The maximum number of results on a page or for an API request call.</p>
284
+ * @public
285
+ */
286
+ MaxResults?: number;
287
+ /**
288
+ * <p>The pagination token that's used to fetch the next set of results.</p>
289
+ * @public
290
+ */
291
+ NextToken?: string;
292
+ /**
293
+ * <p>An optional filter that narrows the results to a specific domain.</p>
294
+ * <p>This filter allows you to specify one domain ARN at a time.
295
+ * Passing multiple ARNs in the <code>ObjectiveFilter</code> isn’t currently supported.</p>
296
+ * @public
297
+ */
298
+ ObjectiveFilter?: ObjectiveFilter;
299
+ }
300
+ /**
301
+ * <p>A summary of metadata for an objective.</p>
302
+ * @public
303
+ */
304
+ export interface ObjectiveSummary {
305
+ /**
306
+ * <p>The Amazon Resource Name (ARN) that identifies the objective.</p>
307
+ * @public
308
+ */
309
+ Arn: string | undefined;
310
+ /**
311
+ * <p>The name of the objective.</p>
312
+ * @public
313
+ */
314
+ Name: string | undefined;
315
+ /**
316
+ * <p>The description of the objective.</p>
317
+ * @public
318
+ */
319
+ Description: string | undefined;
320
+ /**
321
+ * <p>The domain that the objective belongs to.</p>
322
+ * @public
323
+ */
324
+ Domain: AssociatedDomainSummary | undefined;
325
+ /**
326
+ * <p>The time when the objective was created.</p>
327
+ * @public
328
+ */
329
+ CreateTime: Date | undefined;
330
+ /**
331
+ * <p>The time when the objective was most recently updated.</p>
332
+ * @public
333
+ */
334
+ LastUpdateTime: Date | undefined;
335
+ }
336
+ /**
337
+ * @public
338
+ */
339
+ export interface ListObjectivesResponse {
340
+ /**
341
+ * <p>The list of objectives that the <code>ListObjectives</code> API returns.</p>
342
+ * @public
343
+ */
344
+ Objectives: ObjectiveSummary[] | undefined;
345
+ /**
346
+ * <p>The pagination token that's used to fetch the next set of results.</p>
347
+ * @public
348
+ */
349
+ NextToken?: string;
350
+ }
@@ -0,0 +1,8 @@
1
+ import { PaginationConfiguration } from "@smithy/types";
2
+ import { ControlCatalogClient } from "../ControlCatalogClient";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface ControlCatalogPaginationConfiguration extends PaginationConfiguration {
7
+ client: ControlCatalogClient;
8
+ }
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import { ListCommonControlsCommandInput, ListCommonControlsCommandOutput } from "../commands/ListCommonControlsCommand";
3
+ import { ControlCatalogPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateListCommonControls: (config: ControlCatalogPaginationConfiguration, input: ListCommonControlsCommandInput, ...rest: any[]) => Paginator<ListCommonControlsCommandOutput>;
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@smithy/types";
2
+ import { ListDomainsCommandInput, ListDomainsCommandOutput } from "../commands/ListDomainsCommand";
3
+ import { ControlCatalogPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateListDomains: (config: ControlCatalogPaginationConfiguration, input: ListDomainsCommandInput, ...rest: any[]) => Paginator<ListDomainsCommandOutput>;