list_datasets `async` ¶

list_datasets(
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    dataset_group_arn: Optional[Arn] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDatasetsResponse

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

Parameters:

dataset_group_arn (Optional[Arn], default: None ) –

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.
next_token (Optional[NextToken], default: None ) –

A token returned from the previous call to ListDatasets for getting the next set of dataset import jobs (if they exist).
max_results (Optional[MaxResults], default: None ) –

The maximum number of datasets to return.

Raises:

InvalidInputException –

Provide a valid value for the field or parameter.
InvalidNextTokenException –

The token is not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_personalize/_services/async_personalize.py

async def list_datasets(
    self,
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    dataset_group_arn: Optional["capo_personalize.types.arn.Arn"] = None,
    next_token: Optional["capo_personalize.types.next_token.NextToken"] = None,
    max_results: Optional["capo_personalize.types.max_results.MaxResults"] = None,
) -> "capo_personalize.types.list_datasets_response.ListDatasetsResponse":
    """<p>Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>

    Args:
        dataset_group_arn: <p>The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.</p>
        next_token: <p>A token returned from the previous call to <code>ListDatasets</code> for getting the next set of dataset import jobs (if they exist).</p>
        max_results: <p>The maximum number of datasets to return.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The token is not valid.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize.types.list_datasets_request.ListDatasetsRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.list_datasets_response.ListDatasetsResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.list_datasets

        (
            output,
            http_response,
        ) = await capo_personalize._operations.amazon_personalize.list_datasets.async_list_datasets(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDatasets")
    )
    input_: capo_personalize.types.list_datasets_request.ListDatasetsRequest = {}
    if dataset_group_arn is not None:
        input_["dataset_group_arn"] = dataset_group_arn
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_datasets async ¶

list_datasets `async` ¶