{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-mediapackage","description":"AWS Elemental MediaPackage","version":"2017-10-12","base_url":"","endpoints":19,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS Elemental MediaPackage\n@version 2017-10-12\n@auth AWS SigV4\n@endpoints 19\n@toc channels(8), harvest_jobs(3), origin_endpoints(5), tags(3)\n\n@group channels\n@endpoint PUT /channels/{id}/configure_logs\n@desc Changes the Channel's properities to configure log subscription\n@required {Id: str}\n@optional {EgressAccessLogs: EgressAccessLogs, IngressAccessLogs: IngressAccessLogs}\n@returns(200) {Arn: str?, CreatedAt: str?, Description: str?, EgressAccessLogs: EgressAccessLogs?{LogGroupName: str?}, HlsIngest: HlsIngest?{IngestEndpoints: [IngestEndpoint]?}, Id: str?, IngressAccessLogs: IngressAccessLogs?{LogGroupName: str?}, Tags: map<str,str>?}\n\n@endpoint POST /channels\n@desc Creates a new Channel.\n@required {Id: str}\n@optional {Description: str, Tags: map<str,str>}\n@returns(200) {Arn: str?, CreatedAt: str?, Description: str?, EgressAccessLogs: EgressAccessLogs?{LogGroupName: str?}, HlsIngest: HlsIngest?{IngestEndpoints: [IngestEndpoint]?}, Id: str?, IngressAccessLogs: IngressAccessLogs?{LogGroupName: str?}, Tags: map<str,str>?}\n\n@endgroup\n\n@group harvest_jobs\n@endpoint POST /harvest_jobs\n@desc Creates a new HarvestJob record.\n@required {EndTime: str, Id: str, OriginEndpointId: str, S3Destination: S3Destination, StartTime: str}\n@returns(200) {Arn: str?, ChannelId: str?, CreatedAt: str?, EndTime: str?, Id: str?, OriginEndpointId: str?, S3Destination: S3Destination?{BucketName: str, ManifestKey: str, RoleArn: str}, StartTime: str?, Status: str?}\n\n@endgroup\n\n@group origin_endpoints\n@endpoint POST /origin_endpoints\n@desc Creates a new OriginEndpoint record.\n@required {ChannelId: str, Id: str}\n@optional {Authorization: Authorization, CmafPackage: CmafPackageCreateOrUpdateParameters, DashPackage: DashPackage, Description: str, HlsPackage: HlsPackage, ManifestName: str, MssPackage: MssPackage, Origination: str, StartoverWindowSeconds: int, Tags: map<str,str>, TimeDelaySeconds: int, Whitelist: [str]}\n@returns(200) {Arn: str?, Authorization: Authorization?{CdnIdentifierSecret: str, SecretsRoleArn: str}, ChannelId: str?, CmafPackage: CmafPackage?{Encryption: CmafEncryption?{ConstantInitializationVector: str?, EncryptionMethod: str?, KeyRotationIntervalSeconds: int?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, HlsManifests: [HlsManifest]?, SegmentDurationSeconds: int?, SegmentPrefix: str?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}}, CreatedAt: str?, DashPackage: DashPackage?{AdTriggers: [str]?, AdsOnDeliveryRestrictions: str?, Encryption: DashEncryption?{KeyRotationIntervalSeconds: int?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, IncludeIframeOnlyStream: bool?, ManifestLayout: str?, ManifestWindowSeconds: int?, MinBufferTimeSeconds: int?, MinUpdatePeriodSeconds: int?, PeriodTriggers: [str]?, Profile: str?, SegmentDurationSeconds: int?, SegmentTemplateFormat: str?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}, SuggestedPresentationDelaySeconds: int?, UtcTiming: str?, UtcTimingUri: str?}, Description: str?, HlsPackage: HlsPackage?{AdMarkers: str?, AdTriggers: [str]?, AdsOnDeliveryRestrictions: str?, Encryption: HlsEncryption?{ConstantInitializationVector: str?, EncryptionMethod: str?, KeyRotationIntervalSeconds: int?, RepeatExtXKey: bool?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, IncludeDvbSubtitles: bool?, IncludeIframeOnlyStream: bool?, PlaylistType: str?, PlaylistWindowSeconds: int?, ProgramDateTimeIntervalSeconds: int?, SegmentDurationSeconds: int?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}, UseAudioRenditionGroup: bool?}, Id: str?, ManifestName: str?, MssPackage: MssPackage?{Encryption: MssEncryption?{SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, ManifestWindowSeconds: int?, SegmentDurationSeconds: int?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}}, Origination: str?, StartoverWindowSeconds: int?, Tags: map<str,str>?, TimeDelaySeconds: int?, Url: str?, Whitelist: [str]?}\n\n@endgroup\n\n@group channels\n@endpoint DELETE /channels/{id}\n@desc Deletes an existing Channel.\n@required {Id: str}\n\n@endgroup\n\n@group origin_endpoints\n@endpoint DELETE /origin_endpoints/{id}\n@desc Deletes an existing OriginEndpoint.\n@required {Id: str}\n\n@endgroup\n\n@group channels\n@endpoint GET /channels/{id}\n@desc Gets details about a Channel.\n@required {Id: str}\n@returns(200) {Arn: str?, CreatedAt: str?, Description: str?, EgressAccessLogs: EgressAccessLogs?{LogGroupName: str?}, HlsIngest: HlsIngest?{IngestEndpoints: [IngestEndpoint]?}, Id: str?, IngressAccessLogs: IngressAccessLogs?{LogGroupName: str?}, Tags: map<str,str>?}\n\n@endgroup\n\n@group harvest_jobs\n@endpoint GET /harvest_jobs/{id}\n@desc Gets details about an existing HarvestJob.\n@required {Id: str}\n@returns(200) {Arn: str?, ChannelId: str?, CreatedAt: str?, EndTime: str?, Id: str?, OriginEndpointId: str?, S3Destination: S3Destination?{BucketName: str, ManifestKey: str, RoleArn: str}, StartTime: str?, Status: str?}\n\n@endgroup\n\n@group origin_endpoints\n@endpoint GET /origin_endpoints/{id}\n@desc Gets details about an existing OriginEndpoint.\n@required {Id: str}\n@returns(200) {Arn: str?, Authorization: Authorization?{CdnIdentifierSecret: str, SecretsRoleArn: str}, ChannelId: str?, CmafPackage: CmafPackage?{Encryption: CmafEncryption?{ConstantInitializationVector: str?, EncryptionMethod: str?, KeyRotationIntervalSeconds: int?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, HlsManifests: [HlsManifest]?, SegmentDurationSeconds: int?, SegmentPrefix: str?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}}, CreatedAt: str?, DashPackage: DashPackage?{AdTriggers: [str]?, AdsOnDeliveryRestrictions: str?, Encryption: DashEncryption?{KeyRotationIntervalSeconds: int?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, IncludeIframeOnlyStream: bool?, ManifestLayout: str?, ManifestWindowSeconds: int?, MinBufferTimeSeconds: int?, MinUpdatePeriodSeconds: int?, PeriodTriggers: [str]?, Profile: str?, SegmentDurationSeconds: int?, SegmentTemplateFormat: str?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}, SuggestedPresentationDelaySeconds: int?, UtcTiming: str?, UtcTimingUri: str?}, Description: str?, HlsPackage: HlsPackage?{AdMarkers: str?, AdTriggers: [str]?, AdsOnDeliveryRestrictions: str?, Encryption: HlsEncryption?{ConstantInitializationVector: str?, EncryptionMethod: str?, KeyRotationIntervalSeconds: int?, RepeatExtXKey: bool?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, IncludeDvbSubtitles: bool?, IncludeIframeOnlyStream: bool?, PlaylistType: str?, PlaylistWindowSeconds: int?, ProgramDateTimeIntervalSeconds: int?, SegmentDurationSeconds: int?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}, UseAudioRenditionGroup: bool?}, Id: str?, ManifestName: str?, MssPackage: MssPackage?{Encryption: MssEncryption?{SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, ManifestWindowSeconds: int?, SegmentDurationSeconds: int?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}}, Origination: str?, StartoverWindowSeconds: int?, Tags: map<str,str>?, TimeDelaySeconds: int?, Url: str?, Whitelist: [str]?}\n\n@endgroup\n\n@group channels\n@endpoint GET /channels\n@desc Returns a collection of Channels.\n@optional {maxResults: int, nextToken: str}\n@returns(200) {Channels: [Channel]?, NextToken: str?}\n\n@endgroup\n\n@group harvest_jobs\n@endpoint GET /harvest_jobs\n@desc Returns a collection of HarvestJob records.\n@optional {includeChannelId: str, includeStatus: str, maxResults: int, nextToken: str}\n@returns(200) {HarvestJobs: [HarvestJob]?, NextToken: str?}\n\n@endgroup\n\n@group origin_endpoints\n@endpoint GET /origin_endpoints\n@desc Returns a collection of OriginEndpoint records.\n@optional {channelId: str, maxResults: int, nextToken: str}\n@returns(200) {NextToken: str?, OriginEndpoints: [OriginEndpoint]?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resource-arn}\n@required {ResourceArn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endgroup\n\n@group channels\n@endpoint PUT /channels/{id}/credentials\n@desc Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead\n@required {Id: str}\n@returns(200) {Arn: str?, CreatedAt: str?, Description: str?, EgressAccessLogs: EgressAccessLogs?{LogGroupName: str?}, HlsIngest: HlsIngest?{IngestEndpoints: [IngestEndpoint]?}, Id: str?, IngressAccessLogs: IngressAccessLogs?{LogGroupName: str?}, Tags: map<str,str>?}\n\n@endpoint PUT /channels/{id}/ingest_endpoints/{ingest_endpoint_id}/credentials\n@desc Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.\n@required {Id: str, IngestEndpointId: str}\n@returns(200) {Arn: str?, CreatedAt: str?, Description: str?, EgressAccessLogs: EgressAccessLogs?{LogGroupName: str?}, HlsIngest: HlsIngest?{IngestEndpoints: [IngestEndpoint]?}, Id: str?, IngressAccessLogs: IngressAccessLogs?{LogGroupName: str?}, Tags: map<str,str>?}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{resource-arn}\n@required {ResourceArn: str, Tags: map<str,str>}\n\n@endpoint DELETE /tags/{resource-arn}\n@required {ResourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group channels\n@endpoint PUT /channels/{id}\n@desc Updates an existing Channel.\n@required {Id: str}\n@optional {Description: str}\n@returns(200) {Arn: str?, CreatedAt: str?, Description: str?, EgressAccessLogs: EgressAccessLogs?{LogGroupName: str?}, HlsIngest: HlsIngest?{IngestEndpoints: [IngestEndpoint]?}, Id: str?, IngressAccessLogs: IngressAccessLogs?{LogGroupName: str?}, Tags: map<str,str>?}\n\n@endgroup\n\n@group origin_endpoints\n@endpoint PUT /origin_endpoints/{id}\n@desc Updates an existing OriginEndpoint.\n@required {Id: str}\n@optional {Authorization: Authorization, CmafPackage: CmafPackageCreateOrUpdateParameters, DashPackage: DashPackage, Description: str, HlsPackage: HlsPackage, ManifestName: str, MssPackage: MssPackage, Origination: str, StartoverWindowSeconds: int, TimeDelaySeconds: int, Whitelist: [str]}\n@returns(200) {Arn: str?, Authorization: Authorization?{CdnIdentifierSecret: str, SecretsRoleArn: str}, ChannelId: str?, CmafPackage: CmafPackage?{Encryption: CmafEncryption?{ConstantInitializationVector: str?, EncryptionMethod: str?, KeyRotationIntervalSeconds: int?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, HlsManifests: [HlsManifest]?, SegmentDurationSeconds: int?, SegmentPrefix: str?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}}, CreatedAt: str?, DashPackage: DashPackage?{AdTriggers: [str]?, AdsOnDeliveryRestrictions: str?, Encryption: DashEncryption?{KeyRotationIntervalSeconds: int?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, IncludeIframeOnlyStream: bool?, ManifestLayout: str?, ManifestWindowSeconds: int?, MinBufferTimeSeconds: int?, MinUpdatePeriodSeconds: int?, PeriodTriggers: [str]?, Profile: str?, SegmentDurationSeconds: int?, SegmentTemplateFormat: str?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}, SuggestedPresentationDelaySeconds: int?, UtcTiming: str?, UtcTimingUri: str?}, Description: str?, HlsPackage: HlsPackage?{AdMarkers: str?, AdTriggers: [str]?, AdsOnDeliveryRestrictions: str?, Encryption: HlsEncryption?{ConstantInitializationVector: str?, EncryptionMethod: str?, KeyRotationIntervalSeconds: int?, RepeatExtXKey: bool?, SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, IncludeDvbSubtitles: bool?, IncludeIframeOnlyStream: bool?, PlaylistType: str?, PlaylistWindowSeconds: int?, ProgramDateTimeIntervalSeconds: int?, SegmentDurationSeconds: int?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}, UseAudioRenditionGroup: bool?}, Id: str?, ManifestName: str?, MssPackage: MssPackage?{Encryption: MssEncryption?{SpekeKeyProvider: SpekeKeyProvider{CertificateArn: str?, EncryptionContractConfiguration: EncryptionContractConfiguration?, ResourceId: str, RoleArn: str, SystemIds: [str], Url: str}}, ManifestWindowSeconds: int?, SegmentDurationSeconds: int?, StreamSelection: StreamSelection?{MaxVideoBitsPerSecond: int?, MinVideoBitsPerSecond: int?, StreamOrder: str?}}, Origination: str?, StartoverWindowSeconds: int?, Tags: map<str,str>?, TimeDelaySeconds: int?, Url: str?, Whitelist: [str]?}\n\n@endgroup\n\n@end\n"}