cloudtrail

package
v1.99.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

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 AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS 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 AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page (http://aws.amazon.com/tools/).

See the AWS CloudTrail User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html) for information about the data that is included with each AWS 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 (
	// 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 (
	// 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 an invalid trail
	// ARN. The format of a trail ARN is:
	//
	// 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
	// AWS CloudTrail and AWS Organizations. For more information, see Enabling
	// Trusted Access with Other AWS 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"

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

	// 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 SNS topic is not sufficient.
	ErrCodeInsufficientSnsTopicPolicyException = "InsufficientSnsTopicPolicyException"

	// ErrCodeInvalidCloudWatchLogsLogGroupArnException for service response error code
	// "InvalidCloudWatchLogsLogGroupArnException".
	//
	// This exception is thrown when the provided CloudWatch 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"

	// ErrCodeInvalidEventSelectorsException for service response error code
	// "InvalidEventSelectorsException".
	//
	// This exception is thrown when the PutEventSelectors operation is called with
	// a number of event selectors or data resources that is not valid. The combination
	// of event selectors and data resources is not valid. A trail can have up to
	// 5 event selectors. 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 a valid value for a parameter. For example, specifying the ReadWriteType
	//    parameter with a value of read-only is invalid.
	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"

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

	// ErrCodeInvalidLookupAttributesException for service response error code
	// "InvalidLookupAttributesException".
	//
	// Occurs when an invalid lookup attribute is specified.
	ErrCodeInvalidLookupAttributesException = "InvalidLookupAttributesException"

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

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// Invalid token or token that was previously used in a request with different
	// parameters. This exception is thrown if the token is invalid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

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

	// 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 key or value specified for the tag does
	// not match the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$.
	ErrCodeInvalidTagParameterException = "InvalidTagParameterException"

	// ErrCodeInvalidTimeRangeException for service response error code
	// "InvalidTimeRangeException".
	//
	// Occurs if the timestamp values are invalid. 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 invalid.
	//
	//    * 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 deprecated.
	ErrCodeKmsKeyDisabledException = "KmsKeyDisabledException"

	// ErrCodeKmsKeyNotFoundException for service response error code
	// "KmsKeyNotFoundException".
	//
	// This exception is thrown when the KMS key does not exist, or when the S3
	// bucket and the KMS key are not in the same region.
	ErrCodeKmsKeyNotFoundException = "KmsKeyNotFoundException"

	// 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 AWS account making the request to create
	// or update an organization trail is not the master account for an organization
	// in AWS 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 AWS Organizations is not configured to support
	// all features. All features must be enabled in AWS Organization 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 AWS 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"

	// 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 deprecated.
	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 identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

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 CloudTrail tags, up to a limit of 50
	TagsList []*Tag `type:"list"`
	// 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

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

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 listed below if successful. Otherwise, returns an error.

func (AddTagsOutput) GoString added in v0.9.11 

func (s AddTagsOutput) GoString() string

GoString returns the string representation

func (AddTagsOutput) String added in v0.9.11 

func (s AddTagsOutput) String() string

String returns the string representation

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: 

// 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. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. 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 regions only from the region in which the trail was created (that is, from 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 Codes:

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

  • ErrCodeARNInvalidException "CloudTrailARNInvalidException" This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

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

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeInvalidTagParameterException "InvalidTagParameterException" This exception is thrown when the key or value specified for the tag does not match the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$.

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

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

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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/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) 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. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

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 Codes:

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

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

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

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

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

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

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

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

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

  • ErrCodeInvalidKmsKeyIdException "InvalidKmsKeyIdException" This exception is thrown when the KMS key ARN is invalid.

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeTrailNotProvidedException "TrailNotProvidedException" This exception is deprecated.

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

  • ErrCodeKmsKeyNotFoundException "KmsKeyNotFoundException" This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.

  • ErrCodeKmsKeyDisabledException "KmsKeyDisabledException" This exception is deprecated.

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

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

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

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

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

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

  • ErrCodeAccessNotEnabledException "CloudTrailAccessNotEnabledException" This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS Organizations. For more information, see Enabling Trusted Access with Other AWS 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).

  • ErrCodeInsufficientDependencyServiceAccessPermissionException "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).

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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).

  • ErrCodeOrganizationsNotInUseException "OrganizationsNotInUseException" This exception is thrown when the request is made from an AWS 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.

  • ErrCodeOrganizationNotInAllFeaturesModeException "OrganizationNotInAllFeaturesModeException" This exception is thrown when AWS Organizations is not configured to support all features. All features must be enabled in AWS Organization 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/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) 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 Codes:

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeInvalidHomeRegionException "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.

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

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

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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).

  • ErrCodeInsufficientDependencyServiceAccessPermissionException "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/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) DescribeTrails 

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

