AWS Systems Manager QuickSetup 2018-05-10
- Client: Aws\SSMQuickSetup\SSMQuickSetupClient
- Service ID: ssm-quicksetup
- Version: 2018-05-10
This page describes the parameters and results for the operations of the AWS Systems Manager QuickSetup (2018-05-10), and shows how to use the Aws\SSMQuickSetup\SSMQuickSetupClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateConfigurationManager ( array $params = [] )
- Creates a Quick Setup configuration manager resource.
- DeleteConfigurationManager ( array $params = [] )
- Deletes a configuration manager.
- GetConfiguration ( array $params = [] )
- Returns details about the specified configuration.
- GetConfigurationManager ( array $params = [] )
- Returns a configuration manager.
- GetServiceSettings ( array $params = [] )
- Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
- ListConfigurationManagers ( array $params = [] )
- Returns Quick Setup configuration managers.
- ListConfigurations ( array $params = [] )
- Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
- ListQuickSetupTypes ( array $params = [] )
- Returns the available Quick Setup types.
- ListTagsForResource ( array $params = [] )
- Returns tags assigned to the resource.
- TagResource ( array $params = [] )
- Assigns key-value pairs of metadata to Amazon Web Services resources.
- UntagResource ( array $params = [] )
- Removes tags from the specified resource.
- UpdateConfigurationDefinition ( array $params = [] )
- Updates a Quick Setup configuration definition.
- UpdateConfigurationManager ( array $params = [] )
- Updates a Quick Setup configuration manager.
- UpdateServiceSettings ( array $params = [] )
- Updates settings configured for Quick Setup.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateConfigurationManager
$result = $client->createConfigurationManager
([/* ... */]); $promise = $client->createConfigurationManagerAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createConfigurationManager([ 'ConfigurationDefinitions' => [ // REQUIRED [ 'LocalDeploymentAdministrationRoleArn' => '<string>', 'LocalDeploymentExecutionRoleName' => '<string>', 'Parameters' => ['<string>', ...], // REQUIRED 'Type' => '<string>', // REQUIRED 'TypeVersion' => '<string>', ], // ... ], 'Description' => '<string>', 'Name' => '<string>', 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ConfigurationDefinitions
-
- Required: Yes
- Type: Array of ConfigurationDefinitionInput structures
The definition of the Quick Setup configuration that the configuration manager deploys.
- Description
-
- Type: string
A description of the configuration manager.
- Name
-
- Type: string
A name for the configuration manager.
- Tags
-
- Type: Associative array of custom strings keys (TagsMapKeyString) to strings
Key-value pairs of metadata to assign to the configuration manager.
Result Syntax
[ 'ManagerArn' => '<string>', ]
Result Details
Members
- ManagerArn
-
- Required: Yes
- Type: string
The ARN for the newly created configuration manager.
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
DeleteConfigurationManager
$result = $client->deleteConfigurationManager
([/* ... */]); $promise = $client->deleteConfigurationManagerAsync
([/* ... */]);
Deletes a configuration manager.
Parameter Syntax
$result = $client->deleteConfigurationManager([ 'ManagerArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ManagerArn
-
- Required: Yes
- Type: string
The ID of the configuration manager.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
GetConfiguration
$result = $client->getConfiguration
([/* ... */]); $promise = $client->getConfigurationAsync
([/* ... */]);
Returns details about the specified configuration.
Parameter Syntax
$result = $client->getConfiguration([ 'ConfigurationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ConfigurationId
-
- Required: Yes
- Type: string
A service generated identifier for the configuration.
Result Syntax
[ 'Account' => '<string>', 'ConfigurationDefinitionId' => '<string>', 'CreatedAt' => <DateTime>, 'Id' => '<string>', 'LastModifiedAt' => <DateTime>, 'ManagerArn' => '<string>', 'Parameters' => ['<string>', ...], 'Region' => '<string>', 'StatusSummaries' => [ [ 'LastUpdatedAt' => <DateTime>, 'Status' => 'INITIALIZING|DEPLOYING|SUCCEEDED|DELETING|STOPPING|FAILED|STOPPED|DELETE_FAILED|STOP_FAILED|NONE', 'StatusDetails' => ['<string>', ...], 'StatusMessage' => '<string>', 'StatusType' => 'Deployment|AsyncExecutions', ], // ... ], 'Type' => '<string>', 'TypeVersion' => '<string>', ]
Result Details
Members
- Account
-
- Type: string
The ID of the Amazon Web Services account where the configuration was deployed.
- ConfigurationDefinitionId
-
- Type: string
The ID of the configuration definition.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The datetime stamp when the configuration manager was created.
- Id
-
- Type: string
A service generated identifier for the configuration.
- LastModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The datetime stamp when the configuration manager was last updated.
- ManagerArn
-
- Type: string
The ARN of the configuration manager.
- Parameters
-
- Type: Associative array of custom strings keys (ConfigurationParametersMapKeyString) to strings
The parameters for the configuration definition type.
- Region
-
- Type: string
The Amazon Web Services Region where the configuration was deployed.
- StatusSummaries
-
- Type: Array of StatusSummary structures
A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
- Type
-
- Type: string
The type of the Quick Setup configuration.
- TypeVersion
-
- Type: string
The version of the Quick Setup type used.
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
GetConfigurationManager
$result = $client->getConfigurationManager
([/* ... */]); $promise = $client->getConfigurationManagerAsync
([/* ... */]);
Returns a configuration manager.
Parameter Syntax
$result = $client->getConfigurationManager([ 'ManagerArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ManagerArn
-
- Required: Yes
- Type: string
The ARN of the configuration manager.
Result Syntax
[ 'ConfigurationDefinitions' => [ [ 'Id' => '<string>', 'LocalDeploymentAdministrationRoleArn' => '<string>', 'LocalDeploymentExecutionRoleName' => '<string>', 'Parameters' => ['<string>', ...], 'Type' => '<string>', 'TypeVersion' => '<string>', ], // ... ], 'CreatedAt' => <DateTime>, 'Description' => '<string>', 'LastModifiedAt' => <DateTime>, 'ManagerArn' => '<string>', 'Name' => '<string>', 'StatusSummaries' => [ [ 'LastUpdatedAt' => <DateTime>, 'Status' => 'INITIALIZING|DEPLOYING|SUCCEEDED|DELETING|STOPPING|FAILED|STOPPED|DELETE_FAILED|STOP_FAILED|NONE', 'StatusDetails' => ['<string>', ...], 'StatusMessage' => '<string>', 'StatusType' => 'Deployment|AsyncExecutions', ], // ... ], 'Tags' => ['<string>', ...], ]
Result Details
Members
- ConfigurationDefinitions
-
- Type: Array of ConfigurationDefinition structures
The configuration definitions association with the configuration manager.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The datetime stamp when the configuration manager was created.
- Description
-
- Type: string
The description of the configuration manager.
- LastModifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The datetime stamp when the configuration manager was last updated.
- ManagerArn
-
- Required: Yes
- Type: string
The ARN of the configuration manager.
- Name
-
- Type: string
The name of the configuration manager.
- StatusSummaries
-
- Type: Array of StatusSummary structures
A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
- Tags
-
- Type: Associative array of custom strings keys (TagsMapKeyString) to strings
Key-value pairs of metadata to assign to the configuration manager.
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
GetServiceSettings
$result = $client->getServiceSettings
([/* ... */]); $promise = $client->getServiceSettingsAsync
([/* ... */]);
Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
Parameter Syntax
$result = $client->getServiceSettings([ ]);
Parameter Details
Members
Result Syntax
[ 'ServiceSettings' => [ 'ExplorerEnablingRoleArn' => '<string>', ], ]
Result Details
Members
- ServiceSettings
-
- Type: ServiceSettings structure
Returns details about the settings for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
Errors
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
ListConfigurationManagers
$result = $client->listConfigurationManagers
([/* ... */]); $promise = $client->listConfigurationManagersAsync
([/* ... */]);
Returns Quick Setup configuration managers.
Parameter Syntax
$result = $client->listConfigurationManagers([ 'Filters' => [ [ 'Key' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'MaxItems' => <integer>, 'StartingToken' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: Array of Filter structures
Filters the results returned by the request.
- MaxItems
-
- Type: int
Specifies the maximum number of configuration managers that are returned by the request.
- StartingToken
-
- Type: string
The token to use when requesting a specific set of items from a list.
Result Syntax
[ 'ConfigurationManagersList' => [ [ 'ConfigurationDefinitionSummaries' => [ [ 'FirstClassParameters' => ['<string>', ...], 'Id' => '<string>', 'Type' => '<string>', 'TypeVersion' => '<string>', ], // ... ], 'Description' => '<string>', 'ManagerArn' => '<string>', 'Name' => '<string>', 'StatusSummaries' => [ [ 'LastUpdatedAt' => <DateTime>, 'Status' => 'INITIALIZING|DEPLOYING|SUCCEEDED|DELETING|STOPPING|FAILED|STOPPED|DELETE_FAILED|STOP_FAILED|NONE', 'StatusDetails' => ['<string>', ...], 'StatusMessage' => '<string>', 'StatusType' => 'Deployment|AsyncExecutions', ], // ... ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConfigurationManagersList
-
- Type: Array of ConfigurationManagerSummary structures
The configuration managers returned by the request.
- NextToken
-
- Type: string
The token to use when requesting the next set of configuration managers. If there are no additional operations to return, the string is empty.
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
ListConfigurations
$result = $client->listConfigurations
([/* ... */]); $promise = $client->listConfigurationsAsync
([/* ... */]);
Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
Parameter Syntax
$result = $client->listConfigurations([ 'ConfigurationDefinitionId' => '<string>', 'Filters' => [ [ 'Key' => '<string>', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'ManagerArn' => '<string>', 'MaxItems' => <integer>, 'StartingToken' => '<string>', ]);
Parameter Details
Members
- ConfigurationDefinitionId
-
- Type: string
The ID of the configuration definition.
- Filters
-
- Type: Array of Filter structures
Filters the results returned by the request.
- ManagerArn
-
- Type: string
The ARN of the configuration manager.
- MaxItems
-
- Type: int
Specifies the maximum number of configurations that are returned by the request.
- StartingToken
-
- Type: string
The token to use when requesting a specific set of items from a list.
Result Syntax
[ 'ConfigurationsList' => [ [ 'Account' => '<string>', 'ConfigurationDefinitionId' => '<string>', 'CreatedAt' => <DateTime>, 'FirstClassParameters' => ['<string>', ...], 'Id' => '<string>', 'ManagerArn' => '<string>', 'Region' => '<string>', 'StatusSummaries' => [ [ 'LastUpdatedAt' => <DateTime>, 'Status' => 'INITIALIZING|DEPLOYING|SUCCEEDED|DELETING|STOPPING|FAILED|STOPPED|DELETE_FAILED|STOP_FAILED|NONE', 'StatusDetails' => ['<string>', ...], 'StatusMessage' => '<string>', 'StatusType' => 'Deployment|AsyncExecutions', ], // ... ], 'Type' => '<string>', 'TypeVersion' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ConfigurationsList
-
- Type: Array of ConfigurationSummary structures
An array of configurations.
- NextToken
-
- Type: string
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
ListQuickSetupTypes
$result = $client->listQuickSetupTypes
([/* ... */]); $promise = $client->listQuickSetupTypesAsync
([/* ... */]);
Returns the available Quick Setup types.
Parameter Syntax
$result = $client->listQuickSetupTypes([ ]);
Parameter Details
Members
Result Syntax
[ 'QuickSetupTypeList' => [ [ 'LatestVersion' => '<string>', 'Type' => '<string>', ], // ... ], ]
Result Details
Members
- QuickSetupTypeList
-
- Type: Array of QuickSetupTypeOutput structures
An array of Quick Setup types.
Errors
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Returns tags assigned to the resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource the tag is assigned to.
Result Syntax
[ 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- Tags
-
- Type: Array of TagEntry structures
Key-value pairs of metadata assigned to the resource.
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Assigns key-value pairs of metadata to Amazon Web Services resources.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to tag.
- Tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagsMapKeyString) to strings
Key-value pairs of metadata to assign to the resource.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes tags from the specified resource.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to remove tags from.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the tags to remove from the resource.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
UpdateConfigurationDefinition
$result = $client->updateConfigurationDefinition
([/* ... */]); $promise = $client->updateConfigurationDefinitionAsync
([/* ... */]);
Updates a Quick Setup configuration definition.
Parameter Syntax
$result = $client->updateConfigurationDefinition([ 'Id' => '<string>', // REQUIRED 'LocalDeploymentAdministrationRoleArn' => '<string>', 'LocalDeploymentExecutionRoleName' => '<string>', 'ManagerArn' => '<string>', // REQUIRED 'Parameters' => ['<string>', ...], 'TypeVersion' => '<string>', ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The ID of the configuration definition you want to update.
- LocalDeploymentAdministrationRoleArn
-
- Type: string
The ARN of the IAM role used to administrate local configuration deployments.
- LocalDeploymentExecutionRoleName
-
- Type: string
The name of the IAM role used to deploy local configurations.
- ManagerArn
-
- Required: Yes
- Type: string
The ARN of the configuration manager associated with the definition to update.
- Parameters
-
- Type: Associative array of custom strings keys (ConfigurationParametersMapKeyString) to strings
The parameters for the configuration definition type.
- TypeVersion
-
- Type: string
The version of the Quick Setup type to use.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
UpdateConfigurationManager
$result = $client->updateConfigurationManager
([/* ... */]); $promise = $client->updateConfigurationManagerAsync
([/* ... */]);
Updates a Quick Setup configuration manager.
Parameter Syntax
$result = $client->updateConfigurationManager([ 'Description' => '<string>', 'ManagerArn' => '<string>', // REQUIRED 'Name' => '<string>', ]);
Parameter Details
Members
- Description
-
- Type: string
A description of the configuration manager.
- ManagerArn
-
- Required: Yes
- Type: string
The ARN of the configuration manager.
- Name
-
- Type: string
A name for the configuration manager.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
- ResourceNotFoundException:
The resource couldn't be found. Check the ID or name and try again.
UpdateServiceSettings
$result = $client->updateServiceSettings
([/* ... */]); $promise = $client->updateServiceSettingsAsync
([/* ... */]);
Updates settings configured for Quick Setup.
Parameter Syntax
$result = $client->updateServiceSettings([ 'ExplorerEnablingRoleArn' => '<string>', ]);
Parameter Details
Members
- ExplorerEnablingRoleArn
-
- Type: string
The IAM role used to enable Explorer.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The request is invalid. Verify the values provided for the request parameters are accurate.
- ConflictException:
Another request is being processed. Wait a few minutes and try again.
- InternalServerException:
An error occurred on the server side.
- AccessDeniedException:
The requester has insufficient permissions to perform the operation.
- ThrottlingException:
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
Shapes
AccessDeniedException
Description
The requester has insufficient permissions to perform the operation.
Members
- Message
-
- Type: string
ConfigurationDefinition
Description
The definition of a Quick Setup configuration.
Members
- Id
-
- Type: string
The ID of the configuration definition.
- LocalDeploymentAdministrationRoleArn
-
- Type: string
The ARN of the IAM role used to administrate local configuration deployments.
- LocalDeploymentExecutionRoleName
-
- Type: string
The name of the IAM role used to deploy local configurations.
- Parameters
-
- Required: Yes
- Type: Associative array of custom strings keys (ConfigurationParametersMapKeyString) to strings
A list of key-value pairs containing the required parameters for the configuration type.
- Type
-
- Required: Yes
- Type: string
The type of the Quick Setup configuration.
- TypeVersion
-
- Type: string
The version of the Quick Setup type used.
ConfigurationDefinitionInput
Description
Defines the preferences and options for a configuration definition.
Members
- LocalDeploymentAdministrationRoleArn
-
- Type: string
The ARN of the IAM role used to administrate local configuration deployments.
- LocalDeploymentExecutionRoleName
-
- Type: string
The name of the IAM role used to deploy local configurations.
- Parameters
-
- Required: Yes
- Type: Associative array of custom strings keys (ConfigurationParametersMapKeyString) to strings
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)
-
-
DelegatedAccountId
-
Description: (Required) The ID of the delegated administrator account.
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Resource Scheduler (Type: Amazon Web ServicesQuickSetupType-Scheduler)
-
-
TargetTagKey
-
Description: (Required) The tag key assigned to the instances you want to target.
-
-
TargetTagValue
-
Description: (Required) The value of the tag key assigned to the instances you want to target.
-
-
ICalendarString
-
Description: (Required) An iCalendar formatted string containing the schedule you want Change Manager to use.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Default Host Management Configuration (Type: Amazon Web ServicesQuickSetupType-DHMC)
-
-
UpdateSSMAgent
-
Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is "
true
".
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Resource Explorer (Type: Amazon Web ServicesQuickSetupType-ResourceExplorer)
-
-
SelectedAggregatorRegion
-
Description: (Required) The Amazon Web Services Region where you want to create the aggregator index.
-
-
ReplaceExistingAggregator
-
Description: (Required) A boolean value that determines whether to demote an existing aggregator if it is in a Region that differs from the value you specify for the
SelectedAggregatorRegion
.
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Change Manager (Type: Amazon Web ServicesQuickSetupType-SSMChangeMgr)
-
-
DelegatedAccountId
-
Description: (Required) The ID of the delegated administrator account.
-
-
JobFunction
-
Description: (Required) The name for the Change Manager job function.
-
-
PermissionType
-
Description: (Optional) Specifies whether you want to use default administrator permissions for the job function role, or provide a custom IAM policy. The valid values are
CustomPermissions
andAdminPermissions
. The default value for the parameter isCustomerPermissions
.
-
-
CustomPermissions
-
Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify
CustomPermissions
for thePermissionType
parameter.
-
-
TargetOrganizationalUnits
-
Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- DevOps Guru (Type: Amazon Web ServicesQuickSetupType-DevOpsGuru)
-
-
AnalyseAllResources
-
Description: (Optional) A boolean value that determines whether DevOps Guru analyzes all CloudFormation stacks in the account. The default value is "
false
".
-
-
EnableSnsNotifications
-
Description: (Optional) A boolean value that determines whether DevOps Guru sends notifications when an insight is created. The default value is "
true
".
-
-
EnableSsmOpsItems
-
Description: (Optional) A boolean value that determines whether DevOps Guru creates an OpsCenter OpsItem when an insight is created. The default value is "
true
".
-
-
EnableDriftRemediation
-
Description: (Optional) A boolean value that determines whether a drift remediation schedule is used. The default value is "
false
".
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(14 days)
,rate(1 days)
, andnone
. The default value is "none
".
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Conformance Packs (Type: Amazon Web ServicesQuickSetupType-CFGCPacks)
-
-
DelegatedAccountId
-
Description: (Optional) The ID of the delegated administrator account. This parameter is required for Organization deployments.
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(14 days)
,rate(2 days)
, andnone
. The default value is "none
".
-
-
CPackNames
-
Description: (Required) A comma separated list of Config conformance packs.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Config Recording (Type: Amazon Web ServicesQuickSetupType-CFGRecording)
-
-
RecordAllResources
-
Description: (Optional) A boolean value that determines whether all supported resources are recorded. The default value is "
true
".
-
-
ResourceTypesToRecord
-
Description: (Optional) A comma separated list of resource types you want to record.
-
-
RecordGlobalResourceTypes
-
Description: (Optional) A boolean value that determines whether global resources are recorded with all resource configurations. The default value is "
false
".
-
-
GlobalResourceTypesRegion
-
Description: (Optional) Determines the Amazon Web Services Region where global resources are recorded.
-
-
UseCustomBucket
-
Description: (Optional) A boolean value that determines whether a custom Amazon S3 bucket is used for delivery. The default value is "
false
".
-
-
DeliveryBucketName
-
Description: (Optional) The name of the Amazon S3 bucket you want Config to deliver configuration snapshots and configuration history files to.
-
-
DeliveryBucketPrefix
-
Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.
-
-
NotificationOptions
-
Description: (Optional) Determines the notification configuration for the recorder. The valid values are
NoStreaming
,UseExistingTopic
, andCreateTopic
. The default value isNoStreaming
.
-
-
CustomDeliveryTopicAccountId
-
Description: (Optional) The ID of the Amazon Web Services account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the
UseExistingTopic
notification option.
-
-
CustomDeliveryTopicName
-
Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the
UseExistingTopic
notification option.
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(7 days)
,rate(1 days)
, andnone
. The default value is "none
".
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Host Management (Type: Amazon Web ServicesQuickSetupType-SSMHostMgmt)
-
-
UpdateSSMAgent
-
Description: (Optional) A boolean value that determines whether the SSM Agent is updated on the target instances every 2 weeks. The default value is "
true
".
-
-
UpdateEc2LaunchAgent
-
Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is "
false
".
-
-
CollectInventory
-
Description: (Optional) A boolean value that determines whether the EC2 Launch agent is updated on the target instances every month. The default value is "
true
".
-
-
ScanInstances
-
Description: (Optional) A boolean value that determines whether the target instances are scanned daily for available patches. The default value is "
true
".
-
-
InstallCloudWatchAgent
-
Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is installed on the target instances. The default value is "
false
".
-
-
UpdateCloudWatchAgent
-
Description: (Optional) A boolean value that determines whether the Amazon CloudWatch agent is updated on the target instances every month. The default value is "
false
".
-
-
IsPolicyAttachAllowed
-
Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is "
false
".
-
-
TargetType
-
Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are
*
,InstanceIds
,ResourceGroups
, andTags
. Use*
to target all instances in the account.
-
-
TargetInstances
-
Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify
InstanceIds
for theTargetType
parameter.
-
-
TargetTagKey
-
Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
TargetTagValue
-
Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
ResourceGroupName
-
Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify
ResourceGroups
for theTargetType
parameter.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Distributor (Type: Amazon Web ServicesQuickSetupType-Distributor)
-
-
PackagesToInstall
-
Description: (Required) A comma separated list of packages you want to install on the target instances. The valid values are
AWSEFSTools
,AWSCWAgent
, andAWSEC2LaunchAgent
.
-
-
RemediationSchedule
-
Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are
rate(30 days)
,rate(14 days)
,rate(2 days)
, andnone
. The default value is "rate(30 days)
".
-
-
IsPolicyAttachAllowed
-
Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is "
false
".
-
-
TargetType
-
Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are
*
,InstanceIds
,ResourceGroups
, andTags
. Use*
to target all instances in the account.
-
-
TargetInstances
-
Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify
InstanceIds
for theTargetType
parameter.
-
-
TargetTagKey
-
Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
TargetTagValue
-
Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
ResourceGroupName
-
Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify
ResourceGroups
for theTargetType
parameter.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Patch Policy (Type: Amazon Web ServicesQuickSetupType-PatchPolicy)
-
-
PatchPolicyName
-
Description: (Required) A name for the patch policy. The value you provide is applied to target Amazon EC2 instances as a tag.
-
-
SelectedPatchBaselines
-
Description: (Required) An array of JSON objects containing the information for the patch baselines to include in your patch policy.
-
-
PatchBaselineUseDefault
-
Description: (Optional) A boolean value that determines whether the selected patch baselines are all Amazon Web Services provided.
-
-
ConfigurationOptionsPatchOperation
-
Description: (Optional) Determines whether target instances scan for available patches, or scan and install available patches. The valid values are
Scan
andScanAndInstall
. The default value for the parameter isScan
.
-
-
ConfigurationOptionsScanValue
-
Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches.
-
-
ConfigurationOptionsInstallValue
-
Description: (Optional) A cron expression that is used as the schedule for when instances install available patches.
-
-
ConfigurationOptionsScanNextInterval
-
Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is "
false
".
-
-
ConfigurationOptionsInstallNextInterval
-
Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is "
false
".
-
-
RebootOption
-
Description: (Optional) Determines whether instances are rebooted after patches are installed. Valid values are
RebootIfNeeded
andNoReboot
.
-
-
IsPolicyAttachAllowed
-
Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is "
false
".
-
-
OutputLogEnableS3
-
Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3.
-
-
OutputS3Location
-
Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request.
-
OutputS3BucketRegion
-
Description: (Optional) The Amazon Web Services Region where the Amazon S3 bucket you want Config to deliver command output to is located.
-
-
OutputS3BucketName
-
Description: (Optional) The name of the Amazon S3 bucket you want Config to deliver command output to.
-
-
OutputS3KeyPrefix
-
Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket.
-
-
-
-
TargetType
-
Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are
*
,InstanceIds
,ResourceGroups
, andTags
. Use*
to target all instances in the account.
-
-
TargetInstances
-
Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify
InstanceIds
for theTargetType
parameter.
-
-
TargetTagKey
-
Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
TargetTagValue
-
Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify
Tags
for theTargetType
parameter.
-
-
ResourceGroupName
-
Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify
ResourceGroups
for theTargetType
parameter.
-
-
TargetAccounts
-
Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either
TargetAccounts
orTargetOrganizationalUnits
.
-
-
TargetOrganizationalUnits
-
Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to.
-
-
TargetRegions
-
Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to.
-
-
- Type
-
- Required: Yes
- Type: string
The type of the Quick Setup configuration.
- TypeVersion
-
- Type: string
The version of the Quick Setup type to use.
ConfigurationDefinitionSummary
Description
A summarized definition of a Quick Setup configuration definition.
Members
- FirstClassParameters
-
- Type: Associative array of custom strings keys (ConfigurationParametersMapKeyString) to strings
The common parameters and values for the configuration definition.
- Id
-
- Type: string
The ID of the configuration definition.
- Type
-
- Type: string
The type of the Quick Setup configuration used by the configuration definition.
- TypeVersion
-
- Type: string
The version of the Quick Setup type used by the configuration definition.
ConfigurationManagerSummary
Description
A summary of a Quick Setup configuration manager.
Members
- ConfigurationDefinitionSummaries
-
- Type: Array of ConfigurationDefinitionSummary structures
A summary of the Quick Setup configuration definition.
- Description
-
- Type: string
The description of the configuration.
- ManagerArn
-
- Required: Yes
- Type: string
The ARN of the Quick Setup configuration.
- Name
-
- Type: string
The name of the configuration
- StatusSummaries
-
- Type: Array of StatusSummary structures
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.
ConfigurationSummary
Description
Details for a Quick Setup configuration.
Members
- Account
-
- Type: string
The ID of the Amazon Web Services account where the configuration was deployed.
- ConfigurationDefinitionId
-
- Type: string
The ID of the configuration definition.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The datetime stamp when the configuration was created.
- FirstClassParameters
-
- Type: Associative array of custom strings keys (ConfigurationParametersMapKeyString) to strings
The common parameters and values for the configuration definition.
- Id
-
- Type: string
A service generated identifier for the configuration.
- ManagerArn
-
- Type: string
The ARN of the configuration manager.
- Region
-
- Type: string
The Amazon Web Services Region where the configuration was deployed.
- StatusSummaries
-
- Type: Array of StatusSummary structures
A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more.
- Type
-
- Type: string
The type of the Quick Setup configuration.
- TypeVersion
-
- Type: string
The version of the Quick Setup type used.
ConflictException
Description
Another request is being processed. Wait a few minutes and try again.
Members
- Message
-
- Type: string
Filter
Description
A key-value pair to filter results.
Members
- Key
-
- Required: Yes
- Type: string
The key for the filter.
- Values
-
- Required: Yes
- Type: Array of strings
The values for the filter keys.
InternalServerException
Description
An error occurred on the server side.
Members
- Message
-
- Type: string
QuickSetupTypeOutput
Description
Information about the Quick Setup type.
Members
- LatestVersion
-
- Type: string
The latest version number of the configuration.
- Type
-
- Type: string
The type of the Quick Setup configuration.
ResourceNotFoundException
Description
The resource couldn't be found. Check the ID or name and try again.
Members
- Message
-
- Type: string
ServiceSettings
Description
Settings configured for Quick Setup.
Members
- ExplorerEnablingRoleArn
-
- Type: string
The IAM role used to enable Explorer.
StatusSummary
Description
A summarized description of the status.
Members
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The datetime stamp when the status was last updated.
- Status
-
- Type: string
The current status.
- StatusDetails
-
- Type: Associative array of custom strings keys (String) to strings
Details about the status.
- StatusMessage
-
- Type: string
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
-
- Required: Yes
- Type: string
The type of a status summary.
TagEntry
Description
Key-value pairs of metadata.
Members
- Key
-
- Type: string
The key for the tag.
- Value
-
- Type: string
The value for the tag.
ThrottlingException
Description
The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.
Members
- Message
-
- Required: Yes
- Type: string
ValidationException
Description
The request is invalid. Verify the values provided for the request parameters are accurate.
Members
- Message
-
- Type: string