types

package
v1.7.7 Latest Latest
Warning

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

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_   *string
	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccountFindingsMetric 

type AccountFindingsMetric struct {

	// The number of closed findings of each severity in an account on the specified
	// date.
	ClosedFindings *FindingMetricsValuePerSeverity

	// The date from which the finding metrics were retrieved.
	Date *time.Time

	// The average time it takes to close findings of each severity in days.
	MeanTimeToClose *FindingMetricsValuePerSeverity

	// The number of new findings of each severity in account on the specified date.
	NewFindings *FindingMetricsValuePerSeverity

	// The number of open findings of each severity in an account as of the specified
	// date.
	OpenFindings *FindingMetricsValuePerSeverity
	// contains filtered or unexported fields
}

A summary of findings metrics in an account.

type AnalysisType 

type AnalysisType string
const (
	AnalysisTypeSecurity AnalysisType = "Security"
	AnalysisTypeAll      AnalysisType = "All"
)

Enum values for AnalysisType

func (AnalysisType) Values 

func (AnalysisType) Values() []AnalysisType

Values returns all known values for AnalysisType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchGetFindingsError 

type BatchGetFindingsError struct {

	// A code associated with the type of error.
	//
	// This member is required.
	ErrorCode ErrorCode

	// The finding ID of the finding that was not fetched.
	//
	// This member is required.
	FindingId *string

	// Describes the error.
	//
	// This member is required.
	Message *string

	// The name of the scan that generated the finding.
	//
	// This member is required.
	ScanName *string
	// contains filtered or unexported fields
}

Contains information about the error that caused a finding to fail to be retrieved.

type CategoryWithFindingNum 

type CategoryWithFindingNum struct {

	// The name of the finding category. A finding category is determined by the
	// detector that detected the finding.
	CategoryName *string

	// The number of open findings in the category.
	FindingNumber *int32
	// contains filtered or unexported fields
}

Information about a finding category with open findings.

type CodeLine 

type CodeLine struct {

	// The code that contains a vulnerability.
	Content *string

	// The code line number.
	Number *int32
	// contains filtered or unexported fields
}

The line of code where a finding was detected.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_   *string
	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type EncryptionConfig 

type EncryptionConfig struct {

	// The KMS key ARN to use for encryption. This must be provided as a header when
	// uploading your code resource.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Information about account-level configuration.

type ErrorCode 

type ErrorCode string
const (
	ErrorCodeDuplicateIdentifier ErrorCode = "DUPLICATE_IDENTIFIER"
	ErrorCodeItemDoesNotExist    ErrorCode = "ITEM_DOES_NOT_EXIST"
	ErrorCodeInternalError       ErrorCode = "INTERNAL_ERROR"
	ErrorCodeInvalidFindingId    ErrorCode = "INVALID_FINDING_ID"
	ErrorCodeInvalidScanName     ErrorCode = "INVALID_SCAN_NAME"
)

Enum values for ErrorCode

func (ErrorCode) Values 

func (ErrorCode) Values() []ErrorCode

Values returns all known values for ErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FilePath 

type FilePath struct {

	// A list of CodeLine objects that describe where the security vulnerability
	// appears in your code.
	CodeSnippet []CodeLine

	// The last line number of the code snippet where the security vulnerability
	// appears in your code.
	EndLine *int32

	// The name of the file.
	Name *string

	// The path to the resource with the security vulnerability.
	Path *string

	// The first line number of the code snippet where the security vulnerability
	// appears in your code.
	StartLine *int32
	// contains filtered or unexported fields
}

Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.

type Finding 

type Finding struct {

	// The time when the finding was created.
	CreatedAt *time.Time

	// A description of the finding.
	Description *string

	// The identifier for the detector that detected the finding in your code. A
	// detector is a defined rule based on industry standards and AWS best practices.
	DetectorId *string

	// The name of the detector that identified the security vulnerability in your
	// code.
	DetectorName *string

	// One or more tags or categorizations that are associated with a detector. These
	// tags are defined by type, programming language, or other classification such as
	// maintainability or consistency.
	DetectorTags []string

	// The identifier for the component that generated a finding such as
	// AWSCodeGuruSecurity or AWSInspector.
	GeneratorId *string

	// The identifier for a finding.
	Id *string

	// An object that contains the details about how to remediate a finding.
	Remediation *Remediation

	// The resource where Amazon CodeGuru Security detected a finding.
	Resource *Resource

	// The identifier for the rule that generated the finding.
	RuleId *string

	// The severity of the finding.
	Severity Severity

	// The status of the finding. A finding status can be open or closed.
	Status Status

	// The title of the finding.
	Title *string

	// The type of finding.
	Type *string

	// The time when the finding was last updated. Findings are updated when you
	// remediate them or when the finding code location changes.
	UpdatedAt *time.Time

	// An object that describes the detected security vulnerability.
	Vulnerability *Vulnerability
	// contains filtered or unexported fields
}

Information about a finding that was detected in your code.

type FindingIdentifier 

type FindingIdentifier struct {

	// The identifier for a finding.
	//
	// This member is required.
	FindingId *string

	// The name of the scan that generated the finding.
	//
	// This member is required.
	ScanName *string
	// contains filtered or unexported fields
}

An object that contains information about a finding and the scan that generated it.

type FindingMetricsValuePerSeverity 

type FindingMetricsValuePerSeverity struct {

	// The severity of the finding is critical and should be addressed immediately.
	Critical *float64

	// The severity of the finding is high and should be addressed as a near-term
	// priority.
	High *float64

	// The finding is related to quality or readability improvements and not
	// considered actionable.
	Info *float64

	// The severity of the finding is low and does require action on its own.
	Low *float64

	// The severity of the finding is medium and should be addressed as a mid-term
	// priority.
	Medium *float64
	// contains filtered or unexported fields
}

The severity of the issue in the code that generated a finding.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	Error_ *string
	// contains filtered or unexported fields
}

The server encountered an internal error and is unable to complete the request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type MetricsSummary 

type MetricsSummary struct {

	// A list of CategoryWithFindingNum objects for the top 5 finding categories with
	// the most open findings in an account.
	CategoriesWithMostFindings []CategoryWithFindingNum

	// The date from which the metrics summary information was retrieved.
	Date *time.Time

	// The number of open findings of each severity in an account.
	OpenFindings *FindingMetricsValuePerSeverity

	// A list of ScanNameWithFindingNum objects for the top 3 scans with the most
	// number of open findings in an account.
	ScansWithMostOpenCriticalFindings []ScanNameWithFindingNum

	// A list of ScanNameWithFindingNum objects for the top 3 scans with the most
	// number of open critical findings in an account.
	ScansWithMostOpenFindings []ScanNameWithFindingNum
	// contains filtered or unexported fields
}

Information about summary metrics in an account.

type Recommendation 

type Recommendation struct {

	// The recommended course of action to remediate the finding.
	Text *string

	// The URL address to the recommendation for remediating the finding.
	Url *string
	// contains filtered or unexported fields
}

Information about the recommended course of action to remediate a finding.

type Remediation 

type Remediation struct {

	// An object that contains information about the recommended course of action to
	// remediate a finding.
	Recommendation *Recommendation

	// A list of SuggestedFix objects. Each object contains information about a
	// suggested code fix to remediate the finding.
	SuggestedFixes []SuggestedFix
	// contains filtered or unexported fields
}

Information about how to remediate a finding.

type Resource 

type Resource struct {

	// The identifier for the resource.
	Id *string

	// The identifier for a section of the resource, such as an AWS Lambda layer.
	SubResourceId *string
	// contains filtered or unexported fields
}

Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that contains a finding.

type ResourceId 

