describe_users ¶

def describe_users(
    self,
    *,
    config_overrides: Optional[AppStreamClientConfig] = None,
    authentication_type: Optional[
        "capo_appstream.types.authentication_type.AuthenticationType"
    ] = None,
    max_results: Optional["capo_appstream.types.integer.Integer"] = None,
    next_token: Optional["capo_appstream.types.string.String"] = None,
) -> "capo_appstream.types.describe_users_result.DescribeUsersResult":
    """<p>Retrieves a list that describes one or more specified users in the user pool.</p>

    Args:
        authentication_type: <p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>
        max_results: <p>The maximum size of each page of results.</p>
        next_token: <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>

    Raises:
        capo_appstream.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Indicates an incorrect combination of parameters, or a missing parameter.</p>
        capo_appstream.errors.operation_not_permitted_exception.OperationNotPermittedException: <p>The attempted operation is not permitted.</p>
        capo_appstream.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_appstream.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appstream.types.describe_users_request.DescribeUsersRequest]",
    ) -> OperationResponse[
        "capo_appstream.types.describe_users_result.DescribeUsersResult"
    ]:
        import capo_appstream._operations.photon_admin_proxy_service.describe_users

        output, http_response = (
            capo_appstream._operations.photon_admin_proxy_service.describe_users.describe_users(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_appstream.types.describe_users_result.DescribeUsersResult",
    ) -> dict[str, Any]:
        import capo_appstream.types.describe_users_result

        return capo_appstream.types.describe_users_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeUsers", redact_output=_redact_output),
    )
    input_: capo_appstream.types.describe_users_request.DescribeUsersRequest = {}
    if authentication_type is not None:
        input_["authentication_type"] = authentication_type
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output