Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

PutDeliveryDestination

Creates or updates a logical delivery destination. A delivery destination is an AWS resource that represents an AWS 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 AWS 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 AWS services support being configured as a delivery source. These services are listed as Supported [V2 Permissions] in the table at Enabling logging from AWS 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.

Request Syntax


{
   "deliveryDestinationConfiguration": { 
      "destinationResourceArn": "string"
   },
   "name": "string",
   "outputFormat": "string",
   "tags": { 
      "string" : "string" 
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

deliveryDestinationConfiguration

A structure that contains the ARN of the AWS resource that will receive the logs.

Type: DeliveryDestinationConfiguration object

Required: Yes

name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Pattern: [\w-]*

Required: Yes

outputFormat

The format for the logs that this delivery destination will receive.

Type: String

Valid Values: json | plain | w3c | raw | parquet

Required: No

tags

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging AWS resources

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$

Value Length Constraints: Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

Response Syntax


{
   "deliveryDestination": { 
      "arn": "string",
      "deliveryDestinationConfiguration": { 
         "destinationResourceArn": "string"
      },
      "deliveryDestinationType": "string",
      "name": "string",
      "outputFormat": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

deliveryDestination

A structure containing information about the delivery destination that you just created or updated.

Type: DeliveryDestination object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

This operation attempted to create a resource that already exists.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ServiceQuotaExceededException

This request exceeds a service quota.

HTTP Status Code: 400

ServiceUnavailableException

The service cannot complete the request.

HTTP Status Code: 500

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 400

ValidationException

One of the parameters for the request is not valid.

HTTP Status Code: 400