search_groups `async` ¶

search_groups(
    aws_account_id: AwsAccountId,
    namespace: Namespace,
    filters: GroupSearchFilterList,
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[MaxResults] = None,
) -> SearchGroupsResponse

Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.

Parameters:

aws_account_id (AwsAccountId) –

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.
next_token (Optional[String], default: None ) –

A pagination token that can be used in a subsequent request.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return from this request.
namespace (Namespace) –

The namespace that you want to search.
filters (GroupSearchFilterList) –

The structure for the search filters that you want to apply to your search.

Raises:

AccessDeniedException –

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
InternalFailureException –

An internal failure occurred.
InvalidNextTokenException –

The NextToken value isn't valid.
InvalidParameterValueException –

One or more parameters has a value that isn't valid.
PreconditionNotMetException –

One or more preconditions aren't met.
ResourceNotFoundException –

One or more resources can't be found.
ResourceUnavailableException –

This resource is currently unavailable.
ThrottlingException –

Access is throttled.
UnknownServiceError –

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

Source code in docs_src/capo_quicksight/_services/async_quick_sight.py

async def search_groups(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    namespace: "capo_quicksight.types.namespace.Namespace",
    filters: "capo_quicksight.types.group_search_filter_list.GroupSearchFilterList",
    *,
    config_overrides: Optional[AsyncQuickSightClientConfig] = None,
    next_token: Optional["capo_quicksight.types.string.String"] = None,
    max_results: Optional["capo_quicksight.types.max_results.MaxResults"] = None,
) -> "capo_quicksight.types.search_groups_response.SearchGroupsResponse":
    """<p>Use the <code>SearchGroups</code> operation to search groups in a specified Quick Sight namespace using the supplied filters.</p>

    Args:
        aws_account_id: <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon Quick Sight account.</p>
        next_token: <p>A pagination token that can be used in a subsequent request.</p>
        max_results: <p>The maximum number of results to return from this request.</p>
        namespace: <p>The namespace that you want to search.</p>
        filters: <p>The structure for the search filters that you want to apply to your search.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The <code>NextToken</code> value isn't valid.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.precondition_not_met_exception.PreconditionNotMetException: <p>One or more preconditions aren't met.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.resource_unavailable_exception.ResourceUnavailableException: <p>This resource is currently unavailable.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_quicksight.types.search_groups_request.SearchGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_quicksight.types.search_groups_response.SearchGroupsResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.search_groups

        (
            output,
            http_response,
        ) = await capo_quicksight._operations.quick_sight_20180401.search_groups.async_search_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SearchGroups")
    )
    input_: capo_quicksight.types.search_groups_request.SearchGroupsRequest = {
        "aws_account_id": aws_account_id,
        "namespace": namespace,
        "filters": filters,
    }
    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

search_groups async ¶

search_groups `async` ¶