Omics / Client / list_references

list_references#

Omics.Client.list_references(**kwargs)#

Retrieves a list of references.

See also: AWS API Documentation

Request Syntax

response = client.list_references(
    referenceStoreId='string',
    maxResults=123,
    nextToken='string',
    filter={
        'name': 'string',
        'md5': 'string',
        'createdAfter': datetime(2015, 1, 1),
        'createdBefore': datetime(2015, 1, 1)
    }
)
Parameters:

  • referenceStoreId (string) –

    [REQUIRED]

    The references’ reference store ID.

  • maxResults (integer) – The maximum number of references to return in one page of results.

  • nextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

  • filter (dict) –

    A filter to apply to the list.

    • name (string) –

      A name to filter on.

    • md5 (string) –

      An MD5 checksum to filter on.

    • createdAfter (datetime) –

      The filter’s start date.

    • createdBefore (datetime) –

      The filter’s end date.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'references': [
        {
            'id': 'string',
            'arn': 'string',
            'referenceStoreId': 'string',
            'md5': 'string',
            'status': 'ACTIVE'|'DELETING'|'DELETED',
            'name': 'string',
            'description': 'string',
            'creationTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A pagination token that’s included if more results are available.

    • references (list) –

      A list of references.

      • (dict) –

        A genome reference.

        • id (string) –

          The reference’s ID.

        • arn (string) –

          The reference’s ARN.

        • referenceStoreId (string) –

          The reference’s store ID.

        • md5 (string) –

          The reference’s MD5 checksum.

        • status (string) –

          The reference’s status.

        • name (string) –

          The reference’s name.

        • description (string) –

          The reference’s description.

        • creationTime (datetime) –

          When the reference was created.

        • updateTime (datetime) –

          When the reference was updated.

Exceptions