DescribeTrails API operation for AWS CloudTrail.

Retrieves settings for the trail 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 Codes:

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

  • ErrCodeOperationNotPermittedException "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/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) 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 Amazon S3 objects or AWS Lambda functions that you are logging for data events.

For more information, see Logging Data and Management Events for Trails (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) in the AWS 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 Codes:

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

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

  • ErrCodeOperationNotPermittedException "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) 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 Codes:

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

  • ErrCodeInvalidTrailNameException "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 invalid.

  • 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/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) 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/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular 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 Codes:

  • ErrCodeInvalidTimeRangeException "InvalidTimeRangeException" Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.

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

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

  • ErrCodeInvalidTokenException "InvalidTokenException" Reserved for future use.

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

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) 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 Codes:

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

  • ErrCodeARNInvalidException "CloudTrailARNInvalidException" This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

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

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

  • ErrCodeInvalidTokenException "InvalidTokenException" Reserved for future use.

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

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) 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) captured by CloudTrail. Events for a region can be looked up in that region during the last 90 days. Lookup supports the following attributes:

  • AWS access key

  • Event ID

  • Event name

  • Event source

  • Read only

  • Resource name

  • Resource type

  • User name

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 one per second per account. If this limit is exceeded, a throttling error occurs.

Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

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 Codes:

  • ErrCodeInvalidLookupAttributesException "InvalidLookupAttributesException" Occurs when an invalid lookup attribute is specified.

  • ErrCodeInvalidTimeRangeException "InvalidTimeRangeException" Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.

  • ErrCodeInvalidMaxResultsException "InvalidMaxResultsException" This exception is thrown if the limit specified is invalid.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid.

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 for your trail. 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 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 but it 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 is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) and Limits in AWS CloudTrail (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html) in the AWS 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 Codes:

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeInvalidHomeRegionException "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.

  • ErrCodeInvalidEventSelectorsException "InvalidEventSelectorsException" This exception is thrown when the PutEventSelectors operation is called with a number of event selectors or data resources that is not valid. The combination of event selectors and data resources is not valid. A trail can have up to 5 event selectors. 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 a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is invalid.

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

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

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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).

  • ErrCodeInsufficientDependencyServiceAccessPermissionException "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) 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 Codes:

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

  • ErrCodeARNInvalidException "CloudTrailARNInvalidException" This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

    arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeInvalidTagParameterException "InvalidTagParameterException" This exception is thrown when the key or value specified for the tag does not match the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$.

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

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

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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) StartLogging 

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

StartLogging API operation for AWS CloudTrail.

Starts the recording of AWS 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 Codes:

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeInvalidHomeRegionException "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.

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

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

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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).

  • ErrCodeInsufficientDependencyServiceAccessPermissionException "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) StopLogging 

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

StopLogging API operation for AWS CloudTrail.

Suspends the recording of AWS 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 Codes:

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

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeInvalidHomeRegionException "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.

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

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

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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).

  • ErrCodeInsufficientDependencyServiceAccessPermissionException "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) UpdateTrail 

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

UpdateTrail API operation for AWS CloudTrail.

Updates the settings that specify delivery of 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 Codes:

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

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

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

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

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

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

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

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

  • ErrCodeInvalidKmsKeyIdException "InvalidKmsKeyIdException" This exception is thrown when the KMS key ARN is invalid.

  • ErrCodeInvalidTrailNameException "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 invalid.

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

  • ErrCodeTrailNotProvidedException "TrailNotProvidedException" This exception is deprecated.

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

  • ErrCodeInvalidHomeRegionException "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.

  • ErrCodeKmsKeyNotFoundException "KmsKeyNotFoundException" This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.

  • ErrCodeKmsKeyDisabledException "KmsKeyDisabledException" This exception is deprecated.

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

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

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

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

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

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

  • ErrCodeAccessNotEnabledException "CloudTrailAccessNotEnabledException" This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS Organizations. For more information, see Enabling Trusted Access with Other AWS 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).

  • ErrCodeInsufficientDependencyServiceAccessPermissionException "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).

  • ErrCodeOrganizationsNotInUseException "OrganizationsNotInUseException" This exception is thrown when the request is made from an AWS 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.

  • ErrCodeNotOrganizationMasterAccountException "NotOrganizationMasterAccountException" This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS 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).

  • ErrCodeOrganizationNotInAllFeaturesModeException "OrganizationNotInAllFeaturesModeException" This exception is thrown when AWS Organizations is not configured to support all features. All features must be enabled in AWS Organization 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/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 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 will 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.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Specifies whether the trail is created for all accounts in an organization
	// in AWS Organizations, or only for the current AWS account. The default is
	// false, and cannot be true unless the call is made on behalf of an AWS account
	// that is the master account for an organization in AWS 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.
	//
	// 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 invalid.
	//
	//    * 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 (http://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 (http://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 the settings for each trail.

