Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.
For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.
Parameters:
-
max_results
(Optional[int], default:
None
)
–
The maximum number of stores to return in one page of results.
-
next_token
(Optional[NextToken], default:
None
)
–
Specify the pagination token from a previous request to retrieve the next page of results.
-
filter
(Optional[ReferenceStoreFilter], default:
None
)
–
A filter to apply to the list.
Raises:
Source code in docs_src/capo_omics/_services/omics.py
| def list_reference_stores(
self,
*,
config_overrides: Optional[OmicsClientConfig] = None,
max_results: Optional[int] = None,
next_token: Optional["capo_omics.types.next_token.NextToken"] = None,
filter: Optional[
"capo_omics.types.reference_store_filter.ReferenceStoreFilter"
] = None,
) -> "capo_omics.types.list_reference_stores_response.ListReferenceStoresResponse":
"""<p>Retrieves a list of reference stores linked to your account and returns their metadata in JSON format.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/omics/latest/dev/create-reference-store.html">Creating a reference store</a> in the <i>Amazon Web Services HealthOmics User Guide</i>.</p>
Args:
max_results: <p>The maximum number of stores to return in one page of results.</p>
next_token: <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
filter: <p>A filter to apply to the list.</p>
Raises:
capo_omics.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_omics.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred. Try the request again.</p>
capo_omics.errors.request_timeout_exception.RequestTimeoutException: <p>The request timed out.</p>
capo_omics.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_omics.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_omics.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_omics.types.list_reference_stores_request.ListReferenceStoresRequest]",
) -> OperationResponse[
"capo_omics.types.list_reference_stores_response.ListReferenceStoresResponse"
]:
import capo_omics._operations.omics.list_reference_stores
output, http_response = (
capo_omics._operations.omics.list_reference_stores.list_reference_stores(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListReferenceStores")
)
input_: capo_omics.types.list_reference_stores_request.ListReferenceStoresRequest = {}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
if filter is not None:
input_["filter"] = filter
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|