OBJECT

GuardrailsAccountState

Guardrails representation for an account state. All top level fields like name, description, accountStateType, accountStateProvider will be removed in future and will be coming from ManagementEndpoint. JIRA for the same VRAE-35809.

link GraphQL Schema definition

  • type GuardrailsAccountState implements Node {
  • # Guardrail account project
  • accountProjects: [GuardrailsAccountStateProject!]
  • # account id for the GuardrailsAccountState. Eg. For AWS this will be the
  • # accountId for Azure this will be subscription
  • accountStateId: String
  • # Guardrail account provider. Eg AWS , AZURE etc.
  • accountStateProvider: String
  • # Guardrail GuardrailsAccountState type. Eg Account, Subscription, Organization,
  • # OrganizationUnit etc
  • accountStateType: String
  • # CSP user who configured guardrails on this account state
  • createdBy: User!
  • # Timestamp at which guardrails is configured on this account state. Expressed in
  • # UTC ISO-8601 format
  • createdOn: DateTime!
  • # Guardrail account description
  • description: String
  • # desired state runs for this account
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # before: Return records before the given cursor, as per GraphQL
  • # Relay spec
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • desiredStateRuns(after: String, before: String, first: Int): GuardrailsDesiredStateRunConnection!
  • # desired states configured on this account
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # before: Return records before the given cursor, as per GraphQL
  • # Relay spec
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • desiredStates(after: String, before: String, first: Int): GuardrailsDesiredStateConnection!
  • # enforced states configured on this account state
  • #
  • # Arguments
  • # after: Return records after the given cursor, as per GraphQL
  • # Relay spec
  • # before: Return records before the given cursor, as per GraphQL
  • # Relay spec
  • # cspProjectEntityId: Return enforced states belonging to
  • # provided projects
  • # drifted: Return only drifted enforced states
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # from: Filter from date time
  • # sort: Results are sorted as per fields and order specified.
  • # Supported fields are createdBy, updatedBy, status, stateId, stateRef
  • # to: Filter to date time
  • enforcedStates(
  • after: String,
  • before: String,
  • cspProjectEntityId: [EntityId!],
  • drifted: Boolean,
  • first: Int,
  • from: DateTime,
  • sort: [QuerySort!],
  • to: DateTime
  • ): GuardrailsEnforcedStateConnection!
  • id: ID!
  • # Guardrail account name
  • name: String
  • # Guardrail parent account state
  • parent: GuardrailsAccountState
  • # Time series guardrails stats for this account state
  • # The stats are currently retrieved from guardrails database. In future this will
  • # be supported using aria stats service.
  • # JIRA for the sane VRAE-35807
  • #
  • # Arguments
  • # cspProjectEntityId: Return stats applicable to provided
  • # projects
  • # from: Filter from date time
  • # statsIntervalType: stats time interval can be Days or Hours
  • # statsRange: stats time range can be 24hrs, 7days or 30days
  • # to: Filter to date time
  • # types: [Not documented]
  • stats(
  • cspProjectEntityId: [EntityId!],
  • from: DateTime,
  • statsIntervalType: GuardrailsStatsIntervalType!,
  • statsRange: GuardrailsStatsRange,
  • to: DateTime,
  • types: [GuardrailsStatType!]!
  • ): [GuardrailsStats!]!
  • # this will capture summary metrics like total monitored drifts, total mitigated
  • # drifts etc.
  • #
  • # Arguments
  • # from: Filter from date time
  • # range: [Not documented]
  • # to: Filter to date time
  • summary(from: DateTime, range: GuardrailsStatsRange, to: DateTime): GuardrailsAccountSummary
  • # Guardrails Account tags
  • tags: [Tag!]
  • # CSP user who updated guardrails configuration on this account state
  • updatedBy: User
  • # Timestamp at which guardrails configuration is updated on this account state.
  • # Expressed in UTC ISO-8601 format
  • updatedOn: DateTime
  • }