codegurusecurity

package
v0.0.0-...-c570f4e Latest Latest
Warning

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

Go to latest
Published: Dec 20, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package codegurusecurity provides the client and types for making API requests to Amazon CodeGuru Security.

Amazon CodeGuru Security is in preview release and is subject to change.

This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.

By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide (https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html).

See https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10 for more information on this service.

See codegurusecurity package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/codegurusecurity/

Using the Client

To contact Amazon CodeGuru Security with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon CodeGuru Security client CodeGuruSecurity for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/codegurusecurity/#New

Index

Constants

View Source
const (
	// AnalysisTypeSecurity is a AnalysisType enum value
	AnalysisTypeSecurity = "Security"

	// AnalysisTypeAll is a AnalysisType enum value
	AnalysisTypeAll = "All"
)
View Source
const (
	// ErrorCodeDuplicateIdentifier is a ErrorCode enum value
	ErrorCodeDuplicateIdentifier = "DUPLICATE_IDENTIFIER"

	// ErrorCodeItemDoesNotExist is a ErrorCode enum value
	ErrorCodeItemDoesNotExist = "ITEM_DOES_NOT_EXIST"

	// ErrorCodeInternalError is a ErrorCode enum value
	ErrorCodeInternalError = "INTERNAL_ERROR"

	// ErrorCodeInvalidFindingId is a ErrorCode enum value
	ErrorCodeInvalidFindingId = "INVALID_FINDING_ID"

	// ErrorCodeInvalidScanName is a ErrorCode enum value
	ErrorCodeInvalidScanName = "INVALID_SCAN_NAME"
)
View Source
const (
	// ScanStateInProgress is a ScanState enum value
	ScanStateInProgress = "InProgress"

	// ScanStateSuccessful is a ScanState enum value
	ScanStateSuccessful = "Successful"

	// ScanStateFailed is a ScanState enum value
	ScanStateFailed = "Failed"
)
View Source
const (
	// ScanTypeStandard is a ScanType enum value
	ScanTypeStandard = "Standard"

	// ScanTypeExpress is a ScanType enum value
	ScanTypeExpress = "Express"
)
View Source
const (
	// SeverityCritical is a Severity enum value
	SeverityCritical = "Critical"

	// SeverityHigh is a Severity enum value
	SeverityHigh = "High"

	// SeverityMedium is a Severity enum value
	SeverityMedium = "Medium"

	// SeverityLow is a Severity enum value
	SeverityLow = "Low"

	// SeverityInfo is a Severity enum value
	SeverityInfo = "Info"
)
View Source
const (
	// StatusClosed is a Status enum value
	StatusClosed = "Closed"

	// StatusOpen is a Status enum value
	StatusOpen = "Open"

	// StatusAll is a Status enum value
	StatusAll = "All"
)
View Source
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "unknownOperation"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "cannotParse"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "fieldValidationFailed"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "other"

	// ValidationExceptionReasonLambdaCodeShaMisMatch is a ValidationExceptionReason enum value
	ValidationExceptionReasonLambdaCodeShaMisMatch = "lambdaCodeShaMisMatch"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// 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.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The server encountered an internal error and is unable to complete the request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource specified in the request was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the specified constraints.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "CodeGuru Security" // Name of service.
	EndpointsID = "codeguru-security" // ID to lookup a service endpoint with.
	ServiceID   = "CodeGuru Security" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AnalysisType_Values

func AnalysisType_Values() []string

AnalysisType_Values returns all elements of the AnalysisType enum

func ErrorCode_Values

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func ScanState_Values

func ScanState_Values() []string

ScanState_Values returns all elements of the ScanState enum

func ScanType_Values

func ScanType_Values() []string

ScanType_Values returns all elements of the ScanType enum

func Severity_Values

func Severity_Values() []string

Severity_Values returns all elements of the Severity enum

func Status_Values

func Status_Values() []string

Status_Values returns all elements of the Status enum

func ValidationExceptionReason_Values

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The identifier for the error.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The identifier for the resource you don't have access to.
	ResourceId *string `locationName:"resourceId" type:"string"`

	// The type of resource you don't have access to.
	ResourceType *string `locationName:"resourceType" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountFindingsMetric

type AccountFindingsMetric struct {

	// The number of closed findings of each severity in an account on the specified
	// date.
	ClosedFindings *FindingMetricsValuePerSeverity `locationName:"closedFindings" type:"structure"`

	// The date from which the finding metrics were retrieved.
	Date *time.Time `locationName:"date" type:"timestamp"`

	// The average time it takes to close findings of each severity in days.
	MeanTimeToClose *FindingMetricsValuePerSeverity `locationName:"meanTimeToClose" type:"structure"`

	// The number of new findings of each severity in account on the specified date.
	NewFindings *FindingMetricsValuePerSeverity `locationName:"newFindings" type:"structure"`

	// The number of open findings of each severity in an account as of the specified
	// date.
	OpenFindings *FindingMetricsValuePerSeverity `locationName:"openFindings" type:"structure"`
	// contains filtered or unexported fields
}

A summary of findings metrics in an account.

func (AccountFindingsMetric) GoString

func (s AccountFindingsMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountFindingsMetric) SetClosedFindings

SetClosedFindings sets the ClosedFindings field's value.

func (*AccountFindingsMetric) SetDate

SetDate sets the Date field's value.

func (*AccountFindingsMetric) SetMeanTimeToClose

SetMeanTimeToClose sets the MeanTimeToClose field's value.

func (*AccountFindingsMetric) SetNewFindings

SetNewFindings sets the NewFindings field's value.

func (*AccountFindingsMetric) SetOpenFindings

SetOpenFindings sets the OpenFindings field's value.

func (AccountFindingsMetric) String

func (s AccountFindingsMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetFindingsError

type BatchGetFindingsError struct {

	// A code associated with the type of error.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"ErrorCode"`

	// The finding ID of the finding that was not fetched.
	//
	// FindingId is a required field
	FindingId *string `locationName:"findingId" type:"string" required:"true"`

	// Describes the error.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the scan that generated the finding.
	//
	// ScanName is a required field
	ScanName *string `locationName:"scanName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (BatchGetFindingsError) GoString

func (s BatchGetFindingsError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetFindingsError) SetErrorCode

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetFindingsError) SetFindingId

SetFindingId sets the FindingId field's value.

func (*BatchGetFindingsError) SetMessage

SetMessage sets the Message field's value.

func (*BatchGetFindingsError) SetScanName

SetScanName sets the ScanName field's value.

func (BatchGetFindingsError) String

func (s BatchGetFindingsError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetFindingsInput

type BatchGetFindingsInput struct {

	// A list of finding identifiers. Each identifier consists of a scanName and
	// a findingId. You retrieve the findingId when you call GetFindings.
	//
	// FindingIdentifiers is a required field
	FindingIdentifiers []*FindingIdentifier `locationName:"findingIdentifiers" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetFindingsInput) GoString

func (s BatchGetFindingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetFindingsInput) SetFindingIdentifiers

func (s *BatchGetFindingsInput) SetFindingIdentifiers(v []*FindingIdentifier) *BatchGetFindingsInput

SetFindingIdentifiers sets the FindingIdentifiers field's value.

func (BatchGetFindingsInput) String

func (s BatchGetFindingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetFindingsInput) Validate

