ServiceSetting
The service setting data structure.
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 operation to
change the default setting. Or, use the ResetServiceSetting to change the value
back to the original value defined by the AWS service team.
Contents
- ARN
-
The ARN of the service setting.
Type: String
Required: No
- LastModifiedDate
-
The last time the service setting was modified.
Type: Timestamp
Required: No
- LastModifiedUser
-
The ARN of the last modified user. This field is populated only if the setting value was overwritten.
Type: String
Required: No
- SettingId
-
The ID of the service setting.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
- SettingValue
-
The value of the service setting.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- Status
-
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.
Type: String
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
