Skip to content

create_fleet_advisor_collector 

create_fleet_advisor_collector(
    collector_name: String,
    service_access_role_arn: String,
    s3_bucket_name: String,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    description: Optional[String] = None,
) -> CreateFleetAdvisorCollectorResponse

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.

Parameters:

  • collector_name (String) –

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

  • description (Optional[String], default: None ) –

    A summary description of your Fleet Advisor collector.

  • service_access_role_arn (String) –

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

  • s3_bucket_name (String) –

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

Raises:

Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py 
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
def create_fleet_advisor_collector(
    self,
    collector_name: "capo_database_migration_service.types.string.String",
    service_access_role_arn: "capo_database_migration_service.types.string.String",
    s3_bucket_name: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
    description: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
) -> "capo_database_migration_service.types.create_fleet_advisor_collector_response.CreateFleetAdvisorCollectorResponse":
    """<important> <p> 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 <a href="https://docs.aws.amazon.com/dms/latest/userguide/dms_fleet.advisor-end-of-support.html">Amazon Web Services DMS Fleet Advisor end of support</a>. </p> </important> <p>Creates a Fleet Advisor collector using the specified parameters.</p>

    Args:
        collector_name: <p>The name of your Fleet Advisor collector (for example, <code>sample-collector</code>).</p>
        description: <p>A summary description of your Fleet Advisor collector.</p>
        service_access_role_arn: <p>The IAM role that grants permissions to access the specified Amazon S3 bucket.</p>
        s3_bucket_name: <p>The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.</p>

    Raises:
        capo_database_migration_service.errors.access_denied_fault.AccessDeniedFault: <p>DMS was denied access to the endpoint. Check that the role is correctly configured.</p>
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.resource_quota_exceeded_fault.ResourceQuotaExceededFault: <p>The quota for this resource quota has been exceeded.</p>
        capo_database_migration_service.errors.s3_access_denied_fault.S3AccessDeniedFault: <p>Insufficient privileges are preventing access to an Amazon S3 object.</p>
        capo_database_migration_service.errors.s3_resource_not_found_fault.S3ResourceNotFoundFault: <p>A specified Amazon S3 bucket, bucket folder, or other object can't be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.create_fleet_advisor_collector_request.CreateFleetAdvisorCollectorRequest]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.create_fleet_advisor_collector_response.CreateFleetAdvisorCollectorResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.create_fleet_advisor_collector

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.create_fleet_advisor_collector.create_fleet_advisor_collector(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFleetAdvisorCollector")
    )
    input_: capo_database_migration_service.types.create_fleet_advisor_collector_request.CreateFleetAdvisorCollectorRequest = {
        "collector_name": collector_name,
        "service_access_role_arn": service_access_role_arn,
        "s3_bucket_name": s3_bucket_name,
    }
    if description is not None:
        input_["description"] = description

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output