ssm_update_service_setting: ServiceSetting is an account-level setting for an AWS service

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

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 get_service_setting API action to view the current value. Or, use the reset_service_setting to change the value back to the original value defined by the AWS service team.

Update the service setting for the account.

Usage

1
ssm_update_service_setting(SettingId, SettingValue)

Arguments

SettingId

[required] The Amazon Resource Name (ARN) of the service setting to reset. 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/parameter-store/default-parameter-tier

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

  • /ssm/managed-instance/activation-tier

SettingValue

[required] The new value to specify for the service setting. For the /ssm/parameter-store/default-parameter-tier setting ID, the setting value can be one of the following.

  • Standard

  • Advanced

  • Intelligent-Tiering

For the /ssm/parameter-store/high-throughput-enabled, and /ssm/managed-instance/activation-tier setting IDs, the setting value can be true or false.

Value

An empty list.

Request syntax

1
2
3
4
svc$update_service_setting(
  SettingId = "string",
  SettingValue = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.