find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-systems-manager:amazon-systems-manager-service-setting-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Service Setting API
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ssm.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Service Setting
paths:
  /#GetServiceSetting:
    post:
      operationId: GetServiceSetting
      summary: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetServiceSettingResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: ServiceSettingNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceSettingNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.GetServiceSetting
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetServiceSettingRequest'
      tags:
      - Service Setting
  /#ResetServiceSetting:
    post:
      operationId: ResetServiceSetting
      summary: Reset 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. 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResetServiceSettingResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: ServiceSettingNotFound; TooManyUpdates
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceSettingNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.ResetServiceSetting
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ResetServiceSettingRequest'
      tags:
      - Service Setting
  /#UpdateServiceSetting:
    post:
      operationId: UpdateServiceSetting
      summary: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateServiceSettingResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: ServiceSettingNotFound; TooManyUpdates
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceSettingNotFound'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.UpdateServiceSetting
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateServiceSettingRequest'
      tags:
      - Service Setting
components:
  schemas:
    ServiceSetting:
      type: object
      properties:
        SettingId:
          type: string
          description: The ID of the service setting.
        SettingValue:
          type: string
          description: The value of the service setting.
        LastModifiedDate:
          type: string
          format: date-time
          description: The last time the service setting was modified.
        LastModifiedUser:
          type: string
          description: The ARN of the last modified user. This field is populated only if the setting value was overwritten.
        ARN:
          type: string
          description: The ARN of the service setting.
        Status:
          type: string
          description: '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.'
    ResetServiceSettingRequest:
      type: object
      properties:
        SettingId:
          type: string
          description: The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be one of the following. /ssm/appmanager/appmanager-enabled /ssm/automation/customer-script-log-destination /ssm/automation/customer-script-log-group-name /ssm/automation/enable-adaptive-concurrency /ssm/documents/console/public-sharing-permission /ssm/managed-instance/activation-tier /ssm/managed-instance/default-ec2-instance-management-role /ssm/opsinsights/opscenter /ssm/parameter-store/default-parameter-tier /ssm/parameter-store/high-throughput-enabled
      required:
      - SettingId
    GetServiceSettingResult:
      type: object
      properties:
        ServiceSetting:
          $ref: '#/components/schemas/ServiceSetting'
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    UpdateServiceSettingRequest:
      type: object
      properties:
        SettingId:
          type: string
          description: 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/appmanager/appmanager-enabled /ssm/automation/customer-script-log-destination /ssm/automation/customer-script-log-group-name /ssm/automation/enable-adaptive-concurrency /ssm/documents/console/public-sharing-permission /ssm/managed-instance/activation-tier /ssm/managed-instance/default-ec2-instance-management-role /ssm/opsinsights/opscenter /ssm/parameter-store/default-paramet
        SettingValue:
          type: string
          description: The new value to specify for the service setting. The following list specifies the available values for each setting. For /ssm/appmanager/appmanager-enabled, enter True or False. 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/managed-instance/default-ec2-instance-management-role, enter the name of an IAM role
      required:
      - SettingId
      - SettingValue
    ResetServiceSettingResult:
      type: object
      properties:
        ServiceSetting:
          $ref: '#/components/schemas/ServiceSetting'
    UpdateServiceSettingResult:
      type: object
      properties: {}
    GetServiceSettingRequest:
      type: object
      properties:
        SettingId:
          type: string
          description: The ID of the service setting to get. The setting ID can be one of the following. /ssm/appmanager/appmanager-enabled /ssm/automation/customer-script-log-destination /ssm/automation/customer-script-log-group-name /ssm/automation/enable-adaptive-concurrency /ssm/documents/console/public-sharing-permission /ssm/managed-instance/activation-tier /ssm/managed-instance/default-ec2-instance-management-role /ssm/opsinsights/opscenter /ssm/parameter-store/default-parameter-tier /ssm/parameter-store/high-throughput-enabled
      required:
      - SettingId
    ServiceSettingNotFound:
      type: object
      properties:
        Message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ssm
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ssm/service/2014-11-06/ssm-2014-11-06.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)