[ aws . ssm ]

update-service-setting

Description

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 Amazon Web Services service team.

Update the service setting for the account.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-service-setting
--setting-id <value>
--setting-value <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--setting-id (string)

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

--setting-value (string)

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

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

• /ssm/automation/customer-script-log-group-name : the name of an Amazon CloudWatch Logs log group

• /ssm/documents/console/public-sharing-permission : Enable or Disable

• /ssm/managed-instance/activation-tier : standard or advanced

• /ssm/opsinsights/opscenter : Enabled or Disabled

• /ssm/parameter-store/default-parameter-tier : Standard , Advanced , Intelligent-Tiering

• /ssm/parameter-store/high-throughput-enabled : true or false

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update the service setting for Parameter Store throughput

The following update-service-setting example updates the current service setting for Parameter Store throughput in the specified region to use increased throughput.

aws ssm update-service-setting \
    --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled \
    --setting-value true

This command produces no output.

For more information, see Increasing Parameter Store Throughput in the AWS Systems Manager User Guide.

Output

None