2023/11/09 - Amazon CloudWatch Logs - 15 new api methods
Changes Update to support new APIs for delivery of logs from AWS services.
Returns complete information about one delivery. A delivery is a connection between a logical delivery source and a logical delivery destination
You need to specify the delivery id in this operation. You can find the IDs of the deliveries in your account with the DescribeDeliveries operation.
See also: AWS API Documentation
Request Syntax
client.get_delivery(
id='string'
)
string
[REQUIRED]
The ID of the delivery that you want to retrieve.
dict
Response Syntax
{
'delivery': {
'id': 'string',
'arn': 'string',
'deliverySourceName': 'string',
'deliveryDestinationArn': 'string',
'deliveryDestinationType': 'S3'|'CWL'|'FH',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
delivery (dict) --
A structure that contains information about the delivery.
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) --
Retrieves complete information about one delivery source.
See also: AWS API Documentation
Request Syntax
client.get_delivery_source(
name='string'
)
string
[REQUIRED]
The name of the delivery source that you want to retrieve.
dict
Response Syntax
{
'deliverySource': {
'name': 'string',
'arn': 'string',
'resourceArns': [
'string',
],
'service': 'string',
'logType': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
deliverySource (dict) --
A structure containing information about the delivery source.
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) --
Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and check the deliveryDestinationArn field in the results.
See also: AWS API Documentation
Request Syntax
client.delete_delivery_destination(
name='string'
)
string
[REQUIRED]
The name of the delivery destination that you want to delete. You can find a list of delivery destionation names by using the DescribeDeliveryDestinations operation.
None
Deletes s delivery. A delivery is a connection between a logical delivery source and a logical delivery destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.
See also: AWS API Documentation
Request Syntax
client.delete_delivery(
id='string'
)
string
[REQUIRED]
The unique ID of the delivery to delete. You can find the ID of a delivery with the DescribeDeliveries operation.
None
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
)
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.
dict
Response Syntax
{
'deliveryDestinations': [
{
'name': 'string',
'arn': 'string',
'deliveryDestinationType': 'S3'|'CWL'|'FH',
'outputFormat': 'json'|'plain'|'w3c'|'raw'|'parquet',
'deliveryDestinationConfiguration': {
'destinationResourceArn': '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 shared id="AWS"/> service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose 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, or Kinesis Data Firehose.
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 Kinesis Data Firehose.
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.
Creates or updates a logical delivery destination. 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, and Kinesis Data Firehose are supported as logs 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.
Use PutDeliveryDestination to 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.
Use CreateDelivery to 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.
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.
If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.
See also: AWS API Documentation
Request Syntax
client.put_delivery_destination(
name='string',
outputFormat='json'|'plain'|'w3c'|'raw'|'parquet',
deliveryDestinationConfiguration={
'destinationResourceArn': 'string'
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
A name for this delivery destination. This name must be unique for all delivery destinations in your account.
string
The format for the logs that this delivery destination will receive.
dict
[REQUIRED]
A structure that contains the ARN of the Amazon Web Services resource that will receive the logs.
destinationResourceArn (string) -- [REQUIRED]
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 Kinesis Data Firehose.
dict
An optional list of key-value pairs to associate with the resource.
For more information about tagging, see Tagging Amazon Web Services resources
(string) --
(string) --
dict
Response Syntax
{
'deliveryDestination': {
'name': 'string',
'arn': 'string',
'deliveryDestinationType': 'S3'|'CWL'|'FH',
'outputFormat': 'json'|'plain'|'w3c'|'raw'|'parquet',
'deliveryDestinationConfiguration': {
'destinationResourceArn': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
deliveryDestination (dict) --
A structure containing information about the delivery destination that you just created or updated.
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, or Kinesis Data Firehose.
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 Kinesis Data Firehose.
tags (dict) --
The tags that have been assigned to this delivery destination.
(string) --
(string) --
Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery destination.
You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName field in the results.
See also: AWS API Documentation
Request Syntax
client.delete_delivery_source(
name='string'
)
string
[REQUIRED]
The name of the delivery source that you want to delete.
None
Retrieves a list of the deliveries that have been created in the account.
See also: AWS API Documentation
Request Syntax
client.describe_deliveries(
nextToken='string',
limit=123
)
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.
dict
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.
Creates or updates a logical delivery source. 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, or Kinesis Data Firehose.
To configure logs delivery between a delivery destination and an Amazon Web Services service that is supported as a delivery source, you must do the following:
Use PutDeliverySource to create a delivery source, which is a logical object that represents the resource that is actually sending the logs.
Use PutDeliveryDestination to 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.
Use CreateDelivery to 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.
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.
If you use this operation to update an existing delivery source, all the current delivery source parameters are overwritten with the new parameter values that you specify.
See also: AWS API Documentation
Request Syntax
client.put_delivery_source(
name='string',
resourceArn='string',
logType='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
A name for this delivery source. This name must be unique for all delivery sources in your account.
string
[REQUIRED]
The ARN of the Amazon Web Services resource that is generating and sending logs. For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234
string
[REQUIRED]
Defines the type of log that the source is sending. For valid values for this parameter, see the documentation for the source service.
dict
An optional list of key-value pairs to associate with the resource.
For more information about tagging, see Tagging Amazon Web Services resources
(string) --
(string) --
dict
Response Syntax
{
'deliverySource': {
'name': 'string',
'arn': 'string',
'resourceArns': [
'string',
],
'service': 'string',
'logType': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
deliverySource (dict) --
A structure containing information about the delivery source that was just created or updated.
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) --
Retrieves complete information about one delivery destination.
See also: AWS API Documentation
Request Syntax
client.get_delivery_destination(
name='string'
)
string
[REQUIRED]
The name of the delivery destination that you want to retrieve.
dict
Response Syntax
{
'deliveryDestination': {
'name': 'string',
'arn': 'string',
'deliveryDestinationType': 'S3'|'CWL'|'FH',
'outputFormat': 'json'|'plain'|'w3c'|'raw'|'parquet',
'deliveryDestinationConfiguration': {
'destinationResourceArn': 'string'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
deliveryDestination (dict) --
A structure containing information about the 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, or Kinesis Data Firehose.
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 Kinesis Data Firehose.
tags (dict) --
The tags that have been assigned to this delivery destination.
(string) --
(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
)
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.
dict
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 Kinesis Data 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.
Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To configure the delivery of logs from an Amazon Web Services service in another account to a logs delivery destination in the current account, 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.
Use this operation 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.
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.
The contents of the policy must include two statements. One statement enables general logs delivery, and the other allows delivery to the chosen destination. See the examples for the needed policies.
See also: AWS API Documentation
Request Syntax
client.put_delivery_destination_policy(
deliveryDestinationName='string',
deliveryDestinationPolicy='string'
)
string
[REQUIRED]
The name of the delivery destination to assign this policy to.
string
[REQUIRED]
The contents of the policy.
dict
Response Syntax
{
'policy': {
'deliveryDestinationPolicy': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
The contents of the policy that you just created.
deliveryDestinationPolicy (string) --
The contents of the delivery destination policy.
Deletes a delivery destination policy. For more information about these policies, see PutDeliveryDestinationPolicy.
See also: AWS API Documentation
Request Syntax
client.delete_delivery_destination_policy(
deliveryDestinationName='string'
)
string
[REQUIRED]
The name of the delivery destination that you want to delete the policy for.
None
Retrieves the delivery destination policy assigned to the delivery destination that you specify. For more information about delivery destinations and their policies, see PutDeliveryDestinationPolicy.
See also: AWS API Documentation
Request Syntax
client.get_delivery_destination_policy(
deliveryDestinationName='string'
)
string
[REQUIRED]
The name of the delivery destination that you want to retrieve the policy of.
dict
Response Syntax
{
'policy': {
'deliveryDestinationPolicy': 'string'
}
}
Response Structure
(dict) --
policy (dict) --
The IAM policy for this delivery destination.
deliveryDestinationPolicy (string) --
The contents of the delivery destination policy.
Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery destination that you have already created.
Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from Amazon Web Services services.
A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Kinesis Data Firehose.
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.
Use CreateDelivery to create a delivery by pairing exactly one delivery source and one delivery destination.
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.
You can't update an existing delivery. You can only create and delete deliveries.
See also: AWS API Documentation
Request Syntax
client.create_delivery(
deliverySourceName='string',
deliveryDestinationArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the delivery source to use for this delivery.
string
[REQUIRED]
The ARN of the delivery destination to use for this delivery.
dict
An optional list of key-value pairs to associate with the resource.
For more information about tagging, see Tagging Amazon Web Services resources
(string) --
(string) --
dict
Response Syntax
{
'delivery': {
'id': 'string',
'arn': 'string',
'deliverySourceName': 'string',
'deliveryDestinationArn': 'string',
'deliveryDestinationType': 'S3'|'CWL'|'FH',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
delivery (dict) --
A structure that contains information about the delivery that you just created.
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) --