amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.ResetServiceSetting

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. Use the UpdateServiceSetting API operation to change the default setting.

Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

Synopsis

Creating a Request

data ResetServiceSetting Source #

The request body of the ResetServiceSetting API operation.

See: newResetServiceSetting smart constructor.

Constructors

ResetServiceSetting' 

Fields

  • settingId :: Text

    The Amazon Resource Name (ARN) of the service setting to reset. 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

Instances

Instances details
ToJSON ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

toJSON :: ResetServiceSetting -> Value #

toEncoding :: ResetServiceSetting -> Encoding #

toJSONList :: [ResetServiceSetting] -> Value #

toEncodingList :: [ResetServiceSetting] -> Encoding #

ToHeaders ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

toHeaders :: ResetServiceSetting -> [Header] #

ToPath ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

toPath :: ResetServiceSetting -> ByteString #

ToQuery ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

toQuery :: ResetServiceSetting -> QueryString #

AWSRequest ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Associated Types

type AWSResponse ResetServiceSetting #

Methods

request :: (Service -> Service) -> ResetServiceSetting -> Request ResetServiceSetting #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ResetServiceSetting -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ResetServiceSetting))) #

Generic ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Associated Types

type Rep ResetServiceSetting :: Type -> Type #

Methods

from :: ResetServiceSetting -> Rep ResetServiceSetting x #

to :: Rep ResetServiceSetting x -> ResetServiceSetting #

Read ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

readsPrec :: Int -> ReadS ResetServiceSetting #

readList :: ReadS [ResetServiceSetting] #

readPrec :: ReadPrec ResetServiceSetting #

readListPrec :: ReadPrec [ResetServiceSetting] #

Show ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

showsPrec :: Int -> ResetServiceSetting -> ShowS #

show :: ResetServiceSetting -> String #

showList :: [ResetServiceSetting] -> ShowS #

NFData ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

rnf :: ResetServiceSetting -> () #

Eq ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

(==) :: ResetServiceSetting -> ResetServiceSetting -> Bool #

(/=) :: ResetServiceSetting -> ResetServiceSetting -> Bool #

Hashable ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

hashWithSalt :: Int -> ResetServiceSetting -> Int #

hash :: ResetServiceSetting -> Int #

type AWSResponse ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

type AWSResponse ResetServiceSetting = ResetServiceSettingResponse
type Rep ResetServiceSetting Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

type Rep ResetServiceSetting = D1 ('MetaData "ResetServiceSetting" "Amazonka.SSM.ResetServiceSetting" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ResetServiceSetting'" 'PrefixI 'True) (S1 ('MetaSel ('Just "settingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newResetServiceSetting Source #

Arguments

:: Text

ResetServiceSetting

-> ResetServiceSetting 

Create a value of ResetServiceSetting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ResetServiceSetting, resetServiceSetting_settingId - The Amazon Resource Name (ARN) of the service setting to reset. 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

Request Lenses

resetServiceSetting_settingId :: Lens' ResetServiceSetting Text Source #

The Amazon Resource Name (ARN) of the service setting to reset. 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

Destructuring the Response

data ResetServiceSettingResponse Source #

The result body of the ResetServiceSetting API operation.

See: newResetServiceSettingResponse smart constructor.

Constructors

ResetServiceSettingResponse' 

Fields

Instances

Instances details
Generic ResetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Associated Types

type Rep ResetServiceSettingResponse :: Type -> Type #

Methods

from :: ResetServiceSettingResponse -> Rep ResetServiceSettingResponse x #

to :: Rep ResetServiceSettingResponse x -> ResetServiceSettingResponse #

Read ResetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

readsPrec :: Int -> ReadS ResetServiceSettingResponse #

readList :: ReadS [ResetServiceSettingResponse] #

readPrec :: ReadPrec ResetServiceSettingResponse #

readListPrec :: ReadPrec [ResetServiceSettingResponse] #

Show ResetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

showsPrec :: Int -> ResetServiceSettingResponse -> ShowS #

show :: ResetServiceSettingResponse -> String #

showList :: [ResetServiceSettingResponse] -> ShowS #

NFData ResetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

rnf :: ResetServiceSettingResponse -> () #

Eq ResetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

Methods

(==) :: ResetServiceSettingResponse -> ResetServiceSettingResponse -> Bool #

(/=) :: ResetServiceSettingResponse -> ResetServiceSettingResponse -> Bool #

type Rep ResetServiceSettingResponse Source # 
Instance details

Defined in Amazonka.SSM.ResetServiceSetting

type Rep ResetServiceSettingResponse = D1 ('MetaData "ResetServiceSettingResponse" "Amazonka.SSM.ResetServiceSetting" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ResetServiceSettingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceSetting)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newResetServiceSettingResponse Source #

Arguments

:: Int

$sel:httpStatus:ResetServiceSettingResponse'

-> ResetServiceSettingResponse 

Create a value of ResetServiceSettingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:serviceSetting:ResetServiceSettingResponse', resetServiceSettingResponse_serviceSetting - The current, effective service setting after calling the ResetServiceSetting API operation.

$sel:httpStatus:ResetServiceSettingResponse', resetServiceSettingResponse_httpStatus - The response's http status code.

Response Lenses

resetServiceSettingResponse_serviceSetting :: Lens' ResetServiceSettingResponse (Maybe ServiceSetting) Source #

The current, effective service setting after calling the ResetServiceSetting API operation.

resetServiceSettingResponse_httpStatus :: Lens' ResetServiceSettingResponse Int Source #

The response's http status code.