Omics / Client / create_reference_store

create_reference_store

Omics.Client.create_reference_store(**kwargs)

Creates a reference store and returns metadata in JSON format. Reference stores are used to store reference genomes in FASTA format. A reference store is created when the first reference genome is imported. To import additional reference genomes from an Amazon S3 bucket, use the StartReferenceImportJob API operation.

For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_reference_store(
    name='string',
    description='string',
    sseConfig={
        'type': 'KMS',
        'keyArn': 'string'
    },
    tags={
        'string': 'string'
    },
    clientToken='string'
)

Parameters:

• name (string) –

  [REQUIRED]

  A name for the store.

• description (string) – A description for the store.

• sseConfig (dict) –

  Server-side encryption (SSE) settings for the store.

  • type (string) – [REQUIRED]

    The encryption type.

  • keyArn (string) –

    An encryption key ARN.

• tags (dict) –

  Tags for the store.

  • (string) –

    • (string) –

• clientToken (string) – To ensure that requests don’t run multiple times, specify a unique token for each request.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'sseConfig': {
        'type': 'KMS',
        'keyArn': 'string'
    },
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • id (string) –

    The store’s ID.

  • arn (string) –

    The store’s ARN.

  • name (string) –

    The store’s name.

  • description (string) –

    The store’s description.

  • sseConfig (dict) –

    The store’s SSE settings.

    • type (string) –

      The encryption type.

    • keyArn (string) –

      An encryption key ARN.

  • creationTime (datetime) –

    When the store was created.

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ServiceQuotaExceededException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.AccessDeniedException

• Omics.Client.exceptions.RequestTimeoutException