Migration Hub Strategy Recommendations

Retrieves a list of all the servers fetched from customer vCenter using Strategy Recommendation Collector.

See also: AWS API Documentation

Request Syntax

client.list_analyzable_servers(
    maxResults=123,
    nextToken='string',
    sort='ASC'|'DESC'
)

type maxResults

integer

param maxResults

The maximum number of items to include in the response. The maximum value is 100.

type nextToken

string

param nextToken

The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

type sort

string

param sort

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

rtype

dict

returns

Response Syntax

{
    'analyzableServers': [
        {
            'hostname': 'string',
            'ipAddress': 'string',
            'source': 'string',
            'vmId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  Represents output for ListAnalyzableServers operation.

  • analyzableServers (list) --

    The list of analyzable servers with summary information about each server.

    • (dict) --

      Summary information about an analyzable server.

      • hostname (string) --

        The host name of the analyzable server.

      • ipAddress (string) --

        The ip address of the analyzable server.

      • source (string) --

        The data source of the analyzable server.

      • vmId (string) --

        The virtual machine id of the analyzable server.

  • nextToken (string) --

    The token you use to retrieve the next set of results, or null if there are no more results.

{'assessmentDataSourceType': 'StrategyRecommendationsApplicationDataCollector '
                             '| ManualImport | ApplicationDiscoveryService'}

Starts the assessment of an on-premises environment.

See also: AWS API Documentation

Request Syntax

client.start_assessment(
    assessmentDataSourceType='StrategyRecommendationsApplicationDataCollector'|'ManualImport'|'ApplicationDiscoveryService',
    assessmentTargets=[
        {
            'condition': 'EQUALS'|'NOT_EQUALS'|'CONTAINS'|'NOT_CONTAINS',
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    s3bucketForAnalysisData='string',
    s3bucketForReportData='string'
)

type assessmentDataSourceType

string

param assessmentDataSourceType

The data source type of an assessment to be started.

type assessmentTargets

list

param assessmentTargets

List of criteria for assessment.

• (dict) --

  Defines the criteria of assessment.

  • condition (string) -- [REQUIRED]

    Condition of an assessment.

  • name (string) -- [REQUIRED]

    Name of an assessment.

  • values (list) -- [REQUIRED]

    Values of an assessment.

    • (string) --

type s3bucketForAnalysisData

string

param s3bucketForAnalysisData

The S3 bucket used by the collectors to send analysis data to the service. The bucket name must begin with migrationhub-strategy- .

type s3bucketForReportData

string

param s3bucketForReportData

The S3 bucket where all the reports generated by the service are stored. The bucket name must begin with migrationhub-strategy- .

rtype

dict

returns

Response Syntax

{
    'assessmentId': 'string'
}

Response Structure

• (dict) --

  • assessmentId (string) --

    The ID of the assessment.

{'dataSourceType': {'StrategyRecommendationsApplicationDataCollector'}}

Starts a file import.

See also: AWS API Documentation

Request Syntax

client.start_import_file_task(
    S3Bucket='string',
    dataSourceType='ApplicationDiscoveryService'|'MPA'|'Import'|'StrategyRecommendationsApplicationDataCollector',
    groupId=[
        {
            'name': 'ExternalId'|'ExternalSourceType',
            'value': 'string'
        },
    ],
    name='string',
    s3bucketForReportData='string',
    s3key='string'
)

type S3Bucket

string

param S3Bucket

[REQUIRED]

The S3 bucket where the import file is located. The bucket name is required to begin with migrationhub-strategy- .

type dataSourceType

string

param dataSourceType

Specifies the source that the servers are coming from. By default, Strategy Recommendations assumes that the servers specified in the import file are available in AWS Application Discovery Service.

type groupId

list

param groupId

Groups the resources in the import file together with a unique name. This ID can be as filter in ListApplicationComponents and ListServers .

• (dict) --

  The object containing information about distinct imports or groups for Strategy Recommendations.

  • name (string) --

    The key of the specific import group.

  • value (string) --

    The value of the specific import group.

type name

string

param name

[REQUIRED]

A descriptive name for the request.

type s3bucketForReportData

string

param s3bucketForReportData

The S3 bucket where Strategy Recommendations uploads import results. The bucket name is required to begin with migrationhub-strategy-.

type s3key

string

param s3key

[REQUIRED]

The Amazon S3 key name of the import file.

rtype

dict

returns

Response Syntax

{
    'id': 'string'
}

Response Structure

• (dict) --

  • id (string) --

    The ID for a specific import task. The ID is unique within an AWS account.