types

package
Version: v1.6.1 Latest Latest
Warning

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

Go to latest
Published: Sep 17, 2021 License: Apache-2.0 Imports: 4 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdvancedEventSelector added in v0.31.0

type AdvancedEventSelector struct {

	// Contains all selector statements in an advanced event selector.
	//
	// This member is required.
	FieldSelectors []AdvancedFieldSelector

	// An optional, descriptive name for an advanced event selector, such as "Log data
	// events for only two S3 buckets".
	Name *string
	// contains filtered or unexported fields
}

Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html) in the CloudTrail User Guide.

* readOnly

* eventSource

* eventName

* eventCategory

* resources.type

* resources.ARN

You cannot apply both event selectors and advanced event selectors to a trail.

type AdvancedFieldSelector added in v0.31.0

type AdvancedFieldSelector struct {

	// A field in an event record on which to filter events to be logged. Supported
	// fields include readOnly, eventCategory, eventSource (for management events),
	// eventName, resources.type, and resources.ARN.
	//
	// * readOnly - Optional. Can be set
	// to Equals a value of true or false. A value of false logs both read and write
	// events.
	//
	// * eventSource - For filtering management events only. This can be set
	// only to NotEqualskms.amazonaws.com.
	//
	// * eventName - Can use any operator. You can
	// use it to filter in or filter out any data event logged to CloudTrail, such as
	// PutBucket or GetSnapshotBlock. You can have multiple values for this field,
	// separated by commas.
	//
	// * eventCategory - This is required. It must be set to
	// Equals, and the value must be Management or Data.
	//
	// * resources.type - This field
	// is required. resources.type can only use the Equals operator, and the value can
	// be one of the following: AWS::S3::Object, AWS::S3::AccessPoint,
	// AWS::Lambda::Function, AWS::DynamoDB::Table, AWS::S3Outposts::Object,
	// AWS::ManagedBlockchain::Node, AWS::S3ObjectLambda::AccessPoint, or
	// AWS::EC2::Snapshot. You can have only one resources.type field per selector. To
	// log data events on more than one resource type, add another selector.
	//
	// *
	// resources.ARN - You can use any operator with resources.ARN, but if you use
	// Equals or NotEquals, the value must exactly match the ARN of a valid resource of
	// the type you've specified in the template as the value of resources.type. For
	// example, if resources.type equals AWS::S3::Object, the ARN must be in one of the
	// following formats. To log all data events for all objects in a specific S3
	// bucket, use the StartsWith operator, and include only the bucket ARN as the
	// matching value. The trailing slash is intentional; do not exclude it. Replace
	// the text between less than and greater than symbols (<>) with resource-specific
	// information.
	//
	// * arn::s3:::/
	//
	// * arn::s3::://
	//
	// When resources.type equals
	// AWS::S3::AccessPoint, and the operator is set to Equals or NotEquals, the ARN
	// must be in one of the following formats. To log events on all objects in an S3
	// access point, we recommend that you use only the access point ARN, don’t include
	// the object path, and use the StartsWith or NotStartsWith operators.
	//
	// *
	// arn::s3:::accesspoint/
	//
	// * arn::s3:::accesspoint//object/
	//
	// When resources.type
	// equals AWS::Lambda::Function, and the operator is set to Equals or NotEquals,
	// the ARN must be in the following format:
	//
	// * arn::lambda:::function:
	//
	// When
	// resources.type equals AWS::DynamoDB::Table, and the operator is set to Equals or
	// NotEquals, the ARN must be in the following format:
	//
	// *
	// arn::dynamodb:::table:
	//
	// When resources.type equals AWS::S3Outposts::Object, and
	// the operator is set to Equals or NotEquals, the ARN must be in the following
	// format:
	//
	// * arn::s3-outposts:::
	//
	// When resources.type equals
	// AWS::ManagedBlockchain::Node, and the operator is set to Equals or NotEquals,
	// the ARN must be in the following format:
	//
	// *
	// arn::managedblockchain:::nodes/
	//
	// When resources.type equals
	// AWS::S3ObjectLambda::AccessPoint, and the operator is set to Equals or
	// NotEquals, the ARN must be in the following format:
	//
	// *
	// arn::s3-object-lambda:::accesspoint/
	//
	// When resources.type equals
	// AWS::EC2::Snapshot, and the operator is set to Equals or NotEquals, the ARN must
	// be in the following format:
	//
	// * arn::ec2:::snapshot/
	//
	// This member is required.
	Field *string

	// An operator that includes events that match the last few characters of the event
	// record field specified as the value of Field.
	EndsWith []string

	// An operator that includes events that match the exact value of the event record
	// field specified as the value of Field. This is the only valid operator that you
	// can use with the readOnly, eventCategory, and resources.type fields.
	Equals []string

	// An operator that excludes events that match the last few characters of the event
	// record field specified as the value of Field.
	NotEndsWith []string

	// An operator that excludes events that match the exact value of the event record
	// field specified as the value of Field.
	NotEquals []string

	// An operator that excludes events that match the first few characters of the
	// event record field specified as the value of Field.
	NotStartsWith []string

	// An operator that includes events that match the first few characters of the
	// event record field specified as the value of Field.
	StartsWith []string
	// contains filtered or unexported fields
}

