GetDeliveryCommand

Suggest an Edit

Returns complete information about one logical delivery. 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, or Firehose. 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. 

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CloudWatchLogsClient, GetDeliveryCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
// const { CloudWatchLogsClient, GetDeliveryCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
const client = new CloudWatchLogsClient(config);
const input = { // GetDeliveryRequest
  id: "STRING_VALUE", // required
};
const command = new GetDeliveryCommand(input);
const response = await client.send(command);
// { // GetDeliveryResponse
//   delivery: { // Delivery
//     id: "STRING_VALUE",
//     arn: "STRING_VALUE",
//     deliverySourceName: "STRING_VALUE",
//     deliveryDestinationArn: "STRING_VALUE",
//     deliveryDestinationType: "S3" || "CWL" || "FH",
//     recordFields: [ // RecordFields
//       "STRING_VALUE",
//     ],
//     fieldDelimiter: "STRING_VALUE",
//     s3DeliveryConfiguration: { // S3DeliveryConfiguration
//       suffixPath: "STRING_VALUE",
//       enableHiveCompatiblePath: true || false,
//     },
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//   },
// };

GetDeliveryCommand Input

See GetDeliveryCommandInput for more details

Parameter
Type
Description
id
Required
string | undefined

The ID of the delivery that you want to retrieve.

GetDeliveryCommand Output

See GetDeliveryCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
delivery
Delivery | undefined

A structure that contains information about the delivery.

Throws

Name
Fault
Details
ResourceNotFoundException
client

The specified resource does not exist.

ServiceQuotaExceededException
client

This request exceeds a service quota.

ServiceUnavailableException
server

The service cannot complete the request.

ThrottlingException
client

The request was throttled because of quota limits.

ValidationException
client

One of the parameters for the request is not valid.

CloudWatchLogsServiceException
Base exception class for all service exceptions from CloudWatchLogs service.