# GetChannel
<a name="API_GetChannel"></a>

**Important**  
CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see [CloudTrail Lake availability change](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-service-availability-change.html).

 Returns information about a specific channel. 

## Request Syntax
<a name="API_GetChannel_RequestSyntax"></a>

```
{
   "Channel": "string"
}
```

## Request Parameters
<a name="API_GetChannel_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Channel](#API_GetChannel_RequestSyntax) **   <a name="awscloudtrail-GetChannel-request-Channel"></a>
The ARN or `UUID` of a channel.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9._/\-:]+$`   
Required: Yes

## Response Syntax
<a name="API_GetChannel_ResponseSyntax"></a>

```
{
   "ChannelArn": "string",
   "Destinations": [ 
      { 
         "Location": "string",
         "Type": "string"
      }
   ],
   "IngestionStatus": { 
      "LatestIngestionAttemptEventID": "string",
      "LatestIngestionAttemptTime": number,
      "LatestIngestionErrorCode": "string",
      "LatestIngestionSuccessEventID": "string",
      "LatestIngestionSuccessTime": number
   },
   "Name": "string",
   "Source": "string",
   "SourceConfig": { 
      "AdvancedEventSelectors": [ 
         { 
            "FieldSelectors": [ 
               { 
                  "EndsWith": [ "string" ],
                  "Equals": [ "string" ],
                  "Field": "string",
                  "NotEndsWith": [ "string" ],
                  "NotEquals": [ "string" ],
                  "NotStartsWith": [ "string" ],
                  "StartsWith": [ "string" ]
               }
            ],
            "Name": "string"
         }
      ],
      "ApplyToAllRegions": boolean
   }
}
```

## Response Elements
<a name="API_GetChannel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChannelArn](#API_GetChannel_ResponseSyntax) **   <a name="awscloudtrail-GetChannel-response-ChannelArn"></a>
The ARN of an channel returned by a `GetChannel` request.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9._/\-:]+$` 

 ** [Destinations](#API_GetChannel_ResponseSyntax) **   <a name="awscloudtrail-GetChannel-response-Destinations"></a>
The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the AWS service that created the service-linked channel to receive events.  
Type: Array of [Destination](API_Destination.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 200 items.

 ** [IngestionStatus](#API_GetChannel_ResponseSyntax) **   <a name="awscloudtrail-GetChannel-response-IngestionStatus"></a>
A table showing information about the most recent successful and failed attempts to ingest events.  
Type: [IngestionStatus](API_IngestionStatus.md) object

 ** [Name](#API_GetChannel_ResponseSyntax) **   <a name="awscloudtrail-GetChannel-response-Name"></a>
 The name of the CloudTrail channel. For service-linked channels, the name is `aws-service-channel/service-name/custom-suffix` where `service-name` represents the name of the AWS service that created the channel and `custom-suffix` represents the suffix generated by the AWS service.   
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `^[a-zA-Z0-9._\-]+$` 

 ** [Source](#API_GetChannel_ResponseSyntax) **   <a name="awscloudtrail-GetChannel-response-Source"></a>
The source for the CloudTrail channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*` 

 ** [SourceConfig](#API_GetChannel_ResponseSyntax) **   <a name="awscloudtrail-GetChannel-response-SourceConfig"></a>
 Provides information about the advanced event selectors configured for the channel, and whether the channel applies to all Regions or a single Region.   
Type: [SourceConfig](API_SourceConfig.md) object

## Errors
<a name="API_GetChannel_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ChannelARNInvalidException **   
This exception is thrown when the specified value of `ChannelARN` is not valid.  
HTTP Status Code: 400

 ** ChannelNotFoundException **   
This exception is thrown when CloudTrail cannot find the specified channel.  
HTTP Status Code: 400

 ** OperationNotPermittedException **   
This exception is thrown when the requested operation is not permitted.  
HTTP Status Code: 400

 ** UnsupportedOperationException **   
This exception is thrown when the requested operation is not supported.  
HTTP Status Code: 400

## See Also
<a name="API_GetChannel_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/cloudtrail-2013-11-01/GetChannel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cloudtrail-2013-11-01/GetChannel)