DatabaseMigrationService / Client / describe_fleet_advisor_collectors

describe_fleet_advisor_collectors

DatabaseMigrationService.Client.describe_fleet_advisor_collectors(**kwargs)

Returns a list of the Fleet Advisor collectors in your account.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Filters (list) –

  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"

  • (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) – Sets the maximum number of records returned in the response.

• NextToken (string) – 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

{
    'Collectors': [
        {
            'CollectorReferencedId': 'string',
            'CollectorName': 'string',
            'CollectorVersion': 'string',
            'VersionStatus': 'UP_TO_DATE'|'OUTDATED'|'UNSUPPORTED',
            'Description': 'string',
            'S3BucketName': 'string',
            'ServiceAccessRoleArn': 'string',
            'CollectorHealthCheck': {
                'CollectorStatus': 'UNREGISTERED'|'ACTIVE',
                'LocalCollectorS3Access': True|False,
                'WebCollectorS3Access': True|False,
                'WebCollectorGrantedRoleBasedAccess': True|False
            },
            'LastDataReceived': 'string',
            'RegisteredDate': 'string',
            'CreatedDate': 'string',
            'ModifiedDate': 'string',
            'InventoryData': {
                'NumberOfDatabases': 123,
                'NumberOfSchemas': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Collectors (list) –

    Provides descriptions of the Fleet Advisor collectors, including the collectors’ name and ID, and the latest inventory data.

    • (dict) –

      Describes a Fleet Advisor collector.

      • CollectorReferencedId (string) –

        The reference ID of the Fleet Advisor collector.

      • CollectorName (string) –

        The name of the Fleet Advisor collector .

      • CollectorVersion (string) –

        The version of your Fleet Advisor collector, in semantic versioning format, for example 1.0.2

      • VersionStatus (string) –

        Whether the collector version is up to date.

      • Description (string) –

        A summary description of the Fleet Advisor collector.

      • S3BucketName (string) –

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

      • ServiceAccessRoleArn (string) –

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

      • CollectorHealthCheck (dict) –

        Describes the last Fleet Advisor collector health check.

        • CollectorStatus (string) –

          The status of the Fleet Advisor collector.

        • LocalCollectorS3Access (boolean) –

          Whether the local collector can access its Amazon S3 bucket.

        • WebCollectorS3Access (boolean) –

          Whether the web collector can access its Amazon S3 bucket.

        • WebCollectorGrantedRoleBasedAccess (boolean) –

          Whether the role that you provided when creating the Fleet Advisor collector has sufficient permissions to access the Fleet Advisor web collector.

      • LastDataReceived (string) –

        The timestamp of the last time the collector received data, in the following format: 2022-01-24T19:04:02.596113Z

      • RegisteredDate (string) –

        The timestamp when DMS registered the collector, in the following format: 2022-01-24T19:04:02.596113Z

      • CreatedDate (string) –

        The timestamp when you created the collector, in the following format: 2022-01-24T19:04:02.596113Z

      • ModifiedDate (string) –

        The timestamp when DMS last modified the collector, in the following format: 2022-01-24T19:04:02.596113Z

      • InventoryData (dict) –

        Describes a Fleet Advisor collector inventory.

        • NumberOfDatabases (integer) –

          The number of databases in the Fleet Advisor collector inventory.

        • NumberOfSchemas (integer) –

          The number of schemas in the Fleet Advisor collector inventory.

  • NextToken (string) –

    If NextToken is returned, 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.

Exceptions

• DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault