AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Evaluation

import "github.com/aws/aws-sdk-go/service/configservice"

type Evaluation struct { Annotation *string `min:"1" type:"string"` ComplianceResourceId *string `min:"1" type:"string" required:"true"` ComplianceResourceType *string `min:"1" type:"string" required:"true"` ComplianceType *string `type:"string" required:"true" enum:"ComplianceType"` OrderingTimestamp *time.Time `type:"timestamp" required:"true"` }

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

Annotation

Type: *string

Supplementary information about how the evaluation determined the compliance.

ComplianceResourceId

Type: *string

The ID of the AWS resource that was evaluated.

ComplianceResourceId is a required field

ComplianceResourceType

Type: *string

The type of AWS resource that was evaluated.

ComplianceResourceType is a required field

ComplianceType

Type: *string

Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom AWS Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

ComplianceType is a required field

OrderingTimestamp

Type: *time.Time

The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

OrderingTimestamp is a required field

Method

GoString

func (s Evaluation) GoString() string

GoString returns the string representation

SetAnnotation

func (s *Evaluation) SetAnnotation(v string) *Evaluation

SetAnnotation sets the Annotation field's value.

SetComplianceResourceId

func (s *Evaluation) SetComplianceResourceId(v string) *Evaluation

SetComplianceResourceId sets the ComplianceResourceId field's value.

SetComplianceResourceType

func (s *Evaluation) SetComplianceResourceType(v string) *Evaluation

SetComplianceResourceType sets the ComplianceResourceType field's value.

SetComplianceType

func (s *Evaluation) SetComplianceType(v string) *Evaluation

SetComplianceType sets the ComplianceType field's value.

SetOrderingTimestamp

func (s *Evaluation) SetOrderingTimestamp(v time.Time) *Evaluation

SetOrderingTimestamp sets the OrderingTimestamp field's value.

String

func (s Evaluation) String() string

String returns the string representation

Validate

func (s *Evaluation) Validate() error

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

On this page: