diff --git a/clients/client-controlcatalog/.gitignore b/clients/client-controlcatalog/.gitignore new file mode 100644 index 000000000000..54f14c9aef25 --- /dev/null +++ b/clients/client-controlcatalog/.gitignore @@ -0,0 +1,9 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +/dist-* +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/clients/client-controlcatalog/LICENSE b/clients/client-controlcatalog/LICENSE new file mode 100644 index 000000000000..1349aa7c9923 --- /dev/null +++ b/clients/client-controlcatalog/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/clients/client-controlcatalog/README.md b/clients/client-controlcatalog/README.md new file mode 100644 index 000000000000..87b61e5028bd --- /dev/null +++ b/clients/client-controlcatalog/README.md @@ -0,0 +1,256 @@ + + +# @aws-sdk/client-controlcatalog + +## Description + +AWS SDK for JavaScript ControlCatalog Client for Node.js, Browser and React Native. + +
Welcome to the Amazon Web Services Control Catalog API reference. This guide is for +developers who need detailed information about how to programmatically identify and filter +the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides +descriptions, syntax, and usage examples for each of the actions and data types that are +supported by Amazon Web Services Control Catalog.
+Use the following links to get started with the Amazon Web Services Control Catalog API:
++Actions: An +alphabetical list of all Control Catalog API operations.
++Data types: An +alphabetical list of all Control Catalog data types.
++Common +parameters: Parameters that all operations can use.
++Common errors: +Client and server errors that all operations can return.
+Welcome to the Amazon Web Services Control Catalog API reference. This guide is for + * developers who need detailed information about how to programmatically identify and filter + * the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides + * descriptions, syntax, and usage examples for each of the actions and data types that are + * supported by Amazon Web Services Control Catalog.
+ *Use the following links to get started with the Amazon Web Services Control Catalog API:
+ *+ * Actions: An + * alphabetical list of all Control Catalog API operations.
+ *+ * Data types: An + * alphabetical list of all Control Catalog data types.
+ *+ * Common + * parameters: Parameters that all operations can use.
+ *+ * Common errors: + * Client and server errors that all operations can return.
+ *Welcome to the Amazon Web Services Control Catalog API reference. This guide is for + * developers who need detailed information about how to programmatically identify and filter + * the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides + * descriptions, syntax, and usage examples for each of the actions and data types that are + * supported by Amazon Web Services Control Catalog.
+ *Use the following links to get started with the Amazon Web Services Control Catalog API:
+ *+ * Actions: An + * alphabetical list of all Control Catalog API operations.
+ *+ * Data types: An + * alphabetical list of all Control Catalog data types.
+ *+ * Common + * parameters: Parameters that all operations can use.
+ *+ * Common errors: + * Client and server errors that all operations can return.
+ *Returns a paginated list of common controls from the Amazon Web Services Control + * Catalog.
+ *You can apply an optional filter to see common controls that have a specific objective. If + * you don’t provide a filter, the operation returns all common controls.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ControlCatalogClient, ListCommonControlsCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import + * // const { ControlCatalogClient, ListCommonControlsCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import + * const client = new ControlCatalogClient(config); + * const input = { // ListCommonControlsRequest + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * CommonControlFilter: { // CommonControlFilter + * Objectives: [ // ObjectiveResourceFilterList + * { // ObjectiveResourceFilter + * Arn: "STRING_VALUE", + * }, + * ], + * }, + * }; + * const command = new ListCommonControlsCommand(input); + * const response = await client.send(command); + * // { // ListCommonControlsResponse + * // CommonControls: [ // CommonControlSummaryList // required + * // { // CommonControlSummary + * // Arn: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", // required + * // Domain: { // AssociatedDomainSummary + * // Arn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // }, + * // Objective: { // AssociatedObjectiveSummary + * // Arn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // }, + * // CreateTime: new Date("TIMESTAMP"), // required + * // LastUpdateTime: new Date("TIMESTAMP"), // required + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListCommonControlsCommandInput - {@link ListCommonControlsCommandInput} + * @returns {@link ListCommonControlsCommandOutput} + * @see {@link ListCommonControlsCommandInput} for command's `input` shape. + * @see {@link ListCommonControlsCommandOutput} for command's `response` shape. + * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *An internal service error occurred during the processing of your request. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request has invalid or missing parameters.
+ * + * @throws {@link ControlCatalogServiceException} + *Base exception class for all service exceptions from ControlCatalog service.
+ * + * @public + */ +export class ListCommonControlsCommand extends $Command + .classBuilder< + ListCommonControlsCommandInput, + ListCommonControlsCommandOutput, + ControlCatalogClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: ControlCatalogClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("ControlCatalog", "ListCommonControls", {}) + .n("ControlCatalogClient", "ListCommonControlsCommand") + .f(void 0, void 0) + .ser(se_ListCommonControlsCommand) + .de(de_ListCommonControlsCommand) + .build() {} diff --git a/clients/client-controlcatalog/src/commands/ListDomainsCommand.ts b/clients/client-controlcatalog/src/commands/ListDomainsCommand.ts new file mode 100644 index 000000000000..41e30cf775be --- /dev/null +++ b/clients/client-controlcatalog/src/commands/ListDomainsCommand.ts @@ -0,0 +1,103 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlCatalogClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListDomainsRequest, ListDomainsResponse } from "../models/models_0"; +import { de_ListDomainsCommand, se_ListDomainsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListDomainsCommand}. + */ +export interface ListDomainsCommandInput extends ListDomainsRequest {} +/** + * @public + * + * The output of {@link ListDomainsCommand}. + */ +export interface ListDomainsCommandOutput extends ListDomainsResponse, __MetadataBearer {} + +/** + *Returns a paginated list of domains from the Amazon Web Services Control Catalog.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ControlCatalogClient, ListDomainsCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import + * // const { ControlCatalogClient, ListDomainsCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import + * const client = new ControlCatalogClient(config); + * const input = { // ListDomainsRequest + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListDomainsCommand(input); + * const response = await client.send(command); + * // { // ListDomainsResponse + * // Domains: [ // DomainSummaryList // required + * // { // DomainSummary + * // Arn: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", // required + * // CreateTime: new Date("TIMESTAMP"), // required + * // LastUpdateTime: new Date("TIMESTAMP"), // required + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListDomainsCommandInput - {@link ListDomainsCommandInput} + * @returns {@link ListDomainsCommandOutput} + * @see {@link ListDomainsCommandInput} for command's `input` shape. + * @see {@link ListDomainsCommandOutput} for command's `response` shape. + * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *An internal service error occurred during the processing of your request. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request has invalid or missing parameters.
+ * + * @throws {@link ControlCatalogServiceException} + *Base exception class for all service exceptions from ControlCatalog service.
+ * + * @public + */ +export class ListDomainsCommand extends $Command + .classBuilder< + ListDomainsCommandInput, + ListDomainsCommandOutput, + ControlCatalogClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: ControlCatalogClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("ControlCatalog", "ListDomains", {}) + .n("ControlCatalogClient", "ListDomainsCommand") + .f(void 0, void 0) + .ser(se_ListDomainsCommand) + .de(de_ListDomainsCommand) + .build() {} diff --git a/clients/client-controlcatalog/src/commands/ListObjectivesCommand.ts b/clients/client-controlcatalog/src/commands/ListObjectivesCommand.ts new file mode 100644 index 000000000000..44a5e8e4c577 --- /dev/null +++ b/clients/client-controlcatalog/src/commands/ListObjectivesCommand.ts @@ -0,0 +1,116 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlCatalogClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListObjectivesRequest, ListObjectivesResponse } from "../models/models_0"; +import { de_ListObjectivesCommand, se_ListObjectivesCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export { __MetadataBearer, $Command }; +/** + * @public + * + * The input for {@link ListObjectivesCommand}. + */ +export interface ListObjectivesCommandInput extends ListObjectivesRequest {} +/** + * @public + * + * The output of {@link ListObjectivesCommand}. + */ +export interface ListObjectivesCommandOutput extends ListObjectivesResponse, __MetadataBearer {} + +/** + *Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
+ *You can apply an optional filter to see the objectives that belong to a specific domain. + * If you don’t provide a filter, the operation returns all objectives.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ControlCatalogClient, ListObjectivesCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import + * // const { ControlCatalogClient, ListObjectivesCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import + * const client = new ControlCatalogClient(config); + * const input = { // ListObjectivesRequest + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * ObjectiveFilter: { // ObjectiveFilter + * Domains: [ // DomainResourceFilterList + * { // DomainResourceFilter + * Arn: "STRING_VALUE", + * }, + * ], + * }, + * }; + * const command = new ListObjectivesCommand(input); + * const response = await client.send(command); + * // { // ListObjectivesResponse + * // Objectives: [ // ObjectiveSummaryList // required + * // { // ObjectiveSummary + * // Arn: "STRING_VALUE", // required + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", // required + * // Domain: { // AssociatedDomainSummary + * // Arn: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // }, + * // CreateTime: new Date("TIMESTAMP"), // required + * // LastUpdateTime: new Date("TIMESTAMP"), // required + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListObjectivesCommandInput - {@link ListObjectivesCommandInput} + * @returns {@link ListObjectivesCommandOutput} + * @see {@link ListObjectivesCommandInput} for command's `input` shape. + * @see {@link ListObjectivesCommandOutput} for command's `response` shape. + * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *An internal service error occurred during the processing of your request. Try again later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *The request has invalid or missing parameters.
+ * + * @throws {@link ControlCatalogServiceException} + *Base exception class for all service exceptions from ControlCatalog service.
+ * + * @public + */ +export class ListObjectivesCommand extends $Command + .classBuilder< + ListObjectivesCommandInput, + ListObjectivesCommandOutput, + ControlCatalogClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: ControlCatalogClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("ControlCatalog", "ListObjectives", {}) + .n("ControlCatalogClient", "ListObjectivesCommand") + .f(void 0, void 0) + .ser(se_ListObjectivesCommand) + .de(de_ListObjectivesCommand) + .build() {} diff --git a/clients/client-controlcatalog/src/commands/index.ts b/clients/client-controlcatalog/src/commands/index.ts new file mode 100644 index 000000000000..b13889c948a2 --- /dev/null +++ b/clients/client-controlcatalog/src/commands/index.ts @@ -0,0 +1,4 @@ +// smithy-typescript generated code +export * from "./ListCommonControlsCommand"; +export * from "./ListDomainsCommand"; +export * from "./ListObjectivesCommand"; diff --git a/clients/client-controlcatalog/src/endpoint/EndpointParameters.ts b/clients/client-controlcatalog/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..07a8131760b1 --- /dev/null +++ b/clients/client-controlcatalog/src/endpoint/EndpointParameters.ts @@ -0,0 +1,41 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + region?: string | ProviderWelcome to the Amazon Web Services Control Catalog API reference. This guide is for + * developers who need detailed information about how to programmatically identify and filter + * the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides + * descriptions, syntax, and usage examples for each of the actions and data types that are + * supported by Amazon Web Services Control Catalog.
+ *Use the following links to get started with the Amazon Web Services Control Catalog API:
+ *+ * Actions: An + * alphabetical list of all Control Catalog API operations.
+ *+ * Data types: An + * alphabetical list of all Control Catalog data types.
+ *+ * Common + * parameters: Parameters that all operations can use.
+ *+ * Common errors: + * Client and server errors that all operations can return.
+ *You do not have sufficient access to perform this action.
+ * @public + */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA summary of the domain that a common control or an objective belongs to.
+ * @public + */ +export interface AssociatedDomainSummary { + /** + *The Amazon Resource Name (ARN) of the related domain.
+ * @public + */ + Arn?: string; + + /** + *The name of the related domain.
+ * @public + */ + Name?: string; +} + +/** + *A summary of the objective that a common control supports.
+ * @public + */ +export interface AssociatedObjectiveSummary { + /** + *The Amazon Resource Name (ARN) of the related objective.
+ * @public + */ + Arn?: string; + + /** + *The name of the related objective.
+ * @public + */ + Name?: string; +} + +/** + *The objective resource that's being used as a filter.
+ * @public + */ +export interface ObjectiveResourceFilter { + /** + *The Amazon Resource Name (ARN) of the objective.
+ * @public + */ + Arn?: string; +} + +/** + *An optional filter that narrows the results to a specific objective.
+ * @public + */ +export interface CommonControlFilter { + /** + *The objective that's used as filter criteria.
+ *You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs
+ * in the CommonControlFilter
isn’t currently supported.
An internal service error occurred during the processing of your request. Try again later.
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe maximum number of results on a page or for an API request call.
+ * @public + */ + MaxResults?: number; + + /** + *The pagination token that's used to fetch the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *An optional filter that narrows the results to a specific objective.
+ *This filter allows you to specify one objective ARN at a time. Passing multiple ARNs in
+ * the CommonControlFilter
isn’t currently supported.
A summary of metadata for a common control.
+ * @public + */ +export interface CommonControlSummary { + /** + *The Amazon Resource Name (ARN) that identifies the common control.
+ * @public + */ + Arn: string | undefined; + + /** + *The name of the common control.
+ * @public + */ + Name: string | undefined; + + /** + *The description of the common control.
+ * @public + */ + Description: string | undefined; + + /** + *The domain that the common control belongs to.
+ * @public + */ + Domain: AssociatedDomainSummary | undefined; + + /** + *The objective that the common control belongs to.
+ * @public + */ + Objective: AssociatedObjectiveSummary | undefined; + + /** + *The time when the common control was created.
+ * @public + */ + CreateTime: Date | undefined; + + /** + *The time when the common control was most recently updated.
+ * @public + */ + LastUpdateTime: Date | undefined; +} + +/** + * @public + */ +export interface ListCommonControlsResponse { + /** + *The list of common controls that the ListCommonControls
API returns.
The pagination token that's used to fetch the next set of results.
+ * @public + */ + NextToken?: string; +} + +/** + *The request was denied due to request throttling.
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = { + throttling: true, + }; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request has invalid or missing parameters.
+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe maximum number of results on a page or for an API request call.
+ * @public + */ + MaxResults?: number; + + /** + *The pagination token that's used to fetch the next set of results.
+ * @public + */ + NextToken?: string; +} + +/** + *A summary of metadata for a domain.
+ * @public + */ +export interface DomainSummary { + /** + *The Amazon Resource Name (ARN) that identifies the domain.
+ * @public + */ + Arn: string | undefined; + + /** + *The name of the domain.
+ * @public + */ + Name: string | undefined; + + /** + *The description of the domain.
+ * @public + */ + Description: string | undefined; + + /** + *The time when the domain was created.
+ * @public + */ + CreateTime: Date | undefined; + + /** + *The time when the domain was most recently updated.
+ * @public + */ + LastUpdateTime: Date | undefined; +} + +/** + * @public + */ +export interface ListDomainsResponse { + /** + *The list of domains that the ListDomains
API returns.
The pagination token that's used to fetch the next set of results.
+ * @public + */ + NextToken?: string; +} + +/** + *The domain resource that's being used as a filter.
+ * @public + */ +export interface DomainResourceFilter { + /** + *The Amazon Resource Name (ARN) of the domain.
+ * @public + */ + Arn?: string; +} + +/** + *An optional filter that narrows the list of objectives to a specific domain.
+ * @public + */ +export interface ObjectiveFilter { + /** + *The domain that's used as filter criteria.
+ *You can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in
+ * the ObjectiveFilter
isn’t currently supported.
The maximum number of results on a page or for an API request call.
+ * @public + */ + MaxResults?: number; + + /** + *The pagination token that's used to fetch the next set of results.
+ * @public + */ + NextToken?: string; + + /** + *An optional filter that narrows the results to a specific domain.
+ *This filter allows you to specify one domain ARN at a time.
+ * Passing multiple ARNs in the ObjectiveFilter
isn’t currently supported.
A summary of metadata for an objective.
+ * @public + */ +export interface ObjectiveSummary { + /** + *The Amazon Resource Name (ARN) that identifies the objective.
+ * @public + */ + Arn: string | undefined; + + /** + *The name of the objective.
+ * @public + */ + Name: string | undefined; + + /** + *The description of the objective.
+ * @public + */ + Description: string | undefined; + + /** + *The domain that the objective belongs to.
+ * @public + */ + Domain: AssociatedDomainSummary | undefined; + + /** + *The time when the objective was created.
+ * @public + */ + CreateTime: Date | undefined; + + /** + *The time when the objective was most recently updated.
+ * @public + */ + LastUpdateTime: Date | undefined; +} + +/** + * @public + */ +export interface ListObjectivesResponse { + /** + *The list of objectives that the ListObjectives
API returns.
The pagination token that's used to fetch the next set of results.
+ * @public + */ + NextToken?: string; +} diff --git a/clients/client-controlcatalog/src/pagination/Interfaces.ts b/clients/client-controlcatalog/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..9a1c095d769c --- /dev/null +++ b/clients/client-controlcatalog/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { ControlCatalogClient } from "../ControlCatalogClient"; + +/** + * @public + */ +export interface ControlCatalogPaginationConfiguration extends PaginationConfiguration { + client: ControlCatalogClient; +} diff --git a/clients/client-controlcatalog/src/pagination/ListCommonControlsPaginator.ts b/clients/client-controlcatalog/src/pagination/ListCommonControlsPaginator.ts new file mode 100644 index 000000000000..a7632a4d6dbd --- /dev/null +++ b/clients/client-controlcatalog/src/pagination/ListCommonControlsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListCommonControlsCommand, + ListCommonControlsCommandInput, + ListCommonControlsCommandOutput, +} from "../commands/ListCommonControlsCommand"; +import { ControlCatalogClient } from "../ControlCatalogClient"; +import { ControlCatalogPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListCommonControls: ( + config: ControlCatalogPaginationConfiguration, + input: ListCommonControlsCommandInput, + ...rest: any[] +) => PaginatorYou do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.controlcatalog#AssociatedDomainSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.controlcatalog#DomainArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the related domain.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the related domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the domain that a common control or an objective belongs to.
" + } + }, + "com.amazonaws.controlcatalog#AssociatedObjectiveSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.controlcatalog#ObjectiveArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the related objective.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the related objective.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the objective that a common control supports.
" + } + }, + "com.amazonaws.controlcatalog#CommonControlArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 41, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws(?:[-a-z]*)?):controlcatalog:::common-control/[0-9a-z]+$" + } + }, + "com.amazonaws.controlcatalog#CommonControlFilter": { + "type": "structure", + "members": { + "Objectives": { + "target": "com.amazonaws.controlcatalog#ObjectiveResourceFilterList", + "traits": { + "smithy.api#documentation": "The objective that's used as filter criteria.
\nYou can use this parameter to specify one objective ARN at a time. Passing multiple ARNs\n in the CommonControlFilter
isn’t currently supported.
An optional filter that narrows the results to a specific objective.
" + } + }, + "com.amazonaws.controlcatalog#CommonControlResource": { + "type": "resource", + "identifiers": { + "CommonControlArn": { + "target": "com.amazonaws.controlcatalog#CommonControlArn" + } + }, + "list": { + "target": "com.amazonaws.controlcatalog#ListCommonControls" + }, + "traits": { + "aws.api#arn": { + "template": "{CommonControlArn}", + "noAccount": true, + "absolute": true + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "common-control" + } + } + }, + "com.amazonaws.controlcatalog#CommonControlSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.controlcatalog#CommonControlArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the common control.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the common control.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the common control.
", + "smithy.api#required": {} + } + }, + "Domain": { + "target": "com.amazonaws.controlcatalog#AssociatedDomainSummary", + "traits": { + "smithy.api#documentation": "The domain that the common control belongs to.
", + "smithy.api#required": {} + } + }, + "Objective": { + "target": "com.amazonaws.controlcatalog#AssociatedObjectiveSummary", + "traits": { + "smithy.api#documentation": "The objective that the common control belongs to.
", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the common control was created.
", + "smithy.api#required": {} + } + }, + "LastUpdateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the common control was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of metadata for a common control.
" + } + }, + "com.amazonaws.controlcatalog#CommonControlSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.controlcatalog#CommonControlSummary" + } + }, + "com.amazonaws.controlcatalog#ControlCatalog": { + "type": "service", + "version": "2018-05-10", + "resources": [ + { + "target": "com.amazonaws.controlcatalog#CommonControlResource" + }, + { + "target": "com.amazonaws.controlcatalog#DomainResource" + }, + { + "target": "com.amazonaws.controlcatalog#ObjectiveResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ControlCatalog", + "arnNamespace": "controlcatalog", + "cloudTrailEventSource": "controlcatalog.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "controlcatalog" + }, + "aws.iam#supportedPrincipalTypes": ["Root", "IAMUser", "IAMRole", "FederatedUser"], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "origin": "*", + "additionalAllowedHeaders": [ + "*", + "access-control-allow-origin", + "Amz-Sdk-Invocation-Id", + "Amz-Sdk-Request", + "Authorization", + "Content-Length", + "Content-Type", + "Date", + "Host", + "X-Amz-Content-Sha256", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "X-Amz-User-Agent", + "X-Amzn-Trace-Id" + ] + }, + "smithy.api#documentation": "Welcome to the Amazon Web Services Control Catalog API reference. This guide is for \n developers who need detailed information about how to programmatically identify and filter \n the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides \n descriptions, syntax, and usage examples for each of the actions and data types that are \n supported by Amazon Web Services Control Catalog.
\nUse the following links to get started with the Amazon Web Services Control Catalog API:
\n\n Actions: An\n alphabetical list of all Control Catalog API operations.
\n\n Data types: An\n alphabetical list of all Control Catalog data types.
\n\n Common\n parameters: Parameters that all operations can use.
\n\n Common errors:\n Client and server errors that all operations can return.
\nThe Amazon Resource Name (ARN) of the domain.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The domain resource that's being used as a filter.
" + } + }, + "com.amazonaws.controlcatalog#DomainResourceFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.controlcatalog#DomainResourceFilter" + } + }, + "com.amazonaws.controlcatalog#DomainSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.controlcatalog#DomainArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the domain.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the domain.
", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the domain was created.
", + "smithy.api#required": {} + } + }, + "LastUpdateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the domain was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of metadata for a domain.
" + } + }, + "com.amazonaws.controlcatalog#DomainSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.controlcatalog#DomainSummary" + } + }, + "com.amazonaws.controlcatalog#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "An internal service error occurred during the processing of your request. Try again later.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.controlcatalog#ListCommonControls": { + "type": "operation", + "input": { + "target": "com.amazonaws.controlcatalog#ListCommonControlsRequest" + }, + "output": { + "target": "com.amazonaws.controlcatalog#ListCommonControlsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.controlcatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.controlcatalog#InternalServerException" + }, + { + "target": "com.amazonaws.controlcatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.controlcatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of common controls from the Amazon Web Services Control\n Catalog.
\nYou can apply an optional filter to see common controls that have a specific objective. If\n you don’t provide a filter, the operation returns all common controls.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/common-controls" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "CommonControls" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controlcatalog#ListCommonControlsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.controlcatalog#MaxListCommonControlsResults", + "traits": { + "smithy.api#documentation": "The maximum number of results on a page or for an API request call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.controlcatalog#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "CommonControlFilter": { + "target": "com.amazonaws.controlcatalog#CommonControlFilter", + "traits": { + "smithy.api#documentation": "An optional filter that narrows the results to a specific objective.
\nThis filter allows you to specify one objective ARN at a time. Passing multiple ARNs in\n the CommonControlFilter
isn’t currently supported.
The list of common controls that the ListCommonControls
API returns.
The pagination token that's used to fetch the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.controlcatalog#ListDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.controlcatalog#ListDomainsRequest" + }, + "output": { + "target": "com.amazonaws.controlcatalog#ListDomainsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.controlcatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.controlcatalog#InternalServerException" + }, + { + "target": "com.amazonaws.controlcatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.controlcatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of domains from the Amazon Web Services Control Catalog.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/domains" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Domains" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controlcatalog#ListDomainsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.controlcatalog#MaxListDomainsResults", + "traits": { + "smithy.api#documentation": "The maximum number of results on a page or for an API request call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.controlcatalog#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controlcatalog#ListDomainsResponse": { + "type": "structure", + "members": { + "Domains": { + "target": "com.amazonaws.controlcatalog#DomainSummaryList", + "traits": { + "smithy.api#documentation": "The list of domains that the ListDomains
API returns.
The pagination token that's used to fetch the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.controlcatalog#ListObjectives": { + "type": "operation", + "input": { + "target": "com.amazonaws.controlcatalog#ListObjectivesRequest" + }, + "output": { + "target": "com.amazonaws.controlcatalog#ListObjectivesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.controlcatalog#AccessDeniedException" + }, + { + "target": "com.amazonaws.controlcatalog#InternalServerException" + }, + { + "target": "com.amazonaws.controlcatalog#ThrottlingException" + }, + { + "target": "com.amazonaws.controlcatalog#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
\nYou can apply an optional filter to see the objectives that belong to a specific domain.\n If you don’t provide a filter, the operation returns all objectives.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/objectives" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Objectives" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controlcatalog#ListObjectivesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.controlcatalog#MaxListObjectivesResults", + "traits": { + "smithy.api#documentation": "The maximum number of results on a page or for an API request call.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.controlcatalog#PaginationToken", + "traits": { + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "ObjectiveFilter": { + "target": "com.amazonaws.controlcatalog#ObjectiveFilter", + "traits": { + "smithy.api#documentation": "An optional filter that narrows the results to a specific domain.
\nThis filter allows you to specify one domain ARN at a time. \n Passing multiple ARNs in the ObjectiveFilter
isn’t currently supported.
The list of objectives that the ListObjectives
API returns.
The pagination token that's used to fetch the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.controlcatalog#MaxListCommonControlsResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.controlcatalog#MaxListDomainsResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.controlcatalog#MaxListObjectivesResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.controlcatalog#ObjectiveArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws(?:[-a-z]*)?):controlcatalog:::objective/[0-9a-z]+$" + } + }, + "com.amazonaws.controlcatalog#ObjectiveFilter": { + "type": "structure", + "members": { + "Domains": { + "target": "com.amazonaws.controlcatalog#DomainResourceFilterList", + "traits": { + "smithy.api#documentation": "The domain that's used as filter criteria.
\nYou can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in\n the ObjectiveFilter
isn’t currently supported.
An optional filter that narrows the list of objectives to a specific domain.
" + } + }, + "com.amazonaws.controlcatalog#ObjectiveResource": { + "type": "resource", + "identifiers": { + "ObjectiveArn": { + "target": "com.amazonaws.controlcatalog#ObjectiveArn" + } + }, + "list": { + "target": "com.amazonaws.controlcatalog#ListObjectives" + }, + "traits": { + "aws.api#arn": { + "template": "{ObjectiveArn}", + "noAccount": true, + "absolute": true + }, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "objective" + } + } + }, + "com.amazonaws.controlcatalog#ObjectiveResourceFilter": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.controlcatalog#ObjectiveArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the objective.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The objective resource that's being used as a filter.
" + } + }, + "com.amazonaws.controlcatalog#ObjectiveResourceFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.controlcatalog#ObjectiveResourceFilter" + } + }, + "com.amazonaws.controlcatalog#ObjectiveSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.controlcatalog#ObjectiveArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the objective.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the objective.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the objective.
", + "smithy.api#required": {} + } + }, + "Domain": { + "target": "com.amazonaws.controlcatalog#AssociatedDomainSummary", + "traits": { + "smithy.api#documentation": "The domain that the objective belongs to.
", + "smithy.api#required": {} + } + }, + "CreateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the objective was created.
", + "smithy.api#required": {} + } + }, + "LastUpdateTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the objective was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of metadata for an objective.
" + } + }, + "com.amazonaws.controlcatalog#ObjectiveSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.controlcatalog#ObjectiveSummary" + } + }, + "com.amazonaws.controlcatalog#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 1024 + } + } + }, + "com.amazonaws.controlcatalog#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.controlcatalog#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request has invalid or missing parameters.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +}