OBJECT

GuardrailsQueries

link GraphQL Schema definition

  • type GuardrailsQueries {
  • # query guardrails overview, provides accounts governed, guardrails applied,
  • # overall drift counts
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # filter: [Not documented]
  • queryDriftOverview(
  • filter: GuardrailsDriftOverviewFilter!
  • ): GuardrailsDriftOverview! @deprecated( reason: "Not relevant for usage anymore" )
  • # query drift stats based on input filters , provides aggregate drift counts
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # filter: [Not documented]
  • # sort: [Not documented]
  • queryDriftStats(
  • filter: GuardrailsDriftStatsFilter,
  • sort: [QuerySort!]
  • ): [GuardrailsDriftStats!] @deprecated( reason: "Not relevant for usage anymore" )
  • # query guardrails enforced states
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # enforcedStateFilter: [Not documented]
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # queryFilter: Input cspProjectEntity query filters to filter
  • # output of this API
  • # sort: Results are sorted as per fields and order specified.
  • # Supported fields are createdBy, updatedBy, status, stateId, stateRef
  • queryEnforcedStates(
  • after: String,
  • before: String,
  • enforcedStateFilter: GuardrailsEnforcedStateFilter,
  • first: Int,
  • queryFilter: QueryFilter,
  • sort: [QuerySort!]
  • ): GuardrailsEnforcedStateConnection!
  • # query guardrails account creation status
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # taskId: [Not documented]
  • queryGuardrailsAccountCreationStatus(
  • taskId: String!
  • ): GuardrailsAccountCreationStatusResponse!
  • # Query Guardrails Environment.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # queryFilter: Input cspProjectEntity query filters to filter
  • # output of this API
  • # sort: provide sort order for returned result. Current sort
  • # order is only supported for fields mitigatedDrifts, monitoredDrifts,
  • # failedStates
  • queryGuardrailsAccountStates(
  • after: String,
  • before: String,
  • filter: GuardrailsAccountStateFilter,
  • first: Int,
  • queryFilter: QueryFilter,
  • sort: [QuerySort!]
  • ): GuardrailsAccountStateConnection
  • # Query all guardrails desired state runs.
  • #
  • # This API follows GraphQL relay pagination specification
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # queryFilter: Input cspProjectEntity query filters to filter
  • # output of this API
  • # sort: Results are sorted as per fields and order specified.
  • # Supported fields are desrired_state_name, source_template, created_on,
  • # created_by.
  • queryGuardrailsDesiredStateRuns(
  • after: String,
  • before: String,
  • filter: GuardrailsDesiredStateRunFilter,
  • first: Int,
  • queryFilter: QueryFilter,
  • sort: QuerySort
  • ): GuardrailsDesiredStateRunConnection
  • # Query all guardrails desired states.
  • #
  • # This API follows GraphQL relay pagination specification
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # queryFilter: Input cspProjectEntity query filters to filter
  • # output of this API
  • # sort: Results are sorted as per fields and order specified.
  • # Supported fields are name, source_template, mode, createdOn, updatedOn,
  • # createdBy only
  • queryGuardrailsDesiredStates(
  • after: String,
  • before: String,
  • filter: GuardrailsDesiredStateFilter,
  • first: Int,
  • queryFilter: QueryFilter,
  • sort: QuerySort
  • ): GuardrailsDesiredStateConnection
  • # Query dependent object counts
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # filter: [Not documented]
  • queryGuardrailsObjectDependency(
  • filter: GuardrailsObjectDependencyFilter
  • ): GuardrailsObjectDependencyResponse
  • # Lookup guardrails supported resource types
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # filter: [Not documented]
  • queryGuardrailsResourceTypes(
  • filter: GuardrailsResourceTypesFilter
  • ): GuardrailsResourceTypeResponse
  • # Query all guardrails templates
  • #
  • # This API follows GraphQL relay pagination specification
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # queryFilter: Input cspProjectEntity , AWS.isManagementAccount
  • # or both with QueryFilter.and query filters to filter output of this API
  • # sort: Results are sorted as per fields and order specified.
  • # Supported fields are name, category and updated_by
  • queryGuardrailsTemplates(
  • after: String,
  • before: String,
  • filter: GuardrailsTemplateFilter,
  • first: Int,
  • queryFilter: QueryFilter,
  • sort: QuerySort
  • ): GuardrailsTemplateConnection
  • # Fetches validation task details by ID
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # taskId: [Not documented]
  • queryValidateTask(taskId: ID!): GuardrailsRemoteTemplateValidationResponse!
  • # Validates the guardrails template through remote worker
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # guardrailsTemplateContent: Guardrails template content source
  • validateGuardrailsRemoteTemplate(
  • guardrailsTemplateContent: GuardrailsContentSource!
  • ): GuardrailsRemoteTemplateValidationResponse
  • # Validates the guardrails template content and return parsed response
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # guardrailsTemplateContent: Guardrails template content
  • # meta: Meta to represent details like entrypoint for the zip
  • # template
  • validateGuardrailsTemplateContent(
  • guardrailsTemplateContent: GuardrailsTemplateContent!,
  • meta: GuardrailsTemplateMetadata
  • ): GuardrailsTemplateValidationResponse
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # aggregations: Aggregation input for worker groups
  • # pageSize: [Not documented]
  • aggregateGuardrailsWorkerGroups(
  • aggregations: [GuardrailsWorkerGroupAggregationInput!]!,
  • pageSize: Int
  • ): GuardrailsWorkerGroupAggregations
  • # Query all guardrails worker group
  • #
  • # This API follows GraphQL relay pagination specification
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • queryGuardrailsWorkerGroups(
  • after: String,
  • before: String,
  • filter: GuardrailsWorkerGroupFilter,
  • first: Int
  • ): GuardrailsWorkerGroupConnection
  • # Aggregate guardrails remediation actions
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # excludeFilters: Collection of all possible exclude filters
  • # applied when querying for actions objects
  • # filters: Aggregation query filter
  • aggregateGuardrailsRemediationActions(
  • aggregations: [GuardrailsRemediationActionsAggregationInput!]!,
  • excludeFilters: GuardrailsActionExcludeFilters,
  • filters: GuardrailsActionFilters
  • ): GuardrailsRemediationActionsAggregation
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # aggregations: Specify aggregation buckets
  • # excludeFilters: Collection of all possible exclude filters
  • # applied when querying for Run objects
  • # filters: Aggregation query filter
  • aggregateGuardrailsRemediationRuns(
  • aggregations: [GuardrailsRemediationRunsAggregationInput!]!,
  • excludeFilters: GuardrailsRunExcludeFilters,
  • filters: GuardrailsRunFilters
  • ): GuardrailsRemediationRunsAggregation
  • # Query all guardrails remediation Actions
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # sort: Return records sort
  • queryGuardrailsRemediationActions(
  • after: String,
  • before: String,
  • filter: GuardrailsRemediationActionFilterInput,
  • first: Int,
  • sort: [QuerySort]
  • ): GuardrailsRemediationActionConnection
  • # Query all guardrails remediation rules
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # sort: [Not documented]
  • queryGuardrailsRemediationRules(
  • after: String,
  • before: String,
  • filter: GuardrailsRemediationRuleFilterInput,
  • first: Int,
  • sort: [QuerySort]
  • ): GuardrailsRemediationRulesConnection
  • # Query all guardrails Remediation runs.
  • #
  • # Run is single remediation Job execution
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # 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
  • # filter: Input filters to filter output of this API
  • # first: Return first N records in a paged response, as per
  • # GraphQL Relay spec
  • # sort: [Not documented]
  • queryGuardrailsRemediationRuns(
  • after: String,
  • before: String,
  • filter: GuardrailsRemediationRunFilterInput,
  • first: Int,
  • sort: [QuerySort]
  • ): GuardrailsRemediationRunsConnection
  • # Query all guardrails worker group jobs
  • #
  • # **NOTE:** This API/functionality is in Beta, this functionality is a candidate
  • # for a stable API but we reserve the right to fix issues including modifying the
  • # schema if required.
  • #
  • # Arguments
  • # ruleIds: [Not documented]
  • # workerGroupId: Guardrails Worker Group Id
  • queryGuardrailsWorkerGroupJobs(
  • ruleIds: [String!],
  • workerGroupId: ID!
  • ): GuardrailsWorkerGroupJobsConnection
  • }

link Require by