ConfigService / Client / describe_delivery_channels

describe_delivery_channels#

ConfigService.Client.describe_delivery_channels(**kwargs)#

Returns details about the specified delivery channel. If a delivery channel is not specified, this operation 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_delivery_channels(
    DeliveryChannelNames=[
        'string',
    ]
)
Parameters:

DeliveryChannelNames (list) –

A list of delivery channel names.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DeliveryChannels': [
        {
            'name': 'string',
            's3BucketName': 'string',
            's3KeyPrefix': 'string',
            's3KmsKeyArn': 'string',
            'snsTopicARN': 'string',
            'configSnapshotDeliveryProperties': {
                'deliveryFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours'
            }
        },
    ]
}

Response Structure

  • (dict) –

    The output for the DescribeDeliveryChannels action.

    • DeliveryChannels (list) –

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

      • (dict) –

        The channel through which Config delivers notifications and updated configuration states.

        • name (string) –

          The name of the delivery channel. By default, Config assigns the name “default” when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

        • s3BucketName (string) –

          The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

          If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

        • s3KeyPrefix (string) –

          The prefix for the specified Amazon S3 bucket.

        • s3KmsKeyArn (string) –

          The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

        • snsTopicARN (string) –

          The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

          If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

        • configSnapshotDeliveryProperties (dict) –

          The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

          • deliveryFrequency (string) –

            The frequency with which Config delivers configuration snapshots.

Exceptions