get_groups async ¶

async def get_groups(
    self,
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    next_token: Optional[
        "capo_xray.types.get_groups_next_token.GetGroupsNextToken"
    ] = None,
) -> "capo_xray.types.get_groups_result.GetGroupsResult":
    """<p>Retrieves all active group details.</p>

    Args:
        next_token: <p>Pagination token.</p>

    Raises:
        capo_xray.errors.invalid_request_exception.InvalidRequestException: <p>The request is missing required parameters or has invalid parameters.</p>
        capo_xray.errors.throttled_exception.ThrottledException: <p>The request exceeds the maximum number of requests per second.</p>
        capo_xray.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_xray.types.get_groups_request.GetGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_xray.types.get_groups_result.GetGroupsResult"
    ]:
        import capo_xray._operations.awsx_ray.get_groups

        (
            output,
            http_response,
        ) = await capo_xray._operations.awsx_ray.get_groups.async_get_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetGroups")
    )
    input_: capo_xray.types.get_groups_request.GetGroupsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token

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