CloudWatchLogs / Client / put_delivery_destination

put_delivery_destination

CloudWatchLogs.Client.put_delivery_destination(**kwargs)

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

response = client.put_delivery_destination(
    name='string',
    outputFormat='json'|'plain'|'w3c'|'raw'|'parquet',
    deliveryDestinationConfiguration={
        'destinationResourceArn': 'string'
    },
    tags={
        'string': 'string'
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  A name for this delivery destination. This name must be unique for all delivery destinations in your account.

• outputFormat (string) – The format for the logs that this delivery destination will receive.

• deliveryDestinationConfiguration (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 Firehose.

• tags (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) –

Return type:

dict

Returns:

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 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 Firehose.

    • tags (dict) –

      The tags that have been assigned to this delivery destination.

      • (string) –

        • (string) –

Exceptions

• CloudWatchLogs.Client.exceptions.ServiceUnavailableException

• CloudWatchLogs.Client.exceptions.ConflictException

• CloudWatchLogs.Client.exceptions.ValidationException

• CloudWatchLogs.Client.exceptions.ServiceQuotaExceededException

• CloudWatchLogs.Client.exceptions.ThrottlingException

• CloudWatchLogs.Client.exceptions.ResourceNotFoundException