CloudWatchLogs / Client / describe_delivery_sources

describe_delivery_sources#

CloudWatchLogs.Client.describe_delivery_sources(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_delivery_sources(
    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 delivery sources to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'deliverySources': [
        {
            'name': 'string',
            'arn': 'string',
            'resourceArns': [
                'string',
            ],
            'service': 'string',
            'logType': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • deliverySources (list) –

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

      • (dict) –

        This structure contains information about one delivery source in your account. A delivery source is an Amazon Web Services resource that sends logs to an Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose.

        Only some Amazon Web Services services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.

        To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:

        • Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see PutDeliverySource.

        • Create a delivery destination, which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.

        • If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.

        • Create a delivery by pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.

        You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.

        • name (string) –

          The unique name of the delivery source.

        • arn (string) –

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

        • resourceArns (list) –

          This array contains the ARN of the Amazon Web Services resource that sends logs and is represented by this delivery source. Currently, only one ARN can be in the array.

          • (string) –

        • service (string) –

          The Amazon Web Services service that is sending logs.

        • logType (string) –

          The type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.

        • tags (dict) –

          The tags that have been assigned to this delivery source.

          • (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