CloudWatchLogs / Client / describe_deliveries

describe_deliveries#

CloudWatchLogs.Client.describe_deliveries(**kwargs)#

Retrieves a list of the deliveries that have been created in the account.

See also: AWS API Documentation

Request Syntax

response = client.describe_deliveries(
    nextToken='string',
    limit=123
)
Parameters:
  • nextToken (string) – The token for the next set of items to return. The token expires after 24 hours.

  • limit (integer) – Optionally specify the maximum number of deliveries to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'deliveries': [
        {
            'id': 'string',
            'arn': 'string',
            'deliverySourceName': 'string',
            'deliveryDestinationArn': 'string',
            'deliveryDestinationType': 'S3'|'CWL'|'FH',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • deliveries (list) –

      An array of structures. Each structure contains information about one delivery in the account.

      • (dict) –

        This structure contains information about one delivery in your account.

        A delivery is a connection between a logical delivery source and a logical delivery destination.

        For more information, see CreateDelivery.

        You can’t update an existing delivery. You can only create and delete deliveries.

        • id (string) –

          The unique ID that identifies this delivery in your account.

        • arn (string) –

          The Amazon Resource Name (ARN) that uniquely identifies this delivery.

        • deliverySourceName (string) –

          The name of the delivery source that is associated with this delivery.

        • deliveryDestinationArn (string) –

          The ARN of the delivery destination that is associated with this delivery.

        • deliveryDestinationType (string) –

          Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.

        • tags (dict) –

          The tags that have been assigned to this delivery.

          • (string) –

            • (string) –

    • nextToken (string) –

      The token for the next set of items to return. The token expires after 24 hours.

Exceptions

  • CloudWatchLogs.Client.exceptions.ServiceUnavailableException

  • CloudWatchLogs.Client.exceptions.ServiceQuotaExceededException

  • CloudWatchLogs.Client.exceptions.ValidationException

  • CloudWatchLogs.Client.exceptions.ThrottlingException