OBJECT
Query

Root Query
GraphQL Schema definition

type Query {
#   Gets the APIUser. Returns null if not found.
# 
# Arguments
#   tenant: The name of the Tenant.
#   username: The username.
GetApiUser(tenant: String!, username: String!): ApiUser 
#   Gets the App. Returns null if not found.
# 
# Arguments
#   name: The name.
#   tenant: The name of the Tenant.
GetApp(name: String!, tenant: String!): App 
#   Gets between 1 and 100 BulkDataStorage objects.
# 
# Arguments
#   tenant: The name of the Tenant.
#   contentEncoding: The content encoding to use for the returned 
#   BulkDataStorage. Defaults to 'gzip'.
#   count: The number of BulkDataStorage objects to get. Must be 
#   between 1 and 100. Defaults to 1.
#   expiresIn: The number of seconds that the 
#   presignedPost/presignedPut will be valid for. Defaults to 1800.
#   useAccelerationEndpoint: The returned presigned URLs will use 
#   the acceleration endpoint. This endpoint provides
#   for speed increases of 150% or more, but elimianates the ability to use CORS. 
#   Defaults to `false`.
GetBulkDataStorage(
tenant: String!,
contentEncoding: ContentEncoding,
count: Int,
expiresIn: Int,
useAccelerationEndpoint: Boolean
): [BulkDataStorage!]! 
#   Gets the Edge. Returns null if not found.
# 
# Arguments
#   source: The name of the source Node.
#   target: The name of the target Node.
#   tenant: The name of the Tenant.
GetEdge(source: String!, target: String!, tenant: String!): Edge 
#   Gets the Function.
# 
# Arguments
#   name: The name.
#   tenant: The name of the Tenant.
GetFunction(name: String!, tenant: String!): Function 
#   Gets the KmsKey. Returns null if not found. The Tenant default KmsKey is not 
#   gettable.
# 
# Arguments
#   name: The name.
#   tenant: The name of the Tenant.
GetKmsKey(name: String!, tenant: String!): KmsKey 
#   Gets the ManagedNodeType. Returns null if not found. 
# 
# Arguments
#   name: The name.
#   tenant: The name of the Tenant.
GetManagedNodeType(name: String!, tenant: String!): ManagedNodeType 
#   Gets the MessageType. Returns null if not found. 
# 
# Arguments
#   name: The name.
#   tenant: The name of the Tenant.
GetMessageType(name: String!, tenant: String!): MessageType 
#   Gets the Node. Returns null if not found. 
# 
# Arguments
#   name: The name.
#   tenant: The name of the Tenant.
GetNode(name: String!, tenant: String!): Node 
#   Gets the AWS Tenant Regions that are supported by EchoStream.
GetSupportedRegions: [String!]! 
#   Gets the Tenant. Returns null if not found. 
# 
# Arguments
#   tenant: The name.
GetTenant(tenant: String!): Tenant 
#   Gets the TenantUser. Returns null if not found. 
# 
# Arguments
#   email: The email.
#   tenant: The name of the Tenant.
GetTenantUser(email: AWSEmail!, tenant: String!): TenantUser 
#   Gets the current User. 
GetUser: LoginUser! 
#   Gets the EchoStream version
GetVersion: String! 
#   Lists the APIUsers in the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
ListApiUsers(tenant: String!, exclusiveStartKey: AWSJSON, limit: Int): ApiUserResult! 
#   Lists the Apps in the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
#   types:  A list of types to return. If a "!" is placed in front 
#   of a type it will be excluded.
#  
#   Included and excluded types may be mixed. Excluded types take precedemce.
#  
#   None or an empty list will return all types.
# 
#  
#   Example: ["ExternalApp", "CrossAccountApp", "!ManagedApp"]
ListApps(
tenant: String!,
exclusiveStartKey: AWSJSON,
limit: Int,
types: [String]
): AppResult! 
#   Lists the Changes in the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   endDateTime: The end date/time (inclusive) to list changes for 
#   in ISO8601 format. Defaults to now.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
#   sortAscending: True for ascending results, False for descending 
#   result. Defaults to True.
#   startDateTime: The start date/time (inclusive) to list changes 
#   for in ISO8601 format. Defaults to the beginning of time.
ListChanges(
tenant: String!,
endDateTime: AWSDateTime,
exclusiveStartKey: AWSJSON,
limit: Int,
sortAscending: Boolean,
startDateTime: AWSDateTime
): ChangeResult! 
#   Lists the Functions available to the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
ListFunctions(tenant: String!, exclusiveStartKey: AWSJSON, limit: Int): FunctionResult! 
#   Lists the KmsKeys in the Tenant. The Tenant default KmsKey will not be listed. 
#   May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
ListKmsKeys(tenant: String!, exclusiveStartKey: AWSJSON, limit: Int): KmsKeyResult! 
#   Lists the Nodes in the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
#   types:  A list of types to return. If a "!" is placed in front 
#   of a type it will be excluded.
#  
#   Included and excluded types may be mixed. Excluded types take precedemce.
#  
#   None or an empty list will return all types.
# 
#  
#   Example: ["ExternalNode", "ProcessorNode", "WebSubHubNode, 
#   "!WebSubSubcriptionNode"]
ListNodes(
tenant: String!,
exclusiveStartKey: AWSJSON,
limit: Int,
types: [String]
): NodeResult! 
#   Lists the ManagedNodeTypes available to the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
ListManagedNodeTypes(
tenant: String!,
exclusiveStartKey: AWSJSON,
limit: Int
): ManagedNodeTypeResult! 
#   Lists the MessageTypes available to the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
ListMessageTypes(
tenant: String!,
exclusiveStartKey: AWSJSON,
limit: Int
): MessageTypeResult! 
#   Lists the Tenants available to the current User. May paginate.
# 
# Arguments
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
ListTenants(exclusiveStartKey: AWSJSON, limit: Int): TenantResult! 
#   Lists the TenantUsers in the Tenant. May paginate.
# 
# Arguments
#   tenant: The name of the Tenant.
#   exclusiveStartKey: The lastEvaluatedKey from a previous result.
#   limit: The maximum number of items to return.
ListTenantUsers(
tenant: String!,
exclusiveStartKey: AWSJSON,
limit: Int
): TenantUserResult! 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
