2026/10/19 - Amazon CloudWatch Logs - 3 updated api methods
Changes Amazon CloudWatch Logs now supports filtering DescribeDeliverySources by resourceArns, DescribeDeliveryDestinations by names, and DescribeDeliveries by deliverySourceNames.
{'deliverySourceNames': ['string']}
Retrieves a list of the deliveries that have been created in the account.
A delivery is a connection between a delivery source and a delivery destination.
A delivery source represents an Amazon Web Services resource that sends logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging from Amazon Web Services services.
See also: AWS API Documentation
Request Syntax
client.describe_deliveries(
nextToken='string',
limit=123,
deliverySourceNames=[
'string',
]
)
string
The token for the next set of items to return. The token expires after 24 hours.
integer
Optionally specify the maximum number of deliveries to return in the response.
list
An array of delivery source names that filters the results to deliveries associated with any specified delivery source.
(string) --
dict
Response Syntax
{
'deliveries': [
{
'id': 'string',
'arn': 'string',
'deliverySourceName': 'string',
'deliveryDestinationArn': 'string',
'deliveryDestinationType': 'S3'|'CWL'|'FH'|'XRAY',
'recordFields': [
'string',
],
'fieldDelimiter': 'string',
's3DeliveryConfiguration': {
'suffixPath': 'string',
'enableHiveCompatiblePath': True|False
},
'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.
To update an existing delivery configuration, use UpdateDeliveryConfiguration.
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, Firehose, or X-Ray.
recordFields (list) --
The record fields used in this delivery.
(string) --
fieldDelimiter (string) --
The field delimiter that is used between record fields when the final output format of a delivery is in Plain, W3C, or Raw format.
s3DeliveryConfiguration (dict) --
This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.
suffixPath (string) --
This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path vary by log type. To find the values supported for the suffix path for each log type, use the DescribeConfigurationTemplates operation and check the allowedSuffixPathFields field in the response. For more information about how the destination prefix, suffix path, and Hive-compatible setting determine the Amazon S3 object key, see Amazon S3 object key for V2 deliveries.
enableHiveCompatiblePath (boolean) --
This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.
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.
{'names': ['string']}
Retrieves a list of the delivery destinations that have been created in the account.
See also: AWS API Documentation
Request Syntax
client.describe_delivery_destinations(
nextToken='string',
limit=123,
names=[
'string',
]
)
string
The token for the next set of items to return. The token expires after 24 hours.
integer
Optionally specify the maximum number of delivery destinations to return in the response.
list
An array of delivery destination names that filters the results to delivery destinations with any specified name.
(string) --
dict
Response Syntax
{
'deliveryDestinations': [
{
'name': 'string',
'arn': 'string',
'deliveryDestinationType': 'S3'|'CWL'|'FH'|'XRAY',
'outputFormat': 'json'|'plain'|'w3c'|'raw'|'parquet',
'deliveryDestinationConfiguration': {
'destinationResourceArn': 'string'
},
'roleArn': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
deliveryDestinations (list) --
An array of structures. Each structure contains information about one delivery destination in the account.
(dict) --
This structure contains information about one delivery destination in your account. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, Firehose, and X-Ray are supported as delivery destinations.
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.
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 name of this delivery destination.
arn (string) --
The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
deliveryDestinationType (string) --
Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.
outputFormat (string) --
The format of the logs that are sent to this delivery destination.
deliveryDestinationConfiguration (dict) --
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
destinationResourceArn (string) --
The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
roleArn (string) --
The ARN of the IAM role that CloudWatch Logs assumes to deliver to this delivery destination. This field is present only for X-Ray trace delivery destinations that were created with a role.
tags (dict) --
The tags that have been assigned to this delivery destination.
(string) --
(string) --
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.
{'resourceArns': ['string']}
Retrieves a list of the delivery sources that have been created in the account.
See also: AWS API Documentation
Request Syntax
client.describe_delivery_sources(
nextToken='string',
limit=123,
resourceArns=[
'string',
]
)
string
The token for the next set of items to return. The token expires after 24 hours.
integer
Optionally specify the maximum number of delivery sources to return in the response.
list
An array of Amazon Resource Names (ARNs) that filters the results to delivery sources associated with any specified ARN.
(string) --
dict
Response Syntax
{
'deliverySources': [
{
'name': 'string',
'arn': 'string',
'resourceArns': [
'string',
],
'service': 'string',
'logType': 'string',
'tags': {
'string': 'string'
},
'deliverySourceConfiguration': {
'string': 'string'
},
'status': 'ACTIVE'|'INACTIVE',
'statusReason': 'RESOURCE_DELETED'
},
],
'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) --
deliverySourceConfiguration (dict) --
The map of key-value pairs that configure the delivery source.
(string) --
(string) --
status (string) --
The status of the delivery source. A delivery source can have the status ACTIVE or INACTIVE. Note: This value is defined for selective log types.
statusReason (string) --
The reason for the status of the delivery source. A status reason of RESOURCE_DELETED indicates that the resource associated with the delivery source has been deleted. Note: This value is defined for selective log types.
nextToken (string) --
The token for the next set of items to return. The token expires after 24 hours.