cloudtrail

package
v1.43.3 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2022 License: Apache-2.0 Imports: 10 Imported by: 310

Documentation

Overview

Package cloudtrail provides the client and types for making API requests to AWS CloudTrail.

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services (http://aws.amazon.com/tools/).

See the CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html) for information about the data that is included with each Amazon Web Services API call listed in the log files.

See https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01 for more information on this service.

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

Using the Client

To contact AWS CloudTrail 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 AWS CloudTrail client CloudTrail for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudtrail/#New

Index

Constants

View Source 
const (
	// EventDataStoreStatusCreated is a EventDataStoreStatus enum value
	EventDataStoreStatusCreated = "CREATED"

	// EventDataStoreStatusEnabled is a EventDataStoreStatus enum value
	EventDataStoreStatusEnabled = "ENABLED"

	// EventDataStoreStatusPendingDeletion is a EventDataStoreStatus enum value
	EventDataStoreStatusPendingDeletion = "PENDING_DELETION"
)
View Source 
const (
	// InsightTypeApiCallRateInsight is a InsightType enum value
	InsightTypeApiCallRateInsight = "ApiCallRateInsight"

	// InsightTypeApiErrorRateInsight is a InsightType enum value
	InsightTypeApiErrorRateInsight = "ApiErrorRateInsight"
)
View Source 
const (
	// LookupAttributeKeyEventId is a LookupAttributeKey enum value
	LookupAttributeKeyEventId = "EventId"

	// LookupAttributeKeyEventName is a LookupAttributeKey enum value
	LookupAttributeKeyEventName = "EventName"

	// LookupAttributeKeyReadOnly is a LookupAttributeKey enum value
	LookupAttributeKeyReadOnly = "ReadOnly"

	// LookupAttributeKeyUsername is a LookupAttributeKey enum value
	LookupAttributeKeyUsername = "Username"

	// LookupAttributeKeyResourceType is a LookupAttributeKey enum value
	LookupAttributeKeyResourceType = "ResourceType"

	// LookupAttributeKeyResourceName is a LookupAttributeKey enum value
	LookupAttributeKeyResourceName = "ResourceName"

	// LookupAttributeKeyEventSource is a LookupAttributeKey enum value
	LookupAttributeKeyEventSource = "EventSource"

	// LookupAttributeKeyAccessKeyId is a LookupAttributeKey enum value
	LookupAttributeKeyAccessKeyId = "AccessKeyId"
)
View Source 
const (
	// QueryStatusQueued is a QueryStatus enum value
	QueryStatusQueued = "QUEUED"

	// QueryStatusRunning is a QueryStatus enum value
	QueryStatusRunning = "RUNNING"

	// QueryStatusFinished is a QueryStatus enum value
	QueryStatusFinished = "FINISHED"

	// QueryStatusFailed is a QueryStatus enum value
	QueryStatusFailed = "FAILED"

	// QueryStatusCancelled is a QueryStatus enum value
	QueryStatusCancelled = "CANCELLED"
)
View Source 
const (
	// ReadWriteTypeReadOnly is a ReadWriteType enum value
	ReadWriteTypeReadOnly = "ReadOnly"

	// ReadWriteTypeWriteOnly is a ReadWriteType enum value
	ReadWriteTypeWriteOnly = "WriteOnly"

	// ReadWriteTypeAll is a ReadWriteType enum value
	ReadWriteTypeAll = "All"
)
View Source 
const (

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

	// ErrCodeAccessNotEnabledException for service response error code
	// "CloudTrailAccessNotEnabledException".
	//
	// 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).
	ErrCodeAccessNotEnabledException = "CloudTrailAccessNotEnabledException"

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

	// ErrCodeCloudWatchLogsDeliveryUnavailableException for service response error code
	// "CloudWatchLogsDeliveryUnavailableException".
	//
	// Cannot set a CloudWatch Logs delivery for this region.
	ErrCodeCloudWatchLogsDeliveryUnavailableException = "CloudWatchLogsDeliveryUnavailableException"

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

	// ErrCodeEventDataStoreARNInvalidException for service response error code
	// "EventDataStoreARNInvalidException".
	//
	// The specified event data store ARN is not valid or does not map to an event
	// data store in your account.
	ErrCodeEventDataStoreARNInvalidException = "EventDataStoreARNInvalidException"

	// ErrCodeEventDataStoreAlreadyExistsException for service response error code
	// "EventDataStoreAlreadyExistsException".
	//
	// An event data store with that name already exists.
	ErrCodeEventDataStoreAlreadyExistsException = "EventDataStoreAlreadyExistsException"

	// ErrCodeEventDataStoreMaxLimitExceededException for service response error code
	// "EventDataStoreMaxLimitExceededException".
	//
	// Your account has used the maximum number of event data stores.
	ErrCodeEventDataStoreMaxLimitExceededException = "EventDataStoreMaxLimitExceededException"

	// ErrCodeEventDataStoreNotFoundException for service response error code
	// "EventDataStoreNotFoundException".
	//
	// The specified event data store was not found.
	ErrCodeEventDataStoreNotFoundException = "EventDataStoreNotFoundException"

	// ErrCodeEventDataStoreTerminationProtectedException for service response error code
	// "EventDataStoreTerminationProtectedException".
	//
	// The event data store cannot be deleted because termination protection is
	// enabled for it.
	ErrCodeEventDataStoreTerminationProtectedException = "EventDataStoreTerminationProtectedException"

	// ErrCodeInactiveEventDataStoreException for service response error code
	// "InactiveEventDataStoreException".
	//
	// The event data store against which you ran your query is inactive.
	ErrCodeInactiveEventDataStoreException = "InactiveEventDataStoreException"

	// ErrCodeInactiveQueryException for service response error code
	// "InactiveQueryException".
	//
	// The specified query cannot be canceled because it is in the FINISHED, FAILED,
	// or CANCELLED state.
	ErrCodeInactiveQueryException = "InactiveQueryException"

	// ErrCodeInsightNotEnabledException for service response error code
	// "InsightNotEnabledException".
	//
	// If you run GetInsightSelectors on a trail that does not have Insights events
	// enabled, the operation throws the exception InsightNotEnabledException.
	ErrCodeInsightNotEnabledException = "InsightNotEnabledException"

	// ErrCodeInsufficientDependencyServiceAccessPermissionException for service response error code
	// "InsufficientDependencyServiceAccessPermissionException".
	//
	// 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).
	ErrCodeInsufficientDependencyServiceAccessPermissionException = "InsufficientDependencyServiceAccessPermissionException"

	// ErrCodeInsufficientEncryptionPolicyException for service response error code
	// "InsufficientEncryptionPolicyException".
	//
	// This exception is thrown when the policy on the S3 bucket or KMS key is not
	// sufficient.
	ErrCodeInsufficientEncryptionPolicyException = "InsufficientEncryptionPolicyException"

	// ErrCodeInsufficientS3BucketPolicyException for service response error code
	// "InsufficientS3BucketPolicyException".
	//
	// This exception is thrown when the policy on the S3 bucket is not sufficient.
	ErrCodeInsufficientS3BucketPolicyException = "InsufficientS3BucketPolicyException"

	// ErrCodeInsufficientSnsTopicPolicyException for service response error code
	// "InsufficientSnsTopicPolicyException".
	//
	// This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
	ErrCodeInsufficientSnsTopicPolicyException = "InsufficientSnsTopicPolicyException"

	// ErrCodeInvalidCloudWatchLogsLogGroupArnException for service response error code
	// "InvalidCloudWatchLogsLogGroupArnException".
	//
	// This exception is thrown when the provided CloudWatch Logs log group is not
	// valid.
	ErrCodeInvalidCloudWatchLogsLogGroupArnException = "InvalidCloudWatchLogsLogGroupArnException"

	// ErrCodeInvalidCloudWatchLogsRoleArnException for service response error code
	// "InvalidCloudWatchLogsRoleArnException".
	//
	// This exception is thrown when the provided role is not valid.
	ErrCodeInvalidCloudWatchLogsRoleArnException = "InvalidCloudWatchLogsRoleArnException"

	// ErrCodeInvalidDateRangeException for service response error code
	// "InvalidDateRangeException".
	//
	// A date range for the query was specified that is not valid. For more information
	// about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html)
	// in the CloudTrail User Guide.
	ErrCodeInvalidDateRangeException = "InvalidDateRangeException"

	// ErrCodeInvalidEventCategoryException for service response error code
	// "InvalidEventCategoryException".
	//
	// Occurs if an event category that is not valid is specified as a value of
	// EventCategory.
	ErrCodeInvalidEventCategoryException = "InvalidEventCategoryException"

	// ErrCodeInvalidEventDataStoreStatusException for service response error code
	// "InvalidEventDataStoreStatusException".
	//
	// The event data store is not in a status that supports the operation.
	ErrCodeInvalidEventDataStoreStatusException = "InvalidEventDataStoreStatusException"

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

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

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

	// ErrCodeInvalidKmsKeyIdException for service response error code
	// "InvalidKmsKeyIdException".
	//
	// This exception is thrown when the KMS key ARN is not valid.
	ErrCodeInvalidKmsKeyIdException = "InvalidKmsKeyIdException"

	// ErrCodeInvalidLookupAttributesException for service response error code
	// "InvalidLookupAttributesException".
	//
	// Occurs when a lookup attribute is specified that is not valid.
	ErrCodeInvalidLookupAttributesException = "InvalidLookupAttributesException"

	// ErrCodeInvalidMaxResultsException for service response error code
	// "InvalidMaxResultsException".
	//
	// This exception is thrown if the limit specified is not valid.
	ErrCodeInvalidMaxResultsException = "InvalidMaxResultsException"

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

	// ErrCodeInvalidParameterCombinationException for service response error code
	// "InvalidParameterCombinationException".
	//
	// This exception is thrown when the combination of parameters provided is not
	// valid.
	ErrCodeInvalidParameterCombinationException = "InvalidParameterCombinationException"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// The request includes a parameter that is not valid.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeInvalidQueryStatementException for service response error code
	// "InvalidQueryStatementException".
	//
	// The query that was submitted has validation errors, or uses incorrect syntax
	// or unsupported keywords. For more information about writing a query, see
	// Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html)
	// in the CloudTrail User Guide.
	ErrCodeInvalidQueryStatementException = "InvalidQueryStatementException"

	// ErrCodeInvalidQueryStatusException for service response error code
	// "InvalidQueryStatusException".
	//
	// The query status is not valid for the operation.
	ErrCodeInvalidQueryStatusException = "InvalidQueryStatusException"

	// ErrCodeInvalidS3BucketNameException for service response error code
	// "InvalidS3BucketNameException".
	//
	// This exception is thrown when the provided S3 bucket name is not valid.
	ErrCodeInvalidS3BucketNameException = "InvalidS3BucketNameException"

	// ErrCodeInvalidS3PrefixException for service response error code
	// "InvalidS3PrefixException".
	//
	// This exception is thrown when the provided S3 prefix is not valid.
	ErrCodeInvalidS3PrefixException = "InvalidS3PrefixException"

	// ErrCodeInvalidSnsTopicNameException for service response error code
	// "InvalidSnsTopicNameException".
	//
	// This exception is thrown when the provided SNS topic name is not valid.
	ErrCodeInvalidSnsTopicNameException = "InvalidSnsTopicNameException"

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

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

	// ErrCodeInvalidTokenException for service response error code
	// "InvalidTokenException".
	//
	// Reserved for future use.
	ErrCodeInvalidTokenException = "InvalidTokenException"

	// ErrCodeInvalidTrailNameException for service response error code
	// "InvalidTrailNameException".
	//
	// 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)
	ErrCodeInvalidTrailNameException = "InvalidTrailNameException"

	// ErrCodeKmsException for service response error code
	// "KmsException".
	//
	// This exception is thrown when there is an issue with the specified KMS key
	// and the trail can’t be updated.
	ErrCodeKmsException = "KmsException"

	// ErrCodeKmsKeyDisabledException for service response error code
	// "KmsKeyDisabledException".
	//
	// This exception is no longer in use.
	ErrCodeKmsKeyDisabledException = "KmsKeyDisabledException"

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

	// ErrCodeMaxConcurrentQueriesException for service response error code
	// "MaxConcurrentQueriesException".
	//
	// You are already running the maximum number of concurrent queries. Wait a
	// minute for some queries to finish, and then run the query again.
	ErrCodeMaxConcurrentQueriesException = "MaxConcurrentQueriesException"

	// ErrCodeMaximumNumberOfTrailsExceededException for service response error code
	// "MaximumNumberOfTrailsExceededException".
	//
	// This exception is thrown when the maximum number of trails is reached.
	ErrCodeMaximumNumberOfTrailsExceededException = "MaximumNumberOfTrailsExceededException"

	// ErrCodeNotOrganizationMasterAccountException for service response error code
	// "NotOrganizationMasterAccountException".
	//
	// 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).
	ErrCodeNotOrganizationMasterAccountException = "NotOrganizationMasterAccountException"

	// ErrCodeOperationNotPermittedException for service response error code
	// "OperationNotPermittedException".
	//
	// This exception is thrown when the requested operation is not permitted.
	ErrCodeOperationNotPermittedException = "OperationNotPermittedException"

	// ErrCodeOrganizationNotInAllFeaturesModeException for service response error code
	// "OrganizationNotInAllFeaturesModeException".
	//
	// 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).
	ErrCodeOrganizationNotInAllFeaturesModeException = "OrganizationNotInAllFeaturesModeException"

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

	// ErrCodeQueryIdNotFoundException for service response error code
	// "QueryIdNotFoundException".
	//
	// The query ID does not exist or does not map to a query.
	ErrCodeQueryIdNotFoundException = "QueryIdNotFoundException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// This exception is thrown when the specified resource is not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceTypeNotSupportedException for service response error code
	// "ResourceTypeNotSupportedException".
	//
	// This exception is thrown when the specified resource type is not supported
	// by CloudTrail.
	ErrCodeResourceTypeNotSupportedException = "ResourceTypeNotSupportedException"

	// ErrCodeS3BucketDoesNotExistException for service response error code
	// "S3BucketDoesNotExistException".
	//
	// This exception is thrown when the specified S3 bucket does not exist.
	ErrCodeS3BucketDoesNotExistException = "S3BucketDoesNotExistException"

	// ErrCodeTagsLimitExceededException for service response error code
	// "TagsLimitExceededException".
	//
	// The number of tags per trail has exceeded the permitted amount. Currently,
	// the limit is 50.
	ErrCodeTagsLimitExceededException = "TagsLimitExceededException"

	// ErrCodeTrailAlreadyExistsException for service response error code
	// "TrailAlreadyExistsException".
	//
	// This exception is thrown when the specified trail already exists.
	ErrCodeTrailAlreadyExistsException = "TrailAlreadyExistsException"

	// ErrCodeTrailNotFoundException for service response error code
	// "TrailNotFoundException".
	//
	// This exception is thrown when the trail with the given name is not found.
	ErrCodeTrailNotFoundException = "TrailNotFoundException"

	// ErrCodeTrailNotProvidedException for service response error code
	// "TrailNotProvidedException".
	//
	// This exception is no longer in use.
	ErrCodeTrailNotProvidedException = "TrailNotProvidedException"

	// ErrCodeUnsupportedOperationException for service response error code
	// "UnsupportedOperationException".
	//
	// This exception is thrown when the requested operation is not supported.
	ErrCodeUnsupportedOperationException = "UnsupportedOperationException"
)
View Source 
const (
	ServiceName = "cloudtrail" // Name of service.
	EndpointsID = ServiceName  // ID to lookup a service endpoint with.
	ServiceID   = "CloudTrail" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// EventCategoryInsight is a EventCategory enum value
	EventCategoryInsight = "insight"
)

Variables

This section is empty.

Functions

func EventCategory_Values added in v1.34.3 

func EventCategory_Values() []string

EventCategory_Values returns all elements of the EventCategory enum

func EventDataStoreStatus_Values added in v1.42.28 

func EventDataStoreStatus_Values() []string

EventDataStoreStatus_Values returns all elements of the EventDataStoreStatus enum

func InsightType_Values added in v1.34.3 

func InsightType_Values() []string

InsightType_Values returns all elements of the InsightType enum

func LookupAttributeKey_Values added in v1.34.3 

func LookupAttributeKey_Values() []string

LookupAttributeKey_Values returns all elements of the LookupAttributeKey enum

func QueryStatus_Values added in v1.42.28 

func QueryStatus_Values() []string

QueryStatus_Values returns all elements of the QueryStatus enum

func ReadWriteType_Values added in v1.34.3 

func ReadWriteType_Values() []string

ReadWriteType_Values returns all elements of the ReadWriteType enum

Types

type ARNInvalidException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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 (*ARNInvalidException) Code added in v1.28.0 

func (s *ARNInvalidException) Code() string

Code returns the exception type name.

func (*ARNInvalidException) Error added in v1.28.0 

func (s *ARNInvalidException) Error() string

func (ARNInvalidException) GoString added in v1.28.0 

func (s ARNInvalidException) 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 (*ARNInvalidException) Message added in v1.28.0 

func (s *ARNInvalidException) Message() string

Message returns the exception's message.

func (*ARNInvalidException) OrigErr added in v1.28.0 

func (s *ARNInvalidException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ARNInvalidException) RequestID added in v1.28.0 

func (s *ARNInvalidException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ARNInvalidException) StatusCode added in v1.28.0 

func (s *ARNInvalidException) StatusCode() int

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

func (ARNInvalidException) String added in v1.28.0 

func (s ARNInvalidException) 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 AccessNotEnabledException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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 (*AccessNotEnabledException) Code added in v1.28.0 

func (s *AccessNotEnabledException) Code() string

Code returns the exception type name.

func (*AccessNotEnabledException) Error added in v1.28.0 

func (s *AccessNotEnabledException) Error() string

func (AccessNotEnabledException) GoString added in v1.28.0 

func (s AccessNotEnabledException) 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 (*AccessNotEnabledException) Message added in v1.28.0 

func (s *AccessNotEnabledException) Message() string

Message returns the exception's message.

func (*AccessNotEnabledException) OrigErr added in v1.28.0 

func (s *AccessNotEnabledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessNotEnabledException) RequestID added in v1.28.0 

func (s *AccessNotEnabledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessNotEnabledException) StatusCode added in v1.28.0 

func (s *AccessNotEnabledException) StatusCode() int

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

func (AccessNotEnabledException) String added in v1.28.0 

func (s AccessNotEnabledException) 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 AddTagsInput added in v0.9.11 

type AddTagsInput struct {

	// Specifies the ARN of the trail to which one or more tags will be added. The
	// format of a trail ARN is:
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// Contains a list of tags, up to a limit of 50
	//
	// TagsList is a required field
	TagsList []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies the tags to add to a trail.

func (AddTagsInput) GoString added in v0.9.11 

func (s AddTagsInput) 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 (*AddTagsInput) SetResourceId added in v1.5.0 

func (s *AddTagsInput) SetResourceId(v string) *AddTagsInput

SetResourceId sets the ResourceId field's value.

func (*AddTagsInput) SetTagsList added in v1.5.0 

func (s *AddTagsInput) SetTagsList(v []*Tag) *AddTagsInput

SetTagsList sets the TagsList field's value.

func (AddTagsInput) String added in v0.9.11 

func (s AddTagsInput) 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 (*AddTagsInput) Validate added in v1.1.21 

func (s *AddTagsInput) Validate() error

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

type AddTagsOutput added in v0.9.11 

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

Returns the objects or data if successful. Otherwise, returns an error.

func (AddTagsOutput) GoString added in v0.9.11 

func (s AddTagsOutput) 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 (AddTagsOutput) String added in v0.9.11 

func (s AddTagsOutput) 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 AdvancedEventSelector added in v1.35.35 

type AdvancedEventSelector struct {

	// Contains all selector statements in an advanced event selector.
	//
	// FieldSelectors is a required field
	FieldSelectors []*AdvancedFieldSelector `min:"1" type:"list" required:"true"`

	// An optional, descriptive name for an advanced event selector, such as "Log
	// data events for only two S3 buckets".
	Name *string `type:"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.

func (AdvancedEventSelector) GoString added in v1.35.35 

func (s AdvancedEventSelector) 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 (*AdvancedEventSelector) SetFieldSelectors added in v1.35.35 

func (s *AdvancedEventSelector) SetFieldSelectors(v []*AdvancedFieldSelector) *AdvancedEventSelector

SetFieldSelectors sets the FieldSelectors field's value.

func (*AdvancedEventSelector) SetName added in v1.35.35 

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

SetName sets the Name field's value.

func (AdvancedEventSelector) String added in v1.35.35 

func (s AdvancedEventSelector) 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 (*AdvancedEventSelector) Validate added in v1.35.35 

func (s *AdvancedEventSelector) Validate() error

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

type AdvancedFieldSelector added in v1.35.35 

type AdvancedFieldSelector struct {

	// An operator that includes events that match the last few characters of the
	// event record field specified as the value of Field.
	EndsWith []*string `min:"1" type:"list"`

	// 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 `min:"1" type:"list"`

	// 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.
	//    If you do not add this field, CloudTrail logs both both read and write
	//    events. A value of true logs only read events. A value of false logs only
	//    write events.
	//
	//    * eventSource - For filtering management events only. This can be set
	//    only to NotEquals kms.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::Lambda::Function AWS::DynamoDB::Table AWS::S3Outposts::Object AWS::ManagedBlockchain::Node
	//    AWS::S3ObjectLambda::AccessPoint AWS::EC2::Snapshot AWS::S3::AccessPoint
	//    AWS::DynamoDB::Stream AWS::Glue::Table 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:<partition>:s3:::<bucket_name>/
	//    arn:<partition>:s3:::<bucket_name>/<object_path>/ 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:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>
	//    arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>
	//    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:<partition>:lambda:<region>:<account_ID>:function:<function_name>
	//    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:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>
	//    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:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
	//    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:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
	//    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:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
	//    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:<partition>:ec2:<region>::snapshot/<snapshot_ID>
	//    When resources.type equals AWS::DynamoDB::Stream, and the operator is
	//    set to Equals or NotEquals, the ARN must be in the following format: arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>
	//    When resources.type equals AWS::Glue::Table, and the operator is set to
	//    Equals or NotEquals, the ARN must be in the following format: arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>
	//
	// Field is a required field
	Field *string `min:"1" type:"string" required:"true"`

	// An operator that excludes events that match the last few characters of the
	// event record field specified as the value of Field.
	NotEndsWith []*string `min:"1" type:"list"`

	// An operator that excludes events that match the exact value of the event
	// record field specified as the value of Field.
	NotEquals []*string `min:"1" type:"list"`

	// An operator that excludes events that match the first few characters of the
	// event record field specified as the value of Field.
	NotStartsWith []*string `min:"1" type:"list"`

	// An operator that includes events that match the first few characters of the
	// event record field specified as the value of Field.
	StartsWith []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

A single selector statement in an advanced event selector.

func (AdvancedFieldSelector) GoString added in v1.35.35 

func (s AdvancedFieldSelector) 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 (*AdvancedFieldSelector) SetEndsWith added in v1.35.35 

func (s *AdvancedFieldSelector) SetEndsWith(v []*string) *AdvancedFieldSelector

SetEndsWith sets the EndsWith field's value.

func (*AdvancedFieldSelector) SetEquals added in v1.35.35 

func (s *AdvancedFieldSelector) SetEquals(v []*string) *AdvancedFieldSelector

SetEquals sets the Equals field's value.

func (*AdvancedFieldSelector) SetField added in v1.35.35 

func (s *AdvancedFieldSelector) SetField(v string) *AdvancedFieldSelector

SetField sets the Field field's value.

func (*AdvancedFieldSelector) SetNotEndsWith added in v1.35.35 

func (s *AdvancedFieldSelector) SetNotEndsWith(v []*string) *AdvancedFieldSelector

SetNotEndsWith sets the NotEndsWith field's value.

func (*AdvancedFieldSelector) SetNotEquals added in v1.35.35 

func (s *AdvancedFieldSelector) SetNotEquals(v []*string) *AdvancedFieldSelector

SetNotEquals sets the NotEquals field's value.

func (*AdvancedFieldSelector) SetNotStartsWith added in v1.35.35 

func (s *AdvancedFieldSelector) SetNotStartsWith(v []*string) *AdvancedFieldSelector

SetNotStartsWith sets the NotStartsWith field's value.

func (*AdvancedFieldSelector) SetStartsWith added in v1.35.35 

func (s *AdvancedFieldSelector) SetStartsWith(v []*string) *AdvancedFieldSelector

SetStartsWith sets the StartsWith field's value.

func (AdvancedFieldSelector) String added in v1.35.35 

func (s AdvancedFieldSelector) 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 (*AdvancedFieldSelector) Validate added in v1.35.35 

func (s *AdvancedFieldSelector) Validate() error

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

type CancelQueryInput added in v1.42.28 

type CancelQueryInput struct {

	// The ARN (or the ID suffix of the ARN) of an event data store on which the
	// specified query is running.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`

	// The ID of the query that you want to cancel. The QueryId comes from the response
	// of a StartQuery operation.
	//
	// QueryId is a required field
	QueryId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelQueryInput) GoString added in v1.42.28 

func (s CancelQueryInput) 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 (*CancelQueryInput) SetEventDataStore added in v1.42.28 

func (s *CancelQueryInput) SetEventDataStore(v string) *CancelQueryInput

SetEventDataStore sets the EventDataStore field's value.

func (*CancelQueryInput) SetQueryId added in v1.42.28 

func (s *CancelQueryInput) SetQueryId(v string) *CancelQueryInput

SetQueryId sets the QueryId field's value.

func (CancelQueryInput) String added in v1.42.28 

func (s CancelQueryInput) 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 (*CancelQueryInput) Validate added in v1.42.28 

func (s *CancelQueryInput) Validate() error

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

type CancelQueryOutput added in v1.42.28 

type CancelQueryOutput struct {

	// The ID of the canceled query.
	//
	// QueryId is a required field
	QueryId *string `min:"36" type:"string" required:"true"`

	// Shows the status of a query after a CancelQuery request. Typically, the values
	// shown are either RUNNING or CANCELLED.
	//
	// QueryStatus is a required field
	QueryStatus *string `type:"string" required:"true" enum:"QueryStatus"`
	// contains filtered or unexported fields
}

func (CancelQueryOutput) GoString added in v1.42.28 

func (s CancelQueryOutput) 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 (*CancelQueryOutput) SetQueryId added in v1.42.28 

func (s *CancelQueryOutput) SetQueryId(v string) *CancelQueryOutput

SetQueryId sets the QueryId field's value.

func (*CancelQueryOutput) SetQueryStatus added in v1.42.28 

func (s *CancelQueryOutput) SetQueryStatus(v string) *CancelQueryOutput

SetQueryStatus sets the QueryStatus field's value.

func (CancelQueryOutput) String added in v1.42.28 

func (s CancelQueryOutput) 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 CloudTrail 

type CloudTrail struct {
	*client.Client
}

CloudTrail provides the API operation methods for making requests to AWS CloudTrail. See this package's package overview docs for details on the service.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudTrail

New creates a new instance of the CloudTrail 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 CloudTrail client from just a session.
svc := cloudtrail.New(mySession)

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

func (*CloudTrail) AddTags added in v0.9.11 

func (c *CloudTrail) AddTags(input *AddTagsInput) (*AddTagsOutput, error)

AddTags API operation for AWS CloudTrail.

Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all Amazon Web Services Regions only from the Region in which the trail was created (also known as its home region).

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 AWS CloudTrail's API operation AddTags for usage and error information.

Returned Error Types:

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

  • ARNInvalidException 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

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

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

  • InvalidTrailNameException 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)

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

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • EventDataStoreNotFoundException The specified event data store was not found.

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

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

  • NotOrganizationMasterAccountException 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).

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTags

func (*CloudTrail) AddTagsRequest added in v0.9.11 

func (c *CloudTrail) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput)

AddTagsRequest generates a "aws/request.Request" representing the client's request for the AddTags 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 AddTags for more information on using the AddTags 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 AddTagsRequest method.
req, resp := client.AddTagsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTags

func (*CloudTrail) AddTagsWithContext added in v1.8.0 

func (c *CloudTrail) AddTagsWithContext(ctx aws.Context, input *AddTagsInput, opts ...request.Option) (*AddTagsOutput, error)

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

See AddTags 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 (*CloudTrail) CancelQuery added in v1.42.28 

func (c *CloudTrail) CancelQuery(input *CancelQueryInput) (*CancelQueryOutput, error)

CancelQuery API operation for AWS CloudTrail.

Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED or FINISHED. You must specify an ARN value for EventDataStore. The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might show as CANCELLED even if the operation is not yet finished.

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 AWS CloudTrail's API operation CancelQuery for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • InactiveQueryException The specified query cannot be canceled because it is in the FINISHED, FAILED, or CANCELLED state.

  • InvalidParameterException The request includes a parameter that is not valid.

  • QueryIdNotFoundException The query ID does not exist or does not map to a query.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CancelQuery

func (*CloudTrail) CancelQueryRequest added in v1.42.28 

func (c *CloudTrail) CancelQueryRequest(input *CancelQueryInput) (req *request.Request, output *CancelQueryOutput)

CancelQueryRequest generates a "aws/request.Request" representing the client's request for the CancelQuery 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 CancelQuery for more information on using the CancelQuery 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 CancelQueryRequest method.
req, resp := client.CancelQueryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CancelQuery

func (*CloudTrail) CancelQueryWithContext added in v1.42.28 

func (c *CloudTrail) CancelQueryWithContext(ctx aws.Context, input *CancelQueryInput, opts ...request.Option) (*CancelQueryOutput, error)

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

See CancelQuery 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 (*CloudTrail) CreateEventDataStore added in v1.42.28 

func (c *CloudTrail) CreateEventDataStore(input *CreateEventDataStoreInput) (*CreateEventDataStoreOutput, error)

CreateEventDataStore API operation for AWS CloudTrail.

Creates a new event data store.

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 AWS CloudTrail's API operation CreateEventDataStore for usage and error information.

Returned Error Types:

  • EventDataStoreAlreadyExistsException An event data store with that name already exists.

  • EventDataStoreMaxLimitExceededException Your account has used the maximum number of event data stores.

  • InvalidParameterException The request includes a parameter that is not valid.

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

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

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

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

  • AccessNotEnabledException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

  • NotOrganizationMasterAccountException 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).

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

  • OrganizationNotInAllFeaturesModeException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateEventDataStore

func (*CloudTrail) CreateEventDataStoreRequest added in v1.42.28 

func (c *CloudTrail) CreateEventDataStoreRequest(input *CreateEventDataStoreInput) (req *request.Request, output *CreateEventDataStoreOutput)

CreateEventDataStoreRequest generates a "aws/request.Request" representing the client's request for the CreateEventDataStore 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 CreateEventDataStore for more information on using the CreateEventDataStore 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 CreateEventDataStoreRequest method.
req, resp := client.CreateEventDataStoreRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateEventDataStore

func (*CloudTrail) CreateEventDataStoreWithContext added in v1.42.28 

func (c *CloudTrail) CreateEventDataStoreWithContext(ctx aws.Context, input *CreateEventDataStoreInput, opts ...request.Option) (*CreateEventDataStoreOutput, error)

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

See CreateEventDataStore 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 (*CloudTrail) CreateTrail 

func (c *CloudTrail) CreateTrail(input *CreateTrailInput) (*CreateTrailOutput, error)

CreateTrail API operation for AWS CloudTrail.

Creates a trail that specifies the settings for delivery of log data to an Amazon 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 AWS CloudTrail's API operation CreateTrail for usage and error information.

Returned Error Types:

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

  • TrailAlreadyExistsException This exception is thrown when the specified trail already exists.

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

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

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

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

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

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

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

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

  • InvalidTrailNameException 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)

  • TrailNotProvidedException This exception is no longer in use.

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

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

  • KmsKeyDisabledException This exception is no longer in use.

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

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

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

  • CloudWatchLogsDeliveryUnavailableException Cannot set a CloudWatch Logs delivery for this region.

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

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

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

  • AccessNotEnabledException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

  • NotOrganizationMasterAccountException 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).

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

  • OrganizationNotInAllFeaturesModeException 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).

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateTrail

func (*CloudTrail) CreateTrailRequest 

func (c *CloudTrail) CreateTrailRequest(input *CreateTrailInput) (req *request.Request, output *CreateTrailOutput)

CreateTrailRequest generates a "aws/request.Request" representing the client's request for the CreateTrail 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 CreateTrail for more information on using the CreateTrail 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 CreateTrailRequest method.
req, resp := client.CreateTrailRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateTrail

func (*CloudTrail) CreateTrailWithContext added in v1.8.0 

func (c *CloudTrail) CreateTrailWithContext(ctx aws.Context, input *CreateTrailInput, opts ...request.Option) (*CreateTrailOutput, error)

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

See CreateTrail 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 (*CloudTrail) DeleteEventDataStore added in v1.42.28 

func (c *CloudTrail) DeleteEventDataStore(input *DeleteEventDataStoreInput) (*DeleteEventDataStoreOutput, error)

DeleteEventDataStore API operation for AWS CloudTrail.

Disables the event data store specified by EventDataStore, which accepts an event data store ARN. After you run DeleteEventDataStore, the event data store enters a PENDING_DELETION state, and is automatically deleted after a wait period of seven days. TerminationProtectionEnabled must be set to False on the event data store; this operation cannot work if TerminationProtectionEnabled is True.

After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, DescribeQuery, or GetQueryResults on queries that are using an event data store in a PENDING_DELETION state. An event data store in the PENDING_DELETION state does not incur costs.

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 AWS CloudTrail's API operation DeleteEventDataStore for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • EventDataStoreTerminationProtectedException The event data store cannot be deleted because termination protection is enabled for it.

  • InvalidParameterException The request includes a parameter that is not valid.

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

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

  • NotOrganizationMasterAccountException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteEventDataStore

func (*CloudTrail) DeleteEventDataStoreRequest added in v1.42.28 

func (c *CloudTrail) DeleteEventDataStoreRequest(input *DeleteEventDataStoreInput) (req *request.Request, output *DeleteEventDataStoreOutput)

DeleteEventDataStoreRequest generates a "aws/request.Request" representing the client's request for the DeleteEventDataStore 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 DeleteEventDataStore for more information on using the DeleteEventDataStore 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 DeleteEventDataStoreRequest method.
req, resp := client.DeleteEventDataStoreRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteEventDataStore

func (*CloudTrail) DeleteEventDataStoreWithContext added in v1.42.28 

func (c *CloudTrail) DeleteEventDataStoreWithContext(ctx aws.Context, input *DeleteEventDataStoreInput, opts ...request.Option) (*DeleteEventDataStoreOutput, error)

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

See DeleteEventDataStore 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 (*CloudTrail) DeleteTrail 

func (c *CloudTrail) DeleteTrail(input *DeleteTrailInput) (*DeleteTrailOutput, error)

DeleteTrail API operation for AWS CloudTrail.

Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

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 AWS CloudTrail's API operation DeleteTrail for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

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

  • NotOrganizationMasterAccountException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteTrail

func (*CloudTrail) DeleteTrailRequest 

func (c *CloudTrail) DeleteTrailRequest(input *DeleteTrailInput) (req *request.Request, output *DeleteTrailOutput)

DeleteTrailRequest generates a "aws/request.Request" representing the client's request for the DeleteTrail 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 DeleteTrail for more information on using the DeleteTrail 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 DeleteTrailRequest method.
req, resp := client.DeleteTrailRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteTrail

func (*CloudTrail) DeleteTrailWithContext added in v1.8.0 

func (c *CloudTrail) DeleteTrailWithContext(ctx aws.Context, input *DeleteTrailInput, opts ...request.Option) (*DeleteTrailOutput, error)

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

See DeleteTrail 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 (*CloudTrail) DescribeQuery added in v1.42.28 

func (c *CloudTrail) DescribeQuery(input *DescribeQueryInput) (*DescribeQueryOutput, error)

DescribeQuery API operation for AWS CloudTrail.

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. You must specify an ARN for EventDataStore, and a value for QueryID.

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 AWS CloudTrail's API operation DescribeQuery for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • InvalidParameterException The request includes a parameter that is not valid.

  • QueryIdNotFoundException The query ID does not exist or does not map to a query.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeQuery

func (*CloudTrail) DescribeQueryRequest added in v1.42.28 

func (c *CloudTrail) DescribeQueryRequest(input *DescribeQueryInput) (req *request.Request, output *DescribeQueryOutput)

DescribeQueryRequest generates a "aws/request.Request" representing the client's request for the DescribeQuery 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 DescribeQuery for more information on using the DescribeQuery 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 DescribeQueryRequest method.
req, resp := client.DescribeQueryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeQuery

func (*CloudTrail) DescribeQueryWithContext added in v1.42.28 

func (c *CloudTrail) DescribeQueryWithContext(ctx aws.Context, input *DescribeQueryInput, opts ...request.Option) (*DescribeQueryOutput, error)

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

See DescribeQuery 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 (*CloudTrail) DescribeTrails 

func (c *CloudTrail) DescribeTrails(input *DescribeTrailsInput) (*DescribeTrailsOutput, error)

DescribeTrails API operation for AWS CloudTrail.

Retrieves settings for one or more trails associated with the current region for your account.

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 AWS CloudTrail's API operation DescribeTrails for usage and error information.

Returned Error Types:

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

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

  • InvalidTrailNameException 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)

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeTrails

func (*CloudTrail) DescribeTrailsRequest 

func (c *CloudTrail) DescribeTrailsRequest(input *DescribeTrailsInput) (req *request.Request, output *DescribeTrailsOutput)

DescribeTrailsRequest generates a "aws/request.Request" representing the client's request for the DescribeTrails 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 DescribeTrails for more information on using the DescribeTrails 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 DescribeTrailsRequest method.
req, resp := client.DescribeTrailsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeTrails

func (*CloudTrail) DescribeTrailsWithContext added in v1.8.0 

func (c *CloudTrail) DescribeTrailsWithContext(ctx aws.Context, input *DescribeTrailsInput, opts ...request.Option) (*DescribeTrailsOutput, error)

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

See DescribeTrails 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 (*CloudTrail) GetEventDataStore added in v1.42.28 

func (c *CloudTrail) GetEventDataStore(input *GetEventDataStoreInput) (*GetEventDataStoreOutput, error)

GetEventDataStore API operation for AWS CloudTrail.

Returns information about an event data store specified as either an ARN or the ID portion of the ARN.

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 AWS CloudTrail's API operation GetEventDataStore for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • InvalidParameterException The request includes a parameter that is not valid.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventDataStore

func (*CloudTrail) GetEventDataStoreRequest added in v1.42.28 

func (c *CloudTrail) GetEventDataStoreRequest(input *GetEventDataStoreInput) (req *request.Request, output *GetEventDataStoreOutput)

GetEventDataStoreRequest generates a "aws/request.Request" representing the client's request for the GetEventDataStore 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 GetEventDataStore for more information on using the GetEventDataStore 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 GetEventDataStoreRequest method.
req, resp := client.GetEventDataStoreRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventDataStore

func (*CloudTrail) GetEventDataStoreWithContext added in v1.42.28 

func (c *CloudTrail) GetEventDataStoreWithContext(ctx aws.Context, input *GetEventDataStoreInput, opts ...request.Option) (*GetEventDataStoreOutput, error)

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

See GetEventDataStore 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 (*CloudTrail) GetEventSelectors added in v1.5.9 

func (c *CloudTrail) GetEventSelectors(input *GetEventSelectorsInput) (*GetEventSelectorsOutput, error)

GetEventSelectors API operation for AWS CloudTrail.

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

  • If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.

  • If your event selector includes management events.

  • If your event selector includes data events, the resources on which you are logging data events.

For more information, see Logging Data and Management Events for Trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) in the CloudTrail User Guide.

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 AWS CloudTrail's API operation GetEventSelectors for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventSelectors

func (*CloudTrail) GetEventSelectorsRequest added in v1.5.9 

func (c *CloudTrail) GetEventSelectorsRequest(input *GetEventSelectorsInput) (req *request.Request, output *GetEventSelectorsOutput)

GetEventSelectorsRequest generates a "aws/request.Request" representing the client's request for the GetEventSelectors 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 GetEventSelectors for more information on using the GetEventSelectors 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 GetEventSelectorsRequest method.
req, resp := client.GetEventSelectorsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventSelectors

func (*CloudTrail) GetEventSelectorsWithContext added in v1.8.0 

func (c *CloudTrail) GetEventSelectorsWithContext(ctx aws.Context, input *GetEventSelectorsInput, opts ...request.Option) (*GetEventSelectorsOutput, error)

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

See GetEventSelectors 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 (*CloudTrail) GetInsightSelectors added in v1.25.39 

func (c *CloudTrail) GetInsightSelectors(input *GetInsightSelectorsInput) (*GetInsightSelectorsOutput, error)

GetInsightSelectors API operation for AWS CloudTrail.

Describes the settings for the Insights event selectors that you configured for your trail. GetInsightSelectors shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run GetInsightSelectors on a trail that does not have Insights events enabled, the operation throws the exception InsightNotEnabledException

For more information, see Logging CloudTrail Insights Events for Trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html) in the CloudTrail User Guide.

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 AWS CloudTrail's API operation GetInsightSelectors for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetInsightSelectors

func (*CloudTrail) GetInsightSelectorsRequest added in v1.25.39 

func (c *CloudTrail) GetInsightSelectorsRequest(input *GetInsightSelectorsInput) (req *request.Request, output *GetInsightSelectorsOutput)

GetInsightSelectorsRequest generates a "aws/request.Request" representing the client's request for the GetInsightSelectors 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 GetInsightSelectors for more information on using the GetInsightSelectors 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 GetInsightSelectorsRequest method.
req, resp := client.GetInsightSelectorsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetInsightSelectors

func (*CloudTrail) GetInsightSelectorsWithContext added in v1.25.39 

func (c *CloudTrail) GetInsightSelectorsWithContext(ctx aws.Context, input *GetInsightSelectorsInput, opts ...request.Option) (*GetInsightSelectorsOutput, error)

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

See GetInsightSelectors 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 (*CloudTrail) GetQueryResults added in v1.42.28 

func (c *CloudTrail) GetQueryResults(input *GetQueryResultsInput) (*GetQueryResultsOutput, error)

GetQueryResults API operation for AWS CloudTrail.

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation, and an ARN for EventDataStore.

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 AWS CloudTrail's API operation GetQueryResults for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

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

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

  • InvalidParameterException The request includes a parameter that is not valid.

  • QueryIdNotFoundException The query ID does not exist or does not map to a query.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetQueryResults

func (*CloudTrail) GetQueryResultsPages added in v1.42.28 

func (c *CloudTrail) GetQueryResultsPages(input *GetQueryResultsInput, fn func(*GetQueryResultsOutput, bool) bool) error

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

See GetQueryResults 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 GetQueryResults operation.
pageNum := 0
err := client.GetQueryResultsPages(params,
    func(page *cloudtrail.GetQueryResultsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudTrail) GetQueryResultsPagesWithContext added in v1.42.28 

func (c *CloudTrail) GetQueryResultsPagesWithContext(ctx aws.Context, input *GetQueryResultsInput, fn func(*GetQueryResultsOutput, bool) bool, opts ...request.Option) error

GetQueryResultsPagesWithContext same as GetQueryResultsPages 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 (*CloudTrail) GetQueryResultsRequest added in v1.42.28 

func (c *CloudTrail) GetQueryResultsRequest(input *GetQueryResultsInput) (req *request.Request, output *GetQueryResultsOutput)

GetQueryResultsRequest generates a "aws/request.Request" representing the client's request for the GetQueryResults 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 GetQueryResults for more information on using the GetQueryResults 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 GetQueryResultsRequest method.
req, resp := client.GetQueryResultsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetQueryResults

func (*CloudTrail) GetQueryResultsWithContext added in v1.42.28 

func (c *CloudTrail) GetQueryResultsWithContext(ctx aws.Context, input *GetQueryResultsInput, opts ...request.Option) (*GetQueryResultsOutput, error)

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

See GetQueryResults 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 (*CloudTrail) GetTrail added in v1.25.25 

func (c *CloudTrail) GetTrail(input *GetTrailInput) (*GetTrailOutput, error)

GetTrail API operation for AWS CloudTrail.

Returns settings information for a specified trail.

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 AWS CloudTrail's API operation GetTrail for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrail

func (*CloudTrail) GetTrailRequest added in v1.25.25 

func (c *CloudTrail) GetTrailRequest(input *GetTrailInput) (req *request.Request, output *GetTrailOutput)

GetTrailRequest generates a "aws/request.Request" representing the client's request for the GetTrail 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 GetTrail for more information on using the GetTrail 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 GetTrailRequest method.
req, resp := client.GetTrailRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrail

func (*CloudTrail) GetTrailStatus 

func (c *CloudTrail) GetTrailStatus(input *GetTrailStatusInput) (*GetTrailStatusOutput, error)

GetTrailStatus API operation for AWS CloudTrail.

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

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 AWS CloudTrail's API operation GetTrailStatus for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailStatus

func (*CloudTrail) GetTrailStatusRequest 

func (c *CloudTrail) GetTrailStatusRequest(input *GetTrailStatusInput) (req *request.Request, output *GetTrailStatusOutput)

GetTrailStatusRequest generates a "aws/request.Request" representing the client's request for the GetTrailStatus 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 GetTrailStatus for more information on using the GetTrailStatus 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 GetTrailStatusRequest method.
req, resp := client.GetTrailStatusRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailStatus

func (*CloudTrail) GetTrailStatusWithContext added in v1.8.0 

func (c *CloudTrail) GetTrailStatusWithContext(ctx aws.Context, input *GetTrailStatusInput, opts ...request.Option) (*GetTrailStatusOutput, error)

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

See GetTrailStatus 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 (*CloudTrail) GetTrailWithContext added in v1.25.25 

func (c *CloudTrail) GetTrailWithContext(ctx aws.Context, input *GetTrailInput, opts ...request.Option) (*GetTrailOutput, error)

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

See GetTrail 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 (*CloudTrail) ListEventDataStores added in v1.42.28 

func (c *CloudTrail) ListEventDataStores(input *ListEventDataStoresInput) (*ListEventDataStoresOutput, error)

ListEventDataStores API operation for AWS CloudTrail.

Returns information about all event data stores in the account, in the current region.

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 AWS CloudTrail's API operation ListEventDataStores for usage and error information.

Returned Error Types:

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListEventDataStores

func (*CloudTrail) ListEventDataStoresPages added in v1.42.28 

func (c *CloudTrail) ListEventDataStoresPages(input *ListEventDataStoresInput, fn func(*ListEventDataStoresOutput, bool) bool) error

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

See ListEventDataStores 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 ListEventDataStores operation.
pageNum := 0
err := client.ListEventDataStoresPages(params,
    func(page *cloudtrail.ListEventDataStoresOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudTrail) ListEventDataStoresPagesWithContext added in v1.42.28 

func (c *CloudTrail) ListEventDataStoresPagesWithContext(ctx aws.Context, input *ListEventDataStoresInput, fn func(*ListEventDataStoresOutput, bool) bool, opts ...request.Option) error

ListEventDataStoresPagesWithContext same as ListEventDataStoresPages 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 (*CloudTrail) ListEventDataStoresRequest added in v1.42.28 

func (c *CloudTrail) ListEventDataStoresRequest(input *ListEventDataStoresInput) (req *request.Request, output *ListEventDataStoresOutput)

ListEventDataStoresRequest generates a "aws/request.Request" representing the client's request for the ListEventDataStores 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 ListEventDataStores for more information on using the ListEventDataStores 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 ListEventDataStoresRequest method.
req, resp := client.ListEventDataStoresRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListEventDataStores

func (*CloudTrail) ListEventDataStoresWithContext added in v1.42.28 

func (c *CloudTrail) ListEventDataStoresWithContext(ctx aws.Context, input *ListEventDataStoresInput, opts ...request.Option) (*ListEventDataStoresOutput, error)

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

See ListEventDataStores 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 (*CloudTrail) ListPublicKeys added in v0.9.11 

func (c *CloudTrail) ListPublicKeys(input *ListPublicKeysInput) (*ListPublicKeysOutput, error)

ListPublicKeys API operation for AWS CloudTrail.

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private and public key pairs per region. Each digest file is signed with a private key unique to its region. When you validate a digest file from a specific region, you must look in the same region for its corresponding public 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 AWS CloudTrail's API operation ListPublicKeys for usage and error information.

Returned Error Types:

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

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

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

  • InvalidTokenException Reserved for future use.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListPublicKeys

func (*CloudTrail) ListPublicKeysPages added in v1.25.25 

func (c *CloudTrail) ListPublicKeysPages(input *ListPublicKeysInput, fn func(*ListPublicKeysOutput, bool) bool) error

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

See ListPublicKeys 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 ListPublicKeys operation.
pageNum := 0
err := client.ListPublicKeysPages(params,
    func(page *cloudtrail.ListPublicKeysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudTrail) ListPublicKeysPagesWithContext added in v1.25.25 

func (c *CloudTrail) ListPublicKeysPagesWithContext(ctx aws.Context, input *ListPublicKeysInput, fn func(*ListPublicKeysOutput, bool) bool, opts ...request.Option) error

ListPublicKeysPagesWithContext same as ListPublicKeysPages 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 (*CloudTrail) ListPublicKeysRequest added in v0.9.11 

func (c *CloudTrail) ListPublicKeysRequest(input *ListPublicKeysInput) (req *request.Request, output *ListPublicKeysOutput)

ListPublicKeysRequest generates a "aws/request.Request" representing the client's request for the ListPublicKeys 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 ListPublicKeys for more information on using the ListPublicKeys 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 ListPublicKeysRequest method.
req, resp := client.ListPublicKeysRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListPublicKeys

func (*CloudTrail) ListPublicKeysWithContext added in v1.8.0 

func (c *CloudTrail) ListPublicKeysWithContext(ctx aws.Context, input *ListPublicKeysInput, opts ...request.Option) (*ListPublicKeysOutput, error)

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

See ListPublicKeys 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 (*CloudTrail) ListQueries added in v1.42.28 

func (c *CloudTrail) ListQueries(input *ListQueriesInput) (*ListQueriesOutput, error)

ListQueries API operation for AWS CloudTrail.

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, or CANCELLED.

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 AWS CloudTrail's API operation ListQueries for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • InvalidDateRangeException A date range for the query was specified that is not valid. For more information about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) in the CloudTrail User Guide.

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

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

  • InvalidParameterException The request includes a parameter that is not valid.

  • InvalidQueryStatusException The query status is not valid for the operation.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListQueries

func (*CloudTrail) ListQueriesPages added in v1.42.28 

func (c *CloudTrail) ListQueriesPages(input *ListQueriesInput, fn func(*ListQueriesOutput, bool) bool) error

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

See ListQueries 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 ListQueries operation.
pageNum := 0
err := client.ListQueriesPages(params,
    func(page *cloudtrail.ListQueriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudTrail) ListQueriesPagesWithContext added in v1.42.28 

func (c *CloudTrail) ListQueriesPagesWithContext(ctx aws.Context, input *ListQueriesInput, fn func(*ListQueriesOutput, bool) bool, opts ...request.Option) error

ListQueriesPagesWithContext same as ListQueriesPages 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 (*CloudTrail) ListQueriesRequest added in v1.42.28 

func (c *CloudTrail) ListQueriesRequest(input *ListQueriesInput) (req *request.Request, output *ListQueriesOutput)

ListQueriesRequest generates a "aws/request.Request" representing the client's request for the ListQueries 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 ListQueries for more information on using the ListQueries 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 ListQueriesRequest method.
req, resp := client.ListQueriesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListQueries

func (*CloudTrail) ListQueriesWithContext added in v1.42.28 

func (c *CloudTrail) ListQueriesWithContext(ctx aws.Context, input *ListQueriesInput, opts ...request.Option) (*ListQueriesOutput, error)

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

See ListQueries 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 (*CloudTrail) ListTags added in v0.9.11 

func (c *CloudTrail) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

ListTags API operation for AWS CloudTrail.

Lists the tags for the trail in the current region.

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 AWS CloudTrail's API operation ListTags for usage and error information.

Returned Error Types:

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

  • ARNInvalidException 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

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

  • InvalidTrailNameException 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)

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • EventDataStoreNotFoundException The specified event data store was not found.

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

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

  • InvalidTokenException Reserved for future use.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListTags

func (*CloudTrail) ListTagsPages added in v1.25.25 

func (c *CloudTrail) ListTagsPages(input *ListTagsInput, fn func(*ListTagsOutput, bool) bool) error

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

See ListTags 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 ListTags operation.
pageNum := 0
err := client.ListTagsPages(params,
    func(page *cloudtrail.ListTagsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudTrail) ListTagsPagesWithContext added in v1.25.25 

func (c *CloudTrail) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, fn func(*ListTagsOutput, bool) bool, opts ...request.Option) error

ListTagsPagesWithContext same as ListTagsPages 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 (*CloudTrail) ListTagsRequest added in v0.9.11 

func (c *CloudTrail) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

ListTagsRequest generates a "aws/request.Request" representing the client's request for the ListTags 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 ListTags for more information on using the ListTags 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 ListTagsRequest method.
req, resp := client.ListTagsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListTags

func (*CloudTrail) ListTagsWithContext added in v1.8.0 

func (c *CloudTrail) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

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

See ListTags 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 (*CloudTrail) ListTrails added in v1.25.25 

func (c *CloudTrail) ListTrails(input *ListTrailsInput) (*ListTrailsOutput, error)

ListTrails API operation for AWS CloudTrail.

Lists trails that are in the current account.

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 AWS CloudTrail's API operation ListTrails for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListTrails

func (*CloudTrail) ListTrailsPages added in v1.25.25 

func (c *CloudTrail) ListTrailsPages(input *ListTrailsInput, fn func(*ListTrailsOutput, bool) bool) error

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

See ListTrails 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 ListTrails operation.
pageNum := 0
err := client.ListTrailsPages(params,
    func(page *cloudtrail.ListTrailsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudTrail) ListTrailsPagesWithContext added in v1.25.25 

func (c *CloudTrail) ListTrailsPagesWithContext(ctx aws.Context, input *ListTrailsInput, fn func(*ListTrailsOutput, bool) bool, opts ...request.Option) error

ListTrailsPagesWithContext same as ListTrailsPages 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 (*CloudTrail) ListTrailsRequest added in v1.25.25 

func (c *CloudTrail) ListTrailsRequest(input *ListTrailsInput) (req *request.Request, output *ListTrailsOutput)

ListTrailsRequest generates a "aws/request.Request" representing the client's request for the ListTrails 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 ListTrails for more information on using the ListTrails 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 ListTrailsRequest method.
req, resp := client.ListTrailsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListTrails

func (*CloudTrail) ListTrailsWithContext added in v1.25.25 

func (c *CloudTrail) ListTrailsWithContext(ctx aws.Context, input *ListTrailsInput, opts ...request.Option) (*ListTrailsOutput, error)

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

See ListTrails 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 (*CloudTrail) LookupEvents 

func (c *CloudTrail) LookupEvents(input *LookupEventsInput) (*LookupEventsOutput, error)

LookupEvents API operation for AWS CloudTrail.

Looks up management events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events) or CloudTrail Insights events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events) that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events:

  • Amazon Web Services access key

  • Event ID

  • Event name

  • Event source

  • Read only

  • Resource name

  • Resource type

  • User name

Lookup supports the following attributes for Insights events:

  • Event ID

  • Event name

  • Event source

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs.

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 AWS CloudTrail's API operation LookupEvents for usage and error information.

Returned Error Types:

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

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

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

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/LookupEvents

func (*CloudTrail) LookupEventsPages added in v1.6.5 

func (c *CloudTrail) LookupEventsPages(input *LookupEventsInput, fn func(*LookupEventsOutput, bool) bool) error

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

See LookupEvents 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 LookupEvents operation.
pageNum := 0
err := client.LookupEventsPages(params,
    func(page *cloudtrail.LookupEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudTrail) LookupEventsPagesWithContext added in v1.8.0 

func (c *CloudTrail) LookupEventsPagesWithContext(ctx aws.Context, input *LookupEventsInput, fn func(*LookupEventsOutput, bool) bool, opts ...request.Option) error

LookupEventsPagesWithContext same as LookupEventsPages 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 (*CloudTrail) LookupEventsRequest 

func (c *CloudTrail) LookupEventsRequest(input *LookupEventsInput) (req *request.Request, output *LookupEventsOutput)

LookupEventsRequest generates a "aws/request.Request" representing the client's request for the LookupEvents 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 LookupEvents for more information on using the LookupEvents 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 LookupEventsRequest method.
req, resp := client.LookupEventsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/LookupEvents

func (*CloudTrail) LookupEventsWithContext added in v1.8.0 

func (c *CloudTrail) LookupEventsWithContext(ctx aws.Context, input *LookupEventsInput, opts ...request.Option) (*LookupEventsOutput, error)

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

See LookupEvents 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 (*CloudTrail) PutEventSelectors added in v1.5.9 

func (c *CloudTrail) PutEventSelectors(input *PutEventSelectorsInput) (*PutEventSelectorsOutput, error)

PutEventSelectors API operation for AWS CloudTrail.

Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in 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.

Example

You create an event selector for a trail and specify that you want write-only events.

The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

CloudTrail evaluates whether the events match your event selectors.

The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

The GetConsoleOutput is a read-only event that doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException exception is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging data and management events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) and Quotas in CloudTrail (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the CloudTrail User Guide.

You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors, but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. 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.

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 AWS CloudTrail's API operation PutEventSelectors for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

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

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

  • NotOrganizationMasterAccountException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutEventSelectors

func (*CloudTrail) PutEventSelectorsRequest added in v1.5.9 

func (c *CloudTrail) PutEventSelectorsRequest(input *PutEventSelectorsInput) (req *request.Request, output *PutEventSelectorsOutput)

PutEventSelectorsRequest generates a "aws/request.Request" representing the client's request for the PutEventSelectors 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 PutEventSelectors for more information on using the PutEventSelectors 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 PutEventSelectorsRequest method.
req, resp := client.PutEventSelectorsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutEventSelectors

func (*CloudTrail) PutEventSelectorsWithContext added in v1.8.0 

func (c *CloudTrail) PutEventSelectorsWithContext(ctx aws.Context, input *PutEventSelectorsInput, opts ...request.Option) (*PutEventSelectorsOutput, error)

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

See PutEventSelectors 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 (*CloudTrail) PutInsightSelectors added in v1.25.39 

func (c *CloudTrail) PutInsightSelectors(input *PutInsightSelectorsInput) (*PutInsightSelectorsOutput, error)

PutInsightSelectors API operation for AWS CloudTrail.

Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. The valid Insights event types in this release are ApiErrorRateInsight and ApiCallRateInsight.

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 AWS CloudTrail's API operation PutInsightSelectors for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

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

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

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

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

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

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

  • NotOrganizationMasterAccountException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectors

func (*CloudTrail) PutInsightSelectorsRequest added in v1.25.39 

func (c *CloudTrail) PutInsightSelectorsRequest(input *PutInsightSelectorsInput) (req *request.Request, output *PutInsightSelectorsOutput)

PutInsightSelectorsRequest generates a "aws/request.Request" representing the client's request for the PutInsightSelectors 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 PutInsightSelectors for more information on using the PutInsightSelectors 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 PutInsightSelectorsRequest method.
req, resp := client.PutInsightSelectorsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectors

func (*CloudTrail) PutInsightSelectorsWithContext added in v1.25.39 

func (c *CloudTrail) PutInsightSelectorsWithContext(ctx aws.Context, input *PutInsightSelectorsInput, opts ...request.Option) (*PutInsightSelectorsOutput, error)

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

See PutInsightSelectors 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 (*CloudTrail) RemoveTags added in v0.9.11 

func (c *CloudTrail) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error)

RemoveTags API operation for AWS CloudTrail.

Removes the specified tags from a trail.

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 AWS CloudTrail's API operation RemoveTags for usage and error information.

Returned Error Types:

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

  • ARNInvalidException 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

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

  • InvalidTrailNameException 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)

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

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • EventDataStoreNotFoundException The specified event data store was not found.

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

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

  • NotOrganizationMasterAccountException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RemoveTags

func (*CloudTrail) RemoveTagsRequest added in v0.9.11 

func (c *CloudTrail) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput)

RemoveTagsRequest generates a "aws/request.Request" representing the client's request for the RemoveTags 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 RemoveTags for more information on using the RemoveTags 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 RemoveTagsRequest method.
req, resp := client.RemoveTagsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RemoveTags

func (*CloudTrail) RemoveTagsWithContext added in v1.8.0 

func (c *CloudTrail) RemoveTagsWithContext(ctx aws.Context, input *RemoveTagsInput, opts ...request.Option) (*RemoveTagsOutput, error)

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

See RemoveTags 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 (*CloudTrail) RestoreEventDataStore added in v1.42.28 

func (c *CloudTrail) RestoreEventDataStore(input *RestoreEventDataStoreInput) (*RestoreEventDataStoreOutput, error)

RestoreEventDataStore API operation for AWS CloudTrail.

Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.

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 AWS CloudTrail's API operation RestoreEventDataStore for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • EventDataStoreMaxLimitExceededException Your account has used the maximum number of event data stores.

  • InvalidEventDataStoreStatusException The event data store is not in a status that supports the operation.

  • InvalidParameterException The request includes a parameter that is not valid.

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

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

  • AccessNotEnabledException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

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

  • NotOrganizationMasterAccountException 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).

  • OrganizationNotInAllFeaturesModeException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RestoreEventDataStore

func (*CloudTrail) RestoreEventDataStoreRequest added in v1.42.28 

func (c *CloudTrail) RestoreEventDataStoreRequest(input *RestoreEventDataStoreInput) (req *request.Request, output *RestoreEventDataStoreOutput)

RestoreEventDataStoreRequest generates a "aws/request.Request" representing the client's request for the RestoreEventDataStore 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 RestoreEventDataStore for more information on using the RestoreEventDataStore 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 RestoreEventDataStoreRequest method.
req, resp := client.RestoreEventDataStoreRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RestoreEventDataStore

func (*CloudTrail) RestoreEventDataStoreWithContext added in v1.42.28 

func (c *CloudTrail) RestoreEventDataStoreWithContext(ctx aws.Context, input *RestoreEventDataStoreInput, opts ...request.Option) (*RestoreEventDataStoreOutput, error)

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

See RestoreEventDataStore 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 (*CloudTrail) StartLogging 

func (c *CloudTrail) StartLogging(input *StartLoggingInput) (*StartLoggingOutput, error)

StartLogging API operation for AWS CloudTrail.

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

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 AWS CloudTrail's API operation StartLogging for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

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

  • NotOrganizationMasterAccountException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartLogging

func (*CloudTrail) StartLoggingRequest 

func (c *CloudTrail) StartLoggingRequest(input *StartLoggingInput) (req *request.Request, output *StartLoggingOutput)

StartLoggingRequest generates a "aws/request.Request" representing the client's request for the StartLogging 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 StartLogging for more information on using the StartLogging 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 StartLoggingRequest method.
req, resp := client.StartLoggingRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartLogging

func (*CloudTrail) StartLoggingWithContext added in v1.8.0 

func (c *CloudTrail) StartLoggingWithContext(ctx aws.Context, input *StartLoggingInput, opts ...request.Option) (*StartLoggingOutput, error)

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

See StartLogging 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 (*CloudTrail) StartQuery added in v1.42.28 

func (c *CloudTrail) StartQuery(input *StartQueryInput) (*StartQueryOutput, error)

StartQuery API operation for AWS CloudTrail.

Starts a CloudTrail Lake query. The required QueryStatement parameter provides your SQL query, enclosed in single quotation marks.

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 AWS CloudTrail's API operation StartQuery for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • InvalidParameterException The request includes a parameter that is not valid.

  • InvalidQueryStatementException The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) in the CloudTrail User Guide.

  • MaxConcurrentQueriesException You are already running the maximum number of concurrent queries. Wait a minute for some queries to finish, and then run the query again.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartQuery

func (*CloudTrail) StartQueryRequest added in v1.42.28 

func (c *CloudTrail) StartQueryRequest(input *StartQueryInput) (req *request.Request, output *StartQueryOutput)

StartQueryRequest generates a "aws/request.Request" representing the client's request for the StartQuery 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 StartQuery for more information on using the StartQuery 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 StartQueryRequest method.
req, resp := client.StartQueryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartQuery

func (*CloudTrail) StartQueryWithContext added in v1.42.28 

func (c *CloudTrail) StartQueryWithContext(ctx aws.Context, input *StartQueryInput, opts ...request.Option) (*StartQueryOutput, error)

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

See StartQuery 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 (*CloudTrail) StopLogging 

func (c *CloudTrail) StopLogging(input *StopLoggingInput) (*StopLoggingOutput, error)

StopLogging API operation for AWS CloudTrail.

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

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 AWS CloudTrail's API operation StopLogging for usage and error information.

Returned Error Types:

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

  • InvalidTrailNameException 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)

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

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

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

  • NotOrganizationMasterAccountException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StopLogging

func (*CloudTrail) StopLoggingRequest 

func (c *CloudTrail) StopLoggingRequest(input *StopLoggingInput) (req *request.Request, output *StopLoggingOutput)

StopLoggingRequest generates a "aws/request.Request" representing the client's request for the StopLogging 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 StopLogging for more information on using the StopLogging 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 StopLoggingRequest method.
req, resp := client.StopLoggingRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StopLogging

func (*CloudTrail) StopLoggingWithContext added in v1.8.0 

func (c *CloudTrail) StopLoggingWithContext(ctx aws.Context, input *StopLoggingInput, opts ...request.Option) (*StopLoggingOutput, error)

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

See StopLogging 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 (*CloudTrail) UpdateEventDataStore added in v1.42.28 

func (c *CloudTrail) UpdateEventDataStore(input *UpdateEventDataStoreInput) (*UpdateEventDataStoreOutput, error)

UpdateEventDataStore API operation for AWS CloudTrail.

Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. RetentionPeriod is in days, and valid values are integers between 90 and 2555. By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management and data events in your event data store; for more information about AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.

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 AWS CloudTrail's API operation UpdateEventDataStore for usage and error information.

Returned Error Types:

  • EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.

  • EventDataStoreNotFoundException The specified event data store was not found.

  • InactiveEventDataStoreException The event data store against which you ran your query is inactive.

  • InvalidParameterException The request includes a parameter that is not valid.

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

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

  • AccessNotEnabledException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

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

  • NotOrganizationMasterAccountException 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).

  • OrganizationNotInAllFeaturesModeException 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).

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateEventDataStore

func (*CloudTrail) UpdateEventDataStoreRequest added in v1.42.28 

func (c *CloudTrail) UpdateEventDataStoreRequest(input *UpdateEventDataStoreInput) (req *request.Request, output *UpdateEventDataStoreOutput)

UpdateEventDataStoreRequest generates a "aws/request.Request" representing the client's request for the UpdateEventDataStore 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 UpdateEventDataStore for more information on using the UpdateEventDataStore 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 UpdateEventDataStoreRequest method.
req, resp := client.UpdateEventDataStoreRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateEventDataStore

func (*CloudTrail) UpdateEventDataStoreWithContext added in v1.42.28 

func (c *CloudTrail) UpdateEventDataStoreWithContext(ctx aws.Context, input *UpdateEventDataStoreInput, opts ...request.Option) (*UpdateEventDataStoreOutput, error)

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

See UpdateEventDataStore 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 (*CloudTrail) UpdateTrail 

func (c *CloudTrail) UpdateTrail(input *UpdateTrailInput) (*UpdateTrailOutput, error)

UpdateTrail API operation for AWS CloudTrail.

Updates trail settings that control what events you are logging, and how to handle log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

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 AWS CloudTrail's API operation UpdateTrail for usage and error information.

Returned Error Types:

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

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

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

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

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

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

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

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

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

  • InvalidTrailNameException 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)

  • TrailNotProvidedException This exception is no longer in use.

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

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

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

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

  • KmsKeyDisabledException This exception is no longer in use.

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

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

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

  • CloudWatchLogsDeliveryUnavailableException Cannot set a CloudWatch Logs delivery for this region.

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

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

  • AccessNotEnabledException 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).

  • InsufficientDependencyServiceAccessPermissionException 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).

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

  • NotOrganizationMasterAccountException 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).

  • OrganizationNotInAllFeaturesModeException 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).

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateTrail

func (*CloudTrail) UpdateTrailRequest 

func (c *CloudTrail) UpdateTrailRequest(input *UpdateTrailInput) (req *request.Request, output *UpdateTrailOutput)

UpdateTrailRequest generates a "aws/request.Request" representing the client's request for the UpdateTrail 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 UpdateTrail for more information on using the UpdateTrail 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 UpdateTrailRequest method.
req, resp := client.UpdateTrailRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateTrail

func (*CloudTrail) UpdateTrailWithContext added in v1.8.0 

func (c *CloudTrail) UpdateTrailWithContext(ctx aws.Context, input *UpdateTrailInput, opts ...request.Option) (*UpdateTrailOutput, error)

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

See UpdateTrail 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 CloudTrailInvalidClientTokenIdException added in v1.36.7 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.36.7 

func (s *CloudTrailInvalidClientTokenIdException) Code() string

Code returns the exception type name.

func (*CloudTrailInvalidClientTokenIdException) Error added in v1.36.7 

func (s *CloudTrailInvalidClientTokenIdException) Error() string

func (CloudTrailInvalidClientTokenIdException) GoString added in v1.36.7 

func (s CloudTrailInvalidClientTokenIdException) 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 (*CloudTrailInvalidClientTokenIdException) Message added in v1.36.7 

func (s *CloudTrailInvalidClientTokenIdException) Message() string

Message returns the exception's message.

func (*CloudTrailInvalidClientTokenIdException) OrigErr added in v1.36.7 

func (s *CloudTrailInvalidClientTokenIdException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CloudTrailInvalidClientTokenIdException) RequestID added in v1.36.7 

func (s *CloudTrailInvalidClientTokenIdException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CloudTrailInvalidClientTokenIdException) StatusCode added in v1.36.7 

func (s *CloudTrailInvalidClientTokenIdException) StatusCode() int

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

func (CloudTrailInvalidClientTokenIdException) String added in v1.36.7 

func (s CloudTrailInvalidClientTokenIdException) 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 CloudWatchLogsDeliveryUnavailableException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Cannot set a CloudWatch Logs delivery for this region.

func (*CloudWatchLogsDeliveryUnavailableException) Code added in v1.28.0 

func (s *CloudWatchLogsDeliveryUnavailableException) Code() string

Code returns the exception type name.

func (*CloudWatchLogsDeliveryUnavailableException) Error added in v1.28.0 

func (s *CloudWatchLogsDeliveryUnavailableException) Error() string

func (CloudWatchLogsDeliveryUnavailableException) GoString added in v1.28.0 

func (s CloudWatchLogsDeliveryUnavailableException) 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 (*CloudWatchLogsDeliveryUnavailableException) Message added in v1.28.0 

func (s *CloudWatchLogsDeliveryUnavailableException) Message() string

Message returns the exception's message.

func (*CloudWatchLogsDeliveryUnavailableException) OrigErr added in v1.28.0 

func (s *CloudWatchLogsDeliveryUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CloudWatchLogsDeliveryUnavailableException) RequestID added in v1.28.0 

func (s *CloudWatchLogsDeliveryUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CloudWatchLogsDeliveryUnavailableException) StatusCode added in v1.28.0 

func (s *CloudWatchLogsDeliveryUnavailableException) StatusCode() int

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

func (CloudWatchLogsDeliveryUnavailableException) String added in v1.28.0 

func (s CloudWatchLogsDeliveryUnavailableException) 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 added in v1.37.7 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.37.7 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.37.7 

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.37.7 

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 added in v1.37.7 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.37.7 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.37.7 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.37.7 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String added in v1.37.7 

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 CreateEventDataStoreInput added in v1.42.28 

type CreateEventDataStoreInput struct {

	// The advanced event selectors to use to select the events for the data store.
	// For more information about how to use advanced event selectors, see Log events
	// by using advanced event selectors (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced)
	// in the CloudTrail User Guide.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// Specifies whether the event data store includes events from all regions,
	// or only from the region in which the event data store is created.
	MultiRegionEnabled *bool `type:"boolean"`

	// The name of the event data store.
	//
	// Name is a required field
	Name *string `min:"3" type:"string" required:"true"`

	// Specifies whether an event data store collects events logged for an organization
	// in Organizations.
	OrganizationEnabled *bool `type:"boolean"`

	// The retention period of the event data store, in days. You can set a retention
	// period of up to 2555 days, the equivalent of seven years.
	RetentionPeriod *int64 `min:"7" type:"integer"`

	// A list of tags.
	TagsList []*Tag `type:"list"`

	// Specifies whether termination protection is enabled for the event data store.
	// If termination protection is enabled, you cannot delete the event data store
	// until termination protection is disabled.
	TerminationProtectionEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (CreateEventDataStoreInput) GoString added in v1.42.28 

func (s CreateEventDataStoreInput) 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 (*CreateEventDataStoreInput) SetAdvancedEventSelectors added in v1.42.28 

func (s *CreateEventDataStoreInput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *CreateEventDataStoreInput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*CreateEventDataStoreInput) SetMultiRegionEnabled added in v1.42.28 

func (s *CreateEventDataStoreInput) SetMultiRegionEnabled(v bool) *CreateEventDataStoreInput

SetMultiRegionEnabled sets the MultiRegionEnabled field's value.

func (*CreateEventDataStoreInput) SetName added in v1.42.28 

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

SetName sets the Name field's value.

func (*CreateEventDataStoreInput) SetOrganizationEnabled added in v1.42.28 

func (s *CreateEventDataStoreInput) SetOrganizationEnabled(v bool) *CreateEventDataStoreInput

SetOrganizationEnabled sets the OrganizationEnabled field's value.

func (*CreateEventDataStoreInput) SetRetentionPeriod added in v1.42.28 

func (s *CreateEventDataStoreInput) SetRetentionPeriod(v int64) *CreateEventDataStoreInput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*CreateEventDataStoreInput) SetTagsList added in v1.42.28 

func (s *CreateEventDataStoreInput) SetTagsList(v []*Tag) *CreateEventDataStoreInput

SetTagsList sets the TagsList field's value.

func (*CreateEventDataStoreInput) SetTerminationProtectionEnabled added in v1.42.28 

func (s *CreateEventDataStoreInput) SetTerminationProtectionEnabled(v bool) *CreateEventDataStoreInput

SetTerminationProtectionEnabled sets the TerminationProtectionEnabled field's value.

func (CreateEventDataStoreInput) String added in v1.42.28 

func (s CreateEventDataStoreInput) 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 (*CreateEventDataStoreInput) Validate added in v1.42.28 

func (s *CreateEventDataStoreInput) Validate() error

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

type CreateEventDataStoreOutput added in v1.42.28 

type CreateEventDataStoreOutput struct {

	// The advanced event selectors that were used to select the events for the
	// data store.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// The timestamp that shows when the event data store was created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ARN of the event data store.
	EventDataStoreArn *string `min:"3" type:"string"`

	// Indicates whether the event data store collects events from all regions,
	// or only from the region in which it was created.
	MultiRegionEnabled *bool `type:"boolean"`

	// The name of the event data store.
	Name *string `min:"3" type:"string"`

	// Indicates whether an event data store is collecting logged events for an
	// organization in Organizations.
	OrganizationEnabled *bool `type:"boolean"`

	// The retention period of an event data store, in days.
	RetentionPeriod *int64 `min:"7" type:"integer"`

	// The status of event data store creation.
	Status *string `type:"string" enum:"EventDataStoreStatus"`

	// A list of tags.
	TagsList []*Tag `type:"list"`

	// Indicates whether termination protection is enabled for the event data store.
	TerminationProtectionEnabled *bool `type:"boolean"`

	// The timestamp that shows when an event data store was updated, if applicable.
	// UpdatedTimestamp is always either the same or newer than the time shown in
	// CreatedTimestamp.
	UpdatedTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (CreateEventDataStoreOutput) GoString added in v1.42.28 

func (s CreateEventDataStoreOutput) 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 (*CreateEventDataStoreOutput) SetAdvancedEventSelectors added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *CreateEventDataStoreOutput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*CreateEventDataStoreOutput) SetCreatedTimestamp added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetCreatedTimestamp(v time.Time) *CreateEventDataStoreOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*CreateEventDataStoreOutput) SetEventDataStoreArn added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetEventDataStoreArn(v string) *CreateEventDataStoreOutput

SetEventDataStoreArn sets the EventDataStoreArn field's value.

func (*CreateEventDataStoreOutput) SetMultiRegionEnabled added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetMultiRegionEnabled(v bool) *CreateEventDataStoreOutput

SetMultiRegionEnabled sets the MultiRegionEnabled field's value.

func (*CreateEventDataStoreOutput) SetName added in v1.42.28 

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

SetName sets the Name field's value.

func (*CreateEventDataStoreOutput) SetOrganizationEnabled added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetOrganizationEnabled(v bool) *CreateEventDataStoreOutput

SetOrganizationEnabled sets the OrganizationEnabled field's value.

func (*CreateEventDataStoreOutput) SetRetentionPeriod added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetRetentionPeriod(v int64) *CreateEventDataStoreOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*CreateEventDataStoreOutput) SetStatus added in v1.42.28 

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

SetStatus sets the Status field's value.

func (*CreateEventDataStoreOutput) SetTagsList added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetTagsList(v []*Tag) *CreateEventDataStoreOutput

SetTagsList sets the TagsList field's value.

func (*CreateEventDataStoreOutput) SetTerminationProtectionEnabled added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetTerminationProtectionEnabled(v bool) *CreateEventDataStoreOutput

SetTerminationProtectionEnabled sets the TerminationProtectionEnabled field's value.

func (*CreateEventDataStoreOutput) SetUpdatedTimestamp added in v1.42.28 

func (s *CreateEventDataStoreOutput) SetUpdatedTimestamp(v time.Time) *CreateEventDataStoreOutput

SetUpdatedTimestamp sets the UpdatedTimestamp field's value.

func (CreateEventDataStoreOutput) String added in v1.42.28 

func (s CreateEventDataStoreOutput) 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 CreateTrailInput 

type CreateTrailInput struct {

	// Specifies a log group name using an Amazon Resource Name (ARN), a unique
	// identifier that represents the log group to which CloudTrail logs will be
	// delivered. Not required unless you specify CloudWatchLogsRoleArn.
	CloudWatchLogsLogGroupArn *string `type:"string"`

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

	// Specifies whether log file integrity validation is enabled. The default is
	// false.
	//
	// When you disable log file integrity validation, the chain of digest files
	// is broken after one hour. CloudTrail does not create digest files for log
	// files that were delivered during a period in which log file integrity validation
	// was disabled. For example, if you enable log file integrity validation at
	// noon on January 1, disable it at noon on January 2, and re-enable it at noon
	// on January 10, digest files will not be created for the log files delivered
	// from noon on January 2 to noon on January 10. The same applies whenever you
	// stop CloudTrail logging or delete a trail.
	EnableLogFileValidation *bool `type:"boolean"`

	// Specifies whether the trail is publishing events from global services such
	// as IAM to the log files.
	IncludeGlobalServiceEvents *bool `type:"boolean"`

	// Specifies whether the trail is created in the current region or in all regions.
	// The default is false, which creates a trail only in the region where you
	// are signed in. As a best practice, consider creating trails that log events
	// in all regions.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Specifies whether the trail is created for all accounts in an organization
	// in Organizations, or only for the current Amazon Web Services account. The
	// default is false, and cannot be true unless the call is made on behalf of
	// an Amazon Web Services account that is the management account for an organization
	// in Organizations.
	IsOrganizationTrail *bool `type:"boolean"`

	// Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.
	// The value can be an alias name prefixed by "alias/", a fully specified ARN
	// to an alias, a fully specified ARN to a key, or a globally unique identifier.
	//
	// CloudTrail also supports KMS multi-Region keys. For more information about
	// multi-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)
	// in the Key Management Service Developer Guide.
	//
	// Examples:
	//
	//    * alias/MyAliasName
	//
	//    * arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
	//
	//    * arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
	//
	//    * 12345678-1234-1234-1234-123456789012
	KmsKeyId *string `type:"string"`

	// Specifies the name of the trail. The name 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)
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Specifies the name of the Amazon S3 bucket designated for publishing log
	// files. See Amazon S3 Bucket Naming Requirements (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html).
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`

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

	// Specifies the name of the Amazon SNS topic defined for notification of log
	// file delivery. The maximum length is 256 characters.
	SnsTopicName *string `type:"string"`

	// A list of tags.
	TagsList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Specifies the settings for each trail.

func (CreateTrailInput) GoString added in v0.6.5 

func (s CreateTrailInput) 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 (*CreateTrailInput) SetCloudWatchLogsLogGroupArn added in v1.5.0 

func (s *CreateTrailInput) SetCloudWatchLogsLogGroupArn(v string) *CreateTrailInput

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*CreateTrailInput) SetCloudWatchLogsRoleArn added in v1.5.0 

func (s *CreateTrailInput) SetCloudWatchLogsRoleArn(v string) *CreateTrailInput

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*CreateTrailInput) SetEnableLogFileValidation added in v1.5.0 

func (s *CreateTrailInput) SetEnableLogFileValidation(v bool) *CreateTrailInput

SetEnableLogFileValidation sets the EnableLogFileValidation field's value.

func (*CreateTrailInput) SetIncludeGlobalServiceEvents added in v1.5.0 

func (s *CreateTrailInput) SetIncludeGlobalServiceEvents(v bool) *CreateTrailInput

SetIncludeGlobalServiceEvents sets the IncludeGlobalServiceEvents field's value.

func (*CreateTrailInput) SetIsMultiRegionTrail added in v1.5.0 

func (s *CreateTrailInput) SetIsMultiRegionTrail(v bool) *CreateTrailInput

SetIsMultiRegionTrail sets the IsMultiRegionTrail field's value.

func (*CreateTrailInput) SetIsOrganizationTrail added in v1.15.79 

func (s *CreateTrailInput) SetIsOrganizationTrail(v bool) *CreateTrailInput

SetIsOrganizationTrail sets the IsOrganizationTrail field's value.

func (*CreateTrailInput) SetKmsKeyId added in v1.5.0 

func (s *CreateTrailInput) SetKmsKeyId(v string) *CreateTrailInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateTrailInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*CreateTrailInput) SetS3BucketName added in v1.5.0 

func (s *CreateTrailInput) SetS3BucketName(v string) *CreateTrailInput

SetS3BucketName sets the S3BucketName field's value.

func (*CreateTrailInput) SetS3KeyPrefix added in v1.5.0 

func (s *CreateTrailInput) SetS3KeyPrefix(v string) *CreateTrailInput

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*CreateTrailInput) SetSnsTopicName added in v1.5.0 

func (s *CreateTrailInput) SetSnsTopicName(v string) *CreateTrailInput

SetSnsTopicName sets the SnsTopicName field's value.

func (*CreateTrailInput) SetTagsList added in v1.25.25 

func (s *CreateTrailInput) SetTagsList(v []*Tag) *CreateTrailInput

SetTagsList sets the TagsList field's value.

func (CreateTrailInput) String added in v0.6.5 

func (s CreateTrailInput) 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 (*CreateTrailInput) Validate added in v1.1.21 

func (s *CreateTrailInput) Validate() error

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

type CreateTrailOutput 

type CreateTrailOutput struct {

	// Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
	// logs will be delivered.
	CloudWatchLogsLogGroupArn *string `type:"string"`

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

	// Specifies whether the trail is publishing events from global services such
	// as IAM to the log files.
	IncludeGlobalServiceEvents *bool `type:"boolean"`

	// Specifies whether the trail exists in one region or in all regions.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Specifies whether the trail is an organization trail.
	IsOrganizationTrail *bool `type:"boolean"`

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

	// Specifies whether log file integrity validation is enabled.
	LogFileValidationEnabled *bool `type:"boolean"`

	// Specifies the name of the trail.
	Name *string `type:"string"`

	// Specifies the name of the Amazon S3 bucket designated for publishing log
	// files.
	S3BucketName *string `type:"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).
	S3KeyPrefix *string `type:"string"`

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

	// This field is no longer in use. Use SnsTopicARN.
	//
	// Deprecated: SnsTopicName has been deprecated
	SnsTopicName *string `deprecated:"true" type:"string"`

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (CreateTrailOutput) GoString added in v0.6.5 

func (s CreateTrailOutput) 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 (*CreateTrailOutput) SetCloudWatchLogsLogGroupArn added in v1.5.0 

func (s *CreateTrailOutput) SetCloudWatchLogsLogGroupArn(v string) *CreateTrailOutput

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*CreateTrailOutput) SetCloudWatchLogsRoleArn added in v1.5.0 

func (s *CreateTrailOutput) SetCloudWatchLogsRoleArn(v string) *CreateTrailOutput

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*CreateTrailOutput) SetIncludeGlobalServiceEvents added in v1.5.0 

func (s *CreateTrailOutput) SetIncludeGlobalServiceEvents(v bool) *CreateTrailOutput

SetIncludeGlobalServiceEvents sets the IncludeGlobalServiceEvents field's value.

func (*CreateTrailOutput) SetIsMultiRegionTrail added in v1.5.0 

func (s *CreateTrailOutput) SetIsMultiRegionTrail(v bool) *CreateTrailOutput

SetIsMultiRegionTrail sets the IsMultiRegionTrail field's value.

func (*CreateTrailOutput) SetIsOrganizationTrail added in v1.15.79 

func (s *CreateTrailOutput) SetIsOrganizationTrail(v bool) *CreateTrailOutput

SetIsOrganizationTrail sets the IsOrganizationTrail field's value.

func (*CreateTrailOutput) SetKmsKeyId added in v1.5.0 

func (s *CreateTrailOutput) SetKmsKeyId(v string) *CreateTrailOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateTrailOutput) SetLogFileValidationEnabled added in v1.5.0 

func (s *CreateTrailOutput) SetLogFileValidationEnabled(v bool) *CreateTrailOutput

SetLogFileValidationEnabled sets the LogFileValidationEnabled field's value.

func (*CreateTrailOutput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*CreateTrailOutput) SetS3BucketName added in v1.5.0 

func (s *CreateTrailOutput) SetS3BucketName(v string) *CreateTrailOutput

SetS3BucketName sets the S3BucketName field's value.

func (*CreateTrailOutput) SetS3KeyPrefix added in v1.5.0 

func (s *CreateTrailOutput) SetS3KeyPrefix(v string) *CreateTrailOutput

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*CreateTrailOutput) SetSnsTopicARN added in v1.5.0 

func (s *CreateTrailOutput) SetSnsTopicARN(v string) *CreateTrailOutput

SetSnsTopicARN sets the SnsTopicARN field's value.

func (*CreateTrailOutput) SetSnsTopicName added in v1.5.0 

func (s *CreateTrailOutput) SetSnsTopicName(v string) *CreateTrailOutput

SetSnsTopicName sets the SnsTopicName field's value.

func (*CreateTrailOutput) SetTrailARN added in v1.5.0 

func (s *CreateTrailOutput) SetTrailARN(v string) *CreateTrailOutput

SetTrailARN sets the TrailARN field's value.

func (CreateTrailOutput) String added in v0.6.5 

func (s CreateTrailOutput) 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 DataResource added in v1.5.9 

type DataResource struct {

	// The resource type in which you want to log data events. You can specify the
	// following basic event selector resource types:
	//
	//    * AWS::S3::Object
	//
	//    * AWS::Lambda::Function
	//
	//    * AWS::DynamoDB::Table
	//
	// The following resource types are also availble through advanced event selectors.
	// Basic event selector resource types are valid in advanced event selectors,
	// but advanced event selector resource types are not valid in basic event selectors.
	// For more information, see AdvancedFieldSelector$Field.
	//
	//    * AWS::S3Outposts::Object
	//
	//    * AWS::ManagedBlockchain::Node
	//
	//    * AWS::S3ObjectLambda::AccessPoint
	//
	//    * AWS::EC2::Snapshot
	//
	//    * AWS::S3::AccessPoint
	//
	//    * AWS::DynamoDB::Stream
	//
	//    * AWS::Glue::Table
	Type *string `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 `type:"list"`
	// 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.

func (DataResource) GoString added in v1.5.9 

func (s DataResource) 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 (*DataResource) SetType added in v1.5.9 

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

SetType sets the Type field's value.

func (*DataResource) SetValues added in v1.5.9 

func (s *DataResource) SetValues(v []*string) *DataResource

SetValues sets the Values field's value.

func (DataResource) String added in v1.5.9 

func (s DataResource) 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 DeleteEventDataStoreInput added in v1.42.28 

type DeleteEventDataStoreInput struct {

	// The ARN (or the ID suffix of the ARN) of the event data store to delete.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventDataStoreInput) GoString added in v1.42.28 

func (s DeleteEventDataStoreInput) 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 (*DeleteEventDataStoreInput) SetEventDataStore added in v1.42.28 

func (s *DeleteEventDataStoreInput) SetEventDataStore(v string) *DeleteEventDataStoreInput

SetEventDataStore sets the EventDataStore field's value.

func (DeleteEventDataStoreInput) String added in v1.42.28 

func (s DeleteEventDataStoreInput) 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 (*DeleteEventDataStoreInput) Validate added in v1.42.28 

func (s *DeleteEventDataStoreInput) Validate() error

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

type DeleteEventDataStoreOutput added in v1.42.28 

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

func (DeleteEventDataStoreOutput) GoString added in v1.42.28 

func (s DeleteEventDataStoreOutput) 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 (DeleteEventDataStoreOutput) String added in v1.42.28 

func (s DeleteEventDataStoreOutput) 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 DeleteTrailInput 

type DeleteTrailInput struct {

	// Specifies the name or the CloudTrail ARN of the trail to be deleted. The
	// following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request that specifies the name of a trail to delete.

func (DeleteTrailInput) GoString added in v0.6.5 

func (s DeleteTrailInput) 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 (*DeleteTrailInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (DeleteTrailInput) String added in v0.6.5 

func (s DeleteTrailInput) 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 (*DeleteTrailInput) Validate added in v1.1.21 

func (s *DeleteTrailInput) Validate() error

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

type DeleteTrailOutput 

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (DeleteTrailOutput) GoString added in v0.6.5 

func (s DeleteTrailOutput) 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 (DeleteTrailOutput) String added in v0.6.5 

func (s DeleteTrailOutput) 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 DescribeQueryInput added in v1.42.28 

type DescribeQueryInput struct {

	// The ARN (or the ID suffix of the ARN) of an event data store on which the
	// specified query was run.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`

	// The query ID.
	//
	// QueryId is a required field
	QueryId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeQueryInput) GoString added in v1.42.28 

func (s DescribeQueryInput) 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 (*DescribeQueryInput) SetEventDataStore added in v1.42.28 

func (s *DescribeQueryInput) SetEventDataStore(v string) *DescribeQueryInput

SetEventDataStore sets the EventDataStore field's value.

func (*DescribeQueryInput) SetQueryId added in v1.42.28 

func (s *DescribeQueryInput) SetQueryId(v string) *DescribeQueryInput

SetQueryId sets the QueryId field's value.

func (DescribeQueryInput) String added in v1.42.28 

func (s DescribeQueryInput) 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 (*DescribeQueryInput) Validate added in v1.42.28 

func (s *DescribeQueryInput) Validate() error

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

type DescribeQueryOutput added in v1.42.28 

type DescribeQueryOutput struct {

	// The error message returned if a query failed.
	ErrorMessage *string `min:"4" type:"string"`

	// The ID of the query.
	QueryId *string `min:"36" type:"string"`

	// Metadata about a query, including the number of events that were matched,
	// the total number of events scanned, the query run time in milliseconds, and
	// the query's creation time.
	QueryStatistics *QueryStatisticsForDescribeQuery `type:"structure"`

	// The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED,
	// FAILED, or CANCELLED
	QueryStatus *string `type:"string" enum:"QueryStatus"`

	// The SQL code of a query.
	QueryString *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeQueryOutput) GoString added in v1.42.28 

func (s DescribeQueryOutput) 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 (*DescribeQueryOutput) SetErrorMessage added in v1.42.28 

func (s *DescribeQueryOutput) SetErrorMessage(v string) *DescribeQueryOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeQueryOutput) SetQueryId added in v1.42.28 

func (s *DescribeQueryOutput) SetQueryId(v string) *DescribeQueryOutput

SetQueryId sets the QueryId field's value.

func (*DescribeQueryOutput) SetQueryStatistics added in v1.42.28 

func (s *DescribeQueryOutput) SetQueryStatistics(v *QueryStatisticsForDescribeQuery) *DescribeQueryOutput

SetQueryStatistics sets the QueryStatistics field's value.

func (*DescribeQueryOutput) SetQueryStatus added in v1.42.28 

func (s *DescribeQueryOutput) SetQueryStatus(v string) *DescribeQueryOutput

SetQueryStatus sets the QueryStatus field's value.

func (*DescribeQueryOutput) SetQueryString added in v1.42.28 

func (s *DescribeQueryOutput) SetQueryString(v string) *DescribeQueryOutput

SetQueryString sets the QueryString field's value.

func (DescribeQueryOutput) String added in v1.42.28 

func (s DescribeQueryOutput) 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 DescribeTrailsInput 

type DescribeTrailsInput struct {

	// Specifies whether to include shadow trails in the response. A shadow trail
	// is the replication in a region of a trail that was created in a different
	// region, or in the case of an organization trail, the replication of an organization
	// trail in member accounts. If you do not include shadow trails, organization
	// trails in a member account and region replication trails will not be returned.
	// The default is true.
	IncludeShadowTrails *bool `locationName:"includeShadowTrails" type:"boolean"`

	// Specifies a list of trail names, trail ARNs, or both, of the trails to describe.
	// The format of a trail ARN is:
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// If an empty list is specified, information for the trail in the current region
	// is returned.
	//
	//    * If an empty list is specified and IncludeShadowTrails is false, then
	//    information for all trails in the current region is returned.
	//
	//    * If an empty list is specified and IncludeShadowTrails is null or true,
	//    then information for all trails in the current region and any associated
	//    shadow trails in other regions is returned.
	//
	// If one or more trail names are specified, information is returned only if
	// the names match the names of trails belonging only to the current region.
	// To return information about a trail in another region, you must specify its
	// trail ARN.
	TrailNameList []*string `locationName:"trailNameList" type:"list"`
	// contains filtered or unexported fields
}

Returns information about the trail.

func (DescribeTrailsInput) GoString added in v0.6.5 

func (s DescribeTrailsInput) 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 (*DescribeTrailsInput) SetIncludeShadowTrails added in v1.5.0 

func (s *DescribeTrailsInput) SetIncludeShadowTrails(v bool) *DescribeTrailsInput

SetIncludeShadowTrails sets the IncludeShadowTrails field's value.

func (*DescribeTrailsInput) SetTrailNameList added in v1.5.0 

func (s *DescribeTrailsInput) SetTrailNameList(v []*string) *DescribeTrailsInput

SetTrailNameList sets the TrailNameList field's value.

func (DescribeTrailsInput) String added in v0.6.5 

func (s DescribeTrailsInput) 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 DescribeTrailsOutput 

type DescribeTrailsOutput struct {

	// The list of trail objects. Trail objects with string values are only returned
	// if values for the objects exist in a trail's configuration. For example,
	// SNSTopicName and SNSTopicARN are only returned in results if a trail is configured
	// to send SNS notifications. Similarly, KMSKeyId only appears in results if
	// a trail's log files are encrypted with KMS customer managed keys.
	TrailList []*Trail `locationName:"trailList" type:"list"`
	// contains filtered or unexported fields
}

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (DescribeTrailsOutput) GoString added in v0.6.5 

func (s DescribeTrailsOutput) 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 (*DescribeTrailsOutput) SetTrailList added in v1.5.0 

func (s *DescribeTrailsOutput) SetTrailList(v []*Trail) *DescribeTrailsOutput

SetTrailList sets the TrailList field's value.

func (DescribeTrailsOutput) String added in v0.6.5 

func (s DescribeTrailsOutput) 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 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 `type:"string"`

	// A JSON string that contains a representation of the event returned.
	CloudTrailEvent *string `type:"string"`

	// The CloudTrail ID of the event returned.
	EventId *string `type:"string"`

	// The name of the event returned.
	EventName *string `type:"string"`

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

	// The date and time of the event returned.
	EventTime *time.Time `type:"timestamp"`

	// Information about whether the event is a write event or a read event.
	ReadOnly *string `type:"string"`

	// A list of resources referenced by the event returned.
	Resources []*Resource `type:"list"`

	// A user name or role name of the requester that called the API in the event
	// returned.
	Username *string `type:"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.

func (Event) GoString added in v0.6.5 

func (s Event) 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 (*Event) SetAccessKeyId added in v1.15.54 

func (s *Event) SetAccessKeyId(v string) *Event

SetAccessKeyId sets the AccessKeyId field's value.

func (*Event) SetCloudTrailEvent added in v1.5.0 

func (s *Event) SetCloudTrailEvent(v string) *Event

SetCloudTrailEvent sets the CloudTrailEvent field's value.

func (*Event) SetEventId added in v1.5.0 

func (s *Event) SetEventId(v string) *Event

SetEventId sets the EventId field's value.

func (*Event) SetEventName added in v1.5.0 

func (s *Event) SetEventName(v string) *Event

SetEventName sets the EventName field's value.

func (*Event) SetEventSource added in v1.5.9 

func (s *Event) SetEventSource(v string) *Event

SetEventSource sets the EventSource field's value.

func (*Event) SetEventTime added in v1.5.0 

func (s *Event) SetEventTime(v time.Time) *Event

SetEventTime sets the EventTime field's value.

func (*Event) SetReadOnly added in v1.15.54 

func (s *Event) SetReadOnly(v string) *Event

SetReadOnly sets the ReadOnly field's value.

func (*Event) SetResources added in v1.5.0 

func (s *Event) SetResources(v []*Resource) *Event

SetResources sets the Resources field's value.

func (*Event) SetUsername added in v1.5.0 

func (s *Event) SetUsername(v string) *Event

SetUsername sets the Username field's value.

func (Event) String added in v0.6.5 

func (s Event) 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 EventDataStore added in v1.42.28 

type EventDataStore struct {

	// The advanced event selectors that were used to select events for the data
	// store.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// The timestamp of the event data store's creation.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ARN of the event data store.
	EventDataStoreArn *string `min:"3" type:"string"`

	// Indicates whether the event data store includes events from all regions,
	// or only from the region in which it was created.
	MultiRegionEnabled *bool `type:"boolean"`

	// The name of the event data store.
	Name *string `min:"3" type:"string"`

	// Indicates that an event data store is collecting logged events for an organization.
	OrganizationEnabled *bool `type:"boolean"`

	// The retention period, in days.
	RetentionPeriod *int64 `min:"7" type:"integer"`

	// The status of an event data store. Values are ENABLED and PENDING_DELETION.
	Status *string `type:"string" enum:"EventDataStoreStatus"`

	// Indicates whether the event data store is protected from termination.
	TerminationProtectionEnabled *bool `type:"boolean"`

	// The timestamp showing when an event data store was updated, if applicable.
	// UpdatedTimestamp is always either the same or newer than the time shown in
	// CreatedTimestamp.
	UpdatedTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 90 to 2555 days (about three months to up to seven years). To select events for an event data store, use advanced event selectors (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced).

func (EventDataStore) GoString added in v1.42.28 

func (s EventDataStore) 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 (*EventDataStore) SetAdvancedEventSelectors added in v1.42.28 

func (s *EventDataStore) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *EventDataStore

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*EventDataStore) SetCreatedTimestamp added in v1.42.28 

func (s *EventDataStore) SetCreatedTimestamp(v time.Time) *EventDataStore

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*EventDataStore) SetEventDataStoreArn added in v1.42.28 

func (s *EventDataStore) SetEventDataStoreArn(v string) *EventDataStore

SetEventDataStoreArn sets the EventDataStoreArn field's value.

func (*EventDataStore) SetMultiRegionEnabled added in v1.42.28 

func (s *EventDataStore) SetMultiRegionEnabled(v bool) *EventDataStore

SetMultiRegionEnabled sets the MultiRegionEnabled field's value.

func (*EventDataStore) SetName added in v1.42.28 

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

SetName sets the Name field's value.

func (*EventDataStore) SetOrganizationEnabled added in v1.42.28 

func (s *EventDataStore) SetOrganizationEnabled(v bool) *EventDataStore

SetOrganizationEnabled sets the OrganizationEnabled field's value.

func (*EventDataStore) SetRetentionPeriod added in v1.42.28 

func (s *EventDataStore) SetRetentionPeriod(v int64) *EventDataStore

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*EventDataStore) SetStatus added in v1.42.28 

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

SetStatus sets the Status field's value.

func (*EventDataStore) SetTerminationProtectionEnabled added in v1.42.28 

func (s *EventDataStore) SetTerminationProtectionEnabled(v bool) *EventDataStore

SetTerminationProtectionEnabled sets the TerminationProtectionEnabled field's value.

func (*EventDataStore) SetUpdatedTimestamp added in v1.42.28 

func (s *EventDataStore) SetUpdatedTimestamp(v time.Time) *EventDataStore

SetUpdatedTimestamp sets the UpdatedTimestamp field's value.

func (EventDataStore) String added in v1.42.28 

func (s EventDataStore) 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 EventDataStoreARNInvalidException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified event data store ARN is not valid or does not map to an event data store in your account.

func (*EventDataStoreARNInvalidException) Code added in v1.42.28 

func (s *EventDataStoreARNInvalidException) Code() string

Code returns the exception type name.

func (*EventDataStoreARNInvalidException) Error added in v1.42.28 

func (s *EventDataStoreARNInvalidException) Error() string

func (EventDataStoreARNInvalidException) GoString added in v1.42.28 

func (s EventDataStoreARNInvalidException) 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 (*EventDataStoreARNInvalidException) Message added in v1.42.28 

func (s *EventDataStoreARNInvalidException) Message() string

Message returns the exception's message.

func (*EventDataStoreARNInvalidException) OrigErr added in v1.42.28 

func (s *EventDataStoreARNInvalidException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EventDataStoreARNInvalidException) RequestID added in v1.42.28 

func (s *EventDataStoreARNInvalidException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EventDataStoreARNInvalidException) StatusCode added in v1.42.28 

func (s *EventDataStoreARNInvalidException) StatusCode() int

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

func (EventDataStoreARNInvalidException) String added in v1.42.28 

func (s EventDataStoreARNInvalidException) 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 EventDataStoreAlreadyExistsException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An event data store with that name already exists.

func (*EventDataStoreAlreadyExistsException) Code added in v1.42.28 

func (s *EventDataStoreAlreadyExistsException) Code() string

Code returns the exception type name.

func (*EventDataStoreAlreadyExistsException) Error added in v1.42.28 

func (s *EventDataStoreAlreadyExistsException) Error() string

func (EventDataStoreAlreadyExistsException) GoString added in v1.42.28 

func (s EventDataStoreAlreadyExistsException) 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 (*EventDataStoreAlreadyExistsException) Message added in v1.42.28 

func (s *EventDataStoreAlreadyExistsException) Message() string

Message returns the exception's message.

func (*EventDataStoreAlreadyExistsException) OrigErr added in v1.42.28 

func (s *EventDataStoreAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EventDataStoreAlreadyExistsException) RequestID added in v1.42.28 

func (s *EventDataStoreAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EventDataStoreAlreadyExistsException) StatusCode added in v1.42.28 

func (s *EventDataStoreAlreadyExistsException) StatusCode() int

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

func (EventDataStoreAlreadyExistsException) String added in v1.42.28 

func (s EventDataStoreAlreadyExistsException) 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 EventDataStoreMaxLimitExceededException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Your account has used the maximum number of event data stores.

func (*EventDataStoreMaxLimitExceededException) Code added in v1.42.28 

func (s *EventDataStoreMaxLimitExceededException) Code() string

Code returns the exception type name.

func (*EventDataStoreMaxLimitExceededException) Error added in v1.42.28 

func (s *EventDataStoreMaxLimitExceededException) Error() string

func (EventDataStoreMaxLimitExceededException) GoString added in v1.42.28 

func (s EventDataStoreMaxLimitExceededException) 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 (*EventDataStoreMaxLimitExceededException) Message added in v1.42.28 

func (s *EventDataStoreMaxLimitExceededException) Message() string

Message returns the exception's message.

func (*EventDataStoreMaxLimitExceededException) OrigErr added in v1.42.28 

func (s *EventDataStoreMaxLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EventDataStoreMaxLimitExceededException) RequestID added in v1.42.28 

func (s *EventDataStoreMaxLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EventDataStoreMaxLimitExceededException) StatusCode added in v1.42.28 

func (s *EventDataStoreMaxLimitExceededException) StatusCode() int

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

func (EventDataStoreMaxLimitExceededException) String added in v1.42.28 

func (s EventDataStoreMaxLimitExceededException) 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 EventDataStoreNotFoundException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified event data store was not found.

func (*EventDataStoreNotFoundException) Code added in v1.42.28 

func (s *EventDataStoreNotFoundException) Code() string

Code returns the exception type name.

func (*EventDataStoreNotFoundException) Error added in v1.42.28 

func (s *EventDataStoreNotFoundException) Error() string

func (EventDataStoreNotFoundException) GoString added in v1.42.28 

func (s EventDataStoreNotFoundException) 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 (*EventDataStoreNotFoundException) Message added in v1.42.28 

func (s *EventDataStoreNotFoundException) Message() string

Message returns the exception's message.

func (*EventDataStoreNotFoundException) OrigErr added in v1.42.28 

func (s *EventDataStoreNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EventDataStoreNotFoundException) RequestID added in v1.42.28 

func (s *EventDataStoreNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EventDataStoreNotFoundException) StatusCode added in v1.42.28 

func (s *EventDataStoreNotFoundException) StatusCode() int

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

func (EventDataStoreNotFoundException) String added in v1.42.28 

func (s EventDataStoreNotFoundException) 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 EventDataStoreTerminationProtectedException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The event data store cannot be deleted because termination protection is enabled for it.

func (*EventDataStoreTerminationProtectedException) Code added in v1.42.28 

func (s *EventDataStoreTerminationProtectedException) Code() string

Code returns the exception type name.

func (*EventDataStoreTerminationProtectedException) Error added in v1.42.28 

func (s *EventDataStoreTerminationProtectedException) Error() string

func (EventDataStoreTerminationProtectedException) GoString added in v1.42.28 

func (s EventDataStoreTerminationProtectedException) 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 (*EventDataStoreTerminationProtectedException) Message added in v1.42.28 

func (s *EventDataStoreTerminationProtectedException) Message() string

Message returns the exception's message.

func (*EventDataStoreTerminationProtectedException) OrigErr added in v1.42.28 

func (s *EventDataStoreTerminationProtectedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*EventDataStoreTerminationProtectedException) RequestID added in v1.42.28 

func (s *EventDataStoreTerminationProtectedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*EventDataStoreTerminationProtectedException) StatusCode added in v1.42.28 

func (s *EventDataStoreTerminationProtectedException) StatusCode() int

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

func (EventDataStoreTerminationProtectedException) String added in v1.42.28 

func (s EventDataStoreTerminationProtectedException) 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 EventSelector added in v1.5.9 

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

	// 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. You can exclude management event
	// sources only in regions that support the event source.
	ExcludeManagementEventSources []*string `type:"list"`

	// 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 `type:"boolean"`

	// 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 *string `type:"string" enum:"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.

func (EventSelector) GoString added in v1.5.9 

func (s EventSelector) 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 (*EventSelector) SetDataResources added in v1.5.9 

func (s *EventSelector) SetDataResources(v []*DataResource) *EventSelector

SetDataResources sets the DataResources field's value.

func (*EventSelector) SetExcludeManagementEventSources added in v1.25.39 

func (s *EventSelector) SetExcludeManagementEventSources(v []*string) *EventSelector

SetExcludeManagementEventSources sets the ExcludeManagementEventSources field's value.

func (*EventSelector) SetIncludeManagementEvents added in v1.5.9 

func (s *EventSelector) SetIncludeManagementEvents(v bool) *EventSelector

SetIncludeManagementEvents sets the IncludeManagementEvents field's value.

func (*EventSelector) SetReadWriteType added in v1.5.9 

func (s *EventSelector) SetReadWriteType(v string) *EventSelector

SetReadWriteType sets the ReadWriteType field's value.

func (EventSelector) String added in v1.5.9 

func (s EventSelector) 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 GetEventDataStoreInput added in v1.42.28 

type GetEventDataStoreInput struct {

	// The ARN (or ID suffix of the ARN) of the event data store about which you
	// want information.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetEventDataStoreInput) GoString added in v1.42.28 

func (s GetEventDataStoreInput) 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 (*GetEventDataStoreInput) SetEventDataStore added in v1.42.28 

func (s *GetEventDataStoreInput) SetEventDataStore(v string) *GetEventDataStoreInput

SetEventDataStore sets the EventDataStore field's value.

func (GetEventDataStoreInput) String added in v1.42.28 

func (s GetEventDataStoreInput) 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 (*GetEventDataStoreInput) Validate added in v1.42.28 

func (s *GetEventDataStoreInput) Validate() error

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

type GetEventDataStoreOutput added in v1.42.28 

type GetEventDataStoreOutput struct {

	// The advanced event selectors used to select events for the data store.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// The timestamp of the event data store's creation.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The event data store Amazon Resource Number (ARN).
	EventDataStoreArn *string `min:"3" type:"string"`

	// Indicates whether the event data store includes events from all regions,
	// or only from the region in which it was created.
	MultiRegionEnabled *bool `type:"boolean"`

	// The name of the event data store.
	Name *string `min:"3" type:"string"`

	// Indicates whether an event data store is collecting logged events for an
	// organization in Organizations.
	OrganizationEnabled *bool `type:"boolean"`

	// The retention period of the event data store, in days.
	RetentionPeriod *int64 `min:"7" type:"integer"`

	// The status of an event data store. Values can be ENABLED and PENDING_DELETION.
	Status *string `type:"string" enum:"EventDataStoreStatus"`

	// Indicates that termination protection is enabled.
	TerminationProtectionEnabled *bool `type:"boolean"`

	// Shows the time that an event data store was updated, if applicable. UpdatedTimestamp
	// is always either the same or newer than the time shown in CreatedTimestamp.
	UpdatedTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (GetEventDataStoreOutput) GoString added in v1.42.28 

func (s GetEventDataStoreOutput) 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 (*GetEventDataStoreOutput) SetAdvancedEventSelectors added in v1.42.28 

func (s *GetEventDataStoreOutput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *GetEventDataStoreOutput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*GetEventDataStoreOutput) SetCreatedTimestamp added in v1.42.28 

func (s *GetEventDataStoreOutput) SetCreatedTimestamp(v time.Time) *GetEventDataStoreOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*GetEventDataStoreOutput) SetEventDataStoreArn added in v1.42.28 

func (s *GetEventDataStoreOutput) SetEventDataStoreArn(v string) *GetEventDataStoreOutput

SetEventDataStoreArn sets the EventDataStoreArn field's value.

func (*GetEventDataStoreOutput) SetMultiRegionEnabled added in v1.42.28 

func (s *GetEventDataStoreOutput) SetMultiRegionEnabled(v bool) *GetEventDataStoreOutput

SetMultiRegionEnabled sets the MultiRegionEnabled field's value.

func (*GetEventDataStoreOutput) SetName added in v1.42.28 

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

SetName sets the Name field's value.

func (*GetEventDataStoreOutput) SetOrganizationEnabled added in v1.42.28 

func (s *GetEventDataStoreOutput) SetOrganizationEnabled(v bool) *GetEventDataStoreOutput

SetOrganizationEnabled sets the OrganizationEnabled field's value.

func (*GetEventDataStoreOutput) SetRetentionPeriod added in v1.42.28 

func (s *GetEventDataStoreOutput) SetRetentionPeriod(v int64) *GetEventDataStoreOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*GetEventDataStoreOutput) SetStatus added in v1.42.28 

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

SetStatus sets the Status field's value.

func (*GetEventDataStoreOutput) SetTerminationProtectionEnabled added in v1.42.28 

func (s *GetEventDataStoreOutput) SetTerminationProtectionEnabled(v bool) *GetEventDataStoreOutput

SetTerminationProtectionEnabled sets the TerminationProtectionEnabled field's value.

func (*GetEventDataStoreOutput) SetUpdatedTimestamp added in v1.42.28 

func (s *GetEventDataStoreOutput) SetUpdatedTimestamp(v time.Time) *GetEventDataStoreOutput

SetUpdatedTimestamp sets the UpdatedTimestamp field's value.

func (GetEventDataStoreOutput) String added in v1.42.28 

func (s GetEventDataStoreOutput) 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 GetEventSelectorsInput added in v1.5.9 

type GetEventSelectorsInput struct {

	// Specifies the name of the trail or trail ARN. If you specify a trail name,
	// the string 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)
	//
	// If you specify a trail ARN, it must be in the format:
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// TrailName is a required field
	TrailName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetEventSelectorsInput) GoString added in v1.5.9 

func (s GetEventSelectorsInput) 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 (*GetEventSelectorsInput) SetTrailName added in v1.5.9 

func (s *GetEventSelectorsInput) SetTrailName(v string) *GetEventSelectorsInput

SetTrailName sets the TrailName field's value.

func (GetEventSelectorsInput) String added in v1.5.9 

func (s GetEventSelectorsInput) 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 (*GetEventSelectorsInput) Validate added in v1.8.2 

func (s *GetEventSelectorsInput) Validate() error

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

type GetEventSelectorsOutput added in v1.5.9 

type GetEventSelectorsOutput struct {

	// The advanced event selectors that are configured for the trail.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// The event selectors that are configured for the trail.
	EventSelectors []*EventSelector `type:"list"`

	// The specified trail ARN that has the event selectors.
	TrailARN *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetEventSelectorsOutput) GoString added in v1.5.9 

func (s GetEventSelectorsOutput) 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 (*GetEventSelectorsOutput) SetAdvancedEventSelectors added in v1.35.35 

func (s *GetEventSelectorsOutput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *GetEventSelectorsOutput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*GetEventSelectorsOutput) SetEventSelectors added in v1.5.9 

func (s *GetEventSelectorsOutput) SetEventSelectors(v []*EventSelector) *GetEventSelectorsOutput

SetEventSelectors sets the EventSelectors field's value.

func (*GetEventSelectorsOutput) SetTrailARN added in v1.5.9 

func (s *GetEventSelectorsOutput) SetTrailARN(v string) *GetEventSelectorsOutput

SetTrailARN sets the TrailARN field's value.

func (GetEventSelectorsOutput) String added in v1.5.9 

func (s GetEventSelectorsOutput) 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 GetInsightSelectorsInput added in v1.25.39 

type GetInsightSelectorsInput struct {

	// Specifies the name of the trail or trail ARN. If you specify a trail name,
	// the string 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)
	//
	// If you specify a trail ARN, it must be in the format:
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// TrailName is a required field
	TrailName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInsightSelectorsInput) GoString added in v1.25.39 

func (s GetInsightSelectorsInput) 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 (*GetInsightSelectorsInput) SetTrailName added in v1.25.39 

func (s *GetInsightSelectorsInput) SetTrailName(v string) *GetInsightSelectorsInput

SetTrailName sets the TrailName field's value.

func (GetInsightSelectorsInput) String added in v1.25.39 

func (s GetInsightSelectorsInput) 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 (*GetInsightSelectorsInput) Validate added in v1.25.39 

func (s *GetInsightSelectorsInput) Validate() error

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

type GetInsightSelectorsOutput added in v1.25.39 

type GetInsightSelectorsOutput struct {

	// A JSON string that contains the insight types you want to log on a trail.
	// In this release, ApiErrorRateInsight and ApiCallRateInsight are supported
	// as insight types.
	InsightSelectors []*InsightSelector `type:"list"`

	// The Amazon Resource Name (ARN) of a trail for which you want to get Insights
	// selectors.
	TrailARN *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetInsightSelectorsOutput) GoString added in v1.25.39 

func (s GetInsightSelectorsOutput) 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 (*GetInsightSelectorsOutput) SetInsightSelectors added in v1.25.39 

func (s *GetInsightSelectorsOutput) SetInsightSelectors(v []*InsightSelector) *GetInsightSelectorsOutput

SetInsightSelectors sets the InsightSelectors field's value.

func (*GetInsightSelectorsOutput) SetTrailARN added in v1.25.39 

func (s *GetInsightSelectorsOutput) SetTrailARN(v string) *GetInsightSelectorsOutput

SetTrailARN sets the TrailARN field's value.

func (GetInsightSelectorsOutput) String added in v1.25.39 

func (s GetInsightSelectorsOutput) 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 GetQueryResultsInput added in v1.42.28 

type GetQueryResultsInput struct {

	// The ARN (or ID suffix of the ARN) of the event data store against which the
	// query was run.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`

	// The maximum number of query results to display on a single page.
	MaxQueryResults *int64 `min:"1" type:"integer"`

	// A token you can use to get the next page of query results.
	NextToken *string `min:"4" type:"string"`

	// The ID of the query for which you want to get results.
	//
	// QueryId is a required field
	QueryId *string `min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQueryResultsInput) GoString added in v1.42.28 

func (s GetQueryResultsInput) 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 (*GetQueryResultsInput) SetEventDataStore added in v1.42.28 

func (s *GetQueryResultsInput) SetEventDataStore(v string) *GetQueryResultsInput

SetEventDataStore sets the EventDataStore field's value.

func (*GetQueryResultsInput) SetMaxQueryResults added in v1.42.28 

func (s *GetQueryResultsInput) SetMaxQueryResults(v int64) *GetQueryResultsInput

SetMaxQueryResults sets the MaxQueryResults field's value.

func (*GetQueryResultsInput) SetNextToken added in v1.42.28 

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

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsInput) SetQueryId added in v1.42.28 

func (s *GetQueryResultsInput) SetQueryId(v string) *GetQueryResultsInput

SetQueryId sets the QueryId field's value.

func (GetQueryResultsInput) String added in v1.42.28 

func (s GetQueryResultsInput) 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 (*GetQueryResultsInput) Validate added in v1.42.28 

func (s *GetQueryResultsInput) Validate() error

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

type GetQueryResultsOutput added in v1.42.28 

type GetQueryResultsOutput struct {

	// The error message returned if a query failed.
	ErrorMessage *string `min:"4" type:"string"`

	// A token you can use to get the next page of query results.
	NextToken *string `min:"4" type:"string"`

	// Contains the individual event results of the query.
	QueryResultRows [][]map[string]*string `type:"list"`

	// Shows the count of query results.
	QueryStatistics *QueryStatistics `type:"structure"`

	// The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED,
	// or CANCELLED.
	QueryStatus *string `type:"string" enum:"QueryStatus"`
	// contains filtered or unexported fields
}

func (GetQueryResultsOutput) GoString added in v1.42.28 

func (s GetQueryResultsOutput) 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 (*GetQueryResultsOutput) SetErrorMessage added in v1.42.28 

func (s *GetQueryResultsOutput) SetErrorMessage(v string) *GetQueryResultsOutput

SetErrorMessage sets the ErrorMessage field's value.

func (*GetQueryResultsOutput) SetNextToken added in v1.42.28 

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

SetNextToken sets the NextToken field's value.

func (*GetQueryResultsOutput) SetQueryResultRows added in v1.42.28 

func (s *GetQueryResultsOutput) SetQueryResultRows(v [][]map[string]*string) *GetQueryResultsOutput

SetQueryResultRows sets the QueryResultRows field's value.

func (*GetQueryResultsOutput) SetQueryStatistics added in v1.42.28 

func (s *GetQueryResultsOutput) SetQueryStatistics(v *QueryStatistics) *GetQueryResultsOutput

SetQueryStatistics sets the QueryStatistics field's value.

func (*GetQueryResultsOutput) SetQueryStatus added in v1.42.28 

func (s *GetQueryResultsOutput) SetQueryStatus(v string) *GetQueryResultsOutput

SetQueryStatus sets the QueryStatus field's value.

func (GetQueryResultsOutput) String added in v1.42.28 

func (s GetQueryResultsOutput) 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 GetTrailInput added in v1.25.25 

type GetTrailInput struct {

	// The name or the Amazon Resource Name (ARN) of the trail for which you want
	// to retrieve settings information.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTrailInput) GoString added in v1.25.25 

func (s GetTrailInput) 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 (*GetTrailInput) SetName added in v1.25.25 

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

SetName sets the Name field's value.

func (GetTrailInput) String added in v1.25.25 

func (s GetTrailInput) 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 (*GetTrailInput) Validate added in v1.25.25 

func (s *GetTrailInput) Validate() error

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

type GetTrailOutput added in v1.25.25 

type GetTrailOutput struct {

	// The settings for a trail.
	Trail *Trail `type:"structure"`
	// contains filtered or unexported fields
}

func (GetTrailOutput) GoString added in v1.25.25 

func (s GetTrailOutput) 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 (*GetTrailOutput) SetTrail added in v1.25.25 

func (s *GetTrailOutput) SetTrail(v *Trail) *GetTrailOutput

SetTrail sets the Trail field's value.

func (GetTrailOutput) String added in v1.25.25 

func (s GetTrailOutput) 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 GetTrailStatusInput 

type GetTrailStatusInput struct {

	// Specifies the name or the CloudTrail ARN of the trail for which you are requesting
	// status. To get the status of a shadow trail (a replication of the trail in
	// another region), you must specify its ARN. The following is the format of
	// a trail ARN.
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The name of a trail about which you want the current status.

func (GetTrailStatusInput) GoString added in v0.6.5 

func (s GetTrailStatusInput) 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 (*GetTrailStatusInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (GetTrailStatusInput) String added in v0.6.5 

func (s GetTrailStatusInput) 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 (*GetTrailStatusInput) Validate added in v1.1.21 

func (s *GetTrailStatusInput) Validate() error

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

type GetTrailStatusOutput 

type GetTrailStatusOutput struct {

	// Whether the CloudTrail trail is currently logging Amazon Web Services API
	// calls.
	IsLogging *bool `type:"boolean"`

	// Displays any CloudWatch Logs error that CloudTrail encountered when attempting
	// to deliver logs to CloudWatch Logs.
	LatestCloudWatchLogsDeliveryError *string `type:"string"`

	// Displays the most recent date and time when CloudTrail delivered logs to
	// CloudWatch Logs.
	LatestCloudWatchLogsDeliveryTime *time.Time `type:"timestamp"`

	// This field is no longer in use.
	LatestDeliveryAttemptSucceeded *string `type:"string"`

	// This field is no longer in use.
	LatestDeliveryAttemptTime *string `type:"string"`

	// Displays any Amazon S3 error that CloudTrail encountered when attempting
	// to deliver log files to the designated bucket. For more information, see
	// Error Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html)
	// in the Amazon S3 API Reference.
	//
	// This error occurs only when there is a problem with the destination S3 bucket,
	// and does not occur for requests that time out. To resolve the issue, create
	// a new bucket, and then call UpdateTrail to specify the new bucket; or fix
	// the existing objects so that CloudTrail can again write to the bucket.
	LatestDeliveryError *string `type:"string"`

	// Specifies the date and time that CloudTrail last delivered log files to an
	// account's Amazon S3 bucket.
	LatestDeliveryTime *time.Time `type:"timestamp"`

	// Displays any Amazon S3 error that CloudTrail encountered when attempting
	// to deliver a digest file to the designated bucket. For more information,
	// see Error Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html)
	// in the Amazon S3 API Reference.
	//
	// This error occurs only when there is a problem with the destination S3 bucket,
	// and does not occur for requests that time out. To resolve the issue, create
	// a new bucket, and then call UpdateTrail to specify the new bucket; or fix
	// the existing objects so that CloudTrail can again write to the bucket.
	LatestDigestDeliveryError *string `type:"string"`

	// Specifies the date and time that CloudTrail last delivered a digest file
	// to an account's Amazon S3 bucket.
	LatestDigestDeliveryTime *time.Time `type:"timestamp"`

	// This field is no longer in use.
	LatestNotificationAttemptSucceeded *string `type:"string"`

	// This field is no longer in use.
	LatestNotificationAttemptTime *string `type:"string"`

	// Displays any Amazon SNS error that CloudTrail encountered when attempting
	// to send a notification. For more information about Amazon SNS errors, see
	// the Amazon SNS Developer Guide (https://docs.aws.amazon.com/sns/latest/dg/welcome.html).
	LatestNotificationError *string `type:"string"`

	// Specifies the date and time of the most recent Amazon SNS notification that
	// CloudTrail has written a new log file to an account's Amazon S3 bucket.
	LatestNotificationTime *time.Time `type:"timestamp"`

	// Specifies the most recent date and time when CloudTrail started recording
	// API calls for an Amazon Web Services account.
	StartLoggingTime *time.Time `type:"timestamp"`

	// Specifies the most recent date and time when CloudTrail stopped recording
	// API calls for an Amazon Web Services account.
	StopLoggingTime *time.Time `type:"timestamp"`

	// This field is no longer in use.
	TimeLoggingStarted *string `type:"string"`

	// This field is no longer in use.
	TimeLoggingStopped *string `type:"string"`
	// contains filtered or unexported fields
}

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (GetTrailStatusOutput) GoString added in v0.6.5 

func (s GetTrailStatusOutput) 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 (*GetTrailStatusOutput) SetIsLogging added in v1.5.0 

func (s *GetTrailStatusOutput) SetIsLogging(v bool) *GetTrailStatusOutput

SetIsLogging sets the IsLogging field's value.

func (*GetTrailStatusOutput) SetLatestCloudWatchLogsDeliveryError added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestCloudWatchLogsDeliveryError(v string) *GetTrailStatusOutput

SetLatestCloudWatchLogsDeliveryError sets the LatestCloudWatchLogsDeliveryError field's value.

func (*GetTrailStatusOutput) SetLatestCloudWatchLogsDeliveryTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestCloudWatchLogsDeliveryTime(v time.Time) *GetTrailStatusOutput

SetLatestCloudWatchLogsDeliveryTime sets the LatestCloudWatchLogsDeliveryTime field's value.

func (*GetTrailStatusOutput) SetLatestDeliveryAttemptSucceeded added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestDeliveryAttemptSucceeded(v string) *GetTrailStatusOutput

SetLatestDeliveryAttemptSucceeded sets the LatestDeliveryAttemptSucceeded field's value.

func (*GetTrailStatusOutput) SetLatestDeliveryAttemptTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestDeliveryAttemptTime(v string) *GetTrailStatusOutput

SetLatestDeliveryAttemptTime sets the LatestDeliveryAttemptTime field's value.

func (*GetTrailStatusOutput) SetLatestDeliveryError added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestDeliveryError(v string) *GetTrailStatusOutput

SetLatestDeliveryError sets the LatestDeliveryError field's value.

func (*GetTrailStatusOutput) SetLatestDeliveryTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestDeliveryTime(v time.Time) *GetTrailStatusOutput

SetLatestDeliveryTime sets the LatestDeliveryTime field's value.

func (*GetTrailStatusOutput) SetLatestDigestDeliveryError added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestDigestDeliveryError(v string) *GetTrailStatusOutput

SetLatestDigestDeliveryError sets the LatestDigestDeliveryError field's value.

func (*GetTrailStatusOutput) SetLatestDigestDeliveryTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestDigestDeliveryTime(v time.Time) *GetTrailStatusOutput

SetLatestDigestDeliveryTime sets the LatestDigestDeliveryTime field's value.

func (*GetTrailStatusOutput) SetLatestNotificationAttemptSucceeded added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestNotificationAttemptSucceeded(v string) *GetTrailStatusOutput

SetLatestNotificationAttemptSucceeded sets the LatestNotificationAttemptSucceeded field's value.

func (*GetTrailStatusOutput) SetLatestNotificationAttemptTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestNotificationAttemptTime(v string) *GetTrailStatusOutput

SetLatestNotificationAttemptTime sets the LatestNotificationAttemptTime field's value.

func (*GetTrailStatusOutput) SetLatestNotificationError added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestNotificationError(v string) *GetTrailStatusOutput

SetLatestNotificationError sets the LatestNotificationError field's value.

func (*GetTrailStatusOutput) SetLatestNotificationTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetLatestNotificationTime(v time.Time) *GetTrailStatusOutput

SetLatestNotificationTime sets the LatestNotificationTime field's value.

func (*GetTrailStatusOutput) SetStartLoggingTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetStartLoggingTime(v time.Time) *GetTrailStatusOutput

SetStartLoggingTime sets the StartLoggingTime field's value.

func (*GetTrailStatusOutput) SetStopLoggingTime added in v1.5.0 

func (s *GetTrailStatusOutput) SetStopLoggingTime(v time.Time) *GetTrailStatusOutput

SetStopLoggingTime sets the StopLoggingTime field's value.

func (*GetTrailStatusOutput) SetTimeLoggingStarted added in v1.5.0 

func (s *GetTrailStatusOutput) SetTimeLoggingStarted(v string) *GetTrailStatusOutput

SetTimeLoggingStarted sets the TimeLoggingStarted field's value.

func (*GetTrailStatusOutput) SetTimeLoggingStopped added in v1.5.0 

func (s *GetTrailStatusOutput) SetTimeLoggingStopped(v string) *GetTrailStatusOutput

SetTimeLoggingStopped sets the TimeLoggingStopped field's value.

func (GetTrailStatusOutput) String added in v0.6.5 

func (s GetTrailStatusOutput) 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 InactiveEventDataStoreException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The event data store against which you ran your query is inactive.

func (*InactiveEventDataStoreException) Code added in v1.42.28 

func (s *InactiveEventDataStoreException) Code() string

Code returns the exception type name.

func (*InactiveEventDataStoreException) Error added in v1.42.28 

func (s *InactiveEventDataStoreException) Error() string

func (InactiveEventDataStoreException) GoString added in v1.42.28 

func (s InactiveEventDataStoreException) 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 (*InactiveEventDataStoreException) Message added in v1.42.28 

func (s *InactiveEventDataStoreException) Message() string

Message returns the exception's message.

func (*InactiveEventDataStoreException) OrigErr added in v1.42.28 

func (s *InactiveEventDataStoreException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InactiveEventDataStoreException) RequestID added in v1.42.28 

func (s *InactiveEventDataStoreException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InactiveEventDataStoreException) StatusCode added in v1.42.28 

func (s *InactiveEventDataStoreException) StatusCode() int

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

func (InactiveEventDataStoreException) String added in v1.42.28 

func (s InactiveEventDataStoreException) 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 InactiveQueryException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified query cannot be canceled because it is in the FINISHED, FAILED, or CANCELLED state.

func (*InactiveQueryException) Code added in v1.42.28 

func (s *InactiveQueryException) Code() string

Code returns the exception type name.

func (*InactiveQueryException) Error added in v1.42.28 

func (s *InactiveQueryException) Error() string

func (InactiveQueryException) GoString added in v1.42.28 

func (s InactiveQueryException) 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 (*InactiveQueryException) Message added in v1.42.28 

func (s *InactiveQueryException) Message() string

Message returns the exception's message.

func (*InactiveQueryException) OrigErr added in v1.42.28 

func (s *InactiveQueryException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InactiveQueryException) RequestID added in v1.42.28 

func (s *InactiveQueryException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InactiveQueryException) StatusCode added in v1.42.28 

func (s *InactiveQueryException) StatusCode() int

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

func (InactiveQueryException) String added in v1.42.28 

func (s InactiveQueryException) 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 InsightNotEnabledException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InsightNotEnabledException) Code() string

Code returns the exception type name.

func (*InsightNotEnabledException) Error added in v1.28.0 

func (s *InsightNotEnabledException) Error() string

func (InsightNotEnabledException) GoString added in v1.28.0 

func (s InsightNotEnabledException) 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 (*InsightNotEnabledException) Message added in v1.28.0 

func (s *InsightNotEnabledException) Message() string

Message returns the exception's message.

func (*InsightNotEnabledException) OrigErr added in v1.28.0 

func (s *InsightNotEnabledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InsightNotEnabledException) RequestID added in v1.28.0 

func (s *InsightNotEnabledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InsightNotEnabledException) StatusCode added in v1.28.0 

func (s *InsightNotEnabledException) StatusCode() int

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

func (InsightNotEnabledException) String added in v1.28.0 

func (s InsightNotEnabledException) 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 InsightSelector added in v1.25.39 

type InsightSelector struct {

	// The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight
	// are valid insight types.
	InsightType *string `type:"string" enum:"InsightType"`
	// contains filtered or unexported fields
}

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

func (InsightSelector) GoString added in v1.25.39 

func (s InsightSelector) 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 (*InsightSelector) SetInsightType added in v1.25.39 

func (s *InsightSelector) SetInsightType(v string) *InsightSelector

SetInsightType sets the InsightType field's value.

func (InsightSelector) String added in v1.25.39 

func (s InsightSelector) 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 InsufficientDependencyServiceAccessPermissionException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InsufficientDependencyServiceAccessPermissionException) Code() string

Code returns the exception type name.

func (*InsufficientDependencyServiceAccessPermissionException) Error added in v1.28.0 

func (s *InsufficientDependencyServiceAccessPermissionException) Error() string

func (InsufficientDependencyServiceAccessPermissionException) GoString added in v1.28.0 

func (s InsufficientDependencyServiceAccessPermissionException) 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 (*InsufficientDependencyServiceAccessPermissionException) Message added in v1.28.0 

func (s *InsufficientDependencyServiceAccessPermissionException) Message() string

Message returns the exception's message.

func (*InsufficientDependencyServiceAccessPermissionException) OrigErr added in v1.28.0 

func (s *InsufficientDependencyServiceAccessPermissionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InsufficientDependencyServiceAccessPermissionException) RequestID added in v1.28.0 

func (s *InsufficientDependencyServiceAccessPermissionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InsufficientDependencyServiceAccessPermissionException) StatusCode added in v1.28.0 

func (s *InsufficientDependencyServiceAccessPermissionException) StatusCode() int

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

func (InsufficientDependencyServiceAccessPermissionException) String added in v1.28.0 

func (s InsufficientDependencyServiceAccessPermissionException) 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 InsufficientEncryptionPolicyException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InsufficientEncryptionPolicyException) Code() string

Code returns the exception type name.

func (*InsufficientEncryptionPolicyException) Error added in v1.28.0 

func (s *InsufficientEncryptionPolicyException) Error() string

func (InsufficientEncryptionPolicyException) GoString added in v1.28.0 

func (s InsufficientEncryptionPolicyException) 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 (*InsufficientEncryptionPolicyException) Message added in v1.28.0 

func (s *InsufficientEncryptionPolicyException) Message() string

Message returns the exception's message.

func (*InsufficientEncryptionPolicyException) OrigErr added in v1.28.0 

func (s *InsufficientEncryptionPolicyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InsufficientEncryptionPolicyException) RequestID added in v1.28.0 

func (s *InsufficientEncryptionPolicyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InsufficientEncryptionPolicyException) StatusCode added in v1.28.0 

func (s *InsufficientEncryptionPolicyException) StatusCode() int

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

func (InsufficientEncryptionPolicyException) String added in v1.28.0 

func (s InsufficientEncryptionPolicyException) 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 InsufficientS3BucketPolicyException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InsufficientS3BucketPolicyException) Code added in v1.28.0 

func (s *InsufficientS3BucketPolicyException) Code() string

Code returns the exception type name.

func (*InsufficientS3BucketPolicyException) Error added in v1.28.0 

func (s *InsufficientS3BucketPolicyException) Error() string

func (InsufficientS3BucketPolicyException) GoString added in v1.28.0 

func (s InsufficientS3BucketPolicyException) 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 (*InsufficientS3BucketPolicyException) Message added in v1.28.0 

func (s *InsufficientS3BucketPolicyException) Message() string

Message returns the exception's message.

func (*InsufficientS3BucketPolicyException) OrigErr added in v1.28.0 

func (s *InsufficientS3BucketPolicyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InsufficientS3BucketPolicyException) RequestID added in v1.28.0 

func (s *InsufficientS3BucketPolicyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InsufficientS3BucketPolicyException) StatusCode added in v1.28.0 

func (s *InsufficientS3BucketPolicyException) StatusCode() int

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

func (InsufficientS3BucketPolicyException) String added in v1.28.0 

func (s InsufficientS3BucketPolicyException) 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 InsufficientSnsTopicPolicyException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InsufficientSnsTopicPolicyException) Code added in v1.28.0 

func (s *InsufficientSnsTopicPolicyException) Code() string

Code returns the exception type name.

func (*InsufficientSnsTopicPolicyException) Error added in v1.28.0 

func (s *InsufficientSnsTopicPolicyException) Error() string

func (InsufficientSnsTopicPolicyException) GoString added in v1.28.0 

func (s InsufficientSnsTopicPolicyException) 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 (*InsufficientSnsTopicPolicyException) Message added in v1.28.0 

func (s *InsufficientSnsTopicPolicyException) Message() string

Message returns the exception's message.

func (*InsufficientSnsTopicPolicyException) OrigErr added in v1.28.0 

func (s *InsufficientSnsTopicPolicyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InsufficientSnsTopicPolicyException) RequestID added in v1.28.0 

func (s *InsufficientSnsTopicPolicyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InsufficientSnsTopicPolicyException) StatusCode added in v1.28.0 

func (s *InsufficientSnsTopicPolicyException) StatusCode() int

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

func (InsufficientSnsTopicPolicyException) String added in v1.28.0 

func (s InsufficientSnsTopicPolicyException) 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 InvalidCloudWatchLogsLogGroupArnException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidCloudWatchLogsLogGroupArnException) Code added in v1.28.0 

func (s *InvalidCloudWatchLogsLogGroupArnException) Code() string

Code returns the exception type name.

func (*InvalidCloudWatchLogsLogGroupArnException) Error added in v1.28.0 

func (s *InvalidCloudWatchLogsLogGroupArnException) Error() string

func (InvalidCloudWatchLogsLogGroupArnException) GoString added in v1.28.0 

func (s InvalidCloudWatchLogsLogGroupArnException) 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 (*InvalidCloudWatchLogsLogGroupArnException) Message added in v1.28.0 

func (s *InvalidCloudWatchLogsLogGroupArnException) Message() string

Message returns the exception's message.

func (*InvalidCloudWatchLogsLogGroupArnException) OrigErr added in v1.28.0 

func (s *InvalidCloudWatchLogsLogGroupArnException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidCloudWatchLogsLogGroupArnException) RequestID added in v1.28.0 

func (s *InvalidCloudWatchLogsLogGroupArnException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidCloudWatchLogsLogGroupArnException) StatusCode added in v1.28.0 

func (s *InvalidCloudWatchLogsLogGroupArnException) StatusCode() int

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

func (InvalidCloudWatchLogsLogGroupArnException) String added in v1.28.0 

func (s InvalidCloudWatchLogsLogGroupArnException) 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 InvalidCloudWatchLogsRoleArnException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidCloudWatchLogsRoleArnException) Code added in v1.28.0 

func (s *InvalidCloudWatchLogsRoleArnException) Code() string

Code returns the exception type name.

func (*InvalidCloudWatchLogsRoleArnException) Error added in v1.28.0 

func (s *InvalidCloudWatchLogsRoleArnException) Error() string

func (InvalidCloudWatchLogsRoleArnException) GoString added in v1.28.0 

func (s InvalidCloudWatchLogsRoleArnException) 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 (*InvalidCloudWatchLogsRoleArnException) Message added in v1.28.0 

func (s *InvalidCloudWatchLogsRoleArnException) Message() string

Message returns the exception's message.

func (*InvalidCloudWatchLogsRoleArnException) OrigErr added in v1.28.0 

func (s *InvalidCloudWatchLogsRoleArnException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidCloudWatchLogsRoleArnException) RequestID added in v1.28.0 

func (s *InvalidCloudWatchLogsRoleArnException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidCloudWatchLogsRoleArnException) StatusCode added in v1.28.0 

func (s *InvalidCloudWatchLogsRoleArnException) StatusCode() int

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

func (InvalidCloudWatchLogsRoleArnException) String added in v1.28.0 

func (s InvalidCloudWatchLogsRoleArnException) 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 InvalidDateRangeException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A date range for the query was specified that is not valid. For more information about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) in the CloudTrail User Guide.

func (*InvalidDateRangeException) Code added in v1.42.28 

func (s *InvalidDateRangeException) Code() string

Code returns the exception type name.

func (*InvalidDateRangeException) Error added in v1.42.28 

func (s *InvalidDateRangeException) Error() string

func (InvalidDateRangeException) GoString added in v1.42.28 

func (s InvalidDateRangeException) 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 (*InvalidDateRangeException) Message added in v1.42.28 

func (s *InvalidDateRangeException) Message() string

Message returns the exception's message.

func (*InvalidDateRangeException) OrigErr added in v1.42.28 

func (s *InvalidDateRangeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidDateRangeException) RequestID added in v1.42.28 

func (s *InvalidDateRangeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidDateRangeException) StatusCode added in v1.42.28 

func (s *InvalidDateRangeException) StatusCode() int

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

func (InvalidDateRangeException) String added in v1.42.28 

func (s InvalidDateRangeException) 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 InvalidEventCategoryException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidEventCategoryException) Code added in v1.28.0 

func (s *InvalidEventCategoryException) Code() string

Code returns the exception type name.

func (*InvalidEventCategoryException) Error added in v1.28.0 

func (s *InvalidEventCategoryException) Error() string

func (InvalidEventCategoryException) GoString added in v1.28.0 

func (s InvalidEventCategoryException) 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 (*InvalidEventCategoryException) Message added in v1.28.0 

func (s *InvalidEventCategoryException) Message() string

Message returns the exception's message.

func (*InvalidEventCategoryException) OrigErr added in v1.28.0 

func (s *InvalidEventCategoryException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEventCategoryException) RequestID added in v1.28.0 

func (s *InvalidEventCategoryException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEventCategoryException) StatusCode added in v1.28.0 

func (s *InvalidEventCategoryException) StatusCode() int

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

func (InvalidEventCategoryException) String added in v1.28.0 

func (s InvalidEventCategoryException) 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 InvalidEventDataStoreStatusException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The event data store is not in a status that supports the operation.

func (*InvalidEventDataStoreStatusException) Code added in v1.42.28 

func (s *InvalidEventDataStoreStatusException) Code() string

Code returns the exception type name.

func (*InvalidEventDataStoreStatusException) Error added in v1.42.28 

func (s *InvalidEventDataStoreStatusException) Error() string

func (InvalidEventDataStoreStatusException) GoString added in v1.42.28 

func (s InvalidEventDataStoreStatusException) 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 (*InvalidEventDataStoreStatusException) Message added in v1.42.28 

func (s *InvalidEventDataStoreStatusException) Message() string

Message returns the exception's message.

func (*InvalidEventDataStoreStatusException) OrigErr added in v1.42.28 

func (s *InvalidEventDataStoreStatusException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEventDataStoreStatusException) RequestID added in v1.42.28 

func (s *InvalidEventDataStoreStatusException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEventDataStoreStatusException) StatusCode added in v1.42.28 

func (s *InvalidEventDataStoreStatusException) StatusCode() int

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

func (InvalidEventDataStoreStatusException) String added in v1.42.28 

func (s InvalidEventDataStoreStatusException) 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 InvalidEventSelectorsException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InvalidEventSelectorsException) Code() string

Code returns the exception type name.

func (*InvalidEventSelectorsException) Error added in v1.28.0 

func (s *InvalidEventSelectorsException) Error() string

func (InvalidEventSelectorsException) GoString added in v1.28.0 

func (s InvalidEventSelectorsException) 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 (*InvalidEventSelectorsException) Message added in v1.28.0 

func (s *InvalidEventSelectorsException) Message() string

Message returns the exception's message.

func (*InvalidEventSelectorsException) OrigErr added in v1.28.0 

func (s *InvalidEventSelectorsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEventSelectorsException) RequestID added in v1.28.0 

func (s *InvalidEventSelectorsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEventSelectorsException) StatusCode added in v1.28.0 

func (s *InvalidEventSelectorsException) StatusCode() int

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

func (InvalidEventSelectorsException) String added in v1.28.0 

func (s InvalidEventSelectorsException) 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 InvalidHomeRegionException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InvalidHomeRegionException) Code() string

Code returns the exception type name.

func (*InvalidHomeRegionException) Error added in v1.28.0 

func (s *InvalidHomeRegionException) Error() string

func (InvalidHomeRegionException) GoString added in v1.28.0 

func (s InvalidHomeRegionException) 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 (*InvalidHomeRegionException) Message added in v1.28.0 

func (s *InvalidHomeRegionException) Message() string

Message returns the exception's message.

func (*InvalidHomeRegionException) OrigErr added in v1.28.0 

func (s *InvalidHomeRegionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidHomeRegionException) RequestID added in v1.28.0 

func (s *InvalidHomeRegionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidHomeRegionException) StatusCode added in v1.28.0 

func (s *InvalidHomeRegionException) StatusCode() int

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

func (InvalidHomeRegionException) String added in v1.28.0 

func (s InvalidHomeRegionException) 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 InvalidInsightSelectorsException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InvalidInsightSelectorsException) Code() string

Code returns the exception type name.

func (*InvalidInsightSelectorsException) Error added in v1.28.0 

func (s *InvalidInsightSelectorsException) Error() string

func (InvalidInsightSelectorsException) GoString added in v1.28.0 

func (s InvalidInsightSelectorsException) 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 (*InvalidInsightSelectorsException) Message added in v1.28.0 

func (s *InvalidInsightSelectorsException) Message() string

Message returns the exception's message.

func (*InvalidInsightSelectorsException) OrigErr added in v1.28.0 

func (s *InvalidInsightSelectorsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInsightSelectorsException) RequestID added in v1.28.0 

func (s *InvalidInsightSelectorsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInsightSelectorsException) StatusCode added in v1.28.0 

func (s *InvalidInsightSelectorsException) StatusCode() int

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

func (InvalidInsightSelectorsException) String added in v1.28.0 

func (s InvalidInsightSelectorsException) 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 InvalidKmsKeyIdException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidKmsKeyIdException) Code added in v1.28.0 

func (s *InvalidKmsKeyIdException) Code() string

Code returns the exception type name.

func (*InvalidKmsKeyIdException) Error added in v1.28.0 

func (s *InvalidKmsKeyIdException) Error() string

func (InvalidKmsKeyIdException) GoString added in v1.28.0 

func (s InvalidKmsKeyIdException) 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 (*InvalidKmsKeyIdException) Message added in v1.28.0 

func (s *InvalidKmsKeyIdException) Message() string

Message returns the exception's message.

func (*InvalidKmsKeyIdException) OrigErr added in v1.28.0 

func (s *InvalidKmsKeyIdException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidKmsKeyIdException) RequestID added in v1.28.0 

func (s *InvalidKmsKeyIdException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidKmsKeyIdException) StatusCode added in v1.28.0 

func (s *InvalidKmsKeyIdException) StatusCode() int

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

func (InvalidKmsKeyIdException) String added in v1.28.0 

func (s InvalidKmsKeyIdException) 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 InvalidLookupAttributesException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidLookupAttributesException) Code added in v1.28.0 

func (s *InvalidLookupAttributesException) Code() string

Code returns the exception type name.

func (*InvalidLookupAttributesException) Error added in v1.28.0 

func (s *InvalidLookupAttributesException) Error() string

func (InvalidLookupAttributesException) GoString added in v1.28.0 

func (s InvalidLookupAttributesException) 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 (*InvalidLookupAttributesException) Message added in v1.28.0 

func (s *InvalidLookupAttributesException) Message() string

Message returns the exception's message.

func (*InvalidLookupAttributesException) OrigErr added in v1.28.0 

func (s *InvalidLookupAttributesException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidLookupAttributesException) RequestID added in v1.28.0 

func (s *InvalidLookupAttributesException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidLookupAttributesException) StatusCode added in v1.28.0 

func (s *InvalidLookupAttributesException) StatusCode() int

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

func (InvalidLookupAttributesException) String added in v1.28.0 

func (s InvalidLookupAttributesException) 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 InvalidMaxResultsException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidMaxResultsException) Code added in v1.28.0 

func (s *InvalidMaxResultsException) Code() string

Code returns the exception type name.

func (*InvalidMaxResultsException) Error added in v1.28.0 

func (s *InvalidMaxResultsException) Error() string

func (InvalidMaxResultsException) GoString added in v1.28.0 

func (s InvalidMaxResultsException) 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 (*InvalidMaxResultsException) Message added in v1.28.0 

func (s *InvalidMaxResultsException) Message() string

Message returns the exception's message.

func (*InvalidMaxResultsException) OrigErr added in v1.28.0 

func (s *InvalidMaxResultsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidMaxResultsException) RequestID added in v1.28.0 

func (s *InvalidMaxResultsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidMaxResultsException) StatusCode added in v1.28.0 

func (s *InvalidMaxResultsException) StatusCode() int

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

func (InvalidMaxResultsException) String added in v1.28.0 

func (s InvalidMaxResultsException) 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 InvalidNextTokenException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InvalidNextTokenException) Code() string

Code returns the exception type name.

func (*InvalidNextTokenException) Error added in v1.28.0 

func (s *InvalidNextTokenException) Error() string

func (InvalidNextTokenException) GoString added in v1.28.0 

func (s InvalidNextTokenException) 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 (*InvalidNextTokenException) Message added in v1.28.0 

func (s *InvalidNextTokenException) Message() string

Message returns the exception's message.

func (*InvalidNextTokenException) OrigErr added in v1.28.0 

func (s *InvalidNextTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidNextTokenException) RequestID added in v1.28.0 

func (s *InvalidNextTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidNextTokenException) StatusCode added in v1.28.0 

func (s *InvalidNextTokenException) StatusCode() int

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

func (InvalidNextTokenException) String added in v1.28.0 

func (s InvalidNextTokenException) 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 InvalidParameterCombinationException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidParameterCombinationException) Code added in v1.28.0 

func (s *InvalidParameterCombinationException) Code() string

Code returns the exception type name.

func (*InvalidParameterCombinationException) Error added in v1.28.0 

func (s *InvalidParameterCombinationException) Error() string

func (InvalidParameterCombinationException) GoString added in v1.28.0 

func (s InvalidParameterCombinationException) 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 (*InvalidParameterCombinationException) Message added in v1.28.0 

func (s *InvalidParameterCombinationException) Message() string

Message returns the exception's message.

func (*InvalidParameterCombinationException) OrigErr added in v1.28.0 

func (s *InvalidParameterCombinationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterCombinationException) RequestID added in v1.28.0 

func (s *InvalidParameterCombinationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterCombinationException) StatusCode added in v1.28.0 

func (s *InvalidParameterCombinationException) StatusCode() int

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

func (InvalidParameterCombinationException) String added in v1.28.0 

func (s InvalidParameterCombinationException) 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 InvalidParameterException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request includes a parameter that is not valid.

func (*InvalidParameterException) Code added in v1.42.28 

func (s *InvalidParameterException) Code() string

Code returns the exception type name.

func (*InvalidParameterException) Error added in v1.42.28 

func (s *InvalidParameterException) Error() string

func (InvalidParameterException) GoString added in v1.42.28 

func (s InvalidParameterException) 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 (*InvalidParameterException) Message added in v1.42.28 

func (s *InvalidParameterException) Message() string

Message returns the exception's message.

func (*InvalidParameterException) OrigErr added in v1.42.28 

func (s *InvalidParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterException) RequestID added in v1.42.28 

func (s *InvalidParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterException) StatusCode added in v1.42.28 

func (s *InvalidParameterException) StatusCode() int

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

func (InvalidParameterException) String added in v1.42.28 

func (s InvalidParameterException) 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 InvalidQueryStatementException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information about writing a query, see Create or edit a query (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-create-edit-query.html) in the CloudTrail User Guide.

func (*InvalidQueryStatementException) Code added in v1.42.28 

func (s *InvalidQueryStatementException) Code() string

Code returns the exception type name.

func (*InvalidQueryStatementException) Error added in v1.42.28 

func (s *InvalidQueryStatementException) Error() string

func (InvalidQueryStatementException) GoString added in v1.42.28 

func (s InvalidQueryStatementException) 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 (*InvalidQueryStatementException) Message added in v1.42.28 

func (s *InvalidQueryStatementException) Message() string

Message returns the exception's message.

func (*InvalidQueryStatementException) OrigErr added in v1.42.28 

func (s *InvalidQueryStatementException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidQueryStatementException) RequestID added in v1.42.28 

func (s *InvalidQueryStatementException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidQueryStatementException) StatusCode added in v1.42.28 

func (s *InvalidQueryStatementException) StatusCode() int

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

func (InvalidQueryStatementException) String added in v1.42.28 

func (s InvalidQueryStatementException) 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 InvalidQueryStatusException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The query status is not valid for the operation.

func (*InvalidQueryStatusException) Code added in v1.42.28 

func (s *InvalidQueryStatusException) Code() string

Code returns the exception type name.

func (*InvalidQueryStatusException) Error added in v1.42.28 

func (s *InvalidQueryStatusException) Error() string

func (InvalidQueryStatusException) GoString added in v1.42.28 

func (s InvalidQueryStatusException) 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 (*InvalidQueryStatusException) Message added in v1.42.28 

func (s *InvalidQueryStatusException) Message() string

Message returns the exception's message.

func (*InvalidQueryStatusException) OrigErr added in v1.42.28 

func (s *InvalidQueryStatusException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidQueryStatusException) RequestID added in v1.42.28 

func (s *InvalidQueryStatusException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidQueryStatusException) StatusCode added in v1.42.28 

func (s *InvalidQueryStatusException) StatusCode() int

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

func (InvalidQueryStatusException) String added in v1.42.28 

func (s InvalidQueryStatusException) 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 InvalidS3BucketNameException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidS3BucketNameException) Code added in v1.28.0 

func (s *InvalidS3BucketNameException) Code() string

Code returns the exception type name.

func (*InvalidS3BucketNameException) Error added in v1.28.0 

func (s *InvalidS3BucketNameException) Error() string

func (InvalidS3BucketNameException) GoString added in v1.28.0 

func (s InvalidS3BucketNameException) 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 (*InvalidS3BucketNameException) Message added in v1.28.0 

func (s *InvalidS3BucketNameException) Message() string

Message returns the exception's message.

func (*InvalidS3BucketNameException) OrigErr added in v1.28.0 

func (s *InvalidS3BucketNameException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidS3BucketNameException) RequestID added in v1.28.0 

func (s *InvalidS3BucketNameException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidS3BucketNameException) StatusCode added in v1.28.0 

func (s *InvalidS3BucketNameException) StatusCode() int

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

func (InvalidS3BucketNameException) String added in v1.28.0 

func (s InvalidS3BucketNameException) 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 InvalidS3PrefixException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidS3PrefixException) Code added in v1.28.0 

func (s *InvalidS3PrefixException) Code() string

Code returns the exception type name.

func (*InvalidS3PrefixException) Error added in v1.28.0 

func (s *InvalidS3PrefixException) Error() string

func (InvalidS3PrefixException) GoString added in v1.28.0 

func (s InvalidS3PrefixException) 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 (*InvalidS3PrefixException) Message added in v1.28.0 

func (s *InvalidS3PrefixException) Message() string

Message returns the exception's message.

func (*InvalidS3PrefixException) OrigErr added in v1.28.0 

func (s *InvalidS3PrefixException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidS3PrefixException) RequestID added in v1.28.0 

func (s *InvalidS3PrefixException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidS3PrefixException) StatusCode added in v1.28.0 

func (s *InvalidS3PrefixException) StatusCode() int

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

func (InvalidS3PrefixException) String added in v1.28.0 

func (s InvalidS3PrefixException) 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 InvalidSnsTopicNameException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidSnsTopicNameException) Code added in v1.28.0 

func (s *InvalidSnsTopicNameException) Code() string

Code returns the exception type name.

func (*InvalidSnsTopicNameException) Error added in v1.28.0 

func (s *InvalidSnsTopicNameException) Error() string

func (InvalidSnsTopicNameException) GoString added in v1.28.0 

func (s InvalidSnsTopicNameException) 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 (*InvalidSnsTopicNameException) Message added in v1.28.0 

func (s *InvalidSnsTopicNameException) Message() string

Message returns the exception's message.

func (*InvalidSnsTopicNameException) OrigErr added in v1.28.0 

func (s *InvalidSnsTopicNameException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidSnsTopicNameException) RequestID added in v1.28.0 

func (s *InvalidSnsTopicNameException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidSnsTopicNameException) StatusCode added in v1.28.0 

func (s *InvalidSnsTopicNameException) StatusCode() int

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

func (InvalidSnsTopicNameException) String added in v1.28.0 

func (s InvalidSnsTopicNameException) 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 InvalidTagParameterException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InvalidTagParameterException) Code() string

Code returns the exception type name.

func (*InvalidTagParameterException) Error added in v1.28.0 

func (s *InvalidTagParameterException) Error() string

func (InvalidTagParameterException) GoString added in v1.28.0 

func (s InvalidTagParameterException) 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 (*InvalidTagParameterException) Message added in v1.28.0 

func (s *InvalidTagParameterException) Message() string

Message returns the exception's message.

func (*InvalidTagParameterException) OrigErr added in v1.28.0 

func (s *InvalidTagParameterException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTagParameterException) RequestID added in v1.28.0 

func (s *InvalidTagParameterException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTagParameterException) StatusCode added in v1.28.0 

func (s *InvalidTagParameterException) StatusCode() int

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

func (InvalidTagParameterException) String added in v1.28.0 

func (s InvalidTagParameterException) 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 InvalidTimeRangeException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InvalidTimeRangeException) Code() string

Code returns the exception type name.

func (*InvalidTimeRangeException) Error added in v1.28.0 

func (s *InvalidTimeRangeException) Error() string

func (InvalidTimeRangeException) GoString added in v1.28.0 

func (s InvalidTimeRangeException) 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 (*InvalidTimeRangeException) Message added in v1.28.0 

func (s *InvalidTimeRangeException) Message() string

Message returns the exception's message.

func (*InvalidTimeRangeException) OrigErr added in v1.28.0 

func (s *InvalidTimeRangeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTimeRangeException) RequestID added in v1.28.0 

func (s *InvalidTimeRangeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTimeRangeException) StatusCode added in v1.28.0 

func (s *InvalidTimeRangeException) StatusCode() int

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

func (InvalidTimeRangeException) String added in v1.28.0 

func (s InvalidTimeRangeException) 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 InvalidTokenException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Reserved for future use.

func (*InvalidTokenException) Code added in v1.28.0 

func (s *InvalidTokenException) Code() string

Code returns the exception type name.

func (*InvalidTokenException) Error added in v1.28.0 

func (s *InvalidTokenException) Error() string

func (InvalidTokenException) GoString added in v1.28.0 

func (s InvalidTokenException) 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 (*InvalidTokenException) Message added in v1.28.0 

func (s *InvalidTokenException) Message() string

Message returns the exception's message.

func (*InvalidTokenException) OrigErr added in v1.28.0 

func (s *InvalidTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTokenException) RequestID added in v1.28.0 

func (s *InvalidTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTokenException) StatusCode added in v1.28.0 

func (s *InvalidTokenException) StatusCode() int

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

func (InvalidTokenException) String added in v1.28.0 

func (s InvalidTokenException) 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 InvalidTrailNameException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *InvalidTrailNameException) Code() string

Code returns the exception type name.

func (*InvalidTrailNameException) Error added in v1.28.0 

func (s *InvalidTrailNameException) Error() string

func (InvalidTrailNameException) GoString added in v1.28.0 

func (s InvalidTrailNameException) 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 (*InvalidTrailNameException) Message added in v1.28.0 

func (s *InvalidTrailNameException) Message() string

Message returns the exception's message.

func (*InvalidTrailNameException) OrigErr added in v1.28.0 

func (s *InvalidTrailNameException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTrailNameException) RequestID added in v1.28.0 

func (s *InvalidTrailNameException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTrailNameException) StatusCode added in v1.28.0 

func (s *InvalidTrailNameException) StatusCode() int

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

func (InvalidTrailNameException) String added in v1.28.0 

func (s InvalidTrailNameException) 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 KmsException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *KmsException) Code() string

Code returns the exception type name.

func (*KmsException) Error added in v1.28.0 

func (s *KmsException) Error() string

func (KmsException) GoString added in v1.28.0 

func (s KmsException) 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 (*KmsException) Message added in v1.28.0 

func (s *KmsException) Message() string

Message returns the exception's message.

func (*KmsException) OrigErr added in v1.28.0 

func (s *KmsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KmsException) RequestID added in v1.28.0 

func (s *KmsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KmsException) StatusCode added in v1.28.0 

func (s *KmsException) StatusCode() int

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

func (KmsException) String added in v1.28.0 

func (s KmsException) 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 KmsKeyDisabledException deprecated added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This exception is no longer in use.

Deprecated: KmsKeyDisabledException has been deprecated

func (*KmsKeyDisabledException) Code added in v1.28.0 

func (s *KmsKeyDisabledException) Code() string

Code returns the exception type name.

func (*KmsKeyDisabledException) Error added in v1.28.0 

func (s *KmsKeyDisabledException) Error() string

func (KmsKeyDisabledException) GoString added in v1.28.0 

func (s KmsKeyDisabledException) 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 (*KmsKeyDisabledException) Message added in v1.28.0 

func (s *KmsKeyDisabledException) Message() string

Message returns the exception's message.

func (*KmsKeyDisabledException) OrigErr added in v1.28.0 

func (s *KmsKeyDisabledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KmsKeyDisabledException) RequestID added in v1.28.0 

func (s *KmsKeyDisabledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KmsKeyDisabledException) StatusCode added in v1.28.0 

func (s *KmsKeyDisabledException) StatusCode() int

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

func (KmsKeyDisabledException) String added in v1.28.0 

func (s KmsKeyDisabledException) 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 KmsKeyNotFoundException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *KmsKeyNotFoundException) Code() string

Code returns the exception type name.

func (*KmsKeyNotFoundException) Error added in v1.28.0 

func (s *KmsKeyNotFoundException) Error() string

func (KmsKeyNotFoundException) GoString added in v1.28.0 

func (s KmsKeyNotFoundException) 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 (*KmsKeyNotFoundException) Message added in v1.28.0 

func (s *KmsKeyNotFoundException) Message() string

Message returns the exception's message.

func (*KmsKeyNotFoundException) OrigErr added in v1.28.0 

func (s *KmsKeyNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KmsKeyNotFoundException) RequestID added in v1.28.0 

func (s *KmsKeyNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KmsKeyNotFoundException) StatusCode added in v1.28.0 

func (s *KmsKeyNotFoundException) StatusCode() int

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

func (KmsKeyNotFoundException) String added in v1.28.0 

func (s KmsKeyNotFoundException) 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 ListEventDataStoresInput added in v1.42.28 

type ListEventDataStoresInput struct {

	// The maximum number of event data stores to display on a single page.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token you can use to get the next page of event data store results.
	NextToken *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventDataStoresInput) GoString added in v1.42.28 

func (s ListEventDataStoresInput) 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 (*ListEventDataStoresInput) SetMaxResults added in v1.42.28 

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

SetMaxResults sets the MaxResults field's value.

func (*ListEventDataStoresInput) SetNextToken added in v1.42.28 

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

SetNextToken sets the NextToken field's value.

func (ListEventDataStoresInput) String added in v1.42.28 

func (s ListEventDataStoresInput) 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 (*ListEventDataStoresInput) Validate added in v1.42.28 

func (s *ListEventDataStoresInput) Validate() error

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

type ListEventDataStoresOutput added in v1.42.28 

type ListEventDataStoresOutput struct {

	// Contains information about event data stores in the account, in the current
	// region.
	EventDataStores []*EventDataStore `type:"list"`

	// A token you can use to get the next page of results.
	NextToken *string `min:"4" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventDataStoresOutput) GoString added in v1.42.28 

