@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS Elemental MediaConvert
@version 2017-08-29
@auth AWS SigV4
@endpoints 29
@hint download_for_search
@toc 2017-08-29(29)

@endpoint POST /2017-08-29/certificates
@required {Arn: str}

@endpoint DELETE /2017-08-29/jobs/{id}
@required {Id: str}

@endpoint POST /2017-08-29/jobs
@required {Role: str, Settings: JobSettings}
@optional {AccelerationSettings: AccelerationSettings, BillingTagsSource: str, ClientRequestToken: str, HopDestinations: [HopDestination], JobTemplate: str, Priority: int, Queue: str, SimulateReservedQueue: str, StatusUpdateInterval: str, Tags: map<str,str>, UserMetadata: map<str,str>}
@returns(200) {Job: Job?{AccelerationSettings: AccelerationSettings?{Mode: str}, AccelerationStatus: str?, Arn: str?, BillingTagsSource: str?, ClientRequestToken: str?, CreatedAt: str(timestamp)?, CurrentPhase: str?, ErrorCode: int?, ErrorMessage: str?, HopDestinations: [HopDestination]?, Id: str?, JobPercentComplete: int?, JobTemplate: str?, Messages: JobMessages?{Info: [str]?, Warning: [str]?}, OutputGroupDetails: [OutputGroupDetail]?, Priority: int?, Queue: str?, QueueTransitions: [QueueTransition]?, RetryCount: int?, Role: str, Settings: JobSettings{AdAvailOffset: int?, AvailBlanking: AvailBlanking?{AvailBlankingImage: str?}, ColorConversion3DLUTSettings: [ColorConversion3DLUTSetting]?, Esam: EsamSettings?{ManifestConfirmConditionNotification: EsamManifestConfirmConditionNotification?, ResponseSignalPreroll: int?, SignalProcessingNotification: EsamSignalProcessingNotification?}, ExtendedDataServices: ExtendedDataServices?{CopyProtectionAction: str?, VchipAction: str?}, FollowSource: int?, Inputs: [Input]?, KantarWatermark: KantarWatermarkSettings?{ChannelName: str?, ContentReference: str?, CredentialsSecretName: str?, FileOffset: num(f64)?, KantarLicenseId: int?, KantarServerUrl: str?, LogDestination: str?, Metadata3: str?, Metadata4: str?, Metadata5: str?, Metadata6: str?, Metadata7: str?, Metadata8: str?}, MotionImageInserter: MotionImageInserter?{Framerate: MotionImageInsertionFramerate?, Input: str?, InsertionMode: str?, Offset: MotionImageInsertionOffset?, Playback: str?, StartTime: str?}, NielsenConfiguration: NielsenConfiguration?{BreakoutCode: int?, DistributorId: str?}, NielsenNonLinearWatermark: NielsenNonLinearWatermarkSettings?{ActiveWatermarkProcess: str?, AdiFilename: str?, AssetId: str?, AssetName: str?, CbetSourceId: str?, EpisodeId: str?, MetadataDestination: str?, SourceId: int?, SourceWatermarkStatus: str?, TicServerUrl: str?, UniqueTicPerAudioTrack: str?}, OutputGroups: [OutputGroup]?, TimecodeConfig: TimecodeConfig?{Anchor: str?, Source: str?, Start: str?, TimestampOffset: str?}, TimedMetadataInsertion: TimedMetadataInsertion?{Id3Insertions: [Id3Insertion]?}}, SimulateReservedQueue: str?, Status: str?, StatusUpdateInterval: str?, Timing: Timing?{FinishTime: str(timestamp)?, StartTime: str(timestamp)?, SubmitTime: str(timestamp)?}, UserMetadata: map<str,str>?, Warnings: [WarningGroup]?}}

@endpoint POST /2017-08-29/jobTemplates
@required {Name: str, Settings: JobTemplateSettings}
@optional {AccelerationSettings: AccelerationSettings, Category: str, Description: str, HopDestinations: [HopDestination], Priority: int, Queue: str, StatusUpdateInterval: str, Tags: map<str,str>}
@returns(200) {JobTemplate: JobTemplate?{AccelerationSettings: AccelerationSettings?{Mode: str}, Arn: str?, Category: str?, CreatedAt: str(timestamp)?, Description: str?, HopDestinations: [HopDestination]?, LastUpdated: str(timestamp)?, Name: str, Priority: int?, Queue: str?, Settings: JobTemplateSettings{AdAvailOffset: int?, AvailBlanking: AvailBlanking?{AvailBlankingImage: str?}, ColorConversion3DLUTSettings: [ColorConversion3DLUTSetting]?, Esam: EsamSettings?{ManifestConfirmConditionNotification: EsamManifestConfirmConditionNotification?, ResponseSignalPreroll: int?, SignalProcessingNotification: EsamSignalProcessingNotification?}, ExtendedDataServices: ExtendedDataServices?{CopyProtectionAction: str?, VchipAction: str?}, FollowSource: int?, Inputs: [InputTemplate]?, KantarWatermark: KantarWatermarkSettings?{ChannelName: str?, ContentReference: str?, CredentialsSecretName: str?, FileOffset: num(f64)?, KantarLicenseId: int?, KantarServerUrl: str?, LogDestination: str?, Metadata3: str?, Metadata4: str?, Metadata5: str?, Metadata6: str?, Metadata7: str?, Metadata8: str?}, MotionImageInserter: MotionImageInserter?{Framerate: MotionImageInsertionFramerate?, Input: str?, InsertionMode: str?, Offset: MotionImageInsertionOffset?, Playback: str?, StartTime: str?}, NielsenConfiguration: NielsenConfiguration?{BreakoutCode: int?, DistributorId: str?}, NielsenNonLinearWatermark: NielsenNonLinearWatermarkSettings?{ActiveWatermarkProcess: str?, AdiFilename: str?, AssetId: str?, AssetName: str?, CbetSourceId: str?, EpisodeId: str?, MetadataDestination: str?, SourceId: int?, SourceWatermarkStatus: str?, TicServerUrl: str?, UniqueTicPerAudioTrack: str?}, OutputGroups: [OutputGroup]?, TimecodeConfig: TimecodeConfig?{Anchor: str?, Source: str?, Start: str?, TimestampOffset: str?}, TimedMetadataInsertion: TimedMetadataInsertion?{Id3Insertions: [Id3Insertion]?}}, StatusUpdateInterval: str?, Type: str?}}

@endpoint POST /2017-08-29/presets
@required {Name: str, Settings: PresetSettings}
@optional {Category: str, Description: str, Tags: map<str,str>}
@returns(200) {Preset: Preset?{Arn: str?, Category: str?, CreatedAt: str(timestamp)?, Description: str?, LastUpdated: str(timestamp)?, Name: str, Settings: PresetSettings{AudioDescriptions: [AudioDescription]?, CaptionDescriptions: [CaptionDescriptionPreset]?, ContainerSettings: ContainerSettings?{CmfcSettings: CmfcSettings?, Container: str?, F4vSettings: F4vSettings?, M2tsSettings: M2tsSettings?, M3u8Settings: M3u8Settings?, MovSettings: MovSettings?, Mp4Settings: Mp4Settings?, MpdSettings: MpdSettings?, MxfSettings: MxfSettings?}, VideoDescription: VideoDescription?{AfdSignaling: str?, AntiAlias: str?, CodecSettings: VideoCodecSettings?, ColorMetadata: str?, Crop: Rectangle?, DropFrameTimecode: str?, FixedAfd: int?, Height: int?, Position: Rectangle?, RespondToAfd: str?, ScalingBehavior: str?, Sharpness: int?, TimecodeInsertion: str?, VideoPreprocessors: VideoPreprocessor?, Width: int?}}, Type: str?}}

@endpoint POST /2017-08-29/queues
@required {Name: str}
@optional {Description: str, PricingPlan: str, ReservationPlanSettings: ReservationPlanSettings, Status: str, Tags: map<str,str>}
@returns(200) {Queue: Queue?{Arn: str?, CreatedAt: str(timestamp)?, Description: str?, LastUpdated: str(timestamp)?, Name: str, PricingPlan: str?, ProgressingJobsCount: int?, ReservationPlan: ReservationPlan?{Commitment: str?, ExpiresAt: str(timestamp)?, PurchasedAt: str(timestamp)?, RenewalType: str?, ReservedSlots: int?, Status: str?}, Status: str?, SubmittedJobsCount: int?, Type: str?}}

@endpoint DELETE /2017-08-29/jobTemplates/{name}
@required {Name: str}

@endpoint DELETE /2017-08-29/policy

@endpoint DELETE /2017-08-29/presets/{name}
@required {Name: str}

@endpoint DELETE /2017-08-29/queues/{name}
@required {Name: str}

@endpoint POST /2017-08-29/endpoints
@optional {MaxResults: int, Mode: str, NextToken: str}
@returns(200) {Endpoints: [Endpoint]?, NextToken: str?}

@endpoint DELETE /2017-08-29/certificates/{arn}
@required {Arn: str}

@endpoint GET /2017-08-29/jobs/{id}
@required {Id: str}
@returns(200) {Job: Job?{AccelerationSettings: AccelerationSettings?{Mode: str}, AccelerationStatus: str?, Arn: str?, BillingTagsSource: str?, ClientRequestToken: str?, CreatedAt: str(timestamp)?, CurrentPhase: str?, ErrorCode: int?, ErrorMessage: str?, HopDestinations: [HopDestination]?, Id: str?, JobPercentComplete: int?, JobTemplate: str?, Messages: JobMessages?{Info: [str]?, Warning: [str]?}, OutputGroupDetails: [OutputGroupDetail]?, Priority: int?, Queue: str?, QueueTransitions: [QueueTransition]?, RetryCount: int?, Role: str, Settings: JobSettings{AdAvailOffset: int?, AvailBlanking: AvailBlanking?{AvailBlankingImage: str?}, ColorConversion3DLUTSettings: [ColorConversion3DLUTSetting]?, Esam: EsamSettings?{ManifestConfirmConditionNotification: EsamManifestConfirmConditionNotification?, ResponseSignalPreroll: int?, SignalProcessingNotification: EsamSignalProcessingNotification?}, ExtendedDataServices: ExtendedDataServices?{CopyProtectionAction: str?, VchipAction: str?}, FollowSource: int?, Inputs: [Input]?, KantarWatermark: KantarWatermarkSettings?{ChannelName: str?, ContentReference: str?, CredentialsSecretName: str?, FileOffset: num(f64)?, KantarLicenseId: int?, KantarServerUrl: str?, LogDestination: str?, Metadata3: str?, Metadata4: str?, Metadata5: str?, Metadata6: str?, Metadata7: str?, Metadata8: str?}, MotionImageInserter: MotionImageInserter?{Framerate: MotionImageInsertionFramerate?, Input: str?, InsertionMode: str?, Offset: MotionImageInsertionOffset?, Playback: str?, StartTime: str?}, NielsenConfiguration: NielsenConfiguration?{BreakoutCode: int?, DistributorId: str?}, NielsenNonLinearWatermark: NielsenNonLinearWatermarkSettings?{ActiveWatermarkProcess: str?, AdiFilename: str?, AssetId: str?, AssetName: str?, CbetSourceId: str?, EpisodeId: str?, MetadataDestination: str?, SourceId: int?, SourceWatermarkStatus: str?, TicServerUrl: str?, UniqueTicPerAudioTrack: str?}, OutputGroups: [OutputGroup]?, TimecodeConfig: TimecodeConfig?{Anchor: str?, Source: str?, Start: str?, TimestampOffset: str?}, TimedMetadataInsertion: TimedMetadataInsertion?{Id3Insertions: [Id3Insertion]?}}, SimulateReservedQueue: str?, Status: str?, StatusUpdateInterval: str?, Timing: Timing?{FinishTime: str(timestamp)?, StartTime: str(timestamp)?, SubmitTime: str(timestamp)?}, UserMetadata: map<str,str>?, Warnings: [WarningGroup]?}}

@endpoint GET /2017-08-29/jobTemplates/{name}
@required {Name: str}
@returns(200) {JobTemplate: JobTemplate?{AccelerationSettings: AccelerationSettings?{Mode: str}, Arn: str?, Category: str?, CreatedAt: str(timestamp)?, Description: str?, HopDestinations: [HopDestination]?, LastUpdated: str(timestamp)?, Name: str, Priority: int?, Queue: str?, Settings: JobTemplateSettings{AdAvailOffset: int?, AvailBlanking: AvailBlanking?{AvailBlankingImage: str?}, ColorConversion3DLUTSettings: [ColorConversion3DLUTSetting]?, Esam: EsamSettings?{ManifestConfirmConditionNotification: EsamManifestConfirmConditionNotification?, ResponseSignalPreroll: int?, SignalProcessingNotification: EsamSignalProcessingNotification?}, ExtendedDataServices: ExtendedDataServices?{CopyProtectionAction: str?, VchipAction: str?}, FollowSource: int?, Inputs: [InputTemplate]?, KantarWatermark: KantarWatermarkSettings?{ChannelName: str?, ContentReference: str?, CredentialsSecretName: str?, FileOffset: num(f64)?, KantarLicenseId: int?, KantarServerUrl: str?, LogDestination: str?, Metadata3: str?, Metadata4: str?, Metadata5: str?, Metadata6: str?, Metadata7: str?, Metadata8: str?}, MotionImageInserter: MotionImageInserter?{Framerate: MotionImageInsertionFramerate?, Input: str?, InsertionMode: str?, Offset: MotionImageInsertionOffset?, Playback: str?, StartTime: str?}, NielsenConfiguration: NielsenConfiguration?{BreakoutCode: int?, DistributorId: str?}, NielsenNonLinearWatermark: NielsenNonLinearWatermarkSettings?{ActiveWatermarkProcess: str?, AdiFilename: str?, AssetId: str?, AssetName: str?, CbetSourceId: str?, EpisodeId: str?, MetadataDestination: str?, SourceId: int?, SourceWatermarkStatus: str?, TicServerUrl: str?, UniqueTicPerAudioTrack: str?}, OutputGroups: [OutputGroup]?, TimecodeConfig: TimecodeConfig?{Anchor: str?, Source: str?, Start: str?, TimestampOffset: str?}, TimedMetadataInsertion: TimedMetadataInsertion?{Id3Insertions: [Id3Insertion]?}}, StatusUpdateInterval: str?, Type: str?}}

@endpoint GET /2017-08-29/policy
@returns(200) {Policy: Policy?{HttpInputs: str?, HttpsInputs: str?, S3Inputs: str?}}

@endpoint GET /2017-08-29/presets/{name}
@required {Name: str}
@returns(200) {Preset: Preset?{Arn: str?, Category: str?, CreatedAt: str(timestamp)?, Description: str?, LastUpdated: str(timestamp)?, Name: str, Settings: PresetSettings{AudioDescriptions: [AudioDescription]?, CaptionDescriptions: [CaptionDescriptionPreset]?, ContainerSettings: ContainerSettings?{CmfcSettings: CmfcSettings?, Container: str?, F4vSettings: F4vSettings?, M2tsSettings: M2tsSettings?, M3u8Settings: M3u8Settings?, MovSettings: MovSettings?, Mp4Settings: Mp4Settings?, MpdSettings: MpdSettings?, MxfSettings: MxfSettings?}, VideoDescription: VideoDescription?{AfdSignaling: str?, AntiAlias: str?, CodecSettings: VideoCodecSettings?, ColorMetadata: str?, Crop: Rectangle?, DropFrameTimecode: str?, FixedAfd: int?, Height: int?, Position: Rectangle?, RespondToAfd: str?, ScalingBehavior: str?, Sharpness: int?, TimecodeInsertion: str?, VideoPreprocessors: VideoPreprocessor?, Width: int?}}, Type: str?}}

@endpoint GET /2017-08-29/queues/{name}
@required {Name: str}
@returns(200) {Queue: Queue?{Arn: str?, CreatedAt: str(timestamp)?, Description: str?, LastUpdated: str(timestamp)?, Name: str, PricingPlan: str?, ProgressingJobsCount: int?, ReservationPlan: ReservationPlan?{Commitment: str?, ExpiresAt: str(timestamp)?, PurchasedAt: str(timestamp)?, RenewalType: str?, ReservedSlots: int?, Status: str?}, Status: str?, SubmittedJobsCount: int?, Type: str?}}

@endpoint GET /2017-08-29/jobTemplates
@optional {category: str, listBy: str, maxResults: int, nextToken: str, order: str}
@returns(200) {JobTemplates: [JobTemplate]?, NextToken: str?}

@endpoint GET /2017-08-29/jobs
@optional {maxResults: int, nextToken: str, order: str, queue: str, status: str}
@returns(200) {Jobs: [Job]?, NextToken: str?}

@endpoint GET /2017-08-29/presets
@optional {category: str, listBy: str, maxResults: int, nextToken: str, order: str}
@returns(200) {NextToken: str?, Presets: [Preset]?}

@endpoint GET /2017-08-29/queues
@optional {listBy: str, maxResults: int, nextToken: str, order: str}
@returns(200) {NextToken: str?, Queues: [Queue]?}

@endpoint GET /2017-08-29/tags/{arn}
@required {Arn: str}
@returns(200) {ResourceTags: ResourceTags?{Arn: str?, Tags: map<str,str>?}}

@endpoint PUT /2017-08-29/policy
@required {Policy: Policy}
@returns(200) {Policy: Policy?{HttpInputs: str?, HttpsInputs: str?, S3Inputs: str?}}

@endpoint GET /2017-08-29/search
@optional {inputFile: str, maxResults: int, nextToken: str, order: str, queue: str, status: str}
@returns(200) {Jobs: [Job]?, NextToken: str?}

@endpoint POST /2017-08-29/tags
@required {Arn: str, Tags: map<str,str>}

@endpoint PUT /2017-08-29/tags/{arn}
@required {Arn: str}
@optional {TagKeys: [str]}

@endpoint PUT /2017-08-29/jobTemplates/{name}
@required {Name: str}
@optional {AccelerationSettings: AccelerationSettings, Category: str, Description: str, HopDestinations: [HopDestination], Priority: int, Queue: str, Settings: JobTemplateSettings, StatusUpdateInterval: str}
@returns(200) {JobTemplate: JobTemplate?{AccelerationSettings: AccelerationSettings?{Mode: str}, Arn: str?, Category: str?, CreatedAt: str(timestamp)?, Description: str?, HopDestinations: [HopDestination]?, LastUpdated: str(timestamp)?, Name: str, Priority: int?, Queue: str?, Settings: JobTemplateSettings{AdAvailOffset: int?, AvailBlanking: AvailBlanking?{AvailBlankingImage: str?}, ColorConversion3DLUTSettings: [ColorConversion3DLUTSetting]?, Esam: EsamSettings?{ManifestConfirmConditionNotification: EsamManifestConfirmConditionNotification?, ResponseSignalPreroll: int?, SignalProcessingNotification: EsamSignalProcessingNotification?}, ExtendedDataServices: ExtendedDataServices?{CopyProtectionAction: str?, VchipAction: str?}, FollowSource: int?, Inputs: [InputTemplate]?, KantarWatermark: KantarWatermarkSettings?{ChannelName: str?, ContentReference: str?, CredentialsSecretName: str?, FileOffset: num(f64)?, KantarLicenseId: int?, KantarServerUrl: str?, LogDestination: str?, Metadata3: str?, Metadata4: str?, Metadata5: str?, Metadata6: str?, Metadata7: str?, Metadata8: str?}, MotionImageInserter: MotionImageInserter?{Framerate: MotionImageInsertionFramerate?, Input: str?, InsertionMode: str?, Offset: MotionImageInsertionOffset?, Playback: str?, StartTime: str?}, NielsenConfiguration: NielsenConfiguration?{BreakoutCode: int?, DistributorId: str?}, NielsenNonLinearWatermark: NielsenNonLinearWatermarkSettings?{ActiveWatermarkProcess: str?, AdiFilename: str?, AssetId: str?, AssetName: str?, CbetSourceId: str?, EpisodeId: str?, MetadataDestination: str?, SourceId: int?, SourceWatermarkStatus: str?, TicServerUrl: str?, UniqueTicPerAudioTrack: str?}, OutputGroups: [OutputGroup]?, TimecodeConfig: TimecodeConfig?{Anchor: str?, Source: str?, Start: str?, TimestampOffset: str?}, TimedMetadataInsertion: TimedMetadataInsertion?{Id3Insertions: [Id3Insertion]?}}, StatusUpdateInterval: str?, Type: str?}}

@endpoint PUT /2017-08-29/presets/{name}
@required {Name: str}
@optional {Category: str, Description: str, Settings: PresetSettings}
@returns(200) {Preset: Preset?{Arn: str?, Category: str?, CreatedAt: str(timestamp)?, Description: str?, LastUpdated: str(timestamp)?, Name: str, Settings: PresetSettings{AudioDescriptions: [AudioDescription]?, CaptionDescriptions: [CaptionDescriptionPreset]?, ContainerSettings: ContainerSettings?{CmfcSettings: CmfcSettings?, Container: str?, F4vSettings: F4vSettings?, M2tsSettings: M2tsSettings?, M3u8Settings: M3u8Settings?, MovSettings: MovSettings?, Mp4Settings: Mp4Settings?, MpdSettings: MpdSettings?, MxfSettings: MxfSettings?}, VideoDescription: VideoDescription?{AfdSignaling: str?, AntiAlias: str?, CodecSettings: VideoCodecSettings?, ColorMetadata: str?, Crop: Rectangle?, DropFrameTimecode: str?, FixedAfd: int?, Height: int?, Position: Rectangle?, RespondToAfd: str?, ScalingBehavior: str?, Sharpness: int?, TimecodeInsertion: str?, VideoPreprocessors: VideoPreprocessor?, Width: int?}}, Type: str?}}

@endpoint PUT /2017-08-29/queues/{name}
@required {Name: str}
@optional {Description: str, ReservationPlanSettings: ReservationPlanSettings, Status: str}
@returns(200) {Queue: Queue?{Arn: str?, CreatedAt: str(timestamp)?, Description: str?, LastUpdated: str(timestamp)?, Name: str, PricingPlan: str?, ProgressingJobsCount: int?, ReservationPlan: ReservationPlan?{Commitment: str?, ExpiresAt: str(timestamp)?, PurchasedAt: str(timestamp)?, RenewalType: str?, ReservedSlots: int?, Status: str?}, Status: str?, SubmittedJobsCount: int?, Type: str?}}

@end