Class: AWS.Discovery

Inherits:
AWS.Service show all
Identifier:
discovery
API Version:
2015-11-01
Defined in:
(unknown)

Overview

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

Sending a Request Using Discovery

var discovery = new AWS.Discovery();
discovery.associateConfigurationItemsToApplication(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 Discovery object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var discovery = new AWS.Discovery({apiVersion: '2015-11-01'});

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

AWS.config.apiVersions = {
  discovery: '2015-11-01',
  // other service API versions
};

var discovery = new AWS.Discovery();

Version:

  • 2015-11-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Discovery object

var discovery = new AWS.Discovery({apiVersion: '2015-11-01'});

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)

    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'.

  • 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.Discovery.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Discovery.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Discovery.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.

  • 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 accept DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

endpointAWS.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

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

Associates one or more configuration items with an application.

Examples:

Calling the associateConfigurationItemsToApplication operation

var params = {
  applicationConfigurationId: 'STRING_VALUE', /* required */
  configurationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
discovery.associateConfigurationItemsToApplication(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: {})
    • applicationConfigurationId — (String)

      The configuration ID of an application with which items are to be associated.

    • configurationIds — (Array<String>)

      The ID of each configuration item to be associated with an application.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates an application with the given name and description.

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
discovery.createApplication(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: {})
    • name — (String)

      Name of the application to be created.

    • description — (String)

      Description of the application to be created.

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:

      • configurationId — (String)

        Configuration ID of an application to be created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

Service Reference:

Examples:

Calling the createTags operation

var params = {
  configurationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
discovery.createTags(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: {})
    • configurationIds — (Array<String>)

      A list of configuration items that you want to tag.

    • tags — (Array<map>)

      Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example:

      {"key": "serverType", "value": "webServer"}

      • keyrequired — (String)

        The type of tag on which to filter.

      • valuerequired — (String)

        A value for a tag key on which to filter.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes a list of applications and their associations with configuration items.

Service Reference:

Examples:

Calling the deleteApplications operation

var params = {
  configurationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
discovery.deleteApplications(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: {})
    • configurationIds — (Array<String>)

      Configuration ID of an application to be deleted.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

Service Reference:

Examples:

Calling the deleteTags operation

var params = {
  configurationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
discovery.deleteTags(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: {})
    • configurationIds — (Array<String>)

      A list of configuration items with tags that you want to delete.

    • tags — (Array<map>)

      Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example:

      {"key": "serverType", "value": "webServer"}

      • keyrequired — (String)

        The type of tag on which to filter.

      • valuerequired — (String)

        A value for a tag key on which to filter.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.

Service Reference:

Examples:

Calling the describeAgents operation

var params = {
  agentIds: [
    'STRING_VALUE',
    /* more items */
  ],
  filters: [
    {
      condition: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
discovery.describeAgents(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: {})
    • agentIds — (Array<String>)

      The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

    • filters — (Array<map>)

      You can filter the request using various logical operators and a key-value format. For example:

      {"key": "collectionStatus", "value": "STARTED"}

      • namerequired — (String)

        The name of the filter.

      • valuesrequired — (Array<String>)

        A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

      • conditionrequired — (String)

        A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

    • maxResults — (Integer)

      The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

    • nextToken — (String)

      Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

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:

      • agentsInfo — (Array<map>)

        Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.

        • agentId — (String)

          The agent or connector ID.

        • hostName — (String)

          The name of the host where the agent or connector resides. The host can be a server or virtual machine.

        • agentNetworkInfoList — (Array<map>)

          Network details about the host where the agent or connector resides.

          • ipAddress — (String)

            The IP address for the host where the agent/connector resides.

          • macAddress — (String)

            The MAC address for the host where the agent/connector resides.

        • connectorId — (String)

          The ID of the connector.

        • version — (String)

          The agent or connector version.

        • health — (String)

          The health of the agent or connector.

          Possible values include:
          • "HEALTHY"
          • "UNHEALTHY"
          • "RUNNING"
          • "UNKNOWN"
          • "BLACKLISTED"
          • "SHUTDOWN"
        • lastHealthPingTime — (String)

          Time since agent or connector health was reported.

        • collectionStatus — (String)

          Status of the collection process for an agent or connector.

        • agentType — (String)

          Type of agent.

        • registeredTime — (String)

          Agent's first registration timestamp in UTC.

      • nextToken — (String)

        Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action.

Service Reference:

Examples:

Calling the describeConfigurations operation

var params = {
  configurationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
discovery.describeConfigurations(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: {})
    • configurationIds — (Array<String>)

      One or more configuration IDs.

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:

      • configurations — (Array<map<String>>)

        A key in the response map. The value is an array of data.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deprecated. Use DescribeExportTasks instead.

Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.

Service Reference:

Examples:

Calling the describeExportConfigurations operation

var params = {
  exportIds: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
discovery.describeExportConfigurations(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: {})
    • exportIds — (Array<String>)

      A unique identifier that you can use to query the export status.

    • maxResults — (Integer)

      The maximum number of results that you want to display as a part of the query.

    • nextToken — (String)

      A token to get the next set of results. For example, if you specify 100 IDs for DescribeExportConfigurationsRequest$exportIds but set DescribeExportConfigurationsRequest$maxResults to 10, you get results in a set of 10. Use the token in the query to get the next set of 10.

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:

      • exportsInfo — (Array<map>)

        Returns export details. When the status is complete, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.

        • exportIdrequired — (String)

          A unique identifier that you can use to query the export.

        • exportStatusrequired — (String)

          The status of the configuration data export. The status can succeed, fail, or be in-progress.

          Possible values include:
          • "FAILED"
          • "SUCCEEDED"
          • "IN_PROGRESS"
        • statusMessagerequired — (String)

          Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.

        • configurationsDownloadUrl — (String)

          A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.

        • exportRequestTimerequired — (Date)

          The time that the configuration data export was initiated.

      • nextToken — (String)

        A token to get the next set of results. For example, if you specify 100 IDs for DescribeExportConfigurationsRequest$exportIds but set DescribeExportConfigurationsRequest$maxResults to 10, you get results in a set of 10. Use the token in the query to get the next set of 10.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

Service Reference:

Examples:

Calling the describeExportTasks operation

var params = {
  exportIds: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
discovery.describeExportTasks(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: {})
    • exportIds — (Array<String>)

      One or more unique identifiers used to query the status of an export request.

    • maxResults — (Integer)

      The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.

    • nextToken — (String)

      The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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:

      • exportsInfo — (Array<map>)

        Contains one or more sets of export request details. When the status of a request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.

        • exportIdrequired — (String)

          A unique identifier that you can use to query the export.

        • exportStatusrequired — (String)

          The status of the configuration data export. The status can succeed, fail, or be in-progress.

          Possible values include:
          • "FAILED"
          • "SUCCEEDED"
          • "IN_PROGRESS"
        • statusMessagerequired — (String)

          Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.

        • configurationsDownloadUrl — (String)

          A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.

        • exportRequestTimerequired — (Date)

          The time that the configuration data export was initiated.

      • nextToken — (String)

        The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of all tags assigned to a specific configuration item.

Service Reference:

Examples:

Calling the describeTags operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 0,
  nextToken: 'STRING_VALUE'
};
discovery.describeTags(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: {})
    • filters — (Array<map>)

      You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

      • namerequired — (String)

        A name of the tag filter.

      • valuesrequired — (Array<String>)

        Values for the tag filter.

    • maxResults — (Integer)

      The total number of items to return in a single page of output. The maximum value is 100.

    • nextToken — (String)

      A token to start the list. Use this token to get 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:

      • tags — (Array<map>)

        Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

        • configurationType — (String)

          A type of IT asset to tag.

          Possible values include:
          • "SERVER"
          • "PROCESS"
          • "CONNECTION"
          • "APPLICATION"
        • configurationId — (String)

          The configuration ID for the item to tag. You can specify a list of keys and values.

        • key — (String)

          A type of tag on which to filter. For example, serverType.

        • value — (String)

          A value on which to filter. For example key = serverType and value = web server.

        • timeOfCreation — (Date)

          The time the configuration tag was created in Coordinated Universal Time (UTC).

      • nextToken — (String)

        The call returns a token. Use this token to get the next set of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Disassociates one or more configuration items from an application.

Examples:

Calling the disassociateConfigurationItemsFromApplication operation

var params = {
  applicationConfigurationId: 'STRING_VALUE', /* required */
  configurationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
discovery.disassociateConfigurationItemsFromApplication(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: {})
    • applicationConfigurationId — (String)

      Configuration ID of an application from which each item is disassociated.

    • configurationIds — (Array<String>)

      Configuration ID of each item to be disassociated from an application.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Deprecated. Use StartExportTask instead.

Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.

Service Reference:

Examples:

Calling the exportConfigurations operation

discovery.exportConfigurations(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

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:

      • exportId — (String)

        A unique identifier that you can use to query the export status.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves a short summary of discovered assets.

Service Reference:

Examples:

Calling the getDiscoverySummary operation

var params = {
};
discovery.getDiscoverySummary(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: {})

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:

      • servers — (Integer)

        The number of servers discovered.

      • applications — (Integer)

        The number of applications discovered.

      • serversMappedToApplications — (Integer)

        The number of servers mapped to applications.

      • serversMappedtoTags — (Integer)

        The number of servers mapped to tags.

      • agentSummary — (map)

        Details about discovered agents, including agent status and health.

        • activeAgentsrequired — (Integer)

          Number of active discovery agents.

        • healthyAgentsrequired — (Integer)

          Number of healthy discovery agents

        • blackListedAgentsrequired — (Integer)

          Number of blacklisted discovery agents.

        • shutdownAgentsrequired — (Integer)

          Number of discovery agents with status SHUTDOWN.

        • unhealthyAgentsrequired — (Integer)

          Number of unhealthy discovery agents.

        • totalAgentsrequired — (Integer)

          Total number of discovery agents.

        • unknownAgentsrequired — (Integer)

          Number of unknown discovery agents.

      • connectorSummary — (map)

        Details about discovered connectors, including connector status and health.

        • activeConnectorsrequired — (Integer)

          Number of active discovery connectors.

        • healthyConnectorsrequired — (Integer)

          Number of healthy discovery connectors.

        • blackListedConnectorsrequired — (Integer)

          Number of blacklisted discovery connectors.

        • shutdownConnectorsrequired — (Integer)

          Number of discovery connectors with status SHUTDOWN,

        • unhealthyConnectorsrequired — (Integer)

          Number of unhealthy discovery connectors.

        • totalConnectorsrequired — (Integer)

          Total number of discovery connectors.

        • unknownConnectorsrequired — (Integer)

          Number of unknown discovery connectors.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.

Service Reference:

Examples:

Calling the listConfigurations operation

var params = {
  configurationType: SERVER | PROCESS | CONNECTION | APPLICATION, /* required */
  filters: [
    {
      condition: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 0,
  nextToken: 'STRING_VALUE',
  orderBy: [
    {
      fieldName: 'STRING_VALUE', /* required */
      sortOrder: ASC | DESC
    },
    /* more items */
  ]
};
discovery.listConfigurations(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: {})
    • configurationType — (String)

      A valid configuration identified by Application Discovery Service.

      Possible values include:
      • "SERVER"
      • "PROCESS"
      • "CONNECTION"
      • "APPLICATION"
    • filters — (Array<map>)

      You can filter the request using various logical operators and a key-value format. For example:

      {"key": "serverType", "value": "webServer"}

      For a complete list of filter options and guidance about using them with this action, see Querying Discovered Configuration Items.

      • namerequired — (String)

        The name of the filter.

      • valuesrequired — (Array<String>)

        A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

      • conditionrequired — (String)

        A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

    • maxResults — (Integer)

      The total number of items to return. The maximum value is 100.

    • nextToken — (String)

      Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

    • orderBy — (Array<map>)

      Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action.

      • fieldNamerequired — (String)

        The field on which to order.

      • sortOrder — (String)

        Ordering direction.

        Possible values include:
        • "ASC"
        • "DESC"

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:

      • configurations — (Array<map<String>>)

        Returns configuration details, including the configuration ID, attribute names, and attribute values.

      • nextToken — (String)

        Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Retrieves a list of servers that are one network hop away from a specified server.

Service Reference:

Examples:

Calling the listServerNeighbors operation

var params = {
  configurationId: 'STRING_VALUE', /* required */
  maxResults: 0,
  neighborConfigurationIds: [
    'STRING_VALUE',
    /* more items */
  ],
  nextToken: 'STRING_VALUE',
  portInformationNeeded: true || false
};
discovery.listServerNeighbors(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: {})
    • configurationId — (String)

      Configuration ID of the server for which neighbors are being listed.

    • portInformationNeeded — (Boolean)

      Flag to indicate if port and protocol information is needed as part of the response.

    • neighborConfigurationIds — (Array<String>)

      List of configuration IDs to test for one-hop-away.

    • maxResults — (Integer)

      Maximum number of results to return in a single page of output.

    • nextToken — (String)

      Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

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:

      • neighbors — (Array<map>)

        List of distinct servers that are one hop away from the given server.

        • sourceServerIdrequired — (String)

          The ID of the server that opened the network connection.

        • destinationServerIdrequired — (String)

          The ID of the server that accepted the network connection.

        • destinationPort — (Integer)

          The destination network port for the connection.

        • transportProtocol — (String)

          The network protocol used for the connection.

        • connectionsCountrequired — (Integer)

          The number of open network connections with the neighboring server.

      • nextToken — (String)

        Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

      • knownDependencyCount — (Integer)

        Count of distinct servers that are one hop away from the given server.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Instructs the specified agents or connectors to start collecting data.

Service Reference:

Examples:

Calling the startDataCollectionByAgentIds operation

var params = {
  agentIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
discovery.startDataCollectionByAgentIds(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: {})
    • agentIds — (Array<String>)

      The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

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:

      • agentsConfigurationStatus — (Array<map>)

        Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

        • agentId — (String)

          The agent/connector ID.

        • operationSucceeded — (Boolean)

          Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command.

        • description — (String)

          A description of the operation performed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.

Service Reference:

Examples:

Calling the startExportTask operation

var params = {
  exportDataFormat: [
    CSV | GRAPHML,
    /* more items */
  ]
};
discovery.startExportTask(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: {})
    • exportDataFormat — (Array<String>)

      The file format for the returned export data. Default value is CSV.

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:

      • exportId — (String)

        A unique identifier used to query the status of an export request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Instructs the specified agents or connectors to stop collecting data.

Service Reference:

Examples:

Calling the stopDataCollectionByAgentIds operation

var params = {
  agentIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
discovery.stopDataCollectionByAgentIds(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: {})
    • agentIds — (Array<String>)

      The IDs of the agents or connectors from which to stop collecting data.

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:

      • agentsConfigurationStatus — (Array<map>)

        Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

        • agentId — (String)

          The agent/connector ID.

        • operationSucceeded — (Boolean)

          Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command.

        • description — (String)

          A description of the operation performed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Updates metadata about an application.

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  configurationId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  name: 'STRING_VALUE'
};
discovery.updateApplication(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: {})
    • configurationId — (String)

      Configuration ID of the application to be updated.

    • name — (String)

      New name of the application to be updated.

    • description — (String)

      New description of the application to be updated.

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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.