Class: AWS.Discovery

var params = {
  deleteAgents: [ /* required */
    {
      agentId: 'STRING_VALUE', /* required */
      force: true || false
    },
    /* more items */
  ]
};
discovery.batchDeleteAgents(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: {}) —
  • deleteAgents — (Array<map>)

    The list of agents to delete.

    • agentId — required — (String)

      The ID of the agent or data collector to delete.

    • force — (Boolean)

      Optional flag used to force delete an agent or data collector. It is needed to delete any agent in HEALTHY/UNHEALTHY/RUNNING status. Note that deleting an agent that is actively reporting health causes it to be re-registered with a different agent ID after data collector re-connects with Amazon Web Services.

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:

    • errors — (Array<map>)

      A list of agent IDs that failed to delete during the deletion task, each paired with an error message.

      • agentId — required — (String)

        The ID of the agent or data collector to delete.

      • errorMessage — required — (String)

        The description of the error that occurred for the delete failed agent.

      • errorCode — required — (String)

        The type of error that occurred for the delete failed agent. Valid status are: AGENT_IN_USE | NOT_FOUND | INTERNAL_SERVER_ERROR.

        Possible values include:
        • "NOT_FOUND"
        • "INTERNAL_SERVER_ERROR"
        • "AGENT_IN_USE"

Returns:

• (AWS.Request) —

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

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

    The IDs for the import tasks that you want to delete.

  • deleteHistory — (Boolean)

    Set to true to remove the deleted import task from DescribeImportTasks.

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:

    • errors — (Array<map>)

      Error messages returned for each import task that you deleted as a response for this command.

      • importTaskId — (String)

        The unique import ID associated with the error that occurred.

      • errorCode — (String)

        The type of error that occurred for a specific import task.

        Possible values include:
        • "NOT_FOUND"
        • "INTERNAL_SERVER_ERROR"
        • "OVER_LIMIT"
      • errorDescription — (String)

        The description of the error that occurred for a specific import task.

Returns:

• (AWS.Request) —

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

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.

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"}

    • key — required — (String)

      The type of tag on which to filter.

    • value — required — (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.

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.

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"}

    • key — required — (String)

      The type of tag on which to filter.

    • value — required — (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.

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: 'NUMBER_VALUE',
  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 collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

  • filters — (Array<map>)

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

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

    • name — required — (String)

      The name of the filter.

    • values — required — (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.

    • condition — required — (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/collectors 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 collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.

      • agentId — (String)

        The agent or collector ID.

      • hostName — (String)

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

      • agentNetworkInfoList — (Array<map>)

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

        • ipAddress — (String)

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

        • macAddress — (String)

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

      • connectorId — (String)

        The ID of the connector.

      • version — (String)

        The agent or collector version.

      • health — (String)

        The health of the agent.

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

        Time since agent health was reported.

      • collectionStatus — (String)

        Status of the collection process for an agent.

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

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

    The ID of the task to delete.

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:

    • task — (map)

      The BatchDeleteConfigurationTask that represents the deletion task being executed.

      • taskId — (String)

        The deletion task's unique identifier.

      • status — (String)

        The current execution status of the deletion task. Valid status are: INITIALIZING | VALIDATING | DELETING | COMPLETED | FAILED.

        Possible values include:
        • "INITIALIZING"
        • "VALIDATING"
        • "DELETING"
        • "COMPLETED"
        • "FAILED"
      • startTime — (Date)

        An epoch seconds timestamp (UTC) of when the deletion task was started.

      • endTime — (Date)

        An epoch seconds timestamp (UTC) of when the deletion task was completed or failed.

      • configurationType — (String)

        The type of configuration item to delete. Supported types are: SERVER.

        Possible values include:
        • "SERVER"
      • requestedConfigurations — (Array<String>)

        The list of configuration IDs that were originally requested to be deleted by the deletion task.

      • deletedConfigurations — (Array<String>)

        The list of configuration IDs that were successfully deleted by the deletion task.

      • failedConfigurations — (Array<map>)

        A list of configuration IDs that failed to delete during the deletion task, each paired with an error message.

        • configurationId — (String)

          The unique identifier of the configuration the failed to delete.

        • errorStatusCode — (Integer)

          The integer error code associated with the error message.

        • errorMessage — (String)

          A descriptive message indicating why the associated configuration failed to delete.

      • deletionWarnings — (Array<map>)

        A list of configuration IDs that produced warnings regarding their deletion, paired with a warning message.

        • configurationId — (String)

          The unique identifier of the configuration that produced a warning.

        • warningCode — (Integer)

          The integer warning code associated with the warning message.

        • warningText — (String)

          A descriptive message of the warning the associated configuration ID produced.

Returns:

• (AWS.Request) —

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

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.

var params = {
  exportIds: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
discovery.describeContinuousExports(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>)

    The unique IDs assigned to the exports.

  • maxResults — (Integer)

    A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

  • nextToken — (String)

    The token from the previous call to DescribeExportTasks.

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:

    • descriptions — (Array<map>)

      A list of continuous export descriptions.

      • exportId — (String)

        The unique ID assigned to this export.

      • status — (String)

        Describes the status of the export. Can be one of the following values:

        • START_IN_PROGRESS - setting up resources to start continuous export.

        • START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.

        • ACTIVE - data is being exported to the customer bucket.

        • ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.

        • STOP_IN_PROGRESS - stopping the export.

        • STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.

        • INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

        Possible values include:
        • "START_IN_PROGRESS"
        • "START_FAILED"
        • "ACTIVE"
        • "ERROR"
        • "STOP_IN_PROGRESS"
        • "STOP_FAILED"
        • "INACTIVE"
      • statusDetail — (String)

        Contains information about any errors that have occurred. This data type can have the following values:

        • ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery Service User Guide.

        • DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

        • FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your user is missing the Amazon Web ServicesApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role in the Application Discovery Service User Guide.

        • FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your user is missing one or more of the Kinesis data delivery streams.

        • INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact Amazon Web Services Support.

        • LAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions to start continuous export. For more information, see Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the Amazon Web Services Lake Formation Developer Guide.

          You can use one of the following two ways to resolve this issue.

          1. If you don’t want to use the Lake Formation permission model, you can change the default Data Catalog settings to use only Amazon Web Services Identity and Access Management (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation Developer Guide.

          2. You can give the service-linked IAM roles AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For more information, see Granting Database Permissions in the Lake Formation Developer Guide.

             1. AWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant database creator permissions, which gives the role database creation ability and implicit permissions for any created tables. For more information, see Implicit Lake Formation Permissions in the Lake Formation Developer Guide.

             2. AWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all tables in the database.

        • S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.

        • S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.

      • s3Bucket — (String)

        The name of the s3 bucket where the export data parquet files are stored.

      • startTime — (Date)

        The timestamp representing when the continuous export was started.

      • stopTime — (Date)

        The timestamp that represents when this continuous export was stopped.

      • dataSource — (String)

        The type of data collector used to gather this data (currently only offered for AGENT).

        Possible values include:
        • "AGENT"
      • schemaStorageConfig — (map<String>)

        An object which describes how the data is stored.

        • databaseName - the name of the Glue database used to store the schema.

    • nextToken — (String)

      The token from the previous call to DescribeExportTasks.

Returns:

• (AWS.Request) —

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

var params = {
  exportIds: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  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 list of continuous export IDs to search for.

  • maxResults — (Integer)

    A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

  • nextToken — (String)

    The token from the previous call to describe-export-tasks.

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>)
      • exportId — required — (String)

        A unique identifier used to query an export.

      • exportStatus — required — (String)

        The status of the data export job.

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

        A status message provided for API callers.

      • configurationsDownloadUrl — (String)

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

      • exportRequestTime — required — (Date)

        The time that the data export was initiated.

      • isTruncated — (Boolean)

        If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate.

      • requestedStartTime — (Date)

        The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.

      • requestedEndTime — (Date)

        The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.

    • nextToken — (String)

      The token from the previous call to describe-export-tasks.

Returns:

• (AWS.Request) —

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

var params = {
  exportIds: [
    'STRING_VALUE',
    /* more items */
  ],
  filters: [
    {
      condition: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  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.

  • filters — (Array<map>)

    One or more filters.

    • AgentId - ID of the agent whose collected data will be exported

    • name — required — (String)

      A single ExportFilter name. Supported filters: agentIds.

    • values — required — (Array<String>)

      A single agent ID for a Discovery Agent. An agent ID can be found using the DescribeAgents action. Typically an ADS agent ID is in the form o-0123456789abcdef0.

    • condition — required — (String)

      Supported condition: EQUALS

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

      • exportId — required — (String)

        A unique identifier used to query an export.

      • exportStatus — required — (String)

        The status of the data export job.

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

        A status message provided for API callers.

      • configurationsDownloadUrl — (String)

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

      • exportRequestTime — required — (Date)

        The time that the data export was initiated.

      • isTruncated — (Boolean)

        If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate.

      • requestedStartTime — (Date)

        The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.

      • requestedEndTime — (Date)

        The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.

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

var params = {
  filters: [
    {
      name: IMPORT_TASK_ID | STATUS | NAME,
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
discovery.describeImportTasks(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>)

    An array of name-value pairs that you provide to filter the results for the DescribeImportTask request to a specific subset of results. Currently, wildcard values aren't supported for filters.

    • name — (String)

      The name, status, or import task ID for a specific import task.

      Possible values include:
      • "IMPORT_TASK_ID"
      • "STATUS"
      • "NAME"
    • values — (Array<String>)

      An array of strings that you can provide to match against a specific name, status, or import task ID to filter the results for your import task queries.

  • maxResults — (Integer)

    The maximum number of results that you want this request to return, up to 100.

  • nextToken — (String)

    The token to request a specific page 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:

    • nextToken — (String)

      The token to request the next page of results.

    • tasks — (Array<map>)

      A returned array of import tasks that match any applied filters, up to the specified number of maximum results.

      • importTaskId — (String)

        The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an Amazon Web Services account.

      • clientRequestToken — (String)

        A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.

      • name — (String)

        A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

      • importUrl — (String)

        The URL for your import file that you've uploaded to Amazon S3.

      • status — (String)

        The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.

        Possible values include:
        • "IMPORT_IN_PROGRESS"
        • "IMPORT_COMPLETE"
        • "IMPORT_COMPLETE_WITH_ERRORS"
        • "IMPORT_FAILED"
        • "IMPORT_FAILED_SERVER_LIMIT_EXCEEDED"
        • "IMPORT_FAILED_RECORD_LIMIT_EXCEEDED"
        • "DELETE_IN_PROGRESS"
        • "DELETE_COMPLETE"
        • "DELETE_FAILED"
        • "DELETE_FAILED_LIMIT_EXCEEDED"
        • "INTERNAL_ERROR"
      • importRequestTime — (Date)

        The time that the import task request was made, presented in the Unix time stamp format.

      • importCompletionTime — (Date)

        The time that the import task request finished, presented in the Unix time stamp format.

      • importDeletedTime — (Date)

        The time that the import task request was deleted, presented in the Unix time stamp format.

      • serverImportSuccess — (Integer)

        The total number of server records in the import file that were successfully imported.

      • serverImportFailure — (Integer)

        The total number of server records in the import file that failed to be imported.

      • applicationImportSuccess — (Integer)

        The total number of application records in the import file that were successfully imported.

      • applicationImportFailure — (Integer)

        The total number of application records in the import file that failed to be imported.

      • errorsAndFailedEntriesZip — (String)

        A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.

        This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.

        If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.

Returns:

• (AWS.Request) —

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

var params = {
  filters: [
    {
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  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.

    • name — required — (String)

      A name of the tag filter.

    • values — required — (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.

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.

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.

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.

      • activeAgents — required — (Integer)

        Number of active discovery agents.

      • healthyAgents — required — (Integer)

        Number of healthy discovery agents

      • blackListedAgents — required — (Integer)

        Number of blacklisted discovery agents.

      • shutdownAgents — required — (Integer)

        Number of discovery agents with status SHUTDOWN.

      • unhealthyAgents — required — (Integer)

        Number of unhealthy discovery agents.

      • totalAgents — required — (Integer)

        Total number of discovery agents.

      • unknownAgents — required — (Integer)

        Number of unknown discovery agents.

    • connectorSummary — (map)

      Details about discovered connectors, including connector status and health.

      • activeConnectors — required — (Integer)

        Number of active discovery connectors.

      • healthyConnectors — required — (Integer)

        Number of healthy discovery connectors.

      • blackListedConnectors — required — (Integer)

        Number of blacklisted discovery connectors.

      • shutdownConnectors — required — (Integer)

        Number of discovery connectors with status SHUTDOWN,

      • unhealthyConnectors — required — (Integer)

        Number of unhealthy discovery connectors.

      • totalConnectors — required — (Integer)

        Total number of discovery connectors.

      • unknownConnectors — required — (Integer)

        Number of unknown discovery connectors.

    • meCollectorSummary — (map)

      Details about Migration Evaluator collectors, including collector status and health.

      • activeMeCollectors — required — (Integer)

        The number of active Migration Evaluator collectors.

      • healthyMeCollectors — required — (Integer)

        The number of healthy Migration Evaluator collectors.

      • denyListedMeCollectors — required — (Integer)

        The number of deny-listed Migration Evaluator collectors.

      • shutdownMeCollectors — required — (Integer)

        The number of Migration Evaluator collectors with SHUTDOWN status.

      • unhealthyMeCollectors — required — (Integer)

        The number of unhealthy Migration Evaluator collectors.

      • totalMeCollectors — required — (Integer)

        The total number of Migration Evaluator collectors.

      • unknownMeCollectors — required — (Integer)

        The number of unknown Migration Evaluator collectors.

    • agentlessCollectorSummary — (map)

      Details about Agentless Collector collectors, including status.

      • activeAgentlessCollectors — required — (Integer)

        The number of active Agentless Collector collectors.

      • healthyAgentlessCollectors — required — (Integer)

        The number of healthy Agentless Collector collectors.

      • denyListedAgentlessCollectors — required — (Integer)

        The number of deny-listed Agentless Collector collectors.

      • shutdownAgentlessCollectors — required — (Integer)

        The number of Agentless Collector collectors with SHUTDOWN status.

      • unhealthyAgentlessCollectors — required — (Integer)

        The number of unhealthy Agentless Collector collectors.

      • totalAgentlessCollectors — required — (Integer)

        The total number of Agentless Collector collectors.

      • unknownAgentlessCollectors — required — (Integer)

        The number of unknown Agentless Collector collectors.

Returns:

• (AWS.Request) —

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

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: 'NUMBER_VALUE',
  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 Using the ListConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

    • name — required — (String)

      The name of the filter.

    • values — required — (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.

    • condition — required — (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 in the Amazon Web Services Application Discovery Service User Guide.

    • fieldName — required — (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.

var params = {
  configurationId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  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.

      • sourceServerId — required — (String)

        The ID of the server that opened the network connection.

      • destinationServerId — required — (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.

      • connectionsCount — required — (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.

var params = {
  configurationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  configurationType: SERVER /* required */
};
discovery.startBatchDeleteConfigurationTask(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)

    The type of configuration item to delete. Supported types are: SERVER.

    Possible values include:
    • "SERVER"
  • configurationIds — (Array<String>)

    The list of configuration IDs that will be deleted by the task.

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:

    • taskId — (String)

      The unique identifier associated with the newly started deletion task.

Returns:

• (AWS.Request) —

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

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

    • exportId — (String)

      The unique ID assigned to this export.

    • s3Bucket — (String)

      The name of the s3 bucket where the export data parquet files are stored.

    • startTime — (Date)

      The timestamp representing when the continuous export was started.

    • dataSource — (String)

      The type of data collector used to gather this data (currently only offered for AGENT).

      Possible values include:
      • "AGENT"
    • schemaStorageConfig — (map<String>)

      A dictionary which describes how the data is stored.

      • databaseName - the name of the Glue database used to store the schema.

Returns:

• (AWS.Request) —

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

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 from which to start collecting data. If you send a request to an agent ID that you do not have permission to contact, according to your Amazon Web Services 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 and you do not have permission to contact some of those agents, 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 that were instructed to start collecting data. Information includes the agent ID, a description of the operation performed, and whether the agent configuration was updated.

      • agentId — (String)

        The agent ID.

      • operationSucceeded — (Boolean)

        Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent 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.

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  exportDataFormat: [
    CSV,
    /* more items */
  ],
  filters: [
    {
      condition: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE', /* required */
      values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  preferences: {
    ec2RecommendationsPreferences: {
      cpuPerformanceMetricBasis: {
        name: 'STRING_VALUE',
        percentageAdjust: 'NUMBER_VALUE'
      },
      enabled: true || false,
      excludedInstanceTypes: [
        'STRING_VALUE',
        /* more items */
      ],
      preferredRegion: 'STRING_VALUE',
      ramPerformanceMetricBasis: {
        name: 'STRING_VALUE',
        percentageAdjust: 'NUMBER_VALUE'
      },
      reservedInstanceOptions: {
        offeringClass: STANDARD | CONVERTIBLE, /* required */
        purchasingOption: ALL_UPFRONT | PARTIAL_UPFRONT | NO_UPFRONT, /* required */
        termLength: ONE_YEAR | THREE_YEAR /* required */
      },
      tenancy: DEDICATED | SHARED
    }
  },
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
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. Note: The GRAPHML option has been deprecated.

  • filters — (Array<map>)

    If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents.

    • name — required — (String)

      A single ExportFilter name. Supported filters: agentIds.

    • values — required — (Array<String>)

      A single agent ID for a Discovery Agent. An agent ID can be found using the DescribeAgents action. Typically an ADS agent ID is in the form o-0123456789abcdef0.

    • condition — required — (String)

      Supported condition: EQUALS

  • startTime — (Date)

    The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.

  • endTime — (Date)

    The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

  • preferences — (map)

    Indicates the type of data that needs to be exported. Only one ExportPreferences can be enabled at any time.

    • ec2RecommendationsPreferences — (map)

      If enabled, exported data includes EC2 instance type matches for on-premises servers discovered through Amazon Web Services Application Discovery Service.

      • enabled — (Boolean)

        If set to true, the export preferences is set to Ec2RecommendationsExportPreferences.

      • cpuPerformanceMetricBasis — (map)

        The recommended EC2 instance type that matches the CPU usage metric of server performance data.

        • name — (String)

          A utilization metric that is used by the recommendations.

        • percentageAdjust — (Float)

          Specifies the percentage of the specified utilization metric that is used by the recommendations.

      • ramPerformanceMetricBasis — (map)

        The recommended EC2 instance type that matches the Memory usage metric of server performance data.

        • name — (String)

          A utilization metric that is used by the recommendations.

        • percentageAdjust — (Float)

          Specifies the percentage of the specified utilization metric that is used by the recommendations.

      • tenancy — (String)

        The target tenancy to use for your recommended EC2 instances.

        Possible values include:
        • "DEDICATED"
        • "SHARED"
      • excludedInstanceTypes — (Array<String>)

        An array of instance types to exclude from recommendations.

      • preferredRegion — (String)

        The target Amazon Web Services Region for the recommendations. You can use any of the Region codes available for the chosen service, as listed in Amazon Web Services service endpoints in the Amazon Web Services General Reference.

      • reservedInstanceOptions — (map)

        The contract type for a reserved instance. If blank, we assume an On-Demand instance is preferred.

        • purchasingOption — required — (String)

          The payment plan to use for your Reserved Instance.

          Possible values include:
          • "ALL_UPFRONT"
          • "PARTIAL_UPFRONT"
          • "NO_UPFRONT"
        • offeringClass — required — (String)

          The flexibility to change the instance types needed for your Reserved Instance.

          Possible values include:
          • "STANDARD"
          • "CONVERTIBLE"
        • termLength — required — (String)

          The preferred duration of the Reserved Instance term.

          Possible values include:
          • "ONE_YEAR"
          • "THREE_YEAR"

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.

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

    Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.

    Sending more than one StartImportTask request with the same client request token will return information about the original import task with that client request token.

    If a token is not provided, the SDK will use a version 4 UUID.
  • name — (String)

    A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

  • importUrl — (String)

    The URL for your import file that you've uploaded to Amazon S3.

    Note: If you're using the Amazon Web Services CLI, this URL is structured as follows: s3://BucketName/ImportFileName.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:

    • task — (map)

      An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

      • importTaskId — (String)

        The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an Amazon Web Services account.

      • clientRequestToken — (String)

        A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.

      • name — (String)

        A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

      • importUrl — (String)

        The URL for your import file that you've uploaded to Amazon S3.

      • status — (String)

        The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.

        Possible values include:
        • "IMPORT_IN_PROGRESS"
        • "IMPORT_COMPLETE"
        • "IMPORT_COMPLETE_WITH_ERRORS"
        • "IMPORT_FAILED"
        • "IMPORT_FAILED_SERVER_LIMIT_EXCEEDED"
        • "IMPORT_FAILED_RECORD_LIMIT_EXCEEDED"
        • "DELETE_IN_PROGRESS"
        • "DELETE_COMPLETE"
        • "DELETE_FAILED"
        • "DELETE_FAILED_LIMIT_EXCEEDED"
        • "INTERNAL_ERROR"
      • importRequestTime — (Date)

        The time that the import task request was made, presented in the Unix time stamp format.

      • importCompletionTime — (Date)

        The time that the import task request finished, presented in the Unix time stamp format.

      • importDeletedTime — (Date)

        The time that the import task request was deleted, presented in the Unix time stamp format.

      • serverImportSuccess — (Integer)

        The total number of server records in the import file that were successfully imported.

      • serverImportFailure — (Integer)

        The total number of server records in the import file that failed to be imported.

      • applicationImportSuccess — (Integer)

        The total number of application records in the import file that were successfully imported.

      • applicationImportFailure — (Integer)

        The total number of application records in the import file that failed to be imported.

      • errorsAndFailedEntriesZip — (String)

        A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.

        This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.

        If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.

Returns:

• (AWS.Request) —

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

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

    The unique ID assigned to this export.

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:

    • startTime — (Date)

      Timestamp that represents when this continuous export started collecting data.

    • stopTime — (Date)

      Timestamp that represents when this continuous export was stopped.

Returns:

• (AWS.Request) —

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

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 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 that were instructed to stop collecting data. Information includes the agent ID, a description of the operation performed, and whether the agent configuration was updated.

      • agentId — (String)

        The agent ID.

      • operationSucceeded — (Boolean)

        Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent 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.

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.