AWS Systems Manager
API Reference (API Version 2014-11-06)
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

GetServiceSetting

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.

Request Syntax

{ "SettingId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

SettingId

The ID of the service setting to get.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

Response Syntax

{ "ServiceSetting": { "ARN": "string", "LastModifiedDate": number, "LastModifiedUser": "string", "SettingId": "string", "SettingValue": "string", "Status": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ServiceSetting

The query result of the current service setting.

Type: ServiceSetting object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

ServiceSettingNotFound

The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: