[ aws . mediapackagev2 ]

create-harvest-job

Description

Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.

See also: AWS API Documentation

Synopsis

  create-harvest-job
--channel-group-name <value>
--channel-name <value>
--origin-endpoint-name <value>
[--description <value>]
--harvested-manifests <value>
--schedule-configuration <value>
--destination <value>
[--client-token <value>]
[--harvest-job-name <value>]
[--tags <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

--channel-group-name (string)

The name of the channel group containing the channel from which to harvest content.

--channel-name (string)

The name of the channel from which to harvest content.

--origin-endpoint-name (string)

The name of the origin endpoint from which to harvest content.

--description (string)

An optional description for the harvest job.

--harvested-manifests (structure)

A list of manifests to be harvested.

HlsManifests -> (list)

A list of harvested HLS manifests.

(structure)

Information about a harvested HLS manifest.

ManifestName -> (string)

The name of the harvested HLS manifest.

DashManifests -> (list)

A list of harvested DASH manifests.

(structure)

Information about a harvested DASH manifest.

ManifestName -> (string)

The name of the harvested DASH manifest.

LowLatencyHlsManifests -> (list)

A list of harvested Low-Latency HLS manifests.

(structure)

Information about a harvested Low-Latency HLS manifest.

ManifestName -> (string)

The name of the harvested Low-Latency HLS manifest.

Shorthand Syntax:

HlsManifests=[{ManifestName=string},{ManifestName=string}],DashManifests=[{ManifestName=string},{ManifestName=string}],LowLatencyHlsManifests=[{ManifestName=string},{ManifestName=string}]

JSON Syntax:

{
  "HlsManifests": [
    {
      "ManifestName": "string"
    }
    ...
  ],
  "DashManifests": [
    {
      "ManifestName": "string"
    }
    ...
  ],
  "LowLatencyHlsManifests": [
    {
      "ManifestName": "string"
    }
    ...
  ]
}

--schedule-configuration (structure)

The configuration for when the harvest job should run, including start and end times.

StartTime -> (timestamp)

The start time for the harvest job.

EndTime -> (timestamp)

The end time for the harvest job.

Shorthand Syntax:

StartTime=timestamp,EndTime=timestamp

JSON Syntax:

{
  "StartTime": timestamp,
  "EndTime": timestamp
}

--destination (structure)

The S3 destination where the harvested content will be placed.

S3Destination -> (structure)

The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket.

BucketName -> (string)

The name of an S3 bucket within which harvested content will be exported.

DestinationPath -> (string)

The path within the specified S3 bucket where the harvested content will be placed.

Shorthand Syntax:

S3Destination={BucketName=string,DestinationPath=string}

JSON Syntax:

{
  "S3Destination": {
    "BucketName": "string",
    "DestinationPath": "string"
  }
}

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--harvest-job-name (string)

A name for the harvest job. This name must be unique within the channel.

--tags (map)

A collection of tags associated with the harvest job.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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

ChannelGroupName -> (string)

The name of the channel group containing the channel from which content is being harvested.

ChannelName -> (string)

The name of the channel from which content is being harvested.

OriginEndpointName -> (string)

The name of the origin endpoint from which content is being harvested.

Destination -> (structure)

The S3 destination where the harvested content will be placed.

S3Destination -> (structure)

The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket.

BucketName -> (string)

The name of an S3 bucket within which harvested content will be exported.

DestinationPath -> (string)

The path within the specified S3 bucket where the harvested content will be placed.

HarvestJobName -> (string)

The name of the created harvest job.

HarvestedManifests -> (structure)

A list of manifests that will be harvested.

HlsManifests -> (list)

A list of harvested HLS manifests.

(structure)

Information about a harvested HLS manifest.

ManifestName -> (string)

The name of the harvested HLS manifest.

DashManifests -> (list)

A list of harvested DASH manifests.

(structure)

Information about a harvested DASH manifest.

ManifestName -> (string)

The name of the harvested DASH manifest.

LowLatencyHlsManifests -> (list)

A list of harvested Low-Latency HLS manifests.

(structure)

Information about a harvested Low-Latency HLS manifest.

ManifestName -> (string)

The name of the harvested Low-Latency HLS manifest.

Description -> (string)

The description of the harvest job, if provided.

ScheduleConfiguration -> (structure)

The configuration for when the harvest job will run, including start and end times.

StartTime -> (timestamp)

The start time for the harvest job.

EndTime -> (timestamp)

The end time for the harvest job.

Arn -> (string)

The Amazon Resource Name (ARN) of the created harvest job.

CreatedAt -> (timestamp)

The date and time the harvest job was created.

ModifiedAt -> (timestamp)

The date and time the harvest job was last modified.

Status -> (string)

The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).

ErrorMessage -> (string)

An error message if the harvest job creation failed.

ETag -> (string)

The current version of the harvest job. Used for concurrency control.

Tags -> (map)

A collection of tags associated with the harvest job.

key -> (string)

value -> (string)