2022/06/08 - AWS Database Migration Service - 9 new api methods
Changes This release adds DMS Fleet Advisor APIs and exposes functionality for DMS Fleet Advisor. It adds functionality to create and modify fleet advisor instances, and to collect and analyze information about the local data infrastructure.
Returns a list of schemas detected by Fleet Advisor Collectors in your account.
See also: AWS API Documentation
Request Syntax
client.describe_fleet_advisor_schemas(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
NextToken='string'
)
list
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 example Simple .
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 example 15 .
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"
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
Sets the maximum number of records returned in the response.
string
If NextToken is returned by a previous response, there are more results available. The value of NextToken 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.
dict
Response Syntax
{
'FleetAdvisorSchemas': [
{
'CodeLineCount': 123,
'CodeSize': 123,
'Complexity': 'string',
'Server': {
'ServerId': 'string',
'IpAddress': 'string',
'ServerName': 'string'
},
'DatabaseInstance': {
'DatabaseId': 'string',
'DatabaseName': 'string',
'DatabaseIpAddress': 'string',
'DatabaseEngine': 'string'
},
'SchemaId': 'string',
'SchemaName': 'string',
'OriginalSchema': {
'SchemaId': 'string',
'SchemaName': 'string',
'DatabaseId': 'string',
'DatabaseName': 'string',
'DatabaseIpAddress': 'string'
},
'Similarity': 123.0
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FleetAdvisorSchemas (list) --
A collection of SchemaResponse objects.
(dict) --
Describes a schema in a Fleet Advisor collector inventory.
CodeLineCount (integer) --
The number of lines of code in a schema in a Fleet Advisor collector inventory.
CodeSize (integer) --
The size level of the code in a schema in a Fleet Advisor collector inventory.
Complexity (string) --
The complexity level of the code in a schema in a Fleet Advisor collector inventory.
Server (dict) --
The database server for a schema in a Fleet Advisor collector inventory.
ServerId (string) --
The ID of a server in a Fleet Advisor collector inventory.
IpAddress (string) --
The IP address of a server in a Fleet Advisor collector inventory.
ServerName (string) --
The name address of a server in a Fleet Advisor collector inventory.
DatabaseInstance (dict) --
The database for a schema in a Fleet Advisor collector inventory.
DatabaseId (string) --
The ID of a database in a Fleet Advisor collector inventory.
DatabaseName (string) --
The name of a database in a Fleet Advisor collector inventory.
DatabaseIpAddress (string) --
The IP address of a database in a Fleet Advisor collector inventory.
DatabaseEngine (string) --
The database engine of a database in a Fleet Advisor collector inventory, for example PostgreSQL .
SchemaId (string) --
The ID of a schema in a Fleet Advisor collector inventory.
SchemaName (string) --
The name of a schema in a Fleet Advisor collector inventory.
OriginalSchema (dict) --
Describes a schema in a Fleet Advisor collector inventory.
SchemaId (string) --
The ID of a schema in a Fleet Advisor collector inventory.
SchemaName (string) --
The name of a schema in a Fleet Advisor collector inventory.
DatabaseId (string) --
The ID of a database in a Fleet Advisor collector inventory.
DatabaseName (string) --
The name of a database in a Fleet Advisor collector inventory.
DatabaseIpAddress (string) --
The IP address of a database in a Fleet Advisor collector inventory.
Similarity (float) --
The similarity value for a schema in a Fleet Advisor collector inventory. A higher similarity value indicates that a schema is likely to be a duplicate.
NextToken (string) --
If NextToken is returned, there are more results available. The value of NextToken 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.
Provides descriptions of the schemas discovered by your Fleet Advisor collectors.
See also: AWS API Documentation
Request Syntax
client.describe_fleet_advisor_schema_object_summary(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
NextToken='string'
)
list
If you specify any of the following filters, the output includes information for only those schema objects that meet the filter criteria:
schema-id – The ID of the schema, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d .
Example: describe-fleet-advisor-schema-object-summary --filter Name="schema-id",Values="50"
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
Sets the maximum number of records returned in the response.
string
If NextToken is returned by a previous response, there are more results available. The value of NextToken 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.
dict
Response Syntax
{
'FleetAdvisorSchemaObjects': [
{
'SchemaId': 'string',
'ObjectType': 'string',
'NumberOfObjects': 123,
'CodeLineCount': 123,
'CodeSize': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
FleetAdvisorSchemaObjects (list) --
A collection of FleetAdvisorSchemaObjectResponse objects.
(dict) --
Describes a schema object in a Fleet Advisor collector inventory.
SchemaId (string) --
The ID of a schema object in a Fleet Advisor collector inventory.
ObjectType (string) --
The type of the schema object, as reported by the database engine. Examples include the following:
function
trigger
SYSTEM_TABLE
QUEUE
NumberOfObjects (integer) --
The number of objects in a schema object in a Fleet Advisor collector inventory.
CodeLineCount (integer) --
The number of lines of code in a schema object in a Fleet Advisor collector inventory.
CodeSize (integer) --
The size level of the code in a schema object in a Fleet Advisor collector inventory.
NextToken (string) --
If NextToken is returned, there are more results available. The value of NextToken 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.
Returns a list of the Fleet Advisor collectors in your account.
See also: AWS API Documentation
Request Syntax
client.describe_fleet_advisor_collectors(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
NextToken='string'
)
list
If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:
collector-referenced-id – The ID of the collector agent, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d .
collector-name – The name of the collector agent.
An example is: describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
Sets the maximum number of records returned in the response.
string
If NextToken is returned by a previous response, there are more results available. The value of NextToken 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.
dict
Response Syntax
{
'Collectors': [
{
'CollectorReferencedId': 'string',
'CollectorName': 'string',
'CollectorVersion': 'string',
'VersionStatus': 'UP_TO_DATE'|'OUTDATED'|'UNSUPPORTED',
'Description': 'string',
'S3BucketName': 'string',
'ServiceAccessRoleArn': 'string',
'CollectorHealthCheck': {
'CollectorStatus': 'UNREGISTERED'|'ACTIVE',
'LocalCollectorS3Access': True|False,
'WebCollectorS3Access': True|False,
'WebCollectorGrantedRoleBasedAccess': True|False
},
'LastDataReceived': 'string',
'RegisteredDate': 'string',
'CreatedDate': 'string',
'ModifiedDate': 'string',
'InventoryData': {
'NumberOfDatabases': 123,
'NumberOfSchemas': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Collectors (list) --
Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.
(dict) --
Describes a Fleet Advisor collector.
CollectorReferencedId (string) --
The reference ID of the Fleet Advisor collector.
CollectorName (string) --
The name of the Fleet Advisor collector .
CollectorVersion (string) --
The version of your Fleet Advisor collector, in semantic versioning format, for example 1.0.2
VersionStatus (string) --
Whether the collector version is up to date.
Description (string) --
A summary description of the Fleet Advisor collector.
S3BucketName (string) --
The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.
ServiceAccessRoleArn (string) --
The IAM role that grants permissions to access the specified Amazon S3 bucket.
CollectorHealthCheck (dict) --
Describes the last Fleet Advisor collector health check.
CollectorStatus (string) --
The status of the Fleet Advisor collector.
LocalCollectorS3Access (boolean) --
Whether the local collector can access its Amazon S3 bucket.
WebCollectorS3Access (boolean) --
Whether the web collector can access its Amazon S3 bucket.
WebCollectorGrantedRoleBasedAccess (boolean) --
Whether the role that you provided when creating the Fleet Advisor collector has sufficient permissions to access the Fleet Advisor web collector.
LastDataReceived (string) --
The timestamp of the last time the collector received data, in the following format: 2022-01-24T19:04:02.596113Z
RegisteredDate (string) --
The timestamp when DMS registered the collector, in the following format: 2022-01-24T19:04:02.596113Z
CreatedDate (string) --
The timestamp when you created the collector, in the following format: 2022-01-24T19:04:02.596113Z
ModifiedDate (string) --
The timestamp when DMS last modified the collector, in the following format: 2022-01-24T19:04:02.596113Z
InventoryData (dict) --
Describes a Fleet Advisor collector inventory.
NumberOfDatabases (integer) --
The number of databases in the Fleet Advisor collector inventory.
NumberOfSchemas (integer) --
The number of schemas in the Fleet Advisor collector inventory.
NextToken (string) --
If NextToken is returned, there are more results available. The value of NextToken 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.
Provides descriptions of large-scale assessment (LSA) analyses produced by your Fleet Advisor collectors.
See also: AWS API Documentation
Request Syntax
client.describe_fleet_advisor_lsa_analysis(
MaxRecords=123,
NextToken='string'
)
integer
Sets the maximum number of records returned in the response.
string
If NextToken is returned by a previous response, there are more results available. The value of NextToken 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.
dict
Response Syntax
{
'Analysis': [
{
'LsaAnalysisId': 'string',
'Status': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Analysis (list) --
A list of FleetAdvisorLsaAnalysisResponse objects.
(dict) --
Describes a large-scale assessment (LSA) analysis run by a Fleet Advisor collector.
LsaAnalysisId (string) --
The ID of an LSA analysis run by a Fleet Advisor collector.
Status (string) --
The status of an LSA analysis run by a Fleet Advisor collector.
NextToken (string) --
If NextToken is returned, there are more results available. The value of NextToken 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.
Creates a Fleet Advisor collector using the specified parameters.
See also: AWS API Documentation
Request Syntax
client.create_fleet_advisor_collector(
CollectorName='string',
Description='string',
ServiceAccessRoleArn='string',
S3BucketName='string'
)
string
[REQUIRED]
The name of your Fleet Advisor collector (for example, sample-collector ).
string
A summary description of your Fleet Advisor collector.
string
[REQUIRED]
The IAM role that grants permissions to access the specified Amazon S3 bucket.
string
[REQUIRED]
The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.
dict
Response Syntax
{
'CollectorReferencedId': 'string',
'CollectorName': 'string',
'Description': 'string',
'ServiceAccessRoleArn': 'string',
'S3BucketName': 'string'
}
Response Structure
(dict) --
CollectorReferencedId (string) --
The unique ID of the new Fleet Advisor collector, for example: 22fda70c-40d5-4acf-b233-a495bd8eb7f5
CollectorName (string) --
The name of the new Fleet Advisor collector.
Description (string) --
A summary description of the Fleet Advisor collector.
ServiceAccessRoleArn (string) --
The IAM role that grants permissions to access the specified Amazon S3 bucket.
S3BucketName (string) --
The Amazon S3 bucket that the collector uses to store inventory metadata.
Deletes the specified Fleet Advisor collector.
See also: AWS API Documentation
Request Syntax
client.delete_fleet_advisor_collector(
CollectorReferencedId='string'
)
string
[REQUIRED]
The reference ID of the Fleet Advisor collector to delete.
None
Runs large-scale assessment (LSA) analysis on every Fleet Advisor collector in your account.
See also: AWS API Documentation
Request Syntax
client.run_fleet_advisor_lsa_analysis()
dict
Response Syntax
{
'LsaAnalysisId': 'string',
'Status': 'string'
}
Response Structure
(dict) --
LsaAnalysisId (string) --
The ID of the LSA analysis run.
Status (string) --
The status of the LSA analysis, for example COMPLETED .
Deletes the specified Fleet Advisor collector databases.
See also: AWS API Documentation
Request Syntax
client.delete_fleet_advisor_databases(
DatabaseIds=[
'string',
]
)
list
[REQUIRED]
The IDs of the Fleet Advisor collector databases to delete.
(string) --
dict
Response Syntax
{
'DatabaseIds': [
'string',
]
}
Response Structure
(dict) --
DatabaseIds (list) --
The IDs of the databases that the operation deleted.
(string) --
Returns a list of Fleet Advisor databases in your account.
See also: AWS API Documentation
Request Syntax
client.describe_fleet_advisor_databases(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
NextToken='string'
)
list
If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:
database-id – The ID of the database, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d .
database-name – The name of the database.
database-engine – The name of the database engine.
server-ip-address – The IP address of the database server.
database-ip-address – The IP address of the database.
collector-name – The name of the associated Fleet Advisor collector.
An example is: describe-fleet-advisor-databases --filter Name="database-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"
(dict) --
Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.
Name (string) -- [REQUIRED]
The name of the filter as specified for a Describe* or similar operation.
Values (list) -- [REQUIRED]
The filter value, which can specify one or more values used to narrow the returned results.
(string) --
integer
Sets the maximum number of records returned in the response.
string
If NextToken is returned by a previous response, there are more results available. The value of NextToken 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.
dict
Response Syntax
{
'Databases': [
{
'DatabaseId': 'string',
'DatabaseName': 'string',
'IpAddress': 'string',
'NumberOfSchemas': 123,
'Server': {
'ServerId': 'string',
'IpAddress': 'string',
'ServerName': 'string'
},
'SoftwareDetails': {
'Engine': 'string',
'EngineVersion': 'string',
'EngineEdition': 'string',
'ServicePack': 'string',
'SupportLevel': 'string',
'OsArchitecture': 123,
'Tooltip': 'string'
},
'Collectors': [
{
'CollectorReferencedId': 'string',
'CollectorName': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Databases (list) --
Provides descriptions of the Fleet Advisor collector databases, including the database's collector, ID, and name.
(dict) --
Describes a database in a Fleet Advisor collector inventory.
DatabaseId (string) --
The ID of a database in a Fleet Advisor collector inventory.
DatabaseName (string) --
The name of a database in a Fleet Advisor collector inventory.
IpAddress (string) --
The IP address of a database in a Fleet Advisor collector inventory.
NumberOfSchemas (integer) --
The number of schemas in a Fleet Advisor collector inventory database.
Server (dict) --
The server name of a database in a Fleet Advisor collector inventory.
ServerId (string) --
The ID of a server in a Fleet Advisor collector inventory.
IpAddress (string) --
The IP address of a server in a Fleet Advisor collector inventory.
ServerName (string) --
The name address of a server in a Fleet Advisor collector inventory.
SoftwareDetails (dict) --
The software details of a database in a Fleet Advisor collector inventory, such as database engine and version.
Engine (string) --
The database engine of a database in a Fleet Advisor collector inventory, for example Microsoft SQL Server .
EngineVersion (string) --
The database engine version of a database in a Fleet Advisor collector inventory, for example 2019 .
EngineEdition (string) --
The database engine edition of a database in a Fleet Advisor collector inventory, for example Express .
ServicePack (string) --
The service pack level of the database.
SupportLevel (string) --
The support level of the database, for example Mainstream support .
OsArchitecture (integer) --
The operating system architecture of the database.
Tooltip (string) --
Information about the database engine software, for example Mainstream support ends on November 14th, 2024 .
Collectors (list) --
A list of collectors associated with the database.
(dict) --
Briefly describes a Fleet Advisor collector.
CollectorReferencedId (string) --
The reference ID of the Fleet Advisor collector.
CollectorName (string) --
The name of the Fleet Advisor collector.
NextToken (string) --
If NextToken is returned, there are more results available. The value of NextToken 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.