A single selector statement in an advanced event selector.

type CloudTrailARNInvalidException

type CloudTrailARNInvalidException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

func (*CloudTrailARNInvalidException) Error

func (*CloudTrailARNInvalidException) ErrorCode

func (e *CloudTrailARNInvalidException) ErrorCode() string

func (*CloudTrailARNInvalidException) ErrorFault

func (*CloudTrailARNInvalidException) ErrorMessage

func (e *CloudTrailARNInvalidException) ErrorMessage() string

type CloudTrailAccessNotEnabledException

type CloudTrailAccessNotEnabledException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) and Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html).

func (*CloudTrailAccessNotEnabledException) Error

func (*CloudTrailAccessNotEnabledException) ErrorCode

func (*CloudTrailAccessNotEnabledException) ErrorFault

func (*CloudTrailAccessNotEnabledException) ErrorMessage

func (e *CloudTrailAccessNotEnabledException) ErrorMessage() string

type CloudTrailInvalidClientTokenIdException added in v0.31.0

type CloudTrailInvalidClientTokenIdException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when a call results in the InvalidClientTokenId error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.

func (*CloudTrailInvalidClientTokenIdException) Error added in v0.31.0

func (*CloudTrailInvalidClientTokenIdException) ErrorCode added in v0.31.0

func (*CloudTrailInvalidClientTokenIdException) ErrorFault added in v0.31.0

func (*CloudTrailInvalidClientTokenIdException) ErrorMessage added in v0.31.0

type CloudWatchLogsDeliveryUnavailableException

type CloudWatchLogsDeliveryUnavailableException struct {
	Message *string
	// contains filtered or unexported fields
}

Cannot set a CloudWatch Logs delivery for this region.

func (*CloudWatchLogsDeliveryUnavailableException) Error

func (*CloudWatchLogsDeliveryUnavailableException) ErrorCode

func (*CloudWatchLogsDeliveryUnavailableException) ErrorFault

func (*CloudWatchLogsDeliveryUnavailableException) ErrorMessage

type ConflictException added in v1.2.0

type ConflictException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail. If this exception occurs, wait a few minutes, and then try the operation again.

func (*ConflictException) Error added in v1.2.0

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.2.0

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.2.0

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

func (*ConflictException) ErrorMessage added in v1.2.0

func (e *ConflictException) ErrorMessage() string

type DataResource

type DataResource struct {

	// The resource type in which you want to log data events. You can specify
	// AWS::S3::Object, AWS::Lambda::Function, or AWS::DynamoDB::Table resources. The
	// AWS::S3Outposts::Object, AWS::ManagedBlockchain::Node,
	// AWS::S3ObjectLambda::AccessPoint, and AWS::EC2::Snapshot resource types are not
	// valid in basic event selectors. To log data events on these resource types, use
	// advanced event selectors.
	Type *string

	// An array of Amazon Resource Name (ARN) strings or partial ARN strings for the
	// specified objects.
	//
	// * To log data events for all objects in all S3 buckets in
	// your Amazon Web Services account, specify the prefix as arn:aws:s3:::. This also
	// enables logging of data event activity performed by any user or role in your
	// Amazon Web Services account, even if that activity is performed on a bucket that
	// belongs to another Amazon Web Services account.
	//
	// * To log data events for all
	// objects in an S3 bucket, specify the bucket and an empty object prefix such as
	// arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3
	// bucket.
	//
	// * To log data events for specific objects, specify the S3 bucket and
	// object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data
	// events for objects in this S3 bucket that match the prefix.
	//
	// * To log data
	// events for all Lambda functions in your Amazon Web Services account, specify the
	// prefix as arn:aws:lambda. This also enables logging of Invoke activity performed
	// by any user or role in your Amazon Web Services account, even if that activity
	// is performed on a function that belongs to another Amazon Web Services
	// account.
	//
	// * To log data events for a specific Lambda function, specify the
	// function ARN. Lambda function ARNs are exact. For example, if you specify a
	// function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data
	// events will only be logged for
	// arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be
	// logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
	//
	// * To log
	// data events for all DynamoDB tables in your Amazon Web Services account, specify
	// the prefix as arn:aws:dynamodb.
	Values []string
	// contains filtered or unexported fields
}

