String agentId
The agent ID.
Boolean operationSucceeded
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.
String description
A description of the operation performed.
String agentId
The agent or collector ID.
String hostName
The name of the host where the agent or collector resides. The host can be a server or virtual machine.
List<E> agentNetworkInfoList
Network details about the host where the agent or collector resides.
String connectorId
The ID of the connector.
String version
The agent or collector version.
String health
The health of the agent.
String lastHealthPingTime
Time since agent health was reported.
String collectionStatus
Status of the collection process for an agent.
String agentType
Type of agent.
String registeredTime
Agent's first registration timestamp in UTC.
String configurationType
A type of IT asset to tag.
String configurationId
The configuration ID for the item to tag. You can specify a list of keys and values.
String key
A type of tag on which to filter. For example, serverType.
String value
A value on which to filter. For example key = serverType and value = web server.
Date timeOfCreation
The time the configuration tag was created in Coordinated Universal Time (UTC).
String exportId
The unique ID assigned to this export.
String status
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.
String statusDetail
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.
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.
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.
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.
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.
String s3Bucket
The name of the s3 bucket where the export data parquet files are stored.
Date startTime
The timestamp representing when the continuous export was started.
Date stopTime
The timestamp that represents when this continuous export was stopped.
String dataSource
The type of data collector used to gather this data (currently only offered for AGENT).
Map<K,V> schemaStorageConfig
An object which describes how the data is stored.
databaseName - the name of the Glue database used to store the schema.
String configurationId
Configuration ID of an application to be created.
List<E> configurationIds
A list of configuration items that you want to tag.
List<E> tags
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"}
Integer activeAgents
Number of active discovery agents.
Integer healthyAgents
Number of healthy discovery agents
Integer blackListedAgents
Number of blacklisted discovery agents.
Integer shutdownAgents
Number of discovery agents with status SHUTDOWN.
Integer unhealthyAgents
Number of unhealthy discovery agents.
Integer totalAgents
Total number of discovery agents.
Integer unknownAgents
Number of unknown discovery agents.
Integer activeAgentlessCollectors
The number of active Agentless Collector collectors.
Integer healthyAgentlessCollectors
The number of healthy Agentless Collector collectors.
Integer denyListedAgentlessCollectors
The number of deny-listed Agentless Collector collectors.
Integer shutdownAgentlessCollectors
The number of Agentless Collector collectors with SHUTDOWN status.
Integer unhealthyAgentlessCollectors
The number of unhealthy Agentless Collector collectors.
Integer totalAgentlessCollectors
The total number of Agentless Collector collectors.
Integer unknownAgentlessCollectors
The number of unknown Agentless Collector collectors.
Integer activeConnectors
Number of active discovery connectors.
Integer healthyConnectors
Number of healthy discovery connectors.
Integer blackListedConnectors
Number of blacklisted discovery connectors.
Integer shutdownConnectors
Number of discovery connectors with status SHUTDOWN,
Integer unhealthyConnectors
Number of unhealthy discovery connectors.
Integer totalConnectors
Total number of discovery connectors.
Integer unknownConnectors
Number of unknown discovery connectors.
Integer activeMeCollectors
The number of active Migration Evaluator collectors.
Integer healthyMeCollectors
The number of healthy Migration Evaluator collectors.
Integer denyListedMeCollectors
The number of deny-listed Migration Evaluator collectors.
Integer shutdownMeCollectors
The number of Migration Evaluator collectors with SHUTDOWN status.
Integer unhealthyMeCollectors
The number of unhealthy Migration Evaluator collectors.
Integer totalMeCollectors
The total number of Migration Evaluator collectors.
Integer unknownMeCollectors
The number of unknown Migration Evaluator collectors.
List<E> configurationIds
A list of configuration items with tags that you want to delete.
List<E> tags
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"}
List<E> agentIds
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.
List<E> filters
You can filter the request using various logical operators and a key-value format. For example:
{"key": "collectionStatus", "value": "STARTED"}
Integer maxResults
The total number of agents/collectors to return in a single page of output. The maximum value is 100.
String nextToken
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.
List<E> agentsInfo
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.
String nextToken
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.
List<E> exportIds
One or more unique identifiers used to query the status of an export request.
List<E> filters
One or more filters.
AgentId - ID of the agent whose collected data will be exported
Integer maxResults
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.
String nextToken
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.
List<E> exportsInfo
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.
String nextToken
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.
List<E> filters
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.
Integer maxResults
The maximum number of results that you want this request to return, up to 100.
String nextToken
The token to request a specific page of results.
List<E> filters
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.
Integer maxResults
The total number of items to return in a single page of output. The maximum value is 100.
String nextToken
A token to start the list. Use this token to get the next set of results.
Boolean enabled
If set to true, the export preferences is set to Ec2RecommendationsExportPreferences.
UsageMetricBasis cpuPerformanceMetricBasis
The recommended EC2 instance type that matches the CPU usage metric of server performance data.
UsageMetricBasis ramPerformanceMetricBasis
The recommended EC2 instance type that matches the Memory usage metric of server performance data.
String tenancy
The target tenancy to use for your recommended EC2 instances.
List<E> excludedInstanceTypes
An array of instance types to exclude from recommendations.
String preferredRegion
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 reservedInstanceOptions
The contract type for a reserved instance. If blank, we assume an On-Demand instance is preferred.
String exportId
A unique identifier that you can use to query the export status.
String name
A single ExportFilter name. Supported filters: agentIds.
List<E> values
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.
String condition
Supported condition: EQUALS
String exportId
A unique identifier used to query an export.
String exportStatus
The status of the data export job.
String statusMessage
A status message provided for API callers.
String configurationsDownloadUrl
A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
Date exportRequestTime
The time that the data export was initiated.
Boolean isTruncated
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.
Date requestedStartTime
The value of startTime parameter in the StartExportTask request. If no
startTime was requested, this result does not appear in ExportInfo.
Date requestedEndTime
The endTime used in the StartExportTask request. If no endTime was
requested, this result does not appear in ExportInfo.
Ec2RecommendationsExportPreferences ec2RecommendationsPreferences
If enabled, exported data includes EC2 instance type matches for on-premises servers discovered through Amazon Web Services Application Discovery Service.
String name
The name of the filter.
List<E> values
A string value on which to filter. For example, if you choose the destinationServer.osVersion filter
name, you could specify Ubuntu for the value.
String condition
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.
Long servers
The number of servers discovered.
Long applications
The number of applications discovered.
Long serversMappedToApplications
The number of servers mapped to applications.
Long serversMappedtoTags
The number of servers mapped to tags.
CustomerAgentInfo agentSummary
Details about discovered agents, including agent status and health.
CustomerConnectorInfo connectorSummary
Details about discovered connectors, including connector status and health.
CustomerMeCollectorInfo meCollectorSummary
Details about Migration Evaluator collectors, including collector status and health.
CustomerAgentlessCollectorInfo agentlessCollectorSummary
Details about Agentless Collector collectors, including status.
String importTaskId
The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an Amazon Web Services account.
String clientRequestToken
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.
String name
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.
String importUrl
The URL for your import file that you've uploaded to Amazon S3.
String status
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.
Date importRequestTime
The time that the import task request was made, presented in the Unix time stamp format.
Date importCompletionTime
The time that the import task request finished, presented in the Unix time stamp format.
Date importDeletedTime
The time that the import task request was deleted, presented in the Unix time stamp format.
Integer serverImportSuccess
The total number of server records in the import file that were successfully imported.
Integer serverImportFailure
The total number of server records in the import file that failed to be imported.
Integer applicationImportSuccess
The total number of application records in the import file that were successfully imported.
Integer applicationImportFailure
The total number of application records in the import file that failed to be imported.
String errorsAndFailedEntriesZip
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.
String configurationType
A valid configuration identified by Application Discovery Service.
List<E> filters
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.
Integer maxResults
The total number of items to return. The maximum value is 100.
String nextToken
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.
List<E> orderBy
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.
List<E> configurations
Returns configuration details, including the configuration ID, attribute names, and attribute values.
String nextToken
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.
String configurationId
Configuration ID of the server for which neighbors are being listed.
Boolean portInformationNeeded
Flag to indicate if port and protocol information is needed as part of the response.
List<E> neighborConfigurationIds
List of configuration IDs to test for one-hop-away.
Integer maxResults
Maximum number of results to return in a single page of output.
String nextToken
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.
List<E> neighbors
List of distinct servers that are one hop away from the given server.
String nextToken
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.
Long knownDependencyCount
Count of distinct servers that are one hop away from the given server.
String sourceServerId
The ID of the server that opened the network connection.
String destinationServerId
The ID of the server that accepted the network connection.
Integer destinationPort
The destination network port for the connection.
String transportProtocol
The network protocol used for the connection.
Long connectionsCount
The number of open network connections with the neighboring server.
String exportId
The unique ID assigned to this export.
String s3Bucket
The name of the s3 bucket where the export data parquet files are stored.
Date startTime
The timestamp representing when the continuous export was started.
String dataSource
The type of data collector used to gather this data (currently only offered for AGENT).
Map<K,V> schemaStorageConfig
A dictionary which describes how the data is stored.
databaseName - the name of the Glue database used to store the schema.
List<E> agentIds
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.
List<E> exportDataFormat
The file format for the returned export data. Default value is CSV. Note: The
GRAPHML option has been deprecated.
List<E> filters
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.
Date startTime
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.
Date endTime
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.
ExportPreferences preferences
Indicates the type of data that needs to be exported. Only one ExportPreferences can be enabled at any time.
String exportId
A unique identifier used to query the status of an export request.
String clientRequestToken
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.
String name
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.
String importUrl
The URL for your import file that you've uploaded to Amazon S3.
If you're using the Amazon Web Services CLI, this URL is structured as follows:
s3://BucketName/ImportFileName.CSV
ImportTask task
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.
String exportId
The unique ID assigned to this export.
Copyright © 2023. All rights reserved.