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.

Lists the tags for the specified trails, event data stores, or channels in the current Region.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginListTags and EndListTags.

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

Syntax

C#
public abstract Task<ListTagsResponse> ListTagsAsync(
         ListTagsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudTrail.Model.ListTagsRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


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

Exceptions

ExceptionCondition
ChannelARNInvalidException This exception is thrown when the specified value of ChannelARN is not valid.
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
EventDataStoreARNInvalidException The specified event data store ARN is not valid or does not map to an event data store in your account.
EventDataStoreNotFoundException The specified event data store was not found.
InactiveEventDataStoreException The event data store is inactive.
InvalidTokenException Reserved for future use.
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)
NoManagementAccountSLRExistsException This exception is thrown when the management account does not have a service-linked role.
OperationNotPermittedException This exception is thrown when the requested operation is not permitted.
ResourceNotFoundException This exception is thrown when the specified resource is not found.
ResourceTypeNotSupportedException This exception is thrown when the specified resource type is not supported by CloudTrail.
UnsupportedOperationException This exception is thrown when the requested operation is not supported.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also