AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateTrailAsync.

Namespace: Amazon.CloudTrail
Assembly: AWSSDK.CloudTrail.dll
Version: 3.x.y.z

Syntax

C#
public abstract UpdateTrailResponse UpdateTrail(
         UpdateTrailRequest request
)

Parameters

request
Type: Amazon.CloudTrail.Model.UpdateTrailRequest

Container for the necessary parameters to execute the UpdateTrail service method.

Return Value


The response from the UpdateTrail service method, as returned by CloudTrail.

Exceptions

ExceptionCondition
CloudTrailAccessNotEnabledException This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
CloudTrailARNInvalidException This exception is thrown when an operation is called with an ARN that is not valid. The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail The following is the format of an event data store ARN: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE The following is the format of a channel ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
CloudTrailInvalidClientTokenIdException This exception is thrown when a call results in the InvalidClientTokenId error code. This can occur when you are creating or updating a trail to send notifications to an Amazon SNS topic that is in a suspended Amazon Web Services account.
CloudWatchLogsDeliveryUnavailableException Cannot set a CloudWatch Logs delivery for this Region.
ConflictException This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a resource before CloudTrail has time to fully load the resource, or because another operation is modifying the resource. If this exception occurs, wait a few minutes, and then try the operation again.
InsufficientDependencyServiceAccessPermissionException This exception is thrown when the IAM identity that is used to create the organization resource lacks one or more required permissions for creating an organization resource in a required service.
InsufficientEncryptionPolicyException This exception is thrown when the policy on the S3 bucket or KMS key does not have sufficient permissions for the operation.
InsufficientS3BucketPolicyException This exception is thrown when the policy on the S3 bucket is not sufficient.
InsufficientSnsTopicPolicyException This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
InvalidCloudWatchLogsLogGroupArnException This exception is thrown when the provided CloudWatch Logs log group is not valid.
InvalidCloudWatchLogsRoleArnException This exception is thrown when the provided role is not valid.
InvalidEventSelectorsException This exception is thrown when the PutEventSelectors operation is called with a number of event selectors, advanced event selectors, or data resources that is not valid. The combination of event selectors or advanced event selectors and data resources is not valid. A trail can have up to 5 event selectors. If a trail uses advanced event selectors, a maximum of 500 total values for all conditions in all advanced event selectors is allowed. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250. You can: Specify a valid number of event selectors (1 to 5) for a trail. Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail. Specify up to 500 values for all conditions in all advanced event selectors for a trail. Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is not valid.
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.
InvalidKmsKeyIdException This exception is thrown when the KMS key ARN is not valid.
InvalidParameterCombinationException This exception is thrown when the combination of parameters provided is not valid.
InvalidParameterException The request includes a parameter that is not valid.
InvalidS3BucketNameException This exception is thrown when the provided S3 bucket name is not valid.
InvalidS3PrefixException This exception is thrown when the provided S3 prefix is not valid.
InvalidSnsTopicNameException This exception is thrown when the provided SNS topic name is not valid.
InvalidTrailNameException This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements: Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-) Start with a letter or number, and end with a letter or number Be between 3 and 128 characters Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid. Not be in IP address format (for example, 192.168.5.4)
KmsException This exception is thrown when there is an issue with the specified KMS key and the trail or event data store can't be updated.
KmsKeyDisabledException This exception is no longer in use.
KmsKeyNotFoundException This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same Region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same Region.
NoManagementAccountSLRExistsException This exception is thrown when the management account does not have a service-linked role.
NotOrganizationMasterAccountException This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail or event data store is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization or Create an event data store.
OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
OrganizationNotInAllFeaturesModeException This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail or event data store.
OrganizationsNotInUseException This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
S3BucketDoesNotExistException This exception is thrown when the specified S3 bucket does not exist.
ThrottlingException This exception is thrown when the request rate exceeds the limit.
TrailNotFoundException This exception is thrown when the trail with the given name is not found.
TrailNotProvidedException This exception is no longer in use.
UnsupportedOperationException This exception is thrown when the requested operation is not supported.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also