[ aws . mediaconvert ]

probe

Description

The Probe operation analyzes the provided media file and returns comprehensive metadata about its container format, tracks, and any encountered errors.

See also: AWS API Documentation

Synopsis

  probe
[--input-files <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--input-files (list) The list of input media files to be probed.(structure)

The input file that needs to be analyzed.

FileUrl -> (string)

The URI to your input file(s) that is stored in Amazon S3 or on an HTTP(S) server.

Shorthand Syntax:

FileUrl=string ...

JSON Syntax:

[
  {
    "FileUrl": "string"
  }
  ...
]

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

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

• json
• text
• table
• yaml
• yaml-stream

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

• on
• off
• auto

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ProbeResults -> (list)

List of probe results for the input media file(s).

(structure)

The metadata and analysis results for a media file.

Container -> (structure)

Information about the container format of the media file.

Duration -> (double)

The duration of the media file in seconds.

Format -> (string)

The format of the container

Tracks -> (list)

List of Track objects.

(structure)

The track information such as codec, duration, etc.

AudioProperties -> (structure)

Properties specific to audio tracks.

BitDepth -> (integer)

The bit depth of the audio track.

BitRate -> (integer)

The bit rate of the audio track in bits per second.

Channels -> (integer)

The number of audio channels.

FrameRate -> (structure)

the calculated frame rate of the asset.

Denominator -> (integer)

the denominator of the frame rate of the asset.

Numerator -> (integer)

the numerator of the frame rate of the asset.

LanguageCode -> (string)

the language code of the track

SampleRate -> (integer)

The sample rate of the audio track.

Codec -> (string)

The codec used for the track.

DataProperties -> (structure)

Properties specific to data tracks.

LanguageCode -> (string)

the language code of the track

Duration -> (double)

The duration of the track in seconds.

Index -> (integer)

The index of the track.

TrackType -> (string)

The type of the track (video, audio, or data).

VideoProperties -> (structure)

Properties specific to video tracks.

BitDepth -> (integer)

The bit depth of the video track.

BitRate -> (integer)

The bit rate of the video track in bits per second.

ColorPrimaries -> (string)

the color primaries.

FrameRate -> (structure)

the calculated frame rate of the asset.

Denominator -> (integer)

the denominator of the frame rate of the asset.

Numerator -> (integer)

the numerator of the frame rate of the asset.

Height -> (integer)

The height of the video track in pixels.

MatrixCoefficients -> (string)

the matrix coefficients.

TransferCharacteristics -> (string)

the transfer characteristics.

Width -> (integer)

The width of the video track in pixels.

Metadata -> (structure)

Metadata about the file.

ETag -> (string)

The ETag of the file.

FileSize -> (long)

The size of the file in bytes.

LastModified -> (timestamp)

The last modification time of the file.

MimeType -> (string)

The MIME type of the file.

TrackMappings -> (list)

List of Track mapping objects.

(structure)

Track mapping information.

AudioTrackIndexes -> (list)

The indexes of the audio tracks.

(integer)

DataTrackIndexes -> (list)

The indexes of the data tracks.

(integer)

VideoTrackIndexes -> (list)

The indexes of the video tracks.

(integer)