The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail. The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors. If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500. The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

* A user uploads an image file to bucket-1.

* The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.

* A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2.

* The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.

The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.

* A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.

* The Invoke API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.

* The Invoke API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

type Event

type Event struct {

	// The Amazon Web Services access key ID that was used to sign the request. If the
	// request was made with temporary security credentials, this is the access key ID
	// of the temporary credentials.
	AccessKeyId *string

	// A JSON string that contains a representation of the event returned.
	CloudTrailEvent *string

	// The CloudTrail ID of the event returned.
	EventId *string

	// The name of the event returned.
	EventName *string

	// The Amazon Web Services service to which the request was made.
	EventSource *string

	// The date and time of the event returned.
	EventTime *time.Time

	// Information about whether the event is a write event or a read event.
	ReadOnly *string

	// A list of resources referenced by the event returned.
	Resources []Resource

	// A user name or role name of the requester that called the API in the event
	// returned.
	Username *string
	// contains filtered or unexported fields
}

Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.

type EventCategory

type EventCategory string
const (
	EventCategoryInsight EventCategory = "insight"
)

Enum values for EventCategory

func (EventCategory) Values added in v0.29.0

func (EventCategory) Values() []EventCategory

Values returns all known values for EventCategory. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EventSelector

type EventSelector struct {

	// CloudTrail supports data event logging for Amazon S3 objects, Lambda functions,
	// and Amazon DynamoDB tables with basic event selectors. You can specify up to 250
	// resources for an individual event selector, but the total number of data
	// resources cannot exceed 250 across all event selectors in a trail. This limit
	// does not apply if you configure resource logging for all data events. For more
	// information, see Data Events
	// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events)
	// and Limits in CloudTrail
	// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html)
	// in the CloudTrail User Guide.
	DataResources []DataResource

	// An optional list of service event sources from which you do not want management
	// events to be logged on your trail. In this release, the list can be empty
	// (disables the filter), or it can filter out Key Management Service or Amazon RDS
	// Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By
	// default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API
	// events are logged to your trail.
	ExcludeManagementEventSources []string

	// Specify if you want your event selector to include management events for your
	// trail. For more information, see Management Events
	// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events)
	// in the CloudTrail User Guide. By default, the value is true. The first copy of
	// management events is free. You are charged for additional copies of management
	// events that you are logging on any subsequent trail in the same region. For more
	// information about CloudTrail pricing, see CloudTrail Pricing
	// (http://aws.amazon.com/cloudtrail/pricing/).
	IncludeManagementEvents *bool

	// Specify if you want your trail to log read-only events, write-only events, or
	// all. For example, the EC2 GetConsoleOutput is a read-only API operation and
	// RunInstances is a write-only API operation. By default, the value is All.
	ReadWriteType ReadWriteType
	// contains filtered or unexported fields
}

Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail. You cannot apply both event selectors and advanced event selectors to a trail.

type InsightNotEnabledException

type InsightNotEnabledException struct {
	Message *string
	// contains filtered or unexported fields
}

If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException.

func (*InsightNotEnabledException) Error

func (*InsightNotEnabledException) ErrorCode

func (e *InsightNotEnabledException) ErrorCode() string

func (*InsightNotEnabledException) ErrorFault

func (*InsightNotEnabledException) ErrorMessage

func (e *InsightNotEnabledException) ErrorMessage() string

type InsightSelector

type InsightSelector struct {

	// The type of Insights events to log on a trail. The valid Insights type in this
	// release is ApiCallRateInsight.
	InsightType InsightType
	// contains filtered or unexported fields
}

A JSON string that contains a list of insight types that are logged on a trail.

type InsightType

type InsightType string
const (
	InsightTypeApiCallRateInsight InsightType = "ApiCallRateInsight"
)

Enum values for InsightType

func (InsightType) Values added in v0.29.0

func (InsightType) Values() []InsightType

Values returns all known values for InsightType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InsufficientDependencyServiceAccessPermissionException

type InsufficientDependencyServiceAccessPermissionException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for creating an organization trail in a required service. For more information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html).

func (*InsufficientDependencyServiceAccessPermissionException) Error

func (*InsufficientDependencyServiceAccessPermissionException) ErrorCode

