get-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 UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Query the current service setting for the Amazon Web Services account.

Synopsis¶

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

Options¶

--setting-id (string)

The ID of the service setting to get. 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

--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 retrieve the service setting for Parameter Store throughput

The following get-service-setting This example retrieves the current service setting for Parameter Store throughput in the specified region.

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

Output:

{
    "ServiceSetting": {
        "SettingId": "/ssm/parameter-store/high-throughput-enabled",
        "SettingValue": "false",
        "LastModifiedDate": 1555532818.578,
        "LastModifiedUser": "System",
        "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled",
        "Status": "Default"
    }
}

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

Output¶

ServiceSetting -> (structure)

The query result of the current service setting.

SettingId -> (string)

The ID of the service setting.

SettingValue -> (string)

The value of the service setting.

LastModifiedDate -> (timestamp)

The last time the service setting was modified.

LastModifiedUser -> (string)

The ARN of the last modified user. This field is populated only if the setting value was overwritten.

ARN -> (string)

The ARN of the service setting.

Status -> (string)

The status of the service setting. The value can be Default, Customized or PendingUpdate.

Default: The current setting uses a default value provisioned by the Amazon Web Services service team.

Customized: The current setting use a custom value specified by the customer.

PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

Table of Contents

Feedback

User Guide