Amazon Web Services, Inc.

AWS Systems Manager QuickSetup

Quick Setup helps you quickly configure frequently used services and features with recommended best practices. Quick Setup simplifies setting up services,…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Quick Setup helps you quickly configure frequently used services and features with
recommended best practices. Quick Setup simplifies setting up services, including
Systems Manager, by automating common or recommended tasks.

Endpoints 14

  • POSTCreate configuration manager/configurationManagerCreates a Quick Setup configuration manager resource. This object is a collection of desired state configurations for multiple configuration definitions and…
  • GETGet configuration manager/configurationManager/:ManagerArnReturns a configuration manager.
  • PUTUpdate configuration manager/configurationManager/:ManagerArnUpdates a Quick Setup configuration manager.
  • DELETEDelete configuration manager/configurationManager/:ManagerArnDeletes a configuration manager.
  • GETGet configuration/getConfiguration/:ConfigurationIdReturns details about the specified configuration.
  • GETGet service settings/serviceSettingsReturns settings configured for Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
  • PUTUpdate service settings/serviceSettingsUpdates settings configured for Quick Setup.
  • POSTList configuration managers/listConfigurationManagersReturns Quick Setup configuration managers.
  • POSTList configurations/listConfigurationsReturns configurations deployed by Quick Setup in the requesting Amazon Web Services account and Amazon Web Services Region.
  • GETList quick setup types/listQuickSetupTypesReturns the available Quick Setup types.
  • GETList tags for resource/tags/:ResourceArnReturns tags assigned to the resource.
  • PUTTag resource/tags/:ResourceArnAssigns key-value pairs of metadata to Amazon Web Services resources.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes tags from the specified resource.
  • PUTUpdate configuration definition/configurationDefinition/:ManagerArn/:IdUpdates a Quick Setup configuration definition.

API details

Base URL
https://ssm-quicksetup.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
14 operations on 9 pathsGET 5PUT 4POST 3DELETE 2
Description format
AWS Smithy model, API version 2018-05-10

How to test the AWS Systems Manager QuickSetup in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Systems Manager QuickSetup collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create configuration manager” (POST /configurationManager), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Systems Manager QuickSetup?

Quick Setup helps you quickly configure frequently used services and features with recommended best practices. Quick Setup simplifies setting up services,… It is listed under Developer tools and has 14 endpoints.

Who publishes the AWS Systems Manager QuickSetup?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Systems Manager QuickSetup?

Requests go to https://ssm-quicksetup.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Systems Manager QuickSetup?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Systems Manager QuickSetup have?

14 operations on 9 paths (5 GET, 4 PUT, 3 POST, 2 DELETE).

Is forking the AWS Systems Manager QuickSetup free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.