OBJECT

Edge

Transmits messages between Nodes.

link GraphQL Schema definition

  • type Edge {
  • # The AWS ARN of the SQS Queue.
  • arn: String!
  • # When and who created.
  • created: AtBy!
  • # A human-readable description.
  • description: String
  • # True if currently draining in preparation for deletion.
  • draining: Boolean!
  • # The KmsKey encryption key used to encrypt messages at rest.
  • kmsKey: KmsKey
  • # When and who modified.
  • lastModified: AtBy!
  • # The maximum number of times that a message is attempted to be delivered before
  • # being emitted by the DeadLetterEmitterNode.
  • maxReceiveCount: Int
  • # An estimate of the number of messages currently being transferred.
  • messageCounts: MessageCounts!
  • # The MessageType being transferred.
  • messageType: MessageType!
  • # The AWS SQS Queue URL.
  • queue: AWSURL!
  • # The source Node that places messages on this Edge.
  • source: Node!
  • # The target Node that this Edge delivers messages to.
  • target: Node!
  • # The Tenant.
  • tenant: Tenant!
  • # Deletes the Edge, optionally draining it in the process.
  • #
  • # Arguments
  • # drain: True if the messages on the edge shoudl be drained prior
  • # to deletion. Defaults to False.
  • Delete(drain: Boolean): Boolean!
  • # Lists the changes.
  • #
  • # Arguments
  • # endDateTime: The end date/time (inclusive) to list changes for
  • # in ISO8601 format. Defaults to now.
  • # exclusiveStartKey: The lastEvaluatedKey from a previous
  • # ChangeResult. Used when paginating.
  • # limit: Used for limiting the number of results when paginating.
  • # Defaults to "all".
  • # 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(
  • endDateTime: AWSDateTime,
  • exclusiveStartKey: AWSJSON,
  • limit: Int,
  • sortAscending: Boolean,
  • startDateTime: AWSDateTime
  • ): ChangeResult!
  • # Moves the edge to a new source and/or target combination. Messages currently
  • # being transmitted by the Edge are retained.
  • #
  • # Arguments
  • # source: The name of the new source Node.
  • # target: The name of the new target Node.
  • Move(source: String!, target: String!): Edge!
  • # Purges all messages currently being transmitted by the Edge.
  • Purge: Boolean!
  • # Updates the Edge and returns it.
  • #
  • # Arguments
  • # description: A human-readable description.
  • Update(description: String): Edge!
  • }

link Require by