DatabaseMigrationService / Client / describe_recommendations

describe_recommendations#

DatabaseMigrationService.Client.describe_recommendations(**kwargs)#

Returns a paginated list of target engine recommendations for your source databases.

Request Syntax

response = client.describe_recommendations(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    NextToken='string'
)

Parameters:

Filters (list) –
Filters applied to the target engine recommendations described in the form of key-value pairs.
- (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) –
MaxRecords (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.
NextToken (string) –
Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Recommendations': [
        {
            'DatabaseId': 'string',
            'EngineName': 'string',
            'CreatedDate': 'string',
            'Status': 'string',
            'Preferred': True|False,
            'Settings': {
                'InstanceSizingType': 'string',
                'WorkloadType': 'string'
            },
            'Data': {
                'RdsEngine': {
                    'RequirementsToTarget': {
                        'EngineEdition': 'string',
                        'InstanceVcpu': 123.0,
                        'InstanceMemory': 123.0,
                        'StorageSize': 123,
                        'StorageIops': 123,
                        'DeploymentOption': 'string'
                    },
                    'TargetConfiguration': {
                        'EngineEdition': 'string',
                        'InstanceType': 'string',
                        'InstanceVcpu': 123.0,
                        'InstanceMemory': 123.0,
                        'StorageType': 'string',
                        'StorageSize': 123,
                        'StorageIops': 123,
                        'DeploymentOption': 'string'
                    }
                }
            }
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the MaxRecords value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.
- Recommendations (list) –
  
  The list of recommendations of target engines that Fleet Advisor created for the source database.
  - (dict) –
    
    Provides information that describes a recommendation of a target engine.
    
    A recommendation is a set of possible Amazon Web Services target engines that you can choose to migrate your source on-premises database. In this set, Fleet Advisor suggests a single target engine as the right sized migration destination. To determine this rightsized migration destination, Fleet Advisor uses the inventory metadata and metrics from data collector. You can use recommendations before the start of migration to save costs and reduce risks.
    
    With recommendations, you can explore different target options and compare metrics, so you can make an informed decision when you choose the migration target.
    - DatabaseId (string) –
      
      The identifier of the source database for which Fleet Advisor provided this recommendation.
    - EngineName (string) –
      
      The name of the target engine. Valid values include "rds-aurora-mysql", "rds-aurora-postgresql", "rds-mysql", "rds-oracle", "rds-sql-server", and "rds-postgresql".
    - CreatedDate (string) –
      
      The date when Fleet Advisor created the target engine recommendation.
    - Status (string) –
      
      The status of the target engine recommendation. Valid values include "alternate", "in-progress", "not-viable", and "recommended".
    - Preferred (boolean) –
      
      Indicates that this target is the rightsized migration destination.
    - Settings (dict) –
      
      The settings in JSON format for the preferred target engine parameters. These parameters include capacity, resource utilization, and the usage type (production, development, or testing).
      - InstanceSizingType (string) –
        
        The size of your target instance. Fleet Advisor calculates this value based on your data collection type, such as total capacity and resource utilization. Valid values include "total-capacity" and "utilization".
      - WorkloadType (string) –
        
        The deployment option for your target engine. For production databases, Fleet Advisor chooses Multi-AZ deployment. For development or test databases, Fleet Advisor chooses Single-AZ deployment. Valid values include "development" and "production".
    - Data (dict) –
      
      The recommendation of a target engine for the specified source database.
      - RdsEngine (dict) –
        
        The recommendation of a target Amazon RDS database engine.
        
        RequirementsToTarget (dict) –
        
        Supplemental information about the requirements to the recommended target database on Amazon RDS.
        
        EngineEdition (string) –
        
        The required target Amazon RDS engine edition.
        
        InstanceVcpu (float) –
        
        The required number of virtual CPUs (vCPU) on the Amazon RDS DB instance.
        
        InstanceMemory (float) –
        
        The required memory on the Amazon RDS DB instance.
        
        StorageSize (integer) –
        
        The required Amazon RDS DB instance storage size.
        
        StorageIops (integer) –
        
        The required number of I/O operations completed each second (IOPS) on your Amazon RDS DB instance.
        
        DeploymentOption (string) –
        
        The required deployment option for the Amazon RDS DB instance. Valid values include "MULTI_AZ" for Multi-AZ deployments and "SINGLE_AZ" for Single-AZ deployments.
        
        TargetConfiguration (dict) –
        
        Supplemental information about the configuration of the recommended target database on Amazon RDS.
        
        EngineEdition (string) –
        
        Describes the recommended target Amazon RDS engine edition.
        
        InstanceType (string) –
        
        Describes the recommended target Amazon RDS instance type.
        
        InstanceVcpu (float) –
        
        Describes the number of virtual CPUs (vCPU) on the recommended Amazon RDS DB instance that meets your requirements.
        
        InstanceMemory (float) –
        
        Describes the memory on the recommended Amazon RDS DB instance that meets your requirements.
        
        StorageType (string) –
        
        Describes the storage type of the recommended Amazon RDS DB instance that meets your requirements.
        
        Amazon RDS provides three storage types: General Purpose SSD (also known as gp2 and gp3), Provisioned IOPS SSD (also known as io1), and magnetic (also known as standard).
        
        StorageSize (integer) –
        
        Describes the storage size of the recommended Amazon RDS DB instance that meets your requirements.
        
        StorageIops (integer) –
        
        Describes the number of I/O operations completed each second (IOPS) on the recommended Amazon RDS DB instance that meets your requirements.
        
        DeploymentOption (string) –
        
        Describes the deployment option for the recommended Amazon RDS DB instance. The deployment options include Multi-AZ and Single-AZ deployments. Valid values include "MULTI_AZ" and "SINGLE_AZ".

Exceptions

DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault
DatabaseMigrationService.Client.exceptions.AccessDeniedFault