models

package
v0.19.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 3, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// AuthenticationErrorTypeAuthenticationError captures enum value "AuthenticationError"
	AuthenticationErrorTypeAuthenticationError string = "AuthenticationError"

	// AuthenticationErrorTypeInvalidOrMissingToken captures enum value "InvalidOrMissingToken"
	AuthenticationErrorTypeInvalidOrMissingToken string = "InvalidOrMissingToken"
)
View Source 
const (

	// AuthorizationErrorTypeAuthorizationError captures enum value "AuthorizationError"
	AuthorizationErrorTypeAuthorizationError string = "AuthorizationError"

	// AuthorizationErrorTypeEnvironmentAccessDenied captures enum value "EnvironmentAccessDenied"
	AuthorizationErrorTypeEnvironmentAccessDenied string = "EnvironmentAccessDenied"
)
View Source 
const (

	// BadRequestErrorTypeBadRequest captures enum value "BadRequest"
	BadRequestErrorTypeBadRequest string = "BadRequest"

	// BadRequestErrorTypeAlreadyAttachedToTenantError captures enum value "AlreadyAttachedToTenantError"
	BadRequestErrorTypeAlreadyAttachedToTenantError string = "AlreadyAttachedToTenantError"

	// BadRequestErrorTypeAlreadyInvitedError captures enum value "AlreadyInvitedError"
	BadRequestErrorTypeAlreadyInvitedError string = "AlreadyInvitedError"

	// BadRequestErrorTypeDomainAttachedToSsoTenantError captures enum value "DomainAttachedToSsoTenantError"
	BadRequestErrorTypeDomainAttachedToSsoTenantError string = "DomainAttachedToSsoTenantError"

	// BadRequestErrorTypeInvalidCredential captures enum value "InvalidCredential"
	BadRequestErrorTypeInvalidCredential string = "InvalidCredential"

	// BadRequestErrorTypeInvalidJSON captures enum value "InvalidJSON"
	BadRequestErrorTypeInvalidJSON string = "InvalidJSON"

	// BadRequestErrorTypeInvalidParameterValue captures enum value "InvalidParameterValue"
	BadRequestErrorTypeInvalidParameterValue string = "InvalidParameterValue"

	// BadRequestErrorTypeMissingParameter captures enum value "MissingParameter"
	BadRequestErrorTypeMissingParameter string = "MissingParameter"

	// BadRequestErrorTypeRoleNotAssumable captures enum value "RoleNotAssumable"
	BadRequestErrorTypeRoleNotAssumable string = "RoleNotAssumable"

	// BadRequestErrorTypeWorkAlreadyStartedException captures enum value "WorkAlreadyStartedException"
	BadRequestErrorTypeWorkAlreadyStartedException string = "WorkAlreadyStartedException"
)
View Source 
const (

	// ComplianceByRuleResultPASS captures enum value "PASS"
	ComplianceByRuleResultPASS string = "PASS"

	// ComplianceByRuleResultFAIL captures enum value "FAIL"
	ComplianceByRuleResultFAIL string = "FAIL"

	// ComplianceByRuleResultUNKNOWN captures enum value "UNKNOWN"
	ComplianceByRuleResultUNKNOWN string = "UNKNOWN"
)
View Source 
const (

	// CreateCustomRuleInputProviderAWS captures enum value "AWS"
	CreateCustomRuleInputProviderAWS string = "AWS"

	// CreateCustomRuleInputProviderAWSGOVCLOUD captures enum value "AWS_GOVCLOUD"
	CreateCustomRuleInputProviderAWSGOVCLOUD string = "AWS_GOVCLOUD"

	// CreateCustomRuleInputProviderAZURE captures enum value "AZURE"
	CreateCustomRuleInputProviderAZURE string = "AZURE"

	// CreateCustomRuleInputProviderGOOGLE captures enum value "GOOGLE"
	CreateCustomRuleInputProviderGOOGLE string = "GOOGLE"
)
View Source 
const (

	// CreateCustomRuleInputSeverityInformational captures enum value "Informational"
	CreateCustomRuleInputSeverityInformational string = "Informational"

	// CreateCustomRuleInputSeverityLow captures enum value "Low"
	CreateCustomRuleInputSeverityLow string = "Low"

	// CreateCustomRuleInputSeverityMedium captures enum value "Medium"
	CreateCustomRuleInputSeverityMedium string = "Medium"

	// CreateCustomRuleInputSeverityHigh captures enum value "High"
	CreateCustomRuleInputSeverityHigh string = "High"

	// CreateCustomRuleInputSeverityCritical captures enum value "Critical"
	CreateCustomRuleInputSeverityCritical string = "Critical"
)
View Source 
const (

	// CreateCustomRuleInputSourceFUGUE captures enum value "FUGUE"
	CreateCustomRuleInputSourceFUGUE string = "FUGUE"

	// CreateCustomRuleInputSourceCUSTOM captures enum value "CUSTOM"
	CreateCustomRuleInputSourceCUSTOM string = "CUSTOM"
)
View Source 
const (

	// CreateEnvironmentInputProviderAws captures enum value "aws"
	CreateEnvironmentInputProviderAws string = "aws"

	// CreateEnvironmentInputProviderAwsGovcloud captures enum value "aws_govcloud"
	CreateEnvironmentInputProviderAwsGovcloud string = "aws_govcloud"

	// CreateEnvironmentInputProviderAzure captures enum value "azure"
	CreateEnvironmentInputProviderAzure string = "azure"

	// CreateEnvironmentInputProviderGoogle captures enum value "google"
	CreateEnvironmentInputProviderGoogle string = "google"

	// CreateEnvironmentInputProviderRepository captures enum value "repository"
	CreateEnvironmentInputProviderRepository string = "repository"
)
View Source 
const (

	// CreateGroupInputPolicyFugueREADONLY captures enum value "fugue:READONLY"
	CreateGroupInputPolicyFugueREADONLY string = "fugue:READONLY"

	// CreateGroupInputPolicyFugueAUDITOR captures enum value "fugue:AUDITOR"
	CreateGroupInputPolicyFugueAUDITOR string = "fugue:AUDITOR"

	// CreateGroupInputPolicyFugueEDITOR captures enum value "fugue:EDITOR"
	CreateGroupInputPolicyFugueEDITOR string = "fugue:EDITOR"

	// CreateGroupInputPolicyFugueCONTRIBUTOR captures enum value "fugue:CONTRIBUTOR"
	CreateGroupInputPolicyFugueCONTRIBUTOR string = "fugue:CONTRIBUTOR"

	// CreateGroupInputPolicyFugueMANAGER captures enum value "fugue:MANAGER"
	CreateGroupInputPolicyFugueMANAGER string = "fugue:MANAGER"

	// CreateGroupInputPolicyFugueORGANIZATIONREPORTVIEWER captures enum value "fugue:ORGANIZATION_REPORT_VIEWER"
	CreateGroupInputPolicyFugueORGANIZATIONREPORTVIEWER string = "fugue:ORGANIZATION_REPORT_VIEWER"

	// CreateGroupInputPolicyFugueIACSCANNER captures enum value "fugue:IAC_SCANNER"
	CreateGroupInputPolicyFugueIACSCANNER string = "fugue:IAC_SCANNER"
)
View Source 
const (

	// CustomRuleProviderAWS captures enum value "AWS"
	CustomRuleProviderAWS string = "AWS"

	// CustomRuleProviderAWSGOVCLOUD captures enum value "AWS_GOVCLOUD"
	CustomRuleProviderAWSGOVCLOUD string = "AWS_GOVCLOUD"

	// CustomRuleProviderAZURE captures enum value "AZURE"
	CustomRuleProviderAZURE string = "AZURE"

	// CustomRuleProviderGOOGLE captures enum value "GOOGLE"
	CustomRuleProviderGOOGLE string = "GOOGLE"
)
View Source 
const (

	// CustomRuleSeverityInformational captures enum value "Informational"
	CustomRuleSeverityInformational string = "Informational"

	// CustomRuleSeverityLow captures enum value "Low"
	CustomRuleSeverityLow string = "Low"

	// CustomRuleSeverityMedium captures enum value "Medium"
	CustomRuleSeverityMedium string = "Medium"

	// CustomRuleSeverityHigh captures enum value "High"
	CustomRuleSeverityHigh string = "High"

	// CustomRuleSeverityCritical captures enum value "Critical"
	CustomRuleSeverityCritical string = "Critical"
)
View Source 
const (

	// CustomRuleStatusENABLED captures enum value "ENABLED"
	CustomRuleStatusENABLED string = "ENABLED"

	// CustomRuleStatusDISABLED captures enum value "DISABLED"
	CustomRuleStatusDISABLED string = "DISABLED"

	// CustomRuleStatusINVALID captures enum value "INVALID"
	CustomRuleStatusINVALID string = "INVALID"
)
View Source 
const (

	// CustomRuleErrorSeverityError captures enum value "error"
	CustomRuleErrorSeverityError string = "error"

	// CustomRuleErrorSeverityWarning captures enum value "warning"
	CustomRuleErrorSeverityWarning string = "warning"
)
View Source 
const (

	// EnvironmentProviderAws captures enum value "aws"
	EnvironmentProviderAws string = "aws"

	// EnvironmentProviderAwsGovcloud captures enum value "aws_govcloud"
	EnvironmentProviderAwsGovcloud string = "aws_govcloud"

	// EnvironmentProviderAzure captures enum value "azure"
	EnvironmentProviderAzure string = "azure"

	// EnvironmentProviderGoogle captures enum value "google"
	EnvironmentProviderGoogle string = "google"

	// EnvironmentProviderRepository captures enum value "repository"
	EnvironmentProviderRepository string = "repository"
)
View Source 
const (

	// EnvironmentScanStatusCREATED captures enum value "CREATED"
	EnvironmentScanStatusCREATED string = "CREATED"

	// EnvironmentScanStatusQUEUED captures enum value "QUEUED"
	EnvironmentScanStatusQUEUED string = "QUEUED"

	// EnvironmentScanStatusINPROGRESS captures enum value "IN_PROGRESS"
	EnvironmentScanStatusINPROGRESS string = "IN_PROGRESS"

	// EnvironmentScanStatusERROR captures enum value "ERROR"
	EnvironmentScanStatusERROR string = "ERROR"

	// EnvironmentScanStatusSUCCESS captures enum value "SUCCESS"
	EnvironmentScanStatusSUCCESS string = "SUCCESS"

	// EnvironmentScanStatusCANCELED captures enum value "CANCELED"
	EnvironmentScanStatusCANCELED string = "CANCELED"
)
View Source 
const (

	// EventEventTypeDRIFT captures enum value "DRIFT"
	EventEventTypeDRIFT string = "DRIFT"

	// EventEventTypeREMEDIATION captures enum value "REMEDIATION"
	EventEventTypeREMEDIATION string = "REMEDIATION"

	// EventEventTypeCOMPLIANCE captures enum value "COMPLIANCE"
	EventEventTypeCOMPLIANCE string = "COMPLIANCE"
)
View Source 
const (

	// FamilySourceFUGUE captures enum value "FUGUE"
	FamilySourceFUGUE string = "FUGUE"

	// FamilySourceCUSTOM captures enum value "CUSTOM"
	FamilySourceCUSTOM string = "CUSTOM"
)
View Source 
const (

	// FamilyWithRulesSourceFUGUE captures enum value "FUGUE"
	FamilyWithRulesSourceFUGUE string = "FUGUE"

	// FamilyWithRulesSourceCUSTOM captures enum value "CUSTOM"
	FamilyWithRulesSourceCUSTOM string = "CUSTOM"
)
View Source 
const (

	// InternalServerErrorTypeInternalServerError captures enum value "InternalServerError"
	InternalServerErrorTypeInternalServerError string = "InternalServerError"

	// InternalServerErrorTypeDatabaseError captures enum value "DatabaseError"
	InternalServerErrorTypeDatabaseError string = "DatabaseError"
)
View Source 
const (

	// ResourceDiffChangeADDED captures enum value "ADDED"
	ResourceDiffChangeADDED string = "ADDED"

	// ResourceDiffChangeMODIFIED captures enum value "MODIFIED"
	ResourceDiffChangeMODIFIED string = "MODIFIED"

	// ResourceDiffChangeREMOVED captures enum value "REMOVED"
	ResourceDiffChangeREMOVED string = "REMOVED"
)
View Source 
const (

	// RuleWaiverStatusACTIVE captures enum value "ACTIVE"
	RuleWaiverStatusACTIVE string = "ACTIVE"

	// RuleWaiverStatusEXPIRED captures enum value "EXPIRED"
	RuleWaiverStatusEXPIRED string = "EXPIRED"
)
View Source 
const (

	// ScanStatusCREATED captures enum value "CREATED"
	ScanStatusCREATED string = "CREATED"

	// ScanStatusQUEUED captures enum value "QUEUED"
	ScanStatusQUEUED string = "QUEUED"

	// ScanStatusINPROGRESS captures enum value "IN_PROGRESS"
	ScanStatusINPROGRESS string = "IN_PROGRESS"

	// ScanStatusERROR captures enum value "ERROR"
	ScanStatusERROR string = "ERROR"

	// ScanStatusSUCCESS captures enum value "SUCCESS"
	ScanStatusSUCCESS string = "SUCCESS"

	// ScanStatusCANCELED captures enum value "CANCELED"
	ScanStatusCANCELED string = "CANCELED"
)
View Source 
const (

	// TestCustomRuleOutputResultPASS captures enum value "PASS"
	TestCustomRuleOutputResultPASS string = "PASS"

	// TestCustomRuleOutputResultFAIL captures enum value "FAIL"
	TestCustomRuleOutputResultFAIL string = "FAIL"

	// TestCustomRuleOutputResultUNKNOWN captures enum value "UNKNOWN"
	TestCustomRuleOutputResultUNKNOWN string = "UNKNOWN"
)
View Source 
const (

	// TestCustomRuleOutputResourceResultPASS captures enum value "PASS"
	TestCustomRuleOutputResourceResultPASS string = "PASS"

	// TestCustomRuleOutputResourceResultFAIL captures enum value "FAIL"
	TestCustomRuleOutputResourceResultFAIL string = "FAIL"

	// TestCustomRuleOutputResourceResultUNKNOWN captures enum value "UNKNOWN"
	TestCustomRuleOutputResourceResultUNKNOWN string = "UNKNOWN"
)
View Source 
const (

	// UpdateCustomRuleInputSeverityInformational captures enum value "Informational"
	UpdateCustomRuleInputSeverityInformational string = "Informational"

	// UpdateCustomRuleInputSeverityLow captures enum value "Low"
	UpdateCustomRuleInputSeverityLow string = "Low"

	// UpdateCustomRuleInputSeverityMedium captures enum value "Medium"
	UpdateCustomRuleInputSeverityMedium string = "Medium"

	// UpdateCustomRuleInputSeverityHigh captures enum value "High"
	UpdateCustomRuleInputSeverityHigh string = "High"

	// UpdateCustomRuleInputSeverityCritical captures enum value "Critical"
	UpdateCustomRuleInputSeverityCritical string = "Critical"
)
View Source 
const (

	// UpdateCustomRuleInputStatusENABLED captures enum value "ENABLED"
	UpdateCustomRuleInputStatusENABLED string = "ENABLED"

	// UpdateCustomRuleInputStatusDISABLED captures enum value "DISABLED"
	UpdateCustomRuleInputStatusDISABLED string = "DISABLED"
)
View Source 
const (

	// UpdateEnvironmentInputProviderAws captures enum value "aws"
	UpdateEnvironmentInputProviderAws string = "aws"

	// UpdateEnvironmentInputProviderAwsGovcloud captures enum value "aws_govcloud"
	UpdateEnvironmentInputProviderAwsGovcloud string = "aws_govcloud"

	// UpdateEnvironmentInputProviderAzure captures enum value "azure"
	UpdateEnvironmentInputProviderAzure string = "azure"

	// UpdateEnvironmentInputProviderGoogle captures enum value "google"
	UpdateEnvironmentInputProviderGoogle string = "google"

	// UpdateEnvironmentInputProviderRepository captures enum value "repository"
	UpdateEnvironmentInputProviderRepository string = "repository"
)
View Source 
const (

	// CustomRuleSourceCUSTOM captures enum value "CUSTOM"
	CustomRuleSourceCUSTOM string = "CUSTOM"
)
View Source 
const (

	// NotFoundErrorTypeNotFound captures enum value "NotFound"
	NotFoundErrorTypeNotFound string = "NotFound"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Attribute 

type Attribute struct {

	// Indicates whether the attribute type is input or output.
	AttrType string `json:"attr_type,omitempty"`

	// Name of the attribute.
	Name string `json:"name,omitempty"`

	// Value of the attribute as a result of the event.
	New string `json:"new,omitempty"`

	// Value of the attribute before the event.
	Old string `json:"old,omitempty"`

	// Indicates whether the attribute was removed.
	Removed bool `json:"removed,omitempty"`

	// Indicates whether the attribute needed to be deleted and recreated.
	RequiresNew bool `json:"requires_new,omitempty"`

	// Indicates whether the attribute contains sensitive data.
	Sensitive bool `json:"sensitive,omitempty"`
}

Attribute Description of a change to a resource attribute.

swagger:model Attribute

func (*Attribute) MarshalBinary 

func (m *Attribute) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Attribute) UnmarshalBinary 

