UpdateServiceSetting - AWS Systems Manager


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

Request Syntax

{ "SettingId": "string", "SettingValue": "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.


The Amazon Resource Name (ARN) of the service setting to update. For example, arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled. The setting ID can be one of the following.

  • /ssm/managed-instance/default-ec2-instance-management-role

  • /ssm/automation/customer-script-log-destination

  • /ssm/automation/customer-script-log-group-name

  • /ssm/documents/console/public-sharing-permission

  • /ssm/managed-instance/activation-tier

  • /ssm/opsinsights/opscenter

  • /ssm/parameter-store/default-parameter-tier

  • /ssm/parameter-store/high-throughput-enabled


Permissions to update the /ssm/managed-instance/default-ec2-instance-management-role setting should only be provided to administrators. Implement least privilege access when allowing individuals to configure or modify the Default Host Management Configuration.

Type: String

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

Required: Yes


The new value to specify for the service setting. The following list specifies the available values for each setting.

  • For /ssm/managed-instance/default-ec2-instance-management-role, enter the name of an IAM role.

  • For /ssm/automation/customer-script-log-destination, enter CloudWatch.

  • For /ssm/automation/customer-script-log-group-name, enter the name of an Amazon CloudWatch Logs log group.

  • For /ssm/documents/console/public-sharing-permission, enter Enable or Disable.

  • For /ssm/managed-instance/activation-tier, enter standard or advanced.

  • For /ssm/opsinsights/opscenter, enter Enabled or Disabled.

  • For /ssm/parameter-store/default-parameter-tier, enter Standard, Advanced, or Intelligent-Tiering

  • For /ssm/parameter-store/high-throughput-enabled, enter true or false.

Type: String

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

Required: Yes

Response Elements

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


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


An error occurred on the server side.

HTTP Status Code: 500


The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the AWS service team.

HTTP Status Code: 400


There are concurrent updates for a resource that supports one update at a time.

HTTP Status Code: 400



This example illustrates one usage of UpdateServiceSetting.

Sample Request

POST / HTTP/1.1 Host: ssm.us-east-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: AmazonSSM.UpdateServiceSetting 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: 20200325T154927Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20200325/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE Content-Length: 134 { "SettingId": "arn:aws:ssm:us-east-2:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled", "SettingValue": "true" }

Sample Response


See Also

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