{ "smithy": "2.0", "shapes": { "com.amazonaws.ssmquicksetup#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "

The 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
OpsCenter (Type: Amazon Web ServicesQuickSetupType-SSMOpsCenter)
\n
\n \n
\n
Resource Scheduler (Type: Amazon Web ServicesQuickSetupType-Scheduler)
\n
\n \n
\n
Default Host Management Configuration (Type: Amazon Web ServicesQuickSetupType-DHMC)
\n
\n \n
\n
Resource Explorer (Type: Amazon Web ServicesQuickSetupType-ResourceExplorer)
\n
\n \n
\n
Change Manager (Type: Amazon Web ServicesQuickSetupType-SSMChangeMgr)
\n
\n \n
\n
DevOps\u00a0Guru (Type: Amazon Web ServicesQuickSetupType-DevOpsGuru)
\n
\n \n
\n
Conformance Packs (Type: Amazon Web ServicesQuickSetupType-CFGCPacks)
\n
\n \n
\n
Config Recording (Type: Amazon Web ServicesQuickSetupType-CFGRecording)
\n
\n \n
\n
Host Management (Type: Amazon Web ServicesQuickSetupType-SSMHostMgmt)
\n
\n \n
\n
Distributor (Type: Amazon Web ServicesQuickSetupType-Distributor)
\n
\n \n
\n
Patch Policy (Type: Amazon Web ServicesQuickSetupType-PatchPolicy)
\n
\n \n
\n
", "smithy.api#required": {} } }, "TypeVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The 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#ConfigurationSummary": { "type": "structure", "members": { "Id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A service generated identifier for the configuration.

" } }, "ManagerArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the configuration manager.

" } }, "ConfigurationDefinitionId": { "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.

" } }, "TypeVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version of the Quick Setup type used.

" } }, "Region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region where the configuration was deployed.

" } }, "Account": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The datetime stamp when the configuration was created.

", "smithy.api#timestampFormat": "date-time" } }, "FirstClassParameters": { "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", "traits": { "smithy.api#documentation": "

The common parameters and values for the configuration definition.

" } }, "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.

" } } }, "traits": { "smithy.api#documentation": "

Details for a Quick Setup configuration.

" } }, "com.amazonaws.ssmquicksetup#ConfigurationsList": { "type": "list", "member": { "target": "com.amazonaws.ssmquicksetup#ConfigurationSummary" } }, "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#GetConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ssmquicksetup#GetConfigurationInput" }, "output": { "target": "com.amazonaws.ssmquicksetup#GetConfigurationOutput" }, "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 details about the specified configuration.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/getConfiguration/{ConfigurationId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmquicksetup#GetConfigurationInput": { "type": "structure", "members": { "ConfigurationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A service generated identifier for the configuration.

", "smithy.api#httpLabel": {}, "smithy.api#pattern": "^[a-zA-Z0-9-_/:]{1,100}$", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "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#GetConfigurationOutput": { "type": "structure", "members": { "Id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A service generated identifier for the configuration.

" } }, "ManagerArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the configuration manager.

" } }, "ConfigurationDefinitionId": { "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.

" } }, "TypeVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version of the Quick Setup type used.

" } }, "Account": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

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

" } }, "Region": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region where the configuration was deployed.

" } }, "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.

" } }, "Parameters": { "target": "com.amazonaws.ssmquicksetup#ConfigurationParametersMap", "traits": { "smithy.api#documentation": "

The parameters for the configuration definition type.

" } } }, "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#ListConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.ssmquicksetup#ListConfigurationsInput" }, "output": { "target": "com.amazonaws.ssmquicksetup#ListConfigurationsOutput" }, "errors": [ { "target": "com.amazonaws.ssmquicksetup#AccessDeniedException" }, { "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 configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listConfigurations" }, "smithy.api#paginated": { "items": "ConfigurationsList", "inputToken": "StartingToken", "outputToken": "NextToken", "pageSize": "MaxItems" }, "smithy.api#readonly": {} } }, "com.amazonaws.ssmquicksetup#ListConfigurationsInput": { "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 configurations 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.

" } }, "ManagerArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN of the configuration manager.

", "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}$" } }, "ConfigurationDefinitionId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the configuration definition.

", "smithy.api#pattern": "^[a-z0-9-]{1,20}$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ssmquicksetup#ListConfigurationsOutput": { "type": "structure", "members": { "ConfigurationsList": { "target": "com.amazonaws.ssmquicksetup#ConfigurationsList", "traits": { "smithy.api#documentation": "

An array of configurations.

" } }, "NextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The token to use when requesting the next set of items. If there are no additional items to\n 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#GetConfiguration" }, { "target": "com.amazonaws.ssmquicksetup#GetConfigurationManager" }, { "target": "com.amazonaws.ssmquicksetup#GetServiceSettings" }, { "target": "com.amazonaws.ssmquicksetup#ListConfigurationManagers" }, { "target": "com.amazonaws.ssmquicksetup#ListConfigurations" }, { "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#endpointBdd": { "version": "1.1", "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" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://ssm-quicksetup-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ssm-quicksetup-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ssm-quicksetup.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://ssm-quicksetup.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "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 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 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 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 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\n and status type of the status summary object. We don't recommend implementing\n parsing logic around this value since the messages returned can vary in\n 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 } } } }