func (m *Attribute) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Attribute) Validate 

func (m *Attribute) Validate(formats strfmt.Registry) error

Validate validates this attribute

type AuditLogEvent added in v0.13.0 

type AuditLogEvent struct {

	// action
	Action string `json:"action,omitempty"`

	// action type
	ActionType string `json:"action_type,omitempty"`

	// error
	Error bool `json:"error,omitempty"`

	// event source
	EventSource string `json:"event_source,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// identity
	Identity *AuditLogEventIdentity `json:"identity,omitempty"`

	// parameters
	Parameters map[string]string `json:"parameters,omitempty"`

	// principal
	Principal string `json:"principal,omitempty"`

	// request context
	RequestContext *AuditLogEventRequestContext `json:"request_context,omitempty"`

	// response code
	ResponseCode int64 `json:"response_code,omitempty"`

	// response message
	ResponseMessage string `json:"response_message,omitempty"`

	// results
	Results []*AuditLogEventResultsItems0 `json:"results"`

	// subject id
	SubjectID string `json:"subject_id,omitempty"`

	// subject kind
	SubjectKind string `json:"subject_kind,omitempty"`

	// subject name
	SubjectName string `json:"subject_name,omitempty"`

	// timestamp
	Timestamp string `json:"timestamp,omitempty"`
}

AuditLogEvent audit log event

swagger:model AuditLogEvent

func (*AuditLogEvent) MarshalBinary added in v0.13.0 

func (m *AuditLogEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditLogEvent) UnmarshalBinary added in v0.13.0 

func (m *AuditLogEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditLogEvent) Validate added in v0.13.0 

func (m *AuditLogEvent) Validate(formats strfmt.Registry) error

Validate validates this audit log event

type AuditLogEventIdentity added in v0.13.0 

type AuditLogEventIdentity struct {

	// email
	Email string `json:"email,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// principal id
	PrincipalID string `json:"principal_id,omitempty"`

	// principal kind
	PrincipalKind string `json:"principal_kind,omitempty"`
}

AuditLogEventIdentity audit log event identity

swagger:model AuditLogEventIdentity

func (*AuditLogEventIdentity) MarshalBinary added in v0.13.0 

func (m *AuditLogEventIdentity) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditLogEventIdentity) UnmarshalBinary added in v0.13.0 

func (m *AuditLogEventIdentity) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditLogEventIdentity) Validate added in v0.13.0 

func (m *AuditLogEventIdentity) Validate(formats strfmt.Registry) error

Validate validates this audit log event identity

type AuditLogEventRequestContext added in v0.13.0 

type AuditLogEventRequestContext struct {

	// domain
	Domain string `json:"domain,omitempty"`

	// method
	Method string `json:"method,omitempty"`

	// path
	Path string `json:"path,omitempty"`

	// protocol
	Protocol string `json:"protocol,omitempty"`

	// source ip
	SourceIP string `json:"source_ip,omitempty"`

	// trace id
	TraceID string `json:"trace_id,omitempty"`

	// user agent
	UserAgent string `json:"user_agent,omitempty"`
}

AuditLogEventRequestContext audit log event request context

swagger:model AuditLogEventRequestContext

func (*AuditLogEventRequestContext) MarshalBinary added in v0.13.0 

func (m *AuditLogEventRequestContext) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditLogEventRequestContext) UnmarshalBinary added in v0.13.0 

func (m *AuditLogEventRequestContext) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditLogEventRequestContext) Validate added in v0.13.0 

func (m *AuditLogEventRequestContext) Validate(formats strfmt.Registry) error

Validate validates this audit log event request context

type AuditLogEventResultsItems0 added in v0.13.0 

type AuditLogEventResultsItems0 struct {

	// action
	Action string `json:"action,omitempty"`

	// entity id
	EntityID string `json:"entity_id,omitempty"`

	// entity kind
	EntityKind string `json:"entity_kind,omitempty"`

	// entity name
	EntityName string `json:"entity_name,omitempty"`
}

AuditLogEventResultsItems0 audit log event results items0

swagger:model AuditLogEventResultsItems0

func (*AuditLogEventResultsItems0) MarshalBinary added in v0.13.0 

func (m *AuditLogEventResultsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditLogEventResultsItems0) UnmarshalBinary added in v0.13.0 

func (m *AuditLogEventResultsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditLogEventResultsItems0) Validate added in v0.13.0 

func (m *AuditLogEventResultsItems0) Validate(formats strfmt.Registry) error

Validate validates this audit log event results items0

type AuditLogEvents added in v0.13.0 

type AuditLogEvents struct {

	// List of audit log events
	Items []*AuditLogEvent `json:"items"`

	// If set can be used to retrieve the next page of records.
	NextToken string `json:"next_token,omitempty"`
}

AuditLogEvents Paginated list of audit log events

swagger:model AuditLogEvents

func (*AuditLogEvents) MarshalBinary added in v0.13.0 

func (m *AuditLogEvents) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuditLogEvents) UnmarshalBinary added in v0.13.0 

func (m *AuditLogEvents) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuditLogEvents) Validate added in v0.13.0 

func (m *AuditLogEvents) Validate(formats strfmt.Registry) error

Validate validates this audit log events

type AuthenticationError 

type AuthenticationError struct {

	// HTTP status code for the error.
	Code int64 `json:"code,omitempty"`

	// Detailed human-readable message about the authentication error.
	Message string `json:"message,omitempty"`

	// Type of authentication error.
	// Enum: [AuthenticationError InvalidOrMissingToken]
	Type string `json:"type,omitempty"`
}

AuthenticationError Error returned when the API is unable to authenticate the request.

swagger:model AuthenticationError

func (*AuthenticationError) MarshalBinary 

func (m *AuthenticationError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuthenticationError) UnmarshalBinary 

func (m *AuthenticationError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuthenticationError) Validate 

func (m *AuthenticationError) Validate(formats strfmt.Registry) error

Validate validates this authentication error

type AuthorizationError 

type AuthorizationError struct {

	// HTTP status code for the error.
	Code int64 `json:"code,omitempty"`

	// Detailed human-readable message about the authorization error.
	Message string `json:"message,omitempty"`

	// Type of authorization error.
	// Enum: [AuthorizationError EnvironmentAccessDenied]
	Type string `json:"type,omitempty"`
}

AuthorizationError Error returned when the API is unable to authorize the request.

swagger:model AuthorizationError

func (*AuthorizationError) MarshalBinary 

func (m *AuthorizationError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AuthorizationError) UnmarshalBinary 

func (m *AuthorizationError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AuthorizationError) Validate 

func (m *AuthorizationError) Validate(formats strfmt.Registry) error

Validate validates this authorization error

type BadRequestError 

type BadRequestError struct {

	// HTTP status code for the error.
	Code int64 `json:"code,omitempty"`

	// Detailed human-readable message about the bad request.
	Message string `json:"message,omitempty"`

	// Type of bad request.
	// Enum: [BadRequest AlreadyAttachedToTenantError AlreadyInvitedError DomainAttachedToSsoTenantError InvalidCredential InvalidJSON InvalidParameterValue MissingParameter RoleNotAssumable WorkAlreadyStartedException]
	Type string `json:"type,omitempty"`
}

BadRequestError Error returned when the API is presented with a bad request.

swagger:model BadRequestError

func (*BadRequestError) MarshalBinary 

func (m *BadRequestError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BadRequestError) UnmarshalBinary 

func (m *BadRequestError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BadRequestError) Validate 

func (m *BadRequestError) Validate(formats strfmt.Registry) error

Validate validates this bad request error

type ComplianceByResourceType 

type ComplianceByResourceType struct {

	// Count of resources found to be fully compliant with all rules it has been evaulated against.
	Compliant int64 `json:"compliant,omitempty"`

	// List of non-compliant resources and the rules they have violated.
	Noncompliant []*NonCompliantResource `json:"noncompliant"`

	// Name of the resource type.
	ResourceType string `json:"resource_type,omitempty"`

	// Count of all resources evaluated for this resource type.
	Total int64 `json:"total,omitempty"`
}

ComplianceByResourceType Compliance results for a resource type.

swagger:model ComplianceByResourceType

func (*ComplianceByResourceType) MarshalBinary 

func (m *ComplianceByResourceType) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceByResourceType) UnmarshalBinary 

func (m *ComplianceByResourceType) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceByResourceType) Validate 

func (m *ComplianceByResourceType) Validate(formats strfmt.Registry) error

Validate validates this compliance by resource type

type ComplianceByResourceTypeOutput 

type ComplianceByResourceTypeOutput struct {

	// Total number of items.
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// Paginated list of compliance results grouped by resource type.
	Items []*ComplianceByResourceType `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

ComplianceByResourceTypeOutput Paginated list of compliance results grouped by resource type.

swagger:model ComplianceByResourceTypeOutput

func (*ComplianceByResourceTypeOutput) MarshalBinary 

func (m *ComplianceByResourceTypeOutput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceByResourceTypeOutput) UnmarshalBinary 

func (m *ComplianceByResourceTypeOutput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceByResourceTypeOutput) Validate 

func (m *ComplianceByResourceTypeOutput) Validate(formats strfmt.Registry) error

Validate validates this compliance by resource type output

type ComplianceByRule 

type ComplianceByRule struct {

	// List of resource types that failed to satisfy the rule due to a required resource being omitted and associated error messages.
	FailedResourceTypes []*ComplianceByRuleFailedResourceTypesItems0 `json:"failed_resource_types"`

	// List of resources that failed to satisfy the rule due to a misconfiguration in the resource and associated error messages.
	FailedResources []*ComplianceByRuleFailedResourcesItems0 `json:"failed_resources"`

	// Name of the compliance family.
	Family string `json:"family,omitempty"`

	// Result of the rule.
	// Enum: [PASS FAIL UNKNOWN]
	Result string `json:"result,omitempty"`

	// Name of the compliance rule.
	Rule string `json:"rule,omitempty"`

	// List of resource types that were not surveyed and caused the result to be unknown.
	UnsurveyedResourceTypes []string `json:"unsurveyed_resource_types"`
}

ComplianceByRule Compliance rule and result.

swagger:model ComplianceByRule

func (*ComplianceByRule) MarshalBinary 

func (m *ComplianceByRule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceByRule) UnmarshalBinary 

func (m *ComplianceByRule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceByRule) Validate 

func (m *ComplianceByRule) Validate(formats strfmt.Registry) error

Validate validates this compliance by rule

type ComplianceByRuleFailedResourceTypesItems0 

type ComplianceByRuleFailedResourceTypesItems0 struct {

	// Messages why the rule failed.
	Messages []string `json:"messages"`

	// Resource type that failed to satisfy the rule.
	ResourceType string `json:"resource_type,omitempty"`
}

ComplianceByRuleFailedResourceTypesItems0 Resource type that failed to satisfy the rule due to a required resource being omitted and associated error messages.

swagger:model ComplianceByRuleFailedResourceTypesItems0

func (*ComplianceByRuleFailedResourceTypesItems0) MarshalBinary 

func (m *ComplianceByRuleFailedResourceTypesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceByRuleFailedResourceTypesItems0) UnmarshalBinary 

func (m *ComplianceByRuleFailedResourceTypesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceByRuleFailedResourceTypesItems0) Validate 

func (m *ComplianceByRuleFailedResourceTypesItems0) Validate(formats strfmt.Registry) error

Validate validates this compliance by rule failed resource types items0

type ComplianceByRuleFailedResourcesItems0 

type ComplianceByRuleFailedResourcesItems0 struct {

	// Messages why the rule failed.
	Messages []string `json:"messages"`

	// resource
	Resource *Resource `json:"resource,omitempty"`
}

ComplianceByRuleFailedResourcesItems0 Resource that failed to satisfy the rule due to a misconfiguration in the resource and associated error messages.

swagger:model ComplianceByRuleFailedResourcesItems0

func (*ComplianceByRuleFailedResourcesItems0) MarshalBinary 

func (m *ComplianceByRuleFailedResourcesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceByRuleFailedResourcesItems0) UnmarshalBinary 

func (m *ComplianceByRuleFailedResourcesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceByRuleFailedResourcesItems0) Validate 

func (m *ComplianceByRuleFailedResourcesItems0) Validate(formats strfmt.Registry) error

Validate validates this compliance by rule failed resources items0

type ComplianceByRules 

type ComplianceByRules struct {

	// Total number of items.
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// Paginated list of compliance rules and results for a scan.
	Items []*ComplianceByRule `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

ComplianceByRules Paginated list of compliance rules and results for a scan.

swagger:model ComplianceByRules

func (*ComplianceByRules) MarshalBinary 

func (m *ComplianceByRules) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceByRules) UnmarshalBinary 

func (m *ComplianceByRules) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceByRules) Validate 

func (m *ComplianceByRules) Validate(formats strfmt.Registry) error

Validate validates this compliance by rules

type ComplianceDiff 

type ComplianceDiff struct {

	// The resource's compliance state after an event.
	NewState string `json:"new_state,omitempty"`

	// The resource's compliance state before an event.
	OldState string `json:"old_state,omitempty"`

	// ID of the resource given by the provider.
	ResourceID string `json:"resource_id,omitempty"`

	// Resource type.
	ResourceType string `json:"resource_type,omitempty"`

	// List of rule evaluations that changed state after an event.
	Rules []*ComplianceDiffRulesItems0 `json:"rules"`
}

ComplianceDiff Difference between the old and new compliance state of a resource after an event.

swagger:model ComplianceDiff

func (*ComplianceDiff) MarshalBinary 

func (m *ComplianceDiff) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceDiff) UnmarshalBinary 

func (m *ComplianceDiff) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceDiff) Validate 

func (m *ComplianceDiff) Validate(formats strfmt.Registry) error

Validate validates this compliance diff

type ComplianceDiffRulesItems0 

type ComplianceDiffRulesItems0 struct {

	// The compliance families that a rule is evaluated for.
	ComplianceFamilies []string `json:"compliance_families"`

	// The compliance controls that a rule is evaluated for.
	Controls []string `json:"controls"`

	// The rule's error message after an event.
	NewMessage string `json:"new_message,omitempty"`

	// The rule's evaluation state after an event.
	NewState string `json:"new_state,omitempty"`

	// The rule's waived status after an event.
	NewWaived bool `json:"new_waived,omitempty"`

	// The rule's error message before an event.
	OldMessage string `json:"old_message,omitempty"`

	// The rule's evaluation state before an event.
	OldState string `json:"old_state,omitempty"`

	// The rule's waived status before an event.
	OldWaived bool `json:"old_waived,omitempty"`

	// Summary of the rule a resource was evaluated against.
	Summary string `json:"summary,omitempty"`
}

ComplianceDiffRulesItems0 compliance diff rules items0

swagger:model ComplianceDiffRulesItems0

func (*ComplianceDiffRulesItems0) MarshalBinary 

func (m *ComplianceDiffRulesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ComplianceDiffRulesItems0) UnmarshalBinary 

func (m *ComplianceDiffRulesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ComplianceDiffRulesItems0) Validate 

func (m *ComplianceDiffRulesItems0) Validate(formats strfmt.Registry) error

Validate validates this compliance diff rules items0

type CreateCustomRuleInput added in v0.3.0 

type CreateCustomRuleInput struct {

	// Description of the custom rule
	Description string `json:"description,omitempty"`

	// Human readable name of the custom rule
	Name string `json:"name,omitempty"`

	// Provider of the custom rule. Deprecated: please use "providers" instead.
	// Enum: [AWS AWS_GOVCLOUD AZURE GOOGLE]
	Provider string `json:"provider,omitempty"`

	// Providers for the custom rule.
	Providers []string `json:"providers"`

	// Resource type to which the custom rule applies
	ResourceType string `json:"resource_type,omitempty"`

	// The rego source code for the rule
	RuleText string `json:"rule_text,omitempty"`

	// Severity level of the custom rule.
	// Enum: [Informational Low Medium High Critical]
	Severity string `json:"severity,omitempty"`

	// The origin of this rule
	// Enum: [FUGUE CUSTOM]
	Source string `json:"source,omitempty"`
}

CreateCustomRuleInput Input request for creating a custom rule.

swagger:model CreateCustomRuleInput

func (*CreateCustomRuleInput) MarshalBinary added in v0.3.0 

func (m *CreateCustomRuleInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateCustomRuleInput) UnmarshalBinary added in v0.3.0 

func (m *CreateCustomRuleInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateCustomRuleInput) Validate added in v0.3.0 

func (m *CreateCustomRuleInput) Validate(formats strfmt.Registry) error

Validate validates this create custom rule input

type CreateEnvironmentInput 

type CreateEnvironmentInput struct {

	// List of compliance families validated against the environment.
	ComplianceFamilies []string `json:"compliance_families"`

	// Name of the environment.
	Name string `json:"name,omitempty"`

	// Name of the service provider for the environment.
	// Enum: [aws aws_govcloud azure google repository]
	Provider string `json:"provider,omitempty"`

	// A dictionary of options for the provider.
	ProviderOptions *ProviderOptions `json:"provider_options,omitempty"`

	// List of resource types to be remediated if remediation is enabled.
	RemediateResourceTypes []string `json:"remediate_resource_types"`

	// Time in seconds between the end of one scan to the start of the next. Must also set scan_schedule_enabled to true.
	// Minimum: 300
	ScanInterval *int64 `json:"scan_interval,omitempty"`

	// Indicates if the new environment should have scans run on a schedule upon creation.
	ScanScheduleEnabled *bool `json:"scan_schedule_enabled,omitempty"`

	// List of resource types to be surveyed.
	SurveyResourceTypes []string `json:"survey_resource_types"`
}

CreateEnvironmentInput Structure of the body for creating a new environment.

swagger:model CreateEnvironmentInput

func (*CreateEnvironmentInput) MarshalBinary 

func (m *CreateEnvironmentInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateEnvironmentInput) UnmarshalBinary 

func (m *CreateEnvironmentInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateEnvironmentInput) Validate 

func (m *CreateEnvironmentInput) Validate(formats strfmt.Registry) error

Validate validates this create environment input

type CreateFamilyInput added in v0.15.0 

type CreateFamilyInput struct {

	// If the family will automatically be enabled on all environments within the tenant
	AlwaysEnabled *bool `json:"always_enabled,omitempty"`

	// Description of the family
	Description string `json:"description,omitempty"`

	// Human readable name of the family
	Name string `json:"name,omitempty"`

	// If the family is recommended for all new environments
	Recommended *bool `json:"recommended,omitempty"`

	// List of rule ids to associate with family
	RuleIds []string `json:"rule_ids"`
}

CreateFamilyInput Input request for creating a family.

swagger:model CreateFamilyInput

func (*CreateFamilyInput) MarshalBinary added in v0.15.0 

func (m *CreateFamilyInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateFamilyInput) UnmarshalBinary added in v0.15.0 

func (m *CreateFamilyInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateFamilyInput) Validate added in v0.15.0 

func (m *CreateFamilyInput) Validate(formats strfmt.Registry) error

Validate validates this create family input

type CreateGroupInput added in v0.9.0 

type CreateGroupInput struct {

	// environment ids
	EnvironmentIds []string `json:"environment_ids"`

	// name
	Name string `json:"name,omitempty"`

	// policy
	// Enum: [fugue:READONLY fugue:AUDITOR fugue:EDITOR fugue:CONTRIBUTOR fugue:MANAGER fugue:ORGANIZATION_REPORT_VIEWER fugue:IAC_SCANNER]
	Policy string `json:"policy,omitempty"`
}

CreateGroupInput create group input

swagger:model CreateGroupInput

func (*CreateGroupInput) MarshalBinary added in v0.9.0 

func (m *CreateGroupInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateGroupInput) UnmarshalBinary added in v0.9.0 

func (m *CreateGroupInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateGroupInput) Validate added in v0.9.0 

func (m *CreateGroupInput) Validate(formats strfmt.Registry) error

Validate validates this create group input

type CreateInviteInput added in v0.9.0 

type CreateInviteInput struct {

	// email
	// Required: true
	Email *string `json:"email"`

	// expires
	Expires *bool `json:"expires,omitempty"`

	// group ids
	// Required: true
	GroupIds []string `json:"group_ids"`
}

CreateInviteInput create invite input

swagger:model CreateInviteInput

func (*CreateInviteInput) MarshalBinary added in v0.9.0 

func (m *CreateInviteInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateInviteInput) UnmarshalBinary added in v0.9.0 

func (m *CreateInviteInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateInviteInput) Validate added in v0.9.0 

func (m *CreateInviteInput) Validate(formats strfmt.Registry) error

Validate validates this create invite input

type CreateNotificationInput 

type CreateNotificationInput struct {

	// List of email address the notification is delivered to.
	Emails []string `json:"emails"`

	// List of environment ids the notification is attached to.
	Environments []string `json:"environments"`

	// List of events the notification is triggered on.
	Events []string `json:"events"`

	// Human readable name of the notification.
	Name string `json:"name,omitempty"`

	// AWS SNS topic arn the notification is delivered to.
	TopicArn string `json:"topic_arn,omitempty"`
}

CreateNotificationInput Request for creating a new notification.

swagger:model CreateNotificationInput

func (*CreateNotificationInput) MarshalBinary 

func (m *CreateNotificationInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateNotificationInput) UnmarshalBinary 

func (m *CreateNotificationInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateNotificationInput) Validate 

func (m *CreateNotificationInput) Validate(formats strfmt.Registry) error

Validate validates this create notification input

type CreatePolicyInput 

type CreatePolicyInput struct {

	// List of resource types to be able to remediate.
	RemediateResourceTypes []string `json:"remediate_resource_types"`

	// List of resource types to be able to survey.
	SurveyResourceTypes []string `json:"survey_resource_types"`
}

CreatePolicyInput List of resource types to be able to survey and remediate.

swagger:model CreatePolicyInput

func (*CreatePolicyInput) MarshalBinary 

func (m *CreatePolicyInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreatePolicyInput) UnmarshalBinary 

func (m *CreatePolicyInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreatePolicyInput) Validate 

func (m *CreatePolicyInput) Validate(formats strfmt.Registry) error

Validate validates this create policy input

type CreateRuleWaiverInput added in v0.11.0 

type CreateRuleWaiverInput struct {

	// comment
	Comment string `json:"comment,omitempty"`

	// environment id
	// Required: true
	EnvironmentID *string `json:"environment_id"`

	// Unix timestamp representation of the expiration date of this rule waiver.
	// Cannot be combined with `expires_at_duration` or `expires_at_ts`.
	//
	ExpiresAt int64 `json:"expires_at,omitempty"`

	// Duration object representation of the expiration date of this rule waiver.
	// Cannot be combined with `expires_at` or `expires_at_ts`.
	//
	ExpiresAtDuration *Duration `json:"expires_at_duration,omitempty"`

	// RFC3339 representation of the expiration date of this rule waiver.
	// Cannot be combined with `expires_at` or `expires_at_duration`.
	//
	ExpiresAtTs string `json:"expires_at_ts,omitempty"`

	// name
	// Required: true
	Name *string `json:"name"`

	// resource id
	// Required: true
	ResourceID *string `json:"resource_id"`

	// resource provider
	// Required: true
	ResourceProvider *string `json:"resource_provider"`

	// resource tag
	ResourceTag string `json:"resource_tag,omitempty"`

	// resource type
	// Required: true
	ResourceType *string `json:"resource_type"`

	// rule id
	// Required: true
	RuleID *string `json:"rule_id"`
}

CreateRuleWaiverInput Parameters for rule waiver creation.

swagger:model CreateRuleWaiverInput

func (*CreateRuleWaiverInput) MarshalBinary added in v0.11.0 

func (m *CreateRuleWaiverInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CreateRuleWaiverInput) UnmarshalBinary added in v0.11.0 

func (m *CreateRuleWaiverInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CreateRuleWaiverInput) Validate added in v0.11.0 

func (m *CreateRuleWaiverInput) Validate(formats strfmt.Registry) error

Validate validates this create rule waiver input

type CustomRule added in v0.3.0 

type CustomRule struct {

	// Compliance controls to which the custom rule belongs.
	ComplianceControls []string `json:"compliance_controls"`

	// The date and time the rule was created.
	CreatedAt int64 `json:"created_at,omitempty"`

	// Principal that created the rule.
	CreatedBy string `json:"created_by,omitempty"`

	// Display name of the user that created the rule
	CreatedByDisplayName string `json:"created_by_display_name,omitempty"`

	// Description of the custom rule.
	Description string `json:"description,omitempty"`

	// Families to which the custom rule belongs.
	Families []string `json:"families"`

	// ID of the custom rule.
	ID string `json:"id,omitempty"`

	// Human readable name of the custom rule.
	Name string `json:"name,omitempty"`

	// Provider of the custom rule. Deprecated: please use "providers" instead.
	// Enum: [AWS AWS_GOVCLOUD AZURE GOOGLE]
	Provider string `json:"provider,omitempty"`

	// Providers for the custom rule.
	Providers []string `json:"providers"`

	// Resource type to which the custom rule applies.
	ResourceType string `json:"resource_type,omitempty"`

	// The rego source code for the rule.
	RuleText string `json:"rule_text,omitempty"`

	// Severity level of the custom rule.
	// Enum: [Informational Low Medium High Critical]
	Severity string `json:"severity,omitempty"`

	// The origin of this rule.
	// Enum: [CUSTOM]
	Source string `json:"source,omitempty"`

	// The current status of the rule.
	// Enum: [ENABLED DISABLED INVALID]
	Status string `json:"status,omitempty"`

	// Terraform resource type corresponding to resource_type.
	TfResourceType string `json:"tf_resource_type,omitempty"`

	// The date and time the rule was last updated.
	UpdatedAt int64 `json:"updated_at,omitempty"`

	// Principal that last updated the rule.
	UpdatedBy string `json:"updated_by,omitempty"`

	// Display name of the user that last updated the rule
	UpdatedByDisplayName string `json:"updated_by_display_name,omitempty"`
}

CustomRule A custom rule

swagger:model CustomRule

func (*CustomRule) MarshalBinary added in v0.3.0 

func (m *CustomRule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomRule) UnmarshalBinary added in v0.3.0 

func (m *CustomRule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomRule) Validate added in v0.3.0 

func (m *CustomRule) Validate(formats strfmt.Registry) error

Validate validates this custom rule

type CustomRuleError added in v0.4.0 

type CustomRuleError struct {

	// Severity of the error.
	// Enum: [error warning]
	Severity string `json:"severity,omitempty"`

	// Text describing the error
	Text string `json:"text,omitempty"`
}

CustomRuleError An error for a custom rule

swagger:model CustomRuleError

func (*CustomRuleError) MarshalBinary added in v0.4.0 

func (m *CustomRuleError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomRuleError) UnmarshalBinary added in v0.4.0 

func (m *CustomRuleError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomRuleError) Validate added in v0.4.0 

func (m *CustomRuleError) Validate(formats strfmt.Registry) error

Validate validates this custom rule error

type CustomRuleWithErrors added in v0.4.0 

type CustomRuleWithErrors struct {
	CustomRule

	// Syntax errors in the rego source code.
	Errors []*CustomRuleError `json:"errors"`
}

CustomRuleWithErrors A custom rule and any associated syntax errors.

swagger:model CustomRuleWithErrors

func (*CustomRuleWithErrors) MarshalBinary added in v0.4.0 

func (m *CustomRuleWithErrors) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (CustomRuleWithErrors) MarshalJSON added in v0.4.0 

func (m CustomRuleWithErrors) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*CustomRuleWithErrors) UnmarshalBinary added in v0.4.0 

func (m *CustomRuleWithErrors) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomRuleWithErrors) UnmarshalJSON added in v0.4.0 

func (m *CustomRuleWithErrors) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*CustomRuleWithErrors) Validate added in v0.4.0 

func (m *CustomRuleWithErrors) Validate(formats strfmt.Registry) error

Validate validates this custom rule with errors

type CustomRules added in v0.3.0 

type CustomRules struct {

	// Total number of custom rules
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset
	IsTruncated bool `json:"is_truncated,omitempty"`

	// List of custom rules
	Items []*CustomRule `json:"items"`

	// Next offset to use to get the next page of items
	NextOffset int64 `json:"next_offset,omitempty"`
}

CustomRules Paginated list of custom rules

swagger:model CustomRules

func (*CustomRules) MarshalBinary added in v0.3.0 

func (m *CustomRules) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CustomRules) UnmarshalBinary added in v0.3.0 

func (m *CustomRules) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CustomRules) Validate added in v0.3.0 

func (m *CustomRules) Validate(formats strfmt.Registry) error

Validate validates this custom rules

type Duration added in v0.19.0 

type Duration struct {

	// days
	Days int64 `json:"days,omitempty"`

	// hours
	Hours int64 `json:"hours,omitempty"`

	// months
	Months int64 `json:"months,omitempty"`

	// weeks
	Weeks int64 `json:"weeks,omitempty"`

	// years
	Years int64 `json:"years,omitempty"`
}

Duration Defines a duration from the current time and date.

swagger:model Duration

func (*Duration) MarshalBinary added in v0.19.0 

func (m *Duration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Duration) UnmarshalBinary added in v0.19.0 

func (m *Duration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Duration) Validate added in v0.19.0 

func (m *Duration) Validate(formats strfmt.Registry) error

Validate validates this duration

type EditUsersGroupAssignmentsInput added in v0.9.0 

type EditUsersGroupAssignmentsInput struct {

	// group ids
	GroupIds []string `json:"group_ids"`

	// user ids
	UserIds []string `json:"user_ids"`
}

EditUsersGroupAssignmentsInput edit users group assignments input

swagger:model EditUsersGroupAssignmentsInput

func (*EditUsersGroupAssignmentsInput) MarshalBinary added in v0.9.0 

func (m *EditUsersGroupAssignmentsInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EditUsersGroupAssignmentsInput) UnmarshalBinary added in v0.9.0 

func (m *EditUsersGroupAssignmentsInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EditUsersGroupAssignmentsInput) Validate added in v0.9.0 

func (m *EditUsersGroupAssignmentsInput) Validate(formats strfmt.Registry) error

Validate validates this edit users group assignments input

type Environment 

type Environment struct {

	// Scan ID of the baseline if baseline is enabled.
	BaselineID string `json:"baseline_id,omitempty"`

	// List of compliance families validated against the environment.
	ComplianceFamilies []string `json:"compliance_families"`

	// Indicates whether drift detection is enabled for the environment.
	Drift bool `json:"drift,omitempty"`

	// ID of the environment.
	ID string `json:"id,omitempty"`

	// Time the current or most recently completed scan for the environment started.
	LastScanAt int64 `json:"last_scan_at,omitempty"`

	// Name of the environment.
	Name string `json:"name,omitempty"`

	// Time the next scan will start.
	NextScanAt int64 `json:"next_scan_at,omitempty"`

	// Name of the service provider for the environment.
	// Enum: [aws aws_govcloud azure google repository]
	Provider string `json:"provider,omitempty"`

	// provider options
	ProviderOptions *ProviderOptions `json:"provider_options,omitempty"`

	// List of resource types remediated for the environment if remediation is enabled.
	RemediateResourceTypes []string `json:"remediate_resource_types"`

	// Indicates whether remediation is enabled for the environment.
	Remediation bool `json:"remediation,omitempty"`

	// Time in seconds between the end of one scan to the start of the next.
	ScanInterval int64 `json:"scan_interval,omitempty"`

	// Indicates whether the environment should have scans run on a schedule.
	ScanScheduleEnabled bool `json:"scan_schedule_enabled,omitempty"`

	// Status of the current or most recently completed scan for the environment.
	// Enum: [CREATED QUEUED IN_PROGRESS ERROR SUCCESS CANCELED]
	ScanStatus string `json:"scan_status,omitempty"`

	// List of resource types surveyed for the environment.
	SurveyResourceTypes []string `json:"survey_resource_types"`

	// ID of the tenant that owns the environment.
	TenantID string `json:"tenant_id,omitempty"`
}

Environment A managed environment.

swagger:model Environment

func (*Environment) MarshalBinary 

func (m *Environment) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Environment) UnmarshalBinary 

func (m *Environment) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Environment) Validate 

func (m *Environment) Validate(formats strfmt.Registry) error

Validate validates this environment

type EnvironmentRules added in v0.17.0 

type EnvironmentRules struct {

	// items
	// Required: true
	Items []*EnvironmentRulesRule `json:"items"`
}

EnvironmentRules List of rules active for an environment.

swagger:model EnvironmentRules

func (*EnvironmentRules) MarshalBinary added in v0.17.0 

func (m *EnvironmentRules) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EnvironmentRules) UnmarshalBinary added in v0.17.0 

func (m *EnvironmentRules) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EnvironmentRules) Validate added in v0.17.0 

func (m *EnvironmentRules) Validate(formats strfmt.Registry) error

Validate validates this environment rules

type EnvironmentRulesRule added in v0.17.0 

type EnvironmentRulesRule struct {

	// id
	// Required: true
	ID *string `json:"id"`
}

EnvironmentRulesRule environment rules rule

swagger:model EnvironmentRulesRule

func (*EnvironmentRulesRule) MarshalBinary added in v0.17.0 

func (m *EnvironmentRulesRule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EnvironmentRulesRule) UnmarshalBinary added in v0.17.0 

func (m *EnvironmentRulesRule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EnvironmentRulesRule) Validate added in v0.17.0 

func (m *EnvironmentRulesRule) Validate(formats strfmt.Registry) error

Validate validates this environment rules rule

type EnvironmentWithSummary 

type EnvironmentWithSummary struct {
	Environment

	// resource summary
	ResourceSummary *ResourceSummary `json:"resource_summary,omitempty"`
}

EnvironmentWithSummary A managed environment with its latest scan summary.

swagger:model EnvironmentWithSummary

func (*EnvironmentWithSummary) MarshalBinary 

func (m *EnvironmentWithSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (EnvironmentWithSummary) MarshalJSON 

func (m EnvironmentWithSummary) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*EnvironmentWithSummary) UnmarshalBinary 

func (m *EnvironmentWithSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EnvironmentWithSummary) UnmarshalJSON 

func (m *EnvironmentWithSummary) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*EnvironmentWithSummary) Validate 

func (m *EnvironmentWithSummary) Validate(formats strfmt.Registry) error

Validate validates this environment with summary

type Environments 

type Environments struct {

	// Total number of items.
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// Paginated list of environments.
	Items []*Environment `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

Environments Paginated list of environments.

swagger:model Environments

func (*Environments) MarshalBinary 

func (m *Environments) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Environments) UnmarshalBinary 

func (m *Environments) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Environments) Validate 

func (m *Environments) Validate(formats strfmt.Registry) error

Validate validates this environments

type Event 

type Event struct {

	// Difference between the old and new compliance state of the resource.
	ComplianceDiff *ComplianceDiff `json:"compliance_diff,omitempty"`

	// Time the event occurred.
	CreatedAt int64 `json:"created_at,omitempty"`

	// Error message.
	Error string `json:"error,omitempty"`

	// Type of event - drift, remediation, or compliance.
	// Enum: [DRIFT REMEDIATION COMPLIANCE]
	EventType string `json:"event_type,omitempty"`

	// ID of event
	ID string `json:"id,omitempty"`

	// Difference between the old and new state of the resource.
	ResourceDiff *ResourceDiff `json:"resource_diff,omitempty"`
}

Event A drift, remediation or compliance event.

swagger:model Event

func (*Event) MarshalBinary 

func (m *Event) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Event) UnmarshalBinary 

func (m *Event) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Event) Validate 

func (m *Event) Validate(formats strfmt.Registry) error

Validate validates this event

type Events 

type Events struct {

	// Total number of items. DEPRECATED: This property no longer returns accurate counts when filters are applied and will be removed in future API versions
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// Paginated list of events.
	Items []*Event `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

Events Paginated list of drift, remediation, and compliance events.

swagger:model Events

func (*Events) MarshalBinary 

func (m *Events) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Events) UnmarshalBinary 

func (m *Events) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Events) Validate 

func (m *Events) Validate(formats strfmt.Registry) error

Validate validates this events

type Families added in v0.15.0 

type Families struct {

	// count
	Count int64 `json:"count,omitempty"`

	// is truncated
	IsTruncated bool `json:"is_truncated,omitempty"`

	// items
	Items []*Family `json:"items"`

	// next offset
	NextOffset int64 `json:"next_offset,omitempty"`
}

Families families

swagger:model Families

func (*Families) MarshalBinary added in v0.15.0 

func (m *Families) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Families) UnmarshalBinary added in v0.15.0 

func (m *Families) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Families) Validate added in v0.15.0 

func (m *Families) Validate(formats strfmt.Registry) error

Validate validates this families

type FamiliesFilterOutput added in v0.15.0 

type FamiliesFilterOutput struct {

	// provider
	Provider *FamiliesFilterOutputProvider `json:"provider,omitempty"`

	// source
	Source *FamiliesFilterOutputSource `json:"source,omitempty"`
}

FamiliesFilterOutput Filters for families table

swagger:model FamiliesFilterOutput

func (*FamiliesFilterOutput) MarshalBinary added in v0.15.0 

func (m *FamiliesFilterOutput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FamiliesFilterOutput) UnmarshalBinary added in v0.15.0 

func (m *FamiliesFilterOutput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FamiliesFilterOutput) Validate added in v0.15.0 

func (m *FamiliesFilterOutput) Validate(formats strfmt.Registry) error

Validate validates this families filter output

type FamiliesFilterOutputProvider added in v0.15.0 

type FamiliesFilterOutputProvider struct {

	// aws
	Aws int64 `json:"aws,omitempty"`

	// azure
	Azure int64 `json:"azure,omitempty"`

	// google
	Google int64 `json:"google,omitempty"`

	// govcloud
	Govcloud int64 `json:"govcloud,omitempty"`
}

FamiliesFilterOutputProvider families filter output provider

swagger:model FamiliesFilterOutputProvider

func (*FamiliesFilterOutputProvider) MarshalBinary added in v0.15.0 

func (m *FamiliesFilterOutputProvider) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FamiliesFilterOutputProvider) UnmarshalBinary added in v0.15.0 

func (m *FamiliesFilterOutputProvider) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FamiliesFilterOutputProvider) Validate added in v0.15.0 

func (m *FamiliesFilterOutputProvider) Validate(formats strfmt.Registry) error

Validate validates this families filter output provider

type FamiliesFilterOutputSource added in v0.15.0 

type FamiliesFilterOutputSource struct {

	// custom
	Custom int64 `json:"custom,omitempty"`

	// fugue
	Fugue int64 `json:"fugue,omitempty"`
}

FamiliesFilterOutputSource families filter output source

swagger:model FamiliesFilterOutputSource

func (*FamiliesFilterOutputSource) MarshalBinary added in v0.15.0 

func (m *FamiliesFilterOutputSource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FamiliesFilterOutputSource) UnmarshalBinary added in v0.15.0 

func (m *FamiliesFilterOutputSource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FamiliesFilterOutputSource) Validate added in v0.15.0 

func (m *FamiliesFilterOutputSource) Validate(formats strfmt.Registry) error

Validate validates this families filter output source

type Family added in v0.15.0 

type Family struct {

	// If the family will automatically be enabled on all environments within the tenant
	AlwaysEnabled bool `json:"always_enabled,omitempty"`

	// The date and time the rule was created.
	CreatedAt int64 `json:"created_at,omitempty"`

	// Principal that created the rule.
	CreatedBy string `json:"created_by,omitempty"`

	// Display name of the user that created the rule
	CreatedByDisplayName string `json:"created_by_display_name,omitempty"`

	// Description of the family
	Description string `json:"description,omitempty"`

	// ID of the family
	ID string `json:"id,omitempty"`

	// Human readable name of the family
	Name string `json:"name,omitempty"`

	// Provider the families applies to
	Providers []string `json:"providers"`

	// If the family is recommended for all new environments
	Recommended bool `json:"recommended,omitempty"`

	// The origin of this family
	// Enum: [FUGUE CUSTOM]
	Source string `json:"source,omitempty"`

	// ID of the tenant
	TenantID string `json:"tenant_id,omitempty"`

	// The date and time the rule was last updated.
	UpdatedAt int64 `json:"updated_at,omitempty"`

	// Principal that last updated the rule.
	UpdatedBy string `json:"updated_by,omitempty"`

	// Display name of the user that last updated the rule
	UpdatedByDisplayName string `json:"updated_by_display_name,omitempty"`
}

Family A family

swagger:model Family

func (*Family) MarshalBinary added in v0.15.0 

func (m *Family) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Family) UnmarshalBinary added in v0.15.0 

func (m *Family) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Family) Validate added in v0.15.0 

func (m *Family) Validate(formats strfmt.Registry) error

Validate validates this family

type FamilyWithRules added in v0.15.0 

type FamilyWithRules struct {

	// If the family will automatically be enabled on all environments within the tenant
	AlwaysEnabled bool `json:"always_enabled,omitempty"`

	// The date and time the rule was created.
	CreatedAt int64 `json:"created_at,omitempty"`

	// Principal that created the rule.
	CreatedBy string `json:"created_by,omitempty"`

	// Display name of the user that created the rule
	CreatedByDisplayName string `json:"created_by_display_name,omitempty"`

	// Description of the family
	Description string `json:"description,omitempty"`

	// ID of the family
	ID string `json:"id,omitempty"`

	// Human readable name of the family
	Name string `json:"name,omitempty"`

	// Provider the families applies to
	Providers []string `json:"providers"`

	// If the family is recommended for all new environments
	Recommended bool `json:"recommended,omitempty"`

	// List of rule ids associated with family
	RuleIds []string `json:"rule_ids"`

	// The origin of this family
	// Enum: [FUGUE CUSTOM]
	Source string `json:"source,omitempty"`

	// ID of the tenant
	TenantID string `json:"tenant_id,omitempty"`

	// The date and time the rule was last updated.
	UpdatedAt int64 `json:"updated_at,omitempty"`

	// Principal that last updated the rule.
	UpdatedBy string `json:"updated_by,omitempty"`

	// Display name of the user that last updated the rule
	UpdatedByDisplayName string `json:"updated_by_display_name,omitempty"`
}

FamilyWithRules A family with rule IDs

swagger:model FamilyWithRules

func (*FamilyWithRules) MarshalBinary added in v0.15.0 

func (m *FamilyWithRules) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FamilyWithRules) UnmarshalBinary added in v0.15.0 

func (m *FamilyWithRules) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FamilyWithRules) Validate added in v0.15.0 

func (m *FamilyWithRules) Validate(formats strfmt.Registry) error

Validate validates this family with rules

type Group added in v0.9.0 

type Group struct {

	// Map from api_client_id to name.
	APIClients map[string]string `json:"api_clients,omitempty"`

	// Map from environment id to name.
	Environments map[string]string `json:"environments,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// name
	Name string `json:"name,omitempty"`

	// policy
	Policy string `json:"policy,omitempty"`

	// Map from user_id to name.
	Users map[string]string `json:"users,omitempty"`
}

Group group

swagger:model Group

func (*Group) MarshalBinary added in v0.9.0 

func (m *Group) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Group) UnmarshalBinary added in v0.9.0 

func (m *Group) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Group) Validate added in v0.9.0 

func (m *Group) Validate(formats strfmt.Registry) error

Validate validates this group

type Groups added in v0.9.0 

type Groups struct {

	// count
	Count int64 `json:"count,omitempty"`

	// is truncated
	IsTruncated bool `json:"is_truncated,omitempty"`

	// items
	Items []*Group `json:"items"`

	// next offset
	NextOffset int64 `json:"next_offset,omitempty"`
}

Groups groups

swagger:model Groups

func (*Groups) MarshalBinary added in v0.9.0 

func (m *Groups) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Groups) UnmarshalBinary added in v0.9.0 

func (m *Groups) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Groups) Validate added in v0.9.0 

func (m *Groups) Validate(formats strfmt.Registry) error

Validate validates this groups

type InternalServerError 

type InternalServerError struct {

	// HTTP status code for the error.
	Code int64 `json:"code,omitempty"`

	// Detailed human-readable message about the internal server error.
	Message string `json:"message,omitempty"`

	// Type of internal server error.
	// Enum: [InternalServerError DatabaseError]
	Type string `json:"type,omitempty"`
}

InternalServerError Error returned when the API request results in an internal server error.

swagger:model InternalServerError

func (*InternalServerError) MarshalBinary 

func (m *InternalServerError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*InternalServerError) UnmarshalBinary 

func (m *InternalServerError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*InternalServerError) Validate 

func (m *InternalServerError) Validate(formats strfmt.Registry) error

Validate validates this internal server error

type Invite added in v0.9.0 

type Invite struct {

	// created at
	// Required: true
	CreatedAt *int64 `json:"created_at"`

	// email
	// Required: true
	Email *string `json:"email"`

	// expires at
	// Required: true
	ExpiresAt *int64 `json:"expires_at"`

	// Map from group id to name.
	Groups map[string]string `json:"groups,omitempty"`

	// id
	// Required: true
	ID *string `json:"id"`

	// resource type
	ResourceType string `json:"resource_type,omitempty"`

	// status
	// Required: true
	Status *string `json:"status"`

	// updated at
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

Invite invite

swagger:model Invite

func (*Invite) MarshalBinary added in v0.9.0 

func (m *Invite) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Invite) UnmarshalBinary added in v0.9.0 

func (m *Invite) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Invite) Validate added in v0.9.0 

func (m *Invite) Validate(formats strfmt.Registry) error

Validate validates this invite

type Invites added in v0.9.0 

type Invites struct {

	// Total number of items.
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// Paginated list of invites.
	Items []*Invite `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

Invites Paginated list of invites.

swagger:model Invites

func (*Invites) MarshalBinary added in v0.9.0 

func (m *Invites) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Invites) UnmarshalBinary added in v0.9.0 

func (m *Invites) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Invites) Validate added in v0.9.0 

func (m *Invites) Validate(formats strfmt.Registry) error

Validate validates this invites

type NonCompliantResource 

type NonCompliantResource struct {

	// List of rules and messages the resource violates.
	FailedRules []*NonCompliantResourceFailedRulesItems0 `json:"failed_rules"`

	// ID of the failing resource.
	ResourceID string `json:"resource_id,omitempty"`
}

NonCompliantResource Describes the rules violated by a resource.

swagger:model NonCompliantResource

func (*NonCompliantResource) MarshalBinary 

func (m *NonCompliantResource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NonCompliantResource) UnmarshalBinary 

func (m *NonCompliantResource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NonCompliantResource) Validate 

func (m *NonCompliantResource) Validate(formats strfmt.Registry) error

Validate validates this non compliant resource

type NonCompliantResourceFailedRulesItems0 

type NonCompliantResourceFailedRulesItems0 struct {

	// Compliance family the violated rule belongs to.
	Family string `json:"family,omitempty"`

	// Reasons the resource was found in violation of a rule.
	Messages []string `json:"messages"`

	// ID of the violated rule.
	Rule string `json:"rule,omitempty"`
}

NonCompliantResourceFailedRulesItems0 non compliant resource failed rules items0

swagger:model NonCompliantResourceFailedRulesItems0

func (*NonCompliantResourceFailedRulesItems0) MarshalBinary 

func (m *NonCompliantResourceFailedRulesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NonCompliantResourceFailedRulesItems0) UnmarshalBinary 

func (m *NonCompliantResourceFailedRulesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NonCompliantResourceFailedRulesItems0) Validate 

func (m *NonCompliantResourceFailedRulesItems0) Validate(formats strfmt.Registry) error

Validate validates this non compliant resource failed rules items0

type NotFoundError 

type NotFoundError struct {

	// HTTP status code for the error.
	Code int64 `json:"code,omitempty"`

	// Detailed human-readable message about the not found error.
	Message string `json:"message,omitempty"`

	// Type of not found error.
	// Enum: [NotFound]
	Type string `json:"type,omitempty"`
}

NotFoundError Error returned when the API request references a non-existent resource.

swagger:model NotFoundError

func (*NotFoundError) MarshalBinary 

func (m *NotFoundError) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*NotFoundError) UnmarshalBinary 

func (m *NotFoundError) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*NotFoundError) Validate 

func (m *NotFoundError) Validate(formats strfmt.Registry) error

Validate validates this not found error

type NotModifiedResponse added in v0.19.0 

type NotModifiedResponse string

NotModifiedResponse Empty string returned when requested content is not modified.

swagger:model NotModifiedResponse

func (NotModifiedResponse) Validate added in v0.19.0 

func (m NotModifiedResponse) Validate(formats strfmt.Registry) error

Validate validates this not modified response

type Notification 

type Notification struct {

	// The date and time the notification was created.
	CreatedAt int64 `json:"created_at,omitempty"`

	// Principal the created the notification.
	CreatedBy string `json:"created_by,omitempty"`

	// List of email address the notification is delivered to.
	Emails []string `json:"emails"`

	// List of maps from environment id to name the notification is attached to.
	Environments []map[string]string `json:"environments"`

	// List of events the notification is triggered on.
	Events []string `json:"events"`

	// Last error recorded while processing notification. If the last notification processed had no error this field will be empty.
	LastError string `json:"last_error,omitempty"`

	// Human readable name of the notification.
	Name string `json:"name,omitempty"`

	// ID of the notification.
	NotificationID string `json:"notification_id,omitempty"`

	// AWS SNS topic arn the notification is delivered to.
	TopicArn string `json:"topic_arn,omitempty"`

	// AWS The date and time the notification was last updated.
	UpdatedAt int64 `json:"updated_at,omitempty"`

	// Principal that last updated the notification.
	UpdatedBy string `json:"updated_by,omitempty"`
}

Notification Describes configuration of a notification.

swagger:model Notification

func (*Notification) MarshalBinary 

func (m *Notification) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Notification) UnmarshalBinary 

func (m *Notification) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Notification) Validate 

func (m *Notification) Validate(formats strfmt.Registry) error

Validate validates this notification

type Notifications 

type Notifications struct {

	// Count of all found notifications.
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// List of notification configurations.
	Items []*Notification `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

Notifications Paginiated result of notification lists.

swagger:model Notifications

func (*Notifications) MarshalBinary 

func (m *Notifications) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Notifications) UnmarshalBinary 

func (m *Notifications) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Notifications) Validate 

func (m *Notifications) Validate(formats strfmt.Registry) error

Validate validates this notifications

type Permissions 

type Permissions struct {

	// aws
	Aws *PermissionsAws `json:"aws,omitempty"`
}

Permissions Permissions for surveying and remediating the specified resource types.

swagger:model Permissions

func (*Permissions) MarshalBinary 

func (m *Permissions) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Permissions) UnmarshalBinary 

func (m *Permissions) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Permissions) Validate 

func (m *Permissions) Validate(formats strfmt.Registry) error

Validate validates this permissions

type PermissionsAws 

type PermissionsAws struct {

	// JSON policy for surveying and remediating the desired resource types.
	Policy interface{} `json:"policy,omitempty"`

	// JSON trust relationship for IAM role
	TrustRelationship interface{} `json:"trust_relationship,omitempty"`
}

PermissionsAws IAM policy required for surveying and remediating the desired resource types.

swagger:model PermissionsAws

func (*PermissionsAws) MarshalBinary 

func (m *PermissionsAws) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PermissionsAws) UnmarshalBinary 

func (m *PermissionsAws) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PermissionsAws) Validate 

func (m *PermissionsAws) Validate(formats strfmt.Registry) error

Validate validates this permissions aws

type ProviderOptions 

type ProviderOptions struct {

	// aws
	Aws *ProviderOptionsAws `json:"aws,omitempty"`

	// aws govcloud
	AwsGovcloud *ProviderOptionsAws `json:"aws_govcloud,omitempty"`

	// azure
	Azure *ProviderOptionsAzure `json:"azure,omitempty"`

	// google
	Google *ProviderOptionsGoogle `json:"google,omitempty"`

	// repository
	Repository *ProviderOptionsRepository `json:"repository,omitempty"`
}

ProviderOptions Provider options.

swagger:model ProviderOptions

func (*ProviderOptions) MarshalBinary 

func (m *ProviderOptions) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptions) UnmarshalBinary 

func (m *ProviderOptions) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptions) Validate 

func (m *ProviderOptions) Validate(formats strfmt.Registry) error

Validate validates this provider options

type ProviderOptionsAws 

type ProviderOptionsAws struct {

	// The AWS region to scan and remediate infrastructure in.
	Region string `json:"region,omitempty"`

	// The AWS regions to scan and remediate infrastructure in.
	Regions []string `json:"regions"`

	// AWS IAM Role ARN that will be assumed to scan and remediate infrastructure.
	RoleArn string `json:"role_arn,omitempty"`
}

ProviderOptionsAws Provider options for AWS.

swagger:model ProviderOptionsAws

func (*ProviderOptionsAws) MarshalBinary 

func (m *ProviderOptionsAws) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsAws) UnmarshalBinary 

func (m *ProviderOptionsAws) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsAws) Validate 

func (m *ProviderOptionsAws) Validate(formats strfmt.Registry) error

Validate validates this provider options aws

type ProviderOptionsAwsUpdateInput 

type ProviderOptionsAwsUpdateInput struct {

	// The AWS regions to scan and remediate infrastructure in.
	Regions []string `json:"regions"`

	// AWS IAM Role ARN that will be assumed to scan and remediate infrastructure.
	RoleArn string `json:"role_arn,omitempty"`
}

ProviderOptionsAwsUpdateInput Mutable provider options for AWS.

swagger:model ProviderOptionsAwsUpdateInput

func (*ProviderOptionsAwsUpdateInput) MarshalBinary 

func (m *ProviderOptionsAwsUpdateInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsAwsUpdateInput) UnmarshalBinary 

func (m *ProviderOptionsAwsUpdateInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsAwsUpdateInput) Validate 

func (m *ProviderOptionsAwsUpdateInput) Validate(formats strfmt.Registry) error

Validate validates this provider options aws update input

type ProviderOptionsAzure 

type ProviderOptionsAzure struct {

	// The application ID/client ID of the service principal to be used
	ApplicationID string `json:"application_id,omitempty"`

	// The client secret of the service principal to be used
	ClientSecret string `json:"client_secret,omitempty"`

	// The resource groups to be remediated
	RemediateResourceGroups []string `json:"remediate_resource_groups"`

	// The subscription ID of the Azure subscription to be used
	SubscriptionID string `json:"subscription_id,omitempty"`

	// The resource groups to be surveyed
	SurveyResourceGroups []string `json:"survey_resource_groups"`

	// The tenant ID of the Azure subscription to be used
	TenantID string `json:"tenant_id,omitempty"`
}

ProviderOptionsAzure Provider options for Azure.

swagger:model ProviderOptionsAzure

func (*ProviderOptionsAzure) MarshalBinary 

func (m *ProviderOptionsAzure) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsAzure) UnmarshalBinary 

func (m *ProviderOptionsAzure) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsAzure) Validate 

func (m *ProviderOptionsAzure) Validate(formats strfmt.Registry) error

Validate validates this provider options azure

type ProviderOptionsAzureUpdateInput 

type ProviderOptionsAzureUpdateInput struct {

	// The application ID/client ID of the service principal to be used
	ApplicationID string `json:"application_id,omitempty"`

	// The client secret of the service principal to be used
	ClientSecret string `json:"client_secret,omitempty"`

	// The resource groups to be remediated
	RemediateResourceGroups []string `json:"remediate_resource_groups"`

	// The resource groups to be surveyed
	SurveyResourceGroups []string `json:"survey_resource_groups"`
}

ProviderOptionsAzureUpdateInput Mutable provider options for Azure.

swagger:model ProviderOptionsAzureUpdateInput

func (*ProviderOptionsAzureUpdateInput) MarshalBinary 

func (m *ProviderOptionsAzureUpdateInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsAzureUpdateInput) UnmarshalBinary 

func (m *ProviderOptionsAzureUpdateInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsAzureUpdateInput) Validate 

func (m *ProviderOptionsAzureUpdateInput) Validate(formats strfmt.Registry) error

Validate validates this provider options azure update input

type ProviderOptionsGoogle added in v0.11.0 

type ProviderOptionsGoogle struct {

	// project id
	ProjectID string `json:"project_id,omitempty"`

	// service account email
	ServiceAccountEmail string `json:"service_account_email,omitempty"`
}

ProviderOptionsGoogle Provider options for Google.

swagger:model ProviderOptionsGoogle

func (*ProviderOptionsGoogle) MarshalBinary added in v0.11.0 

func (m *ProviderOptionsGoogle) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsGoogle) UnmarshalBinary added in v0.11.0 

func (m *ProviderOptionsGoogle) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsGoogle) Validate added in v0.11.0 

func (m *ProviderOptionsGoogle) Validate(formats strfmt.Registry) error

Validate validates this provider options google

type ProviderOptionsGoogleUpdateInput added in v0.13.0 

type ProviderOptionsGoogleUpdateInput struct {

	// The service account email that will be used to scan infrastructure.
	ServiceAccountEmail string `json:"service_account_email,omitempty"`
}

ProviderOptionsGoogleUpdateInput Mutable provider options for Google.

swagger:model ProviderOptionsGoogleUpdateInput

func (*ProviderOptionsGoogleUpdateInput) MarshalBinary added in v0.13.0 

func (m *ProviderOptionsGoogleUpdateInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsGoogleUpdateInput) UnmarshalBinary added in v0.13.0 

func (m *ProviderOptionsGoogleUpdateInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsGoogleUpdateInput) Validate added in v0.13.0 

func (m *ProviderOptionsGoogleUpdateInput) Validate(formats strfmt.Registry) error

Validate validates this provider options google update input

type ProviderOptionsRepository added in v0.17.0 

type ProviderOptionsRepository struct {

	// The branch associated with this environment (e.g. 'main')
	Branch string `json:"branch,omitempty"`

	// The URL of the repository (e.g. 'https://github.com/fugue/regula.git')
	URL string `json:"url,omitempty"`
}

ProviderOptionsRepository Provider options for repository environments.

swagger:model ProviderOptionsRepository

func (*ProviderOptionsRepository) MarshalBinary added in v0.17.0 

func (m *ProviderOptionsRepository) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsRepository) UnmarshalBinary added in v0.17.0 

func (m *ProviderOptionsRepository) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsRepository) Validate added in v0.17.0 

func (m *ProviderOptionsRepository) Validate(formats strfmt.Registry) error

Validate validates this provider options repository

type ProviderOptionsRepositoryUpdateInput added in v0.17.0 

type ProviderOptionsRepositoryUpdateInput struct {

	// The branch associated with this environment (e.g. 'main')
	Branch string `json:"branch,omitempty"`

	// The URL of the repository (e.g. 'https://github.com/fugue/regula.git')
	URL string `json:"url,omitempty"`
}

ProviderOptionsRepositoryUpdateInput Mutable provider options for repository environments.

swagger:model ProviderOptionsRepositoryUpdateInput

func (*ProviderOptionsRepositoryUpdateInput) MarshalBinary added in v0.17.0 

func (m *ProviderOptionsRepositoryUpdateInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsRepositoryUpdateInput) UnmarshalBinary added in v0.17.0 

func (m *ProviderOptionsRepositoryUpdateInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsRepositoryUpdateInput) Validate added in v0.17.0 

func (m *ProviderOptionsRepositoryUpdateInput) Validate(formats strfmt.Registry) error

Validate validates this provider options repository update input

type ProviderOptionsUpdateInput 

type ProviderOptionsUpdateInput struct {

	// aws
	Aws *ProviderOptionsAwsUpdateInput `json:"aws,omitempty"`

	// aws govcloud
	AwsGovcloud *ProviderOptionsAwsUpdateInput `json:"aws_govcloud,omitempty"`

	// azure
	Azure *ProviderOptionsAzureUpdateInput `json:"azure,omitempty"`

	// google
	Google *ProviderOptionsGoogleUpdateInput `json:"google,omitempty"`

	// repository
	Repository *ProviderOptionsRepositoryUpdateInput `json:"repository,omitempty"`
}

ProviderOptionsUpdateInput Mutable provider options.

swagger:model ProviderOptionsUpdateInput

func (*ProviderOptionsUpdateInput) MarshalBinary 

func (m *ProviderOptionsUpdateInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ProviderOptionsUpdateInput) UnmarshalBinary 

func (m *ProviderOptionsUpdateInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ProviderOptionsUpdateInput) Validate 

func (m *ProviderOptionsUpdateInput) Validate(formats strfmt.Registry) error

Validate validates this provider options update input

type Resource 

type Resource struct {

	// Resource ID.
	ResourceID string `json:"resource_id,omitempty"`

	// Resource type.
	ResourceType string `json:"resource_type,omitempty"`
}

Resource A resource.

swagger:model Resource

func (*Resource) MarshalBinary 

func (m *Resource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Resource) UnmarshalBinary 

func (m *Resource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Resource) Validate 

func (m *Resource) Validate(formats strfmt.Registry) error

Validate validates this resource

type ResourceDiff 

type ResourceDiff struct {

	// Description of the changes to the resource's attributes.
	Attributes []*Attribute `json:"attributes"`

	// Type of change which occurred.
	// Enum: [ADDED MODIFIED REMOVED]
	Change string `json:"change,omitempty"`

	// ID of the resource given by the provider.
	ResourceID string `json:"resource_id,omitempty"`

	// Resource type.
	ResourceType string `json:"resource_type,omitempty"`
}

ResourceDiff Difference between the old and new state of a resource after an event.

swagger:model ResourceDiff

func (*ResourceDiff) MarshalBinary 

func (m *ResourceDiff) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceDiff) UnmarshalBinary 

func (m *ResourceDiff) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceDiff) Validate 

func (m *ResourceDiff) Validate(formats strfmt.Registry) error

Validate validates this resource diff

type ResourceSummary 

type ResourceSummary struct {

	// Number of compliant resources.
	Compliant int64 `json:"compliant,omitempty"`

	// Compliance summary for the compliance families run against resources for the scan.
	Families []*ResourceSummaryFamiliesItems0 `json:"families"`

	// Number of noncompliant resources.
	Noncompliant int64 `json:"noncompliant,omitempty"`

	// Number of resource types in the scan.
	ResourceTypes int64 `json:"resource_types,omitempty"`

	// Number of compliance rules failed.
	RulesFailed int64 `json:"rules_failed,omitempty"`

	// Number of compliance rules passed.
	RulesPassed int64 `json:"rules_passed,omitempty"`

	// Total number of resources in the scan.
	Total int64 `json:"total,omitempty"`
}

ResourceSummary Summary of resources for a scan.

swagger:model ResourceSummary

func (*ResourceSummary) MarshalBinary 

func (m *ResourceSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceSummary) UnmarshalBinary 

func (m *ResourceSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceSummary) Validate 

func (m *ResourceSummary) Validate(formats strfmt.Registry) error

Validate validates this resource summary

type ResourceSummaryFamiliesItems0 

type ResourceSummaryFamiliesItems0 struct {

	// Number of compliant resources in this family.
	Compliant int64 `json:"compliant,omitempty"`

	// Name of the compliance family.
	Family string `json:"family,omitempty"`

	// Number of noncompliant resources in this family.
	Noncompliant int64 `json:"noncompliant,omitempty"`

	// Number of compliance rules failed in this family.
	RulesFailed int64 `json:"rules_failed,omitempty"`

	// Number of compliance rules passed in this family.
	RulesPassed int64 `json:"rules_passed,omitempty"`
}

ResourceSummaryFamiliesItems0 Compliance summary for the compliance family run against resources for the scan.

swagger:model ResourceSummaryFamiliesItems0

func (*ResourceSummaryFamiliesItems0) MarshalBinary 

func (m *ResourceSummaryFamiliesItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceSummaryFamiliesItems0) UnmarshalBinary 

func (m *ResourceSummaryFamiliesItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceSummaryFamiliesItems0) Validate 

func (m *ResourceSummaryFamiliesItems0) Validate(formats strfmt.Registry) error

Validate validates this resource summary families items0

type ResourceTypeMetadata 

type ResourceTypeMetadata struct {

	// List of Fugue recommended resource types.
	RecommendedTypes []string `json:"recommended_types"`

	// List of resource types supported by Fugue.
	ResourceTypes []string `json:"resource_types"`
}

ResourceTypeMetadata List of resource types supported by Fugue.

swagger:model ResourceTypeMetadata

func (*ResourceTypeMetadata) MarshalBinary 

func (m *ResourceTypeMetadata) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceTypeMetadata) UnmarshalBinary 

func (m *ResourceTypeMetadata) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceTypeMetadata) Validate 

func (m *ResourceTypeMetadata) Validate(formats strfmt.Registry) error

Validate validates this resource type metadata

type RuleWaiver added in v0.11.0 

type RuleWaiver struct {

	// comment
	Comment string `json:"comment,omitempty"`

	// The date and time when the rule waiver was created.
	CreatedAt int64 `json:"created_at,omitempty"`

	// Principal that created the rule waiver.
	CreatedBy string `json:"created_by,omitempty"`

	// Display name of the user that created the rule waiver.
	CreatedByDisplayName string `json:"created_by_display_name,omitempty"`

	// environment id
	// Required: true
	EnvironmentID *string `json:"environment_id"`

	// environment name
	EnvironmentName string `json:"environment_name,omitempty"`

	// The date and time when this rule waiver expires.
	ExpiresAt int64 `json:"expires_at,omitempty"`

	// id
	// Required: true
	ID *string `json:"id"`

	// name
	// Required: true
	Name *string `json:"name"`

	// resource id
	// Required: true
	ResourceID *string `json:"resource_id"`

	// resource provider
	// Required: true
	ResourceProvider *string `json:"resource_provider"`

	// resource tag
	ResourceTag string `json:"resource_tag,omitempty"`

	// resource type
	// Required: true
	ResourceType *string `json:"resource_type"`

	// Mapping of this rule in compliance families and their controls which are enabled in a given environment.
	RuleComplianceMapping interface{} `json:"rule_compliance_mapping,omitempty"`

	// Description of the rule.
	RuleDescription string `json:"rule_description,omitempty"`

	// rule id
	// Required: true
	RuleID *string `json:"rule_id"`

	// Enum for whether or not this waiver is active or expired.
	// Enum: [ACTIVE EXPIRED]
	Status string `json:"status,omitempty"`

	// The date and time when the rule waiver was last updated.
	UpdatedAt int64 `json:"updated_at,omitempty"`

	// Principal that last updated the rule waiver.
	UpdatedBy string `json:"updated_by,omitempty"`

	// Display name of the user that last updated the rule waiver.
	UpdatedByDisplayName string `json:"updated_by_display_name,omitempty"`
}

RuleWaiver Rule waiver

swagger:model RuleWaiver

func (*RuleWaiver) MarshalBinary added in v0.11.0 

func (m *RuleWaiver) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RuleWaiver) UnmarshalBinary added in v0.11.0 

func (m *RuleWaiver) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RuleWaiver) Validate added in v0.11.0 

func (m *RuleWaiver) Validate(formats strfmt.Registry) error

Validate validates this rule waiver

type RuleWaivers added in v0.11.0 

type RuleWaivers struct {

	// count
	Count int64 `json:"count,omitempty"`

	// is truncated
	IsTruncated bool `json:"is_truncated,omitempty"`

	// items
	Items []*RuleWaiver `json:"items"`

	// next offset
	NextOffset int64 `json:"next_offset,omitempty"`
}

RuleWaivers rule waivers

swagger:model RuleWaivers

func (*RuleWaivers) MarshalBinary added in v0.11.0 

func (m *RuleWaivers) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RuleWaivers) UnmarshalBinary added in v0.11.0 

func (m *RuleWaivers) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RuleWaivers) Validate added in v0.11.0 

func (m *RuleWaivers) Validate(formats strfmt.Registry) error

Validate validates this rule waivers

type Scan 

type Scan struct {

	// Time the scan was created.
	CreatedAt int64 `json:"created_at,omitempty"`

	// ID of the environment the scan belongs to.
	EnvironmentID string `json:"environment_id,omitempty"`

	// Time the scan was finished.
	FinishedAt int64 `json:"finished_at,omitempty"`

	// ID of the scan.
	ID string `json:"id,omitempty"`

	// Message related to the scan.
	Message string `json:"message,omitempty"`

	// Indicates whether there were any remediation errors on the scan.
	RemediationError bool `json:"remediation_error,omitempty"`

	// Status of the scan.
	// Enum: [CREATED QUEUED IN_PROGRESS ERROR SUCCESS CANCELED]
	Status string `json:"status,omitempty"`

	// Time the scan was last updated.
	UpdatedAt int64 `json:"updated_at,omitempty"`
}

Scan A scan belonging to an environment.

swagger:model Scan

func (*Scan) MarshalBinary 

func (m *Scan) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Scan) UnmarshalBinary 

func (m *Scan) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Scan) Validate 

func (m *Scan) Validate(formats strfmt.Registry) error

Validate validates this scan

type ScanWithSummary 

type ScanWithSummary struct {
	Scan

	// resource summary
	ResourceSummary *ResourceSummary `json:"resource_summary,omitempty"`

	// resource type errors
	ResourceTypeErrors []*ScanWithSummaryResourceTypeErrorsItems0 `json:"resource_type_errors"`
}

ScanWithSummary A scan belonging to an environment.

swagger:model ScanWithSummary

func (*ScanWithSummary) MarshalBinary 

func (m *ScanWithSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (ScanWithSummary) MarshalJSON 

func (m ScanWithSummary) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*ScanWithSummary) UnmarshalBinary 

func (m *ScanWithSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ScanWithSummary) UnmarshalJSON 

func (m *ScanWithSummary) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*ScanWithSummary) Validate 

func (m *ScanWithSummary) Validate(formats strfmt.Registry) error

Validate validates this scan with summary

type ScanWithSummaryResourceTypeErrorsItems0 

type ScanWithSummaryResourceTypeErrorsItems0 struct {

	// error message
	// Required: true
	ErrorMessage *string `json:"error_message"`

	// resource type
	// Required: true
	ResourceType *string `json:"resource_type"`
}

ScanWithSummaryResourceTypeErrorsItems0 scan with summary resource type errors items0

swagger:model ScanWithSummaryResourceTypeErrorsItems0

func (*ScanWithSummaryResourceTypeErrorsItems0) MarshalBinary 

func (m *ScanWithSummaryResourceTypeErrorsItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ScanWithSummaryResourceTypeErrorsItems0) UnmarshalBinary 

func (m *ScanWithSummaryResourceTypeErrorsItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ScanWithSummaryResourceTypeErrorsItems0) Validate 

func (m *ScanWithSummaryResourceTypeErrorsItems0) Validate(formats strfmt.Registry) error

Validate validates this scan with summary resource type errors items0

type Scans 

type Scans struct {

	// Total number of items.
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// Paginated list of scans.
	Items []*Scan `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

Scans Paginated list of scans.

swagger:model Scans

func (*Scans) MarshalBinary 

func (m *Scans) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Scans) UnmarshalBinary 

func (m *Scans) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Scans) Validate 

func (m *Scans) Validate(formats strfmt.Registry) error

Validate validates this scans

type TestCustomRuleInput added in v0.4.0 

type TestCustomRuleInput struct {

	// Resource type to which the custom rule applies
	ResourceType string `json:"resource_type,omitempty"`

	// The rego source code for the rule
	// Required: true
	RuleText *string `json:"rule_text"`

	// Scan to test the custom rule with
	// Required: true
	ScanID *string `json:"scan_id"`
}

TestCustomRuleInput Input request for testing a custom rule.

swagger:model TestCustomRuleInput

func (*TestCustomRuleInput) MarshalBinary added in v0.4.0 

func (m *TestCustomRuleInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestCustomRuleInput) UnmarshalBinary added in v0.4.0 

func (m *TestCustomRuleInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestCustomRuleInput) Validate added in v0.4.0 

func (m *TestCustomRuleInput) Validate(formats strfmt.Registry) error

Validate validates this test custom rule input

type TestCustomRuleInputScan added in v0.4.0 

type TestCustomRuleInputScan struct {

	// links
	Links map[string]string `json:"links,omitempty"`

	// resources
	Resources interface{} `json:"resources,omitempty"`
}

TestCustomRuleInputScan Scan used as input to a custom rule.

swagger:model TestCustomRuleInputScan

func (*TestCustomRuleInputScan) MarshalBinary added in v0.4.0 

func (m *TestCustomRuleInputScan) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestCustomRuleInputScan) UnmarshalBinary added in v0.4.0 

func (m *TestCustomRuleInputScan) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestCustomRuleInputScan) Validate added in v0.4.0 

func (m *TestCustomRuleInputScan) Validate(formats strfmt.Registry) error

Validate validates this test custom rule input scan

type TestCustomRuleOutput added in v0.4.0 

type TestCustomRuleOutput struct {

	// errors
	Errors []*CustomRuleError `json:"errors"`

	// links
	Links map[string]string `json:"links,omitempty"`

	// resources
	Resources []*TestCustomRuleOutputResource `json:"resources"`

	// result
	// Enum: [PASS FAIL UNKNOWN]
	Result string `json:"result,omitempty"`
}

TestCustomRuleOutput Results from testing a custom rule.

swagger:model TestCustomRuleOutput

func (*TestCustomRuleOutput) MarshalBinary added in v0.4.0 

func (m *TestCustomRuleOutput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestCustomRuleOutput) UnmarshalBinary added in v0.4.0 

func (m *TestCustomRuleOutput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestCustomRuleOutput) Validate added in v0.4.0 

func (m *TestCustomRuleOutput) Validate(formats strfmt.Registry) error

Validate validates this test custom rule output

type TestCustomRuleOutputResource added in v0.4.0 

type TestCustomRuleOutputResource struct {

	// ID of the resource.
	ID string `json:"id,omitempty"`

	// Whether or not this single resource is compliant.
	// Enum: [PASS FAIL UNKNOWN]
	Result string `json:"result,omitempty"`

	// Type of the resource.
	Type string `json:"type,omitempty"`
}

TestCustomRuleOutputResource Test results from testing a custom rule on a single resource.

swagger:model TestCustomRuleOutputResource

func (*TestCustomRuleOutputResource) MarshalBinary added in v0.4.0 

func (m *TestCustomRuleOutputResource) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestCustomRuleOutputResource) UnmarshalBinary added in v0.4.0 

func (m *TestCustomRuleOutputResource) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestCustomRuleOutputResource) Validate added in v0.4.0 

func (m *TestCustomRuleOutputResource) Validate(formats strfmt.Registry) error

Validate validates this test custom rule output resource

type UpdateCustomRuleInput added in v0.3.0 

type UpdateCustomRuleInput struct {

	// Description of the custom rule
	Description string `json:"description,omitempty"`

	// Families to which the custom rule belongs
	Families []string `json:"families"`

	// Human readable name of the custom rule
	Name string `json:"name,omitempty"`

	// Providers for the custom rule.
	Providers []string `json:"providers"`

	// Resource type to which the custom rule applies
	ResourceType string `json:"resource_type,omitempty"`

	// Rego code used by the rule
	RuleText string `json:"rule_text,omitempty"`

	// Severity level of the custom rule.
	// Enum: [Informational Low Medium High Critical]
	Severity string `json:"severity,omitempty"`

	// Status of the custom rule
	// Enum: [ENABLED DISABLED]
	Status string `json:"status,omitempty"`
}

UpdateCustomRuleInput Input request for updating a custom rule

swagger:model UpdateCustomRuleInput

func (*UpdateCustomRuleInput) MarshalBinary added in v0.3.0 

func (m *UpdateCustomRuleInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateCustomRuleInput) UnmarshalBinary added in v0.3.0 

func (m *UpdateCustomRuleInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateCustomRuleInput) Validate added in v0.3.0 

func (m *UpdateCustomRuleInput) Validate(formats strfmt.Registry) error

Validate validates this update custom rule input

type UpdateEnvironmentInput 

type UpdateEnvironmentInput struct {

	// Scan ID of the baseline if baseline is enabled.
	BaselineID *string `json:"baseline_id,omitempty"`

	// List of compliance families validated against the environment.
	ComplianceFamilies []string `json:"compliance_families"`

	// Name of the environment.
	Name string `json:"name,omitempty"`

	// Name of the service provider for the environment.
	// Enum: [aws aws_govcloud azure google repository]
	Provider string `json:"provider,omitempty"`

	// provider options
	ProviderOptions *ProviderOptionsUpdateInput `json:"provider_options,omitempty"`

	// List of resource types remediated for the environment if remediation is enabled.
	RemediateResourceTypes []string `json:"remediate_resource_types"`

	// Indicates whether remediation is enabled for the environment.
	Remediation *bool `json:"remediation,omitempty"`

	// Time in seconds between the end of one scan to the start of the next. Must also set scan_schedule_enabled to true.
	// Minimum: 300
	ScanInterval int64 `json:"scan_interval,omitempty"`

	// Indicates whether an environment is scanned on a schedule.
	ScanScheduleEnabled *bool `json:"scan_schedule_enabled,omitempty"`

	// List of resource types surveyed for the environment.
	SurveyResourceTypes []string `json:"survey_resource_types"`
}

UpdateEnvironmentInput A managed environment.

swagger:model UpdateEnvironmentInput

func (*UpdateEnvironmentInput) MarshalBinary 

func (m *UpdateEnvironmentInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateEnvironmentInput) UnmarshalBinary 

func (m *UpdateEnvironmentInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateEnvironmentInput) Validate 

func (m *UpdateEnvironmentInput) Validate(formats strfmt.Registry) error

Validate validates this update environment input

type UpdateFamilyInput added in v0.15.0 

type UpdateFamilyInput struct {

	// If the family will automatically be enabled on all environments within the tenant
	AlwaysEnabled *bool `json:"always_enabled,omitempty"`

	// Description of the family
	Description string `json:"description,omitempty"`

	// Human readable name of the family
	Name string `json:"name,omitempty"`

	// If the family is recommended for all new environments
	Recommended *bool `json:"recommended,omitempty"`

	// List of rule ids to associate with family
	RuleIds []string `json:"rule_ids"`
}

UpdateFamilyInput Input request for updating a family

swagger:model UpdateFamilyInput

func (*UpdateFamilyInput) MarshalBinary added in v0.15.0 

func (m *UpdateFamilyInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateFamilyInput) UnmarshalBinary added in v0.15.0 

func (m *UpdateFamilyInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateFamilyInput) Validate added in v0.15.0 

func (m *UpdateFamilyInput) Validate(formats strfmt.Registry) error

Validate validates this update family input

type UpdateNotificationInput 

type UpdateNotificationInput struct {

	// List of email address the notification is delivered to.
	Emails []string `json:"emails"`

	// List of environment ids the notification is attached to.
	Environments []string `json:"environments"`

	// List of events the notification is triggered on.
	Events []string `json:"events"`

	// Human readable name of the notification.
	Name string `json:"name,omitempty"`

	// AWS SNS topic arn the notification is delivered to.
	TopicArn string `json:"topic_arn,omitempty"`
}

UpdateNotificationInput Request for updating an existing notification.

swagger:model UpdateNotificationInput

func (*UpdateNotificationInput) MarshalBinary 

func (m *UpdateNotificationInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateNotificationInput) UnmarshalBinary 

func (m *UpdateNotificationInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateNotificationInput) Validate 

func (m *UpdateNotificationInput) Validate(formats strfmt.Registry) error

Validate validates this update notification input

type UpdateRuleWaiverInput added in v0.11.0 

type UpdateRuleWaiverInput struct {

	// comment
	Comment string `json:"comment,omitempty"`

	// Unix timestamp representation of the expiration date of this rule waiver.
	// Cannot be combined with `expires_at_duration` or `expires_at_ts`.
	//
	ExpiresAt int64 `json:"expires_at,omitempty"`

	// Duration object representation of the expiration date of this rule waiver.
	// Cannot be combined with `expires_at` or `expires_at_ts`.
	//
	ExpiresAtDuration *Duration `json:"expires_at_duration,omitempty"`

	// RFC3339 representation of the expiration date of this rule waiver.
	// Cannot be combined with `expires_at` or `expires_at_duration`.
	//
	ExpiresAtTs string `json:"expires_at_ts,omitempty"`

	// name
	Name string `json:"name,omitempty"`
}

UpdateRuleWaiverInput Used to update properties of a rule waiver

swagger:model UpdateRuleWaiverInput

func (*UpdateRuleWaiverInput) MarshalBinary added in v0.11.0 

func (m *UpdateRuleWaiverInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateRuleWaiverInput) UnmarshalBinary added in v0.11.0 

func (m *UpdateRuleWaiverInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateRuleWaiverInput) Validate added in v0.11.0 

func (m *UpdateRuleWaiverInput) Validate(formats strfmt.Registry) error

Validate validates this update rule waiver input

type UploadRegulaScanViewOutput added in v0.15.0 

type UploadRegulaScanViewOutput struct {

	// Presigned S3 URL to upload a scan view
	URL string `json:"url,omitempty"`
}

UploadRegulaScanViewOutput Options for uploading regula scan view

swagger:model UploadRegulaScanViewOutput

func (*UploadRegulaScanViewOutput) MarshalBinary added in v0.15.0 

func (m *UploadRegulaScanViewOutput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UploadRegulaScanViewOutput) UnmarshalBinary added in v0.15.0 

func (m *UploadRegulaScanViewOutput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UploadRegulaScanViewOutput) Validate added in v0.15.0 

func (m *UploadRegulaScanViewOutput) Validate(formats strfmt.Registry) error

Validate validates this upload regula scan view output

type User added in v0.9.0 

type User struct {

	// email
	// Required: true
	Email *string `json:"email"`

	// first name
	FirstName string `json:"first_name,omitempty"`

	// Map from group id to name.
	Groups map[string]string `json:"groups,omitempty"`

	// id
	// Required: true
	ID *string `json:"id"`

	// last name
	LastName string `json:"last_name,omitempty"`

	// owner
	Owner bool `json:"owner,omitempty"`

	// resource type
	ResourceType string `json:"resource_type,omitempty"`

	// status
	// Required: true
	Status *string `json:"status"`
}

User user

swagger:model User

func (*User) MarshalBinary added in v0.9.0 

func (m *User) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*User) UnmarshalBinary added in v0.9.0 

func (m *User) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*User) Validate added in v0.9.0 

func (m *User) Validate(formats strfmt.Registry) error

Validate validates this user

type Users added in v0.9.0 

type Users struct {

	// Total number of items.
	Count int64 `json:"count,omitempty"`

	// Indicates whether there are more items at the next offset.
	IsTruncated bool `json:"is_truncated,omitempty"`

	// Paginated list of users.
	Items []*User `json:"items"`

	// Next offset to use to get the next page of items.
	NextOffset int64 `json:"next_offset,omitempty"`
}

Users Paginated list of users.

swagger:model Users

func (*Users) MarshalBinary added in v0.9.0 

func (m *Users) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Users) UnmarshalBinary added in v0.9.0 

func (m *Users) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Users) Validate added in v0.9.0 

func (m *Users) Validate(formats strfmt.Registry) error

Validate validates this users

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.