Omics / Client / list_reference_stores

list_reference_stores

Omics.Client.list_reference_stores(**kwargs)

Retrieves a list of reference stores.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• filter (dict) –

  A filter to apply to the list.

  • createdAfter (datetime) –

    The filter’s start date.

  • createdBefore (datetime) –

    The filter’s end date.

  • name (string) –

    The name to filter on.

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

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • nextToken (string) –

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

  • referenceStores (list) –

    A list of reference stores.

    • (dict) –

      Details about a reference store.

      • arn (string) –

        The store’s ARN.

      • creationTime (datetime) –

        When the store was created.

      • description (string) –

        The store’s description.

      • id (string) –

        The store’s ID.

      • name (string) –

        The store’s name.

      • sseConfig (dict) –

        The store’s server-side encryption (SSE) settings.

        • keyArn (string) –

          An encryption key ARN.

        • type (string) –

          The encryption type.

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.AccessDeniedException

• Omics.Client.exceptions.RequestTimeoutException