type ResourceId interface {
	// contains filtered or unexported methods
}

The identifier for a resource object that contains resources where a finding was detected.

The following types satisfy this interface: 

ResourceIdMemberCodeArtifactId
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/codegurusecurity/types"
)

func main() {
	var union types.ResourceId
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ResourceIdMemberCodeArtifactId:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *string

Output:

type ResourceIdMemberCodeArtifactId 

type ResourceIdMemberCodeArtifactId struct {
	Value string
	// contains filtered or unexported fields
}

The identifier for the code file uploaded to the resource where a finding was detected.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_   *string
	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The resource specified in the request was not found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ScanNameWithFindingNum 

type ScanNameWithFindingNum struct {

	// The number of open findings generated by a scan.
	FindingNumber *int32

	// The name of the scan.
	ScanName *string
	// contains filtered or unexported fields
}

Information about a scan with open findings.

type ScanState 

type ScanState string
const (
	ScanStateInProgress ScanState = "InProgress"
	ScanStateSuccessful ScanState = "Successful"
	ScanStateFailed     ScanState = "Failed"
)

Enum values for ScanState

func (ScanState) Values 

func (ScanState) Values() []ScanState

Values returns all known values for ScanState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ScanSummary 

type ScanSummary struct {

	//  The time when the scan was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The identifier for the scan run.
	//
	// This member is required.
	RunId *string

	// The name of the scan.
	//
	// This member is required.
	ScanName *string

	// The state of the scan. A scan can be In Progress , Complete , or Failed .
	//
	// This member is required.
	ScanState ScanState

	// The ARN for the scan name.
	ScanNameArn *string

	// The time the scan was last updated. A scan is updated when it is re-run.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Information about a scan.

type ScanType 

type ScanType string
const (
	ScanTypeStandard ScanType = "Standard"
	ScanTypeExpress  ScanType = "Express"
)

Enum values for ScanType

func (ScanType) Values 

func (ScanType) Values() []ScanType

Values returns all known values for ScanType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Severity 

type Severity string
const (
	SeverityCritical Severity = "Critical"
	SeverityHigh     Severity = "High"
	SeverityMedium   Severity = "Medium"
	SeverityLow      Severity = "Low"
	SeverityInfo     Severity = "Info"
)

Enum values for Severity

func (Severity) Values 

func (Severity) Values() []Severity

Values returns all known values for Severity. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Status 

type Status string
const (
	StatusClosed Status = "Closed"
	StatusOpen   Status = "Open"
	StatusAll    Status = "All"
)

Enum values for Status

func (Status) Values 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SuggestedFix 

type SuggestedFix struct {

	// The suggested code to add to your file.
	Code *string

	// A description of the suggested code fix and why it is being suggested.
	Description *string
	// contains filtered or unexported fields
}

Information about the suggested code fix to remediate a finding.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_  *string
	ServiceCode *string
	QuotaCode   *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ *string
	Reason     ValidationExceptionReason
	FieldList  []ValidationExceptionField
	// contains filtered or unexported fields
}

The input fails to satisfy the specified constraints.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// Describes the exception.
	//
	// This member is required.
	Message *string

	// The name of the exception.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Information about a validation exception.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
	ValidationExceptionReasonLambdaCodeShaMismatch ValidationExceptionReason = "lambdaCodeShaMisMatch"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Vulnerability 

type Vulnerability struct {

	//  An object that describes the location of the detected security vulnerability
	// in your code.
	FilePath *FilePath

	// The identifier for the vulnerability.
	Id *string

	//  The number of times the vulnerability appears in your code.
	ItemCount *int32

	// One or more URL addresses that contain details about a vulnerability.
	ReferenceUrls []string

	// One or more vulnerabilities that are related to the vulnerability being
	// described.
	RelatedVulnerabilities []string
	// contains filtered or unexported fields
}

Information about a security vulnerability that Amazon CodeGuru Security detected.

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.