ConfigService / Client / describe_delivery_channel_status

describe_delivery_channel_status#

ConfigService.Client.describe_delivery_channel_status(**kwargs)#

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all delivery channels associated with the account.

Note

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

Request Syntax

response = client.describe_delivery_channel_status(
    DeliveryChannelNames=[
        'string',
    ]
)

Parameters:

DeliveryChannelNames (list) –

A list of delivery channel names.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'DeliveryChannelsStatus': [
        {
            'name': 'string',
            'configSnapshotDeliveryInfo': {
                'lastStatus': 'Success'|'Failure'|'Not_Applicable',
                'lastErrorCode': 'string',
                'lastErrorMessage': 'string',
                'lastAttemptTime': datetime(2015, 1, 1),
                'lastSuccessfulTime': datetime(2015, 1, 1),
                'nextDeliveryTime': datetime(2015, 1, 1)
            },
            'configHistoryDeliveryInfo': {
                'lastStatus': 'Success'|'Failure'|'Not_Applicable',
                'lastErrorCode': 'string',
                'lastErrorMessage': 'string',
                'lastAttemptTime': datetime(2015, 1, 1),
                'lastSuccessfulTime': datetime(2015, 1, 1),
                'nextDeliveryTime': datetime(2015, 1, 1)
            },
            'configStreamDeliveryInfo': {
                'lastStatus': 'Success'|'Failure'|'Not_Applicable',
                'lastErrorCode': 'string',
                'lastErrorMessage': 'string',
                'lastStatusChangeTime': datetime(2015, 1, 1)
            }
        },
    ]
}

Response Structure

(dict) –

The output for the DescribeDeliveryChannelStatus action.
- DeliveryChannelsStatus (list) –
  
  A list that contains the status of a specified delivery channel.
  - (dict) –
    
    The status of a specified delivery channel.
    
    Valid values: Success | Failure
    - name (string) –
      
      The name of the delivery channel.
    - configSnapshotDeliveryInfo (dict) –
      
      A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
      - lastStatus (string) –
        
        Status of the last attempted delivery.
      - lastErrorCode (string) –
        
        The error code from the last attempted delivery.
      - lastErrorMessage (string) –
        
        The error message from the last attempted delivery.
      - lastAttemptTime (datetime) –
        
        The time of the last attempted delivery.
      - lastSuccessfulTime (datetime) –
        
        The time of the last successful delivery.
      - nextDeliveryTime (datetime) –
        
        The time that the next delivery occurs.
    - configHistoryDeliveryInfo (dict) –
      
      A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
      - lastStatus (string) –
        
        Status of the last attempted delivery.
      - lastErrorCode (string) –
        
        The error code from the last attempted delivery.
      - lastErrorMessage (string) –
        
        The error message from the last attempted delivery.
      - lastAttemptTime (datetime) –
        
        The time of the last attempted delivery.
      - lastSuccessfulTime (datetime) –
        
        The time of the last successful delivery.
      - nextDeliveryTime (datetime) –
        
        The time that the next delivery occurs.
    - configStreamDeliveryInfo (dict) –
      
      A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
      - lastStatus (string) –
        
        Status of the last attempted delivery.
        
        Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.
      - lastErrorCode (string) –
        
        The error code from the last attempted delivery.
      - lastErrorMessage (string) –
        
        The error message from the last attempted delivery.
      - lastStatusChangeTime (datetime) –
        
        The time from the last status change.

Exceptions

ConfigService.Client.exceptions.NoSuchDeliveryChannelException