We announced the upcoming end-of-support for AWS SDK for JavaScript v2.

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.

Class: AWS.ControlCatalog

Inherits:

AWS.Service

Object
AWS.Service
AWS.ControlCatalog

show all

Identifier:: controlcatalog

API Version:: 2018-05-10

Defined in:: (unknown)

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();

Version:

2018-05-10

Constructor Summary collapse

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

Property Summary collapse

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

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a ControlCatalog object

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

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.ControlCatalog.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.ControlCatalog.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.ControlCatalog.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
useFipsEndpoint (Boolean) —
Enables FIPS compatible endpoints. Defaults to false.
useDualstackEndpoint (Boolean) —
Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

Returns:

(AWS.Endpoint) —
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.

Service Reference:

GetControl

Examples:

Calling the getControl operation

var params = {
  ControlArn: 'STRING_VALUE' /* required */
};
controlcatalog.getControl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ControlArn — (String)
  The Amazon Resource Name (ARN) of the control. It has one of the following formats:
  
  Global format
  
  arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}
  
  Or Regional format
  
  arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}
  
  Here is a more general pattern that covers Amazon Web Services Control Tower and Control Catalog ARNs:
  
  ^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\-]+$

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Arn — (String)
    The Amazon Resource Name (ARN) of the control.
  - Name — (String)
    The display name of the control.
  - Description — (String)
    A description of what the control does.
  - Behavior — (String)
    A term that identifies the control's functional behavior. One of Preventive, Deteictive, Proactive
    Possible values include:
    
    "PREVENTIVE"
    
    "PROACTIVE"
    
    "DETECTIVE"
  - RegionConfiguration — (map)
    Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control currently is available for deployment.
    
    If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the RegionConfiguration API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions A,B,and C while the control is available in Regions A, B, C, and D, you'd see a response with DeployableRegions of A, B, C, and D for a control with REGIONAL scope, even though you may not intend to deploy the control in Region D, because you do not govern it through your landing zone.
    
    Scope — required — (String)
    The coverage of the control, if deployed. Scope is an enumerated type, with value Regional, or Global. A control with Global scope is effective in all Amazon Web Services Regions, regardless of the Region from which it is enabled, or to which it is deployed. A control implemented by an SCP is usually Global in scope. A control with Regional scope has operations that are restricted specifically to the Region from which it is enabled and to which it is deployed. Controls implemented by Config rules and CloudFormation hooks usually are Regional in scope. Security Hub controls usually are Regional in scope.
    Possible values include:
    
    "GLOBAL"
    
    "REGIONAL"
    
    DeployableRegions — (Array<String>)
    Regions in which the control is available to be deployed.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

ListCommonControls

Examples:

Calling the listCommonControls operation

var params = {
  CommonControlFilter: {
    Objectives: [
      {
        Arn: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
controlcatalog.listCommonControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- MaxResults — (Integer)
  The maximum number of results on a page or for an API request call.
- NextToken — (String)
  The pagination token that's used to fetch the next set of results.
- CommonControlFilter — (map)
  An optional filter that narrows the results to a specific objective.
  
  This filter allows you to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.
  - Objectives — (Array<map>)
    The objective that's used as filter criteria.
    
    You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs in the CommonControlFilter isn’t currently supported.
    - Arn — (String)
      The Amazon Resource Name (ARN) of the objective.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - CommonControls — (Array<map>)
    The list of common controls that the ListCommonControls API returns.
    
    Arn — required — (String)
    The Amazon Resource Name (ARN) that identifies the common control.
    
    Name — required — (String)
    The name of the common control.
    
    Description — required — (String)
    The description of the common control.
    
    Domain — required — (map)
    The domain that the common control belongs to.
    
    Arn — (String)
    The Amazon Resource Name (ARN) of the related domain.
    
    Name — (String)
    The name of the related domain.
    
    Objective — required — (map)
    The objective that the common control belongs to.
    
    Arn — (String)
    The Amazon Resource Name (ARN) of the related objective.
    
    Name — (String)
    The name of the related objective.
    
    CreateTime — required — (Date)
    The time when the common control was created.
    
    LastUpdateTime — required — (Date)
    The time when the common control was most recently updated.
  - NextToken — (String)
    The pagination token that's used to fetch the next set of results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

ListControls

Examples:

Calling the listControls operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
controlcatalog.listControls(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- NextToken — (String)
  The pagination token that's used to fetch the next set of results.
- MaxResults — (Integer)
  The maximum number of results on a page or for an API request call.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Controls — (Array<map>)
    Returns a list of controls, given as structures of type controlSummary.
    
    Arn — required — (String)
    The Amazon Resource Name (ARN) of the control.
    
    Name — required — (String)
    The display name of the control.
    
    Description — required — (String)
    A description of the control, as it may appear in the console. Describes the functionality of the control.
  - NextToken — (String)
    The pagination token that's used to fetch the next set of results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

ListDomains

Examples:

Calling the listDomains operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
controlcatalog.listDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- MaxResults — (Integer)
  The maximum number of results on a page or for an API request call.
- NextToken — (String)
  The pagination token that's used to fetch the next set of results.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Domains — (Array<map>)
    The list of domains that the ListDomains API returns.
    
    Arn — required — (String)
    The Amazon Resource Name (ARN) that identifies the domain.
    
    Name — required — (String)
    The name of the domain.
    
    Description — required — (String)
    The description of the domain.
    
    CreateTime — required — (Date)
    The time when the domain was created.
    
    LastUpdateTime — required — (Date)
    The time when the domain was most recently updated.
  - NextToken — (String)
    The pagination token that's used to fetch the next set of results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

ListObjectives

Examples:

Calling the listObjectives operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ObjectiveFilter: {
    Domains: [
      {
        Arn: 'STRING_VALUE'
      },
      /* more items */
    ]
  }
};
controlcatalog.listObjectives(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- MaxResults — (Integer)
  The maximum number of results on a page or for an API request call.
- NextToken — (String)
  The pagination token that's used to fetch the next set of results.
- ObjectiveFilter — (map)
  An optional filter that narrows the results to a specific domain.
  
  This filter allows you to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.
  - Domains — (Array<map>)
    The domain that's used as filter criteria.
    
    You can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in the ObjectiveFilter isn’t currently supported.
    - Arn — (String)
      The Amazon Resource Name (ARN) of the domain.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Objectives — (Array<map>)
    The list of objectives that the ListObjectives API returns.
    
    Arn — required — (String)
    The Amazon Resource Name (ARN) that identifies the objective.
    
    Name — required — (String)
    The name of the objective.
    
    Description — required — (String)
    The description of the objective.
    
    Domain — required — (map)
    The domain that the objective belongs to.
    
    Arn — (String)
    The Amazon Resource Name (ARN) of the related domain.
    
    Name — (String)
    The name of the related domain.
    
    CreateTime — required — (Date)
    The time when the objective was created.
    
    LastUpdateTime — required — (Date)
    The time when the objective was most recently updated.
  - NextToken — (String)
    The pagination token that's used to fetch the next set of results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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.

Parameters:

state (String) —
the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.
params (map) (defaults to: {}) —
a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

function(err, data) { ... }

Callback containing error and data information. See the respective resource state for the expected error or data information.

If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.ControlCatalog

Overview

Service Description

Sending a Request Using ControlCatalog

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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