func (s ListEventDataStoresOutput) 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 (*ListEventDataStoresOutput) SetEventDataStores added in v1.42.28 

func (s *ListEventDataStoresOutput) SetEventDataStores(v []*EventDataStore) *ListEventDataStoresOutput

SetEventDataStores sets the EventDataStores field's value.

func (*ListEventDataStoresOutput) SetNextToken added in v1.42.28 

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

SetNextToken sets the NextToken field's value.

func (ListEventDataStoresOutput) String added in v1.42.28 

func (s ListEventDataStoresOutput) 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 ListPublicKeysInput added in v0.9.11 

type ListPublicKeysInput struct {

	// Optionally specifies, in UTC, the end of the time range to look up public
	// keys for CloudTrail digest files. If not specified, the current time is used.
	EndTime *time.Time `type:"timestamp"`

	// Reserved for future use.
	NextToken *string `type:"string"`

	// Optionally specifies, in UTC, the start of the time range to look up public
	// keys for CloudTrail digest files. If not specified, the current time is used,
	// and the current public key is returned.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Requests the public keys for a specified time range.

func (ListPublicKeysInput) GoString added in v0.9.11 

func (s ListPublicKeysInput) 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 (*ListPublicKeysInput) SetEndTime added in v1.5.0 

func (s *ListPublicKeysInput) SetEndTime(v time.Time) *ListPublicKeysInput

SetEndTime sets the EndTime field's value.

func (*ListPublicKeysInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListPublicKeysInput) SetStartTime added in v1.5.0 

func (s *ListPublicKeysInput) SetStartTime(v time.Time) *ListPublicKeysInput

SetStartTime sets the StartTime field's value.

func (ListPublicKeysInput) String added in v0.9.11 

func (s ListPublicKeysInput) 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 ListPublicKeysOutput added in v0.9.11 

type ListPublicKeysOutput struct {

	// Reserved for future use.
	NextToken *string `type:"string"`

	// Contains an array of PublicKey objects.
	//
	// The returned public keys may have validity time ranges that overlap.
	PublicKeyList []*PublicKey `type:"list"`
	// contains filtered or unexported fields
}

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (ListPublicKeysOutput) GoString added in v0.9.11 

func (s ListPublicKeysOutput) 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 (*ListPublicKeysOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListPublicKeysOutput) SetPublicKeyList added in v1.5.0 

func (s *ListPublicKeysOutput) SetPublicKeyList(v []*PublicKey) *ListPublicKeysOutput

SetPublicKeyList sets the PublicKeyList field's value.

func (ListPublicKeysOutput) String added in v0.9.11 

func (s ListPublicKeysOutput) 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 ListQueriesInput added in v1.42.28 

type ListQueriesInput struct {

	// Use with StartTime to bound a ListQueries request, and limit its results
	// to only those queries run within a specified time period.
	EndTime *time.Time `type:"timestamp"`

	// The ARN (or the ID suffix of the ARN) of an event data store on which queries
	// were run.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`

	// The maximum number of queries to show on a page.
	MaxResults *int64 `min:"1" type:"integer"`

	// A token you can use to get the next page of results.
	NextToken *string `min:"4" type:"string"`

	// The status of queries that you want to return in results. Valid values for
	// QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, or CANCELLED.
	QueryStatus *string `type:"string" enum:"QueryStatus"`

	// Use with EndTime to bound a ListQueries request, and limit its results to
	// only those queries run within a specified time period.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (ListQueriesInput) GoString added in v1.42.28 

func (s ListQueriesInput) 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 (*ListQueriesInput) SetEndTime added in v1.42.28 

func (s *ListQueriesInput) SetEndTime(v time.Time) *ListQueriesInput

SetEndTime sets the EndTime field's value.

func (*ListQueriesInput) SetEventDataStore added in v1.42.28 

func (s *ListQueriesInput) SetEventDataStore(v string) *ListQueriesInput

SetEventDataStore sets the EventDataStore field's value.

func (*ListQueriesInput) SetMaxResults added in v1.42.28 

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

SetMaxResults sets the MaxResults field's value.

func (*ListQueriesInput) SetNextToken added in v1.42.28 

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

SetNextToken sets the NextToken field's value.

func (*ListQueriesInput) SetQueryStatus added in v1.42.28 

func (s *ListQueriesInput) SetQueryStatus(v string) *ListQueriesInput

SetQueryStatus sets the QueryStatus field's value.

func (*ListQueriesInput) SetStartTime added in v1.42.28 

func (s *ListQueriesInput) SetStartTime(v time.Time) *ListQueriesInput

SetStartTime sets the StartTime field's value.

func (ListQueriesInput) String added in v1.42.28 

func (s ListQueriesInput) 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 (*ListQueriesInput) Validate added in v1.42.28 

func (s *ListQueriesInput) Validate() error

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

type ListQueriesOutput added in v1.42.28 

type ListQueriesOutput struct {

	// A token you can use to get the next page of results.
	NextToken *string `min:"4" type:"string"`

	// Lists matching query results, and shows query ID, status, and creation time
	// of each query.
	Queries []*Query `type:"list"`
	// contains filtered or unexported fields
}

func (ListQueriesOutput) GoString added in v1.42.28 

func (s ListQueriesOutput) 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 (*ListQueriesOutput) SetNextToken added in v1.42.28 

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

SetNextToken sets the NextToken field's value.

func (*ListQueriesOutput) SetQueries added in v1.42.28 

func (s *ListQueriesOutput) SetQueries(v []*Query) *ListQueriesOutput

SetQueries sets the Queries field's value.

func (ListQueriesOutput) String added in v1.42.28 

func (s ListQueriesOutput) 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 ListTagsInput added in v0.9.11 

type ListTagsInput struct {

	// Reserved for future use.
	NextToken *string `type:"string"`

	// Specifies a list of trail ARNs whose tags will be listed. The list has a
	// limit of 20 ARNs. The following is the format of a trail ARN.
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// ResourceIdList is a required field
	ResourceIdList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies a list of trail tags to return.

func (ListTagsInput) GoString added in v0.9.11 

func (s ListTagsInput) 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 (*ListTagsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsInput) SetResourceIdList added in v1.5.0 

func (s *ListTagsInput) SetResourceIdList(v []*string) *ListTagsInput

SetResourceIdList sets the ResourceIdList field's value.

func (ListTagsInput) String added in v0.9.11 

func (s ListTagsInput) 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 (*ListTagsInput) Validate added in v1.1.21 

func (s *ListTagsInput) Validate() error

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

type ListTagsOutput added in v0.9.11 

type ListTagsOutput struct {

	// Reserved for future use.
	NextToken *string `type:"string"`

	// A list of resource tags.
	ResourceTagList []*ResourceTag `type:"list"`
	// contains filtered or unexported fields
}

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (ListTagsOutput) GoString added in v0.9.11 

func (s ListTagsOutput) 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 (*ListTagsOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsOutput) SetResourceTagList added in v1.5.0 

func (s *ListTagsOutput) SetResourceTagList(v []*ResourceTag) *ListTagsOutput

SetResourceTagList sets the ResourceTagList field's value.

func (ListTagsOutput) String added in v0.9.11 

func (s ListTagsOutput) 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 ListTrailsInput added in v1.25.25 

type ListTrailsInput struct {

	// The token to use to get the next page of results after a previous API call.
	// This token must be passed in with the same parameters that were specified
	// in the the original call. For example, if the original call specified an
	// AttributeKey of 'Username' with a value of 'root', the call with NextToken
	// should include those same parameters.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTrailsInput) GoString added in v1.25.25 

func (s ListTrailsInput) 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 (*ListTrailsInput) SetNextToken added in v1.25.25 

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

SetNextToken sets the NextToken field's value.

func (ListTrailsInput) String added in v1.25.25 

func (s ListTrailsInput) 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 ListTrailsOutput added in v1.25.25 

type ListTrailsOutput struct {

	// The token to use to get the next page of results after a previous API call.
	// If the token does not appear, there are no more results to return. The token
	// must be passed in with the same parameters as the previous call. For example,
	// if the original call specified an AttributeKey of 'Username' with a value
	// of 'root', the call with NextToken should include those same parameters.
	NextToken *string `type:"string"`

	// Returns the name, ARN, and home region of trails in the current account.
	Trails []*TrailInfo `type:"list"`
	// contains filtered or unexported fields
}

func (ListTrailsOutput) GoString added in v1.25.25 

func (s ListTrailsOutput) 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 (*ListTrailsOutput) SetNextToken added in v1.25.25 

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

SetNextToken sets the NextToken field's value.

func (*ListTrailsOutput) SetTrails added in v1.25.25 

func (s *ListTrailsOutput) SetTrails(v []*TrailInfo) *ListTrailsOutput

SetTrails sets the Trails field's value.

func (ListTrailsOutput) String added in v1.25.25 

func (s ListTrailsOutput) 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 LookupAttribute 

type LookupAttribute struct {

	// Specifies an attribute on which to filter the events returned.
	//
	// AttributeKey is a required field
	AttributeKey *string `type:"string" required:"true" enum:"LookupAttributeKey"`

	// Specifies a value for the specified AttributeKey.
	//
	// AttributeValue is a required field
	AttributeValue *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies an attribute and value that filter the events returned.

func (LookupAttribute) GoString added in v0.6.5 

func (s LookupAttribute) 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 (*LookupAttribute) SetAttributeKey added in v1.5.0 

func (s *LookupAttribute) SetAttributeKey(v string) *LookupAttribute

SetAttributeKey sets the AttributeKey field's value.

func (*LookupAttribute) SetAttributeValue added in v1.5.0 

func (s *LookupAttribute) SetAttributeValue(v string) *LookupAttribute

SetAttributeValue sets the AttributeValue field's value.

func (LookupAttribute) String added in v0.6.5 

func (s LookupAttribute) 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 (*LookupAttribute) Validate added in v1.1.21 

func (s *LookupAttribute) Validate() error

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

type LookupEventsInput 

type LookupEventsInput struct {

	// Specifies that only events that occur before or at the specified time are
	// returned. If the specified end time is before the specified start time, an
	// error is returned.
	EndTime *time.Time `type:"timestamp"`

	// Specifies the event category. If you do not specify an event category, events
	// of the category are not returned in the response. For example, if you do
	// not specify insight as the value of EventCategory, no Insights events are
	// returned.
	EventCategory *string `type:"string" enum:"EventCategory"`

	// Contains a list of lookup attributes. Currently the list can contain only
	// one item.
	LookupAttributes []*LookupAttribute `type:"list"`

	// The number of events to return. Possible values are 1 through 50. The default
	// is 50.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to get the next page of results after a previous API call.
	// This token must be passed in with the same parameters that were specified
	// in the the original call. For example, if the original call specified an
	// AttributeKey of 'Username' with a value of 'root', the call with NextToken
	// should include those same parameters.
	NextToken *string `type:"string"`

	// Specifies that only events that occur after or at the specified time are
	// returned. If the specified start time is after the specified end time, an
	// error is returned.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Contains a request for LookupEvents.

func (LookupEventsInput) GoString added in v0.6.5 

func (s LookupEventsInput) 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 (*LookupEventsInput) SetEndTime added in v1.5.0 

func (s *LookupEventsInput) SetEndTime(v time.Time) *LookupEventsInput

SetEndTime sets the EndTime field's value.

func (*LookupEventsInput) SetEventCategory added in v1.25.39 

func (s *LookupEventsInput) SetEventCategory(v string) *LookupEventsInput

SetEventCategory sets the EventCategory field's value.

func (*LookupEventsInput) SetLookupAttributes added in v1.5.0 

func (s *LookupEventsInput) SetLookupAttributes(v []*LookupAttribute) *LookupEventsInput

SetLookupAttributes sets the LookupAttributes field's value.

func (*LookupEventsInput) SetMaxResults added in v1.5.0 

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

SetMaxResults sets the MaxResults field's value.

func (*LookupEventsInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*LookupEventsInput) SetStartTime added in v1.5.0 

func (s *LookupEventsInput) SetStartTime(v time.Time) *LookupEventsInput

SetStartTime sets the StartTime field's value.

func (LookupEventsInput) String added in v0.6.5 

func (s LookupEventsInput) 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 (*LookupEventsInput) Validate added in v1.1.21 

func (s *LookupEventsInput) Validate() error

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

type LookupEventsOutput 

type LookupEventsOutput struct {

	// A list of events returned based on the lookup attributes specified and the
	// CloudTrail event. The events list is sorted by time. The most recent event
	// is listed first.
	Events []*Event `type:"list"`

	// The token to use to get the next page of results after a previous API call.
	// If the token does not appear, there are no more results to return. The token
	// must be passed in with the same parameters as the previous call. For example,
	// if the original call specified an AttributeKey of 'Username' with a value
	// of 'root', the call with NextToken should include those same parameters.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Contains a response to a LookupEvents action.

func (LookupEventsOutput) GoString added in v0.6.5 

func (s LookupEventsOutput) 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 (*LookupEventsOutput) SetEvents added in v1.5.0 

func (s *LookupEventsOutput) SetEvents(v []*Event) *LookupEventsOutput

SetEvents sets the Events field's value.

func (*LookupEventsOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (LookupEventsOutput) String added in v0.6.5 

func (s LookupEventsOutput) 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 MaxConcurrentQueriesException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You are already running the maximum number of concurrent queries. Wait a minute for some queries to finish, and then run the query again.

func (*MaxConcurrentQueriesException) Code added in v1.42.28 

func (s *MaxConcurrentQueriesException) Code() string

Code returns the exception type name.

func (*MaxConcurrentQueriesException) Error added in v1.42.28 

func (s *MaxConcurrentQueriesException) Error() string

func (MaxConcurrentQueriesException) GoString added in v1.42.28 

func (s MaxConcurrentQueriesException) 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 (*MaxConcurrentQueriesException) Message added in v1.42.28 

func (s *MaxConcurrentQueriesException) Message() string

Message returns the exception's message.

func (*MaxConcurrentQueriesException) OrigErr added in v1.42.28 

func (s *MaxConcurrentQueriesException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MaxConcurrentQueriesException) RequestID added in v1.42.28 

func (s *MaxConcurrentQueriesException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MaxConcurrentQueriesException) StatusCode added in v1.42.28 

func (s *MaxConcurrentQueriesException) StatusCode() int

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

func (MaxConcurrentQueriesException) String added in v1.42.28 

func (s MaxConcurrentQueriesException) 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 MaximumNumberOfTrailsExceededException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*MaximumNumberOfTrailsExceededException) Code added in v1.28.0 

func (s *MaximumNumberOfTrailsExceededException) Code() string

Code returns the exception type name.

func (*MaximumNumberOfTrailsExceededException) Error added in v1.28.0 

func (s *MaximumNumberOfTrailsExceededException) Error() string

func (MaximumNumberOfTrailsExceededException) GoString added in v1.28.0 

func (s MaximumNumberOfTrailsExceededException) 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 (*MaximumNumberOfTrailsExceededException) Message added in v1.28.0 

func (s *MaximumNumberOfTrailsExceededException) Message() string

Message returns the exception's message.

func (*MaximumNumberOfTrailsExceededException) OrigErr added in v1.28.0 

func (s *MaximumNumberOfTrailsExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MaximumNumberOfTrailsExceededException) RequestID added in v1.28.0 

func (s *MaximumNumberOfTrailsExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MaximumNumberOfTrailsExceededException) StatusCode added in v1.28.0 

func (s *MaximumNumberOfTrailsExceededException) StatusCode() int

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

func (MaximumNumberOfTrailsExceededException) String added in v1.28.0 

func (s MaximumNumberOfTrailsExceededException) 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 NotOrganizationMasterAccountException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *NotOrganizationMasterAccountException) Code() string

Code returns the exception type name.

func (*NotOrganizationMasterAccountException) Error added in v1.28.0 

func (s *NotOrganizationMasterAccountException) Error() string

func (NotOrganizationMasterAccountException) GoString added in v1.28.0 

func (s NotOrganizationMasterAccountException) 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 (*NotOrganizationMasterAccountException) Message added in v1.28.0 

func (s *NotOrganizationMasterAccountException) Message() string

Message returns the exception's message.

func (*NotOrganizationMasterAccountException) OrigErr added in v1.28.0 

func (s *NotOrganizationMasterAccountException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotOrganizationMasterAccountException) RequestID added in v1.28.0 

func (s *NotOrganizationMasterAccountException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotOrganizationMasterAccountException) StatusCode added in v1.28.0 

func (s *NotOrganizationMasterAccountException) StatusCode() int

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

func (NotOrganizationMasterAccountException) String added in v1.28.0 

func (s NotOrganizationMasterAccountException) 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 OperationNotPermittedException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*OperationNotPermittedException) Code added in v1.28.0 

func (s *OperationNotPermittedException) Code() string

Code returns the exception type name.

func (*OperationNotPermittedException) Error added in v1.28.0 

func (s *OperationNotPermittedException) Error() string

func (OperationNotPermittedException) GoString added in v1.28.0 

func (s OperationNotPermittedException) 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 (*OperationNotPermittedException) Message added in v1.28.0 

func (s *OperationNotPermittedException) Message() string

Message returns the exception's message.

func (*OperationNotPermittedException) OrigErr added in v1.28.0 

func (s *OperationNotPermittedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationNotPermittedException) RequestID added in v1.28.0 

func (s *OperationNotPermittedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationNotPermittedException) StatusCode added in v1.28.0 

func (s *OperationNotPermittedException) StatusCode() int

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

func (OperationNotPermittedException) String added in v1.28.0 

func (s OperationNotPermittedException) 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 OrganizationNotInAllFeaturesModeException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *OrganizationNotInAllFeaturesModeException) Code() string

Code returns the exception type name.

func (*OrganizationNotInAllFeaturesModeException) Error added in v1.28.0 

func (s *OrganizationNotInAllFeaturesModeException) Error() string

func (OrganizationNotInAllFeaturesModeException) GoString added in v1.28.0 

func (s OrganizationNotInAllFeaturesModeException) 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 (*OrganizationNotInAllFeaturesModeException) Message added in v1.28.0 

func (s *OrganizationNotInAllFeaturesModeException) Message() string

Message returns the exception's message.

func (*OrganizationNotInAllFeaturesModeException) OrigErr added in v1.28.0 

func (s *OrganizationNotInAllFeaturesModeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OrganizationNotInAllFeaturesModeException) RequestID added in v1.28.0 

func (s *OrganizationNotInAllFeaturesModeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OrganizationNotInAllFeaturesModeException) StatusCode added in v1.28.0 

func (s *OrganizationNotInAllFeaturesModeException) StatusCode() int

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

func (OrganizationNotInAllFeaturesModeException) String added in v1.28.0 

func (s OrganizationNotInAllFeaturesModeException) 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 OrganizationsNotInUseException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"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) Code added in v1.28.0 

func (s *OrganizationsNotInUseException) Code() string

Code returns the exception type name.

func (*OrganizationsNotInUseException) Error added in v1.28.0 

func (s *OrganizationsNotInUseException) Error() string

func (OrganizationsNotInUseException) GoString added in v1.28.0 

func (s OrganizationsNotInUseException) 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 (*OrganizationsNotInUseException) Message added in v1.28.0 

func (s *OrganizationsNotInUseException) Message() string

Message returns the exception's message.

func (*OrganizationsNotInUseException) OrigErr added in v1.28.0 

func (s *OrganizationsNotInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OrganizationsNotInUseException) RequestID added in v1.28.0 

func (s *OrganizationsNotInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OrganizationsNotInUseException) StatusCode added in v1.28.0 

func (s *OrganizationsNotInUseException) StatusCode() int

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

func (OrganizationsNotInUseException) String added in v1.28.0 

func (s OrganizationsNotInUseException) 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 PublicKey added in v0.9.11 

type PublicKey struct {

	// The fingerprint of the public key.
	Fingerprint *string `type:"string"`

	// The ending time of validity of the public key.
	ValidityEndTime *time.Time `type:"timestamp"`

	// The starting time of validity of the public key.
	ValidityStartTime *time.Time `type:"timestamp"`

	// The DER encoded public key value in PKCS#1 format.
	// Value is automatically base64 encoded/decoded by the SDK.
	Value []byte `type:"blob"`
	// contains filtered or unexported fields
}

Contains information about a returned public key.

func (PublicKey) GoString added in v0.9.11 

func (s PublicKey) 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 (*PublicKey) SetFingerprint added in v1.5.0 

func (s *PublicKey) SetFingerprint(v string) *PublicKey

SetFingerprint sets the Fingerprint field's value.

func (*PublicKey) SetValidityEndTime added in v1.5.0 

func (s *PublicKey) SetValidityEndTime(v time.Time) *PublicKey

SetValidityEndTime sets the ValidityEndTime field's value.

func (*PublicKey) SetValidityStartTime added in v1.5.0 

func (s *PublicKey) SetValidityStartTime(v time.Time) *PublicKey

SetValidityStartTime sets the ValidityStartTime field's value.

func (*PublicKey) SetValue added in v1.5.0 

func (s *PublicKey) SetValue(v []byte) *PublicKey

SetValue sets the Value field's value.

func (PublicKey) String added in v0.9.11 

func (s PublicKey) 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 PutEventSelectorsInput added in v1.5.9 

type PutEventSelectorsInput struct {

	// Specifies the settings for advanced event selectors. You can add advanced
	// event selectors, and conditions for your advanced event selectors, up to
	// a maximum of 500 values for all conditions and selectors on a trail. You
	// can use either AdvancedEventSelectors or EventSelectors, but not both. If
	// you apply AdvancedEventSelectors to a trail, any existing EventSelectors
	// are overwritten. 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.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// Specifies the settings for your event selectors. You can configure up to
	// five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors
	// in a PutEventSelectors request, but not both. If you apply EventSelectors
	// to a trail, any existing AdvancedEventSelectors are overwritten.
	EventSelectors []*EventSelector `type:"list"`

	// Specifies the name of the trail or trail ARN. If you specify a trail name,
	// the string 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)
	//
	// If you specify a trail ARN, it must be in the following format.
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// TrailName is a required field
	TrailName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventSelectorsInput) GoString added in v1.5.9 

func (s PutEventSelectorsInput) 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 (*PutEventSelectorsInput) SetAdvancedEventSelectors added in v1.35.35 

func (s *PutEventSelectorsInput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *PutEventSelectorsInput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*PutEventSelectorsInput) SetEventSelectors added in v1.5.9 

func (s *PutEventSelectorsInput) SetEventSelectors(v []*EventSelector) *PutEventSelectorsInput

SetEventSelectors sets the EventSelectors field's value.

func (*PutEventSelectorsInput) SetTrailName added in v1.5.9 

func (s *PutEventSelectorsInput) SetTrailName(v string) *PutEventSelectorsInput

SetTrailName sets the TrailName field's value.

func (PutEventSelectorsInput) String added in v1.5.9 

func (s PutEventSelectorsInput) 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 (*PutEventSelectorsInput) Validate added in v1.8.2 

func (s *PutEventSelectorsInput) Validate() error

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

type PutEventSelectorsOutput added in v1.5.9 

type PutEventSelectorsOutput struct {

	// Specifies the advanced event selectors configured for your trail.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// Specifies the event selectors configured for your trail.
	EventSelectors []*EventSelector `type:"list"`

	// Specifies the ARN of the trail that was updated with event selectors. The
	// following is the format of a trail ARN.
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	TrailARN *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutEventSelectorsOutput) GoString added in v1.5.9 

func (s PutEventSelectorsOutput) 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 (*PutEventSelectorsOutput) SetAdvancedEventSelectors added in v1.35.35 

func (s *PutEventSelectorsOutput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *PutEventSelectorsOutput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*PutEventSelectorsOutput) SetEventSelectors added in v1.5.9 

func (s *PutEventSelectorsOutput) SetEventSelectors(v []*EventSelector) *PutEventSelectorsOutput

SetEventSelectors sets the EventSelectors field's value.

func (*PutEventSelectorsOutput) SetTrailARN added in v1.5.9 

func (s *PutEventSelectorsOutput) SetTrailARN(v string) *PutEventSelectorsOutput

SetTrailARN sets the TrailARN field's value.

func (PutEventSelectorsOutput) String added in v1.5.9 

func (s PutEventSelectorsOutput) 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 PutInsightSelectorsInput added in v1.25.39 

type PutInsightSelectorsInput struct {

	// A JSON string that contains the insight types you want to log on a trail.
	// ApiCallRateInsight and ApiErrorRateInsight are valid insight types.
	//
	// InsightSelectors is a required field
	InsightSelectors []*InsightSelector `type:"list" required:"true"`

	// The name of the CloudTrail trail for which you want to change or add Insights
	// selectors.
	//
	// TrailName is a required field
	TrailName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutInsightSelectorsInput) GoString added in v1.25.39 

func (s PutInsightSelectorsInput) 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 (*PutInsightSelectorsInput) SetInsightSelectors added in v1.25.39 

func (s *PutInsightSelectorsInput) SetInsightSelectors(v []*InsightSelector) *PutInsightSelectorsInput

SetInsightSelectors sets the InsightSelectors field's value.

func (*PutInsightSelectorsInput) SetTrailName added in v1.25.39 

func (s *PutInsightSelectorsInput) SetTrailName(v string) *PutInsightSelectorsInput

SetTrailName sets the TrailName field's value.

func (PutInsightSelectorsInput) String added in v1.25.39 

func (s PutInsightSelectorsInput) 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 (*PutInsightSelectorsInput) Validate added in v1.25.39 

func (s *PutInsightSelectorsInput) Validate() error

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

type PutInsightSelectorsOutput added in v1.25.39 

type PutInsightSelectorsOutput struct {

	// A JSON string that contains the Insights event types that you want to log
	// on a trail. The valid Insights types in this release are ApiErrorRateInsight
	// and ApiCallRateInsight.
	InsightSelectors []*InsightSelector `type:"list"`

	// The Amazon Resource Name (ARN) of a trail for which you want to change or
	// add Insights selectors.
	TrailARN *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutInsightSelectorsOutput) GoString added in v1.25.39 

func (s PutInsightSelectorsOutput) 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 (*PutInsightSelectorsOutput) SetInsightSelectors added in v1.25.39 

func (s *PutInsightSelectorsOutput) SetInsightSelectors(v []*InsightSelector) *PutInsightSelectorsOutput

SetInsightSelectors sets the InsightSelectors field's value.

func (*PutInsightSelectorsOutput) SetTrailARN added in v1.25.39 

func (s *PutInsightSelectorsOutput) SetTrailARN(v string) *PutInsightSelectorsOutput

SetTrailARN sets the TrailARN field's value.

func (PutInsightSelectorsOutput) String added in v1.25.39 

func (s PutInsightSelectorsOutput) 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 Query added in v1.42.28 

type Query struct {

	// The creation time of a query.
	CreationTime *time.Time `type:"timestamp"`

	// The ID of a query.
	QueryId *string `min:"36" type:"string"`

	// The status of the query. This can be QUEUED, RUNNING, FINISHED, FAILED, or
	// CANCELLED.
	QueryStatus *string `type:"string" enum:"QueryStatus"`
	// contains filtered or unexported fields
}

A SQL string of criteria about events that you want to collect in an event data store.

func (Query) GoString added in v1.42.28 

func (s Query) 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 (*Query) SetCreationTime added in v1.42.28 

func (s *Query) SetCreationTime(v time.Time) *Query

SetCreationTime sets the CreationTime field's value.

func (*Query) SetQueryId added in v1.42.28 

func (s *Query) SetQueryId(v string) *Query

SetQueryId sets the QueryId field's value.

func (*Query) SetQueryStatus added in v1.42.28 

func (s *Query) SetQueryStatus(v string) *Query

SetQueryStatus sets the QueryStatus field's value.

func (Query) String added in v1.42.28 

func (s Query) 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 QueryIdNotFoundException added in v1.42.28 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The query ID does not exist or does not map to a query.

func (*QueryIdNotFoundException) Code added in v1.42.28 

func (s *QueryIdNotFoundException) Code() string

Code returns the exception type name.

func (*QueryIdNotFoundException) Error added in v1.42.28 

func (s *QueryIdNotFoundException) Error() string

func (QueryIdNotFoundException) GoString added in v1.42.28 

func (s QueryIdNotFoundException) 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 (*QueryIdNotFoundException) Message added in v1.42.28 

func (s *QueryIdNotFoundException) Message() string

Message returns the exception's message.

func (*QueryIdNotFoundException) OrigErr added in v1.42.28 

func (s *QueryIdNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*QueryIdNotFoundException) RequestID added in v1.42.28 

func (s *QueryIdNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*QueryIdNotFoundException) StatusCode added in v1.42.28 

func (s *QueryIdNotFoundException) StatusCode() int

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

func (QueryIdNotFoundException) String added in v1.42.28 

func (s QueryIdNotFoundException) 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 QueryStatistics added in v1.42.28 

type QueryStatistics struct {

	// The number of results returned.
	ResultsCount *int64 `type:"integer"`

	// The total number of results returned by a query.
	TotalResultsCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Metadata about a query, such as the number of results.

func (QueryStatistics) GoString added in v1.42.28 

func (s QueryStatistics) 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 (*QueryStatistics) SetResultsCount added in v1.42.28 

func (s *QueryStatistics) SetResultsCount(v int64) *QueryStatistics

SetResultsCount sets the ResultsCount field's value.

func (*QueryStatistics) SetTotalResultsCount added in v1.42.28 

func (s *QueryStatistics) SetTotalResultsCount(v int64) *QueryStatistics

SetTotalResultsCount sets the TotalResultsCount field's value.

func (QueryStatistics) String added in v1.42.28 

func (s QueryStatistics) 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 QueryStatisticsForDescribeQuery added in v1.42.28 

type QueryStatisticsForDescribeQuery struct {

	// The creation time of the query.
	CreationTime *time.Time `type:"timestamp"`

	// The number of events that matched a query.
	EventsMatched *int64 `type:"long"`

	// The number of events that the query scanned in the event data store.
	EventsScanned *int64 `type:"long"`

	// The query's run time, in milliseconds.
	ExecutionTimeInMillis *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Gets metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

func (QueryStatisticsForDescribeQuery) GoString added in v1.42.28 

func (s QueryStatisticsForDescribeQuery) 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 (*QueryStatisticsForDescribeQuery) SetCreationTime added in v1.42.28 

func (s *QueryStatisticsForDescribeQuery) SetCreationTime(v time.Time) *QueryStatisticsForDescribeQuery

SetCreationTime sets the CreationTime field's value.

func (*QueryStatisticsForDescribeQuery) SetEventsMatched added in v1.42.28 

func (s *QueryStatisticsForDescribeQuery) SetEventsMatched(v int64) *QueryStatisticsForDescribeQuery

SetEventsMatched sets the EventsMatched field's value.

func (*QueryStatisticsForDescribeQuery) SetEventsScanned added in v1.42.28 

func (s *QueryStatisticsForDescribeQuery) SetEventsScanned(v int64) *QueryStatisticsForDescribeQuery

SetEventsScanned sets the EventsScanned field's value.

func (*QueryStatisticsForDescribeQuery) SetExecutionTimeInMillis added in v1.42.28 

func (s *QueryStatisticsForDescribeQuery) SetExecutionTimeInMillis(v int64) *QueryStatisticsForDescribeQuery

SetExecutionTimeInMillis sets the ExecutionTimeInMillis field's value.

func (QueryStatisticsForDescribeQuery) String added in v1.42.28 

func (s QueryStatisticsForDescribeQuery) 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 RemoveTagsInput added in v0.9.11 

type RemoveTagsInput struct {

	// Specifies the ARN of the trail from which tags should be removed. The format
	// of a trail ARN is:
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// Specifies a list of tags to be removed.
	//
	// TagsList is a required field
	TagsList []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Specifies the tags to remove from a trail.

func (RemoveTagsInput) GoString added in v0.9.11 

func (s RemoveTagsInput) 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 (*RemoveTagsInput) SetResourceId added in v1.5.0 

func (s *RemoveTagsInput) SetResourceId(v string) *RemoveTagsInput

SetResourceId sets the ResourceId field's value.

func (*RemoveTagsInput) SetTagsList added in v1.5.0 

func (s *RemoveTagsInput) SetTagsList(v []*Tag) *RemoveTagsInput

SetTagsList sets the TagsList field's value.

func (RemoveTagsInput) String added in v0.9.11 

func (s RemoveTagsInput) 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 (*RemoveTagsInput) Validate added in v1.1.21 

func (s *RemoveTagsInput) Validate() error

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

type RemoveTagsOutput added in v0.9.11 

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (RemoveTagsOutput) GoString added in v0.9.11 

func (s RemoveTagsOutput) 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 (RemoveTagsOutput) String added in v0.9.11 

func (s RemoveTagsOutput) 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 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 `type:"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 `type:"string"`
	// contains filtered or unexported fields
}

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

func (Resource) GoString added in v0.6.5 

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) SetResourceName added in v1.5.0 

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

SetResourceName sets the ResourceName field's value.

func (*Resource) SetResourceType added in v1.5.0 

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

SetResourceType sets the ResourceType field's value.

func (Resource) String added in v0.6.5 

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 ResourceNotFoundException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.28.0 

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 ResourceTag added in v0.9.11 

type ResourceTag struct {

	// Specifies the ARN of the resource.
	ResourceId *string `type:"string"`

	// A list of tags.
	TagsList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

A resource tag.

func (ResourceTag) GoString added in v0.9.11 

func (s ResourceTag) 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 (*ResourceTag) SetResourceId added in v1.5.0 

func (s *ResourceTag) SetResourceId(v string) *ResourceTag

SetResourceId sets the ResourceId field's value.

func (*ResourceTag) SetTagsList added in v1.5.0 

func (s *ResourceTag) SetTagsList(v []*Tag) *ResourceTag

SetTagsList sets the TagsList field's value.

func (ResourceTag) String added in v0.9.11 

func (s ResourceTag) 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 ResourceTypeNotSupportedException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceTypeNotSupportedException) Code added in v1.28.0 

func (s *ResourceTypeNotSupportedException) Code() string

Code returns the exception type name.

func (*ResourceTypeNotSupportedException) Error added in v1.28.0 

func (s *ResourceTypeNotSupportedException) Error() string

func (ResourceTypeNotSupportedException) GoString added in v1.28.0 

func (s ResourceTypeNotSupportedException) 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 (*ResourceTypeNotSupportedException) Message added in v1.28.0 

func (s *ResourceTypeNotSupportedException) Message() string

Message returns the exception's message.

func (*ResourceTypeNotSupportedException) OrigErr added in v1.28.0 

func (s *ResourceTypeNotSupportedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceTypeNotSupportedException) RequestID added in v1.28.0 

func (s *ResourceTypeNotSupportedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceTypeNotSupportedException) StatusCode added in v1.28.0 

func (s *ResourceTypeNotSupportedException) StatusCode() int

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

func (ResourceTypeNotSupportedException) String added in v1.28.0 

func (s ResourceTypeNotSupportedException) 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 RestoreEventDataStoreInput added in v1.42.28 

type RestoreEventDataStoreInput struct {

	// The ARN (or the ID suffix of the ARN) of the event data store that you want
	// to restore.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreEventDataStoreInput) GoString added in v1.42.28 

func (s RestoreEventDataStoreInput) 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 (*RestoreEventDataStoreInput) SetEventDataStore added in v1.42.28 

func (s *RestoreEventDataStoreInput) SetEventDataStore(v string) *RestoreEventDataStoreInput

SetEventDataStore sets the EventDataStore field's value.

func (RestoreEventDataStoreInput) String added in v1.42.28 

func (s RestoreEventDataStoreInput) 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 (*RestoreEventDataStoreInput) Validate added in v1.42.28 

func (s *RestoreEventDataStoreInput) Validate() error

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

type RestoreEventDataStoreOutput added in v1.42.28 

type RestoreEventDataStoreOutput struct {

	// The advanced event selectors that were used to select events.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// The timestamp of an event data store's creation.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The event data store ARN.
	EventDataStoreArn *string `min:"3" type:"string"`

	// Indicates whether the event data store is collecting events from all regions,
	// or only from the region in which the event data store was created.
	MultiRegionEnabled *bool `type:"boolean"`

	// The name of the event data store.
	Name *string `min:"3" type:"string"`

	// Indicates whether an event data store is collecting logged events for an
	// organization in Organizations.
	OrganizationEnabled *bool `type:"boolean"`

	// The retention period, in days.
	RetentionPeriod *int64 `min:"7" type:"integer"`

	// The status of the event data store.
	Status *string `type:"string" enum:"EventDataStoreStatus"`

	// Indicates that termination protection is enabled and the event data store
	// cannot be automatically deleted.
	TerminationProtectionEnabled *bool `type:"boolean"`

	// The timestamp that shows when an event data store was updated, if applicable.
	// UpdatedTimestamp is always either the same or newer than the time shown in
	// CreatedTimestamp.
	UpdatedTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (RestoreEventDataStoreOutput) GoString added in v1.42.28 

func (s RestoreEventDataStoreOutput) 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 (*RestoreEventDataStoreOutput) SetAdvancedEventSelectors added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *RestoreEventDataStoreOutput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*RestoreEventDataStoreOutput) SetCreatedTimestamp added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetCreatedTimestamp(v time.Time) *RestoreEventDataStoreOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*RestoreEventDataStoreOutput) SetEventDataStoreArn added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetEventDataStoreArn(v string) *RestoreEventDataStoreOutput

SetEventDataStoreArn sets the EventDataStoreArn field's value.

func (*RestoreEventDataStoreOutput) SetMultiRegionEnabled added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetMultiRegionEnabled(v bool) *RestoreEventDataStoreOutput

SetMultiRegionEnabled sets the MultiRegionEnabled field's value.

func (*RestoreEventDataStoreOutput) SetName added in v1.42.28 

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

SetName sets the Name field's value.

func (*RestoreEventDataStoreOutput) SetOrganizationEnabled added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetOrganizationEnabled(v bool) *RestoreEventDataStoreOutput

SetOrganizationEnabled sets the OrganizationEnabled field's value.

func (*RestoreEventDataStoreOutput) SetRetentionPeriod added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetRetentionPeriod(v int64) *RestoreEventDataStoreOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*RestoreEventDataStoreOutput) SetStatus added in v1.42.28 

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

SetStatus sets the Status field's value.

func (*RestoreEventDataStoreOutput) SetTerminationProtectionEnabled added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetTerminationProtectionEnabled(v bool) *RestoreEventDataStoreOutput

SetTerminationProtectionEnabled sets the TerminationProtectionEnabled field's value.

func (*RestoreEventDataStoreOutput) SetUpdatedTimestamp added in v1.42.28 

func (s *RestoreEventDataStoreOutput) SetUpdatedTimestamp(v time.Time) *RestoreEventDataStoreOutput

SetUpdatedTimestamp sets the UpdatedTimestamp field's value.

func (RestoreEventDataStoreOutput) String added in v1.42.28 

func (s RestoreEventDataStoreOutput) 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 S3BucketDoesNotExistException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*S3BucketDoesNotExistException) Code added in v1.28.0 

func (s *S3BucketDoesNotExistException) Code() string

Code returns the exception type name.

func (*S3BucketDoesNotExistException) Error added in v1.28.0 

func (s *S3BucketDoesNotExistException) Error() string

func (S3BucketDoesNotExistException) GoString added in v1.28.0 

func (s S3BucketDoesNotExistException) 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 (*S3BucketDoesNotExistException) Message added in v1.28.0 

func (s *S3BucketDoesNotExistException) Message() string

Message returns the exception's message.

func (*S3BucketDoesNotExistException) OrigErr added in v1.28.0 

func (s *S3BucketDoesNotExistException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*S3BucketDoesNotExistException) RequestID added in v1.28.0 

func (s *S3BucketDoesNotExistException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*S3BucketDoesNotExistException) StatusCode added in v1.28.0 

func (s *S3BucketDoesNotExistException) StatusCode() int

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

func (S3BucketDoesNotExistException) String added in v1.28.0 

func (s S3BucketDoesNotExistException) 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 StartLoggingInput 

type StartLoggingInput struct {

	// Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
	// logs Amazon Web Services API calls. The following is the format of a trail
	// ARN.
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request to CloudTrail to start logging Amazon Web Services API calls for an account.

func (StartLoggingInput) GoString added in v0.6.5 

func (s StartLoggingInput) 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 (*StartLoggingInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (StartLoggingInput) String added in v0.6.5 

func (s StartLoggingInput) 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 (*StartLoggingInput) Validate added in v1.1.21 

func (s *StartLoggingInput) Validate() error

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

type StartLoggingOutput 

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (StartLoggingOutput) GoString added in v0.6.5 

func (s StartLoggingOutput) 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 (StartLoggingOutput) String added in v0.6.5 

func (s StartLoggingOutput) 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 StartQueryInput added in v1.42.28 

type StartQueryInput struct {

	// The SQL code of your query.
	//
	// QueryStatement is a required field
	QueryStatement *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartQueryInput) GoString added in v1.42.28 

func (s StartQueryInput) 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 (*StartQueryInput) SetQueryStatement added in v1.42.28 

func (s *StartQueryInput) SetQueryStatement(v string) *StartQueryInput

SetQueryStatement sets the QueryStatement field's value.

func (StartQueryInput) String added in v1.42.28 

func (s StartQueryInput) 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 (*StartQueryInput) Validate added in v1.42.28 

func (s *StartQueryInput) Validate() error

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

type StartQueryOutput added in v1.42.28 

type StartQueryOutput struct {

	// The ID of the started query.
	QueryId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (StartQueryOutput) GoString added in v1.42.28 

func (s StartQueryOutput) 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 (*StartQueryOutput) SetQueryId added in v1.42.28 

func (s *StartQueryOutput) SetQueryId(v string) *StartQueryOutput

SetQueryId sets the QueryId field's value.

func (StartQueryOutput) String added in v1.42.28 

func (s StartQueryOutput) 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 StopLoggingInput 

type StopLoggingInput struct {

	// Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
	// will stop logging Amazon Web Services API calls. The following is the format
	// of a trail ARN.
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.

func (StopLoggingInput) GoString added in v0.6.5 

func (s StopLoggingInput) 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 (*StopLoggingInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (StopLoggingInput) String added in v0.6.5 

func (s StopLoggingInput) 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 (*StopLoggingInput) Validate added in v1.1.21 

func (s *StopLoggingInput) Validate() error

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

type StopLoggingOutput 

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (StopLoggingOutput) GoString added in v0.6.5 

func (s StopLoggingOutput) 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 (StopLoggingOutput) String added in v0.6.5 

func (s StopLoggingOutput) 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 Tag added in v0.9.11 

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.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

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

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

func (Tag) GoString added in v0.9.11 

func (s Tag) 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 (*Tag) SetKey added in v1.5.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v0.9.11 

func (s Tag) 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 (*Tag) Validate added in v1.1.21 

func (s *Tag) Validate() error

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

type TagsLimitExceededException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*TagsLimitExceededException) Code added in v1.28.0 

func (s *TagsLimitExceededException) Code() string

Code returns the exception type name.

func (*TagsLimitExceededException) Error added in v1.28.0 

func (s *TagsLimitExceededException) Error() string

func (TagsLimitExceededException) GoString added in v1.28.0 

func (s TagsLimitExceededException) 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 (*TagsLimitExceededException) Message added in v1.28.0 

func (s *TagsLimitExceededException) Message() string

Message returns the exception's message.

func (*TagsLimitExceededException) OrigErr added in v1.28.0 

func (s *TagsLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TagsLimitExceededException) RequestID added in v1.28.0 

func (s *TagsLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TagsLimitExceededException) StatusCode added in v1.28.0 

func (s *TagsLimitExceededException) StatusCode() int

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

func (TagsLimitExceededException) String added in v1.28.0 

func (s TagsLimitExceededException) 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 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 `type:"string"`

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

	// Specifies if the trail has custom event selectors.
	HasCustomEventSelectors *bool `type:"boolean"`

	// Specifies whether a trail has insight types specified in an InsightSelector
	// list.
	HasInsightSelectors *bool `type:"boolean"`

	// The region in which the trail was created.
	HomeRegion *string `type:"string"`

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

	// Specifies whether the trail exists only in one region or exists in all regions.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Specifies whether the trail is an organization trail.
	IsOrganizationTrail *bool `type:"boolean"`

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

	// Specifies whether log file validation is enabled.
	LogFileValidationEnabled *bool `type:"boolean"`

	// Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
	Name *string `type:"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 `type:"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 `type:"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 `type:"string"`

	// This field is no longer in use. Use SnsTopicARN.
	//
	// Deprecated: SnsTopicName has been deprecated
	SnsTopicName *string `deprecated:"true" type:"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 `type:"string"`
	// contains filtered or unexported fields
}

The settings for a trail.

func (Trail) GoString added in v0.6.5 

func (s Trail) 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 (*Trail) SetCloudWatchLogsLogGroupArn added in v1.5.0 

func (s *Trail) SetCloudWatchLogsLogGroupArn(v string) *Trail

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*Trail) SetCloudWatchLogsRoleArn added in v1.5.0 

func (s *Trail) SetCloudWatchLogsRoleArn(v string) *Trail

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*Trail) SetHasCustomEventSelectors added in v1.5.9 

func (s *Trail) SetHasCustomEventSelectors(v bool) *Trail

SetHasCustomEventSelectors sets the HasCustomEventSelectors field's value.

func (*Trail) SetHasInsightSelectors added in v1.25.39 

func (s *Trail) SetHasInsightSelectors(v bool) *Trail

SetHasInsightSelectors sets the HasInsightSelectors field's value.

func (*Trail) SetHomeRegion added in v1.5.0 

func (s *Trail) SetHomeRegion(v string) *Trail

SetHomeRegion sets the HomeRegion field's value.

func (*Trail) SetIncludeGlobalServiceEvents added in v1.5.0 

func (s *Trail) SetIncludeGlobalServiceEvents(v bool) *Trail

SetIncludeGlobalServiceEvents sets the IncludeGlobalServiceEvents field's value.

func (*Trail) SetIsMultiRegionTrail added in v1.5.0 

func (s *Trail) SetIsMultiRegionTrail(v bool) *Trail

SetIsMultiRegionTrail sets the IsMultiRegionTrail field's value.

func (*Trail) SetIsOrganizationTrail added in v1.15.79 

func (s *Trail) SetIsOrganizationTrail(v bool) *Trail

SetIsOrganizationTrail sets the IsOrganizationTrail field's value.

func (*Trail) SetKmsKeyId added in v1.5.0 

func (s *Trail) SetKmsKeyId(v string) *Trail

SetKmsKeyId sets the KmsKeyId field's value.

func (*Trail) SetLogFileValidationEnabled added in v1.5.0 

func (s *Trail) SetLogFileValidationEnabled(v bool) *Trail

SetLogFileValidationEnabled sets the LogFileValidationEnabled field's value.

func (*Trail) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*Trail) SetS3BucketName added in v1.5.0 

func (s *Trail) SetS3BucketName(v string) *Trail

SetS3BucketName sets the S3BucketName field's value.

func (*Trail) SetS3KeyPrefix added in v1.5.0 

func (s *Trail) SetS3KeyPrefix(v string) *Trail

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*Trail) SetSnsTopicARN added in v1.5.0 

func (s *Trail) SetSnsTopicARN(v string) *Trail

SetSnsTopicARN sets the SnsTopicARN field's value.

func (*Trail) SetSnsTopicName added in v1.5.0 

func (s *Trail) SetSnsTopicName(v string) *Trail

SetSnsTopicName sets the SnsTopicName field's value.

func (*Trail) SetTrailARN added in v1.5.0 

func (s *Trail) SetTrailARN(v string) *Trail

SetTrailARN sets the TrailARN field's value.

func (Trail) String added in v0.6.5 

func (s Trail) 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 TrailAlreadyExistsException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when the specified trail already exists.

func (*TrailAlreadyExistsException) Code added in v1.28.0 

func (s *TrailAlreadyExistsException) Code() string

Code returns the exception type name.

func (*TrailAlreadyExistsException) Error added in v1.28.0 

func (s *TrailAlreadyExistsException) Error() string

func (TrailAlreadyExistsException) GoString added in v1.28.0 

func (s TrailAlreadyExistsException) 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 (*TrailAlreadyExistsException) Message added in v1.28.0 

func (s *TrailAlreadyExistsException) Message() string

Message returns the exception's message.

func (*TrailAlreadyExistsException) OrigErr added in v1.28.0 

func (s *TrailAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TrailAlreadyExistsException) RequestID added in v1.28.0 

func (s *TrailAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TrailAlreadyExistsException) StatusCode added in v1.28.0 

func (s *TrailAlreadyExistsException) StatusCode() int

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

func (TrailAlreadyExistsException) String added in v1.28.0 

func (s TrailAlreadyExistsException) 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 TrailInfo added in v1.25.25 

type TrailInfo struct {

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

	// The name of a trail.
	Name *string `type:"string"`

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

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

func (TrailInfo) GoString added in v1.25.25 

func (s TrailInfo) 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 (*TrailInfo) SetHomeRegion added in v1.25.25 

func (s *TrailInfo) SetHomeRegion(v string) *TrailInfo

SetHomeRegion sets the HomeRegion field's value.

func (*TrailInfo) SetName added in v1.25.25 

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

SetName sets the Name field's value.

func (*TrailInfo) SetTrailARN added in v1.25.25 

func (s *TrailInfo) SetTrailARN(v string) *TrailInfo

SetTrailARN sets the TrailARN field's value.

func (TrailInfo) String added in v1.25.25 

func (s TrailInfo) 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 TrailNotFoundException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*TrailNotFoundException) Code added in v1.28.0 

func (s *TrailNotFoundException) Code() string

Code returns the exception type name.

func (*TrailNotFoundException) Error added in v1.28.0 

func (s *TrailNotFoundException) Error() string

func (TrailNotFoundException) GoString added in v1.28.0 

func (s TrailNotFoundException) 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 (*TrailNotFoundException) Message added in v1.28.0 

func (s *TrailNotFoundException) Message() string

Message returns the exception's message.

func (*TrailNotFoundException) OrigErr added in v1.28.0 

func (s *TrailNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TrailNotFoundException) RequestID added in v1.28.0 

func (s *TrailNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TrailNotFoundException) StatusCode added in v1.28.0 

func (s *TrailNotFoundException) StatusCode() int

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

func (TrailNotFoundException) String added in v1.28.0 

func (s TrailNotFoundException) 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 TrailNotProvidedException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This exception is no longer in use.

func (*TrailNotProvidedException) Code added in v1.28.0 

func (s *TrailNotProvidedException) Code() string

Code returns the exception type name.

func (*TrailNotProvidedException) Error added in v1.28.0 

func (s *TrailNotProvidedException) Error() string

func (TrailNotProvidedException) GoString added in v1.28.0 

func (s TrailNotProvidedException) 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 (*TrailNotProvidedException) Message added in v1.28.0 

func (s *TrailNotProvidedException) Message() string

Message returns the exception's message.

func (*TrailNotProvidedException) OrigErr added in v1.28.0 

func (s *TrailNotProvidedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TrailNotProvidedException) RequestID added in v1.28.0 

func (s *TrailNotProvidedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TrailNotProvidedException) StatusCode added in v1.28.0 

func (s *TrailNotProvidedException) StatusCode() int

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

func (TrailNotProvidedException) String added in v1.28.0 

func (s TrailNotProvidedException) 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 UnsupportedOperationException added in v1.28.0 

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

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*UnsupportedOperationException) Code added in v1.28.0 

func (s *UnsupportedOperationException) Code() string

Code returns the exception type name.

func (*UnsupportedOperationException) Error added in v1.28.0 

func (s *UnsupportedOperationException) Error() string

func (UnsupportedOperationException) GoString added in v1.28.0 

func (s UnsupportedOperationException) 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 (*UnsupportedOperationException) Message added in v1.28.0 

func (s *UnsupportedOperationException) Message() string

Message returns the exception's message.

func (*UnsupportedOperationException) OrigErr added in v1.28.0 

func (s *UnsupportedOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedOperationException) RequestID added in v1.28.0 

func (s *UnsupportedOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedOperationException) StatusCode added in v1.28.0 

func (s *UnsupportedOperationException) StatusCode() int

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

func (UnsupportedOperationException) String added in v1.28.0 

func (s UnsupportedOperationException) 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 UpdateEventDataStoreInput added in v1.42.28 

type UpdateEventDataStoreInput struct {

	// The advanced event selectors used to select events for the event data store.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// The ARN (or the ID suffix of the ARN) of the event data store that you want
	// to update.
	//
	// EventDataStore is a required field
	EventDataStore *string `min:"3" type:"string" required:"true"`

	// Specifies whether an event data store collects events from all regions, or
	// only from the region in which it was created.
	MultiRegionEnabled *bool `type:"boolean"`

	// The event data store name.
	Name *string `min:"3" type:"string"`

	// Specifies whether an event data store collects events logged for an organization
	// in Organizations.
	OrganizationEnabled *bool `type:"boolean"`

	// The retention period, in days.
	RetentionPeriod *int64 `min:"7" type:"integer"`

	// Indicates that termination protection is enabled and the event data store
	// cannot be automatically deleted.
	TerminationProtectionEnabled *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (UpdateEventDataStoreInput) GoString added in v1.42.28 

func (s UpdateEventDataStoreInput) 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 (*UpdateEventDataStoreInput) SetAdvancedEventSelectors added in v1.42.28 

func (s *UpdateEventDataStoreInput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *UpdateEventDataStoreInput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*UpdateEventDataStoreInput) SetEventDataStore added in v1.42.28 

func (s *UpdateEventDataStoreInput) SetEventDataStore(v string) *UpdateEventDataStoreInput

SetEventDataStore sets the EventDataStore field's value.

func (*UpdateEventDataStoreInput) SetMultiRegionEnabled added in v1.42.28 

func (s *UpdateEventDataStoreInput) SetMultiRegionEnabled(v bool) *UpdateEventDataStoreInput

SetMultiRegionEnabled sets the MultiRegionEnabled field's value.

func (*UpdateEventDataStoreInput) SetName added in v1.42.28 

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

SetName sets the Name field's value.

func (*UpdateEventDataStoreInput) SetOrganizationEnabled added in v1.42.28 

func (s *UpdateEventDataStoreInput) SetOrganizationEnabled(v bool) *UpdateEventDataStoreInput

SetOrganizationEnabled sets the OrganizationEnabled field's value.

func (*UpdateEventDataStoreInput) SetRetentionPeriod added in v1.42.28 

func (s *UpdateEventDataStoreInput) SetRetentionPeriod(v int64) *UpdateEventDataStoreInput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*UpdateEventDataStoreInput) SetTerminationProtectionEnabled added in v1.42.28 

func (s *UpdateEventDataStoreInput) SetTerminationProtectionEnabled(v bool) *UpdateEventDataStoreInput

SetTerminationProtectionEnabled sets the TerminationProtectionEnabled field's value.

func (UpdateEventDataStoreInput) String added in v1.42.28 

func (s UpdateEventDataStoreInput) 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 (*UpdateEventDataStoreInput) Validate added in v1.42.28 

func (s *UpdateEventDataStoreInput) Validate() error

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

type UpdateEventDataStoreOutput added in v1.42.28 

type UpdateEventDataStoreOutput struct {

	// The advanced event selectors that are applied to the event data store.
	AdvancedEventSelectors []*AdvancedEventSelector `type:"list"`

	// The timestamp that shows when an event data store was first created.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The ARN of the event data store.
	EventDataStoreArn *string `min:"3" type:"string"`

	// Indicates whether the event data store includes events from all regions,
	// or only from the region in which it was created.
	MultiRegionEnabled *bool `type:"boolean"`

	// The name of the event data store.
	Name *string `min:"3" type:"string"`

	// Indicates whether an event data store is collecting logged events for an
	// organization in Organizations.
	OrganizationEnabled *bool `type:"boolean"`

	// The retention period, in days.
	RetentionPeriod *int64 `min:"7" type:"integer"`

	// The status of an event data store. Values can be ENABLED and PENDING_DELETION.
	Status *string `type:"string" enum:"EventDataStoreStatus"`

	// Indicates whether termination protection is enabled for the event data store.
	TerminationProtectionEnabled *bool `type:"boolean"`

	// The timestamp that shows when the event data store was last updated. UpdatedTimestamp
	// is always either the same or newer than the time shown in CreatedTimestamp.
	UpdatedTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (UpdateEventDataStoreOutput) GoString added in v1.42.28 

func (s UpdateEventDataStoreOutput) 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 (*UpdateEventDataStoreOutput) SetAdvancedEventSelectors added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetAdvancedEventSelectors(v []*AdvancedEventSelector) *UpdateEventDataStoreOutput

SetAdvancedEventSelectors sets the AdvancedEventSelectors field's value.

func (*UpdateEventDataStoreOutput) SetCreatedTimestamp added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetCreatedTimestamp(v time.Time) *UpdateEventDataStoreOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*UpdateEventDataStoreOutput) SetEventDataStoreArn added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetEventDataStoreArn(v string) *UpdateEventDataStoreOutput

SetEventDataStoreArn sets the EventDataStoreArn field's value.

func (*UpdateEventDataStoreOutput) SetMultiRegionEnabled added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetMultiRegionEnabled(v bool) *UpdateEventDataStoreOutput

SetMultiRegionEnabled sets the MultiRegionEnabled field's value.

func (*UpdateEventDataStoreOutput) SetName added in v1.42.28 

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

SetName sets the Name field's value.

func (*UpdateEventDataStoreOutput) SetOrganizationEnabled added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetOrganizationEnabled(v bool) *UpdateEventDataStoreOutput

SetOrganizationEnabled sets the OrganizationEnabled field's value.

func (*UpdateEventDataStoreOutput) SetRetentionPeriod added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetRetentionPeriod(v int64) *UpdateEventDataStoreOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*UpdateEventDataStoreOutput) SetStatus added in v1.42.28 

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

SetStatus sets the Status field's value.

func (*UpdateEventDataStoreOutput) SetTerminationProtectionEnabled added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetTerminationProtectionEnabled(v bool) *UpdateEventDataStoreOutput

SetTerminationProtectionEnabled sets the TerminationProtectionEnabled field's value.

func (*UpdateEventDataStoreOutput) SetUpdatedTimestamp added in v1.42.28 

func (s *UpdateEventDataStoreOutput) SetUpdatedTimestamp(v time.Time) *UpdateEventDataStoreOutput

SetUpdatedTimestamp sets the UpdatedTimestamp field's value.

func (UpdateEventDataStoreOutput) String added in v1.42.28 

func (s UpdateEventDataStoreOutput) 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 UpdateTrailInput 

type UpdateTrailInput struct {

	// Specifies a log group name using an Amazon Resource Name (ARN), a unique
	// identifier that represents the log group to which CloudTrail logs are delivered.
	// Not required unless you specify CloudWatchLogsRoleArn.
	CloudWatchLogsLogGroupArn *string `type:"string"`

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

	// Specifies whether log file validation is enabled. The default is false.
	//
	// When you disable log file integrity validation, the chain of digest files
	// is broken after one hour. CloudTrail does not create digest files for log
	// files that were delivered during a period in which log file integrity validation
	// was disabled. For example, if you enable log file integrity validation at
	// noon on January 1, disable it at noon on January 2, and re-enable it at noon
	// on January 10, digest files will not be created for the log files delivered
	// from noon on January 2 to noon on January 10. The same applies whenever you
	// stop CloudTrail logging or delete a trail.
	EnableLogFileValidation *bool `type:"boolean"`

	// Specifies whether the trail is publishing events from global services such
	// as IAM to the log files.
	IncludeGlobalServiceEvents *bool `type:"boolean"`

	// Specifies whether the trail applies only to the current region or to all
	// regions. The default is false. If the trail exists only in the current region
	// and this value is set to true, shadow trails (replications of the trail)
	// will be created in the other regions. If the trail exists in all regions
	// and this value is set to false, the trail will remain in the region where
	// it was created, and its shadow trails in other regions will be deleted. As
	// a best practice, consider using trails that log events in all regions.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Specifies whether the trail is applied to all accounts in an organization
	// in Organizations, or only for the current Amazon Web Services account. The
	// default is false, and cannot be true unless the call is made on behalf of
	// an Amazon Web Services account that is the management account for an organization
	// in Organizations. If the trail is not an organization trail and this is set
	// to true, the trail will be created in all Amazon Web Services accounts that
	// belong to the organization. If the trail is an organization trail and this
	// is set to false, the trail will remain in the current Amazon Web Services
	// account but be deleted from all member accounts in the organization.
	IsOrganizationTrail *bool `type:"boolean"`

	// Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.
	// The value can be an alias name prefixed by "alias/", a fully specified ARN
	// to an alias, a fully specified ARN to a key, or a globally unique identifier.
	//
	// CloudTrail also supports KMS multi-Region keys. For more information about
	// multi-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)
	// in the Key Management Service Developer Guide.
	//
	// Examples:
	//
	//    * alias/MyAliasName
	//
	//    * arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
	//
	//    * arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
	//
	//    * 12345678-1234-1234-1234-123456789012
	KmsKeyId *string `type:"string"`

	// Specifies the name of the trail or trail ARN. If Name is a trail name, the
	// string 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)
	//
	// If Name is a trail ARN, it must be in the following format.
	//
	// arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// Specifies the name of the Amazon S3 bucket designated for publishing log
	// files. See Amazon S3 Bucket Naming Requirements (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html).
	S3BucketName *string `type:"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 `type:"string"`

	// Specifies the name of the Amazon SNS topic defined for notification of log
	// file delivery. The maximum length is 256 characters.
	SnsTopicName *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies settings to update for the trail.

func (UpdateTrailInput) GoString added in v0.6.5 

func (s UpdateTrailInput) 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 (*UpdateTrailInput) SetCloudWatchLogsLogGroupArn added in v1.5.0 

func (s *UpdateTrailInput) SetCloudWatchLogsLogGroupArn(v string) *UpdateTrailInput

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*UpdateTrailInput) SetCloudWatchLogsRoleArn added in v1.5.0 

func (s *UpdateTrailInput) SetCloudWatchLogsRoleArn(v string) *UpdateTrailInput

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*UpdateTrailInput) SetEnableLogFileValidation added in v1.5.0 

func (s *UpdateTrailInput) SetEnableLogFileValidation(v bool) *UpdateTrailInput

SetEnableLogFileValidation sets the EnableLogFileValidation field's value.

func (*UpdateTrailInput) SetIncludeGlobalServiceEvents added in v1.5.0 

func (s *UpdateTrailInput) SetIncludeGlobalServiceEvents(v bool) *UpdateTrailInput

SetIncludeGlobalServiceEvents sets the IncludeGlobalServiceEvents field's value.

func (*UpdateTrailInput) SetIsMultiRegionTrail added in v1.5.0 

func (s *UpdateTrailInput) SetIsMultiRegionTrail(v bool) *UpdateTrailInput

SetIsMultiRegionTrail sets the IsMultiRegionTrail field's value.

func (*UpdateTrailInput) SetIsOrganizationTrail added in v1.15.79 

func (s *UpdateTrailInput) SetIsOrganizationTrail(v bool) *UpdateTrailInput

SetIsOrganizationTrail sets the IsOrganizationTrail field's value.

func (*UpdateTrailInput) SetKmsKeyId added in v1.5.0 

func (s *UpdateTrailInput) SetKmsKeyId(v string) *UpdateTrailInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*UpdateTrailInput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*UpdateTrailInput) SetS3BucketName added in v1.5.0 

func (s *UpdateTrailInput) SetS3BucketName(v string) *UpdateTrailInput

SetS3BucketName sets the S3BucketName field's value.

func (*UpdateTrailInput) SetS3KeyPrefix added in v1.5.0 

func (s *UpdateTrailInput) SetS3KeyPrefix(v string) *UpdateTrailInput

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*UpdateTrailInput) SetSnsTopicName added in v1.5.0 

func (s *UpdateTrailInput) SetSnsTopicName(v string) *UpdateTrailInput

SetSnsTopicName sets the SnsTopicName field's value.

func (UpdateTrailInput) String added in v0.6.5 

func (s UpdateTrailInput) 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 (*UpdateTrailInput) Validate added in v1.1.21 

func (s *UpdateTrailInput) Validate() error

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

type UpdateTrailOutput 

type UpdateTrailOutput struct {

	// Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail
	// logs are delivered.
	CloudWatchLogsLogGroupArn *string `type:"string"`

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

	// Specifies whether the trail is publishing events from global services such
	// as IAM to the log files.
	IncludeGlobalServiceEvents *bool `type:"boolean"`

	// Specifies whether the trail exists in one region or in all regions.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Specifies whether the trail is an organization trail.
	IsOrganizationTrail *bool `type:"boolean"`

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

	// Specifies whether log file integrity validation is enabled.
	LogFileValidationEnabled *bool `type:"boolean"`

	// Specifies the name of the trail.
	Name *string `type:"string"`

	// Specifies the name of the Amazon S3 bucket designated for publishing log
	// files.
	S3BucketName *string `type:"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 IAM Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).
	S3KeyPrefix *string `type:"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 `type:"string"`

	// This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN.
	//
	// Deprecated: SnsTopicName has been deprecated
	SnsTopicName *string `deprecated:"true" type:"string"`

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

Returns the objects or data listed below if successful. Otherwise, returns an error.

func (UpdateTrailOutput) GoString added in v0.6.5 

func (s UpdateTrailOutput) 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 (*UpdateTrailOutput) SetCloudWatchLogsLogGroupArn added in v1.5.0 

func (s *UpdateTrailOutput) SetCloudWatchLogsLogGroupArn(v string) *UpdateTrailOutput

SetCloudWatchLogsLogGroupArn sets the CloudWatchLogsLogGroupArn field's value.

func (*UpdateTrailOutput) SetCloudWatchLogsRoleArn added in v1.5.0 

func (s *UpdateTrailOutput) SetCloudWatchLogsRoleArn(v string) *UpdateTrailOutput

SetCloudWatchLogsRoleArn sets the CloudWatchLogsRoleArn field's value.

func (*UpdateTrailOutput) SetIncludeGlobalServiceEvents added in v1.5.0 

func (s *UpdateTrailOutput) SetIncludeGlobalServiceEvents(v bool) *UpdateTrailOutput

SetIncludeGlobalServiceEvents sets the IncludeGlobalServiceEvents field's value.

func (*UpdateTrailOutput) SetIsMultiRegionTrail added in v1.5.0 

func (s *UpdateTrailOutput) SetIsMultiRegionTrail(v bool) *UpdateTrailOutput

SetIsMultiRegionTrail sets the IsMultiRegionTrail field's value.

func (*UpdateTrailOutput) SetIsOrganizationTrail added in v1.15.79 

func (s *UpdateTrailOutput) SetIsOrganizationTrail(v bool) *UpdateTrailOutput

SetIsOrganizationTrail sets the IsOrganizationTrail field's value.

func (*UpdateTrailOutput) SetKmsKeyId added in v1.5.0 

func (s *UpdateTrailOutput) SetKmsKeyId(v string) *UpdateTrailOutput

SetKmsKeyId sets the KmsKeyId field's value.

func (*UpdateTrailOutput) SetLogFileValidationEnabled added in v1.5.0 

func (s *UpdateTrailOutput) SetLogFileValidationEnabled(v bool) *UpdateTrailOutput

SetLogFileValidationEnabled sets the LogFileValidationEnabled field's value.

func (*UpdateTrailOutput) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*UpdateTrailOutput) SetS3BucketName added in v1.5.0 

func (s *UpdateTrailOutput) SetS3BucketName(v string) *UpdateTrailOutput

SetS3BucketName sets the S3BucketName field's value.

func (*UpdateTrailOutput) SetS3KeyPrefix added in v1.5.0 

func (s *UpdateTrailOutput) SetS3KeyPrefix(v string) *UpdateTrailOutput

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (*UpdateTrailOutput) SetSnsTopicARN added in v1.5.0 

func (s *UpdateTrailOutput) SetSnsTopicARN(v string) *UpdateTrailOutput

SetSnsTopicARN sets the SnsTopicARN field's value.

func (*UpdateTrailOutput) SetSnsTopicName added in v1.5.0 

func (s *UpdateTrailOutput) SetSnsTopicName(v string) *UpdateTrailOutput

SetSnsTopicName sets the SnsTopicName field's value.

func (*UpdateTrailOutput) SetTrailARN added in v1.5.0 

func (s *UpdateTrailOutput) SetTrailARN(v string) *UpdateTrailOutput

SetTrailARN sets the TrailARN field's value.

func (UpdateTrailOutput) String added in v0.6.5 

func (s UpdateTrailOutput) 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".

Source Files

View all Source files

Directories

Path Synopsis
Package cloudtrailiface provides an interface to enable mocking the AWS CloudTrail service client for testing your code.
 Package cloudtrailiface provides an interface to enable mocking the AWS CloudTrail service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.