1240 lines
51 KiB
JSON
1240 lines
51 KiB
JSON
{
|
||
"version":"2.0",
|
||
"metadata":{
|
||
"apiVersion":"2015-11-01",
|
||
"endpointPrefix":"discovery",
|
||
"jsonVersion":"1.1",
|
||
"protocol":"json",
|
||
"serviceFullName":"AWS Application Discovery Service",
|
||
"signatureVersion":"v4",
|
||
"targetPrefix":"AWSPoseidonService_V2015_11_01",
|
||
"uid":"discovery-2015-11-01"
|
||
},
|
||
"operations":{
|
||
"AssociateConfigurationItemsToApplication":{
|
||
"name":"AssociateConfigurationItemsToApplication",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"AssociateConfigurationItemsToApplicationRequest"},
|
||
"output":{"shape":"AssociateConfigurationItemsToApplicationResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Associates one or more configuration items with an application.</p>"
|
||
},
|
||
"CreateApplication":{
|
||
"name":"CreateApplication",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"CreateApplicationRequest"},
|
||
"output":{"shape":"CreateApplicationResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Creates an application with the given name and description.</p>"
|
||
},
|
||
"CreateTags":{
|
||
"name":"CreateTags",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"CreateTagsRequest"},
|
||
"output":{"shape":"CreateTagsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>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.</p>"
|
||
},
|
||
"DeleteApplications":{
|
||
"name":"DeleteApplications",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DeleteApplicationsRequest"},
|
||
"output":{"shape":"DeleteApplicationsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Deletes a list of applications and their associations with configuration items.</p>"
|
||
},
|
||
"DeleteTags":{
|
||
"name":"DeleteTags",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DeleteTagsRequest"},
|
||
"output":{"shape":"DeleteTagsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.</p>"
|
||
},
|
||
"DescribeAgents":{
|
||
"name":"DescribeAgents",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DescribeAgentsRequest"},
|
||
"output":{"shape":"DescribeAgentsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.</p>"
|
||
},
|
||
"DescribeConfigurations":{
|
||
"name":"DescribeConfigurations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DescribeConfigurationsRequest"},
|
||
"output":{"shape":"DescribeConfigurationsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.</p> <p>For a complete list of outputs for each asset type, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#DescribeConfigurations\">Querying Discovered Configuration Items</a>.</p>"
|
||
},
|
||
"DescribeExportConfigurations":{
|
||
"name":"DescribeExportConfigurations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DescribeExportConfigurationsRequest"},
|
||
"output":{"shape":"DescribeExportConfigurationsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.</p>"
|
||
},
|
||
"DescribeTags":{
|
||
"name":"DescribeTags",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DescribeTagsRequest"},
|
||
"output":{"shape":"DescribeTagsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of all tags assigned to a specific configuration item.</p>"
|
||
},
|
||
"DisassociateConfigurationItemsFromApplication":{
|
||
"name":"DisassociateConfigurationItemsFromApplication",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"DisassociateConfigurationItemsFromApplicationRequest"},
|
||
"output":{"shape":"DisassociateConfigurationItemsFromApplicationResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Disassociates one or more configuration items from an application.</p>"
|
||
},
|
||
"ExportConfigurations":{
|
||
"name":"ExportConfigurations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"output":{"shape":"ExportConfigurationsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"},
|
||
{"shape":"OperationNotPermittedException"}
|
||
],
|
||
"documentation":"<p>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 which you can query using the <i>DescribeExportConfigurations</i> API. The system imposes a limit of two configuration exports in six hours.</p>"
|
||
},
|
||
"GetDiscoverySummary":{
|
||
"name":"GetDiscoverySummary",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"GetDiscoverySummaryRequest"},
|
||
"output":{"shape":"GetDiscoverySummaryResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Retrieves a short summary of discovered assets.</p>"
|
||
},
|
||
"ListConfigurations":{
|
||
"name":"ListConfigurations",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"ListConfigurationsRequest"},
|
||
"output":{"shape":"ListConfigurationsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Retrieves a list of configuration items according to criteria you specify in a filter. The filter criteria identify relationship requirements.</p>"
|
||
},
|
||
"ListServerNeighbors":{
|
||
"name":"ListServerNeighbors",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"ListServerNeighborsRequest"},
|
||
"output":{"shape":"ListServerNeighborsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Retrieves a list of servers which are one network hop away from a specified server.</p>"
|
||
},
|
||
"StartDataCollectionByAgentIds":{
|
||
"name":"StartDataCollectionByAgentIds",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"StartDataCollectionByAgentIdsRequest"},
|
||
"output":{"shape":"StartDataCollectionByAgentIdsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Instructs the specified agents or Connectors to start collecting data.</p>"
|
||
},
|
||
"StopDataCollectionByAgentIds":{
|
||
"name":"StopDataCollectionByAgentIds",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"StopDataCollectionByAgentIdsRequest"},
|
||
"output":{"shape":"StopDataCollectionByAgentIdsResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Instructs the specified agents or Connectors to stop collecting data.</p>"
|
||
},
|
||
"UpdateApplication":{
|
||
"name":"UpdateApplication",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/"
|
||
},
|
||
"input":{"shape":"UpdateApplicationRequest"},
|
||
"output":{"shape":"UpdateApplicationResponse"},
|
||
"errors":[
|
||
{"shape":"AuthorizationErrorException"},
|
||
{"shape":"InvalidParameterException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ServerInternalErrorException"}
|
||
],
|
||
"documentation":"<p>Updates metadata about an application.</p>"
|
||
}
|
||
},
|
||
"shapes":{
|
||
"AgentConfigurationStatus":{
|
||
"type":"structure",
|
||
"members":{
|
||
"agentId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The agent/Connector ID.</p>"
|
||
},
|
||
"operationSucceeded":{
|
||
"shape":"Boolean",
|
||
"documentation":"<p>Information about the status of the <code>StartDataCollection</code> and <code>StopDataCollection</code> operations. The system has recorded the data collection operation. The agent/Connector receives this command the next time it polls for a new command. </p>"
|
||
},
|
||
"description":{
|
||
"shape":"String",
|
||
"documentation":"<p>A description of the operation performed.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>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 or not the agent/Connector configuration was updated.</p>"
|
||
},
|
||
"AgentConfigurationStatusList":{
|
||
"type":"list",
|
||
"member":{"shape":"AgentConfigurationStatus"}
|
||
},
|
||
"AgentId":{"type":"string"},
|
||
"AgentIds":{
|
||
"type":"list",
|
||
"member":{"shape":"AgentId"}
|
||
},
|
||
"AgentInfo":{
|
||
"type":"structure",
|
||
"members":{
|
||
"agentId":{
|
||
"shape":"AgentId",
|
||
"documentation":"<p>The agent or connector ID.</p>"
|
||
},
|
||
"hostName":{
|
||
"shape":"String",
|
||
"documentation":"<p>The name of the host where the agent or connector resides. The host can be a server or virtual machine.</p>"
|
||
},
|
||
"agentNetworkInfoList":{
|
||
"shape":"AgentNetworkInfoList",
|
||
"documentation":"<p>Network details about the host where the agent or connector resides.</p>"
|
||
},
|
||
"connectorId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The ID of the connector.</p>"
|
||
},
|
||
"version":{
|
||
"shape":"String",
|
||
"documentation":"<p>The agent or connector version.</p>"
|
||
},
|
||
"health":{
|
||
"shape":"AgentStatus",
|
||
"documentation":"<p>The health of the agent or connector.</p>"
|
||
},
|
||
"lastHealthPingTime":{
|
||
"shape":"String",
|
||
"documentation":"<p>Time since agent or connector health was reported.</p>"
|
||
},
|
||
"collectionStatus":{
|
||
"shape":"String",
|
||
"documentation":"<p>Status of the collection process for an agent or connector.</p>"
|
||
},
|
||
"agentType":{
|
||
"shape":"String",
|
||
"documentation":"<p>Type of agent.</p>"
|
||
},
|
||
"registeredTime":{
|
||
"shape":"String",
|
||
"documentation":"<p>Agent's first registration time stamp in UTC.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Information about agents or connectors associated with the user’s AWS 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.</p>"
|
||
},
|
||
"AgentNetworkInfo":{
|
||
"type":"structure",
|
||
"members":{
|
||
"ipAddress":{
|
||
"shape":"String",
|
||
"documentation":"<p>The IP address for the host where the agent/Connector resides.</p>"
|
||
},
|
||
"macAddress":{
|
||
"shape":"String",
|
||
"documentation":"<p>The MAC address for the host where the agent/Connector resides.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Network details about the host where the agent/Connector resides.</p>"
|
||
},
|
||
"AgentNetworkInfoList":{
|
||
"type":"list",
|
||
"member":{"shape":"AgentNetworkInfo"}
|
||
},
|
||
"AgentStatus":{
|
||
"type":"string",
|
||
"enum":[
|
||
"HEALTHY",
|
||
"UNHEALTHY",
|
||
"RUNNING",
|
||
"UNKNOWN",
|
||
"BLACKLISTED",
|
||
"SHUTDOWN"
|
||
]
|
||
},
|
||
"AgentsInfo":{
|
||
"type":"list",
|
||
"member":{"shape":"AgentInfo"}
|
||
},
|
||
"ApplicationId":{"type":"string"},
|
||
"ApplicationIdsList":{
|
||
"type":"list",
|
||
"member":{"shape":"ApplicationId"}
|
||
},
|
||
"AssociateConfigurationItemsToApplicationRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"applicationConfigurationId",
|
||
"configurationIds"
|
||
],
|
||
"members":{
|
||
"applicationConfigurationId":{
|
||
"shape":"ApplicationId",
|
||
"documentation":"<p>The configuration ID of an application with which items are to be associated.</p>"
|
||
},
|
||
"configurationIds":{
|
||
"shape":"ConfigurationIdList",
|
||
"documentation":"<p>The ID of each configuration item to be associated with an application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"AssociateConfigurationItemsToApplicationResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"AuthorizationErrorException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"Message"}
|
||
},
|
||
"documentation":"<p>The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.</p>",
|
||
"exception":true
|
||
},
|
||
"Boolean":{"type":"boolean"},
|
||
"BoxedInteger":{
|
||
"type":"integer",
|
||
"box":true
|
||
},
|
||
"Condition":{"type":"string"},
|
||
"Configuration":{
|
||
"type":"map",
|
||
"key":{"shape":"String"},
|
||
"value":{"shape":"String"}
|
||
},
|
||
"ConfigurationId":{"type":"string"},
|
||
"ConfigurationIdList":{
|
||
"type":"list",
|
||
"member":{"shape":"ConfigurationId"}
|
||
},
|
||
"ConfigurationItemType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"SERVER",
|
||
"PROCESS",
|
||
"CONNECTION",
|
||
"APPLICATION"
|
||
]
|
||
},
|
||
"ConfigurationTag":{
|
||
"type":"structure",
|
||
"members":{
|
||
"configurationType":{
|
||
"shape":"ConfigurationItemType",
|
||
"documentation":"<p>A type of IT asset that you want to tag.</p>"
|
||
},
|
||
"configurationId":{
|
||
"shape":"ConfigurationId",
|
||
"documentation":"<p>The configuration ID for the item you want to tag. You can specify a list of keys and values.</p>"
|
||
},
|
||
"key":{
|
||
"shape":"TagKey",
|
||
"documentation":"<p>A type of tag to filter on. For example, <i>serverType</i>.</p>"
|
||
},
|
||
"value":{
|
||
"shape":"TagValue",
|
||
"documentation":"<p>A value to filter on. For example <i>key = serverType</i> and <i>value = web server</i>.</p>"
|
||
},
|
||
"timeOfCreation":{
|
||
"shape":"TimeStamp",
|
||
"documentation":"<p>The time the configuration tag was created in Coordinated Universal Time (UTC).</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Tags for a configuration item. Tags are metadata that help you categorize IT assets.</p>"
|
||
},
|
||
"ConfigurationTagSet":{
|
||
"type":"list",
|
||
"member":{
|
||
"shape":"ConfigurationTag",
|
||
"locationName":"item"
|
||
}
|
||
},
|
||
"Configurations":{
|
||
"type":"list",
|
||
"member":{"shape":"Configuration"}
|
||
},
|
||
"ConfigurationsDownloadUrl":{"type":"string"},
|
||
"ConfigurationsExportId":{"type":"string"},
|
||
"CreateApplicationRequest":{
|
||
"type":"structure",
|
||
"required":["name"],
|
||
"members":{
|
||
"name":{
|
||
"shape":"String",
|
||
"documentation":"<p>Name of the application to be created.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"String",
|
||
"documentation":"<p>Description of the application to be created.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateApplicationResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"configurationId":{
|
||
"shape":"String",
|
||
"documentation":"<p>Configuration ID of an application to be created.</p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateTagsRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"configurationIds",
|
||
"tags"
|
||
],
|
||
"members":{
|
||
"configurationIds":{
|
||
"shape":"ConfigurationIdList",
|
||
"documentation":"<p>A list of configuration items that you want to tag.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagSet",
|
||
"documentation":"<p>Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a <i>key</i>-<i>value</i> format. For example:</p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p>"
|
||
}
|
||
}
|
||
},
|
||
"CreateTagsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"CustomerAgentInfo":{
|
||
"type":"structure",
|
||
"required":[
|
||
"activeAgents",
|
||
"healthyAgents",
|
||
"blackListedAgents",
|
||
"shutdownAgents",
|
||
"unhealthyAgents",
|
||
"totalAgents",
|
||
"unknownAgents"
|
||
],
|
||
"members":{
|
||
"activeAgents":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of active discovery agents.</p>"
|
||
},
|
||
"healthyAgents":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of healthy discovery agents</p>"
|
||
},
|
||
"blackListedAgents":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of blacklisted discovery agents.</p>"
|
||
},
|
||
"shutdownAgents":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of discovery agents with status SHUTDOWN.</p>"
|
||
},
|
||
"unhealthyAgents":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of unhealthy discovery agents.</p>"
|
||
},
|
||
"totalAgents":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Total number of discovery agents.</p>"
|
||
},
|
||
"unknownAgents":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of unknown discovery agents.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Inventory data for installed discovery agents.</p>"
|
||
},
|
||
"CustomerConnectorInfo":{
|
||
"type":"structure",
|
||
"required":[
|
||
"activeConnectors",
|
||
"healthyConnectors",
|
||
"blackListedConnectors",
|
||
"shutdownConnectors",
|
||
"unhealthyConnectors",
|
||
"totalConnectors",
|
||
"unknownConnectors"
|
||
],
|
||
"members":{
|
||
"activeConnectors":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of active discovery connectors.</p>"
|
||
},
|
||
"healthyConnectors":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of healthy discovery connectors.</p>"
|
||
},
|
||
"blackListedConnectors":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of blacklisted discovery connectors.</p>"
|
||
},
|
||
"shutdownConnectors":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of discovery connectors with status SHUTDOWN,</p>"
|
||
},
|
||
"unhealthyConnectors":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of unhealthy discovery connectors.</p>"
|
||
},
|
||
"totalConnectors":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Total number of discovery connectors.</p>"
|
||
},
|
||
"unknownConnectors":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Number of unknown discovery connectors.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Inventory data for installed discovery connectors.</p>"
|
||
},
|
||
"DeleteApplicationsRequest":{
|
||
"type":"structure",
|
||
"required":["configurationIds"],
|
||
"members":{
|
||
"configurationIds":{
|
||
"shape":"ApplicationIdsList",
|
||
"documentation":"<p>Configuration ID of an application to be deleted.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteApplicationsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"DeleteTagsRequest":{
|
||
"type":"structure",
|
||
"required":["configurationIds"],
|
||
"members":{
|
||
"configurationIds":{
|
||
"shape":"ConfigurationIdList",
|
||
"documentation":"<p>A list of configuration items with tags that you want to delete.</p>"
|
||
},
|
||
"tags":{
|
||
"shape":"TagSet",
|
||
"documentation":"<p>Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a <i>key</i>-<i>value</i> format. For example:</p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p>"
|
||
}
|
||
}
|
||
},
|
||
"DeleteTagsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"DescribeAgentsRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"agentIds":{
|
||
"shape":"AgentIds",
|
||
"documentation":"<p>The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.</p>"
|
||
},
|
||
"filters":{
|
||
"shape":"Filters",
|
||
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"collectionStatus\", \"value\": \"STARTED\"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/managing-agent.html\">Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector </a>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>The total number of agents/Connectors to return in a single page of output. The maximum value is 100.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> 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.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeAgentsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"agentsInfo":{
|
||
"shape":"AgentsInfo",
|
||
"documentation":"<p>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.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Token to retrieve the next set of results. For example, if you specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> 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.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeConfigurationsAttribute":{
|
||
"type":"map",
|
||
"key":{"shape":"String"},
|
||
"value":{"shape":"String"}
|
||
},
|
||
"DescribeConfigurationsAttributes":{
|
||
"type":"list",
|
||
"member":{"shape":"DescribeConfigurationsAttribute"}
|
||
},
|
||
"DescribeConfigurationsRequest":{
|
||
"type":"structure",
|
||
"required":["configurationIds"],
|
||
"members":{
|
||
"configurationIds":{
|
||
"shape":"ConfigurationIdList",
|
||
"documentation":"<p>One or more configuration IDs.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeConfigurationsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"configurations":{
|
||
"shape":"DescribeConfigurationsAttributes",
|
||
"documentation":"<p>A key in the response map. The value is an array of data.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeExportConfigurationsRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"exportIds":{
|
||
"shape":"ExportIds",
|
||
"documentation":"<p>A unique identifier that you can use to query the export status.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>The maximum number of results that you want to display as a part of the query.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>A token to get the next set of results. For example, if you specified 100 IDs for <code>DescribeExportConfigurationsRequest$exportIds</code> but set <code>DescribeExportConfigurationsRequest$maxResults</code> to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeExportConfigurationsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"exportsInfo":{
|
||
"shape":"ExportsInfo",
|
||
"documentation":"<p>Returns export details. When the status is complete, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>A token to get the next set of results. For example, if you specified 100 IDs for <code>DescribeExportConfigurationsRequest$exportIds</code> but set <code>DescribeExportConfigurationsRequest$maxResults</code> to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeTagsRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
"filters":{
|
||
"shape":"TagFilters",
|
||
"documentation":"<p>You can filter the list using a <i>key</i>-<i>value</i> format. You can separate these items by using logical operators. Allowed filters include <code>tagKey</code>, <code>tagValue</code>, and <code>configurationId</code>. </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/managing-agents.html\">Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector </a>.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>The total number of items to return in a single page of output. The maximum value is 100.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>A token to start the list. Use this token to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DescribeTagsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"tags":{
|
||
"shape":"ConfigurationTagSet",
|
||
"documentation":"<p>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.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>The call returns a token. Use this token to get the next set of results.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DisassociateConfigurationItemsFromApplicationRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"applicationConfigurationId",
|
||
"configurationIds"
|
||
],
|
||
"members":{
|
||
"applicationConfigurationId":{
|
||
"shape":"ApplicationId",
|
||
"documentation":"<p>Configuration ID of an application from which each item will be disassociated.</p>"
|
||
},
|
||
"configurationIds":{
|
||
"shape":"ConfigurationIdList",
|
||
"documentation":"<p>Configuration ID of each item be be disassociated from an application.</p>"
|
||
}
|
||
}
|
||
},
|
||
"DisassociateConfigurationItemsFromApplicationResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"ExportConfigurationsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"exportId":{
|
||
"shape":"ConfigurationsExportId",
|
||
"documentation":"<p>A unique identifier that you can use to query the export status.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ExportIds":{
|
||
"type":"list",
|
||
"member":{"shape":"ConfigurationsExportId"}
|
||
},
|
||
"ExportInfo":{
|
||
"type":"structure",
|
||
"required":[
|
||
"exportId",
|
||
"exportStatus",
|
||
"statusMessage",
|
||
"exportRequestTime"
|
||
],
|
||
"members":{
|
||
"exportId":{
|
||
"shape":"ConfigurationsExportId",
|
||
"documentation":"<p>A unique identifier that you can use to query the export.</p>"
|
||
},
|
||
"exportStatus":{
|
||
"shape":"ExportStatus",
|
||
"documentation":"<p>The status of the configuration data export. The status can succeed, fail, or be in-progress.</p>"
|
||
},
|
||
"statusMessage":{
|
||
"shape":"ExportStatusMessage",
|
||
"documentation":"<p>Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.</p>"
|
||
},
|
||
"configurationsDownloadUrl":{
|
||
"shape":"ConfigurationsDownloadUrl",
|
||
"documentation":"<p>A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.</p>"
|
||
},
|
||
"exportRequestTime":{
|
||
"shape":"ExportRequestTime",
|
||
"documentation":"<p>The time the configuration data export was initiated.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Information regarding the export status of the discovered data. The value is an array of objects.</p>"
|
||
},
|
||
"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":"<p>The name of the filter.</p>"
|
||
},
|
||
"values":{
|
||
"shape":"FilterValues",
|
||
"documentation":"<p>A string value that you want to filter on. For example, if you choose the <code>destinationServer.osVersion</code> filter name, you could specify <code>Ubuntu</code> for the value.</p>"
|
||
},
|
||
"condition":{
|
||
"shape":"Condition",
|
||
"documentation":"<p>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 <i>AND</i>. If you specify multiple values for a particular filter, the system differentiates the values using <i>OR</i>. Calling either <i>DescribeConfigurations</i> or <i>ListConfigurations</i> returns attributes of matching configuration items.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>A filter that can use conditional operators.</p> <p>for a complete list of filters and guidance for using them with the Application Discovery Service, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html\">Querying Discovered Configuration Items</a>.</p>"
|
||
},
|
||
"FilterName":{"type":"string"},
|
||
"FilterValue":{"type":"string"},
|
||
"FilterValues":{
|
||
"type":"list",
|
||
"member":{
|
||
"shape":"FilterValue",
|
||
"locationName":"item"
|
||
}
|
||
},
|
||
"Filters":{
|
||
"type":"list",
|
||
"member":{"shape":"Filter"}
|
||
},
|
||
"GetDiscoverySummaryRequest":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"GetDiscoverySummaryResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"servers":{
|
||
"shape":"Long",
|
||
"documentation":"<p>Number of servers discovered.</p>"
|
||
},
|
||
"applications":{
|
||
"shape":"Long",
|
||
"documentation":"<p>Number of applications discovered.</p>"
|
||
},
|
||
"serversMappedToApplications":{
|
||
"shape":"Long",
|
||
"documentation":"<p>Number of servers mapped to applications.</p>"
|
||
},
|
||
"serversMappedtoTags":{
|
||
"shape":"Long",
|
||
"documentation":"<p>Number of servers mapped to tags.</p>"
|
||
},
|
||
"agentSummary":{
|
||
"shape":"CustomerAgentInfo",
|
||
"documentation":"<p>Details about discovered agents, including agent status and health.</p>"
|
||
},
|
||
"connectorSummary":{
|
||
"shape":"CustomerConnectorInfo",
|
||
"documentation":"<p>Details about discovered connectors, including connector status and health.</p>"
|
||
}
|
||
}
|
||
},
|
||
"Integer":{"type":"integer"},
|
||
"InvalidParameterException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"Message"}
|
||
},
|
||
"documentation":"<p>One or more parameters are not valid. Verify the parameters and try again.</p>",
|
||
"exception":true
|
||
},
|
||
"InvalidParameterValueException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"Message"}
|
||
},
|
||
"documentation":"<p>The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.</p>",
|
||
"exception":true
|
||
},
|
||
"ListConfigurationsRequest":{
|
||
"type":"structure",
|
||
"required":["configurationType"],
|
||
"members":{
|
||
"configurationType":{
|
||
"shape":"ConfigurationItemType",
|
||
"documentation":"<p>A valid configuration identified by the Discovery Service. </p>"
|
||
},
|
||
"filters":{
|
||
"shape":"Filters",
|
||
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#ListConfigurations\">Querying Discovered Configuration Items</a>. </p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>The total number of items to return. The maximum value is 100.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set <code>ListConfigurationsRequest$maxResults</code> 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.</p>"
|
||
},
|
||
"orderBy":{
|
||
"shape":"OrderByList",
|
||
"documentation":"<p>Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#ListConfigurations\">Querying Discovered Configuration Items</a>.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListConfigurationsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"configurations":{
|
||
"shape":"Configurations",
|
||
"documentation":"<p>Returns configuration details, including the configuration ID, attribute names, and attribute values.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"NextToken",
|
||
"documentation":"<p>Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set <code>ListConfigurationsRequest$maxResults</code> 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.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListServerNeighborsRequest":{
|
||
"type":"structure",
|
||
"required":["configurationId"],
|
||
"members":{
|
||
"configurationId":{
|
||
"shape":"ConfigurationId",
|
||
"documentation":"<p>Configuration ID of the server for which neighbors are being listed.</p>"
|
||
},
|
||
"portInformationNeeded":{
|
||
"shape":"Boolean",
|
||
"documentation":"<p>Flag to indicate if port and protocol information is needed as part of the response.</p>"
|
||
},
|
||
"neighborConfigurationIds":{
|
||
"shape":"ConfigurationIdList",
|
||
"documentation":"<p>List of configuration IDs to test for one-hop-away.</p>"
|
||
},
|
||
"maxResults":{
|
||
"shape":"Integer",
|
||
"documentation":"<p>Maximum number of results to return in a single page of output.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>ListServerNeighborsRequest$neighborConfigurationIds</code> but set <code>ListServerNeighborsRequest$maxResults</code> 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.</p>"
|
||
}
|
||
}
|
||
},
|
||
"ListServerNeighborsResponse":{
|
||
"type":"structure",
|
||
"required":["neighbors"],
|
||
"members":{
|
||
"neighbors":{
|
||
"shape":"NeighborDetailsList",
|
||
"documentation":"<p>List of distinct servers that are one hop away from the given server.</p>"
|
||
},
|
||
"nextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>Token to retrieve the next set of results. For example, if you specified 100 IDs for <code>ListServerNeighborsRequest$neighborConfigurationIds</code> but set <code>ListServerNeighborsRequest$maxResults</code> 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.</p>"
|
||
},
|
||
"knownDependencyCount":{
|
||
"shape":"Long",
|
||
"documentation":"<p>Count of distinct servers that are one hop away from the given server.</p>"
|
||
}
|
||
}
|
||
},
|
||
"Long":{"type":"long"},
|
||
"Message":{"type":"string"},
|
||
"NeighborConnectionDetail":{
|
||
"type":"structure",
|
||
"required":[
|
||
"sourceServerId",
|
||
"destinationServerId",
|
||
"connectionsCount"
|
||
],
|
||
"members":{
|
||
"sourceServerId":{
|
||
"shape":"ConfigurationId",
|
||
"documentation":"<p>ID of server that opened the network connection.</p>"
|
||
},
|
||
"destinationServerId":{
|
||
"shape":"ConfigurationId",
|
||
"documentation":"<p>ID of the server that accepted the networker connection.</p>"
|
||
},
|
||
"destinationPort":{
|
||
"shape":"BoxedInteger",
|
||
"documentation":"<p>Destination network port for the connection.</p>"
|
||
},
|
||
"transportProtocol":{
|
||
"shape":"String",
|
||
"documentation":"<p>Network protocol used for the connection.</p>"
|
||
},
|
||
"connectionsCount":{
|
||
"shape":"Long",
|
||
"documentation":"<p>Number of open network connections with the neighboring server.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Details about neighboring servers.</p>"
|
||
},
|
||
"NeighborDetailsList":{
|
||
"type":"list",
|
||
"member":{"shape":"NeighborConnectionDetail"}
|
||
},
|
||
"NextToken":{"type":"string"},
|
||
"OperationNotPermittedException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"Message"}
|
||
},
|
||
"documentation":"<p>This operation is not permitted.</p>",
|
||
"exception":true
|
||
},
|
||
"OrderByElement":{
|
||
"type":"structure",
|
||
"required":["fieldName"],
|
||
"members":{
|
||
"fieldName":{
|
||
"shape":"String",
|
||
"documentation":"<p>Field to order on.</p>"
|
||
},
|
||
"sortOrder":{
|
||
"shape":"orderString",
|
||
"documentation":"<p>Ordering direction.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Field and direction for ordered output.</p>"
|
||
},
|
||
"OrderByList":{
|
||
"type":"list",
|
||
"member":{"shape":"OrderByElement"}
|
||
},
|
||
"ResourceNotFoundException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"Message"}
|
||
},
|
||
"documentation":"<p>The specified configuration ID was not located. Verify the configuration ID and try again.</p>",
|
||
"exception":true
|
||
},
|
||
"ServerInternalErrorException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"message":{"shape":"Message"}
|
||
},
|
||
"documentation":"<p>The server experienced an internal error. Try again.</p>",
|
||
"exception":true,
|
||
"fault":true
|
||
},
|
||
"StartDataCollectionByAgentIdsRequest":{
|
||
"type":"structure",
|
||
"required":["agentIds"],
|
||
"members":{
|
||
"agentIds":{
|
||
"shape":"AgentIds",
|
||
"documentation":"<p>The IDs of the agents or Connectors that you want to start collecting data. If you send a request to an agent/Connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the <i>Description</i> 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 <code>Failed</code> in the <i>Description</i> field.</p>"
|
||
}
|
||
}
|
||
},
|
||
"StartDataCollectionByAgentIdsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"agentsConfigurationStatus":{
|
||
"shape":"AgentConfigurationStatusList",
|
||
"documentation":"<p>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 or not the agent/Connector configuration was updated.</p>"
|
||
}
|
||
}
|
||
},
|
||
"StopDataCollectionByAgentIdsRequest":{
|
||
"type":"structure",
|
||
"required":["agentIds"],
|
||
"members":{
|
||
"agentIds":{
|
||
"shape":"AgentIds",
|
||
"documentation":"<p>The IDs of the agents or Connectors that you want to stop collecting data.</p>"
|
||
}
|
||
}
|
||
},
|
||
"StopDataCollectionByAgentIdsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"agentsConfigurationStatus":{
|
||
"shape":"AgentConfigurationStatusList",
|
||
"documentation":"<p>Information about agents or the Connector that were instructed to stop collecting data. Information includes the agent/Connector ID, a description of the operation performed, and whether or not the agent/Connector configuration was updated.</p>"
|
||
}
|
||
}
|
||
},
|
||
"String":{"type":"string"},
|
||
"Tag":{
|
||
"type":"structure",
|
||
"required":[
|
||
"key",
|
||
"value"
|
||
],
|
||
"members":{
|
||
"key":{
|
||
"shape":"TagKey",
|
||
"documentation":"<p>A type of tag to filter on.</p>"
|
||
},
|
||
"value":{
|
||
"shape":"TagValue",
|
||
"documentation":"<p>A value for a tag key to filter on.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Metadata that help you categorize IT assets.</p>"
|
||
},
|
||
"TagFilter":{
|
||
"type":"structure",
|
||
"required":[
|
||
"name",
|
||
"values"
|
||
],
|
||
"members":{
|
||
"name":{
|
||
"shape":"FilterName",
|
||
"documentation":"<p>A name of a tag filter.</p>"
|
||
},
|
||
"values":{
|
||
"shape":"FilterValues",
|
||
"documentation":"<p>Values of a tag filter.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The name of a tag filter. Valid names are: <code>tagKey</code>, <code>tagValue</code>, <code>configurationId</code>.</p>"
|
||
},
|
||
"TagFilters":{
|
||
"type":"list",
|
||
"member":{"shape":"TagFilter"}
|
||
},
|
||
"TagKey":{"type":"string"},
|
||
"TagSet":{
|
||
"type":"list",
|
||
"member":{
|
||
"shape":"Tag",
|
||
"locationName":"item"
|
||
}
|
||
},
|
||
"TagValue":{"type":"string"},
|
||
"TimeStamp":{"type":"timestamp"},
|
||
"UpdateApplicationRequest":{
|
||
"type":"structure",
|
||
"required":["configurationId"],
|
||
"members":{
|
||
"configurationId":{
|
||
"shape":"ApplicationId",
|
||
"documentation":"<p>Configuration ID of the application to be updated.</p>"
|
||
},
|
||
"name":{
|
||
"shape":"String",
|
||
"documentation":"<p>New name of the application to be updated.</p>"
|
||
},
|
||
"description":{
|
||
"shape":"String",
|
||
"documentation":"<p>New description of the application to be updated.</p>"
|
||
}
|
||
}
|
||
},
|
||
"UpdateApplicationResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
}
|
||
},
|
||
"orderString":{
|
||
"type":"string",
|
||
"enum":[
|
||
"ASC",
|
||
"DESC"
|
||
]
|
||
}
|
||
},
|
||
"documentation":"<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/faqs/\">FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation.</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. 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 software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.</p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using Amazon software, the AWS 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 installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query the Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, sign up for the AWS Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/preview/\">here</a>. We will send you information about how to get started.</p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>"
|
||
}
|