Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetChannel

Returns information about a specific channel.

Request Syntax


{
   "Channel": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Channel

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


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

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

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

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 objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

IngestionStatus

A table showing information about the most recent successful and failed attempts to ingest events.

Type: IngestionStatus object

Name

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

The source for the CloudTrail channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: .*

SourceConfig

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 object

Errors

For information about the errors that are common to all actions, see Common Errors.

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