DescribeFleetAdvisorSchemas
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
Request Syntax
{
"Filters": [
{
"Name": "string
",
"Values": [ "string
" ]
}
],
"MaxRecords": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:
-
complexity
– The schema's complexity, for exampleSimple
. -
database-id
– The ID of the schema's database. -
database-ip-address
– The IP address of the schema's database. -
database-name
– The name of the schema's database. -
database-engine
– The name of the schema database's engine. -
original-schema-name
– The name of the schema's database's main schema. -
schema-id
– The ID of the schema, for example15
. -
schema-name
– The name of the schema. -
server-ip-address
– The IP address of the schema database's server.
An example is:
describe-fleet-advisor-schemas --filter Name="schema-id",Values="50"
Type: Array of Filter objects
Required: No
-
- MaxRecords
-
Sets the maximum number of records returned in the response.
Type: Integer
Required: No
- NextToken
-
If
NextToken
is returned by a previous response, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.Type: String
Required: No
Response Syntax
{
"FleetAdvisorSchemas": [
{
"CodeLineCount": number,
"CodeSize": number,
"Complexity": "string",
"DatabaseInstance": {
"DatabaseEngine": "string",
"DatabaseId": "string",
"DatabaseIpAddress": "string",
"DatabaseName": "string"
},
"OriginalSchema": {
"DatabaseId": "string",
"DatabaseIpAddress": "string",
"DatabaseName": "string",
"SchemaId": "string",
"SchemaName": "string"
},
"SchemaId": "string",
"SchemaName": "string",
"Server": {
"IpAddress": "string",
"ServerId": "string",
"ServerName": "string"
},
"Similarity": number
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FleetAdvisorSchemas
-
A collection of
SchemaResponse
objects.Type: Array of SchemaResponse objects
- NextToken
-
If
NextToken
is returned, there are more results available. The value ofNextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: