models

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2019 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"

	// BadRequestErrorTypeAlreadyAttachedToDifferentTenantError captures enum value "AlreadyAttachedToDifferentTenantError"
	BadRequestErrorTypeAlreadyAttachedToDifferentTenantError string = "AlreadyAttachedToDifferentTenantError"

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

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

	// 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 (

	// 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"
)
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"
)
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 (

	// 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 (

	// 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 (

	// 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"
)
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"`

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

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

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

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

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

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

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 AuthenticationError 

type AuthenticationError struct {

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

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

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

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"`

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

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

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"`

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

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

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"`

	// 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"`

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

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"`

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

	// 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"`
}

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"`

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

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

	// 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 ComplianceByRuleFailedResourceTypesItems 

type ComplianceByRuleFailedResourceTypesItems struct {

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

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

ComplianceByRuleFailedResourceTypesItems Resource type that failed to satisfy the rule due to a required resource being omitted and associated error messages. swagger:model complianceByRuleFailedResourceTypesItems

func (*ComplianceByRuleFailedResourceTypesItems) MarshalBinary 

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

MarshalBinary interface implementation

func (*ComplianceByRuleFailedResourceTypesItems) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ComplianceByRuleFailedResourceTypesItems) Validate 

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

Validate validates this compliance by rule failed resource types items

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"`
}

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 ComplianceByRuleFailedResourcesItems 

type ComplianceByRuleFailedResourcesItems struct {

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

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

ComplianceByRuleFailedResourcesItems Resource that failed to satisfy the rule due to a misconfiguration in the resource and associated error messages. swagger:model complianceByRuleFailedResourcesItems

func (*ComplianceByRuleFailedResourcesItems) MarshalBinary 

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

MarshalBinary interface implementation

func (*ComplianceByRuleFailedResourcesItems) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ComplianceByRuleFailedResourcesItems) Validate 

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

Validate validates this compliance by rule failed resources items

type ComplianceByRuleFailedResourcesItems0 

type ComplianceByRuleFailedResourcesItems0 struct {

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

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

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"`

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

	// 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"`
}

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"`

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

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

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

	// 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 ComplianceDiffRulesItems 

type ComplianceDiffRulesItems 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"`

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

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

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

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

ComplianceDiffRulesItems compliance diff rules items swagger:model complianceDiffRulesItems

func (*ComplianceDiffRulesItems) MarshalBinary 

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

MarshalBinary interface implementation

func (*ComplianceDiffRulesItems) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ComplianceDiffRulesItems) Validate 

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

Validate validates this compliance diff rules items

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"`

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

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

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

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

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 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"`

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

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

	// 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"`

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

	// 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 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"`

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

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 Environment 

type Environment struct {

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

	// 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"`

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

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

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

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

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

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

	// 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"`

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

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

	// 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"`

	// 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"`
}

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 EnvironmentWithSummary 

type EnvironmentWithSummary struct {
	Environment

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

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 EnvironmentWithSummaryAllOf1 

type EnvironmentWithSummaryAllOf1 struct {

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

EnvironmentWithSummaryAllOf1 environment with summary all of1 swagger:model environmentWithSummaryAllOf1

func (*EnvironmentWithSummaryAllOf1) MarshalBinary 

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

MarshalBinary interface implementation

func (*EnvironmentWithSummaryAllOf1) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*EnvironmentWithSummaryAllOf1) Validate 

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

Validate validates this environment with summary all of1

type Environments 

type Environments struct {

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

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

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

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

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"`

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

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

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

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

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

Event A drift or remediation 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"`

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

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

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

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 InternalServerError 

type InternalServerError struct {

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

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

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

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 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"`
}

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 NonCompliantResourceFailedRulesItems 

type NonCompliantResourceFailedRulesItems struct {

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

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

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

NonCompliantResourceFailedRulesItems non compliant resource failed rules items swagger:model nonCompliantResourceFailedRulesItems

func (*NonCompliantResourceFailedRulesItems) MarshalBinary 

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

MarshalBinary interface implementation

func (*NonCompliantResourceFailedRulesItems) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*NonCompliantResourceFailedRulesItems) Validate 

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

Validate validates this non compliant resource failed rules items

type NonCompliantResourceFailedRulesItems0 

type NonCompliantResourceFailedRulesItems0 struct {

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

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

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

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"`

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

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

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 Notification 

type Notification struct {

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

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

	// 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"`

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

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

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

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

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

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"`

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

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

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

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"`
}

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"`

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

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"`

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

	// azure
	Azure *ProviderOptionsAzure `json:"azure"`
}

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"`

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

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 {

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

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"`

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

	// 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"`

	// 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"`
}

ProviderOptionsAzure Provider options for Azire. 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"`

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

	// 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 ProviderOptionsUpdateInput 

type ProviderOptionsUpdateInput struct {

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

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

	// azure
	Azure *ProviderOptionsAzureUpdateInput `json:"azure"`
}

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"`

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

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"`

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

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

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"`

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

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

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

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

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

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

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 ResourceSummaryFamiliesItems 

type ResourceSummaryFamiliesItems struct {

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

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

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

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

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

ResourceSummaryFamiliesItems Compliance summary for the compliance family run against resources for the scan. swagger:model resourceSummaryFamiliesItems

func (*ResourceSummaryFamiliesItems) MarshalBinary 

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

MarshalBinary interface implementation

func (*ResourceSummaryFamiliesItems) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ResourceSummaryFamiliesItems) Validate 

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

Validate validates this resource summary families items

type ResourceSummaryFamiliesItems0 

type ResourceSummaryFamiliesItems0 struct {

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

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

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

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

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

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 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 Scan 

type Scan struct {

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

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

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

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

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

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

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

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

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"`

	// 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 ScanWithSummaryAllOf1 

type ScanWithSummaryAllOf1 struct {

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

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

ScanWithSummaryAllOf1 scan with summary all of1 swagger:model scanWithSummaryAllOf1

func (*ScanWithSummaryAllOf1) MarshalBinary 

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

MarshalBinary interface implementation

func (*ScanWithSummaryAllOf1) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ScanWithSummaryAllOf1) Validate 

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

Validate validates this scan with summary all of1

type ScanWithSummaryAllOf1ResourceTypeErrorsItems 

type ScanWithSummaryAllOf1ResourceTypeErrorsItems struct {

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

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

ScanWithSummaryAllOf1ResourceTypeErrorsItems scan with summary all of1 resource type errors items swagger:model scanWithSummaryAllOf1ResourceTypeErrorsItems

func (*ScanWithSummaryAllOf1ResourceTypeErrorsItems) MarshalBinary 

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

MarshalBinary interface implementation

func (*ScanWithSummaryAllOf1ResourceTypeErrorsItems) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ScanWithSummaryAllOf1ResourceTypeErrorsItems) Validate 

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

Validate validates this scan with summary all of1 resource type errors items

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"`

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

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

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

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 UpdateEnvironmentInput 

type UpdateEnvironmentInput struct {

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

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

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

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

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

	// 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"`

	// 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"`

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

	// 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 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"`

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

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

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.