Documentation
¶
Index ¶
- Constants
- type Attribute
- type AuditLogEvent
- type AuditLogEventIdentity
- type AuditLogEventRequestContext
- type AuditLogEventResultsItems0
- type AuditLogEvents
- type AuthenticationError
- type AuthorizationError
- type BadRequestError
- type ComplianceByResourceType
- type ComplianceByResourceTypeOutput
- type ComplianceByRule
- type ComplianceByRuleFailedResourceTypesItems0
- type ComplianceByRuleFailedResourcesItems0
- type ComplianceByRules
- type ComplianceDiff
- type ComplianceDiffRulesItems0
- type CreateCustomRuleInput
- type CreateEnvironmentInput
- type CreateFamilyInput
- type CreateGroupInput
- type CreateInviteInput
- type CreateNotificationInput
- type CreatePolicyInput
- type CreateRuleWaiverInput
- type CustomRule
- type CustomRuleError
- type CustomRuleWithErrors
- func (m *CustomRuleWithErrors) MarshalBinary() ([]byte, error)
- func (m CustomRuleWithErrors) MarshalJSON() ([]byte, error)
- func (m *CustomRuleWithErrors) UnmarshalBinary(b []byte) error
- func (m *CustomRuleWithErrors) UnmarshalJSON(raw []byte) error
- func (m *CustomRuleWithErrors) Validate(formats strfmt.Registry) error
- type CustomRules
- type EditUsersGroupAssignmentsInput
- type Environment
- type EnvironmentWithSummary
- func (m *EnvironmentWithSummary) MarshalBinary() ([]byte, error)
- func (m EnvironmentWithSummary) MarshalJSON() ([]byte, error)
- func (m *EnvironmentWithSummary) UnmarshalBinary(b []byte) error
- func (m *EnvironmentWithSummary) UnmarshalJSON(raw []byte) error
- func (m *EnvironmentWithSummary) Validate(formats strfmt.Registry) error
- type Environments
- type Event
- type Events
- type Families
- type Family
- type FamilyWithRules
- type Group
- type Groups
- type InternalServerError
- type Invite
- type Invites
- type NonCompliantResource
- type NonCompliantResourceFailedRulesItems0
- type NotFoundError
- type Notification
- type Notifications
- type Permissions
- type PermissionsAws
- type ProviderOptions
- type ProviderOptionsAws
- type ProviderOptionsAwsUpdateInput
- type ProviderOptionsAzure
- type ProviderOptionsAzureUpdateInput
- type ProviderOptionsGoogle
- type ProviderOptionsGoogleUpdateInput
- type ProviderOptionsUpdateInput
- type Resource
- type ResourceDiff
- type ResourceSummary
- type ResourceSummaryFamiliesItems0
- type ResourceTypeMetadata
- type RuleWaiver
- type RuleWaivers
- type Scan
- type ScanWithSummary
- type ScanWithSummaryResourceTypeErrorsItems0
- type Scans
- type TestCustomRuleInput
- type TestCustomRuleInputScan
- type TestCustomRuleOutput
- type TestCustomRuleOutputResource
- type UpdateCustomRuleInput
- type UpdateEnvironmentInput
- type UpdateFamilyInput
- type UpdateNotificationInput
- type UpdateRuleWaiverInput
- type UploadRegulaScanViewOutput
- type User
- type Users
Constants ¶
const ( // AuthenticationErrorTypeAuthenticationError captures enum value "AuthenticationError" AuthenticationErrorTypeAuthenticationError string = "AuthenticationError" // AuthenticationErrorTypeInvalidOrMissingToken captures enum value "InvalidOrMissingToken" AuthenticationErrorTypeInvalidOrMissingToken string = "InvalidOrMissingToken" )
const ( // AuthorizationErrorTypeAuthorizationError captures enum value "AuthorizationError" AuthorizationErrorTypeAuthorizationError string = "AuthorizationError" // AuthorizationErrorTypeEnvironmentAccessDenied captures enum value "EnvironmentAccessDenied" AuthorizationErrorTypeEnvironmentAccessDenied string = "EnvironmentAccessDenied" )
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" // 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" )
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" )
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" )
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" )
const ( // CreateCustomRuleInputSourceFUGUE captures enum value "FUGUE" CreateCustomRuleInputSourceFUGUE string = "FUGUE" // CreateCustomRuleInputSourceCUSTOM captures enum value "CUSTOM" CreateCustomRuleInputSourceCUSTOM string = "CUSTOM" )
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" )
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" )
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" )
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" )
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" )
const ( // CustomRuleErrorSeverityError captures enum value "error" CustomRuleErrorSeverityError string = "error" // CustomRuleErrorSeverityWarning captures enum value "warning" CustomRuleErrorSeverityWarning string = "warning" )
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" )
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" )
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" )
const ( // FamilySourceFUGUE captures enum value "FUGUE" FamilySourceFUGUE string = "FUGUE" // FamilySourceCUSTOM captures enum value "CUSTOM" FamilySourceCUSTOM string = "CUSTOM" )
const ( // FamilyWithRulesSourceFUGUE captures enum value "FUGUE" FamilyWithRulesSourceFUGUE string = "FUGUE" // FamilyWithRulesSourceCUSTOM captures enum value "CUSTOM" FamilyWithRulesSourceCUSTOM string = "CUSTOM" )
const ( // InternalServerErrorTypeInternalServerError captures enum value "InternalServerError" InternalServerErrorTypeInternalServerError string = "InternalServerError" // InternalServerErrorTypeDatabaseError captures enum value "DatabaseError" InternalServerErrorTypeDatabaseError string = "DatabaseError" )
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" )
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" )
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" )
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" )
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" )
const ( // UpdateCustomRuleInputStatusENABLED captures enum value "ENABLED" UpdateCustomRuleInputStatusENABLED string = "ENABLED" // UpdateCustomRuleInputStatusDISABLED captures enum value "DISABLED" UpdateCustomRuleInputStatusDISABLED string = "DISABLED" )
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" )
const ( // CustomRuleSourceCUSTOM captures enum value "CUSTOM" CustomRuleSourceCUSTOM string = "CUSTOM" )
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 ¶
MarshalBinary interface implementation
func (*Attribute) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AuditLogEvent ¶
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 ¶
func (m *AuditLogEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuditLogEvent) UnmarshalBinary ¶
func (m *AuditLogEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuditLogEventIdentity ¶
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 ¶
func (m *AuditLogEventIdentity) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuditLogEventIdentity) UnmarshalBinary ¶
func (m *AuditLogEventIdentity) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuditLogEventRequestContext ¶
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 ¶
func (m *AuditLogEventRequestContext) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuditLogEventRequestContext) UnmarshalBinary ¶
func (m *AuditLogEventRequestContext) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuditLogEventResultsItems0 ¶
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 ¶
func (m *AuditLogEventResultsItems0) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuditLogEventResultsItems0) UnmarshalBinary ¶
func (m *AuditLogEventResultsItems0) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuditLogEvents ¶
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 ¶
func (m *AuditLogEvents) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuditLogEvents) UnmarshalBinary ¶
func (m *AuditLogEvents) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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
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
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 AlreadyAttachedToDifferentTenantError 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
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
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
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
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
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
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
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
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
type CreateCustomRuleInput ¶
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
// Enum: [AWS AWS_GOVCLOUD AZURE GOOGLE]
Provider string `json:"provider,omitempty"`
// 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 ¶
func (m *CreateCustomRuleInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateCustomRuleInput) UnmarshalBinary ¶
func (m *CreateCustomRuleInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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 cloud service provider for the environment.
// Enum: [aws aws_govcloud azure google]
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
type CreateFamilyInput ¶
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 ¶
func (m *CreateFamilyInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateFamilyInput) UnmarshalBinary ¶
func (m *CreateFamilyInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateGroupInput ¶
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]
Policy string `json:"policy,omitempty"`
}
CreateGroupInput create group input
swagger:model CreateGroupInput
func (*CreateGroupInput) MarshalBinary ¶
func (m *CreateGroupInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateGroupInput) UnmarshalBinary ¶
func (m *CreateGroupInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateInviteInput ¶
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 ¶
func (m *CreateInviteInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateInviteInput) UnmarshalBinary ¶
func (m *CreateInviteInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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
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
type CreateRuleWaiverInput ¶
type CreateRuleWaiverInput struct {
// comment
Comment string `json:"comment,omitempty"`
// environment id
// Required: true
EnvironmentID *string `json:"environment_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"`
// rule id
// Required: true
RuleID *string `json:"rule_id"`
}
CreateRuleWaiverInput Parameters for rule waiver creation.
swagger:model CreateRuleWaiverInput
func (*CreateRuleWaiverInput) MarshalBinary ¶
func (m *CreateRuleWaiverInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateRuleWaiverInput) UnmarshalBinary ¶
func (m *CreateRuleWaiverInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CustomRule ¶
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.
// Enum: [AWS AWS_GOVCLOUD AZURE GOOGLE]
Provider string `json:"provider,omitempty"`
// 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 ¶
func (m *CustomRule) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CustomRule) UnmarshalBinary ¶
func (m *CustomRule) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CustomRuleError ¶
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 ¶
func (m *CustomRuleError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CustomRuleError) UnmarshalBinary ¶
func (m *CustomRuleError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CustomRuleWithErrors ¶
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 ¶
func (m *CustomRuleWithErrors) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (CustomRuleWithErrors) MarshalJSON ¶
func (m CustomRuleWithErrors) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*CustomRuleWithErrors) UnmarshalBinary ¶
func (m *CustomRuleWithErrors) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*CustomRuleWithErrors) UnmarshalJSON ¶
func (m *CustomRuleWithErrors) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type CustomRules ¶
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 ¶
func (m *CustomRules) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CustomRules) UnmarshalBinary ¶
func (m *CustomRules) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EditUsersGroupAssignmentsInput ¶
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 ¶
func (m *EditUsersGroupAssignmentsInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EditUsersGroupAssignmentsInput) UnmarshalBinary ¶
func (m *EditUsersGroupAssignmentsInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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 cloud service provider for the environment.
// Enum: [aws aws_govcloud azure google]
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
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
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
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 ¶
MarshalBinary interface implementation
func (*Event) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 ¶
MarshalBinary interface implementation
func (*Events) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Families ¶
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 ¶
MarshalBinary interface implementation
func (*Families) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Family ¶
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 ¶
MarshalBinary interface implementation
func (*Family) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FamilyWithRules ¶
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 ¶
func (m *FamilyWithRules) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FamilyWithRules) UnmarshalBinary ¶
func (m *FamilyWithRules) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Group ¶
type Group struct {
// 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 ¶
MarshalBinary interface implementation
func (*Group) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Groups ¶
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 ¶
MarshalBinary interface implementation
func (*Groups) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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
type Invite ¶
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 ¶
MarshalBinary interface implementation
func (*Invite) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Invites ¶
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 ¶
MarshalBinary interface implementation
func (*Invites) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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
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
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
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
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
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
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
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"`
}
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
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
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
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
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
type ProviderOptionsGoogle ¶
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 ¶
func (m *ProviderOptionsGoogle) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProviderOptionsGoogle) UnmarshalBinary ¶
func (m *ProviderOptionsGoogle) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProviderOptionsGoogleUpdateInput ¶
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 ¶
func (m *ProviderOptionsGoogleUpdateInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProviderOptionsGoogleUpdateInput) UnmarshalBinary ¶
func (m *ProviderOptionsGoogleUpdateInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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"`
}
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
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 ¶
MarshalBinary interface implementation
func (*Resource) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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
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
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
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
type RuleWaiver ¶
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"`
// 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"`
// 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 ¶
func (m *RuleWaiver) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RuleWaiver) UnmarshalBinary ¶
func (m *RuleWaiver) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RuleWaivers ¶
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 ¶
func (m *RuleWaivers) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RuleWaivers) UnmarshalBinary ¶
func (m *RuleWaivers) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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 ¶
MarshalBinary interface implementation
func (*Scan) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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
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
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 ¶
MarshalBinary interface implementation
func (*Scans) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TestCustomRuleInput ¶
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 ¶
func (m *TestCustomRuleInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TestCustomRuleInput) UnmarshalBinary ¶
func (m *TestCustomRuleInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TestCustomRuleInputScan ¶
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 ¶
func (m *TestCustomRuleInputScan) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TestCustomRuleInputScan) UnmarshalBinary ¶
func (m *TestCustomRuleInputScan) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TestCustomRuleOutput ¶
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 ¶
func (m *TestCustomRuleOutput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TestCustomRuleOutput) UnmarshalBinary ¶
func (m *TestCustomRuleOutput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TestCustomRuleOutputResource ¶
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 ¶
func (m *TestCustomRuleOutputResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TestCustomRuleOutputResource) UnmarshalBinary ¶
func (m *TestCustomRuleOutputResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UpdateCustomRuleInput ¶
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"`
// 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 ¶
func (m *UpdateCustomRuleInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateCustomRuleInput) UnmarshalBinary ¶
func (m *UpdateCustomRuleInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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 cloud service provider for the environment.
// Enum: [aws aws_govcloud azure google]
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
type UpdateFamilyInput ¶
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 ¶
func (m *UpdateFamilyInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateFamilyInput) UnmarshalBinary ¶
func (m *UpdateFamilyInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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
type UpdateRuleWaiverInput ¶
type UpdateRuleWaiverInput struct {
// comment
Comment string `json:"comment,omitempty"`
// name
Name string `json:"name,omitempty"`
}
UpdateRuleWaiverInput Used to update properties of a rule waiver
swagger:model UpdateRuleWaiverInput
func (*UpdateRuleWaiverInput) MarshalBinary ¶
func (m *UpdateRuleWaiverInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UpdateRuleWaiverInput) UnmarshalBinary ¶
func (m *UpdateRuleWaiverInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UploadRegulaScanViewOutput ¶
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 ¶
func (m *UploadRegulaScanViewOutput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UploadRegulaScanViewOutput) UnmarshalBinary ¶
func (m *UploadRegulaScanViewOutput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type User ¶
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 ¶
MarshalBinary interface implementation
func (*User) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Users ¶
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 ¶
MarshalBinary interface implementation
func (*Users) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files
¶
- attribute.go
- audit_log_event.go
- audit_log_event_identity.go
- audit_log_event_request_context.go
- audit_log_events.go
- authentication_error.go
- authorization_error.go
- bad_request_error.go
- compliance_by_resource_type.go
- compliance_by_resource_type_output.go
- compliance_by_rule.go
- compliance_by_rules.go
- compliance_diff.go
- create_custom_rule_input.go
- create_environment_input.go
- create_family_input.go
- create_group_input.go
- create_invite_input.go
- create_notification_input.go
- create_policy_input.go
- create_rule_waiver_input.go
- custom_rule.go
- custom_rule_error.go
- custom_rule_with_errors.go
- custom_rules.go
- edit_users_group_assignments_input.go
- environment.go
- environment_with_summary.go
- environments.go
- event.go
- events.go
- families.go
- family.go
- family_with_rules.go
- group.go
- groups.go
- internal_server_error.go
- invite.go
- invites.go
- non_compliant_resource.go
- not_found_error.go
- notification.go
- notifications.go
- permissions.go
- permissions_aws.go
- provider_options.go
- provider_options_aws.go
- provider_options_aws_update_input.go
- provider_options_azure.go
- provider_options_azure_update_input.go
- provider_options_google.go
- provider_options_google_update_input.go
- provider_options_update_input.go
- resource.go
- resource_diff.go
- resource_summary.go
- resource_type_metadata.go
- rule_waiver.go
- rule_waivers.go
- scan.go
- scan_with_summary.go
- scans.go
- test_custom_rule_input.go
- test_custom_rule_input_scan.go
- test_custom_rule_output.go
- test_custom_rule_output_resource.go
- update_custom_rule_input.go
- update_environment_input.go
- update_family_input.go
- update_notification_input.go
- update_rule_waiver_input.go
- upload_regula_scan_view_output.go
- user.go
- users.go