mediapackagev2 / Client / get_origin_endpoint

get_origin_endpoint#

mediapackagev2.Client.get_origin_endpoint(**kwargs)#

Retrieves the specified origin endpoint that’s configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it’s currently using.

Request Syntax

response = client.get_origin_endpoint(
    ChannelGroupName='string',
    ChannelName='string',
    OriginEndpointName='string'
)

Parameters:

ChannelGroupName (string) –
[REQUIRED]

The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) –
[REQUIRED]

The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
OriginEndpointName (string) –
[REQUIRED]

The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'ChannelGroupName': 'string',
    'ChannelName': 'string',
    'OriginEndpointName': 'string',
    'ContainerType': 'TS'|'CMAF',
    'Segment': {
        'SegmentDurationSeconds': 123,
        'SegmentName': 'string',
        'TsUseAudioRenditionGroup': True|False,
        'IncludeIframeOnlyStreams': True|False,
        'TsIncludeDvbSubtitles': True|False,
        'Scte': {
            'ScteFilter': [
                'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM',
            ]
        },
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': {
                'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES',
                'CmafEncryptionMethod': 'CENC'|'CBCS'
            },
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'EncryptionContractConfiguration': {
                    'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED',
                    'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED'
                },
                'ResourceId': 'string',
                'DrmSystems': [
                    'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE',
                ],
                'RoleArn': 'string',
                'Url': 'string'
            }
        }
    },
    'CreatedAt': datetime(2015, 1, 1),
    'ModifiedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'StartoverWindowSeconds': 123,
    'HlsManifests': [
        {
            'ManifestName': 'string',
            'Url': 'string',
            'ChildManifestName': 'string',
            'ManifestWindowSeconds': 123,
            'ProgramDateTimeIntervalSeconds': 123,
            'ScteHls': {
                'AdMarkerHls': 'DATERANGE'
            },
            'FilterConfiguration': {
                'ManifestFilter': 'string',
                'Start': datetime(2015, 1, 1),
                'End': datetime(2015, 1, 1),
                'TimeDelaySeconds': 123
            }
        },
    ],
    'LowLatencyHlsManifests': [
        {
            'ManifestName': 'string',
            'Url': 'string',
            'ChildManifestName': 'string',
            'ManifestWindowSeconds': 123,
            'ProgramDateTimeIntervalSeconds': 123,
            'ScteHls': {
                'AdMarkerHls': 'DATERANGE'
            },
            'FilterConfiguration': {
                'ManifestFilter': 'string',
                'Start': datetime(2015, 1, 1),
                'End': datetime(2015, 1, 1),
                'TimeDelaySeconds': 123
            }
        },
    ],
    'ETag': 'string',
    'Tags': {
        'string': 'string'
    },
    'DashManifests': [
        {
            'ManifestName': 'string',
            'Url': 'string',
            'ManifestWindowSeconds': 123,
            'FilterConfiguration': {
                'ManifestFilter': 'string',
                'Start': datetime(2015, 1, 1),
                'End': datetime(2015, 1, 1),
                'TimeDelaySeconds': 123
            },
            'MinUpdatePeriodSeconds': 123,
            'MinBufferTimeSeconds': 123,
            'SuggestedPresentationDelaySeconds': 123,
            'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE',
            'PeriodTriggers': [
                'AVAILS'|'DRM_KEY_ROTATION'|'SOURCE_CHANGES'|'SOURCE_DISRUPTIONS'|'NONE',
            ],
            'ScteDash': {
                'AdMarkerDash': 'BINARY'|'XML'
            },
            'DrmSignaling': 'INDIVIDUAL'|'REFERENCED',
            'UtcTiming': {
                'TimingMode': 'HTTP_HEAD'|'HTTP_ISO'|'HTTP_XSDATE'|'UTC_DIRECT',
                'TimingSource': 'string'
            }
        },
    ]
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) associated with the resource.
- ChannelGroupName (string) –
  
  The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
- ChannelName (string) –
  
  The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
- OriginEndpointName (string) –
  
  The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
- ContainerType (string) –
  
  The type of container attached to this origin endpoint.
- Segment (dict) –
  
  The segment configuration, including the segment name, duration, and other configuration values.
  - SegmentDurationSeconds (integer) –
    
    The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
  - SegmentName (string) –
    
    The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can’t use spaces in the name.
  - TsUseAudioRenditionGroup (boolean) –
    
    When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
  - IncludeIframeOnlyStreams (boolean) –
    
    When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
  - TsIncludeDvbSubtitles (boolean) –
    
    By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
  - Scte (dict) –
    
    The SCTE configuration options in the segment settings.
    - ScteFilter (list) –
      
      The SCTE-35 message types that you want to be treated as ad markers in the output.
      - (string) –
  - Encryption (dict) –
    
    The parameters for encrypting content.
    - ConstantInitializationVector (string) –
      
      A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don’t specify a value, then MediaPackage creates the constant initialization vector (IV).
    - EncryptionMethod (dict) –
      
      The encryption method to use.
      - TsEncryptionMethod (string) –
        
        The encryption method to use.
      - CmafEncryptionMethod (string) –
        
        The encryption method to use.
    - KeyRotationIntervalSeconds (integer) –
      
      The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don’t enter an interval, content keys aren’t rotated.
      
      The following example setting causes the service to rotate keys every thirty minutes: 1800
    - SpekeKeyProvider (dict) –
      
      The parameters for the SPEKE key provider.
      - EncryptionContractConfiguration (dict) –
        
        Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
        
        PresetSpeke20Audio (string) –
        
        A collection of audio encryption presets.
        
        Value description:
        
        PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
        
        PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
        
        PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
        
        SHARED - Use the same content key for all of the audio and video tracks in your stream.
        
        UNENCRYPTED - Don’t encrypt any of the audio tracks in your stream.
        
        PresetSpeke20Video (string) –
        
        A collection of video encryption presets.
        
        Value description:
        
        PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
        
        PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
        
        PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
        
        PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
        
        PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
        
        PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
        
        PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
        
        PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
        
        SHARED - Use the same content key for all of the video and audio tracks in your stream.
        
        UNENCRYPTED - Don’t encrypt any of the video tracks in your stream.
      - ResourceId (string) –
        
        The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
        
        The following example shows a resource ID: MovieNight20171126093045
      - DrmSystems (list) –
        
        The DRM solution provider you’re using to protect your content during distribution.
        
        (string) –
      - RoleArn (string) –
        
        The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
        
        Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
      - Url (string) –
        
        The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
        
        The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
