DatabaseMigrationService / Client / create_fleet_advisor_collector

create_fleet_advisor_collector

DatabaseMigrationService.Client.create_fleet_advisor_collector(**kwargs)

Warning

End of support notice: On May 20, 2026, Amazon Web Services will end support for Amazon Web Services DMS Fleet Advisor;. After May 20, 2026, you will no longer be able to access the Amazon Web Services DMS Fleet Advisor; console or Amazon Web Services DMS Fleet Advisor; resources. For more information, see Amazon Web Services DMS Fleet Advisor end of support.

Creates a Fleet Advisor collector using the specified parameters.

See also: AWS API Documentation

Request Syntax

response = client.create_fleet_advisor_collector(
    CollectorName='string',
    Description='string',
    ServiceAccessRoleArn='string',
    S3BucketName='string'
)
Parameters:

  • CollectorName (string) –

    [REQUIRED]

    The name of your Fleet Advisor collector (for example, sample-collector).

  • Description (string) – A summary description of your Fleet Advisor collector.

  • ServiceAccessRoleArn (string) –

    [REQUIRED]

    The IAM role that grants permissions to access the specified Amazon S3 bucket.

  • S3BucketName (string) –

    [REQUIRED]

    The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.

Return type:

dict

Returns:

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.

Exceptions