OBJECT
Mutation

Root Mutation
GraphQL Schema definition

type Mutation {
#   Creates a ApiAuthenticatorFunction and returns it.
# 
# Arguments
#   code: A Python code string that contains a single top-level 
#   function definition.
#   This function must have the signature (*, context, request, **kwargs) and return 
#   None or a tuple containing
#   an AuthCredentials and BaseUser (or subclasses).
#   description: A human-readable description.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   readme: The README in MarkDown format.
#   requirements: The list of Python requirements, in pip format.
CreateApiAuthenticatorFunction(
code: String!,
description: String!,
name: String!,
tenant: String!,
readme: String,
requirements: [String!]
): ApiAuthenticatorFunction! 
#   Creates a new APIUser and returns it.
# 
# Arguments
#   role: The role of the new API User.
#   tenant: The name of the Tenant to create this in.
#   description: A human-readable description.
CreateApiUser(role: ApiUserRole!, tenant: String!, description: String): ApiUser! 
#   Creates a new BitmapperFunction and returns it.
# 
# Arguments
#   argumentMessageType: The name of the MessageType.
#   code: A Python code string that contains a single top-level 
#   function definition.
#   This function is used as a template when creating custom routing rules in 
#   RouterNodes
#   that use this MessageType. This function must have the signature
#   (*, context, message, source, **kwargs) and return an integer.
#   description: A human-readable description.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   readme: The README in MarkDown format.
#   requirements: The list of Python requirements, in pip format.
CreateBitmapperFunction(
argumentMessageType: String!,
code: String!,
description: String!,
name: String!,
tenant: String!,
readme: String,
requirements: [String!]
): BitmapperFunction! 
#   Creates a BitmapRouterNode and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_ ]{3,80}$"
#   receiveMessageType: The name of the MessageType that will be 
#   received.
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   inlineBitmapper: A Python code string that contains a single 
#   top-level function definition.
#   This function must have the signature (*, context, message, source, **kwargs) 
#   and return an integer.
#   Mutually exclusive with managedBitmapper.
#   loggingLevel: The logging level. Defaults to INFO.
#   managedBitmapper: The name of the BitmapperFunction. Mutually 
#   exclusive with inlineBitmapper.
#   requirements: The list of Python requirements, in pip format.
#   routeTable: The route table. A route table is a JSON object 
#   with hexadecimal (base-16) keys (the route bitmaps - e.g. 0xF1) and a list of 
#   target Node names as the values.
CreateBitmapRouterNode(
name: String!,
receiveMessageType: String!,
tenant: String!,
config: AWSJSON,
description: String,
inlineBitmapper: String,
loggingLevel: LogLevel,
managedBitmapper: String,
requirements: [String!],
routeTable: AWSJSON
): BitmapRouterNode! 
#   Creates a new CrossAccountApp and returns it.
# 
# Arguments
#   account: The AWS account number that is authorized to use this 
#   App's EchoStream Cloud resources.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   tableAccess: True if this App can access the Tenant's table. 
#   Defaults to False.
CreateCrossAccountApp(
account: String!,
name: String!,
tenant: String!,
config: AWSJSON,
description: String,
tableAccess: Boolean
): CrossAccountApp! 
#   Creates a new CrossTenantReceivingApp and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   sendingTenant: The name of the Tenant that will be sending 
#   messages.
#   tenant: The name of the Tenant to create this in.
CreateCrossTenantReceivingApp(
name: String!,
sendingTenant: String!,
tenant: String!
): CrossTenantReceivingApp! 
#   Creates a new CrossTenantSendingApp and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   receivingApp: The name of the CrossTenantReceivingApp in the 
#   receivingTenant. 
#   receivingTenant: The name of the Tenant that will be receiving 
#   messages.
#   tenant: The name of the Tenant to create this in.
CreateCrossTenantSendingApp(
name: String!,
receivingApp: String!,
receivingTenant: String!,
tenant: String!
): CrossTenantSendingApp! 
#   Creates a new CrossTenantSendingNode and returns it.
# 
# Arguments
#   app: The name of the CrossTenantSendingApp.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_ ]{3,80}$"
#   receiveMessageType: The name of the MessageType.
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   inlineProcessor: A Python code string that contains a single 
#   top-level function definition.
#   This function is used as a template when creating custom processing in 
#   ProcessorNodes
#   that use this MessageType. This function must have the signature
#   (*, context, message, source, **kwargs) and return None, a string or a list of 
#   strings.
#   Mutually exclusive with managedProcessor.
#   loggingLevel: The logging level. Defaults to INFO.
#   managedProcessor: The name of a ProcessorFunction. Mutually 
#   exclusive with the inlineProcessor.
#   requirements: The list of Python requirements, in pip format.
#   sendMessageType: The name of the MessageType. Defaults to 
#   receiveMessageType.
#   sequentialProcessing: True if messages should not be processed 
#   concurrently. If False, messages are processed concurrently. Defaults to False.
CreateCrossTenantSendingNode(
app: String!,
name: String!,
receiveMessageType: String!,
tenant: String!,
config: AWSJSON,
description: String,
inlineProcessor: String,
loggingLevel: LogLevel,
managedProcessor: String,
requirements: [String!],
sendMessageType: String,
sequentialProcessing: Boolean
): CrossTenantSendingNode! 
#   Creates an Edge and returns it.
# 
# Arguments
#   source: The name of the Node that will be sending messages. 
#   Must have the same MessageType as the target.
#   target: The name of the Node that will be receiving messages. 
#   Must have the same MessageType as the source.
#   tenant: The name of the Tenant to create this in.
#   description: A human-readable description.
#   kmsKey: The name of the KmsKey to use for at-rest encryption of 
#   the messages. Defaults to the Tenant's default key.
#   maxReceiveCount: The number of delivery attempts to make before 
#   sending a message to the DeadLetterEmitter. Defaults to infinity.
CreateEdge(
source: String!,
target: String!,
tenant: String!,
description: String,
kmsKey: String,
maxReceiveCount: Int
): Edge! 
#   Creates an ExternalApp and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   tableAccess: True if this App can access the Tenant's table. 
#   Defaults to False.
CreateExternalApp(
name: String!,
tenant: String!,
config: AWSJSON,
description: String,
tableAccess: Boolean
): ExternalApp! 
#   Creates an ExternalNode and returns it.
# 
# Arguments
#   app: The name of the ExternalApp or CrossAccountApp.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   receiveMessageType: The name of the MessageType that will be 
#   received.
#   sendMessageType: The name of the MessageType that will be sent.
CreateExternalNode(
app: String!,
name: String!,
tenant: String!,
config: AWSJSON,
description: String,
receiveMessageType: String,
sendMessageType: String
): ExternalNode! 
#   Creates a FilesDotComWebhookNode and returns it.
# 
# Arguments
#   apiKey: The API Key for your Files.com site that is sending 
#   webhooks.
#   Used to query Files.com for the IP addresses to whitelist.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   description: A human-readable description.
CreateFilesDotComWebhookNode(
apiKey: String!,
name: String!,
tenant: String!,
description: String
): FilesDotComWebhookNode! 
#   Create a KmsKey and return it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9_\-]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   description: A human-readable description.
CreateKmsKey(name: String!, tenant: String!, description: String): KmsKey! 
#   Creates a LoadBalancerNode and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_ ]{3,80}$"
#   receiveMessageType: The name of the MessageType that will be 
#   received.
#   tenant: The name of the Tenant to create this in.
#   description: A human-readable description.
CreateLoadBalancerNode(
name: String!,
receiveMessageType: String!,
tenant: String!,
description: String
): LoadBalancerNode! 
#   Creates a ManagedApp and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9_\-]{3,80}$".
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   tableAccess: True if this App can access the Tenant's table. 
#   Defaults to False.
CreateManagedApp(
name: String!,
tenant: String!,
config: AWSJSON,
description: String,
tableAccess: Boolean
): ManagedApp! 
#   Creates a ManagedNode and returns it.
# 
# Arguments
#   app: The name of the ManagedApp.
#   managedNodeType: The name of the ManagedNodeType.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-]{3,63}$".
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   loggingLevel: The logging level. Defaults to INFO.
#   mounts: The mounts to create. Must conform to the mount 
#   requirements of the ManagedNodeType.
#   ports: The ports to expose. Must conform to the port 
#   requirements of the ManagedNodeType
CreateManagedNode(
app: String!,
managedNodeType: String!,
name: String!,
tenant: String!,
config: AWSJSON,
description: String,
loggingLevel: LogLevel,
mounts: [MountInput!],
ports: [PortInput!]
): ManagedNode! 
#   Creates a ManagedNodeType and returns it.
# 
# Arguments
#   description: A human-readable description.
#   imageUri: The URI of the Docker image. Must be a public or a 
#   private AWS ECR repository.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   configTemplate: A JSON Schema ( https://json-schema.org/ ) 
#   document that specifies the requirements for the config attribute of 
#   ManagedNodes created using this ManagedNodeType.
#   mountRequirements: The mount (i.e. - volume) requirements of 
#   the Docker image.
#   portRequirements: The port requirements of the Docker image.
#   readme: The README in MarkDown format.
#   receiveMessageType: The name of the MessageType that will be 
#   received.
#   sendMessageType: The name of the MessageType that will be sent.
CreateManagedNodeType(
description: String!,
imageUri: String!,
name: String!,
tenant: String!,
configTemplate: AWSJSON,
mountRequirements: [MountRequirementInput!],
portRequirements: [PortRequirementInput!],
readme: String,
receiveMessageType: String,
sendMessageType: String
): ManagedNodeType! 
#   Creates a MessageType and returns it.
# 
# Arguments
#   auditor: A Python code string that contains a single top-level 
#   function definition.
#   This function must have the signature (*, message, **kwargs) where
#   message is a string and must return a flat dictionary.
#   bitmapperTemplate: A Python code string that contains a single 
#   top-level function definition.
#   This function is used as a template when creating custom routing rules in 
#   RouterNodes
#   that use this MessageType. This function must have the signature
#   (*, context, message, source, **kwargs) and return an integer.
#   description: A human-readable description.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z][A-Za-z0-9\-_\.]{3,24}$"
#   processorTemplate: A Python code string that contains a single 
#   top-level function definition.
#   This function is used as a template when creating custom processing in 
#   ProcessorNodes
#   that use this MessageType. This function must have the signature
#   (*, context, message, source, **kwargs) and return None, a string or a list of 
#   strings.
#   sampleMessage: A sample message.
#   tenant: The name of the Tenant to create this in.
#   readme: The README in MarkDown format.
#   requirements: The list of Python requirements, in pip format.
CreateMessageType(
auditor: String!,
bitmapperTemplate: String!,
description: String!,
name: String!,
processorTemplate: String!,
sampleMessage: String!,
tenant: String!,
readme: String,
requirements: [String!]
): MessageType! 
#   Creates a ProcessorFunction and returns it.
# 
# Arguments
#   argumentMessageType: The name of the MessageType.
#   code: A Python code string that contains a single top-level 
#   function definition.
#   This function must have the signature (*, context, message, source, **kwargs) 
#   and return None, a string or a list of strings.
#   description: A human-readable description.
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   readme: The README in MarkDown format.
#   requirements: The list of Python requirements, in pip format.
#   returnMessageType: The name of the MessageType that is 
#   returned.
CreateProcessorFunction(
argumentMessageType: String!,
code: String!,
description: String!,
name: String!,
tenant: String!,
readme: String,
requirements: [String!],
returnMessageType: String
): ProcessorFunction! 
#   Creates a ProcessorNode and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_ ]{3,80}$"
#   receiveMessageType: The name of the MessageType that will be 
#   received.
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   inlineProcessor: A Python code string that contains a single 
#   top-level function definition.
#   This function is used as a template when creating custom processing in 
#   ProcessorNodes
#   that use this MessageType. This function must have the signature
#   (*, context, message, source, **kwargs) and return None, a string or a list of 
#   strings.
#   Mutually exclusive with managedProcessor.
#   loggingLevel: The logging level. Defaults to INFO.
#   managedProcessor: The name of a ProcessorFunction. Mutually 
#   exclusive with the inlineProcessor.
#   requirements: The list of Python requirements, in pip format.
#   sendMessageType: The name of the MessageType that will be sent. 
#   Defaults to null.
#   sequentialProcessing: True if messages should not be processed 
#   concurrently. If False, messages are processed concurrently. Defaults to False.
CreateProcessorNode(
name: String!,
receiveMessageType: String!,
tenant: String!,
config: AWSJSON,
description: String,
inlineProcessor: String,
loggingLevel: LogLevel,
managedProcessor: String,
requirements: [String!],
sendMessageType: String,
sequentialProcessing: Boolean
): ProcessorNode! 
#   Creates a Tenant and returns it.
# 
# Arguments
#   name: The name. Must be unique within the EchoStream. Must 
#   conform to the regular expression "^[A-Za-z0-9_\-]{8,80}$"
#   region: The AWS region.
#   description: A human-readable description.
CreateTenant(name: String!, region: String!, description: String): CreateTenantResponse! 
#   Creates a TimerNode and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_\.: ]{3,80}$"
#   scheduleExpression: An Amazon Event Bridge cron expression ( 
#   https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html#eb-cron-expressions 
#   )
#   tenant: The name of the Tenant to create this in.
#   description: A human-readable description.
CreateTimerNode(
name: String!,
scheduleExpression: String!,
tenant: String!,
description: String
): TimerNode! 
#   Creates a WebhookNode and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_ ]{3,80}$"
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   description: A human-readable description.
#   inlineApiAuthenticator: A Python code string that contains a 
#   single top-level function definition.
#   This function must have the signature (*, context, request, **kwargs) and return 
#   None or a tuple containing
#   an AuthCredentials and BaseUser (or subclasses).
#   Mutually exclusive with managedApiAuthenticator.
#   loggingLevel: The logging level. Defaults to INFO.
#   managedApiAuthenticator: The name of a 
#   ApiAuthenticatorFunction. Mutually exclusive with the inlineApiAuthenticator.
#   requirements: The list of Python requirements, in pip format.
#   sendMessageType: The name of the MessageType that will be sent. 
#   Must be JSON based. Defaults to echo.json.
CreateWebhookNode(
name: String!,
tenant: String!,
config: AWSJSON,
description: String,
inlineApiAuthenticator: String,
loggingLevel: LogLevel,
managedApiAuthenticator: String,
requirements: [String!],
sendMessageType: String
): WebhookNode! 
#   Creates a WebSubHubNode and returns it.
# 
# Arguments
#   name: The name. Must be unique within the Tenant. Must conform 
#   to the regular expression "^[A-Za-z0-9\-_ ]{3,39}$"
#   tenant: The name of the Tenant to create this in.
#   config: The config, in JSON object format (i.e. - dict, map).
#   defaultLeaseSeconds: The lease duration to apply to 
#   subscription requests
#   that do not specify hub.lease_seconds. Must be greater
#   than or equal to 300 (the minimum lease seconds allowed
#   by the hub). Defaults to 864000 (10 days).
#   deliveryRetries: The number of times to attempt delivery to a 
#   subscription.
#   If not provided, the subscriptions will attempt to deliver
#   a message for 7 days.
#   description: A human-readable description.
#   inlineApiAuthenticator:  A Python code string that contains a 
#   single top-level function definition.
#  
#   This function must have the signature (*, context, request, **kwargs) and return 
#   None or a tuple containing
#  
#   an AuthCredentials and BaseUser (or subclasses).
#  
#   Mutually exclusive with managedApiAuthenticator.
# 
#  
#   For WebSubHubNodes, the BaseUser subclass returned MUST implement the identity 
#   property
#  
#   (this is used to identify the subscriber).
#   loggingLevel: The logging level. Defaults to INFO.
#   managedApiAuthenticator:  The name of a 
#   ApiAuthenticatorFunction. Mutually exclusive with the inlineApiAuthenticator.
# 
#  
#   For WebSubHubNodes, the BaseUser subclass returned MUST implement the identity 
#   property
#  
#   (this is used to identify the subscriber).
#   maxLeaseSeconds: The maximum lease duration for a subscription. 
#   Must
#   be greater than or equal to defaultLeaseSeconds. Defaults
#   to 864000 (10 days).
#   requirements: The list of Python requirements, in pip format.
#   signatureAlgorithm: The WebSub signature algorithm used by hub 
#   subscriptions
#   when the subscription provides a secret. Defaults to SHA1.
#   subscriptionSecurity: The security requirements the hub is 
#   enforcing on subscription
#   requests. If not provided no security requirements will be placed
#   on subscriptions.
CreateWebSubHubNode(
name: String!,
tenant: String!,
config: AWSJSON,
defaultLeaseSeconds: Int,
deliveryRetries: Int,
description: String,
inlineApiAuthenticator: String,
loggingLevel: LogLevel,
managedApiAuthenticator: String,
maxLeaseSeconds: Int,
requirements: [String!],
signatureAlgorithm: WebSubSignatureAlgorithm,
subscriptionSecurity: WebSubSubscriptionSecurity
): WebSubHubNode! 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