func (*InsufficientDependencyServiceAccessPermissionException) ErrorFault

func (*InsufficientDependencyServiceAccessPermissionException) ErrorMessage

type InsufficientEncryptionPolicyException

type InsufficientEncryptionPolicyException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.

func (*InsufficientEncryptionPolicyException) Error

func (*InsufficientEncryptionPolicyException) ErrorCode

func (*InsufficientEncryptionPolicyException) ErrorFault

func (*InsufficientEncryptionPolicyException) ErrorMessage

type InsufficientS3BucketPolicyException

type InsufficientS3BucketPolicyException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the policy on the S3 bucket is not sufficient.

func (*InsufficientS3BucketPolicyException) Error

func (*InsufficientS3BucketPolicyException) ErrorCode

func (*InsufficientS3BucketPolicyException) ErrorFault

func (*InsufficientS3BucketPolicyException) ErrorMessage

func (e *InsufficientS3BucketPolicyException) ErrorMessage() string

type InsufficientSnsTopicPolicyException

type InsufficientSnsTopicPolicyException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the policy on the Amazon SNS topic is not sufficient.

func (*InsufficientSnsTopicPolicyException) Error

func (*InsufficientSnsTopicPolicyException) ErrorCode

func (*InsufficientSnsTopicPolicyException) ErrorFault

func (*InsufficientSnsTopicPolicyException) ErrorMessage

func (e *InsufficientSnsTopicPolicyException) ErrorMessage() string

type InvalidCloudWatchLogsLogGroupArnException

type InvalidCloudWatchLogsLogGroupArnException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the provided CloudWatch Logs log group is not valid.

func (*InvalidCloudWatchLogsLogGroupArnException) Error

func (*InvalidCloudWatchLogsLogGroupArnException) ErrorCode

func (*InvalidCloudWatchLogsLogGroupArnException) ErrorFault

func (*InvalidCloudWatchLogsLogGroupArnException) ErrorMessage

type InvalidCloudWatchLogsRoleArnException

type InvalidCloudWatchLogsRoleArnException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the provided role is not valid.

func (*InvalidCloudWatchLogsRoleArnException) Error

func (*InvalidCloudWatchLogsRoleArnException) ErrorCode

func (*InvalidCloudWatchLogsRoleArnException) ErrorFault

func (*InvalidCloudWatchLogsRoleArnException) ErrorMessage

type InvalidEventCategoryException

type InvalidEventCategoryException struct {
	Message *string
	// contains filtered or unexported fields
}

Occurs if an event category that is not valid is specified as a value of EventCategory.

func (*InvalidEventCategoryException) Error

func (*InvalidEventCategoryException) ErrorCode

func (e *InvalidEventCategoryException) ErrorCode() string

func (*InvalidEventCategoryException) ErrorFault

func (*InvalidEventCategoryException) ErrorMessage

func (e *InvalidEventCategoryException) ErrorMessage() string

type InvalidEventSelectorsException

type InvalidEventSelectorsException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the PutEventSelectors operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250. You can:

* Specify a valid number of event selectors (1 to 5) for a trail.

* Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.

* Specify up to 500 values for all conditions in all advanced event selectors for a trail.

* Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.

func (*InvalidEventSelectorsException) Error

func (*InvalidEventSelectorsException) ErrorCode

func (e *InvalidEventSelectorsException) ErrorCode() string

func (*InvalidEventSelectorsException) ErrorFault

func (*InvalidEventSelectorsException) ErrorMessage

func (e *InvalidEventSelectorsException) ErrorMessage() string

type InvalidHomeRegionException

type InvalidHomeRegionException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

func (*InvalidHomeRegionException) Error

func (*InvalidHomeRegionException) ErrorCode

func (e *InvalidHomeRegionException) ErrorCode() string

func (*InvalidHomeRegionException) ErrorFault

func (*InvalidHomeRegionException) ErrorMessage

func (e *InvalidHomeRegionException) ErrorMessage() string

type InvalidInsightSelectorsException

type InvalidInsightSelectorsException struct {
	Message *string
	// contains filtered or unexported fields
}

The formatting or syntax of the InsightSelectors JSON statement in your PutInsightSelectors or GetInsightSelectors request is not valid, or the specified insight type in the InsightSelectors statement is not a valid insight type.

func (*InvalidInsightSelectorsException) Error

func (*InvalidInsightSelectorsException) ErrorCode

func (*InvalidInsightSelectorsException) ErrorFault

func (*InvalidInsightSelectorsException) ErrorMessage

func (e *InvalidInsightSelectorsException) ErrorMessage() string

type InvalidKmsKeyIdException

type InvalidKmsKeyIdException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the KMS key ARN is not valid.

func (*InvalidKmsKeyIdException) Error

func (e *InvalidKmsKeyIdException) Error() string

func (*InvalidKmsKeyIdException) ErrorCode

func (e *InvalidKmsKeyIdException) ErrorCode() string

func (*InvalidKmsKeyIdException) ErrorFault

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

func (*InvalidKmsKeyIdException) ErrorMessage

func (e *InvalidKmsKeyIdException) ErrorMessage() string

type InvalidLookupAttributesException

type InvalidLookupAttributesException struct {
	Message *string
	// contains filtered or unexported fields
}

Occurs when a lookup attribute is specified that is not valid.

func (*InvalidLookupAttributesException) Error

func (*InvalidLookupAttributesException) ErrorCode

func (*InvalidLookupAttributesException) ErrorFault

func (*InvalidLookupAttributesException) ErrorMessage

func (e *InvalidLookupAttributesException) ErrorMessage() string

type InvalidMaxResultsException

type InvalidMaxResultsException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown if the limit specified is not valid.

func (*InvalidMaxResultsException) Error

func (*InvalidMaxResultsException) ErrorCode

func (e *InvalidMaxResultsException) ErrorCode() string

func (*InvalidMaxResultsException) ErrorFault

func (*InvalidMaxResultsException) ErrorMessage

func (e *InvalidMaxResultsException) ErrorMessage() string

type InvalidNextTokenException

type InvalidNextTokenException struct {
	Message *string
	// contains filtered or unexported fields
}

A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.

func (*InvalidNextTokenException) Error

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault

func (*InvalidNextTokenException) ErrorMessage

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidParameterCombinationException

type InvalidParameterCombinationException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the combination of parameters provided is not valid.

func (*InvalidParameterCombinationException) Error

func (*InvalidParameterCombinationException) ErrorCode

func (*InvalidParameterCombinationException) ErrorFault

func (*InvalidParameterCombinationException) ErrorMessage

func (e *InvalidParameterCombinationException) ErrorMessage() string

type InvalidS3BucketNameException

type InvalidS3BucketNameException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the provided S3 bucket name is not valid.

func (*InvalidS3BucketNameException) Error

func (*InvalidS3BucketNameException) ErrorCode

func (e *InvalidS3BucketNameException) ErrorCode() string

func (*InvalidS3BucketNameException) ErrorFault

func (*InvalidS3BucketNameException) ErrorMessage

func (e *InvalidS3BucketNameException) ErrorMessage() string

type InvalidS3PrefixException

type InvalidS3PrefixException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the provided S3 prefix is not valid.

func (*InvalidS3PrefixException) Error

func (e *InvalidS3PrefixException) Error() string

func (*InvalidS3PrefixException) ErrorCode

func (e *InvalidS3PrefixException) ErrorCode() string

func (*InvalidS3PrefixException) ErrorFault

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

func (*InvalidS3PrefixException) ErrorMessage

func (e *InvalidS3PrefixException) ErrorMessage() string

type InvalidSnsTopicNameException

type InvalidSnsTopicNameException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the provided SNS topic name is not valid.

func (*InvalidSnsTopicNameException) Error

func (*InvalidSnsTopicNameException) ErrorCode

func (e *InvalidSnsTopicNameException) ErrorCode() string

func (*InvalidSnsTopicNameException) ErrorFault

func (*InvalidSnsTopicNameException) ErrorMessage

func (e *InvalidSnsTopicNameException) ErrorMessage() string

type InvalidTagParameterException

type InvalidTagParameterException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.

func (*InvalidTagParameterException) Error

func (*InvalidTagParameterException) ErrorCode

func (e *InvalidTagParameterException) ErrorCode() string

func (*InvalidTagParameterException) ErrorFault

func (*InvalidTagParameterException) ErrorMessage

func (e *InvalidTagParameterException) ErrorMessage() string

type InvalidTimeRangeException

type InvalidTimeRangeException struct {
	Message *string
	// contains filtered or unexported fields
}

Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.

func (*InvalidTimeRangeException) Error

func (e *InvalidTimeRangeException) Error() string

func (*InvalidTimeRangeException) ErrorCode

func (e *InvalidTimeRangeException) ErrorCode() string

func (*InvalidTimeRangeException) ErrorFault

func (*InvalidTimeRangeException) ErrorMessage

func (e *InvalidTimeRangeException) ErrorMessage() string

type InvalidTokenException

type InvalidTokenException struct {
	Message *string
	// contains filtered or unexported fields
}

Reserved for future use.

func (*InvalidTokenException) Error

func (e *InvalidTokenException) Error() string

func (*InvalidTokenException) ErrorCode

func (e *InvalidTokenException) ErrorCode() string

func (*InvalidTokenException) ErrorFault

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

func (*InvalidTokenException) ErrorMessage

func (e *InvalidTokenException) ErrorMessage() string

type InvalidTrailNameException

type InvalidTrailNameException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:

* Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

* Start with a letter or number, and end with a letter or number

* Be between 3 and 128 characters

* Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

* Not be in IP address format (for example, 192.168.5.4)

func (*InvalidTrailNameException) Error

func (e *InvalidTrailNameException) Error() string

func (*InvalidTrailNameException) ErrorCode

func (e *InvalidTrailNameException) ErrorCode() string

func (*InvalidTrailNameException) ErrorFault

func (*InvalidTrailNameException) ErrorMessage

func (e *InvalidTrailNameException) ErrorMessage() string

type KmsException

type KmsException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.

func (*KmsException) Error

func (e *KmsException) Error() string

func (*KmsException) ErrorCode

func (e *KmsException) ErrorCode() string

func (*KmsException) ErrorFault

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

func (*KmsException) ErrorMessage

func (e *KmsException) ErrorMessage() string

type KmsKeyDisabledException

type KmsKeyDisabledException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is no longer in use.

func (*KmsKeyDisabledException) Error

func (e *KmsKeyDisabledException) Error() string

func (*KmsKeyDisabledException) ErrorCode

func (e *KmsKeyDisabledException) ErrorCode() string

func (*KmsKeyDisabledException) ErrorFault

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

func (*KmsKeyDisabledException) ErrorMessage

func (e *KmsKeyDisabledException) ErrorMessage() string

type KmsKeyNotFoundException

type KmsKeyNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same region.

func (*KmsKeyNotFoundException) Error

func (e *KmsKeyNotFoundException) Error() string

func (*KmsKeyNotFoundException) ErrorCode

func (e *KmsKeyNotFoundException) ErrorCode() string

func (*KmsKeyNotFoundException) ErrorFault

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

func (*KmsKeyNotFoundException) ErrorMessage

func (e *KmsKeyNotFoundException) ErrorMessage() string

type LookupAttribute

type LookupAttribute struct {

	// Specifies an attribute on which to filter the events returned.
	//
	// This member is required.
	AttributeKey LookupAttributeKey

	// Specifies a value for the specified AttributeKey.
	//
	// This member is required.
	AttributeValue *string
	// contains filtered or unexported fields
}

Specifies an attribute and value that filter the events returned.

type LookupAttributeKey

type LookupAttributeKey string
const (
	LookupAttributeKeyEventId      LookupAttributeKey = "EventId"
	LookupAttributeKeyEventName    LookupAttributeKey = "EventName"
	LookupAttributeKeyReadOnly     LookupAttributeKey = "ReadOnly"
	LookupAttributeKeyUsername     LookupAttributeKey = "Username"
	LookupAttributeKeyResourceType LookupAttributeKey = "ResourceType"
	LookupAttributeKeyResourceName LookupAttributeKey = "ResourceName"
	LookupAttributeKeyEventSource  LookupAttributeKey = "EventSource"
	LookupAttributeKeyAccessKeyId  LookupAttributeKey = "AccessKeyId"
)

Enum values for LookupAttributeKey

func (LookupAttributeKey) Values added in v0.29.0

Values returns all known values for LookupAttributeKey. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MaximumNumberOfTrailsExceededException

type MaximumNumberOfTrailsExceededException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the maximum number of trails is reached.

func (*MaximumNumberOfTrailsExceededException) Error

func (*MaximumNumberOfTrailsExceededException) ErrorCode

func (*MaximumNumberOfTrailsExceededException) ErrorFault

func (*MaximumNumberOfTrailsExceededException) ErrorMessage

type NotOrganizationMasterAccountException

type NotOrganizationMasterAccountException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html).

func (*NotOrganizationMasterAccountException) Error

func (*NotOrganizationMasterAccountException) ErrorCode

func (*NotOrganizationMasterAccountException) ErrorFault

func (*NotOrganizationMasterAccountException) ErrorMessage

type OperationNotPermittedException

type OperationNotPermittedException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the requested operation is not permitted.

func (*OperationNotPermittedException) Error

func (*OperationNotPermittedException) ErrorCode

func (e *OperationNotPermittedException) ErrorCode() string

