{ "version":"2.0", "metadata":{ "apiVersion":"2018-05-10", "endpointPrefix":"ssm-quicksetup", "jsonVersion":"1.1", "protocol":"rest-json", "protocols":["rest-json"], "serviceFullName":"AWS Systems Manager QuickSetup", "serviceId":"SSM QuickSetup", "signatureVersion":"v4", "signingName":"ssm-quicksetup", "uid":"ssm-quicksetup-2018-05-10", "auth":["aws.auth#sigv4"] }, "operations":{ "CreateConfigurationManager":{ "name":"CreateConfigurationManager", "http":{ "method":"POST", "requestUri":"/configurationManager", "responseCode":200 }, "input":{"shape":"CreateConfigurationManagerInput"}, "output":{"shape":"CreateConfigurationManagerOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Creates 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.

" }, "DeleteConfigurationManager":{ "name":"DeleteConfigurationManager", "http":{ "method":"DELETE", "requestUri":"/configurationManager/{ManagerArn}", "responseCode":200 }, "input":{"shape":"DeleteConfigurationManagerInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a configuration manager.

", "idempotent":true }, "GetConfiguration":{ "name":"GetConfiguration", "http":{ "method":"GET", "requestUri":"/getConfiguration/{ConfigurationId}", "responseCode":200 }, "input":{"shape":"GetConfigurationInput"}, "output":{"shape":"GetConfigurationOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns details about the specified configuration.

" }, "GetConfigurationManager":{ "name":"GetConfigurationManager", "http":{ "method":"GET", "requestUri":"/configurationManager/{ManagerArn}", "responseCode":200 }, "input":{"shape":"GetConfigurationManagerInput"}, "output":{"shape":"GetConfigurationManagerOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a configuration manager.

" }, "GetServiceSettings":{ "name":"GetServiceSettings", "http":{ "method":"GET", "requestUri":"/serviceSettings", "responseCode":200 }, "output":{"shape":"GetServiceSettingsOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

" }, "ListConfigurationManagers":{ "name":"ListConfigurationManagers", "http":{ "method":"POST", "requestUri":"/listConfigurationManagers", "responseCode":200 }, "input":{"shape":"ListConfigurationManagersInput"}, "output":{"shape":"ListConfigurationManagersOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns Quick Setup configuration managers.

" }, "ListConfigurations":{ "name":"ListConfigurations", "http":{ "method":"POST", "requestUri":"/listConfigurations", "responseCode":200 }, "input":{"shape":"ListConfigurationsInput"}, "output":{"shape":"ListConfigurationsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

" }, "ListQuickSetupTypes":{ "name":"ListQuickSetupTypes", "http":{ "method":"GET", "requestUri":"/listQuickSetupTypes", "responseCode":200 }, "output":{"shape":"ListQuickSetupTypesOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Returns the available Quick Setup types.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns tags assigned to the resource.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"PUT", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"TagResourceInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Assigns key-value pairs of metadata to Amazon Web Services resources.

", "idempotent":true }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{ResourceArn}", "responseCode":200 }, "input":{"shape":"UntagResourceInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Removes tags from the specified resource.

", "idempotent":true }, "UpdateConfigurationDefinition":{ "name":"UpdateConfigurationDefinition", "http":{ "method":"PUT", "requestUri":"/configurationDefinition/{ManagerArn}/{Id}", "responseCode":200 }, "input":{"shape":"UpdateConfigurationDefinitionInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a Quick Setup configuration definition.

", "idempotent":true }, "UpdateConfigurationManager":{ "name":"UpdateConfigurationManager", "http":{ "method":"PUT", "requestUri":"/configurationManager/{ManagerArn}", "responseCode":200 }, "input":{"shape":"UpdateConfigurationManagerInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a Quick Setup configuration manager.

", "idempotent":true }, "UpdateServiceSettings":{ "name":"UpdateServiceSettings", "http":{ "method":"PUT", "requestUri":"/serviceSettings", "responseCode":200 }, "input":{"shape":"UpdateServiceSettingsInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates settings configured for Quick Setup.

", "idempotent":true } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The requester has insufficient permissions to perform the operation.

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "ConfigurationDefinition":{ "type":"structure", "required":[ "Parameters", "Type" ], "members":{ "Id":{ "shape":"String", "documentation":"

The ID of the configuration definition.

" }, "LocalDeploymentAdministrationRoleArn":{ "shape":"IAMRoleArn", "documentation":"

The ARN of the IAM role used to administrate local configuration deployments.

" }, "LocalDeploymentExecutionRoleName":{ "shape":"ConfigurationDefinitionLocalDeploymentExecutionRoleNameString", "documentation":"

The name of the IAM role used to deploy local configurations.

" }, "Parameters":{ "shape":"ConfigurationParametersMap", "documentation":"

A list of key-value pairs containing the required parameters for the configuration type.

" }, "Type":{ "shape":"ConfigurationDefinitionTypeString", "documentation":"

The type of the Quick Setup configuration.

" }, "TypeVersion":{ "shape":"ConfigurationDefinitionTypeVersionString", "documentation":"

The version of the Quick Setup type used.

" } }, "documentation":"

The definition of a Quick Setup configuration.

" }, "ConfigurationDefinitionInput":{ "type":"structure", "required":[ "Parameters", "Type" ], "members":{ "LocalDeploymentAdministrationRoleArn":{ "shape":"IAMRoleArn", "documentation":"

The ARN of the IAM role used to administrate local configuration deployments.

" }, "LocalDeploymentExecutionRoleName":{ "shape":"ConfigurationDefinitionInputLocalDeploymentExecutionRoleNameString", "documentation":"

The name of the IAM role used to deploy local configurations.

" }, "Parameters":{ "shape":"ConfigurationParametersMap", "documentation":"

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.

OpsCenter (Type: Amazon Web ServicesQuickSetupType-SSMOpsCenter)
Resource Scheduler (Type: Amazon Web ServicesQuickSetupType-Scheduler)
Default Host Management Configuration (Type: Amazon Web ServicesQuickSetupType-DHMC)
Resource Explorer (Type: Amazon Web ServicesQuickSetupType-ResourceExplorer)
Change Manager (Type: Amazon Web ServicesQuickSetupType-SSMChangeMgr)
DevOps Guru (Type: Amazon Web ServicesQuickSetupType-DevOpsGuru)
Conformance Packs (Type: Amazon Web ServicesQuickSetupType-CFGCPacks)
Config Recording (Type: Amazon Web ServicesQuickSetupType-CFGRecording)
Host Management (Type: Amazon Web ServicesQuickSetupType-SSMHostMgmt)
Distributor (Type: Amazon Web ServicesQuickSetupType-Distributor)
Patch Policy (Type: Amazon Web ServicesQuickSetupType-PatchPolicy)
" }, "Type":{ "shape":"ConfigurationDefinitionInputTypeString", "documentation":"

The type of the Quick Setup configuration.

" }, "TypeVersion":{ "shape":"ConfigurationDefinitionInputTypeVersionString", "documentation":"

The version of the Quick Setup type to use.

" } }, "documentation":"

Defines the preferences and options for a configuration definition.

" }, "ConfigurationDefinitionInputLocalDeploymentExecutionRoleNameString":{ "type":"string", "pattern":"^[\\w+=,.@-]{1,64}$" }, "ConfigurationDefinitionInputTypeString":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.:/]{3,200}$" }, "ConfigurationDefinitionInputTypeVersionString":{ "type":"string", "max":128, "min":1 }, "ConfigurationDefinitionLocalDeploymentExecutionRoleNameString":{ "type":"string", "pattern":"^[\\w+=,.@-]{1,64}$" }, "ConfigurationDefinitionSummariesList":{ "type":"list", "member":{"shape":"ConfigurationDefinitionSummary"} }, "ConfigurationDefinitionSummary":{ "type":"structure", "members":{ "FirstClassParameters":{ "shape":"ConfigurationParametersMap", "documentation":"

The common parameters and values for the configuration definition.

" }, "Id":{ "shape":"String", "documentation":"

The ID of the configuration definition.

" }, "Type":{ "shape":"String", "documentation":"

The type of the Quick Setup configuration used by the configuration definition.

" }, "TypeVersion":{ "shape":"String", "documentation":"

The version of the Quick Setup type used by the configuration definition.

" } }, "documentation":"

A summarized definition of a Quick Setup configuration definition.

" }, "ConfigurationDefinitionTypeString":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.:/]{3,200}$" }, "ConfigurationDefinitionTypeVersionString":{ "type":"string", "max":128, "min":1 }, "ConfigurationDefinitionsInputList":{ "type":"list", "member":{"shape":"ConfigurationDefinitionInput"} }, "ConfigurationDefinitionsList":{ "type":"list", "member":{"shape":"ConfigurationDefinition"} }, "ConfigurationManagerList":{ "type":"list", "member":{"shape":"ConfigurationManagerSummary"} }, "ConfigurationManagerSummary":{ "type":"structure", "required":["ManagerArn"], "members":{ "ConfigurationDefinitionSummaries":{ "shape":"ConfigurationDefinitionSummariesList", "documentation":"

A summary of the Quick Setup configuration definition.

" }, "Description":{ "shape":"String", "documentation":"

The description of the configuration.

" }, "ManagerArn":{ "shape":"String", "documentation":"

The ARN of the Quick Setup configuration.

" }, "Name":{ "shape":"String", "documentation":"

The name of the configuration

" }, "StatusSummaries":{ "shape":"StatusSummariesList", "documentation":"

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.

" } }, "documentation":"

A summary of a Quick Setup configuration manager.

" }, "ConfigurationParametersMap":{ "type":"map", "key":{"shape":"ConfigurationParametersMapKeyString"}, "value":{"shape":"ConfigurationParametersMapValueString"} }, "ConfigurationParametersMapKeyString":{ "type":"string", "max":256, "min":1, "pattern":"^[A-Za-z0-9+=@_\\/\\s-]+$" }, "ConfigurationParametersMapValueString":{ "type":"string", "max":40960, "min":0 }, "ConfigurationSummary":{ "type":"structure", "members":{ "Account":{ "shape":"String", "documentation":"

The ID of the Amazon Web Services account where the configuration was deployed.

" }, "ConfigurationDefinitionId":{ "shape":"String", "documentation":"

The ID of the configuration definition.

" }, "CreatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

The datetime stamp when the configuration was created.

" }, "FirstClassParameters":{ "shape":"ConfigurationParametersMap", "documentation":"

The common parameters and values for the configuration definition.

" }, "Id":{ "shape":"String", "documentation":"

A service generated identifier for the configuration.

" }, "ManagerArn":{ "shape":"String", "documentation":"

The ARN of the configuration manager.

" }, "Region":{ "shape":"String", "documentation":"

The Amazon Web Services Region where the configuration was deployed.

" }, "StatusSummaries":{ "shape":"StatusSummariesList", "documentation":"

A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.

" }, "Type":{ "shape":"String", "documentation":"

The type of the Quick Setup configuration.

" }, "TypeVersion":{ "shape":"String", "documentation":"

The version of the Quick Setup type used.

" } }, "documentation":"

Details for a Quick Setup configuration.

" }, "ConfigurationsList":{ "type":"list", "member":{"shape":"ConfigurationSummary"} }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Another request is being processed. Wait a few minutes and try again.

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "CreateConfigurationManagerInput":{ "type":"structure", "required":["ConfigurationDefinitions"], "members":{ "ConfigurationDefinitions":{ "shape":"ConfigurationDefinitionsInputList", "documentation":"

The definition of the Quick Setup configuration that the configuration manager deploys.

" }, "Description":{ "shape":"CreateConfigurationManagerInputDescriptionString", "documentation":"

A description of the configuration manager.

" }, "Name":{ "shape":"CreateConfigurationManagerInputNameString", "documentation":"

A name for the configuration manager.

" }, "Tags":{ "shape":"TagsMap", "documentation":"

Key-value pairs of metadata to assign to the configuration manager.

" } } }, "CreateConfigurationManagerInputDescriptionString":{ "type":"string", "pattern":"^.{0,512}$" }, "CreateConfigurationManagerInputNameString":{ "type":"string", "pattern":"^[ A-Za-z0-9._-]{0,120}$" }, "CreateConfigurationManagerOutput":{ "type":"structure", "required":["ManagerArn"], "members":{ "ManagerArn":{ "shape":"String", "documentation":"

The ARN for the newly created configuration manager.

" } } }, "DeleteConfigurationManagerInput":{ "type":"structure", "required":["ManagerArn"], "members":{ "ManagerArn":{ "shape":"DeleteConfigurationManagerInputManagerArnString", "documentation":"

The ID of the configuration manager.

", "location":"uri", "locationName":"ManagerArn" } } }, "DeleteConfigurationManagerInputManagerArnString":{ "type":"string", "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}$" }, "Filter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"FilterKeyString", "documentation":"

The key for the filter.

" }, "Values":{ "shape":"FilterValues", "documentation":"

The values for the filter keys.

" } }, "documentation":"

A key-value pair to filter results.

" }, "FilterKeyString":{ "type":"string", "max":128, "min":0, "pattern":"^[A-Za-z0-9+=@_\\/\\s-]*$" }, "FilterValues":{ "type":"list", "member":{"shape":"FilterValuesMemberString"} }, "FilterValuesMemberString":{ "type":"string", "max":256, "min":0, "pattern":"^[A-Za-z0-9+=@_\\/\\s-]*$" }, "FiltersList":{ "type":"list", "member":{"shape":"Filter"} }, "GetConfigurationInput":{ "type":"structure", "required":["ConfigurationId"], "members":{ "ConfigurationId":{ "shape":"GetConfigurationInputConfigurationIdString", "documentation":"

A service generated identifier for the configuration.

", "location":"uri", "locationName":"ConfigurationId" } } }, "GetConfigurationInputConfigurationIdString":{ "type":"string", "pattern":"^[a-zA-Z0-9-_/:]{1,100}$" }, "GetConfigurationManagerInput":{ "type":"structure", "required":["ManagerArn"], "members":{ "ManagerArn":{ "shape":"GetConfigurationManagerInputManagerArnString", "documentation":"

The ARN of the configuration manager.

", "location":"uri", "locationName":"ManagerArn" } } }, "GetConfigurationManagerInputManagerArnString":{ "type":"string", "min":1, "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}$" }, "GetConfigurationManagerOutput":{ "type":"structure", "required":["ManagerArn"], "members":{ "ConfigurationDefinitions":{ "shape":"ConfigurationDefinitionsList", "documentation":"

The configuration definitions association with the configuration manager.

" }, "CreatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

The datetime stamp when the configuration manager was created.

" }, "Description":{ "shape":"String", "documentation":"

The description of the configuration manager.

" }, "LastModifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

The datetime stamp when the configuration manager was last updated.

" }, "ManagerArn":{ "shape":"String", "documentation":"

The ARN of the configuration manager.

" }, "Name":{ "shape":"String", "documentation":"

The name of the configuration manager.

" }, "StatusSummaries":{ "shape":"StatusSummariesList", "documentation":"

A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.

" }, "Tags":{ "shape":"TagsMap", "documentation":"

Key-value pairs of metadata to assign to the configuration manager.

" } } }, "GetConfigurationOutput":{ "type":"structure", "members":{ "Account":{ "shape":"String", "documentation":"

The ID of the Amazon Web Services account where the configuration was deployed.

" }, "ConfigurationDefinitionId":{ "shape":"String", "documentation":"

The ID of the configuration definition.

" }, "CreatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

The datetime stamp when the configuration manager was created.

" }, "Id":{ "shape":"String", "documentation":"

A service generated identifier for the configuration.

" }, "LastModifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

The datetime stamp when the configuration manager was last updated.

" }, "ManagerArn":{ "shape":"String", "documentation":"

The ARN of the configuration manager.

" }, "Parameters":{ "shape":"ConfigurationParametersMap", "documentation":"

The parameters for the configuration definition type.

" }, "Region":{ "shape":"String", "documentation":"

The Amazon Web Services Region where the configuration was deployed.

" }, "StatusSummaries":{ "shape":"StatusSummariesList", "documentation":"

A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.

" }, "Type":{ "shape":"String", "documentation":"

The type of the Quick Setup configuration.

" }, "TypeVersion":{ "shape":"String", "documentation":"

The version of the Quick Setup type used.

" } } }, "GetServiceSettingsOutput":{ "type":"structure", "members":{ "ServiceSettings":{ "shape":"ServiceSettings", "documentation":"

Returns details about the settings for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

" } } }, "IAMRoleArn":{"type":"string"}, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An error occurred on the server side.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "ListConfigurationManagersInput":{ "type":"structure", "members":{ "Filters":{ "shape":"FiltersList", "documentation":"

Filters the results returned by the request.

" }, "MaxItems":{ "shape":"ListConfigurationManagersInputMaxItemsInteger", "documentation":"

Specifies the maximum number of configuration managers that are returned by the request.

" }, "StartingToken":{ "shape":"ListConfigurationManagersInputStartingTokenString", "documentation":"

The token to use when requesting a specific set of items from a list.

" } } }, "ListConfigurationManagersInputMaxItemsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListConfigurationManagersInputStartingTokenString":{ "type":"string", "max":1024, "min":0, "pattern":"^[A-Za-z0-9+=@_\\/\\s-]*$" }, "ListConfigurationManagersOutput":{ "type":"structure", "members":{ "ConfigurationManagersList":{ "shape":"ConfigurationManagerList", "documentation":"

The configuration managers returned by the request.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of configuration managers. If there are no additional operations to return, the string is empty.

" } } }, "ListConfigurationsInput":{ "type":"structure", "members":{ "ConfigurationDefinitionId":{ "shape":"ListConfigurationsInputConfigurationDefinitionIdString", "documentation":"

The ID of the configuration definition.

" }, "Filters":{ "shape":"FiltersList", "documentation":"

Filters the results returned by the request.

" }, "ManagerArn":{ "shape":"ListConfigurationsInputManagerArnString", "documentation":"

The ARN of the configuration manager.

" }, "MaxItems":{ "shape":"ListConfigurationsInputMaxItemsInteger", "documentation":"

Specifies the maximum number of configurations that are returned by the request.

" }, "StartingToken":{ "shape":"ListConfigurationsInputStartingTokenString", "documentation":"

The token to use when requesting a specific set of items from a list.

" } } }, "ListConfigurationsInputConfigurationDefinitionIdString":{ "type":"string", "pattern":"^[a-z0-9-]{1,20}$" }, "ListConfigurationsInputManagerArnString":{ "type":"string", "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}$" }, "ListConfigurationsInputMaxItemsInteger":{ "type":"integer", "box":true, "max":100, "min":1 }, "ListConfigurationsInputStartingTokenString":{ "type":"string", "max":1024, "min":0, "pattern":"^[A-Za-z0-9+=@_|\\/\\s-]*$" }, "ListConfigurationsOutput":{ "type":"structure", "members":{ "ConfigurationsList":{ "shape":"ConfigurationsList", "documentation":"

An array of configurations.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListQuickSetupTypesOutput":{ "type":"structure", "members":{ "QuickSetupTypeList":{ "shape":"QuickSetupTypeList", "documentation":"

An array of Quick Setup types.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The ARN of the resource the tag is assigned to.

", "location":"uri", "locationName":"ResourceArn" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"Tags", "documentation":"

Key-value pairs of metadata assigned to the resource.

" } } }, "QuickSetupTypeList":{ "type":"list", "member":{"shape":"QuickSetupTypeOutput"} }, "QuickSetupTypeOutput":{ "type":"structure", "members":{ "LatestVersion":{ "shape":"String", "documentation":"

The latest version number of the configuration.

" }, "Type":{ "shape":"String", "documentation":"

The type of the Quick Setup configuration.

" } }, "documentation":"

Information about the Quick Setup type.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The resource couldn't be found. Check the ID or name and try again.

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ServiceSettings":{ "type":"structure", "members":{ "ExplorerEnablingRoleArn":{ "shape":"IAMRoleArn", "documentation":"

The IAM role used to enable Explorer.

" } }, "documentation":"

Settings configured for Quick Setup.

" }, "Status":{ "type":"string", "enum":[ "INITIALIZING", "DEPLOYING", "SUCCEEDED", "DELETING", "STOPPING", "FAILED", "STOPPED", "DELETE_FAILED", "STOP_FAILED", "NONE" ] }, "StatusDetails":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "StatusSummariesList":{ "type":"list", "member":{"shape":"StatusSummary"} }, "StatusSummary":{ "type":"structure", "required":[ "LastUpdatedAt", "StatusType" ], "members":{ "LastUpdatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

The datetime stamp when the status was last updated.

" }, "Status":{ "shape":"Status", "documentation":"

The current status.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

Details about the status.

" }, "StatusMessage":{ "shape":"String", "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.

" }, "StatusType":{ "shape":"StatusType", "documentation":"

The type of a status summary.

" } }, "documentation":"

A summarized description of the status.

" }, "StatusType":{ "type":"string", "enum":[ "Deployment", "AsyncExecutions" ] }, "String":{"type":"string"}, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "TagEntry":{ "type":"structure", "members":{ "Key":{ "shape":"TagEntryKeyString", "documentation":"

The key for the tag.

" }, "Value":{ "shape":"TagEntryValueString", "documentation":"

The value for the tag.

" } }, "documentation":"

Key-value pairs of metadata.

", "sensitive":true }, "TagEntryKeyString":{ "type":"string", "max":128, "min":1, "pattern":"^[A-Za-z0-9 _=@:.+-/]+$" }, "TagEntryValueString":{ "type":"string", "max":256, "min":0, "pattern":"^[A-Za-z0-9 _=@:.+-/]+$" }, "TagKeys":{ "type":"list", "member":{"shape":"String"} }, "TagResourceInput":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The ARN of the resource to tag.

", "location":"uri", "locationName":"ResourceArn" }, "Tags":{ "shape":"TagsMap", "documentation":"

Key-value pairs of metadata to assign to the resource.

" } } }, "Tags":{ "type":"list", "member":{"shape":"TagEntry"}, "sensitive":true }, "TagsMap":{ "type":"map", "key":{"shape":"TagsMapKeyString"}, "value":{"shape":"TagsMapValueString"}, "sensitive":true }, "TagsMapKeyString":{ "type":"string", "max":128, "min":1, "pattern":"^[A-Za-z0-9 _=@:.+-/]+$" }, "TagsMapValueString":{ "type":"string", "max":256, "min":0, "pattern":"^[A-Za-z0-9 _=@:.+-/]+$" }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"String"} }, "documentation":"

The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "UntagResourceInput":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The ARN of the resource to remove tags from.

", "location":"uri", "locationName":"ResourceArn" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

The keys of the tags to remove from the resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UpdateConfigurationDefinitionInput":{ "type":"structure", "required":[ "Id", "ManagerArn" ], "members":{ "Id":{ "shape":"UpdateConfigurationDefinitionInputIdString", "documentation":"

The ID of the configuration definition you want to update.

", "location":"uri", "locationName":"Id" }, "LocalDeploymentAdministrationRoleArn":{ "shape":"IAMRoleArn", "documentation":"

The ARN of the IAM role used to administrate local configuration deployments.

" }, "LocalDeploymentExecutionRoleName":{ "shape":"UpdateConfigurationDefinitionInputLocalDeploymentExecutionRoleNameString", "documentation":"

The name of the IAM role used to deploy local configurations.

" }, "ManagerArn":{ "shape":"UpdateConfigurationDefinitionInputManagerArnString", "documentation":"

The ARN of the configuration manager associated with the definition to update.

", "location":"uri", "locationName":"ManagerArn" }, "Parameters":{ "shape":"ConfigurationParametersMap", "documentation":"

The parameters for the configuration definition type.

" }, "TypeVersion":{ "shape":"UpdateConfigurationDefinitionInputTypeVersionString", "documentation":"

The version of the Quick Setup type to use.

" } } }, "UpdateConfigurationDefinitionInputIdString":{ "type":"string", "pattern":"^[a-z0-9-]{1,20}$" }, "UpdateConfigurationDefinitionInputLocalDeploymentExecutionRoleNameString":{ "type":"string", "pattern":"^[\\w+=,.@-]{1,64}$" }, "UpdateConfigurationDefinitionInputManagerArnString":{ "type":"string", "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}$" }, "UpdateConfigurationDefinitionInputTypeVersionString":{ "type":"string", "pattern":"^\\d{1,3}(\\.\\d{1,3})?$|^LATEST$" }, "UpdateConfigurationManagerInput":{ "type":"structure", "required":["ManagerArn"], "members":{ "Description":{ "shape":"UpdateConfigurationManagerInputDescriptionString", "documentation":"

A description of the configuration manager.

" }, "ManagerArn":{ "shape":"UpdateConfigurationManagerInputManagerArnString", "documentation":"

The ARN of the configuration manager.

", "location":"uri", "locationName":"ManagerArn" }, "Name":{ "shape":"UpdateConfigurationManagerInputNameString", "documentation":"

A name for the configuration manager.

" } } }, "UpdateConfigurationManagerInputDescriptionString":{ "type":"string", "pattern":"^.{0,512}$" }, "UpdateConfigurationManagerInputManagerArnString":{ "type":"string", "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}$" }, "UpdateConfigurationManagerInputNameString":{ "type":"string", "pattern":"^[ A-Za-z0-9._-]{0,120}$" }, "UpdateServiceSettingsInput":{ "type":"structure", "members":{ "ExplorerEnablingRoleArn":{ "shape":"IAMRoleArn", "documentation":"

The IAM role used to enable Explorer.

" } } }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The request is invalid. Verify the values provided for the request parameters are accurate.

", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"

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.

" }