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]
- (
- 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]
- (
- GuardrailsDriftStatsFilter, :
- 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
- (
- String, :
- String, :
- GuardrailsEnforcedStateFilter, :
- Int, :
- QueryFilter, :
- 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]
- (
- 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
- (
- String, :
- String, :
- GuardrailsAccountStateFilter, :
- Int, :
- QueryFilter, :
- 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.
- (
- String, :
- String, :
- GuardrailsDesiredStateRunFilter, :
- Int, :
- QueryFilter, :
- 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
- (
- String, :
- String, :
- GuardrailsDesiredStateFilter, :
- Int, :
- QueryFilter, :
- 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]
- (
- 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]
- (
- 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
- (
- String, :
- String, :
- GuardrailsTemplateFilter, :
- Int, :
- QueryFilter, :
- 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]
- 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
- (
- 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
- (
- GuardrailsTemplateContent!, :
- 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]
- (
- GuardrailsWorkerGroupAggregationInput!]!, : [
- 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
- (
- String, :
- String, :
- GuardrailsWorkerGroupFilter, :
- 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
- (
- GuardrailsRemediationActionsAggregationInput!]!, : [
- GuardrailsActionExcludeFilters, :
- 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
- (
- GuardrailsRemediationRunsAggregationInput!]!, : [
- GuardrailsRunExcludeFilters, :
- 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
- (
- String, :
- String, :
- GuardrailsRemediationActionFilterInput, :
- Int, :
- 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]
- (
- String, :
- String, :
- GuardrailsRemediationRuleFilterInput, :
- Int, :
- 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]
- (
- String, :
- String, :
- GuardrailsRemediationRunFilterInput, :
- Int, :
- 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
- (
- String!], : [
- ID! :
- ): GuardrailsWorkerGroupJobsConnection
- }