Associates one or more configuration items with an application.
" }, "BatchDeleteImportData":{ "name":"BatchDeleteImportData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchDeleteImportDataRequest"}, "output":{"shape":"BatchDeleteImportDataResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications.
Amazon Web Services Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.
" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateApplicationRequest"}, "output":{"shape":"CreateApplicationResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Creates an application with the given name and description.
" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "output":{"shape":"CreateTagsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.
Do not store sensitive information (like personal data) in tags.
Deletes a list of applications and their associations with configuration items.
" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "output":{"shape":"DeleteTagsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
" }, "DescribeAgents":{ "name":"DescribeAgents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAgentsRequest"}, "output":{"shape":"DescribeAgentsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.
Retrieves attributes for a list of configuration item IDs.
All of the supplied IDs must be for the same asset type from one of the following:
server
application
process
connection
Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.
For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.
DescribeExportConfigurations is deprecated. Use DescribeExportTasks, instead.
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
" }, "DescribeImportTasks":{ "name":"DescribeImportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportTasksRequest"}, "output":{"shape":"DescribeImportTasksResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.
There are three valid tag filter names:
tagKey
tagValue
configurationId
Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters.
Disassociates one or more configuration items from an application.
" }, "ExportConfigurations":{ "name":"ExportConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"ExportConfigurationsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"OperationNotPermittedException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Deprecated. Use StartExportTask instead.
Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.
", "deprecated":true }, "GetDiscoverySummary":{ "name":"GetDiscoverySummary", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDiscoverySummaryRequest"}, "output":{"shape":"GetDiscoverySummaryResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Retrieves a short summary of discovered assets.
This API operation takes no request parameters and is called as is at the command prompt as shown in the example.
" }, "ListConfigurations":{ "name":"ListConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListConfigurationsRequest"}, "output":{"shape":"ListConfigurationsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.
Retrieves a list of servers that are one network hop away from a specified server.
" }, "StartContinuousExport":{ "name":"StartContinuousExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartContinuousExportRequest"}, "output":{"shape":"StartContinuousExportResponse"}, "errors":[ {"shape":"ConflictErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ResourceInUseException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Start the continuous flow of agent's discovered data into Amazon Athena.
" }, "StartDataCollectionByAgentIds":{ "name":"StartDataCollectionByAgentIds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartDataCollectionByAgentIdsRequest"}, "output":{"shape":"StartDataCollectionByAgentIdsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Instructs the specified agents or connectors to start collecting data.
" }, "StartExportTask":{ "name":"StartExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartExportTaskRequest"}, "output":{"shape":"StartExportTaskResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"OperationNotPermittedException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Begins the export of discovered data to an S3 bucket.
If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports.
If you do not include an agentIds filter, summary data is exported that includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery Agents. Export of summary data is limited to two exports per day.
Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.
To start an import request, do this:
Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.
Fill out the template with your server and application data.
Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.
Use the console or the StartImportTask command with the Amazon Web Services CLI or one of the Amazon Web Services SDKs to import the records from your file.
For more information, including step-by-step procedures, see Migration Hub Import in the Amazon Web Services Application Discovery Service User Guide.
There are limits to the number of import tasks you can create (and delete) in an Amazon Web Services account. For more information, see Amazon Web Services Application Discovery Service Limits in the Amazon Web Services Application Discovery Service User Guide.
Stop the continuous flow of agent's discovered data into Amazon Athena.
" }, "StopDataCollectionByAgentIds":{ "name":"StopDataCollectionByAgentIds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopDataCollectionByAgentIdsRequest"}, "output":{"shape":"StopDataCollectionByAgentIdsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Instructs the specified agents or connectors to stop collecting data.
" }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationRequest"}, "output":{"shape":"UpdateApplicationResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"HomeRegionNotSetException"} ], "documentation":"Updates metadata about an application.
" } }, "shapes":{ "AgentConfigurationStatus":{ "type":"structure", "members":{ "agentId":{ "shape":"String", "documentation":"The agent/connector ID.
" }, "operationSucceeded":{ "shape":"Boolean", "documentation":"Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command.
A description of the operation performed.
" } }, "documentation":"Information about agents or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.
" }, "AgentConfigurationStatusList":{ "type":"list", "member":{"shape":"AgentConfigurationStatus"} }, "AgentId":{ "type":"string", "max":20, "min":10, "pattern":"\\S+" }, "AgentIds":{ "type":"list", "member":{"shape":"AgentId"} }, "AgentInfo":{ "type":"structure", "members":{ "agentId":{ "shape":"AgentId", "documentation":"The agent or connector ID.
" }, "hostName":{ "shape":"String", "documentation":"The name of the host where the agent or connector resides. The host can be a server or virtual machine.
" }, "agentNetworkInfoList":{ "shape":"AgentNetworkInfoList", "documentation":"Network details about the host where the agent or connector resides.
" }, "connectorId":{ "shape":"String", "documentation":"The ID of the connector.
" }, "version":{ "shape":"String", "documentation":"The agent or connector version.
" }, "health":{ "shape":"AgentStatus", "documentation":"The health of the agent or connector.
" }, "lastHealthPingTime":{ "shape":"String", "documentation":"Time since agent or connector health was reported.
" }, "collectionStatus":{ "shape":"String", "documentation":"Status of the collection process for an agent or connector.
" }, "agentType":{ "shape":"String", "documentation":"Type of agent.
" }, "registeredTime":{ "shape":"String", "documentation":"Agent's first registration timestamp in UTC.
" } }, "documentation":"Information about agents or connectors associated with the user’s Amazon Web Services account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.
" }, "AgentNetworkInfo":{ "type":"structure", "members":{ "ipAddress":{ "shape":"String", "documentation":"The IP address for the host where the agent/connector resides.
" }, "macAddress":{ "shape":"String", "documentation":"The MAC address for the host where the agent/connector resides.
" } }, "documentation":"Network details about the host where the agent/connector resides.
" }, "AgentNetworkInfoList":{ "type":"list", "member":{"shape":"AgentNetworkInfo"} }, "AgentStatus":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY", "RUNNING", "UNKNOWN", "BLACKLISTED", "SHUTDOWN" ] }, "AgentsInfo":{ "type":"list", "member":{"shape":"AgentInfo"} }, "ApplicationDescription":{ "type":"string", "max":1000, "pattern":"(^$|[\\s\\S]*\\S[\\s\\S]*)" }, "ApplicationId":{ "type":"string", "max":200, "pattern":"\\S+" }, "ApplicationIdsList":{ "type":"list", "member":{"shape":"ApplicationId"} }, "ApplicationName":{ "type":"string", "max":127, "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, "AssociateConfigurationItemsToApplicationRequest":{ "type":"structure", "required":[ "applicationConfigurationId", "configurationIds" ], "members":{ "applicationConfigurationId":{ "shape":"ApplicationId", "documentation":"The configuration ID of an application with which items are to be associated.
" }, "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"The ID of each configuration item to be associated with an application.
" } } }, "AssociateConfigurationItemsToApplicationResponse":{ "type":"structure", "members":{ } }, "AuthorizationErrorException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
", "exception":true }, "BatchDeleteImportDataError":{ "type":"structure", "members":{ "importTaskId":{ "shape":"ImportTaskIdentifier", "documentation":"The unique import ID associated with the error that occurred.
" }, "errorCode":{ "shape":"BatchDeleteImportDataErrorCode", "documentation":"The type of error that occurred for a specific import task.
" }, "errorDescription":{ "shape":"BatchDeleteImportDataErrorDescription", "documentation":"The description of the error that occurred for a specific import task.
" } }, "documentation":"Error messages returned for each import task that you deleted as a response for this command.
" }, "BatchDeleteImportDataErrorCode":{ "type":"string", "enum":[ "NOT_FOUND", "INTERNAL_SERVER_ERROR", "OVER_LIMIT" ] }, "BatchDeleteImportDataErrorDescription":{"type":"string"}, "BatchDeleteImportDataErrorList":{ "type":"list", "member":{"shape":"BatchDeleteImportDataError"} }, "BatchDeleteImportDataRequest":{ "type":"structure", "required":["importTaskIds"], "members":{ "importTaskIds":{ "shape":"ToDeleteIdentifierList", "documentation":"The IDs for the import tasks that you want to delete.
" } } }, "BatchDeleteImportDataResponse":{ "type":"structure", "members":{ "errors":{ "shape":"BatchDeleteImportDataErrorList", "documentation":"Error messages returned for each import task that you deleted as a response for this command.
" } } }, "Boolean":{"type":"boolean"}, "BoxedInteger":{ "type":"integer", "box":true }, "ClientRequestToken":{ "type":"string", "max":100, "min":1 }, "Condition":{ "type":"string", "max":200, "pattern":"\\S+" }, "Configuration":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "ConfigurationId":{ "type":"string", "max":200, "pattern":"\\S*" }, "ConfigurationIdList":{ "type":"list", "member":{"shape":"ConfigurationId"} }, "ConfigurationItemType":{ "type":"string", "enum":[ "SERVER", "PROCESS", "CONNECTION", "APPLICATION" ] }, "ConfigurationTag":{ "type":"structure", "members":{ "configurationType":{ "shape":"ConfigurationItemType", "documentation":"A type of IT asset to tag.
" }, "configurationId":{ "shape":"ConfigurationId", "documentation":"The configuration ID for the item to tag. You can specify a list of keys and values.
" }, "key":{ "shape":"TagKey", "documentation":"A type of tag on which to filter. For example, serverType.
" }, "value":{ "shape":"TagValue", "documentation":"A value on which to filter. For example key = serverType and value = web server.
" }, "timeOfCreation":{ "shape":"TimeStamp", "documentation":"The time the configuration tag was created in Coordinated Universal Time (UTC).
" } }, "documentation":"Tags for a configuration item. Tags are metadata that help you categorize IT assets.
" }, "ConfigurationTagSet":{ "type":"list", "member":{"shape":"ConfigurationTag"} }, "Configurations":{ "type":"list", "member":{"shape":"Configuration"} }, "ConfigurationsDownloadUrl":{"type":"string"}, "ConfigurationsExportId":{ "type":"string", "max":200, "pattern":"\\S*" }, "ConflictErrorException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"", "exception":true }, "ContinuousExportDescription":{ "type":"structure", "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"The unique ID assigned to this export.
" }, "status":{ "shape":"ContinuousExportStatus", "documentation":"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.
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 IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies in the Application Discovery Service User Guide.
FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM 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.
The name of the s3 bucket where the export data parquet files are stored.
" }, "startTime":{ "shape":"TimeStamp", "documentation":"The timestamp representing when the continuous export was started.
" }, "stopTime":{ "shape":"TimeStamp", "documentation":"The timestamp that represents when this continuous export was stopped.
" }, "dataSource":{ "shape":"DataSource", "documentation":"The type of data collector used to gather this data (currently only offered for AGENT).
" }, "schemaStorageConfig":{ "shape":"SchemaStorageConfig", "documentation":"An object which describes how the data is stored.
databaseName - the name of the Glue database used to store the schema.
A list of continuous export descriptions.
" }, "ContinuousExportDescriptions":{ "type":"list", "member":{"shape":"ContinuousExportDescription"} }, "ContinuousExportIds":{ "type":"list", "member":{"shape":"ConfigurationsExportId"} }, "ContinuousExportStatus":{ "type":"string", "enum":[ "START_IN_PROGRESS", "START_FAILED", "ACTIVE", "ERROR", "STOP_IN_PROGRESS", "STOP_FAILED", "INACTIVE" ] }, "CreateApplicationRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"ApplicationName", "documentation":"Name of the application to be created.
" }, "description":{ "shape":"ApplicationDescription", "documentation":"Description of the application to be created.
" } } }, "CreateApplicationResponse":{ "type":"structure", "members":{ "configurationId":{ "shape":"String", "documentation":"Configuration ID of an application to be created.
" } } }, "CreateTagsRequest":{ "type":"structure", "required":[ "configurationIds", "tags" ], "members":{ "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"A list of configuration items that you want to tag.
" }, "tags":{ "shape":"TagSet", "documentation":"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\"}
Number of active discovery agents.
" }, "healthyAgents":{ "shape":"Integer", "documentation":"Number of healthy discovery agents
" }, "blackListedAgents":{ "shape":"Integer", "documentation":"Number of blacklisted discovery agents.
" }, "shutdownAgents":{ "shape":"Integer", "documentation":"Number of discovery agents with status SHUTDOWN.
" }, "unhealthyAgents":{ "shape":"Integer", "documentation":"Number of unhealthy discovery agents.
" }, "totalAgents":{ "shape":"Integer", "documentation":"Total number of discovery agents.
" }, "unknownAgents":{ "shape":"Integer", "documentation":"Number of unknown discovery agents.
" } }, "documentation":"Inventory data for installed discovery agents.
" }, "CustomerAgentlessCollectorInfo":{ "type":"structure", "required":[ "activeAgentlessCollectors", "healthyAgentlessCollectors", "denyListedAgentlessCollectors", "shutdownAgentlessCollectors", "unhealthyAgentlessCollectors", "totalAgentlessCollectors", "unknownAgentlessCollectors" ], "members":{ "activeAgentlessCollectors":{"shape":"Integer"}, "healthyAgentlessCollectors":{"shape":"Integer"}, "denyListedAgentlessCollectors":{"shape":"Integer"}, "shutdownAgentlessCollectors":{"shape":"Integer"}, "unhealthyAgentlessCollectors":{"shape":"Integer"}, "totalAgentlessCollectors":{"shape":"Integer"}, "unknownAgentlessCollectors":{"shape":"Integer"} } }, "CustomerConnectorInfo":{ "type":"structure", "required":[ "activeConnectors", "healthyConnectors", "blackListedConnectors", "shutdownConnectors", "unhealthyConnectors", "totalConnectors", "unknownConnectors" ], "members":{ "activeConnectors":{ "shape":"Integer", "documentation":"Number of active discovery connectors.
" }, "healthyConnectors":{ "shape":"Integer", "documentation":"Number of healthy discovery connectors.
" }, "blackListedConnectors":{ "shape":"Integer", "documentation":"Number of blacklisted discovery connectors.
" }, "shutdownConnectors":{ "shape":"Integer", "documentation":"Number of discovery connectors with status SHUTDOWN,
" }, "unhealthyConnectors":{ "shape":"Integer", "documentation":"Number of unhealthy discovery connectors.
" }, "totalConnectors":{ "shape":"Integer", "documentation":"Total number of discovery connectors.
" }, "unknownConnectors":{ "shape":"Integer", "documentation":"Number of unknown discovery connectors.
" } }, "documentation":"Inventory data for installed discovery connectors.
" }, "CustomerMeCollectorInfo":{ "type":"structure", "required":[ "activeMeCollectors", "healthyMeCollectors", "denyListedMeCollectors", "shutdownMeCollectors", "unhealthyMeCollectors", "totalMeCollectors", "unknownMeCollectors" ], "members":{ "activeMeCollectors":{ "shape":"Integer", "documentation":"The number of active Migration Evaluator collectors.
" }, "healthyMeCollectors":{ "shape":"Integer", "documentation":"The number of healthy Migration Evaluator collectors.
" }, "denyListedMeCollectors":{ "shape":"Integer", "documentation":"The number of deny-listed Migration Evaluator collectors.
" }, "shutdownMeCollectors":{ "shape":"Integer", "documentation":" The number of Migration Evaluator collectors with SHUTDOWN status.
The number of unhealthy Migration Evaluator collectors.
" }, "totalMeCollectors":{ "shape":"Integer", "documentation":"The total number of Migration Evaluator collectors.
" }, "unknownMeCollectors":{ "shape":"Integer", "documentation":"The number of unknown Migration Evaluator collectors.
" } }, "documentation":"The inventory data for installed Migration Evaluator collectors.
" }, "DataSource":{ "type":"string", "enum":["AGENT"] }, "DatabaseName":{ "type":"string", "max":252, "min":1 }, "DeleteApplicationsRequest":{ "type":"structure", "required":["configurationIds"], "members":{ "configurationIds":{ "shape":"ApplicationIdsList", "documentation":"Configuration ID of an application to be deleted.
" } } }, "DeleteApplicationsResponse":{ "type":"structure", "members":{ } }, "DeleteTagsRequest":{ "type":"structure", "required":["configurationIds"], "members":{ "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"A list of configuration items with tags that you want to delete.
" }, "tags":{ "shape":"TagSet", "documentation":"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\"}
The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your Amazon Web Services user account.
" }, "filters":{ "shape":"Filters", "documentation":"You can filter the request using various logical operators and a key-value format. For example:
{\"key\": \"collectionStatus\", \"value\": \"STARTED\"}
The total number of agents/Connectors to return in a single page of output. The maximum value is 100.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
One or more configuration IDs.
" } } }, "DescribeConfigurationsResponse":{ "type":"structure", "members":{ "configurations":{ "shape":"DescribeConfigurationsAttributes", "documentation":"A key in the response map. The value is an array of data.
" } } }, "DescribeContinuousExportsMaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "DescribeContinuousExportsRequest":{ "type":"structure", "members":{ "exportIds":{ "shape":"ContinuousExportIds", "documentation":"The unique IDs assigned to the exports.
" }, "maxResults":{ "shape":"DescribeContinuousExportsMaxResults", "documentation":"A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token from the previous call to DescribeExportTasks.
A list of continuous export descriptions.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token from the previous call to DescribeExportTasks.
A list of continuous export IDs to search for.
" }, "maxResults":{ "shape":"Integer", "documentation":"A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token from the previous call to describe-export-tasks.
" } } }, "DescribeExportConfigurationsResponse":{ "type":"structure", "members":{ "exportsInfo":{ "shape":"ExportsInfo", "documentation":"" }, "nextToken":{ "shape":"NextToken", "documentation":"The token from the previous call to describe-export-tasks.
" } } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "exportIds":{ "shape":"ExportIds", "documentation":"One or more unique identifiers used to query the status of an export request.
" }, "filters":{ "shape":"ExportFilters", "documentation":"One or more filters.
AgentId - ID of the agent whose collected data will be exported
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.
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.
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.
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.
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.
The maximum number of results that you want this request to return, up to 100.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The token to request a specific page of results.
" } } }, "DescribeImportTasksResponse":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The token to request the next page of results.
" }, "tasks":{ "shape":"ImportTaskList", "documentation":"A returned array of import tasks that match any applied filters, up to the specified number of maximum results.
" } } }, "DescribeTagsRequest":{ "type":"structure", "members":{ "filters":{ "shape":"TagFilters", "documentation":"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.
The total number of items to return in a single page of output. The maximum value is 100.
" }, "nextToken":{ "shape":"NextToken", "documentation":"A token to start the list. Use this token to get the next set of results.
" } } }, "DescribeTagsResponse":{ "type":"structure", "members":{ "tags":{ "shape":"ConfigurationTagSet", "documentation":"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.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The call returns a token. Use this token to get the next set of results.
" } } }, "DisassociateConfigurationItemsFromApplicationRequest":{ "type":"structure", "required":[ "applicationConfigurationId", "configurationIds" ], "members":{ "applicationConfigurationId":{ "shape":"ApplicationId", "documentation":"Configuration ID of an application from which each item is disassociated.
" }, "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"Configuration ID of each item to be disassociated from an application.
" } } }, "DisassociateConfigurationItemsFromApplicationResponse":{ "type":"structure", "members":{ } }, "ExportConfigurationsResponse":{ "type":"structure", "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"A unique identifier that you can use to query the export status.
" } } }, "ExportDataFormat":{ "type":"string", "enum":[ "CSV", "GRAPHML" ] }, "ExportDataFormats":{ "type":"list", "member":{"shape":"ExportDataFormat"} }, "ExportFilter":{ "type":"structure", "required":[ "name", "values", "condition" ], "members":{ "name":{ "shape":"FilterName", "documentation":"A single ExportFilter name. Supported filters: agentIds.
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.
Supported condition: EQUALS
Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.
" }, "ExportFilters":{ "type":"list", "member":{"shape":"ExportFilter"} }, "ExportIds":{ "type":"list", "member":{"shape":"ConfigurationsExportId"} }, "ExportInfo":{ "type":"structure", "required":[ "exportId", "exportStatus", "statusMessage", "exportRequestTime" ], "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"A unique identifier used to query an export.
" }, "exportStatus":{ "shape":"ExportStatus", "documentation":"The status of the data export job.
" }, "statusMessage":{ "shape":"ExportStatusMessage", "documentation":"A status message provided for API callers.
" }, "configurationsDownloadUrl":{ "shape":"ConfigurationsDownloadUrl", "documentation":"A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
" }, "exportRequestTime":{ "shape":"ExportRequestTime", "documentation":"The time that the data export was initiated.
" }, "isTruncated":{ "shape":"Boolean", "documentation":"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.
The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.
The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.
Information regarding the export status of discovered data. The value is an array of objects.
" }, "ExportRequestTime":{"type":"timestamp"}, "ExportStatus":{ "type":"string", "enum":[ "FAILED", "SUCCEEDED", "IN_PROGRESS" ] }, "ExportStatusMessage":{"type":"string"}, "ExportsInfo":{ "type":"list", "member":{"shape":"ExportInfo"} }, "Filter":{ "type":"structure", "required":[ "name", "values", "condition" ], "members":{ "name":{ "shape":"String", "documentation":"The name of the filter.
" }, "values":{ "shape":"FilterValues", "documentation":"A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
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.
" } }, "documentation":"A filter that can use conditional operators.
For more information about filters, see Querying Discovered Configuration Items in the Amazon Web Services Application Discovery Service User Guide.
" }, "FilterName":{ "type":"string", "max":1000, "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, "FilterValue":{ "type":"string", "max":1000, "pattern":"(^$|[\\s\\S]*\\S[\\s\\S]*)" }, "FilterValues":{ "type":"list", "member":{"shape":"FilterValue"} }, "Filters":{ "type":"list", "member":{"shape":"Filter"} }, "GetDiscoverySummaryRequest":{ "type":"structure", "members":{ } }, "GetDiscoverySummaryResponse":{ "type":"structure", "members":{ "servers":{ "shape":"Long", "documentation":"The number of servers discovered.
" }, "applications":{ "shape":"Long", "documentation":"The number of applications discovered.
" }, "serversMappedToApplications":{ "shape":"Long", "documentation":"The number of servers mapped to applications.
" }, "serversMappedtoTags":{ "shape":"Long", "documentation":"The number of servers mapped to tags.
" }, "agentSummary":{ "shape":"CustomerAgentInfo", "documentation":"Details about discovered agents, including agent status and health.
" }, "connectorSummary":{ "shape":"CustomerConnectorInfo", "documentation":"Details about discovered connectors, including connector status and health.
" }, "meCollectorSummary":{ "shape":"CustomerMeCollectorInfo", "documentation":"Details about Migration Evaluator collectors, including collector status and health.
" }, "agentlessCollectorSummary":{"shape":"CustomerAgentlessCollectorInfo"} } }, "HomeRegionNotSetException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"The home region is not set. Set the home region to continue.
", "exception":true }, "ImportStatus":{ "type":"string", "enum":[ "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" ] }, "ImportTask":{ "type":"structure", "members":{ "importTaskId":{ "shape":"ImportTaskIdentifier", "documentation":"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":{ "shape":"ClientRequestToken", "documentation":"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":{ "shape":"ImportTaskName", "documentation":"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":{ "shape":"ImportURL", "documentation":"The URL for your import file that you've uploaded to Amazon S3.
" }, "status":{ "shape":"ImportStatus", "documentation":"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.
The time that the import task request was made, presented in the Unix time stamp format.
" }, "importCompletionTime":{ "shape":"TimeStamp", "documentation":"The time that the import task request finished, presented in the Unix time stamp format.
" }, "importDeletedTime":{ "shape":"TimeStamp", "documentation":"The time that the import task request was deleted, presented in the Unix time stamp format.
" }, "serverImportSuccess":{ "shape":"Integer", "documentation":"The total number of server records in the import file that were successfully imported.
" }, "serverImportFailure":{ "shape":"Integer", "documentation":"The total number of server records in the import file that failed to be imported.
" }, "applicationImportSuccess":{ "shape":"Integer", "documentation":"The total number of application records in the import file that were successfully imported.
" }, "applicationImportFailure":{ "shape":"Integer", "documentation":"The total number of application records in the import file that failed to be imported.
" }, "errorsAndFailedEntriesZip":{ "shape":"S3PresignedUrl", "documentation":"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.
" } }, "documentation":"An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
" }, "ImportTaskFilter":{ "type":"structure", "members":{ "name":{ "shape":"ImportTaskFilterName", "documentation":"The name, status, or import task ID for a specific import task.
" }, "values":{ "shape":"ImportTaskFilterValueList", "documentation":"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.
" } }, "documentation":"A name-values pair of elements you can use to filter the results when querying your import tasks. Currently, wildcards are not supported for filters.
When filtering by import status, all other filter values are ignored.
One or more parameters are not valid. Verify the parameters and try again.
", "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.
", "exception":true }, "ListConfigurationsRequest":{ "type":"structure", "required":["configurationType"], "members":{ "configurationType":{ "shape":"ConfigurationItemType", "documentation":"A valid configuration identified by Application Discovery Service.
" }, "filters":{ "shape":"Filters", "documentation":"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.
" }, "maxResults":{ "shape":"Integer", "documentation":"The total number of items to return. The maximum value is 100.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
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.
" } } }, "ListConfigurationsResponse":{ "type":"structure", "members":{ "configurations":{ "shape":"Configurations", "documentation":"Returns configuration details, including the configuration ID, attribute names, and attribute values.
" }, "nextToken":{ "shape":"NextToken", "documentation":"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.
Configuration ID of the server for which neighbors are being listed.
" }, "portInformationNeeded":{ "shape":"Boolean", "documentation":"Flag to indicate if port and protocol information is needed as part of the response.
" }, "neighborConfigurationIds":{ "shape":"ConfigurationIdList", "documentation":"List of configuration IDs to test for one-hop-away.
" }, "maxResults":{ "shape":"Integer", "documentation":"Maximum number of results to return in a single page of output.
" }, "nextToken":{ "shape":"String", "documentation":"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 of distinct servers that are one hop away from the given server.
" }, "nextToken":{ "shape":"String", "documentation":"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.
Count of distinct servers that are one hop away from the given server.
" } } }, "Long":{"type":"long"}, "Message":{"type":"string"}, "NeighborConnectionDetail":{ "type":"structure", "required":[ "sourceServerId", "destinationServerId", "connectionsCount" ], "members":{ "sourceServerId":{ "shape":"ConfigurationId", "documentation":"The ID of the server that opened the network connection.
" }, "destinationServerId":{ "shape":"ConfigurationId", "documentation":"The ID of the server that accepted the network connection.
" }, "destinationPort":{ "shape":"BoxedInteger", "documentation":"The destination network port for the connection.
" }, "transportProtocol":{ "shape":"String", "documentation":"The network protocol used for the connection.
" }, "connectionsCount":{ "shape":"Long", "documentation":"The number of open network connections with the neighboring server.
" } }, "documentation":"Details about neighboring servers.
" }, "NeighborDetailsList":{ "type":"list", "member":{"shape":"NeighborConnectionDetail"} }, "NextToken":{"type":"string"}, "OperationNotPermittedException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"This operation is not permitted.
", "exception":true }, "OrderByElement":{ "type":"structure", "required":["fieldName"], "members":{ "fieldName":{ "shape":"OrderByElementFieldName", "documentation":"The field on which to order.
" }, "sortOrder":{ "shape":"orderString", "documentation":"Ordering direction.
" } }, "documentation":"A field and direction for ordered output.
" }, "OrderByElementFieldName":{ "type":"string", "max":1000, "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, "OrderByList":{ "type":"list", "member":{"shape":"OrderByElement"} }, "ResourceInUseException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.
The specified configuration ID was not located. Verify the configuration ID and try again.
", "exception":true }, "S3Bucket":{"type":"string"}, "S3PresignedUrl":{"type":"string"}, "SchemaStorageConfig":{ "type":"map", "key":{"shape":"DatabaseName"}, "value":{"shape":"String"} }, "ServerInternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"The server experienced an internal error. Try again.
", "exception":true, "fault":true }, "StartContinuousExportRequest":{ "type":"structure", "members":{ } }, "StartContinuousExportResponse":{ "type":"structure", "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"The unique ID assigned to this export.
" }, "s3Bucket":{ "shape":"S3Bucket", "documentation":"The name of the s3 bucket where the export data parquet files are stored.
" }, "startTime":{ "shape":"TimeStamp", "documentation":"The timestamp representing when the continuous export was started.
" }, "dataSource":{ "shape":"DataSource", "documentation":"The type of data collector used to gather this data (currently only offered for AGENT).
" }, "schemaStorageConfig":{ "shape":"SchemaStorageConfig", "documentation":"A dictionary which describes how the data is stored.
databaseName - the name of the Glue database used to store the schema.
The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your 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/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.
Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.
" } } }, "StartExportTaskRequest":{ "type":"structure", "members":{ "exportDataFormat":{ "shape":"ExportDataFormats", "documentation":"The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.
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 Agentless Discovery Connector data and summary data from Application Discovery agents.
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":{ "shape":"TimeStamp", "documentation":"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.
" } } }, "StartExportTaskResponse":{ "type":"structure", "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"A unique identifier used to query the status of an export request.
" } } }, "StartImportTaskRequest":{ "type":"structure", "required":[ "name", "importUrl" ], "members":{ "clientRequestToken":{ "shape":"ClientRequestToken", "documentation":"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.
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":{ "shape":"ImportURL", "documentation":"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
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.
" } } }, "StopContinuousExportRequest":{ "type":"structure", "required":["exportId"], "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"The unique ID assigned to this export.
" } } }, "StopContinuousExportResponse":{ "type":"structure", "members":{ "startTime":{ "shape":"TimeStamp", "documentation":"Timestamp that represents when this continuous export started collecting data.
" }, "stopTime":{ "shape":"TimeStamp", "documentation":"Timestamp that represents when this continuous export was stopped.
" } } }, "StopDataCollectionByAgentIdsRequest":{ "type":"structure", "required":["agentIds"], "members":{ "agentIds":{ "shape":"AgentIds", "documentation":"The IDs of the agents or connectors from which to stop collecting data.
" } } }, "StopDataCollectionByAgentIdsResponse":{ "type":"structure", "members":{ "agentsConfigurationStatus":{ "shape":"AgentConfigurationStatusList", "documentation":"Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.
" } } }, "String":{ "type":"string", "max":10000, "pattern":"[\\s\\S]*" }, "StringMax255":{ "type":"string", "max":255, "min":1, "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, "Tag":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"TagKey", "documentation":"The type of tag on which to filter.
" }, "value":{ "shape":"TagValue", "documentation":"A value for a tag key on which to filter.
" } }, "documentation":"Metadata that help you categorize IT assets.
Do not store sensitive information (like personal data) in tags.
A name of the tag filter.
" }, "values":{ "shape":"FilterValues", "documentation":"Values for the tag filter.
" } }, "documentation":"The tag filter. Valid names are: tagKey, tagValue, configurationId.
Configuration ID of the application to be updated.
" }, "name":{ "shape":"ApplicationName", "documentation":"New name of the application to be updated.
" }, "description":{ "shape":"ApplicationDescription", "documentation":"New description of the application to be updated.
" } } }, "UpdateApplicationResponse":{ "type":"structure", "members":{ } }, "orderString":{ "type":"string", "enum":[ "ASC", "DESC" ] } }, "documentation":"Amazon Web Services Application Discovery Service helps you plan application migration projects. It automatically identifies servers, virtual machines (VMs), and network dependencies in your on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ. Application Discovery Service offers three ways of performing discovery and collecting data about your on-premises servers:
Agentless discovery is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. It does not work in non-VMware environments.
Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment.
Agentless discovery doesn't collect information about network dependencies, only agent-based discovery collects that information.
Agent-based discovery collects a richer set of data than agentless discovery by using the Amazon Web Services Application Discovery Agent, which you install on one or more hosts in your data center.
The agent captures infrastructure and application information, including an inventory of running processes, system performance information, resource utilization, and network dependencies.
The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.
Amazon Web Services Partner Network (APN) solutions integrate with Application Discovery Service, enabling you to import details of your on-premises environment directly into Migration Hub without using the discovery connector or discovery agent.
Third-party application discovery tools can query Amazon Web Services Application Discovery Service, and they can write to the Application Discovery Service database using the public API.
In this way, you can import data into Migration Hub and view it, so that you can associate applications with servers and track migrations.
Recommendations
We recommend that you use agent-based discovery for non-VMware environments, and whenever you want to collect information about network dependencies. You can run agent-based and agentless discovery simultaneously. Use agentless discovery to complete the initial infrastructure assessment quickly, and then install agents on select hosts to collect additional information.
Working With This Guide
This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.
Remember that you must set your Migration Hub home region before you call any of these APIs.
You must make API calls for write actions (create, notify, associate, disassociate, import, or put) while in your home region, or a HomeRegionNotSetException error is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside of your home region.
Although it is unlikely, the Migration Hub home region could change. If you call APIs outside the home region, an InvalidInputException is returned.
You must call GetHomeRegion to obtain the latest Migration Hub home region.
This guide is intended for use with the Amazon Web Services Application Discovery Service User Guide.
All data is handled according to the Amazon Web Services Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.