func (s *BatchGetFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetFindingsOutput

type BatchGetFindingsOutput struct {

	// A list of errors for individual findings which were not fetched. Each BatchGetFindingsError
	// contains the scanName, findingId, errorCode and error message.
	//
	// FailedFindings is a required field
	FailedFindings []*BatchGetFindingsError `locationName:"failedFindings" type:"list" required:"true"`

	// A list of all requested findings.
	//
	// Findings is a required field
	Findings []*Finding `locationName:"findings" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetFindingsOutput) GoString

func (s BatchGetFindingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetFindingsOutput) SetFailedFindings

SetFailedFindings sets the FailedFindings field's value.

func (*BatchGetFindingsOutput) SetFindings

SetFindings sets the Findings field's value.

func (BatchGetFindingsOutput) String

func (s BatchGetFindingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `locationName:"categoryName" type:"string"`

	// The number of open findings in the category.
	FindingNumber *int64 `locationName:"findingNumber" type:"integer"`
	// contains filtered or unexported fields
}

Information about a finding category with open findings.

func (CategoryWithFindingNum) GoString

func (s CategoryWithFindingNum) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CategoryWithFindingNum) SetCategoryName

func (s *CategoryWithFindingNum) SetCategoryName(v string) *CategoryWithFindingNum

SetCategoryName sets the CategoryName field's value.

func (*CategoryWithFindingNum) SetFindingNumber

func (s *CategoryWithFindingNum) SetFindingNumber(v int64) *CategoryWithFindingNum

SetFindingNumber sets the FindingNumber field's value.

func (CategoryWithFindingNum) String

func (s CategoryWithFindingNum) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CodeGuruSecurity

type CodeGuruSecurity struct {
	*client.Client
}

CodeGuruSecurity provides the API operation methods for making requests to Amazon CodeGuru Security. See this package's package overview docs for details on the service.

CodeGuruSecurity methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the CodeGuruSecurity client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a CodeGuruSecurity client from just a session.
svc := codegurusecurity.New(mySession)

// Create a CodeGuruSecurity client with additional configuration
svc := codegurusecurity.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CodeGuruSecurity) BatchGetFindings

func (c *CodeGuruSecurity) BatchGetFindings(input *BatchGetFindingsInput) (*BatchGetFindingsOutput, error)

BatchGetFindings API operation for Amazon CodeGuru Security.

Returns a list of all requested findings.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation BatchGetFindings for usage and error information.

Returned Error Types:

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindings

func (*CodeGuruSecurity) BatchGetFindingsRequest

func (c *CodeGuruSecurity) BatchGetFindingsRequest(input *BatchGetFindingsInput) (req *request.Request, output *BatchGetFindingsOutput)

BatchGetFindingsRequest generates a "aws/request.Request" representing the client's request for the BatchGetFindings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetFindings for more information on using the BatchGetFindings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchGetFindingsRequest method.
req, resp := client.BatchGetFindingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindings

func (*CodeGuruSecurity) BatchGetFindingsWithContext

func (c *CodeGuruSecurity) BatchGetFindingsWithContext(ctx aws.Context, input *BatchGetFindingsInput, opts ...request.Option) (*BatchGetFindingsOutput, error)

BatchGetFindingsWithContext is the same as BatchGetFindings with the addition of the ability to pass a context and additional request options.

See BatchGetFindings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) CreateScan

func (c *CodeGuruSecurity) CreateScan(input *CreateScanInput) (*CreateScanOutput, error)

CreateScan API operation for Amazon CodeGuru Security.

Use to create a scan using code uploaded to an S3 bucket.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation CreateScan for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

  • ResourceNotFoundException The resource specified in the request was not found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateScan

func (*CodeGuruSecurity) CreateScanRequest

func (c *CodeGuruSecurity) CreateScanRequest(input *CreateScanInput) (req *request.Request, output *CreateScanOutput)

CreateScanRequest generates a "aws/request.Request" representing the client's request for the CreateScan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateScan for more information on using the CreateScan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateScanRequest method.
req, resp := client.CreateScanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateScan

func (*CodeGuruSecurity) CreateScanWithContext

func (c *CodeGuruSecurity) CreateScanWithContext(ctx aws.Context, input *CreateScanInput, opts ...request.Option) (*CreateScanOutput, error)

CreateScanWithContext is the same as CreateScan with the addition of the ability to pass a context and additional request options.

See CreateScan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) CreateUploadUrl

func (c *CodeGuruSecurity) CreateUploadUrl(input *CreateUploadUrlInput) (*CreateUploadUrlOutput, error)

CreateUploadUrl API operation for Amazon CodeGuru Security.

Generates a pre-signed URL and request headers used to upload a code resource.

You can upload your code resource to the URL and add the request headers using any HTTP client.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation CreateUploadUrl for usage and error information.

Returned Error Types:

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrl

func (*CodeGuruSecurity) CreateUploadUrlRequest

func (c *CodeGuruSecurity) CreateUploadUrlRequest(input *CreateUploadUrlInput) (req *request.Request, output *CreateUploadUrlOutput)

CreateUploadUrlRequest generates a "aws/request.Request" representing the client's request for the CreateUploadUrl operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUploadUrl for more information on using the CreateUploadUrl API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateUploadUrlRequest method.
req, resp := client.CreateUploadUrlRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrl

func (*CodeGuruSecurity) CreateUploadUrlWithContext

func (c *CodeGuruSecurity) CreateUploadUrlWithContext(ctx aws.Context, input *CreateUploadUrlInput, opts ...request.Option) (*CreateUploadUrlOutput, error)

CreateUploadUrlWithContext is the same as CreateUploadUrl with the addition of the ability to pass a context and additional request options.

See CreateUploadUrl for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) GetAccountConfiguration

GetAccountConfiguration API operation for Amazon CodeGuru Security.

Use to get account level configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation GetAccountConfiguration for usage and error information.

Returned Error Types:

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetAccountConfiguration

func (*CodeGuruSecurity) GetAccountConfigurationRequest

func (c *CodeGuruSecurity) GetAccountConfigurationRequest(input *GetAccountConfigurationInput) (req *request.Request, output *GetAccountConfigurationOutput)

GetAccountConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetAccountConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAccountConfiguration for more information on using the GetAccountConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAccountConfigurationRequest method.
req, resp := client.GetAccountConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetAccountConfiguration

func (*CodeGuruSecurity) GetAccountConfigurationWithContext

func (c *CodeGuruSecurity) GetAccountConfigurationWithContext(ctx aws.Context, input *GetAccountConfigurationInput, opts ...request.Option) (*GetAccountConfigurationOutput, error)

GetAccountConfigurationWithContext is the same as GetAccountConfiguration with the addition of the ability to pass a context and additional request options.

See GetAccountConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) GetFindings

func (c *CodeGuruSecurity) GetFindings(input *GetFindingsInput) (*GetFindingsOutput, error)

GetFindings API operation for Amazon CodeGuru Security.

Returns a list of all findings generated by a particular scan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation GetFindings for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

  • ResourceNotFoundException The resource specified in the request was not found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetFindings

func (*CodeGuruSecurity) GetFindingsPages

func (c *CodeGuruSecurity) GetFindingsPages(input *GetFindingsInput, fn func(*GetFindingsOutput, bool) bool) error

GetFindingsPages iterates over the pages of a GetFindings operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetFindings method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetFindings operation.
pageNum := 0
err := client.GetFindingsPages(params,
    func(page *codegurusecurity.GetFindingsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CodeGuruSecurity) GetFindingsPagesWithContext

func (c *CodeGuruSecurity) GetFindingsPagesWithContext(ctx aws.Context, input *GetFindingsInput, fn func(*GetFindingsOutput, bool) bool, opts ...request.Option) error

GetFindingsPagesWithContext same as GetFindingsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) GetFindingsRequest

func (c *CodeGuruSecurity) GetFindingsRequest(input *GetFindingsInput) (req *request.Request, output *GetFindingsOutput)

GetFindingsRequest generates a "aws/request.Request" representing the client's request for the GetFindings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFindings for more information on using the GetFindings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetFindingsRequest method.
req, resp := client.GetFindingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetFindings

func (*CodeGuruSecurity) GetFindingsWithContext

func (c *CodeGuruSecurity) GetFindingsWithContext(ctx aws.Context, input *GetFindingsInput, opts ...request.Option) (*GetFindingsOutput, error)

GetFindingsWithContext is the same as GetFindings with the addition of the ability to pass a context and additional request options.

See GetFindings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) GetMetricsSummary

func (c *CodeGuruSecurity) GetMetricsSummary(input *GetMetricsSummaryInput) (*GetMetricsSummaryOutput, error)

GetMetricsSummary API operation for Amazon CodeGuru Security.

Returns top level metrics about an account from a specified date, including number of open findings, the categories with most findings, the scans with most open findings, and scans with most open critical findings.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation GetMetricsSummary for usage and error information.

Returned Error Types:

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetMetricsSummary

func (*CodeGuruSecurity) GetMetricsSummaryRequest

func (c *CodeGuruSecurity) GetMetricsSummaryRequest(input *GetMetricsSummaryInput) (req *request.Request, output *GetMetricsSummaryOutput)

GetMetricsSummaryRequest generates a "aws/request.Request" representing the client's request for the GetMetricsSummary operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMetricsSummary for more information on using the GetMetricsSummary API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMetricsSummaryRequest method.
req, resp := client.GetMetricsSummaryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetMetricsSummary

func (*CodeGuruSecurity) GetMetricsSummaryWithContext

func (c *CodeGuruSecurity) GetMetricsSummaryWithContext(ctx aws.Context, input *GetMetricsSummaryInput, opts ...request.Option) (*GetMetricsSummaryOutput, error)

GetMetricsSummaryWithContext is the same as GetMetricsSummary with the addition of the ability to pass a context and additional request options.

See GetMetricsSummary for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) GetScan

func (c *CodeGuruSecurity) GetScan(input *GetScanInput) (*GetScanOutput, error)

GetScan API operation for Amazon CodeGuru Security.

Returns details about a scan, including whether or not a scan has completed.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation GetScan for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The resource specified in the request was not found.

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetScan

func (*CodeGuruSecurity) GetScanRequest

func (c *CodeGuruSecurity) GetScanRequest(input *GetScanInput) (req *request.Request, output *GetScanOutput)

GetScanRequest generates a "aws/request.Request" representing the client's request for the GetScan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetScan for more information on using the GetScan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetScanRequest method.
req, resp := client.GetScanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetScan

func (*CodeGuruSecurity) GetScanWithContext

func (c *CodeGuruSecurity) GetScanWithContext(ctx aws.Context, input *GetScanInput, opts ...request.Option) (*GetScanOutput, error)

GetScanWithContext is the same as GetScan with the addition of the ability to pass a context and additional request options.

See GetScan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) ListFindingsMetrics

func (c *CodeGuruSecurity) ListFindingsMetrics(input *ListFindingsMetricsInput) (*ListFindingsMetricsOutput, error)

ListFindingsMetrics API operation for Amazon CodeGuru Security.

Returns metrics about all findings in an account within a specified time range.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation ListFindingsMetrics for usage and error information.

Returned Error Types:

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetrics

func (*CodeGuruSecurity) ListFindingsMetricsPages

func (c *CodeGuruSecurity) ListFindingsMetricsPages(input *ListFindingsMetricsInput, fn func(*ListFindingsMetricsOutput, bool) bool) error

ListFindingsMetricsPages iterates over the pages of a ListFindingsMetrics operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFindingsMetrics method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFindingsMetrics operation.
pageNum := 0
err := client.ListFindingsMetricsPages(params,
    func(page *codegurusecurity.ListFindingsMetricsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CodeGuruSecurity) ListFindingsMetricsPagesWithContext

func (c *CodeGuruSecurity) ListFindingsMetricsPagesWithContext(ctx aws.Context, input *ListFindingsMetricsInput, fn func(*ListFindingsMetricsOutput, bool) bool, opts ...request.Option) error

ListFindingsMetricsPagesWithContext same as ListFindingsMetricsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) ListFindingsMetricsRequest

func (c *CodeGuruSecurity) ListFindingsMetricsRequest(input *ListFindingsMetricsInput) (req *request.Request, output *ListFindingsMetricsOutput)

ListFindingsMetricsRequest generates a "aws/request.Request" representing the client's request for the ListFindingsMetrics operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFindingsMetrics for more information on using the ListFindingsMetrics API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFindingsMetricsRequest method.
req, resp := client.ListFindingsMetricsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetrics

func (*CodeGuruSecurity) ListFindingsMetricsWithContext

func (c *CodeGuruSecurity) ListFindingsMetricsWithContext(ctx aws.Context, input *ListFindingsMetricsInput, opts ...request.Option) (*ListFindingsMetricsOutput, error)

ListFindingsMetricsWithContext is the same as ListFindingsMetrics with the addition of the ability to pass a context and additional request options.

See ListFindingsMetrics for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) ListScans

func (c *CodeGuruSecurity) ListScans(input *ListScansInput) (*ListScansOutput, error)

ListScans API operation for Amazon CodeGuru Security.

Returns a list of all the standard scans in an account. Does not return express scans.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation ListScans for usage and error information.

Returned Error Types:

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

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScans

func (*CodeGuruSecurity) ListScansPages

func (c *CodeGuruSecurity) ListScansPages(input *ListScansInput, fn func(*ListScansOutput, bool) bool) error

ListScansPages iterates over the pages of a ListScans operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListScans method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListScans operation.
pageNum := 0
err := client.ListScansPages(params,
    func(page *codegurusecurity.ListScansOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CodeGuruSecurity) ListScansPagesWithContext

func (c *CodeGuruSecurity) ListScansPagesWithContext(ctx aws.Context, input *ListScansInput, fn func(*ListScansOutput, bool) bool, opts ...request.Option) error

ListScansPagesWithContext same as ListScansPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) ListScansRequest

func (c *CodeGuruSecurity) ListScansRequest(input *ListScansInput) (req *request.Request, output *ListScansOutput)

ListScansRequest generates a "aws/request.Request" representing the client's request for the ListScans operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListScans for more information on using the ListScans API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListScansRequest method.
req, resp := client.ListScansRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScans

func (*CodeGuruSecurity) ListScansWithContext

func (c *CodeGuruSecurity) ListScansWithContext(ctx aws.Context, input *ListScansInput, opts ...request.Option) (*ListScansOutput, error)

ListScansWithContext is the same as ListScans with the addition of the ability to pass a context and additional request options.

See ListScans for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) ListTagsForResource

func (c *CodeGuruSecurity) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon CodeGuru Security.

Returns a list of all tags associated with a scan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

  • ResourceNotFoundException The resource specified in the request was not found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListTagsForResource

func (*CodeGuruSecurity) ListTagsForResourceRequest

func (c *CodeGuruSecurity) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListTagsForResource

func (*CodeGuruSecurity) ListTagsForResourceWithContext

func (c *CodeGuruSecurity) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) TagResource

func (c *CodeGuruSecurity) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon CodeGuru Security.

Use to add one or more tags to an existing scan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation TagResource for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

  • ResourceNotFoundException The resource specified in the request was not found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/TagResource

func (*CodeGuruSecurity) TagResourceRequest

func (c *CodeGuruSecurity) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/TagResource

func (*CodeGuruSecurity) TagResourceWithContext

func (c *CodeGuruSecurity) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) UntagResource

func (c *CodeGuruSecurity) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon CodeGuru Security.

Use to remove one or more tags from an existing scan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation UntagResource for usage and error information.

Returned Error Types:

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

  • ConflictException 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.

  • ResourceNotFoundException The resource specified in the request was not found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UntagResource

func (*CodeGuruSecurity) UntagResourceRequest

func (c *CodeGuruSecurity) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UntagResource

func (*CodeGuruSecurity) UntagResourceWithContext

func (c *CodeGuruSecurity) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CodeGuruSecurity) UpdateAccountConfiguration

UpdateAccountConfiguration API operation for Amazon CodeGuru Security.

Use to update account-level configuration with an encryption key.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CodeGuru Security's API operation UpdateAccountConfiguration for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The resource specified in the request was not found.

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the specified constraints.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfiguration

func (*CodeGuruSecurity) UpdateAccountConfigurationRequest

func (c *CodeGuruSecurity) UpdateAccountConfigurationRequest(input *UpdateAccountConfigurationInput) (req *request.Request, output *UpdateAccountConfigurationOutput)

UpdateAccountConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateAccountConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAccountConfiguration for more information on using the UpdateAccountConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAccountConfigurationRequest method.
req, resp := client.UpdateAccountConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfiguration

func (*CodeGuruSecurity) UpdateAccountConfigurationWithContext

func (c *CodeGuruSecurity) UpdateAccountConfigurationWithContext(ctx aws.Context, input *UpdateAccountConfigurationInput, opts ...request.Option) (*UpdateAccountConfigurationOutput, error)

UpdateAccountConfigurationWithContext is the same as UpdateAccountConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateAccountConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CodeLine

type CodeLine struct {

	// The code that contains a vulnerability.
	Content *string `locationName:"content" type:"string"`

	// The code line number.
	Number *int64 `locationName:"number" type:"integer"`
	// contains filtered or unexported fields
}

The line of code where a finding was detected.

func (CodeLine) GoString

func (s CodeLine) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CodeLine) SetContent

func (s *CodeLine) SetContent(v string) *CodeLine

SetContent sets the Content field's value.

func (*CodeLine) SetNumber

func (s *CodeLine) SetNumber(v int64) *CodeLine

SetNumber sets the Number field's value.

func (CodeLine) String

func (s CodeLine) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The identifier for the error.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The identifier for the service resource associated with the request.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of resource associated with the request.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// 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) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateScanInput

type CreateScanInput struct {

	// The type of analysis you want CodeGuru Security to perform in the scan, either
	// Security or All. The Security type only generates findings related to security.
	// The All type generates both security findings and quality findings. Defaults
	// to Security type if missing.
	AnalysisType *string `locationName:"analysisType" type:"string" enum:"AnalysisType"`

	// The idempotency token for the request. Amazon CodeGuru Security uses this
	// value to prevent the accidental creation of duplicate scans if there are
	// failures and retries.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The identifier for an input resource used to create a scan.
	//
	// ResourceId is a required field
	ResourceId *ResourceId `locationName:"resourceId" type:"structure" required:"true"`

	// The unique name that CodeGuru Security uses to track revisions across multiple
	// scans of the same resource. Only allowed for a STANDARD scan type. If not
	// specified, it will be auto generated.
	//
	// ScanName is a required field
	ScanName *string `locationName:"scanName" min:"1" type:"string" required:"true"`

	// The type of scan, either Standard or Express. Defaults to Standard type if
	// missing.
	//
	// Express scans run on limited resources and use a limited set of detectors
	// to analyze your code in near-real time. Standard scans have standard resource
	// limits and use the full set of detectors to analyze your code.
	ScanType *string `locationName:"scanType" type:"string" enum:"ScanType"`

	// An array of key-value pairs used to tag a scan. A tag is a custom attribute
	// label with two parts:
	//
	//    * A tag key. For example, CostCenter, Environment, or Secret. Tag keys
	//    are case sensitive.
	//
	//    * An optional tag value field. For example, 111122223333, Production,
	//    or a team name. Omitting the tag value is the same as using an empty string.
	//    Tag values are case sensitive.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateScanInput) GoString

func (s CreateScanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScanInput) SetAnalysisType

func (s *CreateScanInput) SetAnalysisType(v string) *CreateScanInput

SetAnalysisType sets the AnalysisType field's value.

func (*CreateScanInput) SetClientToken

func (s *CreateScanInput) SetClientToken(v string) *CreateScanInput

SetClientToken sets the ClientToken field's value.

func (*CreateScanInput) SetResourceId

func (s *CreateScanInput) SetResourceId(v *ResourceId) *CreateScanInput

SetResourceId sets the ResourceId field's value.

func (*CreateScanInput) SetScanName

func (s *CreateScanInput) SetScanName(v string) *CreateScanInput

SetScanName sets the ScanName field's value.

func (*CreateScanInput) SetScanType

func (s *CreateScanInput) SetScanType(v string) *CreateScanInput

SetScanType sets the ScanType field's value.

func (*CreateScanInput) SetTags

func (s *CreateScanInput) SetTags(v map[string]*string) *CreateScanInput

SetTags sets the Tags field's value.

func (CreateScanInput) String

func (s CreateScanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScanInput) Validate

func (s *CreateScanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateScanOutput

type CreateScanOutput struct {

	// The identifier for the resource object that contains resources that were
	// scanned.
	//
	// ResourceId is a required field
	ResourceId *ResourceId `locationName:"resourceId" type:"structure" required:"true"`

	// UUID that identifies the individual scan run.
	//
	// RunId is a required field
	RunId *string `locationName:"runId" type:"string" required:"true"`

	// The name of the scan.
	//
	// ScanName is a required field
	ScanName *string `locationName:"scanName" min:"1" type:"string" required:"true"`

	// The ARN for the scan name.
	ScanNameArn *string `locationName:"scanNameArn" min:"1" type:"string"`

	// The current state of the scan. Returns either InProgress, Successful, or
	// Failed.
	//
	// ScanState is a required field
	ScanState *string `locationName:"scanState" type:"string" required:"true" enum:"ScanState"`
	// contains filtered or unexported fields
}

func (CreateScanOutput) GoString

func (s CreateScanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScanOutput) SetResourceId

func (s *CreateScanOutput) SetResourceId(v *ResourceId) *CreateScanOutput

SetResourceId sets the ResourceId field's value.

func (*CreateScanOutput) SetRunId

func (s *CreateScanOutput) SetRunId(v string) *CreateScanOutput

SetRunId sets the RunId field's value.

func (*CreateScanOutput) SetScanName

func (s *CreateScanOutput) SetScanName(v string) *CreateScanOutput

SetScanName sets the ScanName field's value.

func (*CreateScanOutput) SetScanNameArn

func (s *CreateScanOutput) SetScanNameArn(v string) *CreateScanOutput

SetScanNameArn sets the ScanNameArn field's value.

func (*CreateScanOutput) SetScanState

func (s *CreateScanOutput) SetScanState(v string) *CreateScanOutput

SetScanState sets the ScanState field's value.

func (CreateScanOutput) String

func (s CreateScanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateUploadUrlInput

type CreateUploadUrlInput struct {

	// The name of the scan that will use the uploaded resource. CodeGuru Security
	// uses the unique scan name to track revisions across multiple scans of the
	// same resource. Use this scanName when you call CreateScan on the code resource
	// you upload to this URL.
	//
	// ScanName is a required field
	ScanName *string `locationName:"scanName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateUploadUrlInput) GoString

func (s CreateUploadUrlInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUploadUrlInput) SetScanName

SetScanName sets the ScanName field's value.

func (CreateUploadUrlInput) String

func (s CreateUploadUrlInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUploadUrlInput) Validate

func (s *CreateUploadUrlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateUploadUrlOutput

type CreateUploadUrlOutput struct {

	// The identifier for the uploaded code resource.
	//
	// CodeArtifactId is a required field
	CodeArtifactId *string `locationName:"codeArtifactId" type:"string" required:"true"`

	// A set of key-value pairs that contain the required headers when uploading
	// your resource.
	//
	// RequestHeaders is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUploadUrlOutput's
	// String and GoString methods.
	//
	// RequestHeaders is a required field
	RequestHeaders map[string]*string `locationName:"requestHeaders" type:"map" required:"true" sensitive:"true"`

	// A pre-signed S3 URL. You can upload the code file you want to scan and add
	// the required requestHeaders using any HTTP client.
	//
	// S3Url is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateUploadUrlOutput's
	// String and GoString methods.
	//
	// S3Url is a required field
	S3Url *string `locationName:"s3Url" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateUploadUrlOutput) GoString

func (s CreateUploadUrlOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUploadUrlOutput) SetCodeArtifactId

func (s *CreateUploadUrlOutput) SetCodeArtifactId(v string) *CreateUploadUrlOutput

SetCodeArtifactId sets the CodeArtifactId field's value.

func (*CreateUploadUrlOutput) SetRequestHeaders

func (s *CreateUploadUrlOutput) SetRequestHeaders(v map[string]*string) *CreateUploadUrlOutput

SetRequestHeaders sets the RequestHeaders field's value.

func (*CreateUploadUrlOutput) SetS3Url

SetS3Url sets the S3Url field's value.

func (CreateUploadUrlOutput) String

func (s CreateUploadUrlOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `locationName:"kmsKeyArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about account-level configuration.

func (EncryptionConfig) GoString

func (s EncryptionConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfig) SetKmsKeyArn

func (s *EncryptionConfig) SetKmsKeyArn(v string) *EncryptionConfig

SetKmsKeyArn sets the KmsKeyArn field's value.

func (EncryptionConfig) String

func (s EncryptionConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfig) Validate

func (s *EncryptionConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FilePath

type FilePath struct {

	// A list of CodeLine objects that describe where the security vulnerability
	// appears in your code.
	CodeSnippet []*CodeLine `locationName:"codeSnippet" type:"list"`

	// The last line number of the code snippet where the security vulnerability
	// appears in your code.
	EndLine *int64 `locationName:"endLine" type:"integer"`

	// The name of the file.
	Name *string `locationName:"name" type:"string"`

	// The path to the resource with the security vulnerability.
	Path *string `locationName:"path" type:"string"`

	// The first line number of the code snippet where the security vulnerability
	// appears in your code.
	StartLine *int64 `locationName:"startLine" type:"integer"`
	// contains filtered or unexported fields
}

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

func (FilePath) GoString

func (s FilePath) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FilePath) SetCodeSnippet

func (s *FilePath) SetCodeSnippet(v []*CodeLine) *FilePath

SetCodeSnippet sets the CodeSnippet field's value.

func (*FilePath) SetEndLine

func (s *FilePath) SetEndLine(v int64) *FilePath

SetEndLine sets the EndLine field's value.

func (*FilePath) SetName

func (s *FilePath) SetName(v string) *FilePath

SetName sets the Name field's value.

func (*FilePath) SetPath

func (s *FilePath) SetPath(v string) *FilePath

SetPath sets the Path field's value.

func (*FilePath) SetStartLine

func (s *FilePath) SetStartLine(v int64) *FilePath

SetStartLine sets the StartLine field's value.

func (FilePath) String

func (s FilePath) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Finding

type Finding struct {

	// The time when the finding was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// A description of the finding.
	Description *string `locationName:"description" type:"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 `locationName:"detectorId" type:"string"`

	// The name of the detector that identified the security vulnerability in your
	// code.
	DetectorName *string `locationName:"detectorName" type:"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 `locationName:"detectorTags" type:"list"`

	// The identifier for the component that generated a finding such as AWSCodeGuruSecurity
	// or AWSInspector.
	GeneratorId *string `locationName:"generatorId" type:"string"`

	// The identifier for a finding.
	Id *string `locationName:"id" type:"string"`

	// An object that contains the details about how to remediate a finding.
	Remediation *Remediation `locationName:"remediation" type:"structure"`

	// The resource where Amazon CodeGuru Security detected a finding.
	Resource *Resource `locationName:"resource" type:"structure"`

	// The identifier for the rule that generated the finding.
	RuleId *string `locationName:"ruleId" type:"string"`

	// The severity of the finding.
	Severity *string `locationName:"severity" type:"string" enum:"Severity"`

	// The status of the finding. A finding status can be open or closed.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// The title of the finding.
	Title *string `locationName:"title" type:"string"`

	// The type of finding.
	Type *string `locationName:"type" 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 `locationName:"updatedAt" type:"timestamp"`

	// An object that describes the detected security vulnerability.
	Vulnerability *Vulnerability `locationName:"vulnerability" type:"structure"`
	// contains filtered or unexported fields
}

Information about a finding that was detected in your code.

func (Finding) GoString

func (s Finding) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Finding) SetCreatedAt

func (s *Finding) SetCreatedAt(v time.Time) *Finding

SetCreatedAt sets the CreatedAt field's value.

func (*Finding) SetDescription

func (s *Finding) SetDescription(v string) *Finding

SetDescription sets the Description field's value.

func (*Finding) SetDetectorId

func (s *Finding) SetDetectorId(v string) *Finding

SetDetectorId sets the DetectorId field's value.

func (*Finding) SetDetectorName

func (s *Finding) SetDetectorName(v string) *Finding

SetDetectorName sets the DetectorName field's value.

func (*Finding) SetDetectorTags

func (s *Finding) SetDetectorTags(v []*string) *Finding

SetDetectorTags sets the DetectorTags field's value.

func (*Finding) SetGeneratorId

func (s *Finding) SetGeneratorId(v string) *Finding

SetGeneratorId sets the GeneratorId field's value.

func (*Finding) SetId

func (s *Finding) SetId(v string) *Finding

SetId sets the Id field's value.

func (*Finding) SetRemediation

func (s *Finding) SetRemediation(v *Remediation) *Finding

SetRemediation sets the Remediation field's value.

func (*Finding) SetResource

func (s *Finding) SetResource(v *Resource) *Finding

SetResource sets the Resource field's value.

func (*Finding) SetRuleId

func (s *Finding) SetRuleId(v string) *Finding

SetRuleId sets the RuleId field's value.

func (*Finding) SetSeverity

func (s *Finding) SetSeverity(v string) *Finding

SetSeverity sets the Severity field's value.

func (*Finding) SetStatus

func (s *Finding) SetStatus(v string) *Finding

SetStatus sets the Status field's value.

func (*Finding) SetTitle

func (s *Finding) SetTitle(v string) *Finding

SetTitle sets the Title field's value.

func (*Finding) SetType

func (s *Finding) SetType(v string) *Finding

SetType sets the Type field's value.

func (*Finding) SetUpdatedAt

func (s *Finding) SetUpdatedAt(v time.Time) *Finding

SetUpdatedAt sets the UpdatedAt field's value.

func (*Finding) SetVulnerability

func (s *Finding) SetVulnerability(v *Vulnerability) *Finding

SetVulnerability sets the Vulnerability field's value.

func (Finding) String

func (s Finding) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FindingIdentifier

type FindingIdentifier struct {

	// The identifier for a finding.
	//
	// FindingId is a required field
	FindingId *string `locationName:"findingId" type:"string" required:"true"`

	// The name of the scan that generated the finding.
	//
	// ScanName is a required field
	ScanName *string `locationName:"scanName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (FindingIdentifier) GoString

func (s FindingIdentifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingIdentifier) SetFindingId

func (s *FindingIdentifier) SetFindingId(v string) *FindingIdentifier

SetFindingId sets the FindingId field's value.

func (*FindingIdentifier) SetScanName

func (s *FindingIdentifier) SetScanName(v string) *FindingIdentifier

SetScanName sets the ScanName field's value.

func (FindingIdentifier) String

func (s FindingIdentifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingIdentifier) Validate

func (s *FindingIdentifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FindingMetricsValuePerSeverity

type FindingMetricsValuePerSeverity struct {

	// The severity of the finding is critical and should be addressed immediately.
	Critical *float64 `locationName:"critical" type:"double"`

	// The severity of the finding is high and should be addressed as a near-term
	// priority.
	High *float64 `locationName:"high" type:"double"`

	// The finding is related to quality or readability improvements and not considered
	// actionable.
	Info *float64 `locationName:"info" type:"double"`

	// The severity of the finding is low and does require action on its own.
	Low *float64 `locationName:"low" type:"double"`

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

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

func (FindingMetricsValuePerSeverity) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FindingMetricsValuePerSeverity) SetCritical

SetCritical sets the Critical field's value.

func (*FindingMetricsValuePerSeverity) SetHigh

SetHigh sets the High field's value.

func (*FindingMetricsValuePerSeverity) SetInfo

SetInfo sets the Info field's value.

func (*FindingMetricsValuePerSeverity) SetLow

SetLow sets the Low field's value.

func (*FindingMetricsValuePerSeverity) SetMedium

SetMedium sets the Medium field's value.

func (FindingMetricsValuePerSeverity) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAccountConfigurationInput

type GetAccountConfigurationInput struct {
	// contains filtered or unexported fields
}

func (GetAccountConfigurationInput) GoString

func (s GetAccountConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetAccountConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAccountConfigurationOutput

type GetAccountConfigurationOutput struct {

	// An EncryptionConfig object that contains the KMS key ARN to use for encryption.
	// By default, CodeGuru Security uses an AWS-managed key for encryption. To
	// specify your own key, call UpdateAccountConfiguration.
	//
	// EncryptionConfig is a required field
	EncryptionConfig *EncryptionConfig `locationName:"encryptionConfig" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAccountConfigurationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAccountConfigurationOutput) SetEncryptionConfig

SetEncryptionConfig sets the EncryptionConfig field's value.

func (GetAccountConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetFindingsInput

type GetFindingsInput struct {

	// The maximum number of results to return in the response. Use this parameter
	// when paginating results. If additional results exist beyond the number you
	// specify, the nextToken element is returned in the response. Use nextToken
	// in a subsequent request to retrieve additional results.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token to use for paginating results that are returned in the response.
	// Set the value of this parameter to null for the first request. For subsequent
	// calls, use the nextToken value returned from the previous request to continue
	// listing results after the first page.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The name of the scan you want to retrieve findings from.
	//
	// ScanName is a required field
	ScanName *string `location:"uri" locationName:"scanName" min:"1" type:"string" required:"true"`

	// The status of the findings you want to get. Pass either Open, Closed, or
	// All.
	Status *string `location:"querystring" locationName:"status" type:"string" enum:"Status"`
	// contains filtered or unexported fields
}

func (GetFindingsInput) GoString

func (s GetFindingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingsInput) SetMaxResults

func (s *GetFindingsInput) SetMaxResults(v int64) *GetFindingsInput

SetMaxResults sets the MaxResults field's value.

func (*GetFindingsInput) SetNextToken

func (s *GetFindingsInput) SetNextToken(v string) *GetFindingsInput

SetNextToken sets the NextToken field's value.

func (*GetFindingsInput) SetScanName

func (s *GetFindingsInput) SetScanName(v string) *GetFindingsInput

SetScanName sets the ScanName field's value.

func (*GetFindingsInput) SetStatus

func (s *GetFindingsInput) SetStatus(v string) *GetFindingsInput

SetStatus sets the Status field's value.

func (GetFindingsInput) String

func (s GetFindingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingsInput) Validate

func (s *GetFindingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFindingsOutput

type GetFindingsOutput struct {

	// A list of findings generated by the specified scan.
	Findings []*Finding `locationName:"findings" type:"list"`

	// A pagination token. You can use this in future calls to GetFindings to continue
	// listing results after the current page.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetFindingsOutput) GoString

func (s GetFindingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetFindingsOutput) SetFindings

func (s *GetFindingsOutput) SetFindings(v []*Finding) *GetFindingsOutput

SetFindings sets the Findings field's value.

func (*GetFindingsOutput) SetNextToken

func (s *GetFindingsOutput) SetNextToken(v string) *GetFindingsOutput

SetNextToken sets the NextToken field's value.

func (GetFindingsOutput) String

func (s GetFindingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMetricsSummaryInput

type GetMetricsSummaryInput struct {

	// The date you want to retrieve summary metrics from, rounded to the nearest
	// day. The date must be within the past two years since metrics data is only
	// stored for two years. If a date outside of this range is passed, the response
	// will be empty.
	//
	// Date is a required field
	Date *time.Time `location:"querystring" locationName:"date" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (GetMetricsSummaryInput) GoString

func (s GetMetricsSummaryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMetricsSummaryInput) SetDate

SetDate sets the Date field's value.

func (GetMetricsSummaryInput) String

func (s GetMetricsSummaryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMetricsSummaryInput) Validate

func (s *GetMetricsSummaryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMetricsSummaryOutput

type GetMetricsSummaryOutput struct {

	// The summary metrics from the specified date.
	MetricsSummary *MetricsSummary `locationName:"metricsSummary" type:"structure"`
	// contains filtered or unexported fields
}

func (GetMetricsSummaryOutput) GoString

func (s GetMetricsSummaryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMetricsSummaryOutput) SetMetricsSummary

SetMetricsSummary sets the MetricsSummary field's value.

func (GetMetricsSummaryOutput) String

func (s GetMetricsSummaryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetScanInput

type GetScanInput struct {

	// UUID that identifies the individual scan run you want to view details about.
	// You retrieve this when you call the CreateScan operation. Defaults to the
	// latest scan run if missing.
	RunId *string `location:"querystring" locationName:"runId" type:"string"`

	// The name of the scan you want to view details about.
	//
	// ScanName is a required field
	ScanName *string `location:"uri" locationName:"scanName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetScanInput) GoString

func (s GetScanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetScanInput) SetRunId

func (s *GetScanInput) SetRunId(v string) *GetScanInput

SetRunId sets the RunId field's value.

func (*GetScanInput) SetScanName

func (s *GetScanInput) SetScanName(v string) *GetScanInput

SetScanName sets the ScanName field's value.

func (GetScanInput) String

func (s GetScanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetScanInput) Validate

func (s *GetScanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetScanOutput

type GetScanOutput struct {

	// The type of analysis CodeGuru Security performed in the scan, either Security
	// or All. The Security type only generates findings related to security. The
	// All type generates both security findings and quality findings.
	//
	// AnalysisType is a required field
	AnalysisType *string `locationName:"analysisType" type:"string" required:"true" enum:"AnalysisType"`

	// The time the scan was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The number of times a scan has been re-run on a revised resource.
	NumberOfRevisions *int64 `locationName:"numberOfRevisions" type:"long"`

	// UUID that identifies the individual scan run.
	//
	// RunId is a required field
	RunId *string `locationName:"runId" type:"string" required:"true"`

	// The name of the scan.
	//
	// ScanName is a required field
	ScanName *string `locationName:"scanName" min:"1" type:"string" required:"true"`

	// The ARN for the scan name.
	ScanNameArn *string `locationName:"scanNameArn" min:"1" type:"string"`

	// The current state of the scan. Pass either InProgress, Successful, or Failed.
	//
	// ScanState is a required field
	ScanState *string `locationName:"scanState" type:"string" required:"true" enum:"ScanState"`

	// The time when the scan was last updated. Only available for STANDARD scan
	// types.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetScanOutput) GoString

func (s GetScanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetScanOutput) SetAnalysisType

func (s *GetScanOutput) SetAnalysisType(v string) *GetScanOutput

SetAnalysisType sets the AnalysisType field's value.

func (*GetScanOutput) SetCreatedAt

func (s *GetScanOutput) SetCreatedAt(v time.Time) *GetScanOutput

SetCreatedAt sets the CreatedAt field's value.

func (*GetScanOutput) SetNumberOfRevisions

func (s *GetScanOutput) SetNumberOfRevisions(v int64) *GetScanOutput

SetNumberOfRevisions sets the NumberOfRevisions field's value.

func (*GetScanOutput) SetRunId

func (s *GetScanOutput) SetRunId(v string) *GetScanOutput

SetRunId sets the RunId field's value.

func (*GetScanOutput) SetScanName

func (s *GetScanOutput) SetScanName(v string) *GetScanOutput

SetScanName sets the ScanName field's value.

func (*GetScanOutput) SetScanNameArn

func (s *GetScanOutput) SetScanNameArn(v string) *GetScanOutput

SetScanNameArn sets the ScanNameArn field's value.

func (*GetScanOutput) SetScanState

func (s *GetScanOutput) SetScanState(v string) *GetScanOutput

SetScanState sets the ScanState field's value.

func (*GetScanOutput) SetUpdatedAt

func (s *GetScanOutput) SetUpdatedAt(v time.Time) *GetScanOutput

SetUpdatedAt sets the UpdatedAt field's value.

func (GetScanOutput) String

func (s GetScanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The internal error encountered by the server.
	Error_ *string `locationName:"error" type:"string"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFindingsMetricsInput

type ListFindingsMetricsInput struct {

	// The end date of the interval which you want to retrieve metrics from.
	//
	// EndDate is a required field
	EndDate *time.Time `location:"querystring" locationName:"endDate" type:"timestamp" required:"true"`

	// The maximum number of results to return in the response. Use this parameter
	// when paginating results. If additional results exist beyond the number you
	// specify, the nextToken element is returned in the response. Use nextToken
	// in a subsequent request to retrieve additional results.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token to use for paginating results that are returned in the response.
	// Set the value of this parameter to null for the first request. For subsequent
	// calls, use the nextToken value returned from the previous request to continue
	// listing results after the first page.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The start date of the interval which you want to retrieve metrics from.
	//
	// StartDate is a required field
	StartDate *time.Time `location:"querystring" locationName:"startDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (ListFindingsMetricsInput) GoString

func (s ListFindingsMetricsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFindingsMetricsInput) SetEndDate

SetEndDate sets the EndDate field's value.

func (*ListFindingsMetricsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListFindingsMetricsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListFindingsMetricsInput) SetStartDate

SetStartDate sets the StartDate field's value.

func (ListFindingsMetricsInput) String

func (s ListFindingsMetricsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFindingsMetricsInput) Validate

func (s *ListFindingsMetricsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFindingsMetricsOutput

type ListFindingsMetricsOutput struct {

	// A list of AccountFindingsMetric objects retrieved from the specified time
	// interval.
	FindingsMetrics []*AccountFindingsMetric `locationName:"findingsMetrics" type:"list"`

	// A pagination token. You can use this in future calls to ListFindingMetrics
	// to continue listing results after the current page.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFindingsMetricsOutput) GoString

func (s ListFindingsMetricsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFindingsMetricsOutput) SetFindingsMetrics

SetFindingsMetrics sets the FindingsMetrics field's value.

func (*ListFindingsMetricsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFindingsMetricsOutput) String

func (s ListFindingsMetricsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListScansInput

type ListScansInput struct {

	// The maximum number of results to return in the response. Use this parameter
	// when paginating results. If additional results exist beyond the number you
	// specify, the nextToken element is returned in the response. Use nextToken
	// in a subsequent request to retrieve additional results.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token to use for paginating results that are returned in the response.
	// Set the value of this parameter to null for the first request. For subsequent
	// calls, use the nextToken value returned from the previous request to continue
	// listing results after the first page.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListScansInput) GoString

func (s ListScansInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScansInput) SetMaxResults

func (s *ListScansInput) SetMaxResults(v int64) *ListScansInput

SetMaxResults sets the MaxResults field's value.

func (*ListScansInput) SetNextToken

func (s *ListScansInput) SetNextToken(v string) *ListScansInput

SetNextToken sets the NextToken field's value.

func (ListScansInput) String

func (s ListScansInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScansInput) Validate

func (s *ListScansInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListScansOutput

type ListScansOutput struct {

	// A pagination token. You can use this in future calls to ListScans to continue
	// listing results after the current page.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of ScanSummary objects with information about all scans in an account.
	Summaries []*ScanSummary `locationName:"summaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListScansOutput) GoString

func (s ListScansOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScansOutput) SetNextToken

func (s *ListScansOutput) SetNextToken(v string) *ListScansOutput

SetNextToken sets the NextToken field's value.

func (*ListScansOutput) SetSummaries

func (s *ListScansOutput) SetSummaries(v []*ScanSummary) *ListScansOutput

SetSummaries sets the Summaries field's value.

func (ListScansOutput) String

func (s ListScansOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The ARN of the ScanName object. You can retrieve this ARN by calling ListScans
	// or GetScan.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// An array of key-value pairs used to tag an existing scan. A tag is a custom
	// attribute label with two parts:
	//
	//    * A tag key. For example, CostCenter, Environment, or Secret. Tag keys
	//    are case sensitive.
	//
	//    * An optional tag value field. For example, 111122223333, Production,
	//    or a team name. Omitting the tag value is the same as using an empty string.
	//    Tag values are case sensitive.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `locationName:"categoriesWithMostFindings" type:"list"`

	// The date from which the metrics summary information was retrieved.
	Date *time.Time `locationName:"date" type:"timestamp"`

	// The number of open findings of each severity in an account.
	OpenFindings *FindingMetricsValuePerSeverity `locationName:"openFindings" type:"structure"`

	// A list of ScanNameWithFindingNum objects for the top 3 scans with the most
	// number of open findings in an account.
	ScansWithMostOpenCriticalFindings []*ScanNameWithFindingNum `locationName:"scansWithMostOpenCriticalFindings" type:"list"`

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

Information about summary metrics in an account.

func (MetricsSummary) GoString

func (s MetricsSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricsSummary) SetCategoriesWithMostFindings

func (s *MetricsSummary) SetCategoriesWithMostFindings(v []*CategoryWithFindingNum) *MetricsSummary

SetCategoriesWithMostFindings sets the CategoriesWithMostFindings field's value.

func (*MetricsSummary) SetDate

func (s *MetricsSummary) SetDate(v time.Time) *MetricsSummary

SetDate sets the Date field's value.

func (*MetricsSummary) SetOpenFindings

SetOpenFindings sets the OpenFindings field's value.

func (*MetricsSummary) SetScansWithMostOpenCriticalFindings

func (s *MetricsSummary) SetScansWithMostOpenCriticalFindings(v []*ScanNameWithFindingNum) *MetricsSummary

SetScansWithMostOpenCriticalFindings sets the ScansWithMostOpenCriticalFindings field's value.

func (*MetricsSummary) SetScansWithMostOpenFindings

func (s *MetricsSummary) SetScansWithMostOpenFindings(v []*ScanNameWithFindingNum) *MetricsSummary

SetScansWithMostOpenFindings sets the ScansWithMostOpenFindings field's value.

func (MetricsSummary) String

func (s MetricsSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Recommendation

type Recommendation struct {

	// The recommended course of action to remediate the finding.
	Text *string `locationName:"text" type:"string"`

	// The URL address to the recommendation for remediating the finding.
	Url *string `locationName:"url" type:"string"`
	// contains filtered or unexported fields
}

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

func (Recommendation) GoString

func (s Recommendation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Recommendation) SetText

func (s *Recommendation) SetText(v string) *Recommendation

SetText sets the Text field's value.

func (*Recommendation) SetUrl

func (s *Recommendation) SetUrl(v string) *Recommendation

SetUrl sets the Url field's value.

func (Recommendation) String

func (s Recommendation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Remediation

type Remediation struct {

	// An object that contains information about the recommended course of action
	// to remediate a finding.
	Recommendation *Recommendation `locationName:"recommendation" type:"structure"`

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

Information about how to remediate a finding.

func (Remediation) GoString

func (s Remediation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Remediation) SetRecommendation

func (s *Remediation) SetRecommendation(v *Recommendation) *Remediation

SetRecommendation sets the Recommendation field's value.

func (*Remediation) SetSuggestedFixes

func (s *Remediation) SetSuggestedFixes(v []*SuggestedFix) *Remediation

SetSuggestedFixes sets the SuggestedFixes field's value.

func (Remediation) String

func (s Remediation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Resource

type Resource struct {

	// The identifier for the resource.
	Id *string `locationName:"id" type:"string"`

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

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

func (Resource) GoString

func (s Resource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Resource) SetId

func (s *Resource) SetId(v string) *Resource

SetId sets the Id field's value.

func (*Resource) SetSubResourceId

func (s *Resource) SetSubResourceId(v string) *Resource

SetSubResourceId sets the SubResourceId field's value.

func (Resource) String

func (s Resource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceId

type ResourceId struct {

	// The identifier for the code file uploaded to the resource where a finding
	// was detected.
	CodeArtifactId *string `locationName:"codeArtifactId" type:"string"`
	// contains filtered or unexported fields
}

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

func (ResourceId) GoString

func (s ResourceId) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceId) SetCodeArtifactId

func (s *ResourceId) SetCodeArtifactId(v string) *ResourceId

SetCodeArtifactId sets the CodeArtifactId field's value.

func (ResourceId) String

func (s ResourceId) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The identifier for the error.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The identifier for the resource that was not found.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of resource that was not found.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The resource specified in the request was not found.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScanNameWithFindingNum

type ScanNameWithFindingNum struct {

	// The number of open findings generated by a scan.
	FindingNumber *int64 `locationName:"findingNumber" type:"integer"`

	// The name of the scan.
	ScanName *string `locationName:"scanName" type:"string"`
	// contains filtered or unexported fields
}

Information about a scan with open findings.

func (ScanNameWithFindingNum) GoString

func (s ScanNameWithFindingNum) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScanNameWithFindingNum) SetFindingNumber

func (s *ScanNameWithFindingNum) SetFindingNumber(v int64) *ScanNameWithFindingNum

SetFindingNumber sets the FindingNumber field's value.

func (*ScanNameWithFindingNum) SetScanName

SetScanName sets the ScanName field's value.

func (ScanNameWithFindingNum) String

func (s ScanNameWithFindingNum) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScanSummary

type ScanSummary struct {

	// The time when the scan was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The identifier for the scan run.
	//
	// RunId is a required field
	RunId *string `locationName:"runId" type:"string" required:"true"`

	// The name of the scan.
	//
	// ScanName is a required field
	ScanName *string `locationName:"scanName" min:"1" type:"string" required:"true"`

	// The ARN for the scan name.
	ScanNameArn *string `locationName:"scanNameArn" min:"1" type:"string"`

	// The state of the scan. A scan can be In Progress, Complete, or Failed.
	//
	// ScanState is a required field
	ScanState *string `locationName:"scanState" type:"string" required:"true" enum:"ScanState"`

	// The time the scan was last updated. A scan is updated when it is re-run.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

Information about a scan.

func (ScanSummary) GoString

func (s ScanSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScanSummary) SetCreatedAt

func (s *ScanSummary) SetCreatedAt(v time.Time) *ScanSummary

SetCreatedAt sets the CreatedAt field's value.

func (*ScanSummary) SetRunId

func (s *ScanSummary) SetRunId(v string) *ScanSummary

SetRunId sets the RunId field's value.

func (*ScanSummary) SetScanName

func (s *ScanSummary) SetScanName(v string) *ScanSummary

SetScanName sets the ScanName field's value.

func (*ScanSummary) SetScanNameArn

func (s *ScanSummary) SetScanNameArn(v string) *ScanSummary

SetScanNameArn sets the ScanNameArn field's value.

func (*ScanSummary) SetScanState

func (s *ScanSummary) SetScanState(v string) *ScanSummary

SetScanState sets the ScanState field's value.

func (*ScanSummary) SetUpdatedAt

func (s *ScanSummary) SetUpdatedAt(v time.Time) *ScanSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (ScanSummary) String

func (s ScanSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuggestedFix

type SuggestedFix struct {

	// The suggested code to add to your file.
	Code *string `locationName:"code" type:"string"`

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

Information about the suggested code fix to remediate a finding.

func (SuggestedFix) GoString

func (s SuggestedFix) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuggestedFix) SetCode

func (s *SuggestedFix) SetCode(v string) *SuggestedFix

SetCode sets the Code field's value.

func (*SuggestedFix) SetDescription

func (s *SuggestedFix) SetDescription(v string) *SuggestedFix

SetDescription sets the Description field's value.

func (SuggestedFix) String

func (s SuggestedFix) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

	// The ARN of the ScanName object. You can retrieve this ARN by calling ListScans
	// or GetScan.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// An array of key-value pairs used to tag an existing scan. A tag is a custom
	// attribute label with two parts:
	//
	//    * A tag key. For example, CostCenter, Environment, or Secret. Tag keys
	//    are case sensitive.
	//
	//    * An optional tag value field. For example, 111122223333, Production,
	//    or a team name. Omitting the tag value is the same as using an empty string.
	//    Tag values are case sensitive.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The identifier for the error.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The identifier for the originating quota.
	QuotaCode *string `locationName:"quotaCode" type:"string"`

	// The identifier for the originating service.
	ServiceCode *string `locationName:"serviceCode" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the ScanName object. You can retrieve this ARN by calling ListScans
	// or GetScan.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of keys for each tag you want to remove from a scan.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAccountConfigurationInput

type UpdateAccountConfigurationInput struct {

	// The KMS key ARN you want to use for encryption. Defaults to service-side
	// encryption if missing.
	//
	// EncryptionConfig is a required field
	EncryptionConfig *EncryptionConfig `locationName:"encryptionConfig" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAccountConfigurationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountConfigurationInput) SetEncryptionConfig

SetEncryptionConfig sets the EncryptionConfig field's value.

func (UpdateAccountConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountConfigurationInput) Validate

func (s *UpdateAccountConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAccountConfigurationOutput

type UpdateAccountConfigurationOutput struct {

	// An EncryptionConfig object that contains the KMS key ARN to use for encryption.
	//
	// EncryptionConfig is a required field
	EncryptionConfig *EncryptionConfig `locationName:"encryptionConfig" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAccountConfigurationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccountConfigurationOutput) SetEncryptionConfig

SetEncryptionConfig sets the EncryptionConfig field's value.

func (UpdateAccountConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The identifier for the error.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true"`

	// The field that caused the error, if applicable.
	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The reason the request failed validation.
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The input fails to satisfy the specified constraints.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField

type ValidationExceptionField struct {

	// Describes the exception.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the exception.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a validation exception.

func (ValidationExceptionField) GoString

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName

SetName sets the Name field's value.

func (ValidationExceptionField) String

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Vulnerability

type Vulnerability struct {

	// An object that describes the location of the detected security vulnerability
	// in your code.
	FilePath *FilePath `locationName:"filePath" type:"structure"`

	// The identifier for the vulnerability.
	Id *string `locationName:"id" type:"string"`

	// The number of times the vulnerability appears in your code.
	ItemCount *int64 `locationName:"itemCount" type:"integer"`

	// One or more URL addresses that contain details about a vulnerability.
	ReferenceUrls []*string `locationName:"referenceUrls" type:"list"`

	// One or more vulnerabilities that are related to the vulnerability being described.
	RelatedVulnerabilities []*string `locationName:"relatedVulnerabilities" type:"list"`
	// contains filtered or unexported fields
}

Information about a security vulnerability that Amazon CodeGuru Security detected.

func (Vulnerability) GoString

func (s Vulnerability) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Vulnerability) SetFilePath

func (s *Vulnerability) SetFilePath(v *FilePath) *Vulnerability

SetFilePath sets the FilePath field's value.

func (*Vulnerability) SetId

func (s *Vulnerability) SetId(v string) *Vulnerability

SetId sets the Id field's value.

func (*Vulnerability) SetItemCount

func (s *Vulnerability) SetItemCount(v int64) *Vulnerability

SetItemCount sets the ItemCount field's value.

func (*Vulnerability) SetReferenceUrls

func (s *Vulnerability) SetReferenceUrls(v []*string) *Vulnerability

SetReferenceUrls sets the ReferenceUrls field's value.

func (*Vulnerability) SetRelatedVulnerabilities

func (s *Vulnerability) SetRelatedVulnerabilities(v []*string) *Vulnerability

SetRelatedVulnerabilities sets the RelatedVulnerabilities field's value.

func (Vulnerability) String

func (s Vulnerability) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package codegurusecurityiface provides an interface to enable mocking the Amazon CodeGuru Security service client for testing your code.
Package codegurusecurityiface provides an interface to enable mocking the Amazon CodeGuru Security service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL