Amazon Web Services, Inc.

AWS Control Catalog

Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the…

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

Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Control Catalog. Use the following links to get started with the Control Catalog API: Actions : An alphabetical list of all Control Catalog API operations. Data types : An alphabetical list of all Control Catalog data types. Common parameters : Parameters that all operations can use. Common errors : Client and server errors that all operations can return.

Endpoints 6

Control

  • POSTGet control/get-controlReturns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn…
  • POSTList controls/list-controls?nextToken=string&maxResults=0Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as…

Common control

  • POSTList common controls/common-controls?maxResults=0&nextToken=stringReturns a paginated list of common controls from the Amazon Web Services Control Catalog. You can apply an optional filter to see common controls that have a…

Domain

  • POSTList domains/domains?maxResults=0&nextToken=stringReturns a paginated list of domains from the Control Catalog.

Objective

  • POSTList objectives/objectives?maxResults=0&nextToken=stringReturns a paginated list of objectives from the Control Catalog. You can apply an optional filter to see the objectives that belong to a specific domain. If…
  • POSTList control mappings/list-control-mappings?nextToken=string&maxResults=0Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common…

API details

Base URL
https://controlcatalog.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
6 operations on 6 pathsPOST 6
Main resources
Control 2Common control 1Domain 1Objective 1
Description format
AWS Smithy model, API version 2018-05-10

How to test the AWS Control Catalog 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 Control Catalog 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 “Get control” (POST /get-control), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Control Catalog?

Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the… It is listed under Developer tools and has 6 endpoints.

Who publishes the AWS Control Catalog?

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 Control Catalog?

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

How do I authenticate with the AWS Control Catalog?

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

How many endpoints does the AWS Control Catalog have?

6 operations on 6 paths (6 POST). The largest groups are Control, Common control, Domain, Objective.

Is forking the AWS Control Catalog 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.