Skip to content

Schema Types

Query

Root Query Object

Field Argument Type Description
listUsers ListUsersResult!
input ListUsersInput!
getUser GetUserResult!
input GetUserInput!
getUsersByEmail GetUsersByEmailResult!
input GetUsersByEmailInput!
getGroups GetGroupsResult!
input GetGroupsInput!

Objects

GetGroupsResult

Field Argument Type Description
groups [Group!]!

GetUserResult

Field Argument Type Description
user User

GetUsersByEmailResult

Field Argument Type Description
users [User!]!

Group

Field Argument Type Description
id ID!
name String!
description String
members [String!]!

ListUsersResult

Field Argument Type Description
userConnection UserConnection

User

Field Argument Type Description
id ID! The Vision User ID currently matches the User's email address, but do not rely on that to always be the case. If a User's email address changes after creation, the User ID will not change to match it. In a future release, we will be switching to GUIDs.
email AWSEmail!
given_name String!
family_name String!
phone_number String!

UserConnection

Field Argument Type Description
items [User!]!
nextToken String If this is present and a non-empty string, then there are more results to return. Use that value in a subsequent request to get those additional results. If the nextToken you receive from a query is an empty string then you know you have reached the end of the available items.

Inputs

GetGroupsInput

Field Type Description
ids [ID!]!

GetUserInput

Field Type Description
id ID!

GetUsersByEmailInput

Field Type Description
email String!

ListUsersInput

Field Type Description
limit Int! Set to the maximum number of items that you would like to be returned.
nextToken String Set to an empty string to get the first subset of items. If you are trying to get the next set of items then you should give the nextToken you received from the last request for this input to get the next set of results.

Scalars

AWSEmail

The AWSEmail scalar type provided by AWS AppSync, represents an Email address string that complies with RFC 822. For example, "username@example.com" is a valid Email address.

Boolean

Built-in Boolean

ID

Built-in ID

Int

Built-in Int

String

Built-in String