- CreatedAt (datetime) –
  
  The date and time the origin endpoint was created.
- ModifiedAt (datetime) –
  
  The date and time the origin endpoint was modified.
- Description (string) –
  
  The description for your origin endpoint.
- StartoverWindowSeconds (integer) –
  
  The size of the window (in seconds) to create a window of the live stream that’s available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
- HlsManifests (list) –
  
  An HTTP live streaming (HLS) manifest configuration.
  - (dict) –
    
    Retrieve the HTTP live streaming (HLS) manifest configuration.
    - ManifestName (string) –
      
      A short short string that’s appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can’t use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
    - Url (string) –
      
      The egress domain URL for stream delivery from MediaPackage.
    - ChildManifestName (string) –
      
      A short string that’s appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
    - ManifestWindowSeconds (integer) –
      
      The total duration (in seconds) of the manifest’s content.
    - ProgramDateTimeIntervalSeconds (integer) –
      
      Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don’t enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren’t included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
      
      Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
    - ScteHls (dict) –
      
      The SCTE configuration.
      - AdMarkerHls (string) –
        
        Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
        
        Value description:
        
        DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
    - FilterConfiguration (dict) –
      
      Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
      - ManifestFilter (string) –
        
        Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest’s endpoint URL.
      - Start (datetime) –
        
        Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest’s endpoint URL.
      - End (datetime) –
        
        Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest’s endpoint URL.
      - TimeDelaySeconds (integer) –
        
        Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint’s startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest’s endpoint URL.
- LowLatencyHlsManifests (list) –
  
  A low-latency HLS manifest configuration.
  - (dict) –
    
    Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.
    - ManifestName (string) –
      
      A short short string that’s appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can’t use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
    - Url (string) –
      
      The egress domain URL for stream delivery from MediaPackage.
    - ChildManifestName (string) –
      
      A short string that’s appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
    - ManifestWindowSeconds (integer) –
      
      The total duration (in seconds) of the manifest’s content.
    - ProgramDateTimeIntervalSeconds (integer) –
      
      Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don’t enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren’t included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
      
      Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
    - ScteHls (dict) –
      
      The SCTE configuration.
      - AdMarkerHls (string) –
        
        Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
        
        Value description:
        
        DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
    - FilterConfiguration (dict) –
      
      Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
      - ManifestFilter (string) –
        
        Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest’s endpoint URL.
      - Start (datetime) –
        
        Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest’s endpoint URL.
      - End (datetime) –
        
        Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest’s endpoint URL.
      - TimeDelaySeconds (integer) –
        
        Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint’s startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest’s endpoint URL.
- ETag (string) –
  
  The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.
- Tags (dict) –
  
  The comma-separated list of tag key:value pairs assigned to the origin endpoint.
  - (string) –
    - (string) –
- DashManifests (list) –
  
  A DASH manifest configuration.
  - (dict) –
    
    Retrieve the DASH manifest configuration.
    - ManifestName (string) –
      
      A short string that’s appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don’t enter a value, MediaPackage uses the default manifest name, index.
    - Url (string) –
      
      The egress domain URL for stream delivery from MediaPackage.
    - ManifestWindowSeconds (integer) –
      
      The total duration (in seconds) of the manifest’s content.
    - FilterConfiguration (dict) –
      
      Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.
      - ManifestFilter (string) –
        
        Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest’s endpoint URL.
      - Start (datetime) –
        
        Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest’s endpoint URL.
      - End (datetime) –
        
        Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest’s endpoint URL.
      - TimeDelaySeconds (integer) –
        
        Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint’s startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest’s endpoint URL.
    - MinUpdatePeriodSeconds (integer) –
      
      Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.
    - MinBufferTimeSeconds (integer) –
      
      Minimum amount of content (in seconds) that a player must keep available in the buffer.
    - SuggestedPresentationDelaySeconds (integer) –
      
      The amount of time (in seconds) that the player should be from the end of the manifest.
    - SegmentTemplateFormat (string) –
      
      Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.
      
      Value description:
      - NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.
    - PeriodTriggers (list) –
      
      A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.
      - (string) –
    - ScteDash (dict) –
      
      The SCTE configuration.
      - AdMarkerDash (string) –
        
        Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.
        
        Value description:
        
        Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.
        
        XML - The SCTE marker is expressed fully in XML.
    - DrmSignaling (string) –
      
      Determines how the DASH manifest signals the DRM content.
    - UtcTiming (dict) –
      
      Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).
      - TimingMode (string) –
        
        The UTC timing mode.
      - TimingSource (string) –
        
        The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

Exceptions

mediapackagev2.Client.exceptions.ThrottlingException
mediapackagev2.Client.exceptions.InternalServerException
mediapackagev2.Client.exceptions.AccessDeniedException
mediapackagev2.Client.exceptions.ValidationException
mediapackagev2.Client.exceptions.ResourceNotFoundException