AWS.ControlCatalog — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Welcome to the Amazon Web Services 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 Amazon Web Services Control Catalog.

Use the following links to get started with the Amazon Web Services 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.

Sending a Request Using ControlCatalog

var controlcatalog = new AWS.ControlCatalog();
controlcatalog.getControl(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ControlCatalog object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var controlcatalog = new AWS.ControlCatalog({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the controlcatalog service identifier:

AWS.config.apiVersions = {
  controlcatalog: '2018-05-10',
  // other service API versions
};

var controlcatalog = new AWS.ControlCatalog();

Constructor Summarycollapse

• new AWS.ControlCatalog(options = {}) ⇒ Object constructor
  Constructs a service object.

Property Summarycollapse

• endpoint ⇒ AWS.Endpoint readwrite
  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

• getControl(params = {}, callback) ⇒ AWS.Request
  Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported.
• listCommonControls(params = {}, callback) ⇒ AWS.Request
  Returns 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 specific objective.
• listControls(params = {}, callback) ⇒ AWS.Request
  Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library.
• listDomains(params = {}, callback) ⇒ AWS.Request
  Returns a paginated list of domains from the Amazon Web Services Control Catalog.
  .
• listObjectives(params = {}, callback) ⇒ AWS.Request
  Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
  You can apply an optional filter to see the objectives that belong to a specific domain.
• waitFor(state, params = {}, callback) ⇒ AWS.Request
  Waits for a given ControlCatalog resource.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.ControlCatalog(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

getControl(params = {}, callback) ⇒ AWS.Request

Returns 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 parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.

In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.

listCommonControls(params = {}, callback) ⇒ AWS.Request

Returns 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 specific objective. If you don’t provide a filter, the operation returns all common controls.

listControls(params = {}, callback) ⇒ AWS.Request

Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.

listDomains(params = {}, callback) ⇒ AWS.Request

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

listObjectives(params = {}, callback) ⇒ AWS.Request

Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given ControlCatalog resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.