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 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.

Query the current service setting for the AWS 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.

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.

Errors

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

Examples

Example

This example illustrates one usage of GetServiceSetting.

Sample Request

POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.GetServiceSetting
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240324T203339Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 54

{
    "SettingId": "/ssm/managed-instance/activation-tier"
}

Sample Response

{
    "ServiceSetting": {
        "ARN": "arn:aws:ssm:us-east-2:111122223333:servicesetting/ssm/managed-instance/activation-tier",
        "LastModifiedDate": 1579136114.275,
        "LastModifiedUser": "System",
        "SettingId": "/ssm/managed-instance/activation-tier",
        "SettingValue": "standard",
        "Status": "Default"
    }
}

See Also

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