2019/03/04 - Amazon Simple Systems Manager (SSM) - 3 new api methods
Changes This release updates AWS Systems Manager APIs to support service settings for AWS customers. A service setting is a key-value pair that defines how a user interacts with or uses an AWS service, and is typically created and consumed by the AWS service team. AWS customers can read a service setting via GetServiceSetting API and update the setting via UpdateServiceSetting API or ResetServiceSetting API, which are introduced in this release. For example, if an AWS service charges money to the account based on a feature or service usage, then the AWS service team might create a setting with the default value of "false". This means the user can't use this feature unless they update the setting to "true" and intentionally opt in for a paid feature.
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId . You can't create a new SettingId , but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.
Update the service setting for the account.
See also: AWS API Documentation
Request Syntax
client.update_service_setting(
SettingId='string',
SettingValue='string'
)
string
[REQUIRED]
The ID of the service setting to update.
string
[REQUIRED]
The new value to specify for the service setting.
dict
Response Syntax
{}
Response Structure
(dict) --
The result body of the UpdateServiceSetting API action.
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId . You can't create a new SettingId , but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
See also: AWS API Documentation
Request Syntax
client.reset_service_setting(
SettingId='string'
)
string
[REQUIRED]
The ID of the service setting to reset.
dict
Response Syntax
{
'ServiceSetting': {
'SettingId': 'string',
'SettingValue': 'string',
'LastModifiedDate': datetime(2015, 1, 1),
'LastModifiedUser': 'string',
'ARN': 'string',
'Status': 'string'
}
}
Response Structure
(dict) --
The result body of the ResetServiceSetting API action.
ServiceSetting (dict) --
The current, effective service setting after calling the ResetServiceSetting API action.
SettingId (string) --
The ID of the service setting.
SettingValue (string) --
The value of the service setting.
LastModifiedDate (datetime) --
The last time the service setting was modified.
LastModifiedUser (string) --
The ARN of the last modified user. This field is populated only if the setting value was overwritten.
ARN (string) --
The ARN of the service setting.
Status (string) --
The status of the service setting. The value can be Default, Customized or PendingUpdate.
Default: The current setting uses a default value provisioned by the AWS service team.
Customized: The current setting use a custom value specified by the customer.
PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId . You can't create a new SettingId , but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
See also: AWS API Documentation
Request Syntax
client.get_service_setting(
SettingId='string'
)
string
[REQUIRED]
The ID of the service setting to get.
dict
Response Syntax
{
'ServiceSetting': {
'SettingId': 'string',
'SettingValue': 'string',
'LastModifiedDate': datetime(2015, 1, 1),
'LastModifiedUser': 'string',
'ARN': 'string',
'Status': 'string'
}
}
Response Structure
(dict) --
The query result body of the GetServiceSetting API action.
ServiceSetting (dict) --
The query result of the current service setting.
SettingId (string) --
The ID of the service setting.
SettingValue (string) --
The value of the service setting.
LastModifiedDate (datetime) --
The last time the service setting was modified.
LastModifiedUser (string) --
The ARN of the last modified user. This field is populated only if the setting value was overwritten.
ARN (string) --
The ARN of the service setting.
Status (string) --
The status of the service setting. The value can be Default, Customized or PendingUpdate.
Default: The current setting uses a default value provisioned by the AWS service team.
Customized: The current setting use a custom value specified by the customer.
PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.