Quick Setup helps you quickly configure frequently used services and features with +recommended best practices. Quick Setup simplifies setting up services, including +Systems Manager, by automating common or recommended tasks.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-ssm-quicksetup +using your favorite package manager: + +- `npm install @aws-sdk/client-ssm-quicksetup` +- `yarn add @aws-sdk/client-ssm-quicksetup` +- `pnpm add @aws-sdk/client-ssm-quicksetup` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `SSMQuickSetupClient` and +the commands you need, for example `ListQuickSetupTypesCommand`: + +```js +// ES5 example +const { SSMQuickSetupClient, ListQuickSetupTypesCommand } = require("@aws-sdk/client-ssm-quicksetup"); +``` + +```ts +// ES6+ example +import { SSMQuickSetupClient, ListQuickSetupTypesCommand } from "@aws-sdk/client-ssm-quicksetup"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new SSMQuickSetupClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListQuickSetupTypesCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-ssm-quicksetup"; +const client = new AWS.SSMQuickSetup({ region: "REGION" }); + +// async/await. +try { + const data = await client.listQuickSetupTypes(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listQuickSetupTypes(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listQuickSetupTypes(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-ssm-quicksetup` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. + +## Client Commands (Operations List) + +Quick Setup helps you quickly configure frequently used services and features with + * recommended best practices. Quick Setup simplifies setting up services, including + * Systems Manager, by automating common or recommended tasks.
+ * @public + */ +export class SSMQuickSetup extends SSMQuickSetupClient implements SSMQuickSetup {} +createAggregatedClient(commands, SSMQuickSetup); diff --git a/clients/client-ssm-quicksetup/src/SSMQuickSetupClient.ts b/clients/client-ssm-quicksetup/src/SSMQuickSetupClient.ts new file mode 100644 index 0000000000000..ef29c794c0f3a --- /dev/null +++ b/clients/client-ssm-quicksetup/src/SSMQuickSetupClient.ts @@ -0,0 +1,366 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { + DefaultIdentityProviderConfig, + getHttpAuthSchemeEndpointRuleSetPlugin, + getHttpSigningPlugin, +} from "@smithy/core"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + AwsCredentialIdentityProvider, + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + 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"; + +import { + defaultSSMQuickSetupHttpAuthSchemeParametersProvider, + HttpAuthSchemeInputConfig, + HttpAuthSchemeResolvedConfig, + resolveHttpAuthSchemeConfig, +} from "./auth/httpAuthSchemeProvider"; +import { + CreateConfigurationManagerCommandInput, + CreateConfigurationManagerCommandOutput, +} from "./commands/CreateConfigurationManagerCommand"; +import { + DeleteConfigurationManagerCommandInput, + DeleteConfigurationManagerCommandOutput, +} from "./commands/DeleteConfigurationManagerCommand"; +import { + GetConfigurationManagerCommandInput, + GetConfigurationManagerCommandOutput, +} from "./commands/GetConfigurationManagerCommand"; +import { GetServiceSettingsCommandInput, GetServiceSettingsCommandOutput } from "./commands/GetServiceSettingsCommand"; +import { + ListConfigurationManagersCommandInput, + ListConfigurationManagersCommandOutput, +} from "./commands/ListConfigurationManagersCommand"; +import { + ListQuickSetupTypesCommandInput, + ListQuickSetupTypesCommandOutput, +} from "./commands/ListQuickSetupTypesCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { + UpdateConfigurationDefinitionCommandInput, + UpdateConfigurationDefinitionCommandOutput, +} from "./commands/UpdateConfigurationDefinitionCommand"; +import { + UpdateConfigurationManagerCommandInput, + UpdateConfigurationManagerCommandOutput, +} from "./commands/UpdateConfigurationManagerCommand"; +import { + UpdateServiceSettingsCommandInput, + UpdateServiceSettingsCommandOutput, +} from "./commands/UpdateServiceSettingsCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | CreateConfigurationManagerCommandInput + | DeleteConfigurationManagerCommandInput + | GetConfigurationManagerCommandInput + | GetServiceSettingsCommandInput + | ListConfigurationManagersCommandInput + | ListQuickSetupTypesCommandInput + | ListTagsForResourceCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput + | UpdateConfigurationDefinitionCommandInput + | UpdateConfigurationManagerCommandInput + | UpdateServiceSettingsCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | CreateConfigurationManagerCommandOutput + | DeleteConfigurationManagerCommandOutput + | GetConfigurationManagerCommandOutput + | GetServiceSettingsCommandOutput + | ListConfigurationManagersCommandOutput + | ListQuickSetupTypesCommandOutput + | ListTagsForResourceCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput + | UpdateConfigurationDefinitionCommandOutput + | UpdateConfigurationManagerCommandOutput + | UpdateServiceSettingsCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandlerUserInput; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderQuick Setup helps you quickly configure frequently used services and features with + * recommended best practices. Quick Setup simplifies setting up services, including + * Systems Manager, by automating common or recommended tasks.
+ * @public + */ +export class SSMQuickSetupClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + SSMQuickSetupClientResolvedConfig +> { + /** + * The resolved configuration of SSMQuickSetupClient class. This is resolved and normalized from the {@link SSMQuickSetupClientConfig | constructor configuration interface}. + */ + readonly config: SSMQuickSetupClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigCreates a Quick Setup configuration manager resource. This object is a collection + * of desired state configurations for multiple configuration definitions and + * summaries describing the deployments of those definitions.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, CreateConfigurationManagerCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, CreateConfigurationManagerCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // CreateConfigurationManagerInput + * Name: "STRING_VALUE", + * Description: "STRING_VALUE", + * ConfigurationDefinitions: [ // ConfigurationDefinitionsInputList // required + * { // ConfigurationDefinitionInput + * Type: "STRING_VALUE", // required + * Parameters: { // ConfigurationParametersMap // required + * "The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class CreateConfigurationManagerCommand extends $Command + .classBuilder< + CreateConfigurationManagerCommandInput, + CreateConfigurationManagerCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "CreateConfigurationManager", {}) + .n("SSMQuickSetupClient", "CreateConfigurationManagerCommand") + .f(CreateConfigurationManagerInputFilterSensitiveLog, void 0) + .ser(se_CreateConfigurationManagerCommand) + .de(de_CreateConfigurationManagerCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/DeleteConfigurationManagerCommand.ts b/clients/client-ssm-quicksetup/src/commands/DeleteConfigurationManagerCommand.ts new file mode 100644 index 0000000000000..2b80b06655e76 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/DeleteConfigurationManagerCommand.ts @@ -0,0 +1,99 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { DeleteConfigurationManagerInput } from "../models/models_0"; +import { de_DeleteConfigurationManagerCommand, se_DeleteConfigurationManagerCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteConfigurationManagerCommand}. + */ +export interface DeleteConfigurationManagerCommandInput extends DeleteConfigurationManagerInput {} +/** + * @public + * + * The output of {@link DeleteConfigurationManagerCommand}. + */ +export interface DeleteConfigurationManagerCommandOutput extends __MetadataBearer {} + +/** + *Deletes a configuration manager.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, DeleteConfigurationManagerCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, DeleteConfigurationManagerCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // DeleteConfigurationManagerInput + * ManagerArn: "STRING_VALUE", // required + * }; + * const command = new DeleteConfigurationManagerCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteConfigurationManagerCommandInput - {@link DeleteConfigurationManagerCommandInput} + * @returns {@link DeleteConfigurationManagerCommandOutput} + * @see {@link DeleteConfigurationManagerCommandInput} for command's `input` shape. + * @see {@link DeleteConfigurationManagerCommandOutput} for command's `response` shape. + * @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found. Check the ID or name and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class DeleteConfigurationManagerCommand extends $Command + .classBuilder< + DeleteConfigurationManagerCommandInput, + DeleteConfigurationManagerCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "DeleteConfigurationManager", {}) + .n("SSMQuickSetupClient", "DeleteConfigurationManagerCommand") + .f(void 0, void 0) + .ser(se_DeleteConfigurationManagerCommand) + .de(de_DeleteConfigurationManagerCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/GetConfigurationManagerCommand.ts b/clients/client-ssm-quicksetup/src/commands/GetConfigurationManagerCommand.ts new file mode 100644 index 0000000000000..016c5404e7e14 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/GetConfigurationManagerCommand.ts @@ -0,0 +1,135 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { + GetConfigurationManagerInput, + GetConfigurationManagerOutput, + GetConfigurationManagerOutputFilterSensitiveLog, +} from "../models/models_0"; +import { de_GetConfigurationManagerCommand, se_GetConfigurationManagerCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetConfigurationManagerCommand}. + */ +export interface GetConfigurationManagerCommandInput extends GetConfigurationManagerInput {} +/** + * @public + * + * The output of {@link GetConfigurationManagerCommand}. + */ +export interface GetConfigurationManagerCommandOutput extends GetConfigurationManagerOutput, __MetadataBearer {} + +/** + *Returns a configuration manager.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, GetConfigurationManagerCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, GetConfigurationManagerCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // GetConfigurationManagerInput + * ManagerArn: "STRING_VALUE", // required + * }; + * const command = new GetConfigurationManagerCommand(input); + * const response = await client.send(command); + * // { // GetConfigurationManagerOutput + * // ManagerArn: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // CreatedAt: new Date("TIMESTAMP"), + * // LastModifiedAt: new Date("TIMESTAMP"), + * // StatusSummaries: [ // StatusSummariesList + * // { // StatusSummary + * // StatusType: "Deployment" || "AsyncExecutions", // required + * // Status: "INITIALIZING" || "DEPLOYING" || "SUCCEEDED" || "DELETING" || "STOPPING" || "FAILED" || "STOPPED" || "DELETE_FAILED" || "STOP_FAILED" || "NONE", + * // StatusMessage: "STRING_VALUE", + * // LastUpdatedAt: new Date("TIMESTAMP"), // required + * // StatusDetails: { // StatusDetails + * // "The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found. Check the ID or name and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class GetConfigurationManagerCommand extends $Command + .classBuilder< + GetConfigurationManagerCommandInput, + GetConfigurationManagerCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "GetConfigurationManager", {}) + .n("SSMQuickSetupClient", "GetConfigurationManagerCommand") + .f(void 0, GetConfigurationManagerOutputFilterSensitiveLog) + .ser(se_GetConfigurationManagerCommand) + .de(de_GetConfigurationManagerCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/GetServiceSettingsCommand.ts b/clients/client-ssm-quicksetup/src/commands/GetServiceSettingsCommand.ts new file mode 100644 index 0000000000000..8d5a0c4ebdb24 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/GetServiceSettingsCommand.ts @@ -0,0 +1,94 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { GetServiceSettingsOutput } from "../models/models_0"; +import { de_GetServiceSettingsCommand, se_GetServiceSettingsCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetServiceSettingsCommand}. + */ +export interface GetServiceSettingsCommandInput {} +/** + * @public + * + * The output of {@link GetServiceSettingsCommand}. + */ +export interface GetServiceSettingsCommandOutput extends GetServiceSettingsOutput, __MetadataBearer {} + +/** + *Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, GetServiceSettingsCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, GetServiceSettingsCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = {}; + * const command = new GetServiceSettingsCommand(input); + * const response = await client.send(command); + * // { // GetServiceSettingsOutput + * // ServiceSettings: { // ServiceSettings + * // ExplorerEnablingRoleArn: "STRING_VALUE", + * // }, + * // }; + * + * ``` + * + * @param GetServiceSettingsCommandInput - {@link GetServiceSettingsCommandInput} + * @returns {@link GetServiceSettingsCommandOutput} + * @see {@link GetServiceSettingsCommandInput} for command's `input` shape. + * @see {@link GetServiceSettingsCommandOutput} for command's `response` shape. + * @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class GetServiceSettingsCommand extends $Command + .classBuilder< + GetServiceSettingsCommandInput, + GetServiceSettingsCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "GetServiceSettings", {}) + .n("SSMQuickSetupClient", "GetServiceSettingsCommand") + .f(void 0, void 0) + .ser(se_GetServiceSettingsCommand) + .de(de_GetServiceSettingsCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/ListConfigurationManagersCommand.ts b/clients/client-ssm-quicksetup/src/commands/ListConfigurationManagersCommand.ts new file mode 100644 index 0000000000000..97a22026fa80d --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/ListConfigurationManagersCommand.ts @@ -0,0 +1,135 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { ListConfigurationManagersInput, ListConfigurationManagersOutput } from "../models/models_0"; +import { de_ListConfigurationManagersCommand, se_ListConfigurationManagersCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListConfigurationManagersCommand}. + */ +export interface ListConfigurationManagersCommandInput extends ListConfigurationManagersInput {} +/** + * @public + * + * The output of {@link ListConfigurationManagersCommand}. + */ +export interface ListConfigurationManagersCommandOutput extends ListConfigurationManagersOutput, __MetadataBearer {} + +/** + *Returns Quick Setup configuration managers.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, ListConfigurationManagersCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, ListConfigurationManagersCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // ListConfigurationManagersInput + * StartingToken: "STRING_VALUE", + * MaxItems: Number("int"), + * Filters: [ // FiltersList + * { // Filter + * Key: "STRING_VALUE", // required + * Values: [ // FilterValues // required + * "STRING_VALUE", + * ], + * }, + * ], + * }; + * const command = new ListConfigurationManagersCommand(input); + * const response = await client.send(command); + * // { // ListConfigurationManagersOutput + * // ConfigurationManagersList: [ // ConfigurationManagerList + * // { // ConfigurationManagerSummary + * // ManagerArn: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // StatusSummaries: [ // StatusSummariesList + * // { // StatusSummary + * // StatusType: "Deployment" || "AsyncExecutions", // required + * // Status: "INITIALIZING" || "DEPLOYING" || "SUCCEEDED" || "DELETING" || "STOPPING" || "FAILED" || "STOPPED" || "DELETE_FAILED" || "STOP_FAILED" || "NONE", + * // StatusMessage: "STRING_VALUE", + * // LastUpdatedAt: new Date("TIMESTAMP"), // required + * // StatusDetails: { // StatusDetails + * // "The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class ListConfigurationManagersCommand extends $Command + .classBuilder< + ListConfigurationManagersCommandInput, + ListConfigurationManagersCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "ListConfigurationManagers", {}) + .n("SSMQuickSetupClient", "ListConfigurationManagersCommand") + .f(void 0, void 0) + .ser(se_ListConfigurationManagersCommand) + .de(de_ListConfigurationManagersCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/ListQuickSetupTypesCommand.ts b/clients/client-ssm-quicksetup/src/commands/ListQuickSetupTypesCommand.ts new file mode 100644 index 0000000000000..7b96bae8a09c1 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/ListQuickSetupTypesCommand.ts @@ -0,0 +1,97 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { ListQuickSetupTypesOutput } from "../models/models_0"; +import { de_ListQuickSetupTypesCommand, se_ListQuickSetupTypesCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListQuickSetupTypesCommand}. + */ +export interface ListQuickSetupTypesCommandInput {} +/** + * @public + * + * The output of {@link ListQuickSetupTypesCommand}. + */ +export interface ListQuickSetupTypesCommandOutput extends ListQuickSetupTypesOutput, __MetadataBearer {} + +/** + *Returns the available Quick Setup types.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, ListQuickSetupTypesCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, ListQuickSetupTypesCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = {}; + * const command = new ListQuickSetupTypesCommand(input); + * const response = await client.send(command); + * // { // ListQuickSetupTypesOutput + * // QuickSetupTypeList: [ // QuickSetupTypeList + * // { // QuickSetupTypeOutput + * // Type: "STRING_VALUE", + * // LatestVersion: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListQuickSetupTypesCommandInput - {@link ListQuickSetupTypesCommandInput} + * @returns {@link ListQuickSetupTypesCommandOutput} + * @see {@link ListQuickSetupTypesCommandInput} for command's `input` shape. + * @see {@link ListQuickSetupTypesCommandOutput} for command's `response` shape. + * @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class ListQuickSetupTypesCommand extends $Command + .classBuilder< + ListQuickSetupTypesCommandInput, + ListQuickSetupTypesCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "ListQuickSetupTypes", {}) + .n("SSMQuickSetupClient", "ListQuickSetupTypesCommand") + .f(void 0, void 0) + .ser(se_ListQuickSetupTypesCommand) + .de(de_ListQuickSetupTypesCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/ListTagsForResourceCommand.ts b/clients/client-ssm-quicksetup/src/commands/ListTagsForResourceCommand.ts new file mode 100644 index 0000000000000..d296896d37fc0 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/ListTagsForResourceCommand.ts @@ -0,0 +1,110 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { + ListTagsForResourceRequest, + ListTagsForResourceResponse, + ListTagsForResourceResponseFilterSensitiveLog, +} from "../models/models_0"; +import { de_ListTagsForResourceCommand, se_ListTagsForResourceCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {} +/** + * @public + * + * The output of {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} + +/** + *Returns tags assigned to the resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, ListTagsForResourceCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, ListTagsForResourceCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // ListTagsForResourceRequest + * ResourceArn: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceResponse + * // Tags: [ // Tags + * // { // TagEntry + * // Key: "STRING_VALUE", + * // Value: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput} + * @returns {@link ListTagsForResourceCommandOutput} + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found. Check the ID or name and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class ListTagsForResourceCommand extends $Command + .classBuilder< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "ListTagsForResource", {}) + .n("SSMQuickSetupClient", "ListTagsForResourceCommand") + .f(void 0, ListTagsForResourceResponseFilterSensitiveLog) + .ser(se_ListTagsForResourceCommand) + .de(de_ListTagsForResourceCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/TagResourceCommand.ts b/clients/client-ssm-quicksetup/src/commands/TagResourceCommand.ts new file mode 100644 index 0000000000000..7fdb94961ac68 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/TagResourceCommand.ts @@ -0,0 +1,102 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { TagResourceInput, TagResourceInputFilterSensitiveLog } from "../models/models_0"; +import { de_TagResourceCommand, se_TagResourceCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link TagResourceCommand}. + */ +export interface TagResourceCommandInput extends TagResourceInput {} +/** + * @public + * + * The output of {@link TagResourceCommand}. + */ +export interface TagResourceCommandOutput extends __MetadataBearer {} + +/** + *Assigns key-value pairs of metadata to Amazon Web Services resources.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, TagResourceCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, TagResourceCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // TagResourceInput + * ResourceArn: "STRING_VALUE", // required + * Tags: { // TagsMap // required + * "The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found. Check the ID or name and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class TagResourceCommand extends $Command + .classBuilder< + TagResourceCommandInput, + TagResourceCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "TagResource", {}) + .n("SSMQuickSetupClient", "TagResourceCommand") + .f(TagResourceInputFilterSensitiveLog, void 0) + .ser(se_TagResourceCommand) + .de(de_TagResourceCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/UntagResourceCommand.ts b/clients/client-ssm-quicksetup/src/commands/UntagResourceCommand.ts new file mode 100644 index 0000000000000..a40cc7dab5a44 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/UntagResourceCommand.ts @@ -0,0 +1,102 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { UntagResourceInput } from "../models/models_0"; +import { de_UntagResourceCommand, se_UntagResourceCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandInput extends UntagResourceInput {} +/** + * @public + * + * The output of {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandOutput extends __MetadataBearer {} + +/** + *Removes tags from the specified resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, UntagResourceCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, UntagResourceCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // UntagResourceInput + * ResourceArn: "STRING_VALUE", // required + * TagKeys: [ // TagKeys // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagResourceCommandInput - {@link UntagResourceCommandInput} + * @returns {@link UntagResourceCommandOutput} + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found. Check the ID or name and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class UntagResourceCommand extends $Command + .classBuilder< + UntagResourceCommandInput, + UntagResourceCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "UntagResource", {}) + .n("SSMQuickSetupClient", "UntagResourceCommand") + .f(void 0, void 0) + .ser(se_UntagResourceCommand) + .de(de_UntagResourceCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/UpdateConfigurationDefinitionCommand.ts b/clients/client-ssm-quicksetup/src/commands/UpdateConfigurationDefinitionCommand.ts new file mode 100644 index 0000000000000..8d4839d9f5582 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/UpdateConfigurationDefinitionCommand.ts @@ -0,0 +1,109 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateConfigurationDefinitionInput } from "../models/models_0"; +import { + de_UpdateConfigurationDefinitionCommand, + se_UpdateConfigurationDefinitionCommand, +} from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateConfigurationDefinitionCommand}. + */ +export interface UpdateConfigurationDefinitionCommandInput extends UpdateConfigurationDefinitionInput {} +/** + * @public + * + * The output of {@link UpdateConfigurationDefinitionCommand}. + */ +export interface UpdateConfigurationDefinitionCommandOutput extends __MetadataBearer {} + +/** + *Updates a Quick Setup configuration definition.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, UpdateConfigurationDefinitionCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, UpdateConfigurationDefinitionCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // UpdateConfigurationDefinitionInput + * ManagerArn: "STRING_VALUE", // required + * Id: "STRING_VALUE", // required + * TypeVersion: "STRING_VALUE", + * Parameters: { // ConfigurationParametersMap + * "The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found. Check the ID or name and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class UpdateConfigurationDefinitionCommand extends $Command + .classBuilder< + UpdateConfigurationDefinitionCommandInput, + UpdateConfigurationDefinitionCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "UpdateConfigurationDefinition", {}) + .n("SSMQuickSetupClient", "UpdateConfigurationDefinitionCommand") + .f(void 0, void 0) + .ser(se_UpdateConfigurationDefinitionCommand) + .de(de_UpdateConfigurationDefinitionCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/UpdateConfigurationManagerCommand.ts b/clients/client-ssm-quicksetup/src/commands/UpdateConfigurationManagerCommand.ts new file mode 100644 index 0000000000000..f7ebd25e09233 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/UpdateConfigurationManagerCommand.ts @@ -0,0 +1,101 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateConfigurationManagerInput } from "../models/models_0"; +import { de_UpdateConfigurationManagerCommand, se_UpdateConfigurationManagerCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateConfigurationManagerCommand}. + */ +export interface UpdateConfigurationManagerCommandInput extends UpdateConfigurationManagerInput {} +/** + * @public + * + * The output of {@link UpdateConfigurationManagerCommand}. + */ +export interface UpdateConfigurationManagerCommandOutput extends __MetadataBearer {} + +/** + *Updates a Quick Setup configuration manager.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, UpdateConfigurationManagerCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, UpdateConfigurationManagerCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // UpdateConfigurationManagerInput + * ManagerArn: "STRING_VALUE", // required + * Name: "STRING_VALUE", + * Description: "STRING_VALUE", + * }; + * const command = new UpdateConfigurationManagerCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateConfigurationManagerCommandInput - {@link UpdateConfigurationManagerCommandInput} + * @returns {@link UpdateConfigurationManagerCommandOutput} + * @see {@link UpdateConfigurationManagerCommandInput} for command's `input` shape. + * @see {@link UpdateConfigurationManagerCommandOutput} for command's `response` shape. + * @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource couldn't be found. Check the ID or name and try again.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class UpdateConfigurationManagerCommand extends $Command + .classBuilder< + UpdateConfigurationManagerCommandInput, + UpdateConfigurationManagerCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "UpdateConfigurationManager", {}) + .n("SSMQuickSetupClient", "UpdateConfigurationManagerCommand") + .f(void 0, void 0) + .ser(se_UpdateConfigurationManagerCommand) + .de(de_UpdateConfigurationManagerCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/UpdateServiceSettingsCommand.ts b/clients/client-ssm-quicksetup/src/commands/UpdateServiceSettingsCommand.ts new file mode 100644 index 0000000000000..b4c62758e77ad --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/UpdateServiceSettingsCommand.ts @@ -0,0 +1,96 @@ +// 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 { commonParams } from "../endpoint/EndpointParameters"; +import { UpdateServiceSettingsInput } from "../models/models_0"; +import { de_UpdateServiceSettingsCommand, se_UpdateServiceSettingsCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, SSMQuickSetupClientResolvedConfig } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateServiceSettingsCommand}. + */ +export interface UpdateServiceSettingsCommandInput extends UpdateServiceSettingsInput {} +/** + * @public + * + * The output of {@link UpdateServiceSettingsCommand}. + */ +export interface UpdateServiceSettingsCommandOutput extends __MetadataBearer {} + +/** + *Updates settings configured for Quick Setup.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { SSMQuickSetupClient, UpdateServiceSettingsCommand } from "@aws-sdk/client-ssm-quicksetup"; // ES Modules import + * // const { SSMQuickSetupClient, UpdateServiceSettingsCommand } = require("@aws-sdk/client-ssm-quicksetup"); // CommonJS import + * const client = new SSMQuickSetupClient(config); + * const input = { // UpdateServiceSettingsInput + * ExplorerEnablingRoleArn: "STRING_VALUE", + * }; + * const command = new UpdateServiceSettingsCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UpdateServiceSettingsCommandInput - {@link UpdateServiceSettingsCommandInput} + * @returns {@link UpdateServiceSettingsCommandOutput} + * @see {@link UpdateServiceSettingsCommandInput} for command's `input` shape. + * @see {@link UpdateServiceSettingsCommandOutput} for command's `response` shape. + * @see {@link SSMQuickSetupClientResolvedConfig | config} for SSMQuickSetupClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The requester has insufficient permissions to perform the operation.
+ * + * @throws {@link ConflictException} (client fault) + *Another request is being processed. Wait a few minutes and try again.
+ * + * @throws {@link InternalServerException} (server fault) + *An error occurred on the server side.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * + * @throws {@link ValidationException} (client fault) + *The request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * + * @throws {@link SSMQuickSetupServiceException} + *Base exception class for all service exceptions from SSMQuickSetup service.
+ * + * @public + */ +export class UpdateServiceSettingsCommand extends $Command + .classBuilder< + UpdateServiceSettingsCommandInput, + UpdateServiceSettingsCommandOutput, + SSMQuickSetupClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep({ + ...commonParams, + }) + .m(function (this: any, Command: any, cs: any, config: SSMQuickSetupClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("QuickSetup", "UpdateServiceSettings", {}) + .n("SSMQuickSetupClient", "UpdateServiceSettingsCommand") + .f(void 0, void 0) + .ser(se_UpdateServiceSettingsCommand) + .de(de_UpdateServiceSettingsCommand) + .build() {} diff --git a/clients/client-ssm-quicksetup/src/commands/index.ts b/clients/client-ssm-quicksetup/src/commands/index.ts new file mode 100644 index 0000000000000..cf90679c921b5 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/commands/index.ts @@ -0,0 +1,13 @@ +// smithy-typescript generated code +export * from "./CreateConfigurationManagerCommand"; +export * from "./DeleteConfigurationManagerCommand"; +export * from "./GetConfigurationManagerCommand"; +export * from "./GetServiceSettingsCommand"; +export * from "./ListConfigurationManagersCommand"; +export * from "./ListQuickSetupTypesCommand"; +export * from "./ListTagsForResourceCommand"; +export * from "./TagResourceCommand"; +export * from "./UntagResourceCommand"; +export * from "./UpdateConfigurationDefinitionCommand"; +export * from "./UpdateConfigurationManagerCommand"; +export * from "./UpdateServiceSettingsCommand"; diff --git a/clients/client-ssm-quicksetup/src/endpoint/EndpointParameters.ts b/clients/client-ssm-quicksetup/src/endpoint/EndpointParameters.ts new file mode 100644 index 0000000000000..6044fbeb46c31 --- /dev/null +++ b/clients/client-ssm-quicksetup/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 | ProviderQuick Setup helps you quickly configure frequently used services and features with + * recommended best practices. Quick Setup simplifies setting up services, including + * Systems Manager, by automating common or recommended tasks.
+ * + * @packageDocumentation + */ +export * from "./SSMQuickSetupClient"; +export * from "./SSMQuickSetup"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export type { RuntimeExtension } from "./runtimeExtensions"; +export type { SSMQuickSetupExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +export { SSMQuickSetupServiceException } from "./models/SSMQuickSetupServiceException"; diff --git a/clients/client-ssm-quicksetup/src/models/SSMQuickSetupServiceException.ts b/clients/client-ssm-quicksetup/src/models/SSMQuickSetupServiceException.ts new file mode 100644 index 0000000000000..5fdf5fb292047 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/models/SSMQuickSetupServiceException.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export type { __ServiceExceptionOptions }; + +export { __ServiceException }; + +/** + * @public + * + * Base exception class for all service exceptions from SSMQuickSetup service. + */ +export class SSMQuickSetupServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, SSMQuickSetupServiceException.prototype); + } +} diff --git a/clients/client-ssm-quicksetup/src/models/index.ts b/clients/client-ssm-quicksetup/src/models/index.ts new file mode 100644 index 0000000000000..9eaceb12865f8 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-ssm-quicksetup/src/models/models_0.ts b/clients/client-ssm-quicksetup/src/models/models_0.ts new file mode 100644 index 0000000000000..07ffaab802322 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/models/models_0.ts @@ -0,0 +1,2163 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from "@smithy/smithy-client"; + +import { SSMQuickSetupServiceException as __BaseException } from "./SSMQuickSetupServiceException"; + +/** + *The requester has insufficient permissions to perform the operation.
+ * @public + */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe definition of a Quick Setup configuration.
+ * @public + */ +export interface ConfigurationDefinition { + /** + *The type of the Quick Setup configuration.
+ * @public + */ + Type: string | undefined; + + /** + *A list of key-value pairs containing the required parameters for the configuration + * type.
+ * @public + */ + Parameters: RecordThe version of the Quick Setup type used.
+ * @public + */ + TypeVersion?: string; + + /** + *The name of the IAM role used to deploy local + * configurations.
+ * @public + */ + LocalDeploymentExecutionRoleName?: string; + + /** + *The ARN of the IAM role used to administrate local configuration + * deployments.
+ * @public + */ + LocalDeploymentAdministrationRoleArn?: string; + + /** + *The ID of the configuration definition.
+ * @public + */ + Id?: string; +} + +/** + *Defines the preferences and options for a configuration definition.
+ * @public + */ +export interface ConfigurationDefinitionInput { + /** + *The type of the Quick Setup configuration.
+ * @public + */ + Type: string | undefined; + + /** + *The parameters for the configuration definition type. Parameters for configuration + * definitions vary based the configuration type. The following tables outline the + * parameters for each configuration type.
+ *
+ * DelegatedAccountId
+ *
Description: (Required) The ID of the + * delegated administrator account.
+ *
+ * TargetOrganizationalUnits
+ *
Description: (Required) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * TargetTagKey
+ *
Description: (Required) The tag key assigned + * to the instances you want to target.
+ *
+ * TargetTagValue
+ *
Description: (Required) The value of the tag + * key assigned to the instances you want to + * target.
+ *
+ * ICalendarString
+ *
Description: (Required) An iCalendar + * formatted string containing the schedule you want + * Change Manager to use.
+ *
+ * TargetAccounts
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account initiating the
+ * configuration deployment. You only need to provide
+ * a value for this parameter if you want to deploy
+ * the configuration locally. A value must be
+ * provided for either TargetAccounts or
+ * TargetOrganizationalUnits.
+ * TargetOrganizationalUnits
+ *
Description: (Optional) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * UpdateSSMAgent
+ *
Description: (Optional) A boolean value that
+ * determines whether the SSM Agent is updated on the
+ * target instances every 2 weeks. The default value
+ * is "true".
+ * TargetOrganizationalUnits
+ *
Description: (Required) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * SelectedAggregatorRegion
+ *
Description: (Required) The Amazon Web Services Region where you want to create the + * aggregator index.
+ *
+ * ReplaceExistingAggregator
+ *
Description: (Required) A boolean value that
+ * determines whether to demote an existing
+ * aggregator if it is in a Region that differs from
+ * the value you specify for the
+ * SelectedAggregatorRegion.
+ * TargetOrganizationalUnits
+ *
Description: (Required) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * DelegatedAccountId
+ *
Description: (Required) The ID of the + * delegated administrator account.
+ *
+ * JobFunction
+ *
Description: (Required) The name for the + * Change Manager job function.
+ *
+ * PermissionType
+ *
Description: (Optional) Specifies whether
+ * you want to use default administrator permissions
+ * for the job function role, or provide a custom
+ * IAM policy. The valid values are
+ * CustomPermissions and
+ * AdminPermissions. The default value
+ * for the parameter is
+ * CustomerPermissions.
+ * CustomPermissions
+ *
Description: (Optional) A JSON string
+ * containing the IAM policy you want
+ * your job function to use. You must provide a value
+ * for this parameter if you specify
+ * CustomPermissions for the
+ * PermissionType parameter.
+ * TargetOrganizationalUnits
+ *
Description: (Required) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * AnalyseAllResources
+ *
Description: (Optional) A boolean value that
+ * determines whether DevOps Guru analyzes all
+ * CloudFormation stacks in the account. The
+ * default value is "false".
+ * EnableSnsNotifications
+ *
Description: (Optional) A boolean value that
+ * determines whether DevOps Guru sends
+ * notifications when an insight is created. The
+ * default value is "true".
+ * EnableSsmOpsItems
+ *
Description: (Optional) A boolean value that
+ * determines whether DevOps Guru creates an
+ * OpsCenter OpsItem when an insight is created. The
+ * default value is "true".
+ * EnableDriftRemediation
+ *
Description: (Optional) A boolean value that
+ * determines whether a drift remediation schedule is
+ * used. The default value is
+ * "false".
+ * RemediationSchedule
+ *
Description: (Optional) A rate expression
+ * that defines the schedule for drift remediation.
+ * The valid values are rate(30 days),
+ * rate(14 days), rate(1
+ * days), and none. The default
+ * value is "none".
+ * TargetAccounts
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account initiating the
+ * configuration deployment. You only need to provide
+ * a value for this parameter if you want to deploy
+ * the configuration locally. A value must be
+ * provided for either TargetAccounts or
+ * TargetOrganizationalUnits.
+ * TargetOrganizationalUnits
+ *
Description: (Optional) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * DelegatedAccountId
+ *
Description: (Optional) The ID of the + * delegated administrator account. This parameter is + * required for Organization deployments.
+ *
+ * RemediationSchedule
+ *
Description: (Optional) A rate expression
+ * that defines the schedule for drift remediation.
+ * The valid values are rate(30 days),
+ * rate(14 days), rate(2
+ * days), and none. The default
+ * value is "none".
+ * CPackNames
+ *
Description: (Required) A comma separated + * list of Config conformance + * packs.
+ *
+ * TargetAccounts
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account initiating the
+ * configuration deployment. You only need to provide
+ * a value for this parameter if you want to deploy
+ * the configuration locally. A value must be
+ * provided for either TargetAccounts or
+ * TargetOrganizationalUnits.
+ * TargetOrganizationalUnits
+ *
Description: (Optional) The ID of the root + * of your Organization. This configuration type + * doesn't currently support choosing specific OUs. + * The configuration will be deployed to all the OUs + * in the Organization.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * RecordAllResources
+ *
Description: (Optional) A boolean value that
+ * determines whether all supported resources are
+ * recorded. The default value is
+ * "true".
+ * ResourceTypesToRecord
+ *
Description: (Optional) A comma separated + * list of resource types you want to record.
+ *
+ * RecordGlobalResourceTypes
+ *
Description: (Optional) A boolean value that
+ * determines whether global resources are recorded
+ * with all resource configurations. The default
+ * value is "false".
+ * GlobalResourceTypesRegion
+ *
Description: (Optional) Determines the + * Amazon Web Services Region where global resources + * are recorded.
+ *
+ * UseCustomBucket
+ *
Description: (Optional) A boolean value that
+ * determines whether a custom Amazon S3
+ * bucket is used for delivery. The default value is
+ * "false".
+ * DeliveryBucketName
+ *
Description: (Optional) The name of the + * Amazon S3 bucket you want Config to deliver configuration snapshots and + * configuration history files to.
+ *
+ * DeliveryBucketPrefix
+ *
Description: (Optional) The key prefix you + * want to use in the custom Amazon S3 + * bucket.
+ *
+ * NotificationOptions
+ *
Description: (Optional) Determines the
+ * notification configuration for the recorder. The
+ * valid values are NoStreaming,
+ * UseExistingTopic, and
+ * CreateTopic. The default value is
+ * NoStreaming.
+ * CustomDeliveryTopicAccountId
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account where the Amazon SNS topic you want to use for notifications
+ * resides. You must specify a value for this
+ * parameter if you use the
+ * UseExistingTopic notification
+ * option.
+ * CustomDeliveryTopicName
+ *
Description: (Optional) The name of the
+ * Amazon SNS topic you want to use for
+ * notifications. You must specify a value for this
+ * parameter if you use the
+ * UseExistingTopic notification
+ * option.
+ * RemediationSchedule
+ *
Description: (Optional) A rate expression
+ * that defines the schedule for drift remediation.
+ * The valid values are rate(30 days),
+ * rate(7 days), rate(1
+ * days), and none. The default
+ * value is "none".
+ * TargetAccounts
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account initiating the
+ * configuration deployment. You only need to provide
+ * a value for this parameter if you want to deploy
+ * the configuration locally. A value must be
+ * provided for either TargetAccounts or
+ * TargetOrganizationalUnits.
+ * TargetOrganizationalUnits
+ *
Description: (Optional) The ID of the root + * of your Organization. This configuration type + * doesn't currently support choosing specific OUs. + * The configuration will be deployed to all the OUs + * in the Organization.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * UpdateSSMAgent
+ *
Description: (Optional) A boolean value that
+ * determines whether the SSM Agent is updated on the
+ * target instances every 2 weeks. The default value
+ * is "true".
+ * UpdateEc2LaunchAgent
+ *
Description: (Optional) A boolean value that
+ * determines whether the EC2 Launch agent is updated
+ * on the target instances every month. The default
+ * value is "false".
+ * CollectInventory
+ *
Description: (Optional) A boolean value that
+ * determines whether the EC2 Launch agent is updated
+ * on the target instances every month. The default
+ * value is "true".
+ * ScanInstances
+ *
Description: (Optional) A boolean value that
+ * determines whether the target instances are
+ * scanned daily for available patches. The default
+ * value is "true".
+ * InstallCloudWatchAgent
+ *
Description: (Optional) A boolean value that
+ * determines whether the Amazon CloudWatch agent
+ * is installed on the target instances. The default
+ * value is "false".
+ * UpdateCloudWatchAgent
+ *
Description: (Optional) A boolean value that
+ * determines whether the Amazon CloudWatch agent
+ * is updated on the target instances every month.
+ * The default value is "false".
+ * IsPolicyAttachAllowed
+ *
Description: (Optional) A boolean value that
+ * determines whether Quick Setup attaches policies
+ * to instances profiles already associated with the
+ * target instances. The default value is
+ * "false".
+ * TargetType
+ *
Description: (Optional) Determines how
+ * instances are targeted for local account
+ * deployments. Don't specify a value for this
+ * parameter if you're deploying to OUs. The valid
+ * values are *,
+ * InstanceIds,
+ * ResourceGroups, and
+ * Tags. Use * to target
+ * all instances in the account.
+ * TargetInstances
+ *
Description: (Optional) A comma separated
+ * list of instance IDs. You must provide a value for
+ * this parameter if you specify
+ * InstanceIds for the
+ * TargetType parameter.
+ * TargetTagKey
+ *
Description: (Optional) The tag key assigned
+ * to the instances you want to target. You must
+ * provide a value for this parameter if you specify
+ * Tags for the TargetType
+ * parameter.
+ * TargetTagValue
+ *
Description: (Optional) The value of the tag
+ * key assigned to the instances you want to target.
+ * You must provide a value for this parameter if you
+ * specify Tags for the
+ * TargetType parameter.
+ * ResourceGroupName
+ *
Description: (Optional) The name of the
+ * resource group associated with the instances you
+ * want to target. You must provide a value for this
+ * parameter if you specify
+ * ResourceGroups for the
+ * TargetType parameter.
+ * TargetAccounts
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account initiating the
+ * configuration deployment. You only need to provide
+ * a value for this parameter if you want to deploy
+ * the configuration locally. A value must be
+ * provided for either TargetAccounts or
+ * TargetOrganizationalUnits.
+ * TargetOrganizationalUnits
+ *
Description: (Optional) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * PackagesToInstall
+ *
Description: (Required) A comma separated
+ * list of packages you want to install on the target
+ * instances. The valid values are
+ * AWSEFSTools, AWSCWAgent,
+ * and AWSEC2LaunchAgent.
+ * RemediationSchedule
+ *
Description: (Optional) A rate expression
+ * that defines the schedule for drift remediation.
+ * The valid values are rate(30 days),
+ * rate(14 days), rate(2
+ * days), and none. The default
+ * value is "rate(30 days)".
+ * IsPolicyAttachAllowed
+ *
Description: (Optional) A boolean value that
+ * determines whether Quick Setup attaches policies
+ * to instances profiles already associated with the
+ * target instances. The default value is
+ * "false".
+ * TargetType
+ *
Description: (Optional) Determines how
+ * instances are targeted for local account
+ * deployments. Don't specify a value for this
+ * parameter if you're deploying to OUs. The valid
+ * values are *,
+ * InstanceIds,
+ * ResourceGroups, and
+ * Tags. Use * to target
+ * all instances in the account.
+ * TargetInstances
+ *
Description: (Optional) A comma separated
+ * list of instance IDs. You must provide a value for
+ * this parameter if you specify
+ * InstanceIds for the
+ * TargetType parameter.
+ * TargetTagKey
+ *
Description: (Required) The tag key assigned
+ * to the instances you want to target. You must
+ * provide a value for this parameter if you specify
+ * Tags for the TargetType
+ * parameter.
+ * TargetTagValue
+ *
Description: (Required) The value of the tag
+ * key assigned to the instances you want to target.
+ * You must provide a value for this parameter if you
+ * specify Tags for the
+ * TargetType parameter.
+ * ResourceGroupName
+ *
Description: (Required) The name of the
+ * resource group associated with the instances you
+ * want to target. You must provide a value for this
+ * parameter if you specify
+ * ResourceGroups for the
+ * TargetType parameter.
+ * TargetAccounts
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account initiating the
+ * configuration deployment. You only need to provide
+ * a value for this parameter if you want to deploy
+ * the configuration locally. A value must be
+ * provided for either TargetAccounts or
+ * TargetOrganizationalUnits.
+ * TargetOrganizationalUnits
+ *
Description: (Optional) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *
+ * PatchPolicyName
+ *
Description: (Required) A name for the patch + * policy. The value you provide is applied to target + * Amazon EC2 instances as a tag.
+ *
+ * SelectedPatchBaselines
+ *
Description: (Required) An array of JSON + * objects containing the information for the patch + * baselines to include in your patch policy.
+ *
+ * PatchBaselineUseDefault
+ *
Description: (Optional) A boolean value that + * determines whether the selected patch baselines + * are all Amazon Web Services provided.
+ *
+ * ConfigurationOptionsPatchOperation
+ *
Description: (Optional) Determines whether
+ * target instances scan for available patches, or
+ * scan and install available patches. The valid
+ * values are Scan and
+ * ScanAndInstall. The default value for
+ * the parameter is Scan.
+ * ConfigurationOptionsScanValue
+ *
Description: (Optional) A cron expression + * that is used as the schedule for when instances + * scan for available patches.
+ *
+ * ConfigurationOptionsInstallValue
+ *
Description: (Optional) A cron expression + * that is used as the schedule for when instances + * install available patches.
+ *
+ * ConfigurationOptionsScanNextInterval
+ *
Description: (Optional) A boolean value that
+ * determines whether instances should scan for
+ * available patches at the next cron interval. The
+ * default value is "false".
+ * ConfigurationOptionsInstallNextInterval
+ *
Description: (Optional) A boolean value that
+ * determines whether instances should scan for
+ * available patches at the next cron interval. The
+ * default value is "false".
+ * RebootOption
+ *
Description: (Optional) A boolean value that
+ * determines whether instances are rebooted after
+ * patches are installed. The default value is
+ * "false".
+ * IsPolicyAttachAllowed
+ *
Description: (Optional) A boolean value that
+ * determines whether Quick Setup attaches policies
+ * to instances profiles already associated with the
+ * target instances. The default value is
+ * "false".
+ * OutputLogEnableS3
+ *
Description: (Optional) A boolean value that + * determines whether command output logs are sent to + * Amazon S3.
+ *
+ * OutputS3Location
+ *
Description: (Optional) A JSON string + * containing information about the Amazon S3 + * bucket where you want to store the output details + * of the request.
+ *
+ * OutputS3BucketRegion
+ *
Description: (Optional) The Amazon Web Services Region where the Amazon S3 + * bucket you want Config to deliver + * command output to is located.
+ *
+ * OutputS3BucketName
+ *
Description: (Optional) The name of the + * Amazon S3 bucket you want Config to deliver command output to.
+ *
+ * OutputS3KeyPrefix
+ *
Description: (Optional) The key prefix you + * want to use in the custom Amazon S3 + * bucket.
+ *
+ * TargetType
+ *
Description: (Optional) Determines how
+ * instances are targeted for local account
+ * deployments. Don't specify a value for this
+ * parameter if you're deploying to OUs. The valid
+ * values are *,
+ * InstanceIds,
+ * ResourceGroups, and
+ * Tags. Use * to target
+ * all instances in the account.
+ * TargetInstances
+ *
Description: (Optional) A comma separated
+ * list of instance IDs. You must provide a value for
+ * this parameter if you specify
+ * InstanceIds for the
+ * TargetType parameter.
+ * TargetTagKey
+ *
Description: (Required) The tag key assigned
+ * to the instances you want to target. You must
+ * provide a value for this parameter if you specify
+ * Tags for the TargetType
+ * parameter.
+ * TargetTagValue
+ *
Description: (Required) The value of the tag
+ * key assigned to the instances you want to target.
+ * You must provide a value for this parameter if you
+ * specify Tags for the
+ * TargetType parameter.
+ * ResourceGroupName
+ *
Description: (Required) The name of the
+ * resource group associated with the instances you
+ * want to target. You must provide a value for this
+ * parameter if you specify
+ * ResourceGroups for the
+ * TargetType parameter.
+ * TargetAccounts
+ *
Description: (Optional) The ID of the
+ * Amazon Web Services account initiating the
+ * configuration deployment. You only need to provide
+ * a value for this parameter if you want to deploy
+ * the configuration locally. A value must be
+ * provided for either TargetAccounts or
+ * TargetOrganizationalUnits.
+ * TargetOrganizationalUnits
+ *
Description: (Optional) A comma separated + * list of organizational units (OUs) you want to + * deploy the configuration to.
+ *
+ * TargetRegions
+ *
Description: (Required) A comma separated + * list of Amazon Web Services Regions you want to + * deploy the configuration to.
+ *The version of the Quick Setup type to use.
+ * @public + */ + TypeVersion?: string; + + /** + *The name of the IAM role used to deploy local + * configurations.
+ * @public + */ + LocalDeploymentExecutionRoleName?: string; + + /** + *The ARN of the IAM role used to administrate local configuration + * deployments.
+ * @public + */ + LocalDeploymentAdministrationRoleArn?: string; +} + +/** + *A summarized definition of a Quick Setup configuration definition.
+ * @public + */ +export interface ConfigurationDefinitionSummary { + /** + *The ID of the configuration definition.
+ * @public + */ + Id?: string; + + /** + *The type of the Quick Setup configuration used by the configuration + * definition.
+ * @public + */ + Type?: string; + + /** + *The version of the Quick Setup type used by the configuration definition.
+ * @public + */ + TypeVersion?: string; + + /** + *The common parameters and values for the configuration definition.
+ * @public + */ + FirstClassParameters?: RecordA summarized description of the status.
+ * @public + */ +export interface StatusSummary { + /** + *The type of a status summary.
+ * @public + */ + StatusType: StatusType | undefined; + + /** + *The current status.
+ * @public + */ + Status?: Status; + + /** + *When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
+ * @public + */ + StatusMessage?: string; + + /** + *The datetime stamp when the status was last updated.
+ * @public + */ + LastUpdatedAt: Date | undefined; + + /** + *Details about the status.
+ * @public + */ + StatusDetails?: RecordA summary of a Quick Setup configuration manager.
+ * @public + */ +export interface ConfigurationManagerSummary { + /** + *The ARN of the Quick Setup configuration.
+ * @public + */ + ManagerArn: string | undefined; + + /** + *The description of the configuration.
+ * @public + */ + Description?: string; + + /** + *The name of the configuration
+ * @public + */ + Name?: string; + + /** + *Summaries of the state of the configuration manager. These summaries include an + * aggregate of the statuses from the configuration definition associated with the + * configuration manager. This includes deployment statuses, association statuses, + * drift statuses, health checks, and more.
+ * @public + */ + StatusSummaries?: StatusSummary[]; + + /** + *A summary of the Quick Setup configuration definition.
+ * @public + */ + ConfigurationDefinitionSummaries?: ConfigurationDefinitionSummary[]; +} + +/** + *Another request is being processed. Wait a few minutes and try again.
+ * @public + */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA name for the configuration manager.
+ * @public + */ + Name?: string; + + /** + *A description of the configuration manager.
+ * @public + */ + Description?: string; + + /** + *The definition of the Quick Setup configuration that the configuration manager + * deploys.
+ * @public + */ + ConfigurationDefinitions: ConfigurationDefinitionInput[] | undefined; + + /** + *Key-value pairs of metadata to assign to the configuration manager.
+ * @public + */ + Tags?: RecordThe ARN for the newly created configuration manager.
+ * @public + */ + ManagerArn: string | undefined; +} + +/** + *An error occurred on the server side.
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = {}; + Message: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request is invalid. Verify the values provided for the request parameters are + * accurate.
+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe ID of the configuration manager.
+ * @public + */ + ManagerArn: string | undefined; +} + +/** + *The resource couldn't be found. Check the ID or name and try again.
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + Message?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA key-value pair to filter results.
+ * @public + */ +export interface Filter { + /** + *The key for the filter.
+ * @public + */ + Key: string | undefined; + + /** + *The values for the filter keys.
+ * @public + */ + Values: string[] | undefined; +} + +/** + * @public + */ +export interface GetConfigurationManagerInput { + /** + *The ARN of the configuration manager.
+ * @public + */ + ManagerArn: string | undefined; +} + +/** + * @public + */ +export interface GetConfigurationManagerOutput { + /** + *The ARN of the configuration manager.
+ * @public + */ + ManagerArn: string | undefined; + + /** + *The description of the configuration manager.
+ * @public + */ + Description?: string; + + /** + *The name of the configuration manager.
+ * @public + */ + Name?: string; + + /** + *The datetime stamp when the configuration manager was created.
+ * @public + */ + CreatedAt?: Date; + + /** + *The datetime stamp when the configuration manager was last updated.
+ * @public + */ + LastModifiedAt?: Date; + + /** + *A summary of the state of the configuration manager. This includes deployment + * statuses, association statuses, drift statuses, health checks, and more.
+ * @public + */ + StatusSummaries?: StatusSummary[]; + + /** + *The configuration definitions association with the configuration manager.
+ * @public + */ + ConfigurationDefinitions?: ConfigurationDefinition[]; + + /** + *Key-value pairs of metadata to assign to the configuration manager.
+ * @public + */ + Tags?: RecordSettings configured for Quick Setup.
+ * @public + */ +export interface ServiceSettings { + /** + *The IAM role used to enable Explorer.
+ * @public + */ + ExplorerEnablingRoleArn?: string; +} + +/** + * @public + */ +export interface GetServiceSettingsOutput { + /** + *Returns details about the settings for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
+ * @public + */ + ServiceSettings?: ServiceSettings; +} + +/** + * @public + */ +export interface ListConfigurationManagersInput { + /** + *The token to use when requesting a specific set of items from a list.
+ * @public + */ + StartingToken?: string; + + /** + *Specifies the maximum number of configuration managers that are returned by the + * request.
+ * @public + */ + MaxItems?: number; + + /** + *Filters the results returned by the request.
+ * @public + */ + Filters?: Filter[]; +} + +/** + * @public + */ +export interface ListConfigurationManagersOutput { + /** + *The configuration managers returned by the request.
+ * @public + */ + ConfigurationManagersList?: ConfigurationManagerSummary[]; + + /** + *The token to use when requesting the next set of configuration managers. If there + * are no additional operations to return, the string is empty.
+ * @public + */ + NextToken?: string; +} + +/** + *Information about the Quick Setup type.
+ * @public + */ +export interface QuickSetupTypeOutput { + /** + *The type of the Quick Setup configuration.
+ * @public + */ + Type?: string; + + /** + *The latest version number of the configuration.
+ * @public + */ + LatestVersion?: string; +} + +/** + * @public + */ +export interface ListQuickSetupTypesOutput { + /** + *An array of Quick Setup types.
+ * @public + */ + QuickSetupTypeList?: QuickSetupTypeOutput[]; +} + +/** + * @public + */ +export interface ListTagsForResourceRequest { + /** + *The ARN of the resource the tag is assigned to.
+ * @public + */ + ResourceArn: string | undefined; +} + +/** + *Key-value pairs of metadata.
+ * @public + */ +export interface TagEntry { + /** + *The key for the tag.
+ * @public + */ + Key?: string; + + /** + *The value for the tag.
+ * @public + */ + Value?: string; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + *Key-value pairs of metadata assigned to the resource.
+ * @public + */ + Tags?: TagEntry[]; +} + +/** + * @public + */ +export interface TagResourceInput { + /** + *The ARN of the resource to tag.
+ * @public + */ + ResourceArn: string | undefined; + + /** + *Key-value pairs of metadata to assign to the resource.
+ * @public + */ + Tags: RecordThe ARN of the resource to remove tags from.
+ * @public + */ + ResourceArn: string | undefined; + + /** + *The keys of the tags to remove from the resource.
+ * @public + */ + TagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UpdateConfigurationDefinitionInput { + /** + *The ARN of the configuration manager associated with the definition to + * update.
+ * @public + */ + ManagerArn: string | undefined; + + /** + *The ID of the configuration definition you want to update.
+ * @public + */ + Id: string | undefined; + + /** + *The version of the Quick Setup type to use.
+ * @public + */ + TypeVersion?: string; + + /** + *The parameters for the configuration definition type.
+ * @public + */ + Parameters?: RecordThe name of the IAM role used to deploy local + * configurations.
+ * @public + */ + LocalDeploymentExecutionRoleName?: string; + + /** + *The ARN of the IAM role used to administrate local configuration + * deployments.
+ * @public + */ + LocalDeploymentAdministrationRoleArn?: string; +} + +/** + * @public + */ +export interface UpdateConfigurationManagerInput { + /** + *The ARN of the configuration manager.
+ * @public + */ + ManagerArn: string | undefined; + + /** + *A name for the configuration manager.
+ * @public + */ + Name?: string; + + /** + *A description of the configuration manager.
+ * @public + */ + Description?: string; +} + +/** + * @public + */ +export interface UpdateServiceSettingsInput { + /** + *The IAM role used to enable Explorer.
+ * @public + */ + ExplorerEnablingRoleArn?: string; +} + +/** + * @internal + */ +export const CreateConfigurationManagerInputFilterSensitiveLog = (obj: CreateConfigurationManagerInput): any => ({ + ...obj, + ...(obj.Tags && { Tags: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetConfigurationManagerOutputFilterSensitiveLog = (obj: GetConfigurationManagerOutput): any => ({ + ...obj, + ...(obj.Tags && { Tags: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const TagEntryFilterSensitiveLog = (obj: TagEntry): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListTagsForResourceResponseFilterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ + ...obj, + ...(obj.Tags && { Tags: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const TagResourceInputFilterSensitiveLog = (obj: TagResourceInput): any => ({ + ...obj, + ...(obj.Tags && { Tags: SENSITIVE_STRING }), +}); diff --git a/clients/client-ssm-quicksetup/src/pagination/Interfaces.ts b/clients/client-ssm-quicksetup/src/pagination/Interfaces.ts new file mode 100644 index 0000000000000..a4e079a0f4127 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { SSMQuickSetupClient } from "../SSMQuickSetupClient"; + +/** + * @public + */ +export interface SSMQuickSetupPaginationConfiguration extends PaginationConfiguration { + client: SSMQuickSetupClient; +} diff --git a/clients/client-ssm-quicksetup/src/pagination/ListConfigurationManagersPaginator.ts b/clients/client-ssm-quicksetup/src/pagination/ListConfigurationManagersPaginator.ts new file mode 100644 index 0000000000000..2ddba87dc79f8 --- /dev/null +++ b/clients/client-ssm-quicksetup/src/pagination/ListConfigurationManagersPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListConfigurationManagersCommand, + ListConfigurationManagersCommandInput, + ListConfigurationManagersCommandOutput, +} from "../commands/ListConfigurationManagersCommand"; +import { SSMQuickSetupClient } from "../SSMQuickSetupClient"; +import { SSMQuickSetupPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListConfigurationManagers: ( + config: SSMQuickSetupPaginationConfiguration, + input: ListConfigurationManagersCommandInput, + ...rest: any[] +) => PaginatorThe requester has insufficient permissions to perform the operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinition": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration.
", + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "A list of key-value pairs containing the required parameters for the configuration\n type.
", + "smithy.api#required": {} + } + }, + "TypeVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the Quick Setup type used.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "LocalDeploymentExecutionRoleName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the IAM role used to deploy local\n configurations.
", + "smithy.api#pattern": "^[\\w+=,.@-]{1,64}$" + } + }, + "LocalDeploymentAdministrationRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role used to administrate local configuration\n deployments.
" + } + }, + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a Quick Setup configuration.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionInput": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration.
", + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.:/]{3,200}$", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "The parameters for the configuration definition type. Parameters for configuration\n definitions vary based the configuration type. The following tables outline the\n parameters for each configuration type.
\n\n DelegatedAccountId\n
Description: (Required) The ID of the\n delegated administrator account.
\n\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n TargetTagKey\n
Description: (Required) The tag key assigned\n to the instances you want to target.
\n\n TargetTagValue\n
Description: (Required) The value of the tag\n key assigned to the instances you want to\n target.
\n\n ICalendarString\n
Description: (Required) An iCalendar\n formatted string containing the schedule you want\n Change Manager to use.
\n\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n UpdateSSMAgent\n
Description: (Optional) A boolean value that\n determines whether the SSM Agent is updated on the\n target instances every 2 weeks. The default value\n is \"true\".
\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n SelectedAggregatorRegion\n
Description: (Required) The Amazon Web Services Region where you want to create the\n aggregator index.
\n\n ReplaceExistingAggregator\n
Description: (Required) A boolean value that\n determines whether to demote an existing\n aggregator if it is in a Region that differs from\n the value you specify for the\n SelectedAggregatorRegion.
\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n DelegatedAccountId\n
Description: (Required) The ID of the\n delegated administrator account.
\n\n JobFunction\n
Description: (Required) The name for the\n Change Manager job function.
\n\n PermissionType\n
Description: (Optional) Specifies whether\n you want to use default administrator permissions\n for the job function role, or provide a custom\n IAM policy. The valid values are\n CustomPermissions and\n AdminPermissions. The default value\n for the parameter is\n CustomerPermissions.
\n CustomPermissions\n
Description: (Optional) A JSON string\n containing the IAM policy you want\n your job function to use. You must provide a value\n for this parameter if you specify\n CustomPermissions for the\n PermissionType parameter.
\n TargetOrganizationalUnits\n
Description: (Required) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n AnalyseAllResources\n
Description: (Optional) A boolean value that\n determines whether DevOps Guru analyzes all\n CloudFormation stacks in the account. The\n default value is \"false\".
\n EnableSnsNotifications\n
Description: (Optional) A boolean value that\n determines whether DevOps Guru sends\n notifications when an insight is created. The\n default value is \"true\".
\n EnableSsmOpsItems\n
Description: (Optional) A boolean value that\n determines whether DevOps Guru creates an\n OpsCenter OpsItem when an insight is created. The\n default value is \"true\".
\n EnableDriftRemediation\n
Description: (Optional) A boolean value that\n determines whether a drift remediation schedule is\n used. The default value is\n \"false\".
\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(14 days), rate(1\n days), and none. The default\n value is \"none\".
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n DelegatedAccountId\n
Description: (Optional) The ID of the\n delegated administrator account. This parameter is\n required for Organization deployments.
\n\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(14 days), rate(2\n days), and none. The default\n value is \"none\".
\n CPackNames\n
Description: (Required) A comma separated\n list of Config conformance\n packs.
\n\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) The ID of the root\n of your Organization. This configuration type\n doesn't currently support choosing specific OUs.\n The configuration will be deployed to all the OUs\n in the Organization.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n RecordAllResources\n
Description: (Optional) A boolean value that\n determines whether all supported resources are\n recorded. The default value is\n \"true\".
\n ResourceTypesToRecord\n
Description: (Optional) A comma separated\n list of resource types you want to record.
\n\n RecordGlobalResourceTypes\n
Description: (Optional) A boolean value that\n determines whether global resources are recorded\n with all resource configurations. The default\n value is \"false\".
\n GlobalResourceTypesRegion\n
Description: (Optional) Determines the\n Amazon Web Services Region where global resources\n are recorded.
\n\n UseCustomBucket\n
Description: (Optional) A boolean value that\n determines whether a custom Amazon S3\n bucket is used for delivery. The default value is\n \"false\".
\n DeliveryBucketName\n
Description: (Optional) The name of the\n Amazon S3 bucket you want Config to deliver configuration snapshots and\n configuration history files to.
\n\n DeliveryBucketPrefix\n
Description: (Optional) The key prefix you\n want to use in the custom Amazon S3\n bucket.
\n\n NotificationOptions\n
Description: (Optional) Determines the\n notification configuration for the recorder. The\n valid values are NoStreaming,\n UseExistingTopic, and\n CreateTopic. The default value is\n NoStreaming.
\n CustomDeliveryTopicAccountId\n
Description: (Optional) The ID of the\n Amazon Web Services account where the Amazon SNS topic you want to use for notifications\n resides. You must specify a value for this\n parameter if you use the\n UseExistingTopic notification\n option.
\n CustomDeliveryTopicName\n
Description: (Optional) The name of the\n Amazon SNS topic you want to use for\n notifications. You must specify a value for this\n parameter if you use the\n UseExistingTopic notification\n option.
\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(7 days), rate(1\n days), and none. The default\n value is \"none\".
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) The ID of the root\n of your Organization. This configuration type\n doesn't currently support choosing specific OUs.\n The configuration will be deployed to all the OUs\n in the Organization.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n UpdateSSMAgent\n
Description: (Optional) A boolean value that\n determines whether the SSM Agent is updated on the\n target instances every 2 weeks. The default value\n is \"true\".
\n UpdateEc2LaunchAgent\n
Description: (Optional) A boolean value that\n determines whether the EC2 Launch agent is updated\n on the target instances every month. The default\n value is \"false\".
\n CollectInventory\n
Description: (Optional) A boolean value that\n determines whether the EC2 Launch agent is updated\n on the target instances every month. The default\n value is \"true\".
\n ScanInstances\n
Description: (Optional) A boolean value that\n determines whether the target instances are\n scanned daily for available patches. The default\n value is \"true\".
\n InstallCloudWatchAgent\n
Description: (Optional) A boolean value that\n determines whether the Amazon CloudWatch agent\n is installed on the target instances. The default\n value is \"false\".
\n UpdateCloudWatchAgent\n
Description: (Optional) A boolean value that\n determines whether the Amazon CloudWatch agent\n is updated on the target instances every month.\n The default value is \"false\".
\n IsPolicyAttachAllowed\n
Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies\n to instances profiles already associated with the\n target instances. The default value is\n \"false\".
\n TargetType\n
Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are *,\n InstanceIds,\n ResourceGroups, and\n Tags. Use * to target\n all instances in the account.
\n TargetInstances\n
Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n InstanceIds for the\n TargetType parameter.
\n TargetTagKey\n
Description: (Optional) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n Tags for the TargetType\n parameter.
\n TargetTagValue\n
Description: (Optional) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify Tags for the\n TargetType parameter.
\n ResourceGroupName\n
Description: (Optional) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n ResourceGroups for the\n TargetType parameter.
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n PackagesToInstall\n
Description: (Required) A comma separated\n list of packages you want to install on the target\n instances. The valid values are\n AWSEFSTools, AWSCWAgent,\n and AWSEC2LaunchAgent.
\n RemediationSchedule\n
Description: (Optional) A rate expression\n that defines the schedule for drift remediation.\n The valid values are rate(30 days),\n rate(14 days), rate(2\n days), and none. The default\n value is \"rate(30 days)\".
\n IsPolicyAttachAllowed\n
Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies\n to instances profiles already associated with the\n target instances. The default value is\n \"false\".
\n TargetType\n
Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are *,\n InstanceIds,\n ResourceGroups, and\n Tags. Use * to target\n all instances in the account.
\n TargetInstances\n
Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n InstanceIds for the\n TargetType parameter.
\n TargetTagKey\n
Description: (Required) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n Tags for the TargetType\n parameter.
\n TargetTagValue\n
Description: (Required) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify Tags for the\n TargetType parameter.
\n ResourceGroupName\n
Description: (Required) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n ResourceGroups for the\n TargetType parameter.
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\n\n PatchPolicyName\n
Description: (Required) A name for the patch\n policy. The value you provide is applied to target\n Amazon EC2 instances as a tag.
\n\n SelectedPatchBaselines\n
Description: (Required) An array of JSON\n objects containing the information for the patch\n baselines to include in your patch policy.
\n\n PatchBaselineUseDefault\n
Description: (Optional) A boolean value that\n determines whether the selected patch baselines\n are all Amazon Web Services provided.
\n\n ConfigurationOptionsPatchOperation\n
Description: (Optional) Determines whether\n target instances scan for available patches, or\n scan and install available patches. The valid\n values are Scan and\n ScanAndInstall. The default value for\n the parameter is Scan.
\n ConfigurationOptionsScanValue\n
Description: (Optional) A cron expression\n that is used as the schedule for when instances\n scan for available patches.
\n\n ConfigurationOptionsInstallValue\n
Description: (Optional) A cron expression\n that is used as the schedule for when instances\n install available patches.
\n\n ConfigurationOptionsScanNextInterval\n
Description: (Optional) A boolean value that\n determines whether instances should scan for\n available patches at the next cron interval. The\n default value is \"false\".
\n ConfigurationOptionsInstallNextInterval\n
Description: (Optional) A boolean value that\n determines whether instances should scan for\n available patches at the next cron interval. The\n default value is \"false\".
\n RebootOption\n
Description: (Optional) A boolean value that\n determines whether instances are rebooted after\n patches are installed. The default value is\n \"false\".
\n IsPolicyAttachAllowed\n
Description: (Optional) A boolean value that\n determines whether Quick Setup attaches policies\n to instances profiles already associated with the\n target instances. The default value is\n \"false\".
\n OutputLogEnableS3\n
Description: (Optional) A boolean value that\n determines whether command output logs are sent to\n Amazon S3.
\n\n OutputS3Location\n
Description: (Optional) A JSON string\n containing information about the Amazon S3\n bucket where you want to store the output details\n of the request.
\n\n OutputS3BucketRegion\n
Description: (Optional) The Amazon Web Services Region where the Amazon S3\n bucket you want Config to deliver\n command output to is located.
\n\n OutputS3BucketName\n
Description: (Optional) The name of the\n Amazon S3 bucket you want Config to deliver command output to.
\n\n OutputS3KeyPrefix\n
Description: (Optional) The key prefix you\n want to use in the custom Amazon S3\n bucket.
\n\n TargetType\n
Description: (Optional) Determines how\n instances are targeted for local account\n deployments. Don't specify a value for this\n parameter if you're deploying to OUs. The valid\n values are *,\n InstanceIds,\n ResourceGroups, and\n Tags. Use * to target\n all instances in the account.
\n TargetInstances\n
Description: (Optional) A comma separated\n list of instance IDs. You must provide a value for\n this parameter if you specify\n InstanceIds for the\n TargetType parameter.
\n TargetTagKey\n
Description: (Required) The tag key assigned\n to the instances you want to target. You must\n provide a value for this parameter if you specify\n Tags for the TargetType\n parameter.
\n TargetTagValue\n
Description: (Required) The value of the tag\n key assigned to the instances you want to target.\n You must provide a value for this parameter if you\n specify Tags for the\n TargetType parameter.
\n ResourceGroupName\n
Description: (Required) The name of the\n resource group associated with the instances you\n want to target. You must provide a value for this\n parameter if you specify\n ResourceGroups for the\n TargetType parameter.
\n TargetAccounts\n
Description: (Optional) The ID of the\n Amazon Web Services account initiating the\n configuration deployment. You only need to provide\n a value for this parameter if you want to deploy\n the configuration locally. A value must be\n provided for either TargetAccounts or\n TargetOrganizationalUnits.
\n TargetOrganizationalUnits\n
Description: (Optional) A comma separated\n list of organizational units (OUs) you want to\n deploy the configuration to.
\n\n TargetRegions\n
Description: (Required) A comma separated\n list of Amazon Web Services Regions you want to\n deploy the configuration to.
\nThe version of the Quick Setup type to use.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "LocalDeploymentExecutionRoleName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the IAM role used to deploy local\n configurations.
", + "smithy.api#pattern": "^[\\w+=,.@-]{1,64}$" + } + }, + "LocalDeploymentAdministrationRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role used to administrate local configuration\n deployments.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the preferences and options for a configuration definition.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummary" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummary": { + "type": "structure", + "members": { + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration definition.
" + } + }, + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration used by the configuration\n definition.
" + } + }, + "TypeVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the Quick Setup type used by the configuration definition.
" + } + }, + "FirstClassParameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "The common parameters and values for the configuration definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summarized definition of a Quick Setup configuration definition.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionInput" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinition" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationManagerList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationManagerSummary" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationManagerSummary": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the Quick Setup configuration.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the configuration.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the configuration
" + } + }, + "StatusSummaries": { + "target": "com.amazonaws.ssmquicksetup#StatusSummariesList", + "traits": { + "smithy.api#documentation": "Summaries of the state of the configuration manager. These summaries include an\n aggregate of the statuses from the configuration definition associated with the\n configuration manager. This includes deployment statuses, association statuses,\n drift statuses, health checks, and more.
" + } + }, + "ConfigurationDefinitionSummaries": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionSummariesList", + "traits": { + "smithy.api#documentation": "A summary of the Quick Setup configuration definition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of a Quick Setup configuration manager.
" + } + }, + "com.amazonaws.ssmquicksetup#ConfigurationParametersMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]+$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 40960 + } + } + } + }, + "com.amazonaws.ssmquicksetup#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "Another request is being processed. Wait a few minutes and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.ssmquicksetup#CreateConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#CreateConfigurationManagerInput" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#CreateConfigurationManagerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Quick Setup configuration manager resource. This object is a collection\n of desired state configurations for multiple configuration definitions and\n summaries describing the deployments of those definitions.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/configurationManager" + } + } + }, + "com.amazonaws.ssmquicksetup#CreateConfigurationManagerInput": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A name for the configuration manager.
", + "smithy.api#pattern": "^[ A-Za-z0-9._-]{0,120}$" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the configuration manager.
", + "smithy.api#pattern": "^.{0,512}$" + } + }, + "ConfigurationDefinitions": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsInputList", + "traits": { + "smithy.api#documentation": "The definition of the Quick Setup configuration that the configuration manager\n deploys.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssmquicksetup#TagsMap", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata to assign to the configuration manager.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#CreateConfigurationManagerOutput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN for the newly created configuration manager.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#DeleteConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#DeleteConfigurationManagerInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a configuration manager.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/configurationManager/{ManagerArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#DeleteConfigurationManagerInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#Filter": { + "type": "structure", + "members": { + "Key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key for the filter.
", + "smithy.api#length": { + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]*$", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.ssmquicksetup#FilterValues", + "traits": { + "smithy.api#documentation": "The values for the filter keys.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A key-value pair to filter results.
" + } + }, + "com.amazonaws.ssmquicksetup#FilterValues": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]*$" + } + } + }, + "com.amazonaws.ssmquicksetup#FiltersList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#Filter" + } + }, + "com.amazonaws.ssmquicksetup#GetConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#GetConfigurationManagerInput" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#GetConfigurationManagerOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a configuration manager.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/configurationManager/{ManagerArn}" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetConfigurationManagerFailure", + "params": { + "ManagerArn": "arn:aws:ssm-quicksetup:us-east-1:602768233532:configuration-manager/7cac1a1b-64a9-4c9a-97e8-8c68928b8f13" + }, + "expect": { + "failure": { + "errorId": "com.amazonaws.ssmquicksetup#AccessDeniedException" + } + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmquicksetup#GetConfigurationManagerInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#GetConfigurationManagerOutput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the configuration manager.
" + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the configuration manager.
" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The datetime stamp when the configuration manager was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "LastModifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The datetime stamp when the configuration manager was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "StatusSummaries": { + "target": "com.amazonaws.ssmquicksetup#StatusSummariesList", + "traits": { + "smithy.api#documentation": "A summary of the state of the configuration manager. This includes deployment\n statuses, association statuses, drift statuses, health checks, and more.
" + } + }, + "ConfigurationDefinitions": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationDefinitionsList", + "traits": { + "smithy.api#documentation": "The configuration definitions association with the configuration manager.
" + } + }, + "Tags": { + "target": "com.amazonaws.ssmquicksetup#TagsMap", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata to assign to the configuration manager.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#GetServiceSettings": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#GetServiceSettingsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/serviceSettings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmquicksetup#GetServiceSettingsOutput": { + "type": "structure", + "members": { + "ServiceSettings": { + "target": "com.amazonaws.ssmquicksetup#ServiceSettings", + "traits": { + "smithy.api#documentation": "Returns details about the settings for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#IAMRoleArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::IAM::Role" + } + } + }, + "com.amazonaws.ssmquicksetup#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "An error occurred on the server side.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.ssmquicksetup#ListConfigurationManagers": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#ListConfigurationManagersInput" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#ListConfigurationManagersOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns Quick Setup configuration managers.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/listConfigurationManagers" + }, + "smithy.api#paginated": { + "items": "ConfigurationManagersList", + "inputToken": "StartingToken", + "outputToken": "NextToken", + "pageSize": "MaxItems" + }, + "smithy.test#smokeTests": [ + { + "id": "ListConfigurationManagersSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmquicksetup#ListConfigurationManagersInput": { + "type": "structure", + "members": { + "StartingToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token to use when requesting a specific set of items from a list.
", + "smithy.api#length": { + "max": 1024 + }, + "smithy.api#pattern": "^[A-Za-z0-9+=@_\\/\\s-]*$" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of configuration managers that are returned by the\n request.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "Filters": { + "target": "com.amazonaws.ssmquicksetup#FiltersList", + "traits": { + "smithy.api#documentation": "Filters the results returned by the request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#ListConfigurationManagersOutput": { + "type": "structure", + "members": { + "ConfigurationManagersList": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationManagerList", + "traits": { + "smithy.api#documentation": "The configuration managers returned by the request.
" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token to use when requesting the next set of configuration managers. If there\n are no additional operations to return, the string is empty.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#ListQuickSetupTypes": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#ListQuickSetupTypesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the available Quick Setup types.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/listQuickSetupTypes" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "ListQuickSetupTypesSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmquicksetup#ListQuickSetupTypesOutput": { + "type": "structure", + "members": { + "QuickSetupTypeList": { + "target": "com.amazonaws.ssmquicksetup#QuickSetupTypeList", + "traits": { + "smithy.api#documentation": "An array of Quick Setup types.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.ssmquicksetup#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns tags assigned to the resource.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ssmquicksetup#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource the tag is assigned to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.ssmquicksetup#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata assigned to the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmquicksetup#QuickSetup": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.ssmquicksetup#CreateConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#DeleteConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#GetConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#GetServiceSettings" + }, + { + "target": "com.amazonaws.ssmquicksetup#ListConfigurationManagers" + }, + { + "target": "com.amazonaws.ssmquicksetup#ListQuickSetupTypes" + }, + { + "target": "com.amazonaws.ssmquicksetup#ListTagsForResource" + }, + { + "target": "com.amazonaws.ssmquicksetup#TagResource" + }, + { + "target": "com.amazonaws.ssmquicksetup#UntagResource" + }, + { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinition" + }, + { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationManager" + }, + { + "target": "com.amazonaws.ssmquicksetup#UpdateServiceSettings" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "SSM QuickSetup", + "arnNamespace": "ssm-quicksetup", + "cloudTrailEventSource": "ssm-quicksetup.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "ssm-quicksetup" + }, + "aws.iam#supportedPrincipalTypes": ["Root", "IAMUser", "IAMRole", "FederatedUser"], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Authorization", + "Content-Type", + "Credentials", + "X-Amz-Date", + "X-Api-Key", + "X-Amz-Security-Token", + "x-amz-content-sha256", + "X-Amz-User-Agent" + ] + }, + "smithy.api#documentation": "Quick Setup helps you quickly configure frequently used services and features with\n recommended best practices. Quick Setup simplifies setting up services, including\n Systems Manager, by automating common or recommended tasks.
", + "smithy.api#title": "AWS Systems Manager QuickSetup", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://ssm-quicksetup.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ssm-quicksetup.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.ssmquicksetup#QuickSetupTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#QuickSetupTypeOutput" + } + }, + "com.amazonaws.ssmquicksetup#QuickSetupTypeOutput": { + "type": "structure", + "members": { + "Type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of the Quick Setup configuration.
" + } + }, + "LatestVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The latest version number of the configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Quick Setup type.
" + } + }, + "com.amazonaws.ssmquicksetup#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The resource couldn't be found. Check the ID or name and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ssmquicksetup#ServiceSettings": { + "type": "structure", + "members": { + "ExplorerEnablingRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The IAM role used to enable Explorer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings configured for Quick Setup.
" + } + }, + "com.amazonaws.ssmquicksetup#Status": { + "type": "enum", + "members": { + "INITIALIZING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZING" + } + }, + "DEPLOYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPLOYING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "STOP_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOP_FAILED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.ssmquicksetup#StatusDetails": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.ssmquicksetup#StatusSummariesList": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#StatusSummary" + } + }, + "com.amazonaws.ssmquicksetup#StatusSummary": { + "type": "structure", + "members": { + "StatusType": { + "target": "com.amazonaws.ssmquicksetup#StatusType", + "traits": { + "smithy.api#documentation": "The type of a status summary.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.ssmquicksetup#Status", + "traits": { + "smithy.api#documentation": "The current status.
" + } + }, + "StatusMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
" + } + }, + "LastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The datetime stamp when the status was last updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "StatusDetails": { + "target": "com.amazonaws.ssmquicksetup#StatusDetails", + "traits": { + "smithy.api#documentation": "Details about the status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summarized description of the status.
" + } + }, + "com.amazonaws.ssmquicksetup#StatusType": { + "type": "enum", + "members": { + "DEPLOYMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Deployment" + } + }, + "ASYNC_EXECUTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AsyncExecutions" + } + } + } + }, + "com.amazonaws.ssmquicksetup#TagEntry": { + "type": "structure", + "members": { + "Key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The key for the tag.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "Value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value for the tag.
", + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + } + }, + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssmquicksetup#TagKeys": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.ssmquicksetup#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#TagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns key-value pairs of metadata to Amazon Web Services resources.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#TagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssmquicksetup#TagsMap", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata to assign to the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmquicksetup#TagEntry" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssmquicksetup#TagsMap": { + "type": "map", + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssmquicksetup#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.ssmquicksetup#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UntagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from the specified resource.
", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to remove tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.ssmquicksetup#TagKeys", + "traits": { + "smithy.api#documentation": "The keys of the tags to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinitionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a Quick Setup configuration definition.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/configurationDefinition/{ManagerArn}/{Id}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationDefinitionInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager associated with the definition to\n update.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + }, + "Id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the configuration definition you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^[a-z0-9-]{1,20}$", + "smithy.api#required": {} + } + }, + "TypeVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The version of the Quick Setup type to use.
", + "smithy.api#pattern": "^\\d{1,3}(\\.\\d{1,3})?$|^LATEST$" + } + }, + "Parameters": { + "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", + "traits": { + "smithy.api#documentation": "The parameters for the configuration definition type.
" + } + }, + "LocalDeploymentExecutionRoleName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the IAM role used to deploy local\n configurations.
", + "smithy.api#pattern": "^[\\w+=,.@-]{1,64}$" + } + }, + "LocalDeploymentAdministrationRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role used to administrate local configuration\n deployments.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationManager": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UpdateConfigurationManagerInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a Quick Setup configuration manager.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/configurationManager/{ManagerArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateConfigurationManagerInput": { + "type": "structure", + "members": { + "ManagerArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration manager.
", + "smithy.api#httpLabel": {}, + "smithy.api#pattern": "^arn:aws:ssm-quicksetup:([^:]+):(\\d{12}):configuration-manager/[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "smithy.api#required": {} + } + }, + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A name for the configuration manager.
", + "smithy.api#pattern": "^[ A-Za-z0-9._-]{0,120}$" + } + }, + "Description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the configuration manager.
", + "smithy.api#pattern": "^.{0,512}$" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateServiceSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmquicksetup#UpdateServiceSettingsInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ConflictException" + }, + { + "target": "com.amazonaws.ssmquicksetup#InternalServerException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmquicksetup#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates settings configured for Quick Setup.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/serviceSettings" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.ssmquicksetup#UpdateServiceSettingsInput": { + "type": "structure", + "members": { + "ExplorerEnablingRoleArn": { + "target": "com.amazonaws.ssmquicksetup#IAMRoleArn", + "traits": { + "smithy.api#documentation": "The IAM role used to enable Explorer.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmquicksetup#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request is invalid. Verify the values provided for the request parameters are\n accurate.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +}