describe-archive¶
Description¶
Retrieves details about an archive.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-archive
--archive-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--archive-name (string)
The name of the archive to retrieve.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
ArchiveArn -> (string)
The ARN of the archive.
ArchiveName -> (string)
The name of the archive.
EventSourceArn -> (string)
The ARN of the event source associated with the archive.
Description -> (string)
The description of the archive.
EventPattern -> (string)
The event pattern used to filter events sent to the archive.
State -> (string)
The state of the archive.
StateReason -> (string)
The reason that the archive is in the state.
RetentionDays -> (integer)
The number of days to retain events for in the archive.
SizeBytes -> (long)
The size of the archive in bytes.
EventCount -> (long)
The number of events in the archive.
CreationTime -> (timestamp)
The time at which the archive was created.