/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ElasticTranscoder::CreateJob

NAME

Paws::ElasticTranscoder::CreateJob - Arguments for method CreateJob on Paws::ElasticTranscoder

DESCRIPTION

This class represents the parameters used for calling the method CreateJob on the Amazon Elastic Transcoder service. Use the attributes of this class as arguments to method CreateJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateJob.

SYNOPSIS


            

              
              
my $elastictranscoder = Paws->service('ElasticTranscoder');
my $CreateJobResponse = $elastictranscoder->CreateJob(
  PipelineId => 'MyId',
  Input      => {
    AspectRatio        => 'MyAspectRatio',     # OPTIONAL
    Container          => 'MyJobContainer',    # OPTIONAL
    DetectedProperties => {
      DurationMillis => 1,                     # OPTIONAL
      FileSize       => 1,                     # OPTIONAL
      FrameRate      => 'MyFloatString',       # OPTIONAL
      Height         => 1,                     # OPTIONAL
      Width          => 1,                     # OPTIONAL
    },    # OPTIONAL
    Encryption => {
      InitializationVector => 'MyZeroTo255String',      # max: 255; OPTIONAL
      Key                  => 'MyBase64EncodedString',  # OPTIONAL
      KeyMd5               => 'MyBase64EncodedString',  # OPTIONAL
      Mode                 => 'MyEncryptionMode',       # OPTIONAL
    },    # OPTIONAL
    FrameRate     => 'MyFrameRate',    # OPTIONAL
    InputCaptions => {
      CaptionSources => [
        {
          Encryption => {
            InitializationVector =>
              'MyZeroTo255String',    # max: 255; OPTIONAL
            Key    => 'MyBase64EncodedString',    # OPTIONAL
            KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
            Mode   => 'MyEncryptionMode',         # OPTIONAL
          },    # OPTIONAL
          Key        => 'MyLongKey',       # min: 1, max: 1024; OPTIONAL
          Label      => 'MyName',          # min: 1, max: 40; OPTIONAL
          Language   => 'MyKey',           # min: 1, max: 255; OPTIONAL
          TimeOffset => 'MyTimeOffset',    # OPTIONAL
        },
        ...
      ],    # max: 20; OPTIONAL
      MergePolicy => 'MyCaptionMergePolicy',    # OPTIONAL
    },    # OPTIONAL
    Interlaced => 'MyInterlaced',    # OPTIONAL
    Key        => 'MyLongKey',       # min: 1, max: 1024; OPTIONAL
    Resolution => 'MyResolution',    # OPTIONAL
    TimeSpan   => {
      Duration  => 'MyTime',         # OPTIONAL
      StartTime => 'MyTime',         # OPTIONAL
    },    # OPTIONAL
  },    # OPTIONAL
  Inputs => [
    {
      AspectRatio        => 'MyAspectRatio',     # OPTIONAL
      Container          => 'MyJobContainer',    # OPTIONAL
      DetectedProperties => {
        DurationMillis => 1,                     # OPTIONAL
        FileSize       => 1,                     # OPTIONAL
        FrameRate      => 'MyFloatString',       # OPTIONAL
        Height         => 1,                     # OPTIONAL
        Width          => 1,                     # OPTIONAL
      },    # OPTIONAL
      Encryption => {
        InitializationVector => 'MyZeroTo255String',    # max: 255; OPTIONAL
        Key                  => 'MyBase64EncodedString',    # OPTIONAL
        KeyMd5               => 'MyBase64EncodedString',    # OPTIONAL
        Mode                 => 'MyEncryptionMode',         # OPTIONAL
      },    # OPTIONAL
      FrameRate     => 'MyFrameRate',    # OPTIONAL
      InputCaptions => {
        CaptionSources => [
          {
            Encryption => {
              InitializationVector =>
                'MyZeroTo255String',    # max: 255; OPTIONAL
              Key    => 'MyBase64EncodedString',    # OPTIONAL
              KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
              Mode   => 'MyEncryptionMode',         # OPTIONAL
            },    # OPTIONAL
            Key        => 'MyLongKey',       # min: 1, max: 1024; OPTIONAL
            Label      => 'MyName',          # min: 1, max: 40; OPTIONAL
            Language   => 'MyKey',           # min: 1, max: 255; OPTIONAL
            TimeOffset => 'MyTimeOffset',    # OPTIONAL
          },
          ...
        ],    # max: 20; OPTIONAL
        MergePolicy => 'MyCaptionMergePolicy',    # OPTIONAL
      },    # OPTIONAL
      Interlaced => 'MyInterlaced',    # OPTIONAL
      Key        => 'MyLongKey',       # min: 1, max: 1024; OPTIONAL
      Resolution => 'MyResolution',    # OPTIONAL
      TimeSpan   => {
        Duration  => 'MyTime',         # OPTIONAL
        StartTime => 'MyTime',         # OPTIONAL
      },    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  Output => {
    AlbumArt => {
      Artwork => [
        {
          AlbumArtFormat => 'MyJpgOrPng',    # OPTIONAL
          Encryption     => {
            InitializationVector =>
              'MyZeroTo255String',           # max: 255; OPTIONAL
            Key    => 'MyBase64EncodedString',    # OPTIONAL
            KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
            Mode   => 'MyEncryptionMode',         # OPTIONAL
          },    # OPTIONAL
          InputKey      => 'MyWatermarkKey',   # min: 1, max: 1024; OPTIONAL
          MaxHeight     => 'MyDigitsOrAuto',   # OPTIONAL
          MaxWidth      => 'MyDigitsOrAuto',   # OPTIONAL
          PaddingPolicy => 'MyPaddingPolicy',  # OPTIONAL
          SizingPolicy  => 'MySizingPolicy',   # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      MergePolicy => 'MyMergePolicy',    # OPTIONAL
    },    # OPTIONAL
    Captions => {
      CaptionFormats => [
        {
          Encryption => {
            InitializationVector =>
              'MyZeroTo255String',    # max: 255; OPTIONAL
            Key    => 'MyBase64EncodedString',    # OPTIONAL
            KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
            Mode   => 'MyEncryptionMode',         # OPTIONAL
          },    # OPTIONAL
          Format  => 'MyCaptionFormatFormat',     # OPTIONAL
          Pattern => 'MyCaptionFormatPattern',    # OPTIONAL
        },
        ...
      ],    # max: 4; OPTIONAL
      CaptionSources => [
        {
          Encryption => {
            InitializationVector =>
              'MyZeroTo255String',    # max: 255; OPTIONAL
            Key    => 'MyBase64EncodedString',    # OPTIONAL
            KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
            Mode   => 'MyEncryptionMode',         # OPTIONAL
          },    # OPTIONAL
          Key        => 'MyLongKey',       # min: 1, max: 1024; OPTIONAL
          Label      => 'MyName',          # min: 1, max: 40; OPTIONAL
          Language   => 'MyKey',           # min: 1, max: 255; OPTIONAL
          TimeOffset => 'MyTimeOffset',    # OPTIONAL
        },
        ...
      ],    # max: 20; OPTIONAL
      MergePolicy => 'MyCaptionMergePolicy',    # OPTIONAL
    },    # OPTIONAL
    Composition => [
      {
        TimeSpan => {
          Duration  => 'MyTime',    # OPTIONAL
          StartTime => 'MyTime',    # OPTIONAL
        },    # OPTIONAL
      },
      ...
    ],    # OPTIONAL
    Encryption => {
      InitializationVector => 'MyZeroTo255String',      # max: 255; OPTIONAL
      Key                  => 'MyBase64EncodedString',  # OPTIONAL
      KeyMd5               => 'MyBase64EncodedString',  # OPTIONAL
      Mode                 => 'MyEncryptionMode',       # OPTIONAL
    },    # OPTIONAL
    Key                 => 'MyKey',            # min: 1, max: 255; OPTIONAL
    PresetId            => 'MyId',
    Rotate              => 'MyRotate',         # OPTIONAL
    SegmentDuration     => 'MyFloatString',    # OPTIONAL
    ThumbnailEncryption => {
      InitializationVector => 'MyZeroTo255String',      # max: 255; OPTIONAL
      Key                  => 'MyBase64EncodedString',  # OPTIONAL
      KeyMd5               => 'MyBase64EncodedString',  # OPTIONAL
      Mode                 => 'MyEncryptionMode',       # OPTIONAL
    },    # OPTIONAL
    ThumbnailPattern => 'MyThumbnailPattern',    # OPTIONAL
    Watermarks       => [
      {
        Encryption => {
          InitializationVector => 'MyZeroTo255String',  # max: 255; OPTIONAL
          Key                  => 'MyBase64EncodedString',    # OPTIONAL
          KeyMd5               => 'MyBase64EncodedString',    # OPTIONAL
          Mode                 => 'MyEncryptionMode',         # OPTIONAL
        },    # OPTIONAL
        InputKey          => 'MyWatermarkKey', # min: 1, max: 1024; OPTIONAL
        PresetWatermarkId =>
          'MyPresetWatermarkId',               # min: 1, max: 40; OPTIONAL
      },
      ...
    ],    # OPTIONAL
  },    # OPTIONAL
  OutputKeyPrefix => 'MyKey',    # OPTIONAL
  Outputs         => [
    {
      AlbumArt => {
        Artwork => [
          {
            AlbumArtFormat => 'MyJpgOrPng',    # OPTIONAL
            Encryption     => {
              InitializationVector =>
                'MyZeroTo255String',           # max: 255; OPTIONAL
              Key    => 'MyBase64EncodedString',    # OPTIONAL
              KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
              Mode   => 'MyEncryptionMode',         # OPTIONAL
            },    # OPTIONAL
            InputKey      => 'MyWatermarkKey', # min: 1, max: 1024; OPTIONAL
            MaxHeight     => 'MyDigitsOrAuto', # OPTIONAL
            MaxWidth      => 'MyDigitsOrAuto', # OPTIONAL
            PaddingPolicy => 'MyPaddingPolicy',    # OPTIONAL
            SizingPolicy  => 'MySizingPolicy',     # OPTIONAL
          },
          ...
        ],    # OPTIONAL
        MergePolicy => 'MyMergePolicy',    # OPTIONAL
      },    # OPTIONAL
      Captions => {
        CaptionFormats => [
          {
            Encryption => {
              InitializationVector =>
                'MyZeroTo255String',    # max: 255; OPTIONAL
              Key    => 'MyBase64EncodedString',    # OPTIONAL
              KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
              Mode   => 'MyEncryptionMode',         # OPTIONAL
            },    # OPTIONAL
            Format  => 'MyCaptionFormatFormat',     # OPTIONAL
            Pattern => 'MyCaptionFormatPattern',    # OPTIONAL
          },
          ...
        ],    # max: 4; OPTIONAL
        CaptionSources => [
          {
            Encryption => {
              InitializationVector =>
                'MyZeroTo255String',    # max: 255; OPTIONAL
              Key    => 'MyBase64EncodedString',    # OPTIONAL
              KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
              Mode   => 'MyEncryptionMode',         # OPTIONAL
            },    # OPTIONAL
            Key        => 'MyLongKey',       # min: 1, max: 1024; OPTIONAL
            Label      => 'MyName',          # min: 1, max: 40; OPTIONAL
            Language   => 'MyKey',           # min: 1, max: 255; OPTIONAL
            TimeOffset => 'MyTimeOffset',    # OPTIONAL
          },
          ...
        ],    # max: 20; OPTIONAL
        MergePolicy => 'MyCaptionMergePolicy',    # OPTIONAL
      },    # OPTIONAL
      Composition => [
        {
          TimeSpan => {
            Duration  => 'MyTime',    # OPTIONAL
            StartTime => 'MyTime',    # OPTIONAL
          },    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      Encryption => {
        InitializationVector => 'MyZeroTo255String',    # max: 255; OPTIONAL
        Key                  => 'MyBase64EncodedString',    # OPTIONAL
        KeyMd5               => 'MyBase64EncodedString',    # OPTIONAL
        Mode                 => 'MyEncryptionMode',         # OPTIONAL
      },    # OPTIONAL
      Key                 => 'MyKey',           # min: 1, max: 255; OPTIONAL
      PresetId            => 'MyId',
      Rotate              => 'MyRotate',        # OPTIONAL
      SegmentDuration     => 'MyFloatString',   # OPTIONAL
      ThumbnailEncryption => {
        InitializationVector => 'MyZeroTo255String',    # max: 255; OPTIONAL
        Key                  => 'MyBase64EncodedString',    # OPTIONAL
        KeyMd5               => 'MyBase64EncodedString',    # OPTIONAL
        Mode                 => 'MyEncryptionMode',         # OPTIONAL
      },    # OPTIONAL
      ThumbnailPattern => 'MyThumbnailPattern',    # OPTIONAL
      Watermarks       => [
        {
          Encryption => {
            InitializationVector =>
              'MyZeroTo255String',    # max: 255; OPTIONAL
            Key    => 'MyBase64EncodedString',    # OPTIONAL
            KeyMd5 => 'MyBase64EncodedString',    # OPTIONAL
            Mode   => 'MyEncryptionMode',         # OPTIONAL
          },    # OPTIONAL
          InputKey => 'MyWatermarkKey',    # min: 1, max: 1024; OPTIONAL
          PresetWatermarkId =>
            'MyPresetWatermarkId',         # min: 1, max: 40; OPTIONAL
        },
        ...
      ],    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  Playlists => [
    {
      Format               => 'MyPlaylistFormat',    # OPTIONAL
      HlsContentProtection => {
        InitializationVector  => 'MyZeroTo255String',   # max: 255; OPTIONAL
        Key                   => 'MyBase64EncodedString',    # OPTIONAL
        KeyMd5                => 'MyBase64EncodedString',    # OPTIONAL
        KeyStoragePolicy      => 'MyKeyStoragePolicy',       # OPTIONAL
        LicenseAcquisitionUrl => 'MyZeroTo512String',   # max: 512; OPTIONAL
        Method                => 'MyHlsContentProtectionMethod',  # OPTIONAL
      },    # OPTIONAL
      Name       => 'MyFilename',    # min: 1, max: 255; OPTIONAL
      OutputKeys => [
        'MyKey', ...                 # min: 1, max: 255; OPTIONAL
      ],    # max: 30; OPTIONAL
      PlayReadyDrm => {
        Format                => 'MyPlayReadyDrmFormatString',    # OPTIONAL
        InitializationVector  => 'MyZeroTo255String',   # max: 255; OPTIONAL
        Key                   => 'MyNonEmptyBase64EncodedString', # OPTIONAL
        KeyId                 => 'MyKeyIdGuid',                   # OPTIONAL
        KeyMd5                => 'MyNonEmptyBase64EncodedString', # OPTIONAL
        LicenseAcquisitionUrl =>
          'MyOneTo512String',    # min: 1, max: 512; OPTIONAL
      },    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  UserMetadata => { 'MyString' => 'MyString', },    # OPTIONAL
);
# Results:
my $Job = $CreateJobResponse->Job;
# Returns a L<Paws::ElasticTranscoder::CreateJobResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/elastictranscoder/CreateJob

ATTRIBUTES

Input => Paws::ElasticTranscoder::JobInput

A section of the request body that provides information about the file that is being transcoded.

Inputs => ArrayRef[Paws::ElasticTranscoder::JobInput]

A section of the request body that provides information about the files that are being transcoded.

Output => Paws::ElasticTranscoder::CreateJobOutput

A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax.

OutputKeyPrefix => Str

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

Outputs => ArrayRef[Paws::ElasticTranscoder::CreateJobOutput]

A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

REQUIRED PipelineId => Str

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

Playlists => ArrayRef[Paws::ElasticTranscoder::CreateJobPlaylist]

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

UserMetadata => Paws::ElasticTranscoder::UserMetadata

User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateJob in Paws::ElasticTranscoder

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues