Menu
AWS Config
API Reference (API Version 2014-11-12)

DescribeDeliveryChannels

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

Note

Currently, you can specify only one delivery channel per region in your account.

Request Syntax

{
   "DeliveryChannelNames": [ "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.

DeliveryChannelNames

A list of delivery channel names.

Type: Array of strings

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

Required: No

Response Syntax

{
   "DeliveryChannels": [ 
      { 
         "configSnapshotDeliveryProperties": { 
            "deliveryFrequency": "string"
         },
         "name": "string",
         "s3BucketName": "string",
         "s3KeyPrefix": "string",
         "snsTopicARN": "string"
      }
   ]
}

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.

DeliveryChannels

A list that contains the descriptions of the specified delivery channel.

Type: Array of DeliveryChannel objects

Errors

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

NoSuchDeliveryChannelException

You have specified a delivery channel that does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: