Omics / Client / get_sequence_store

get_sequence_store#

Omics.Client.get_sequence_store(**kwargs)#

Gets information about a sequence store.

Request Syntax

response = client.get_sequence_store(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The store’s ID.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'sseConfig': {
        'type': 'KMS',
        'keyArn': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'fallbackLocation': 'string',
    's3Access': {
        's3Uri': 'string',
        's3AccessPointArn': 'string'
    },
    'eTagAlgorithmFamily': 'MD5up'|'SHA256up'|'SHA512up'
}

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 server-side encryption (SSE) settings.
  - type (string) –
    
    The encryption type.
  - keyArn (string) –
    
    An encryption key ARN.
- creationTime (datetime) –
  
  When the store was created.
- fallbackLocation (string) –
  
  An S3 location that is used to store files that have failed a direct upload.
- s3Access (dict) –
  
  The S3 metadata of a sequence store, including the ARN and S3 URI of the S3 bucket.
  - s3Uri (string) –
    
    The S3 URI of the sequence store.
  - s3AccessPointArn (string) –
    
    This is ARN of the access point associated with the S3 bucket storing read sets.
- eTagAlgorithmFamily (string) –
  
  The algorithm family of the ETag.

Exceptions

Omics.Client.exceptions.InternalServerException
Omics.Client.exceptions.ThrottlingException
Omics.Client.exceptions.ValidationException
Omics.Client.exceptions.ResourceNotFoundException
Omics.Client.exceptions.AccessDeniedException
Omics.Client.exceptions.RequestTimeoutException