AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Returns complete information about one logical delivery . A delivery is a connection between a ` delivery source https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html`__ and a ` delivery destination https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html`__ .
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.
See also: AWS API Documentation
get-delivery
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--id
(string)
The ID of the delivery that you want to retrieve.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
delivery -> (structure)
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 Firehose.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 inPlain
,W3C
, orRaw
format.s3DeliveryConfiguration -> (structure)
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 will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.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 -> (map)
The tags that have been assigned to this delivery.
key -> (string)
value -> (string)