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.
Returns a list of the Fleet Advisor collectors in your account.
Parameters:
-
filters
(Optional[FilterList], default:
None
)
–
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"
-
max_records
(Optional[IntegerOptional], default:
None
)
–
Sets the maximum number of records returned in the response.
-
next_token
(Optional[String], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_database_migration_service/_services/async_database_migration_service.py
| async def describe_fleet_advisor_collectors(
self,
*,
config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
filters: Optional[
"capo_database_migration_service.types.filter_list.FilterList"
] = None,
max_records: Optional[
"capo_database_migration_service.types.integer_optional.IntegerOptional"
] = None,
next_token: Optional[
"capo_database_migration_service.types.string.String"
] = None,
) -> "capo_database_migration_service.types.describe_fleet_advisor_collectors_response.DescribeFleetAdvisorCollectorsResponse":
"""<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>Returns a list of the Fleet Advisor collectors in your account.</p>
Args:
filters: <p> If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:</p> <ul> <li> <p> <code>collector-referenced-id</code> – The ID of the collector agent, for example <code>d4610ac5-e323-4ad9-bc50-eaf7249dfe9d</code>.</p> </li> <li> <p> <code>collector-name</code> – The name of the collector agent.</p> </li> </ul> <p>An example is: <code>describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"</code> </p>
max_records: <p>Sets the maximum number of records returned in the response.</p>
next_token: <p>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> 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. </p>
Raises:
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.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_database_migration_service.types.describe_fleet_advisor_collectors_request.DescribeFleetAdvisorCollectorsRequest]",
) -> AsyncOperationResponse[
"capo_database_migration_service.types.describe_fleet_advisor_collectors_response.DescribeFleetAdvisorCollectorsResponse"
]:
import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_fleet_advisor_collectors
(
output,
http_response,
) = await capo_database_migration_service._operations.amazon_dm_sv20160101.describe_fleet_advisor_collectors.async_describe_fleet_advisor_collectors(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeFleetAdvisorCollectors")
)
input_: capo_database_migration_service.types.describe_fleet_advisor_collectors_request.DescribeFleetAdvisorCollectorsRequest = {}
if filters is not None:
input_["filters"] = filters
if max_records is not None:
input_["max_records"] = max_records
if next_token is not None:
input_["next_token"] = next_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|