Omics / Client / get_reference_metadata

get_reference_metadata#

Omics.Client.get_reference_metadata(**kwargs)#

Gets information about a genome reference’s metadata.

See also: AWS API Documentation

Request Syntax

response = client.get_reference_metadata(
    id='string',
    referenceStoreId='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The reference’s ID.

  • referenceStoreId (string) –

    [REQUIRED]

    The reference’s reference store ID.

Return type:

dict

Returns:

Response Syntax

{
    '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),
    'files': {
        'source': {
            'totalParts': 123,
            'partSize': 123,
            'contentLength': 123,
            's3Access': {
                's3Uri': 'string'
            }
        },
        'index': {
            'totalParts': 123,
            'partSize': 123,
            'contentLength': 123,
            's3Access': {
                's3Uri': 'string'
            }
        }
    }
}

Response Structure

  • (dict) –

    • id (string) –

      The reference’s ID.

    • arn (string) –

      The reference’s ARN.

    • referenceStoreId (string) –

      The reference’s reference 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.

    • files (dict) –

      The reference’s files.

      • source (dict) –

        The source file’s location in Amazon S3.

        • totalParts (integer) –

          The file’s total parts.

        • partSize (integer) –

          The file’s part size.

        • contentLength (integer) –

          The file’s content length.

        • s3Access (dict) –

          The S3 URI metadata of a sequence store.

          • s3Uri (string) –

            The S3 URI for each read set file.

      • index (dict) –

        The files’ index.

        • totalParts (integer) –

          The file’s total parts.

        • partSize (integer) –

          The file’s part size.

        • contentLength (integer) –

          The file’s content length.

        • s3Access (dict) –

          The S3 URI metadata of a sequence store.

          • s3Uri (string) –

            The S3 URI for each read set file.

Exceptions