func (CreateTrailInput) GoString added in v0.6.5 

func (s CreateTrailInput) GoString() string

GoString returns the string representation

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.99.0 

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) String added in v0.6.5 

func (s CreateTrailInput) String() string

String returns the string representation

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 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 (http://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 deprecated. 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

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.99.0 

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

type DataResource added in v1.5.9 

type DataResource struct {

	// The resource type in which you want to log data events. You can specify AWS::S3::Object
	// or AWS::Lambda::Function resources.
	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 AWS account,
	//    specify the prefix as arn:aws:s3:::. This will also enable logging of
	//    data event activity performed by any user or role in your AWS account,
	//    even if that activity is performed on a bucket that belongs to another
	//    AWS account.
	//
	//    * To log data events for all objects in all S3 buckets that include my-bucket
	//    in their names, specify the prefix as aws:s3:::my-bucket. The trail logs
	//    data events for all objects in all buckets whose name contains a match
	//    for my-bucket.
	//
	//    * 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 functions in your AWS account, specify the
	//    prefix as arn:aws:lambda. This will also enable logging of Invoke activity
	//    performed by any user or role in your AWS account, even if that activity
	//    is performed on a function that belongs to another AWS account.
	//
	//    * To log data eents for a specific Lambda function, specify the function
	//    ARN. Lambda function ARNs are exact. Unlike S3, you cannot use matching.
	//    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.
	Values []*string `type:"list"`
	// contains filtered or unexported fields
}

The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into 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.

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 spcified 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 AWS Lambda data events for a Lambda function named MyLambdaFunction, but not for all AWS 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 AWS 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 AWS 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

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

type DeleteTrailInput 

type DeleteTrailInput struct {

	// Specifies the name or the CloudTrail ARN of the trail to be deleted. The
	// format of a trail ARN is: 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

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

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

func (DeleteTrailOutput) String added in v0.6.5 

func (s DeleteTrailOutput) String() string

String returns the string representation

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

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

type DescribeTrailsOutput 

type DescribeTrailsOutput struct {

	// The list of trail objects.
	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

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

type Event 

type Event struct {

	// The AWS 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 AWS service that the request was made to.
	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

func (*Event) SetAccessKeyId added in v1.99.0 

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.99.0 

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

type EventSelector added in v1.5.9 

type EventSelector struct {

	// CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda
	// functions. 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 (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events)
	// and Limits in AWS CloudTrail (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html)
	// in the AWS CloudTrail User Guide.
	DataResources []*DataResource `type:"list"`

	// Specify if you want your event selector to include management events for
	// your trail.
	//
	// For more information, see Management Events (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events)
	// in the AWS CloudTrail User Guide.
	//
	// By default, the value is true.
	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.

func (EventSelector) GoString added in v1.5.9 

func (s EventSelector) GoString() string

GoString returns the string representation

func (*EventSelector) SetDataResources added in v1.5.9 

func (s *EventSelector) SetDataResources(v []*DataResource) *EventSelector

SetDataResources sets the DataResources 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

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

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

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

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

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 format of a trail ARN is:
	//
	// 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

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

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 is currently logging AWS 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 deprecated.
	LatestDeliveryAttemptSucceeded *string `type:"string"`

	// This field is deprecated.
	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 the
	// topic Error Responses (http://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 will not occur for timeouts. To resolve the issue, create a new bucket
	// and 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
	// the topic Error Responses (http://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 will not occur for timeouts. To resolve the issue, create a new bucket
	// and 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 deprecated.
	LatestNotificationAttemptSucceeded *string `type:"string"`

	// This field is deprecated.
	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 (http://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 AWS account.
	StartLoggingTime *time.Time `type:"timestamp"`

	// Specifies the most recent date and time when CloudTrail stopped recording
	// API calls for an AWS account.
	StopLoggingTime *time.Time `type:"timestamp"`

	// This field is deprecated.
	TimeLoggingStarted *string `type:"string"`

	// This field is deprecated.
	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

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

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

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

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

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

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 format of a trail ARN is:
	//
	// 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

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

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

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

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

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

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"`

	// 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

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

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

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

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

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

type PutEventSelectorsInput added in v1.5.9 

type PutEventSelectorsInput struct {

	// Specifies the settings for your event selectors. You can configure up to
	// five event selectors for a trail.
	//
	// EventSelectors is a required field
	EventSelectors []*EventSelector `type:"list" required:"true"`

	// 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 invalid.
	//
	//    * 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 (PutEventSelectorsInput) GoString added in v1.5.9 

func (s PutEventSelectorsInput) GoString() string

GoString returns the string representation

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

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 event selectors configured for your trail.
	EventSelectors []*EventSelector `type:"list"`

	// Specifies the ARN of the trail that was updated with event selectors. 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
}

func (PutEventSelectorsOutput) GoString added in v1.5.9 

func (s PutEventSelectorsOutput) GoString() string

GoString returns the string representation

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

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 []*Tag `type:"list"`
	// 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

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

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

func (RemoveTagsOutput) String added in v0.9.11 

func (s RemoveTagsOutput) String() string

String returns the string representation

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 RDS, and AccessKey
	// for IAM. For a list of resource types supported for event lookup, see Resource
	// Types Supported for Event Lookup (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/lookup_supported_resourcetypes.html).
	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

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

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

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

type StartLoggingInput 

type StartLoggingInput struct {

	// Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
	// logs AWS API calls. The format of a trail ARN is:
	//
	// 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 AWS API calls for an account.

func (StartLoggingInput) GoString added in v0.6.5 

func (s StartLoggingInput) GoString() string

GoString returns the string representation

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

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

func (StartLoggingOutput) String added in v0.6.5 

func (s StartLoggingOutput) String() string

String returns the string representation

type StopLoggingInput 

type StopLoggingInput struct {

	// Specifies the name or the CloudTrail ARN of the trail for which CloudTrail
	// will stop logging AWS API calls. The format of a trail ARN is:
	//
	// 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 AWS API calls for the specified account.

func (StopLoggingInput) GoString added in v0.6.5 

func (s StopLoggingInput) GoString() string

GoString returns the string representation

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

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

func (StopLoggingOutput) String added in v0.6.5 

func (s StopLoggingOutput) String() string

String returns the string representation

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 `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 `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

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

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 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"`

	// The region in which the trail was created.
	HomeRegion *string `type:"string"`

	// Set to True to include AWS API calls from AWS global services such as IAM.
	// Otherwise, False.
	IncludeGlobalServiceEvents *bool `type:"boolean"`

	// Specifies whether the trail belongs only to 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 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 (http://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 (http://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 format of a topic ARN is:
	//
	// arn:aws:sns:us-east-2:123456789012:MyTopic
	SnsTopicARN *string `type:"string"`

	// This field is deprecated. Use SnsTopicARN.
	//
	// Deprecated: SnsTopicName has been deprecated
	SnsTopicName *string `deprecated:"true" type:"string"`

	// Specifies the ARN of the trail. 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
}

The settings for a trail.

func (Trail) GoString added in v0.6.5 

func (s Trail) GoString() string

GoString returns the string representation

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) 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.99.0 

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

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 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 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 will 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.
	IsMultiRegionTrail *bool `type:"boolean"`

	// Specifies whether the trail is applied to all accounts in an organization
	// in AWS Organizations, or only for the current AWS account. The default is
	// false, and cannot be true unless the call is made on behalf of an AWS account
	// that is the master account for an organization in AWS Organizations. If the
	// trail is not an organization trail and this is set to true, the trail will
	// be created in all AWS 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 AWS 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.
	//
	// 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 invalid.
	//
	//    * Not be in IP address format (for example, 192.168.5.4)
	//
	// If Name is a trail ARN, it must be in the 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 (http://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 (http://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

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.99.0 

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

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 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 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 (http://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 deprecated. Use SnsTopicARN.
	//
	// Deprecated: SnsTopicName has been deprecated
	SnsTopicName *string `deprecated:"true" type:"string"`

	// Specifies the ARN of the trail that was updated. 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 (UpdateTrailOutput) GoString added in v0.6.5 

func (s UpdateTrailOutput) GoString() string

GoString returns the string representation

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.99.0 

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

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.