list_dataset_groups `async` ¶

list_dataset_groups(
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListDatasetGroupsResponse

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

Parameters:

next_token (Optional[NextToken], default: None ) –

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

The maximum number of dataset groups to return.

Raises:

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_dataset_groups(
    self,
    *,
    config_overrides: Optional[AsyncPersonalizeClientConfig] = 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_dataset_groups_response.ListDatasetGroupsResponse"
):
    """<p>Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>.</p>

    Args:
        next_token: <p>A token returned from the previous call to <code>ListDatasetGroups</code> for getting the next set of dataset groups (if they exist).</p>
        max_results: <p>The maximum number of dataset groups to return.</p>

    Raises:
        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_dataset_groups_request.ListDatasetGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_personalize.types.list_dataset_groups_response.ListDatasetGroupsResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.list_dataset_groups

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDatasetGroups")
    )
    input_: capo_personalize.types.list_dataset_groups_request.ListDatasetGroupsRequest = {}
    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_dataset_groups async ¶

list_dataset_groups `async` ¶