SystemsManagerQuickSetup ************************ Client ====== class SystemsManagerQuickSetup.Client A low-level client representing AWS Systems Manager QuickSetup Quick Setup helps you quickly configure frequently used services and features with recommended best practices. Quick Setup simplifies setting up services, including Systems Manager, by automating common or recommended tasks. import boto3 client = boto3.client('ssm-quicksetup') These are the available methods: * can_paginate * close * create_configuration_manager * delete_configuration_manager * get_configuration * get_configuration_manager * get_paginator * get_service_settings * get_waiter * list_configuration_managers * list_configurations * list_quick_setup_types * list_tags_for_resource * tag_resource * untag_resource * update_configuration_definition * update_configuration_manager * update_service_settings Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListConfigurationManagers * ListConfigurations SystemsManagerQuickSetup / Paginator / ListConfigurationManagers ListConfigurationManagers ************************* class SystemsManagerQuickSetup.Paginator.ListConfigurationManagers paginator = client.get_paginator('list_configuration_managers') paginate(**kwargs) Creates an iterator that will paginate through responses from "SystemsManagerQuickSetup.Client.list_configuration_managers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Filters=[ { 'Key': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Filters** (*list*) -- Filters the results returned by the request. * *(dict) --* A key-value pair to filter results. * **Key** *(string) --* **[REQUIRED]** The key for the filter. * **Values** *(list) --* **[REQUIRED]** The values for the filter keys. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ConfigurationManagersList': [ { 'ConfigurationDefinitionSummaries': [ { 'FirstClassParameters': { 'string': 'string' }, 'Id': 'string', 'Type': 'string', 'TypeVersion': 'string' }, ], 'Description': 'string', 'ManagerArn': 'string', 'Name': 'string', 'StatusSummaries': [ { 'LastUpdatedAt': datetime(2015, 1, 1), 'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE', 'StatusDetails': { 'string': 'string' }, 'StatusMessage': 'string', 'StatusType': 'Deployment'|'AsyncExecutions' }, ] }, ], } **Response Structure** * *(dict) --* * **ConfigurationManagersList** *(list) --* The configuration managers returned by the request. * *(dict) --* A summary of a Quick Setup configuration manager. * **ConfigurationDefinitionSummaries** *(list) --* A summary of the Quick Setup configuration definition. * *(dict) --* A summarized definition of a Quick Setup configuration definition. * **FirstClassParameters** *(dict) --* The common parameters and values for the configuration definition. * *(string) --* * *(string) --* * **Id** *(string) --* The ID of the configuration definition. * **Type** *(string) --* The type of the Quick Setup configuration used by the configuration definition. * **TypeVersion** *(string) --* The version of the Quick Setup type used by the configuration definition. * **Description** *(string) --* The description of the configuration. * **ManagerArn** *(string) --* The ARN of the Quick Setup configuration. * **Name** *(string) --* The name of the configuration * **StatusSummaries** *(list) --* 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. * *(dict) --* A summarized description of the status. * **LastUpdatedAt** *(datetime) --* The datetime stamp when the status was last updated. * **Status** *(string) --* The current status. * **StatusDetails** *(dict) --* Details about the status. * *(string) --* * *(string) --* * **StatusMessage** *(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** *(string) --* The type of a status summary. SystemsManagerQuickSetup / Paginator / ListConfigurations ListConfigurations ****************** class SystemsManagerQuickSetup.Paginator.ListConfigurations paginator = client.get_paginator('list_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "SystemsManagerQuickSetup.Client.list_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ConfigurationDefinitionId='string', Filters=[ { 'Key': 'string', 'Values': [ 'string', ] }, ], ManagerArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ConfigurationDefinitionId** (*string*) -- The ID of the configuration definition. * **Filters** (*list*) -- Filters the results returned by the request. * *(dict) --* A key-value pair to filter results. * **Key** *(string) --* **[REQUIRED]** The key for the filter. * **Values** *(list) --* **[REQUIRED]** The values for the filter keys. * *(string) --* * **ManagerArn** (*string*) -- The ARN of the configuration manager. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ConfigurationsList': [ { 'Account': 'string', 'ConfigurationDefinitionId': 'string', 'CreatedAt': datetime(2015, 1, 1), 'FirstClassParameters': { 'string': 'string' }, 'Id': 'string', 'ManagerArn': 'string', 'Region': 'string', 'StatusSummaries': [ { 'LastUpdatedAt': datetime(2015, 1, 1), 'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE', 'StatusDetails': { 'string': 'string' }, 'StatusMessage': 'string', 'StatusType': 'Deployment'|'AsyncExecutions' }, ], 'Type': 'string', 'TypeVersion': 'string' }, ], } **Response Structure** * *(dict) --* * **ConfigurationsList** *(list) --* An array of configurations. * *(dict) --* Details for a Quick Setup configuration. * **Account** *(string) --* The ID of the Amazon Web Services account where the configuration was deployed. * **ConfigurationDefinitionId** *(string) --* The ID of the configuration definition. * **CreatedAt** *(datetime) --* The datetime stamp when the configuration was created. * **FirstClassParameters** *(dict) --* The common parameters and values for the configuration definition. * *(string) --* * *(string) --* * **Id** *(string) --* A service generated identifier for the configuration. * **ManagerArn** *(string) --* The ARN of the configuration manager. * **Region** *(string) --* The Amazon Web Services Region where the configuration was deployed. * **StatusSummaries** *(list) --* A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more. * *(dict) --* A summarized description of the status. * **LastUpdatedAt** *(datetime) --* The datetime stamp when the status was last updated. * **Status** *(string) --* The current status. * **StatusDetails** *(dict) --* Details about the status. * *(string) --* * *(string) --* * **StatusMessage** *(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** *(string) --* The type of a status summary. * **Type** *(string) --* The type of the Quick Setup configuration. * **TypeVersion** *(string) --* The version of the Quick Setup type used. SystemsManagerQuickSetup / Client / list_configuration_managers list_configuration_managers *************************** SystemsManagerQuickSetup.Client.list_configuration_managers(**kwargs) Returns Quick Setup configuration managers. See also: AWS API Documentation **Request Syntax** response = client.list_configuration_managers( Filters=[ { 'Key': 'string', 'Values': [ 'string', ] }, ], MaxItems=123, StartingToken='string' ) Parameters: * **Filters** (*list*) -- Filters the results returned by the request. * *(dict) --* A key-value pair to filter results. * **Key** *(string) --* **[REQUIRED]** The key for the filter. * **Values** *(list) --* **[REQUIRED]** The values for the filter keys. * *(string) --* * **MaxItems** (*integer*) -- Specifies the maximum number of configuration managers that are returned by the request. * **StartingToken** (*string*) -- The token to use when requesting a specific set of items from a list. Return type: dict Returns: **Response Syntax** { 'ConfigurationManagersList': [ { 'ConfigurationDefinitionSummaries': [ { 'FirstClassParameters': { 'string': 'string' }, 'Id': 'string', 'Type': 'string', 'TypeVersion': 'string' }, ], 'Description': 'string', 'ManagerArn': 'string', 'Name': 'string', 'StatusSummaries': [ { 'LastUpdatedAt': datetime(2015, 1, 1), 'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE', 'StatusDetails': { 'string': 'string' }, 'StatusMessage': 'string', 'StatusType': 'Deployment'|'AsyncExecutions' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ConfigurationManagersList** *(list) --* The configuration managers returned by the request. * *(dict) --* A summary of a Quick Setup configuration manager. * **ConfigurationDefinitionSummaries** *(list) --* A summary of the Quick Setup configuration definition. * *(dict) --* A summarized definition of a Quick Setup configuration definition. * **FirstClassParameters** *(dict) --* The common parameters and values for the configuration definition. * *(string) --* * *(string) --* * **Id** *(string) --* The ID of the configuration definition. * **Type** *(string) --* The type of the Quick Setup configuration used by the configuration definition. * **TypeVersion** *(string) --* The version of the Quick Setup type used by the configuration definition. * **Description** *(string) --* The description of the configuration. * **ManagerArn** *(string) --* The ARN of the Quick Setup configuration. * **Name** *(string) --* The name of the configuration * **StatusSummaries** *(list) --* 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. * *(dict) --* A summarized description of the status. * **LastUpdatedAt** *(datetime) --* The datetime stamp when the status was last updated. * **Status** *(string) --* The current status. * **StatusDetails** *(dict) --* Details about the status. * *(string) --* * *(string) --* * **StatusMessage** *(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** *(string) --* The type of a status summary. * **NextToken** *(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. **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" SystemsManagerQuickSetup / Client / get_paginator get_paginator ************* SystemsManagerQuickSetup.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. SystemsManagerQuickSetup / Client / list_quick_setup_types list_quick_setup_types ********************** SystemsManagerQuickSetup.Client.list_quick_setup_types() Returns the available Quick Setup types. See also: AWS API Documentation **Request Syntax** response = client.list_quick_setup_types() Return type: dict Returns: **Response Syntax** { 'QuickSetupTypeList': [ { 'LatestVersion': 'string', 'Type': 'string' }, ] } **Response Structure** * *(dict) --* * **QuickSetupTypeList** *(list) --* An array of Quick Setup types. * *(dict) --* Information about the Quick Setup type. * **LatestVersion** *(string) --* The latest version number of the configuration. * **Type** *(string) --* The type of the Quick Setup configuration. **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" SystemsManagerQuickSetup / Client / can_paginate can_paginate ************ SystemsManagerQuickSetup.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. SystemsManagerQuickSetup / Client / list_configurations list_configurations ******************* SystemsManagerQuickSetup.Client.list_configurations(**kwargs) Returns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.list_configurations( ConfigurationDefinitionId='string', Filters=[ { 'Key': 'string', 'Values': [ 'string', ] }, ], ManagerArn='string', MaxItems=123, StartingToken='string' ) Parameters: * **ConfigurationDefinitionId** (*string*) -- The ID of the configuration definition. * **Filters** (*list*) -- Filters the results returned by the request. * *(dict) --* A key-value pair to filter results. * **Key** *(string) --* **[REQUIRED]** The key for the filter. * **Values** *(list) --* **[REQUIRED]** The values for the filter keys. * *(string) --* * **ManagerArn** (*string*) -- The ARN of the configuration manager. * **MaxItems** (*integer*) -- Specifies the maximum number of configurations that are returned by the request. * **StartingToken** (*string*) -- The token to use when requesting a specific set of items from a list. Return type: dict Returns: **Response Syntax** { 'ConfigurationsList': [ { 'Account': 'string', 'ConfigurationDefinitionId': 'string', 'CreatedAt': datetime(2015, 1, 1), 'FirstClassParameters': { 'string': 'string' }, 'Id': 'string', 'ManagerArn': 'string', 'Region': 'string', 'StatusSummaries': [ { 'LastUpdatedAt': datetime(2015, 1, 1), 'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE', 'StatusDetails': { 'string': 'string' }, 'StatusMessage': 'string', 'StatusType': 'Deployment'|'AsyncExecutions' }, ], 'Type': 'string', 'TypeVersion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ConfigurationsList** *(list) --* An array of configurations. * *(dict) --* Details for a Quick Setup configuration. * **Account** *(string) --* The ID of the Amazon Web Services account where the configuration was deployed. * **ConfigurationDefinitionId** *(string) --* The ID of the configuration definition. * **CreatedAt** *(datetime) --* The datetime stamp when the configuration was created. * **FirstClassParameters** *(dict) --* The common parameters and values for the configuration definition. * *(string) --* * *(string) --* * **Id** *(string) --* A service generated identifier for the configuration. * **ManagerArn** *(string) --* The ARN of the configuration manager. * **Region** *(string) --* The Amazon Web Services Region where the configuration was deployed. * **StatusSummaries** *(list) --* A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more. * *(dict) --* A summarized description of the status. * **LastUpdatedAt** *(datetime) --* The datetime stamp when the status was last updated. * **Status** *(string) --* The current status. * **StatusDetails** *(dict) --* Details about the status. * *(string) --* * *(string) --* * **StatusMessage** *(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** *(string) --* The type of a status summary. * **Type** *(string) --* The type of the Quick Setup configuration. * **TypeVersion** *(string) --* The version of the Quick Setup type used. * **NextToken** *(string) --* The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / update_configuration_definition update_configuration_definition ******************************* SystemsManagerQuickSetup.Client.update_configuration_definition(**kwargs) Updates a Quick Setup configuration definition. See also: AWS API Documentation **Request Syntax** response = client.update_configuration_definition( Id='string', LocalDeploymentAdministrationRoleArn='string', LocalDeploymentExecutionRoleName='string', ManagerArn='string', Parameters={ 'string': 'string' }, TypeVersion='string' ) Parameters: * **Id** (*string*) -- **[REQUIRED]** The ID of the configuration definition you want to update. * **LocalDeploymentAdministrationRoleArn** (*string*) -- The ARN of the IAM role used to administrate local configuration deployments. * **LocalDeploymentExecutionRoleName** (*string*) -- The name of the IAM role used to deploy local configurations. * **ManagerArn** (*string*) -- **[REQUIRED]** The ARN of the configuration manager associated with the definition to update. * **Parameters** (*dict*) -- The parameters for the configuration definition type. * *(string) --* * *(string) --* * **TypeVersion** (*string*) -- The version of the Quick Setup type to use. Returns: None **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / list_tags_for_resource list_tags_for_resource ********************** SystemsManagerQuickSetup.Client.list_tags_for_resource(**kwargs) Returns tags assigned to the resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource the tag is assigned to. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* Key-value pairs of metadata assigned to the resource. * *(dict) --* Key-value pairs of metadata. * **Key** *(string) --* The key for the tag. * **Value** *(string) --* The value for the tag. **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / get_configuration get_configuration ***************** SystemsManagerQuickSetup.Client.get_configuration(**kwargs) Returns details about the specified configuration. See also: AWS API Documentation **Request Syntax** response = client.get_configuration( ConfigurationId='string' ) Parameters: **ConfigurationId** (*string*) -- **[REQUIRED]** A service generated identifier for the configuration. Return type: dict Returns: **Response Syntax** { 'Account': 'string', 'ConfigurationDefinitionId': 'string', 'CreatedAt': datetime(2015, 1, 1), 'Id': 'string', 'LastModifiedAt': datetime(2015, 1, 1), 'ManagerArn': 'string', 'Parameters': { 'string': 'string' }, 'Region': 'string', 'StatusSummaries': [ { 'LastUpdatedAt': datetime(2015, 1, 1), 'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE', 'StatusDetails': { 'string': 'string' }, 'StatusMessage': 'string', 'StatusType': 'Deployment'|'AsyncExecutions' }, ], 'Type': 'string', 'TypeVersion': 'string' } **Response Structure** * *(dict) --* * **Account** *(string) --* The ID of the Amazon Web Services account where the configuration was deployed. * **ConfigurationDefinitionId** *(string) --* The ID of the configuration definition. * **CreatedAt** *(datetime) --* The datetime stamp when the configuration manager was created. * **Id** *(string) --* A service generated identifier for the configuration. * **LastModifiedAt** *(datetime) --* The datetime stamp when the configuration manager was last updated. * **ManagerArn** *(string) --* The ARN of the configuration manager. * **Parameters** *(dict) --* The parameters for the configuration definition type. * *(string) --* * *(string) --* * **Region** *(string) --* The Amazon Web Services Region where the configuration was deployed. * **StatusSummaries** *(list) --* A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more. * *(dict) --* A summarized description of the status. * **LastUpdatedAt** *(datetime) --* The datetime stamp when the status was last updated. * **Status** *(string) --* The current status. * **StatusDetails** *(dict) --* Details about the status. * *(string) --* * *(string) --* * **StatusMessage** *(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** *(string) --* The type of a status summary. * **Type** *(string) --* The type of the Quick Setup configuration. * **TypeVersion** *(string) --* The version of the Quick Setup type used. **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / untag_resource untag_resource ************** SystemsManagerQuickSetup.Client.untag_resource(**kwargs) Removes tags from the specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource to remove tags from. * **TagKeys** (*list*) -- **[REQUIRED]** The keys of the tags to remove from the resource. * *(string) --* Returns: None **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / get_configuration_manager get_configuration_manager ************************* SystemsManagerQuickSetup.Client.get_configuration_manager(**kwargs) Returns a configuration manager. See also: AWS API Documentation **Request Syntax** response = client.get_configuration_manager( ManagerArn='string' ) Parameters: **ManagerArn** (*string*) -- **[REQUIRED]** The ARN of the configuration manager. Return type: dict Returns: **Response Syntax** { 'ConfigurationDefinitions': [ { 'Id': 'string', 'LocalDeploymentAdministrationRoleArn': 'string', 'LocalDeploymentExecutionRoleName': 'string', 'Parameters': { 'string': 'string' }, 'Type': 'string', 'TypeVersion': 'string' }, ], 'CreatedAt': datetime(2015, 1, 1), 'Description': 'string', 'LastModifiedAt': datetime(2015, 1, 1), 'ManagerArn': 'string', 'Name': 'string', 'StatusSummaries': [ { 'LastUpdatedAt': datetime(2015, 1, 1), 'Status': 'INITIALIZING'|'DEPLOYING'|'SUCCEEDED'|'DELETING'|'STOPPING'|'FAILED'|'STOPPED'|'DELETE_FAILED'|'STOP_FAILED'|'NONE', 'StatusDetails': { 'string': 'string' }, 'StatusMessage': 'string', 'StatusType': 'Deployment'|'AsyncExecutions' }, ], 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **ConfigurationDefinitions** *(list) --* The configuration definitions association with the configuration manager. * *(dict) --* The definition of a Quick Setup configuration. * **Id** *(string) --* The ID of the configuration definition. * **LocalDeploymentAdministrationRoleArn** *(string) --* The ARN of the IAM role used to administrate local configuration deployments. * **LocalDeploymentExecutionRoleName** *(string) --* The name of the IAM role used to deploy local configurations. * **Parameters** *(dict) --* A list of key-value pairs containing the required parameters for the configuration type. * *(string) --* * *(string) --* * **Type** *(string) --* The type of the Quick Setup configuration. * **TypeVersion** *(string) --* The version of the Quick Setup type used. * **CreatedAt** *(datetime) --* The datetime stamp when the configuration manager was created. * **Description** *(string) --* The description of the configuration manager. * **LastModifiedAt** *(datetime) --* The datetime stamp when the configuration manager was last updated. * **ManagerArn** *(string) --* The ARN of the configuration manager. * **Name** *(string) --* The name of the configuration manager. * **StatusSummaries** *(list) --* A summary of the state of the configuration manager. This includes deployment statuses, association statuses, drift statuses, health checks, and more. * *(dict) --* A summarized description of the status. * **LastUpdatedAt** *(datetime) --* The datetime stamp when the status was last updated. * **Status** *(string) --* The current status. * **StatusDetails** *(dict) --* Details about the status. * *(string) --* * *(string) --* * **StatusMessage** *(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** *(string) --* The type of a status summary. * **Tags** *(dict) --* Key-value pairs of metadata to assign to the configuration manager. * *(string) --* * *(string) --* **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / get_waiter get_waiter ********** SystemsManagerQuickSetup.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" SystemsManagerQuickSetup / Client / update_service_settings update_service_settings *********************** SystemsManagerQuickSetup.Client.update_service_settings(**kwargs) Updates settings configured for Quick Setup. See also: AWS API Documentation **Request Syntax** response = client.update_service_settings( ExplorerEnablingRoleArn='string' ) Parameters: **ExplorerEnablingRoleArn** (*string*) -- The IAM role used to enable Explorer. Returns: None **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" SystemsManagerQuickSetup / Client / create_configuration_manager create_configuration_manager **************************** SystemsManagerQuickSetup.Client.create_configuration_manager(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_configuration_manager( ConfigurationDefinitions=[ { 'LocalDeploymentAdministrationRoleArn': 'string', 'LocalDeploymentExecutionRoleName': 'string', 'Parameters': { 'string': 'string' }, 'Type': 'string', 'TypeVersion': 'string' }, ], Description='string', Name='string', Tags={ 'string': 'string' } ) Parameters: * **ConfigurationDefinitions** (*list*) -- **[REQUIRED]** The definition of the Quick Setup configuration that the configuration manager deploys. * *(dict) --* Defines the preferences and options for a configuration definition. * **LocalDeploymentAdministrationRoleArn** *(string) --* The ARN of the IAM role used to administrate local configuration deployments. * **LocalDeploymentExecutionRoleName** *(string) --* The name of the IAM role used to deploy local configurations. * **Parameters** *(dict) --* **[REQUIRED]** 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" or "TargetOrganizationalUnits". * "TargetOrganizationalUnits" * Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. 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" and "AdminPermissions". The default value for the parameter is "CustomerPermissions". * "CustomPermissions" * Description: (Optional) A JSON string containing the IAM policy you want your job function to use. You must provide a value for this parameter if you specify "CustomPermissions" for the "PermissionType" parameter. * "TargetOrganizationalUnits" * Description: (Required) A comma separated list of organizational units (OUs) you want to deploy the configuration to. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. 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)", and "none". The default value is " "none"". * "TargetAccounts" * Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either "TargetAccounts" or "TargetOrganizationalUnits". * "TargetOrganizationalUnits" * Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. 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)", and "none". The default value is " "none"". * "CPackNames" * Description: (Required) A comma separated list of Config conformance packs. * "TargetAccounts" * Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either "TargetAccounts" or "TargetOrganizationalUnits". * "TargetOrganizationalUnits" * Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. 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", and "CreateTopic". The default value is "NoStreaming". * "CustomDeliveryTopicAccountId" * Description: (Optional) The ID of the Amazon Web Services account where the Amazon SNS topic you want to use for notifications resides. You must specify a value for this parameter if you use the "UseExistingTopic" notification option. * "CustomDeliveryTopicName" * Description: (Optional) The name of the Amazon SNS topic you want to use for notifications. You must specify a value for this parameter if you use the "UseExistingTopic" notification option. * "RemediationSchedule" * Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are "rate(30 days)", "rate(7 days)", "rate(1 days)", and "none". The default value is " "none"". * "TargetAccounts" * Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either "TargetAccounts" or "TargetOrganizationalUnits". * "TargetOrganizationalUnits" * Description: (Optional) The ID of the root of your Organization. This configuration type doesn't currently support choosing specific OUs. The configuration will be deployed to all the OUs in the Organization. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. 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", and "Tags". Use "*" to target all instances in the account. * "TargetInstances" * Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify "InstanceIds" for the "TargetType" parameter. * "TargetTagKey" * Description: (Optional) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify "Tags" for the "TargetType" parameter. * "TargetTagValue" * Description: (Optional) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify "Tags" for the "TargetType" parameter. * "ResourceGroupName" * Description: (Optional) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify "ResourceGroups" for the "TargetType" parameter. * "TargetAccounts" * Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either "TargetAccounts" or "TargetOrganizationalUnits". * "TargetOrganizationalUnits" * Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. 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", and "AWSEC2LaunchAgent". * "RemediationSchedule" * Description: (Optional) A rate expression that defines the schedule for drift remediation. The valid values are "rate(30 days)", "rate(14 days)", "rate(2 days)", and "none". The default value is " "rate(30 days)"". * "IsPolicyAttachAllowed" * Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " "false"". * "TargetType" * Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are "*", "InstanceIds", "ResourceGroups", and "Tags". Use "*" to target all instances in the account. * "TargetInstances" * Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify "InstanceIds" for the "TargetType" parameter. * "TargetTagKey" * Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify "Tags" for the "TargetType" parameter. * "TargetTagValue" * Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify "Tags" for the "TargetType" parameter. * "ResourceGroupName" * Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify "ResourceGroups" for the "TargetType" parameter. * "TargetAccounts" * Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either "TargetAccounts" or "TargetOrganizationalUnits". * "TargetOrganizationalUnits" * Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. 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" and "ScanAndInstall". The default value for the parameter is "Scan". * "ConfigurationOptionsScanValue" * Description: (Optional) A cron expression that is used as the schedule for when instances scan for available patches. * "ConfigurationOptionsInstallValue" * Description: (Optional) A cron expression that is used as the schedule for when instances install available patches. * "ConfigurationOptionsScanNextInterval" * Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " "false"". * "ConfigurationOptionsInstallNextInterval" * Description: (Optional) A boolean value that determines whether instances should scan for available patches at the next cron interval. The default value is " "false"". * "RebootOption" * Description: (Optional) Determines whether instances are rebooted after patches are installed. Valid values are "RebootIfNeeded" and "NoReboot". * "IsPolicyAttachAllowed" * Description: (Optional) A boolean value that determines whether Quick Setup attaches policies to instances profiles already associated with the target instances. The default value is " "false"". * "OutputLogEnableS3" * Description: (Optional) A boolean value that determines whether command output logs are sent to Amazon S3. * "OutputS3Location" * Description: (Optional) A JSON string containing information about the Amazon S3 bucket where you want to store the output details of the request. * "OutputS3BucketRegion" * Description: (Optional) The Amazon Web Services Region where the Amazon S3 bucket you want Config to deliver command output to is located. * "OutputS3BucketName" * Description: (Optional) The name of the Amazon S3 bucket you want Config to deliver command output to. * "OutputS3KeyPrefix" * Description: (Optional) The key prefix you want to use in the custom Amazon S3 bucket. * "TargetType" * Description: (Optional) Determines how instances are targeted for local account deployments. Don't specify a value for this parameter if you're deploying to OUs. The valid values are "*", "InstanceIds", "ResourceGroups", and "Tags". Use "*" to target all instances in the account. * "TargetInstances" * Description: (Optional) A comma separated list of instance IDs. You must provide a value for this parameter if you specify "InstanceIds" for the "TargetType" parameter. * "TargetTagKey" * Description: (Required) The tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify "Tags" for the "TargetType" parameter. * "TargetTagValue" * Description: (Required) The value of the tag key assigned to the instances you want to target. You must provide a value for this parameter if you specify "Tags" for the "TargetType" parameter. * "ResourceGroupName" * Description: (Required) The name of the resource group associated with the instances you want to target. You must provide a value for this parameter if you specify "ResourceGroups" for the "TargetType" parameter. * "TargetAccounts" * Description: (Optional) The ID of the Amazon Web Services account initiating the configuration deployment. You only need to provide a value for this parameter if you want to deploy the configuration locally. A value must be provided for either "TargetAccounts" or "TargetOrganizationalUnits". * "TargetOrganizationalUnits" * Description: (Optional) A comma separated list of organizational units (OUs) you want to deploy the configuration to. * "TargetRegions" * Description: (Required) A comma separated list of Amazon Web Services Regions you want to deploy the configuration to. * *(string) --* * *(string) --* * **Type** *(string) --* **[REQUIRED]** The type of the Quick Setup configuration. * **TypeVersion** *(string) --* The version of the Quick Setup type to use. * **Description** (*string*) -- A description of the configuration manager. * **Name** (*string*) -- A name for the configuration manager. * **Tags** (*dict*) -- Key-value pairs of metadata to assign to the configuration manager. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ManagerArn': 'string' } **Response Structure** * *(dict) --* * **ManagerArn** *(string) --* The ARN for the newly created configuration manager. **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" SystemsManagerQuickSetup / Client / close close ***** SystemsManagerQuickSetup.Client.close() Closes underlying endpoint connections. SystemsManagerQuickSetup / Client / delete_configuration_manager delete_configuration_manager **************************** SystemsManagerQuickSetup.Client.delete_configuration_manager(**kwargs) Deletes a configuration manager. See also: AWS API Documentation **Request Syntax** response = client.delete_configuration_manager( ManagerArn='string' ) Parameters: **ManagerArn** (*string*) -- **[REQUIRED]** The ID of the configuration manager. Returns: None **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / get_service_settings get_service_settings ******************** SystemsManagerQuickSetup.Client.get_service_settings() Returns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.get_service_settings() Return type: dict Returns: **Response Syntax** { 'ServiceSettings': { 'ExplorerEnablingRoleArn': 'string' } } **Response Structure** * *(dict) --* * **ServiceSettings** *(dict) --* Returns details about the settings for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region. * **ExplorerEnablingRoleArn** *(string) --* The IAM role used to enable Explorer. **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" SystemsManagerQuickSetup / Client / tag_resource tag_resource ************ SystemsManagerQuickSetup.Client.tag_resource(**kwargs) Assigns key-value pairs of metadata to Amazon Web Services resources. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource to tag. * **Tags** (*dict*) -- **[REQUIRED]** Key-value pairs of metadata to assign to the resource. * *(string) --* * *(string) --* Returns: None **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption" SystemsManagerQuickSetup / Client / update_configuration_manager update_configuration_manager **************************** SystemsManagerQuickSetup.Client.update_configuration_manager(**kwargs) Updates a Quick Setup configuration manager. See also: AWS API Documentation **Request Syntax** response = client.update_configuration_manager( Description='string', ManagerArn='string', Name='string' ) Parameters: * **Description** (*string*) -- A description of the configuration manager. * **ManagerArn** (*string*) -- **[REQUIRED]** The ARN of the configuration manager. * **Name** (*string*) -- A name for the configuration manager. Returns: None **Exceptions** * "SystemsManagerQuickSetup.Client.exceptions.ValidationException" * "SystemsManagerQuickSetup.Client.exceptions.ConflictException" * "SystemsManagerQuickSetup.Client.exceptions.InternalServerExcept ion" * "SystemsManagerQuickSetup.Client.exceptions.AccessDeniedExceptio n" * "SystemsManagerQuickSetup.Client.exceptions.ThrottlingException" * "SystemsManagerQuickSetup.Client.exceptions.ResourceNotFoundExce ption"