func (*OperationNotPermittedException) ErrorFault

func (*OperationNotPermittedException) ErrorMessage

func (e *OperationNotPermittedException) ErrorMessage() string

type OrganizationNotInAllFeaturesModeException

type OrganizationNotInAllFeaturesModeException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail. For more information, see Prepare For Creating a Trail For Your Organization (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-an-organizational-trail-prepare.html).

func (*OrganizationNotInAllFeaturesModeException) Error

func (*OrganizationNotInAllFeaturesModeException) ErrorCode

func (*OrganizationNotInAllFeaturesModeException) ErrorFault

func (*OrganizationNotInAllFeaturesModeException) ErrorMessage

type OrganizationsNotInUseException

type OrganizationsNotInUseException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.

func (*OrganizationsNotInUseException) Error

func (*OrganizationsNotInUseException) ErrorCode

func (e *OrganizationsNotInUseException) ErrorCode() string

func (*OrganizationsNotInUseException) ErrorFault

func (*OrganizationsNotInUseException) ErrorMessage

func (e *OrganizationsNotInUseException) ErrorMessage() string

type PublicKey

type PublicKey struct {

	// The fingerprint of the public key.
	Fingerprint *string

	// The ending time of validity of the public key.
	ValidityEndTime *time.Time

	// The starting time of validity of the public key.
	ValidityStartTime *time.Time

	// The DER encoded public key value in PKCS#1 format.
	Value []byte
	// contains filtered or unexported fields
}

Contains information about a returned public key.

type ReadWriteType

type ReadWriteType string
const (
	ReadWriteTypeReadOnly  ReadWriteType = "ReadOnly"
	ReadWriteTypeWriteOnly ReadWriteType = "WriteOnly"
	ReadWriteTypeAll       ReadWriteType = "All"
)

Enum values for ReadWriteType

func (ReadWriteType) Values added in v0.29.0

func (ReadWriteType) Values() []ReadWriteType

Values returns all known values for ReadWriteType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Resource

type Resource struct {

	// The name of the resource referenced by the event returned. These are
	// user-created names whose values will depend on the environment. For example, the
	// resource name might be "auto-scaling-test-group" for an Auto Scaling Group or
	// "i-1234567" for an EC2 Instance.
	ResourceName *string

	// The type of a resource referenced by the event returned. When the resource type
	// cannot be determined, null is returned. Some examples of resource types are:
	// Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey
	// for IAM. To learn more about how to look up and filter events by the resource
	// types supported for a service, see Filtering CloudTrail Events
	// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events-console.html#filtering-cloudtrail-events).
	ResourceType *string
	// contains filtered or unexported fields
}

Specifies the type and name of a resource referenced by an event.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the specified resource is not found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceTag

type ResourceTag struct {

	// Specifies the ARN of the resource.
	ResourceId *string

	// A list of tags.
	TagsList []Tag
	// contains filtered or unexported fields
}

A resource tag.

type ResourceTypeNotSupportedException

type ResourceTypeNotSupportedException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the specified resource type is not supported by CloudTrail.

func (*ResourceTypeNotSupportedException) Error

func (*ResourceTypeNotSupportedException) ErrorCode

func (*ResourceTypeNotSupportedException) ErrorFault

func (*ResourceTypeNotSupportedException) ErrorMessage

func (e *ResourceTypeNotSupportedException) ErrorMessage() string

type S3BucketDoesNotExistException

type S3BucketDoesNotExistException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the specified S3 bucket does not exist.

func (*S3BucketDoesNotExistException) Error

func (*S3BucketDoesNotExistException) ErrorCode

func (e *S3BucketDoesNotExistException) ErrorCode() string

func (*S3BucketDoesNotExistException) ErrorFault

func (*S3BucketDoesNotExistException) ErrorMessage

func (e *S3BucketDoesNotExistException) ErrorMessage() string

type Tag

type Tag struct {

	// The key in a key-value pair. The key must be must be no longer than 128 Unicode
	// characters. The key must be unique for the resource to which it applies.
	//
	// This member is required.
	Key *string

	// The value in a key-value pair of a tag. The value must be no longer than 256
	// Unicode characters.
	Value *string
	// contains filtered or unexported fields
}

A custom key-value pair associated with a resource such as a CloudTrail trail.

type TagsLimitExceededException

type TagsLimitExceededException struct {
	Message *string
	// contains filtered or unexported fields
}

The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.

func (*TagsLimitExceededException) Error

func (*TagsLimitExceededException) ErrorCode

func (e *TagsLimitExceededException) ErrorCode() string

func (*TagsLimitExceededException) ErrorFault

func (*TagsLimitExceededException) ErrorMessage

func (e *TagsLimitExceededException) ErrorMessage() string

type Trail

type Trail struct {

	// Specifies an Amazon Resource Name (ARN), a unique identifier that represents the
	// log group to which CloudTrail logs will be delivered.
	CloudWatchLogsLogGroupArn *string

	// Specifies the role for the CloudWatch Logs endpoint to assume to write to a
	// user's log group.
	CloudWatchLogsRoleArn *string

	// Specifies if the trail has custom event selectors.
	HasCustomEventSelectors *bool

	// Specifies whether a trail has insight types specified in an InsightSelector
	// list.
	HasInsightSelectors *bool

	// The region in which the trail was created.
	HomeRegion *string

	// Set to True to include Amazon Web Services API calls from Amazon Web Services
	// global services such as IAM. Otherwise, False.
	IncludeGlobalServiceEvents *bool

	// Specifies whether the trail exists only in one region or exists in all regions.
	IsMultiRegionTrail *bool

	// Specifies whether the trail is an organization trail.
	IsOrganizationTrail *bool

	// Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The
	// value is a fully specified ARN to a KMS key in the following format.
	// arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
	KmsKeyId *string

	// Specifies whether log file validation is enabled.
	LogFileValidationEnabled *bool

	// Name of the trail set by calling CreateTrail. The maximum length is 128
	// characters.
	Name *string

	// Name of the Amazon S3 bucket into which CloudTrail delivers your trail files.
	// See Amazon S3 Bucket Naming Requirements
	// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html).
	S3BucketName *string

	// Specifies the Amazon S3 key prefix that comes after the name of the bucket you
	// have designated for log file delivery. For more information, see Finding Your
	// CloudTrail Log Files
	// (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).
	// The maximum length is 200 characters.
	S3KeyPrefix *string

	// Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
	// notifications when log files are delivered. The following is the format of a
	// topic ARN. arn:aws:sns:us-east-2:123456789012:MyTopic
	SnsTopicARN *string

	// This field is no longer in use. Use SnsTopicARN.
	//
	// Deprecated: This member has been deprecated.
	SnsTopicName *string

	// Specifies the ARN of the trail. The following is the format of a trail ARN.
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	TrailARN *string
	// contains filtered or unexported fields
}

The settings for a trail.

type TrailAlreadyExistsException

type TrailAlreadyExistsException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the specified trail already exists.

func (*TrailAlreadyExistsException) Error

func (*TrailAlreadyExistsException) ErrorCode

func (e *TrailAlreadyExistsException) ErrorCode() string

func (*TrailAlreadyExistsException) ErrorFault

func (*TrailAlreadyExistsException) ErrorMessage

func (e *TrailAlreadyExistsException) ErrorMessage() string

type TrailInfo

type TrailInfo struct {

	// The Amazon Web Services Region in which a trail was created.
	HomeRegion *string

	// The name of a trail.
	Name *string

	// The ARN of a trail.
	TrailARN *string
	// contains filtered or unexported fields
}

Information about a CloudTrail trail, including the trail's name, home region, and Amazon Resource Name (ARN).

type TrailNotFoundException

type TrailNotFoundException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the trail with the given name is not found.

func (*TrailNotFoundException) Error

func (e *TrailNotFoundException) Error() string

func (*TrailNotFoundException) ErrorCode

func (e *TrailNotFoundException) ErrorCode() string

func (*TrailNotFoundException) ErrorFault

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

func (*TrailNotFoundException) ErrorMessage

func (e *TrailNotFoundException) ErrorMessage() string

type TrailNotProvidedException

type TrailNotProvidedException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is no longer in use.

func (*TrailNotProvidedException) Error

func (e *TrailNotProvidedException) Error() string

func (*TrailNotProvidedException) ErrorCode

func (e *TrailNotProvidedException) ErrorCode() string

func (*TrailNotProvidedException) ErrorFault

func (*TrailNotProvidedException) ErrorMessage

func (e *TrailNotProvidedException) ErrorMessage() string

type UnsupportedOperationException

type UnsupportedOperationException struct {
	Message *string
	// contains filtered or unexported fields
}

This exception is thrown when the requested operation is not supported.

func (*UnsupportedOperationException) Error

func (*UnsupportedOperationException) ErrorCode

func (e *UnsupportedOperationException) ErrorCode() string

func (*UnsupportedOperationException) ErrorFault

func (*UnsupportedOperationException) ErrorMessage

func (e *UnsupportedOperationException) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL