Amazonka.MemoryDb.DescribeUsers

Returns a list of users.

This operation returns paginated results.

Creating a Request

data DescribeUsers

See: newDescribeUsers smart constructor.

Constructors

DescribeUsers'

Fields

• filters :: Maybe [Filter]

  Filter to determine the list of users to return.

• maxResults :: Maybe Int

  The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

• nextToken :: Maybe Text

  An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

• userName :: Maybe Text

  The name of the user

Instances

ToJSON DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

toJSON :: DescribeUsers -> Value

toEncoding :: DescribeUsers -> Encoding

toJSONList :: [DescribeUsers] -> Value

toEncodingList :: [DescribeUsers] -> Encoding

ToHeaders DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

toHeaders :: DescribeUsers -> [Header]

ToPath DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

toPath :: DescribeUsers -> ByteString

ToQuery DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

toQuery :: DescribeUsers -> QueryString

AWSPager DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

page :: DescribeUsers -> AWSResponse DescribeUsers -> Maybe DescribeUsers

AWSRequest DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Associated Types

type AWSResponse DescribeUsers

Methods

request :: (Service -> Service) -> DescribeUsers -> Request DescribeUsers

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUsers)))

Generic DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Associated Types

type Rep DescribeUsers :: Type -> Type

Methods

from :: DescribeUsers -> Rep DescribeUsers x

to :: Rep DescribeUsers x -> DescribeUsers

Read DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

readsPrec :: Int -> ReadS DescribeUsers

readList :: ReadS [DescribeUsers]

readPrec :: ReadPrec DescribeUsers

readListPrec :: ReadPrec [DescribeUsers]

Show DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

showsPrec :: Int -> DescribeUsers -> ShowS

show :: DescribeUsers -> String

showList :: [DescribeUsers] -> ShowS

NFData DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

rnf :: DescribeUsers -> ()

Eq DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

(==) :: DescribeUsers -> DescribeUsers -> Bool

(/=) :: DescribeUsers -> DescribeUsers -> Bool

Hashable DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

hashWithSalt :: Int -> DescribeUsers -> Int

hash :: DescribeUsers -> Int

type AWSResponse DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

type AWSResponse DescribeUsers = DescribeUsersResponse

type Rep DescribeUsers

Defined in Amazonka.MemoryDb.DescribeUsers

type Rep DescribeUsers = D1 ('MetaData "DescribeUsers" "Amazonka.MemoryDb.DescribeUsers" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeUsers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeUsers :: DescribeUsers

Create a value of DescribeUsers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filters:DescribeUsers', describeUsers_filters - Filter to determine the list of users to return.

$sel:maxResults:DescribeUsers', describeUsers_maxResults - The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

DescribeUsers, describeUsers_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:userName:DescribeUsers', describeUsers_userName - The name of the user

Request Lenses

describeUsers_filters :: Lens' DescribeUsers (Maybe [Filter])

Filter to determine the list of users to return.

describeUsers_maxResults :: Lens' DescribeUsers (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeUsers_nextToken :: Lens' DescribeUsers (Maybe Text)

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeUsers_userName :: Lens' DescribeUsers (Maybe Text)

The name of the user

Destructuring the Response

data DescribeUsersResponse

See: newDescribeUsersResponse smart constructor.

Constructors

DescribeUsersResponse'

Fields

• nextToken :: Maybe Text

  An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

• users :: Maybe [User]

  A list of users.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeUsersResponse

Defined in Amazonka.MemoryDb.DescribeUsers

Associated Types

type Rep DescribeUsersResponse :: Type -> Type

Methods

from :: DescribeUsersResponse -> Rep DescribeUsersResponse x

to :: Rep DescribeUsersResponse x -> DescribeUsersResponse

Read DescribeUsersResponse

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

readsPrec :: Int -> ReadS DescribeUsersResponse

readList :: ReadS [DescribeUsersResponse]

readPrec :: ReadPrec DescribeUsersResponse

readListPrec :: ReadPrec [DescribeUsersResponse]

Show DescribeUsersResponse

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

showsPrec :: Int -> DescribeUsersResponse -> ShowS

show :: DescribeUsersResponse -> String

showList :: [DescribeUsersResponse] -> ShowS

NFData DescribeUsersResponse

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

rnf :: DescribeUsersResponse -> ()

Eq DescribeUsersResponse

Defined in Amazonka.MemoryDb.DescribeUsers

Methods

(==) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool

(/=) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool

type Rep DescribeUsersResponse

Defined in Amazonka.MemoryDb.DescribeUsers

type Rep DescribeUsersResponse = D1 ('MetaData "DescribeUsersResponse" "Amazonka.MemoryDb.DescribeUsers" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [User])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUsersResponse

Arguments

:: Int

$sel:httpStatus:DescribeUsersResponse'

-> DescribeUsersResponse

Create a value of DescribeUsersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeUsers, describeUsersResponse_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:users:DescribeUsersResponse', describeUsersResponse_users - A list of users.

$sel:httpStatus:DescribeUsersResponse', describeUsersResponse_httpStatus - The response's http status code.

Response Lenses

describeUsersResponse_nextToken :: Lens' DescribeUsersResponse (Maybe Text)

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])

A list of users.

describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int

The response's http status code.