# Resources The AWS Elemental MediaPackage REST API includes the following resources. **Topics** + [ # Channels ](channels.md) + [ # Channels id ](channels-id.md) + [ # Channels id Configure\$1logs ](channels-id-configure_logs.md) + [ # Channels id Credentials ](channels-id-credentials.md) + [ # Channels id Ingest\$1endpoints ingest\$1endpoint\$1id Credentials ](channels-id-ingest_endpoints-ingest_endpoint_id-credentials.md) + [ # Harvest\$1jobs ](harvest_jobs.md) + [ # Harvest\$1jobs id ](harvest_jobs-id.md) + [ # Origin\$1endpoints ](origin_endpoints.md) + [ # Origin\$1endpoints id ](origin_endpoints-id.md) + [ # Tags resource-arn ](tags-resource-arn.md) # Channels ## URI `/channels` ## HTTP methods ### GET **Operation ID:** `ListChannels` Lists channels that match a set of filters that you define. **Query parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | nextToken | String | False | Pagination token from the GET list request. Use the token to fetch the next page of results. | | maxResults | String | False | Upper bound on number of records to return. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | ChannelList | `200 OK` responseThe list of channels is returned successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### POST **Operation ID:** `CreateChannel` Creates a channel to receive content. Once created, a channel provides static input URLs. These URLs remain the same throughout the lifetime of the channel, regardless of any failures or upgrades that might occur. Use these URLs to configure the outputs of your upstream encoder. **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | Channel | `200 OK` responseThe channel is created successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Request bodies #### POST schema POST ``` { "description": "string", "id": "string", "tags": { } } ``` ### Response bodies #### ChannelList schema ChannelList ``` { "channels": [ { "createdAt": "string", "ingressAccessLogs": { "logGroupName": "string" }, "egressAccessLogs": { "logGroupName": "string" }, "description": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "id": "string", "url": "string", "username": "string" } ] }, "id": "string", "arn": "string", "tags": { } } ], "nextToken": "string" } ``` #### Channel schema Channel ``` { "createdAt": "string", "ingressAccessLogs": { "logGroupName": "string" }, "egressAccessLogs": { "logGroupName": "string" }, "description": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "id": "string", "url": "string", "username": "string" } ] }, "id": "string", "arn": "string", "tags": { } } ``` ## Properties ### Channel Channel configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The channel's unique system-generated resource name, based on the AWS record. | | createdAt | string | False | The date and time the Channel was created. | | description | string | False | Any descriptive information that you want to add to the channel for future identification purposes. | | egressAccessLogs | [EgressAccessLogs](#channels-model-egressaccesslogs) | False | Configures egress access logs. | | hlsIngest | [HlsIngest](#channels-model-hlsingest) | False | System-generated information about the channel. | | id | string | False | Unique identifier that you assign to the channel. | | ingressAccessLogs | [IngressAccessLogs](#channels-model-ingressaccesslogs) | False | Configures ingress access logs. | | tags | [Tags](#channels-model-tags) | False | The tags assigned to the channel. | ### ChannelCreateParameters Channel configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | description | string | False | Any descriptive information that you want to add to the channel for future identification purposes. | | id | string | True | Unique identifier that you assign to the channel. Supported characters are numbers, letters, underscores (\$1), and dashes (-) with a length of 1 to 256 characters. | | tags | [Tags](#channels-model-tags) | False | The tags to assign to the channel. | ### ChannelList A collection of Channel records. | Property | Type | Required | Description | | --- |--- |--- |--- | | channels | Array of type [Channel](#channels-model-channel) | False | List of channel objects that are configured on this account. | | nextToken | string | False | Pagination token. Use this token to request the next page of channel results. | ### EgressAccessLogs Egress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/EgressAccessLogs`. | ### HlsIngest HLS ingest configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | ingestEndpoints | Array of type [IngestEndpoint](#channels-model-ingestendpoint) | False | The input URL where the source stream should be sent. | ### IngestEndpoint An endpoint for ingesting source content for a channel. | Property | Type | Required | Description | | --- |--- |--- |--- | | id | string | False | The system-generated unique identifier for the IngestEndpoint. | | password | string | False | The system-generated password for WebDAV input authentication. | | url | string | False | The input URL where the source stream should be sent. | | username | string | False | The system-generated username for WebDAV input authentication. | ### IngressAccessLogs Ingress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/IngressAccessLogs`. | ### Tags A collection of tags associated with a resource. Value description: + **Property**: `"key1": "value1"` + **Type**: string + **Required**: True + **Description**: A comma-separated list of tag key:value pairs that you define. For example: ``` { "Key1": "Value1", "Key2": "Value2" } ``` | Property | Type | Required | Description | | --- |--- |--- |--- | | `*` | string | False | | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### ListChannels + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/ListChannels) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/ListChannels) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/ListChannels) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/ListChannels) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/ListChannels) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/ListChannels) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/ListChannels) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/ListChannels) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/ListChannels) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/ListChannels) ### CreateChannel + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/CreateChannel) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/CreateChannel) # Channels id ## URI `/channels/id` ## HTTP methods ### GET **Operation ID:** `DescribeChannel` Provides details about a channel. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | Channel | `200 OK` responseChannel details are returned successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### PUT **Operation ID:** `UpdateChannel` Updates a specific channel. You can't change the `id` attribute or any other system-generated attributes. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | Channel | `200 OK` responseThe channel is updated successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### DELETE **Operation ID:** `DeleteChannel` Permanently deletes a channel. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 202 | None | `202 Accepted` responseAWS Elemental MediaPackage accepted the request but has not processed it yet. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Request bodies #### PUT schema PUT ``` { "description": "string" } ``` ### Response bodies #### Channel schema Channel ``` { "createdAt": "string", "ingressAccessLogs": { "logGroupName": "string" }, "egressAccessLogs": { "logGroupName": "string" }, "description": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "id": "string", "url": "string", "username": "string" } ] }, "id": "string", "arn": "string", "tags": { } } ``` ## Properties ### Channel Channel configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The channel's unique system-generated resource name, based on the AWS record. | | createdAt | string | False | The date and time the Channel was created. | | description | string | False | Any descriptive information that you want to add to the channel for future identification purposes. | | egressAccessLogs | [EgressAccessLogs](#channels-id-model-egressaccesslogs) | False | Configures egress access logs. | | hlsIngest | [HlsIngest](#channels-id-model-hlsingest) | False | System-generated information about the channel. | | id | string | False | Unique identifier that you assign to the channel. | | ingressAccessLogs | [IngressAccessLogs](#channels-id-model-ingressaccesslogs) | False | Configures ingress access logs. | | tags | [Tags](#channels-id-model-tags) | False | The tags assigned to the channel. | ### ChannelUpdateParameters Channel configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | description | string | False | Any descriptive information that you want to add to the channel for future identification purposes. | ### EgressAccessLogs Egress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/EgressAccessLogs`. | ### HlsIngest HLS ingest configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | ingestEndpoints | Array of type [IngestEndpoint](#channels-id-model-ingestendpoint) | False | The input URL where the source stream should be sent. | ### IngestEndpoint An endpoint for ingesting source content for a channel. | Property | Type | Required | Description | | --- |--- |--- |--- | | id | string | False | The system-generated unique identifier for the IngestEndpoint. | | password | string | False | The system-generated password for WebDAV input authentication. | | url | string | False | The input URL where the source stream should be sent. | | username | string | False | The system-generated username for WebDAV input authentication. | ### IngressAccessLogs Ingress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/IngressAccessLogs`. | ### Tags A collection of tags associated with a resource. Value description: + **Property**: `"key1": "value1"` + **Type**: string + **Required**: True + **Description**: A comma-separated list of tag key:value pairs that you define. For example: ``` { "Key1": "Value1", "Key2": "Value2" } ``` | Property | Type | Required | Description | | --- |--- |--- |--- | | `*` | string | False | | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### DescribeChannel + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/DescribeChannel) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/DescribeChannel) ### UpdateChannel + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/UpdateChannel) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/UpdateChannel) ### DeleteChannel + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/DeleteChannel) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/DeleteChannel) # Channels id Configure\$1logs Configures access logs for a channel. For information about access logs, see [Access logging](https://docs.aws.amazon.com/mediapackage/latest/ug/access-logging.html). ## URI `/channels/id/configure_logs` ## HTTP methods ### PUT **Operation ID:** `ConfigureLogs` Configures access logs for a channel. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | Channel | `200 OK` responseThe channel is updated successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Request bodies #### PUT schema PUT ``` { "ingressAccessLogs": { "logGroupName": "string" }, "egressAccessLogs": { "logGroupName": "string" } } ``` ### Response bodies #### Channel schema Channel ``` { "createdAt": "string", "ingressAccessLogs": { "logGroupName": "string" }, "egressAccessLogs": { "logGroupName": "string" }, "description": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "id": "string", "url": "string", "username": "string" } ] }, "id": "string", "arn": "string", "tags": { } } ``` ## Properties ### Channel Channel configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The channel's unique system-generated resource name, based on the AWS record. | | createdAt | string | False | The date and time the Channel was created. | | description | string | False | Any descriptive information that you want to add to the channel for future identification purposes. | | egressAccessLogs | [EgressAccessLogs](#channels-id-configure_logs-model-egressaccesslogs) | False | Configures egress access logs. | | hlsIngest | [HlsIngest](#channels-id-configure_logs-model-hlsingest) | False | System-generated information about the channel. | | id | string | False | Unique identifier that you assign to the channel. | | ingressAccessLogs | [IngressAccessLogs](#channels-id-configure_logs-model-ingressaccesslogs) | False | Configures ingress access logs. | | tags | [Tags](#channels-id-configure_logs-model-tags) | False | The tags assigned to the channel. | ### ConfigureLogsParameters Access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | egressAccessLogs | [EgressAccessLogs](#channels-id-configure_logs-model-egressaccesslogs) | False | Configures egress access logs. | | ingressAccessLogs | [IngressAccessLogs](#channels-id-configure_logs-model-ingressaccesslogs) | False | Configures ingress access logs. | ### EgressAccessLogs Egress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/EgressAccessLogs`. | ### HlsIngest HLS ingest configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | ingestEndpoints | Array of type [IngestEndpoint](#channels-id-configure_logs-model-ingestendpoint) | False | The input URL where the source stream should be sent. | ### IngestEndpoint An endpoint for ingesting source content for a channel. | Property | Type | Required | Description | | --- |--- |--- |--- | | id | string | False | The system-generated unique identifier for the IngestEndpoint. | | password | string | False | The system-generated password for WebDAV input authentication. | | url | string | False | The input URL where the source stream should be sent. | | username | string | False | The system-generated username for WebDAV input authentication. | ### IngressAccessLogs Ingress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/IngressAccessLogs`. | ### Tags A collection of tags associated with a resource. Value description: + **Property**: `"key1": "value1"` + **Type**: string + **Required**: True + **Description**: A comma-separated list of tag key:value pairs that you define. For example: ``` { "Key1": "Value1", "Key2": "Value2" } ``` | Property | Type | Required | Description | | --- |--- |--- |--- | | `*` | string | False | | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### ConfigureLogs + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/ConfigureLogs) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/ConfigureLogs) # Channels id Credentials ## URI `/channels/id/credentials` ## HTTP methods ### PUT **Operation ID:** `RotateChannelCredentials` Changes the username and password of the first IngestEndpoint on the channel. **Important** This API is being deprecated. Use RotateIngestEndpointCredentials instead. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | Channel | `200 OK` responseNew WebDAV credentials are generated successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Response bodies #### Channel schema Channel ``` { "createdAt": "string", "ingressAccessLogs": { "logGroupName": "string" }, "egressAccessLogs": { "logGroupName": "string" }, "description": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "id": "string", "url": "string", "username": "string" } ] }, "id": "string", "arn": "string", "tags": { } } ``` ## Properties ### Channel Channel configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The channel's unique system-generated resource name, based on the AWS record. | | createdAt | string | False | The date and time the Channel was created. | | description | string | False | Any descriptive information that you want to add to the channel for future identification purposes. | | egressAccessLogs | [EgressAccessLogs](#channels-id-credentials-model-egressaccesslogs) | False | Configures egress access logs. | | hlsIngest | [HlsIngest](#channels-id-credentials-model-hlsingest) | False | System-generated information about the channel. | | id | string | False | Unique identifier that you assign to the channel. | | ingressAccessLogs | [IngressAccessLogs](#channels-id-credentials-model-ingressaccesslogs) | False | Configures ingress access logs. | | tags | [Tags](#channels-id-credentials-model-tags) | False | The tags assigned to the channel. | ### EgressAccessLogs Egress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/EgressAccessLogs`. | ### HlsIngest HLS ingest configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | ingestEndpoints | Array of type [IngestEndpoint](#channels-id-credentials-model-ingestendpoint) | False | The input URL where the source stream should be sent. | ### IngestEndpoint An endpoint for ingesting source content for a channel. | Property | Type | Required | Description | | --- |--- |--- |--- | | id | string | False | The system-generated unique identifier for the IngestEndpoint. | | password | string | False | The system-generated password for WebDAV input authentication. | | url | string | False | The input URL where the source stream should be sent. | | username | string | False | The system-generated username for WebDAV input authentication. | ### IngressAccessLogs Ingress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/IngressAccessLogs`. | ### Tags A collection of tags associated with a resource. Value description: + **Property**: `"key1": "value1"` + **Type**: string + **Required**: True + **Description**: A comma-separated list of tag key:value pairs that you define. For example: ``` { "Key1": "Value1", "Key2": "Value2" } ``` | Property | Type | Required | Description | | --- |--- |--- |--- | | `*` | string | False | | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### RotateChannelCredentials + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/RotateChannelCredentials) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/RotateChannelCredentials) # Channels id Ingest\$1endpoints ingest\$1endpoint\$1id Credentials ## URI `/channels/id/ingest_endpoints/ingest_endpoint_id/credentials` ## HTTP methods ### PUT **Operation ID:** `RotateIngestEndpointCredentials` Rotate the IngestEndpoint's username and password, as specified by the ID of the IngestEndpoint. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | ingest\$1endpoint\$1id | String | True | The ID of the IngestEndpoint whose credentials you're rotating. | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | Channel | `200 OK` responseThe channel is updated successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | ingest\$1endpoint\$1id | String | True | The ID of the IngestEndpoint whose credentials you're rotating. | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Response bodies #### Channel schema Channel ``` { "createdAt": "string", "ingressAccessLogs": { "logGroupName": "string" }, "egressAccessLogs": { "logGroupName": "string" }, "description": "string", "hlsIngest": { "ingestEndpoints": [ { "password": "string", "id": "string", "url": "string", "username": "string" } ] }, "id": "string", "arn": "string", "tags": { } } ``` ## Properties ### Channel Channel configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The channel's unique system-generated resource name, based on the AWS record. | | createdAt | string | False | The date and time the Channel was created. | | description | string | False | Any descriptive information that you want to add to the channel for future identification purposes. | | egressAccessLogs | [EgressAccessLogs](#channels-id-ingest_endpoints-ingest_endpoint_id-credentials-model-egressaccesslogs) | False | Configures egress access logs. | | hlsIngest | [HlsIngest](#channels-id-ingest_endpoints-ingest_endpoint_id-credentials-model-hlsingest) | False | System-generated information about the channel. | | id | string | False | Unique identifier that you assign to the channel. | | ingressAccessLogs | [IngressAccessLogs](#channels-id-ingest_endpoints-ingest_endpoint_id-credentials-model-ingressaccesslogs) | False | Configures ingress access logs. | | tags | [Tags](#channels-id-ingest_endpoints-ingest_endpoint_id-credentials-model-tags) | False | The tags assigned to the channel. | ### EgressAccessLogs Egress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for egress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/EgressAccessLogs`. | ### HlsIngest HLS ingest configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | ingestEndpoints | Array of type [IngestEndpoint](#channels-id-ingest_endpoints-ingest_endpoint_id-credentials-model-ingestendpoint) | False | The input URL where the source stream should be sent. | ### IngestEndpoint An endpoint for ingesting source content for a channel. | Property | Type | Required | Description | | --- |--- |--- |--- | | id | string | False | The system-generated unique identifier for the IngestEndpoint. | | password | string | False | The system-generated password for WebDAV input authentication. | | url | string | False | The input URL where the source stream should be sent. | | username | string | False | The system-generated username for WebDAV input authentication. | ### IngressAccessLogs Ingress access log configuration parameters. | Property | Type | Required | Description | | --- |--- |--- |--- | | logGroupName | string | False | Sets a custom AWS CloudWatch log group name for ingress logs. If a log group name isn't specified, the default name is used: `/aws/MediaPackage/IngressAccessLogs`. | ### Tags A collection of tags associated with a resource. Value description: + **Property**: `"key1": "value1"` + **Type**: string + **Required**: True + **Description**: A comma-separated list of tag key:value pairs that you define. For example: ``` { "Key1": "Value1", "Key2": "Value2" } ``` | Property | Type | Required | Description | | --- |--- |--- |--- | | `*` | string | False | | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### RotateIngestEndpointCredentials + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/RotateIngestEndpointCredentials) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/RotateIngestEndpointCredentials) # Harvest\$1jobs HarvestJobs provide details about the video on demand (VOD) assets that you want to harvest, or extract, from live content streams. ## URI `/harvest_jobs` ## HTTP methods ### GET **Operation ID:** `ListHarvestJobs` Lists harvestJobs that match a set of filters that you define. **Query parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | includeStatus | String | False | Limits results to harvestJobs with the given status. Valid values are `IN_PROGRESS`, `SUCCEEDED`, and `FAILED`. | | nextToken | String | False | Pagination token from the GET list request. Use the token to fetch the next page of results. | | maxResults | String | False | Upper bound on number of records to return. | | includeChannelId | String | False | Limits results to harvestJobs associated with the given channel ID. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | HarvestJobList | `200 OK response` The list of harvestJobs is returned successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### POST **Operation ID:** `CreateHarvestJob` Creates a harvestJob to extract a video on demand (VOD) clip from the live stream. **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | HarvestJob | `200 OK response` The harvestJob is created successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Request bodies #### POST schema POST ``` { "s3Destination": { "bucketName": "string", "manifestKey": "string", "roleArn": "string" }, "startTime": "string", "endTime": "string", "id": "string", "originEndpointId": "string" } ``` ### Response bodies #### HarvestJobList schema HarvestJobList ``` { "harvestJobs": [ { "createdAt": "string", "s3Destination": { "bucketName": "string", "manifestKey": "string", "roleArn": "string" }, "startTime": "string", "endTime": "string", "id": "string", "originEndpointId": "string", "arn": "string", "channelId": "string", "status": enum } ], "nextToken": "string" } ``` #### HarvestJob schema HarvestJob ``` { "createdAt": "string", "s3Destination": { "bucketName": "string", "manifestKey": "string", "roleArn": "string" }, "startTime": "string", "endTime": "string", "id": "string", "originEndpointId": "string", "arn": "string", "channelId": "string", "status": enum } ``` ## Properties ### HarvestJob HarvestJob configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The Amazon Resource Name (ARN) that MediaPackage assigns to the harvestJob. | | channelId | string | False | The ID of the channel that the HarvestJob harvests from. | | createdAt | string | False | The time that you submitted the HarvestJob. | | endTime | string | False | The end time of the window for the live-to-VOD asset. | | id | string | False | Unique identifier for this harvestJob. The identifier can't be changed after the harvestJob is created. | | originEndpointId | string | False | The endpoint that MediaPackage harvests the live-to-VOD asset from. | | s3Destination | [S3Destination](#harvest_jobs-model-s3destination) | False | Parameters that define how MediaPackage accesses and saves the harvested asset to your Amazon S3 bucket. | | startTime | string | False | The start time of the window for the live-to-VOD asset. | | status | stringValues: `IN_PROGRESS \| SUCCEEDED \| FAILED` | False | The current status of the harvestJob.We recommend that you configure a CloudWatch Event to notify you as harvestJobs complete or fail. For any failures, the CloudWatch Event explains why the harvestJob failed. For more information about CloudWatch Events, see [Monitoring AWS Elemental MediaPackage with Amazon CloudWatch Events](https://docs.aws.amazon.com/mediapackage/latest/ug/monitoring-cloudwatch-events.html). | ### HarvestJobCreateParameters HarvestJob configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | endTime | string | True | The end time of the window for the live-to-VOD asset. The length of the asset can't exceed the startover window on the endpoint. If the startover window is five hours, the asset's end time can't be more than five hours from the asset's start time. | | id | string | True | Unique identifier for this harvestJob. The identifier can't be changed after the harvestJob is created. | | originEndpointId | string | True | The endpoint that MediaPackage harvests the live-to-VOD asset from. | | s3Destination | [S3Destination](#harvest_jobs-model-s3destination) | True | Parameters that define how MediaPackage accesses and saves the harvested asset to your Amazon S3 bucket. | | startTime | string | True | The start time of the window for the live-to-VOD asset. This time must be at the same time or after the live event started, and must be within the startover window on the endpoint. If the endpoint has a startover window of five hours and the asset's start time is six hours ago, the harvestJob fails. | ### HarvestJobList Lists harvestJobs that match a set of filters that you define. | Property | Type | Required | Description | | --- |--- |--- |--- | | harvestJobs | Array of type [HarvestJob](#harvest_jobs-model-harvestjob) | False | List of harvestJobs that you created on this account. MediaPackage runs each harvestJob only once. After that, MediaPackage keeps a record of the job on your account for 90 days, for reference purposes only. | | nextToken | string | False | Pagination token from the GET list request. Use the token to fetch the next page of results. | ### S3Destination Defines how and where MediaPackage saves the live-to-VOD asset after it's been harvested from the live stream. | Property | Type | Required | Description | | --- |--- |--- |--- | | bucketName | string | True | The name of the Amazon S3 bucket where MediaPackage stores the live-to-VOD asset. | | manifestKey | string | True | The path within the S3 bucket where MediaPackage stores the parent manifest of the harvested asset. | | roleArn | string | True | The Amazon Resource Name (ARN) for the IAM role that provides MediaPackage access to read and write to the Amazon S3 bucket where the harvested live-to-VOD asset is stored. For more information about this role, see [Allowing AWS Elemental MediaPackage to Access Amazon S3](https://docs.aws.amazon.com/mediapackage/latest/ug/setting-up-create-trust-rel.html). | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### ListHarvestJobs + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/ListHarvestJobs) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/ListHarvestJobs) ### CreateHarvestJob + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/CreateHarvestJob) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/CreateHarvestJob) # Harvest\$1jobs id HarvestJobs provide details about the video on demand (VOD) assets that you harvested, or extracted, from live content streams. ## URI `/harvest_jobs/id` ## HTTP methods ### GET **Operation ID:** `DescribeHarvestJob` Provides details about a harvestJob. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | HarvestJob | `200 OK response` HarvestJob details are returned successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Response bodies #### HarvestJob schema HarvestJob ``` { "createdAt": "string", "s3Destination": { "bucketName": "string", "manifestKey": "string", "roleArn": "string" }, "startTime": "string", "endTime": "string", "id": "string", "originEndpointId": "string", "arn": "string", "channelId": "string", "status": enum } ``` ## Properties ### HarvestJob HarvestJob configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The Amazon Resource Name (ARN) that MediaPackage assigns to the harvestJob. | | channelId | string | False | The ID of the channel that the HarvestJob harvests from. | | createdAt | string | False | The time that you submitted the HarvestJob. | | endTime | string | False | The end time of the window for the live-to-VOD asset. | | id | string | False | Unique identifier for this harvestJob. The identifier can't be changed after the harvestJob is created. | | originEndpointId | string | False | The endpoint that MediaPackage harvests the live-to-VOD asset from. | | s3Destination | [S3Destination](#harvest_jobs-id-model-s3destination) | False | Parameters that define how MediaPackage accesses and saves the harvested asset to your Amazon S3 bucket. | | startTime | string | False | The start time of the window for the live-to-VOD asset. | | status | stringValues: `IN_PROGRESS \| SUCCEEDED \| FAILED` | False | The current status of the harvestJob.We recommend that you configure a CloudWatch Event to notify you as harvestJobs complete or fail. For any failures, the CloudWatch Event explains why the harvestJob failed. For more information about CloudWatch Events, see [Monitoring AWS Elemental MediaPackage with Amazon CloudWatch Events](https://docs.aws.amazon.com/mediapackage/latest/ug/monitoring-cloudwatch-events.html). | ### S3Destination Defines how and where MediaPackage saves the live-to-VOD asset after it's been harvested from the live stream. | Property | Type | Required | Description | | --- |--- |--- |--- | | bucketName | string | True | The name of the Amazon S3 bucket where MediaPackage stores the live-to-VOD asset. | | manifestKey | string | True | The path within the S3 bucket where MediaPackage stores the parent manifest of the harvested asset. | | roleArn | string | True | The Amazon Resource Name (ARN) for the IAM role that provides MediaPackage access to read and write to the Amazon S3 bucket where the harvested live-to-VOD asset is stored. For more information about this role, see [Allowing AWS Elemental MediaPackage to Access Amazon S3](https://docs.aws.amazon.com/mediapackage/latest/ug/setting-up-create-trust-rel.html). | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### DescribeHarvestJob + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/DescribeHarvestJob) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/DescribeHarvestJob) # Origin\$1endpoints ## URI `/origin_endpoints` ## HTTP methods ### GET **Operation ID:** `ListOriginEndpoints` Lists endpoints that match a set of filters that you define. **Query parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | nextToken | String | False | Pagination token from the GET list request. Use the token to fetch the next page of results. | | maxResults | String | False | Upper bound on number of records to return. | | channelId | String | False | Limits results to endpoints associated with the given channel ID. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | OriginEndpointList | `200 OK` responseThe list of endpoints is returned successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### POST **Operation ID:** `CreateOriginEndpoint` Create an endpoint on an AWS Elemental MediaPackage channel. An endpoint represents a single delivery point of a channel, and defines content output handling through various components, such as packaging protocols, DRM and encryption integration, and more. Once created, an endpoint provides a fixed public URL. This URL remains the same throughout the lifetime of the endpoint, regardless of any failures or upgrades that might occur. Integrate the URL with a downstream CDN (such as Amazon CloudFront) or playback device. **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | OriginEndpoint | `200 OK` responseThe endpoint is created successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Request bodies #### POST schema POST ``` { "startoverWindowSeconds": integer, "manifestName": "string", "description": "string", "dashPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string", "profile": enum, "utcTiming": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "suggestedPresentationDelaySeconds": integer, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "whitelist": [ "string" ], "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "adMarkers": enum, "playlistWindowSeconds": integer, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "playlistWindowSeconds": integer, "includeDvbSubtitles": boolean, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "tags": { }, "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "origination": enum, "timeDelaySeconds": integer, "id": "string", "channelId": "string", "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } } ``` ### Response bodies #### OriginEndpointList schema OriginEndpointList ``` { "originEndpoints": [ { "startoverWindowSeconds": integer, "manifestName": "string", "description": "string", "dashPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string", "profile": enum, "utcTiming": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "suggestedPresentationDelaySeconds": integer, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "whitelist": [ "string" ], "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "adMarkers": enum, "playlistWindowSeconds": integer, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "url": "string" } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "playlistWindowSeconds": integer, "includeDvbSubtitles": boolean, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "url": "string", "tags": { }, "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "createdAt": "string", "origination": enum, "timeDelaySeconds": integer, "id": "string", "arn": "string", "channelId": "string", "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } } ], "nextToken": "string" } ``` #### OriginEndpoint schema OriginEndpoint ``` { "startoverWindowSeconds": integer, "manifestName": "string", "description": "string", "dashPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string", "profile": enum, "utcTiming": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "suggestedPresentationDelaySeconds": integer, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "whitelist": [ "string" ], "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "adMarkers": enum, "playlistWindowSeconds": integer, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "url": "string" } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "playlistWindowSeconds": integer, "includeDvbSubtitles": boolean, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "url": "string", "tags": { }, "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "createdAt": "string", "origination": enum, "timeDelaySeconds": integer, "id": "string", "arn": "string", "channelId": "string", "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } } ``` ## Properties ### AdsOnDeliveryRestrictions This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Value description: + `NONE` - No SCTE-35 messages become ads. + `RESTRICTED` - SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. + `UNRESTRICTED` - SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. + `BOTH` - All SCTE-35 messages of the types specified in AdTriggers will be treated as ads. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). + `NONE` + `RESTRICTED` + `UNRESTRICTED` + `BOTH` ### Authorization Parameters for enabling CDN authorization on the endpoint. | Property | Type | Required | Description | | --- |--- |--- |--- | | cdnIdentifierSecret | string | True | The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that your Content Delivery Network (CDN) uses for authorization to access your endpoint. | | secretsRoleArn | string | True | The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. | ### CmafEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | constantInitializationVector | string | False | An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). | | encryptionMethod | [CmafEncryptionMethod](#origin_endpoints-model-cmafencryptionmethod) | False | The encryption method to use. | | keyRotationIntervalSeconds | integer | False | Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to `0` to disable key rotation. | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### CmafEncryptionMethod The encryption method to use. + `SAMPLE_AES` + `AES_CTR` ### CmafPackage Parameters for Common Media Application Format (CMAF) packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | encryption | [CmafEncryption](#origin_endpoints-model-cmafencryption) | False | Parameters for encrypting content. | | hlsManifests | Array of type [HlsManifest](#origin_endpoints-model-hlsmanifest) | False | A list of HLS manifest configurations available from this endpoint. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration. | | segmentPrefix | string | False | An optional custom string that is prepended to the name of each segment. If not specified, the segment prefix defaults to the ChannelId. | | streamSelection | [StreamSelection](#origin_endpoints-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | ### CmafPackageCreateOrUpdateParameters Parameters for creating an endpoint that supports Common Media Application Format (CMAF) packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | encryption | [CmafEncryption](#origin_endpoints-model-cmafencryption) | False | Parameters for encrypting content. | | hlsManifests | Array of type [HlsManifestCreateOrUpdateParameters](#origin_endpoints-model-hlsmanifestcreateorupdateparameters) | False | A list of HLS manifest configurations available from this endpoint. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration. | | segmentPrefix | string | False | An optional custom string that is prepended to the name of each segment. If not specified, the segment prefix defaults to the ChannelId. | | streamSelection | [StreamSelection](#origin_endpoints-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | ### DashEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | keyRotationIntervalSeconds | integer | False | Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to `0` to disable key rotation. | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### DashPackage Parameters for DASH packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | adsOnDeliveryRestrictions | [AdsOnDeliveryRestrictions](#origin_endpoints-model-adsondeliveryrestrictions) | False | The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | adTriggers | Array of type string | False | The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | encryption | [DashEncryption](#origin_endpoints-model-dashencryption) | False | Parameters for encrypting content. | | includeIframeOnlyStream | boolean | False | When enabled, an I-Frame only stream will be included in the output. | | manifestLayout | stringValues: `FULL \| COMPACT` | False | Determines the position of some tags in the manifest. Value description: `FULL` - Elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`. `COMPACT` - Duplicate elements are combined and presented at the `AdaptationSet` level. | | manifestWindowSeconds | integer | False | Time window (in seconds) contained in each manifest. | | minBufferTimeSeconds | integer | False | Minimum amount of content (measured in seconds) that a player must keep available in the buffer. | | minUpdatePeriodSeconds | integer | False | Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. | | periodTriggers | Array of type stringValues: `ADS` | False | A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type **ADS** to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. 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](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html). | | profile | stringValues: `NONE \| HBBTV_1_5 \| HYBRIDCAST \| DVB_DASH_2014` | False | The DASH profile for the output.Value description: `NONE` - The output doesn't use a DASH profile. `HBBTV_1_5` - The output is compliant with HbbTV v1.5. For information about HbbTV v1.5, see the [HbbTV specification website](https://www.hbbtv.org/resource-library/specifications/). `HYBRIDCAST` - The output is compliant with Hybridcast. For more information about Hybridcast, see the [IPTV Forum Japan Hybridcast specification](https://www.iptvforum.jp/en/hybridcast/specification.html). `DVB_DASH_2014` - The output is compliant with DVB-DASH 2014. For more information about DVB-DASH 2014, see the [DVB-DASH specification](https://www.etsi.org/deliver/etsi_ts/103200_103299/103285/01.01.01_60/ts_103285v010101p.pdf). | | segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. | | segmentTemplateFormat | stringValues: `NUMBER_WITH_TIMELINE \| TIME_WITH_TIMELINE \| NUMBER_WITH_DURATION` | False | 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`. `NUMBER_WITH_DURATION` - The `$Number$` variable is used in the `media ` URL and a `duration` attribute is added to the segment template. The `SegmentTimeline` object is removed from the representation. `TIME_WITH_TIMELINE` - The `$Time$` variable is used in the `media` URL. The value of this variable is the timestamp of when the segment starts. A full `SegmentTimeline` object is presented in each `SegmentTemplate`. | | streamSelection | [StreamSelection](#origin_endpoints-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | | suggestedPresentationDelaySeconds | integer | False | Amount of time (in seconds) that the player should be from the live point at the end of the manifest. | | utcTiming | stringValues: `NONE \| HTTP-HEAD \| HTTP-ISO \| HTTP-XSDATE` | False | Determines the type of UTC timing included in the DASH Media Presentation Description (MPD). | | utcTimingUri | string | False | Specifies the value attribute of the UTC timing field when utcTiming is set to `HTTP-ISO` or `HTTP-HEAD`. | ### EncryptionContractConfiguration Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines the content keys 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. For more information about these presets, see [SPEKE Version 2.0 Presets](https://docs.aws.amazon.com/mediapackage/latest/ug/drm-content-speke-v2-presets.html) Note the following considerations when using `encryptionContractConfiguration`: + You can use `encryptionContractConfiguration` for DASH endpoints that use SPEKE Version 2.0. SPEKE Version 2.0 relies on the CPIX Version 2.3 specification. + You must disable key rotation for this endpoint by setting `keyRotationIntervalSeconds` to `0`. + You cannot combine an `UNENCRYPTED` preset with `UNENCRYPTED` or `SHARED` presets across `presetSpeke20Audio` and `presetSpeke20Video`. + When you use a `SHARED` preset, you must use it for both `presetSpeke20Audio` and `presetSpeke20Video`. | Property | Type | Required | Description | | --- |--- |--- |--- | | presetSpeke20Audio | stringValues: `PRESET-AUDIO-1 \| PRESET-AUDIO-2 \| PRESET-AUDIO-3 \| SHARED \| UNENCRYPTED` | True | 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 | stringValues: `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` | True | 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\$1HD1 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\$1HD1 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. | ### HlsEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | constantInitializationVector | string | False | A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. | | encryptionMethod | stringValues: `AES_128 \| SAMPLE_AES` | False | HLS encryption type. | | keyRotationIntervalSeconds | integer | False | Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to `0` to disable key rotation. | | repeatExtXKey | boolean | False | Repeat the EXT-X-KEY directive for every media segment. This might result in an increase in client requests to the DRM server. | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### HlsManifest A HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint. | Property | Type | Required | Description | | --- |--- |--- |--- | | adMarkers | stringValues: `NONE \| SCTE35_ENHANCED \| PASSTHROUGH \| DATERANGE` | False | Controls how ad markers are included in the packaged endpoint.Value description: `NONE` - Omits all SCTE-35 ad markers from the output. `PASSTHROUGH` - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest. `SCTE35_ENHANCED` - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest. `DATERANGE` - Inserts SCTE-35 `EXT-X-DATERANGE` tags to signal ad and program transition events in HLS and CMAF manifests. If you use `DATERANGE`, you must set a `programDateTimeIntervalSeconds` value greater than `0`. To learn more about `DATERANGE`, see [SCTE-35 Ad Marker EXT-X-DATERANGE](https://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html). | | id | string | True | The manifest ID is required and must be unique within the OriginEndpoint. The ID can't be changed after the endpoint is created. | | includeIframeOnlyStream | boolean | False | Applies to stream sets with a single video track only. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. | | playlistType | stringValues: `NONE \| EVENT \| VOD` | False | When specified as either `event` or `vod`, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content. | | playlistWindowSeconds | integer | False | Time window (in seconds) contained in each parent manifest. | | programDateTimeIntervalSeconds | integer | False | Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify in seconds between each EXT-XPROGRAM-DATE-TIME tag. If the interval is not specified, or is set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted in the manifest.Omit this attribute or enter `0` to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. | | url | string | False | The URL that's used to request this manifest from this endpoint. | ### HlsManifestCreateOrUpdateParameters Parameters for creating an HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint. | Property | Type | Required | Description | | --- |--- |--- |--- | | adMarkers | stringValues: `NONE \| SCTE35_ENHANCED \| PASSTHROUGH \| DATERANGE` | False | Controls how ad markers are included in the packaged endpoint. Value description: `NONE` - Omits all SCTE-35 ad markers from the output. `PASSTHROUGH` - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest. `SCTE35_ENHANCED` - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest. `DATERANGE` - Inserts SCTE-35 `EXT-X-DATERANGE` tags to signal ad and program transition events in HLS and CMAF manifests. If you use `DATERANGE`, you must set a `programDateTimeIntervalSeconds` value greater than `0`. To learn more about `DATERANGE`, see [SCTE-35 Ad Marker EXT-X-DATERANGE](https://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html). | | adsOnDeliveryRestrictions | [AdsOnDeliveryRestrictions](#origin_endpoints-model-adsondeliveryrestrictions) | False | The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | adTriggers | Array of type string | False | The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | id | string | True | The manifest ID is required and must be unique within the OriginEndpoint. The ID can't be changed after the endpoint is created. | | includeIframeOnlyStream | boolean | False | Applies to stream sets with a single video track only. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. | | playlistType | stringValues: `NONE \| EVENT \| VOD` | False | When specified as either `event` or `vod`, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content. | | playlistWindowSeconds | integer | False | Time window (in seconds) contained in each parent manifest. | | programDateTimeIntervalSeconds | integer | False | Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify in seconds between each EXT-XPROGRAM-DATE-TIME tag. If the interval is not specified, or is set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted in the manifest.Omit this attribute or enter `0` to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. | ### HlsPackage Parameters for Apple HLS packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | adMarkers | stringValues: `NONE \| SCTE35_ENHANCED \| PASSTHROUGH \| DATERANGE` | False | Controls how ad markers are included in the packaged endpoint.Value description: `NONE` - Omits all SCTE-35 ad markers from the output. `PASSTHROUGH` - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest. `SCTE35_ENHANCED` - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest. `DATERANGE` - Inserts SCTE-35 `EXT-X-DATERANGE` tags to signal ad and program transition events in HLS and CMAF manifests. If you use `DATERANGE`, you must set a `programDateTimeIntervalSeconds` value greater than `0`. To learn more about `DATERANGE`, see [SCTE-35 Ad Marker EXT-X-DATERANGE](https://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html). | | adsOnDeliveryRestrictions | [AdsOnDeliveryRestrictions](#origin_endpoints-model-adsondeliveryrestrictions) | False | The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | adTriggers | Array of type string | False | The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | encryption | [HlsEncryption](#origin_endpoints-model-hlsencryption) | False | Parameters for encrypting content. | | includeDvbSubtitles | boolean | False | When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output. | | includeIframeOnlyStream | boolean | False | Only applies to stream sets with a single video track. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. | | playlistType | stringValues: `NONE \| EVENT \| VOD` | False | When specified as either `event` or `vod`, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content. | | playlistWindowSeconds | integer | False | Time window (in seconds) contained in each parent manifest. | | programDateTimeIntervalSeconds | integer | False | Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify in seconds between each EXT-XPROGRAM-DATE-TIME tag. If the interval is not specified, or is set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted in the manifest.Omit this attribute or enter `0` to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. | | streamSelection | [StreamSelection](#origin_endpoints-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | | useAudioRenditionGroup | boolean | False | When true, AWS Elemental 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. | ### MssEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### MssPackage Parameters for Microsoft Smooth Streaming packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | encryption | [MssEncryption](#origin_endpoints-model-mssencryption) | False | Parameters for encrypting content. | | manifestWindowSeconds | integer | False | Time window (in seconds) contained in each manifest. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. | | streamSelection | [StreamSelection](#origin_endpoints-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | ### OriginEndpoint OriginEndpoint configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The endpoint's unique system-generated resource name, based on the AWS record. | | authorization | [Authorization](#origin_endpoints-model-authorization) | False | Parameters for CDN authorization. | | channelId | string | False | The ID of the channel associated with this endpoint. | | cmafPackage | [CmafPackage](#origin_endpoints-model-cmafpackage) | False | Parameters for CMAF packaging. | | createdAt | string | False | The date and time the OriginEndpoint was created. | | dashPackage | [DashPackage](#origin_endpoints-model-dashpackage) | False | Parameters for DASH packaging. | | description | string | False | Any descriptive information that you want to add to the endpoint for future identification purposes. | | hlsPackage | [HlsPackage](#origin_endpoints-model-hlspackage) | False | Parameters for Apple HLS packaging. | | id | string | False | The endpoint identifier. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. | | mssPackage | [MssPackage](#origin_endpoints-model-msspackage) | False | Parameters for Microsoft Smooth Streaming packaging. | | origination | stringValues: `ALLOW \| DENY` | False | Controls video origination from this endpoint. Value description: `ALLOW` - Enables this endpoint to serve content to requesting devices. `DENY` - Prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see [Live-to-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html). | | startoverWindowSeconds | integer | False | Maximum duration (seconds) of content to retain for startover playback. A `0` indicates that startover playback is disabled for this endpoint. | | tags | [Tags](#origin_endpoints-model-tags) | False | The tags assigned to the endpoint. | | timeDelaySeconds | integer | False | Minimum duration (seconds) of delay to enforce on the playback of live content. A `0` indicates that there is no time delay in effect for this endpoint | | url | string | False | The URL that's used to request content from this endpoint. | | whitelist | Array of type string | False | The IP addresses that can access this endpoint. | ### OriginEndpointCreateParameters OriginEndpoint configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | authorization | [Authorization](#origin_endpoints-model-authorization) | False | Parameters for CDN authorization. | | channelId | string | True | The ID of the channel associated with this endpoint. | | cmafPackage | [CmafPackageCreateOrUpdateParameters](#origin_endpoints-model-cmafpackagecreateorupdateparameters) | False | Parameters for Common Media Application Format (CMAF) packaging. | | dashPackage | [DashPackage](#origin_endpoints-model-dashpackage) | False | Parameters for DASH packaging. | | description | string | False | Any descriptive information that you want to add to the endpoint for future identification purposes. | | hlsPackage | [HlsPackage](#origin_endpoints-model-hlspackage) | False | Parameters for Apple HLS packaging. | | id | string | True | The endpoint ID is required and must be unique for your account in this region. The ID can't be changed after the endpoint is created. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. | | mssPackage | [MssPackage](#origin_endpoints-model-msspackage) | False | Parameters for Microsoft Smooth Streaming packaging. | | origination | stringValues: `ALLOW \| DENY` | False | Controls video origination from this endpoint. Value description: `ALLOW` - Enables this endpoint to serve content to requesting devices. `DENY` - Prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see [Live-to-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html). | | startoverWindowSeconds | integer | False | Maximum duration (seconds) of content to retain for startover playback. Omit this attribute or enter `0` to indicate that startover playback is disabled for this endpoint. | | tags | [Tags](#origin_endpoints-model-tags) | False | The tags to assign to the endpoint. | | timeDelaySeconds | integer | False | Minimum duration (seconds) of delay to enforce on the playback of live content. Omit this attribute or enter `0` to indicate that there is no time delay in effect for this endpoint | | whitelist | Array of type string | False | The IP addresses that can access this endpoint. | ### OriginEndpointList A collection of OriginEndpoint records. | Property | Type | Required | Description | | --- |--- |--- |--- | | nextToken | string | False | Pagination token. Use this token to request the next page of channel results. | | originEndpoints | Array of type [OriginEndpoint](#origin_endpoints-model-originendpoint) | False | List of endpoints that are configured on this account and the channel that you specified in the request parameters. | ### SpekeKeyProvider Keyprovider settings for DRM. | Property | Type | Required | Description | | --- |--- |--- |--- | | certificateArn | string | False | The Amazon Resource Name (ARN) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint. For this feature to work, your DRM key provider must support content key encryption. | | encryptionContractConfiguration | [EncryptionContractConfiguration](#origin_endpoints-model-encryptioncontractconfiguration) | False | Use `encryptionContractConfiguration` to 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. | | resourceId | string | True | Unique identifier for this endpoint, as it is configured in the key provider service. | | roleArn | string | True | 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 AWS Elemental MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Valid format: `arn:aws:iam::accountID:role/name` | | systemIds | Array of type string | True | List of unique identifiers for the DRM systems to use, as defined in the CPIX specification. | | url | string | True | URL for the key provider’s key retrieval API endpoint. Must start with https://. | ### StreamSelection Limitations for outputs from the endpoint, based on the video bitrate. | Property | Type | Required | Description | | --- |--- |--- |--- | | maxVideoBitsPerSecond | integer | False | The upper limit of the bitrates that this endpoint serves. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output. If you don't specify a value, it defaults to 2147483647 bits per second. | | minVideoBitsPerSecond | integer | False | The lower limit of the bitrates that this endpoint serves. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output. If you don't specify a value, it defaults to 0 bits per second. | | streamOrder | stringValues: `ORIGINAL \| VIDEO_BITRATE_ASCENDING \| VIDEO_BITRATE_DESCENDING` | False | Order in which the different video bitrates are presented to the player. | ### Tags A collection of tags associated with a resource. Value description: + **Property**: `"key1": "value1"` + **Type**: string + **Required**: True + **Description**: A comma-separated list of tag key:value pairs that you define. For example: ``` { "Key1": "Value1", "Key2": "Value2" } ``` | Property | Type | Required | Description | | --- |--- |--- |--- | | `*` | string | False | | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### ListOriginEndpoints + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/ListOriginEndpoints) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/ListOriginEndpoints) ### CreateOriginEndpoint + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/CreateOriginEndpoint) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/CreateOriginEndpoint) # Origin\$1endpoints id ## URI `/origin_endpoints/id` ## HTTP methods ### GET **Operation ID:** `DescribeOriginEndpoint` Provides details about an endpoint. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | OriginEndpoint | `200 OK` responseEndpoint details are returned successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### PUT **Operation ID:** `UpdateOriginEndpoint` Updates a specific endpoint. When you submit the request to update an endpoint, include all necessary attributes in the request, even the ones that aren't being updated. If you send only the updated attributes, then all modifiable attributes that weren't specifically included in the request will reset to default values. For example, if you are using a 30 second time delay and submit a request to only update the endpoint description, then the time delay will update to zero (disabled). We recommend that you submit a GET request to obtain the endpoint's existing attributes and submit an updated version of the GET response body when you are updating an endpoint. You can't change the `id` attribute or any other system-generated attributes. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | OriginEndpoint | `200 OK` responseThe endpoint is updated successfully. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### DELETE **Operation ID:** `DeleteOriginEndpoint` Permanently deletes an endpoint. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 202 | None | `202 Accepted` responseAWS Elemental MediaPackage accepted the request but has not processed it yet. | | 403 | None | `403 Forbidden` responseAWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. | | 404 | None | `404 Not Found` responseAWS Elemental MediaPackage did not find a representation of the target resource. | | 422 | None | `422 Unprocessable Entity` responseAWS Elemental MediaPackage could not process the instructions in the body of the request. | | 429 | None | `429 Too Many Requests` responseOne of these two error conditions:Too many requests have been sent in a given amount of time.Your account has exceeded the quota allotted for the resource that you're creating. | | 500 | None | `500 Internal Server Error` responseAn unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. | | 503 | None | `Service unavailable` responseAWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. | ### OPTIONS Enable CORS by returning correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | id | String | True | Identifier for the object that you are working on. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Request bodies #### PUT schema PUT ``` { "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "startoverWindowSeconds": integer, "origination": enum, "timeDelaySeconds": integer, "manifestName": "string", "description": "string", "dashPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string", "profile": enum, "utcTiming": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "suggestedPresentationDelaySeconds": integer, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "whitelist": [ "string" ], "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "adMarkers": enum, "playlistWindowSeconds": integer, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "playlistWindowSeconds": integer, "includeDvbSubtitles": boolean, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } } ``` ### Response bodies #### OriginEndpoint schema OriginEndpoint ``` { "startoverWindowSeconds": integer, "manifestName": "string", "description": "string", "dashPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string", "profile": enum, "utcTiming": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "suggestedPresentationDelaySeconds": integer, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "whitelist": [ "string" ], "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "adMarkers": enum, "playlistWindowSeconds": integer, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "url": "string" } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "playlistWindowSeconds": integer, "includeDvbSubtitles": boolean, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "url": "string", "tags": { }, "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "createdAt": "string", "origination": enum, "timeDelaySeconds": integer, "id": "string", "arn": "string", "channelId": "string", "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } } ``` ## Properties ### AdsOnDeliveryRestrictions This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Value description: + `NONE` - No SCTE-35 messages become ads. + `RESTRICTED` - SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. + `UNRESTRICTED` - SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. + `BOTH` - All SCTE-35 messages of the types specified in AdTriggers will be treated as ads. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). + `NONE` + `RESTRICTED` + `UNRESTRICTED` + `BOTH` ### Authorization Parameters for enabling CDN authorization on the endpoint. | Property | Type | Required | Description | | --- |--- |--- |--- | | cdnIdentifierSecret | string | True | The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that your Content Delivery Network (CDN) uses for authorization to access your endpoint. | | secretsRoleArn | string | True | The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager. | ### CmafEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | constantInitializationVector | string | False | An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). | | encryptionMethod | [CmafEncryptionMethod](#origin_endpoints-id-model-cmafencryptionmethod) | False | The encryption method to use. | | keyRotationIntervalSeconds | integer | False | Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to `0` to disable key rotation. | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-id-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### CmafEncryptionMethod The encryption method to use. + `SAMPLE_AES` + `AES_CTR` ### CmafPackage Parameters for Common Media Application Format (CMAF) packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | encryption | [CmafEncryption](#origin_endpoints-id-model-cmafencryption) | False | Parameters for encrypting content. | | hlsManifests | Array of type [HlsManifest](#origin_endpoints-id-model-hlsmanifest) | False | A list of HLS manifest configurations available from this endpoint. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration. | | segmentPrefix | string | False | An optional custom string that is prepended to the name of each segment. If not specified, the segment prefix defaults to the ChannelId. | | streamSelection | [StreamSelection](#origin_endpoints-id-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | ### CmafPackageCreateOrUpdateParameters Parameters for creating an endpoint that supports Common Media Application Format (CMAF) packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | encryption | [CmafEncryption](#origin_endpoints-id-model-cmafencryption) | False | Parameters for encrypting content. | | hlsManifests | Array of type [HlsManifestCreateOrUpdateParameters](#origin_endpoints-id-model-hlsmanifestcreateorupdateparameters) | False | A list of HLS manifest configurations available from this endpoint. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration. | | segmentPrefix | string | False | An optional custom string that is prepended to the name of each segment. If not specified, the segment prefix defaults to the ChannelId. | | streamSelection | [StreamSelection](#origin_endpoints-id-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | ### DashEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | keyRotationIntervalSeconds | integer | False | Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to `0` to disable key rotation. | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-id-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### DashPackage Parameters for DASH packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | adsOnDeliveryRestrictions | [AdsOnDeliveryRestrictions](#origin_endpoints-id-model-adsondeliveryrestrictions) | False | The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | adTriggers | Array of type string | False | The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | encryption | [DashEncryption](#origin_endpoints-id-model-dashencryption) | False | Parameters for encrypting content. | | includeIframeOnlyStream | boolean | False | When enabled, an I-Frame only stream will be included in the output. | | manifestLayout | stringValues: `FULL \| COMPACT` | False | Determines the position of some tags in the manifest. Value description: `FULL` - Elements like `SegmentTemplate` and `ContentProtection` are included in each `Representation`. `COMPACT` - Duplicate elements are combined and presented at the `AdaptationSet` level. | | manifestWindowSeconds | integer | False | Time window (in seconds) contained in each manifest. | | minBufferTimeSeconds | integer | False | Minimum amount of content (measured in seconds) that a player must keep available in the buffer. | | minUpdatePeriodSeconds | integer | False | Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. | | periodTriggers | Array of type stringValues: `ADS` | False | A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type **ADS** to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. 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](https://docs.aws.amazon.com/mediapackage/latest/ug/multi-period.html). | | profile | stringValues: `NONE \| HBBTV_1_5 \| HYBRIDCAST \| DVB_DASH_2014` | False | The DASH profile for the output.Value description: `NONE` - The output doesn't use a DASH profile. `HBBTV_1_5` - The output is compliant with HbbTV v1.5. For information about HbbTV v1.5, see the [HbbTV specification website](https://www.hbbtv.org/resource-library/specifications/). `HYBRIDCAST` - The output is compliant with Hybridcast. For more information about Hybridcast, see the [IPTV Forum Japan Hybridcast specification](https://www.iptvforum.jp/en/hybridcast/specification.html). `DVB_DASH_2014` - The output is compliant with DVB-DASH 2014. For more information about DVB-DASH 2014, see the [DVB-DASH specification](https://www.etsi.org/deliver/etsi_ts/103200_103299/103285/01.01.01_60/ts_103285v010101p.pdf). | | segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. | | segmentTemplateFormat | stringValues: `NUMBER_WITH_TIMELINE \| TIME_WITH_TIMELINE \| NUMBER_WITH_DURATION` | False | 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`. `NUMBER_WITH_DURATION` - The `$Number$` variable is used in the `media ` URL and a `duration` attribute is added to the segment template. The `SegmentTimeline` object is removed from the representation. `TIME_WITH_TIMELINE` - The `$Time$` variable is used in the `media` URL. The value of this variable is the timestamp of when the segment starts. A full `SegmentTimeline` object is presented in each `SegmentTemplate`. | | streamSelection | [StreamSelection](#origin_endpoints-id-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | | suggestedPresentationDelaySeconds | integer | False | Amount of time (in seconds) that the player should be from the live point at the end of the manifest. | | utcTiming | stringValues: `NONE \| HTTP-HEAD \| HTTP-ISO \| HTTP-XSDATE` | False | Determines the type of UTC timing included in the DASH Media Presentation Description (MPD). | | utcTimingUri | string | False | Specifies the value attribute of the UTC timing field when utcTiming is set to `HTTP-ISO` or `HTTP-HEAD`. | ### EncryptionContractConfiguration Use `encryptionContractConfiguration` to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines the content keys 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. For more information about these presets, see [SPEKE Version 2.0 Presets](https://docs.aws.amazon.com/mediapackage/latest/ug/drm-content-speke-v2-presets.html) Note the following considerations when using `encryptionContractConfiguration`: + You can use `encryptionContractConfiguration` for DASH endpoints that use SPEKE Version 2.0. SPEKE Version 2.0 relies on the CPIX Version 2.3 specification. + You must disable key rotation for this endpoint by setting `keyRotationIntervalSeconds` to `0`. + You cannot combine an `UNENCRYPTED` preset with `UNENCRYPTED` or `SHARED` presets across `presetSpeke20Audio` and `presetSpeke20Video`. + When you use a `SHARED` preset, you must use it for both `presetSpeke20Audio` and `presetSpeke20Video`. | Property | Type | Required | Description | | --- |--- |--- |--- | | presetSpeke20Audio | stringValues: `PRESET-AUDIO-1 \| PRESET-AUDIO-2 \| PRESET-AUDIO-3 \| SHARED \| UNENCRYPTED` | True | 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 | stringValues: `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` | True | 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\$1HD1 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\$1HD1 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. | ### HlsEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | constantInitializationVector | string | False | A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. | | encryptionMethod | stringValues: `AES_128 \| SAMPLE_AES` | False | HLS encryption type. | | keyRotationIntervalSeconds | integer | False | Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to `0` to disable key rotation. | | repeatExtXKey | boolean | False | Repeat the EXT-X-KEY directive for every media segment. This might result in an increase in client requests to the DRM server. | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-id-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### HlsManifest A HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint. | Property | Type | Required | Description | | --- |--- |--- |--- | | adMarkers | stringValues: `NONE \| SCTE35_ENHANCED \| PASSTHROUGH \| DATERANGE` | False | Controls how ad markers are included in the packaged endpoint.Value description: `NONE` - Omits all SCTE-35 ad markers from the output. `PASSTHROUGH` - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest. `SCTE35_ENHANCED` - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest. `DATERANGE` - Inserts SCTE-35 `EXT-X-DATERANGE` tags to signal ad and program transition events in HLS and CMAF manifests. If you use `DATERANGE`, you must set a `programDateTimeIntervalSeconds` value greater than `0`. To learn more about `DATERANGE`, see [SCTE-35 Ad Marker EXT-X-DATERANGE](https://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html). | | id | string | True | The manifest ID is required and must be unique within the OriginEndpoint. The ID can't be changed after the endpoint is created. | | includeIframeOnlyStream | boolean | False | Applies to stream sets with a single video track only. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. | | playlistType | stringValues: `NONE \| EVENT \| VOD` | False | When specified as either `event` or `vod`, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content. | | playlistWindowSeconds | integer | False | Time window (in seconds) contained in each parent manifest. | | programDateTimeIntervalSeconds | integer | False | Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify in seconds between each EXT-XPROGRAM-DATE-TIME tag. If the interval is not specified, or is set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted in the manifest.Omit this attribute or enter `0` to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. | | url | string | False | The URL that's used to request this manifest from this endpoint. | ### HlsManifestCreateOrUpdateParameters Parameters for creating an HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint. | Property | Type | Required | Description | | --- |--- |--- |--- | | adMarkers | stringValues: `NONE \| SCTE35_ENHANCED \| PASSTHROUGH \| DATERANGE` | False | Controls how ad markers are included in the packaged endpoint. Value description: `NONE` - Omits all SCTE-35 ad markers from the output. `PASSTHROUGH` - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest. `SCTE35_ENHANCED` - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest. `DATERANGE` - Inserts SCTE-35 `EXT-X-DATERANGE` tags to signal ad and program transition events in HLS and CMAF manifests. If you use `DATERANGE`, you must set a `programDateTimeIntervalSeconds` value greater than `0`. To learn more about `DATERANGE`, see [SCTE-35 Ad Marker EXT-X-DATERANGE](https://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html). | | adsOnDeliveryRestrictions | [AdsOnDeliveryRestrictions](#origin_endpoints-id-model-adsondeliveryrestrictions) | False | The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | adTriggers | Array of type string | False | The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | id | string | True | The manifest ID is required and must be unique within the OriginEndpoint. The ID can't be changed after the endpoint is created. | | includeIframeOnlyStream | boolean | False | Applies to stream sets with a single video track only. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. | | playlistType | stringValues: `NONE \| EVENT \| VOD` | False | When specified as either `event` or `vod`, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content. | | playlistWindowSeconds | integer | False | Time window (in seconds) contained in each parent manifest. | | programDateTimeIntervalSeconds | integer | False | Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify in seconds between each EXT-XPROGRAM-DATE-TIME tag. If the interval is not specified, or is set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted in the manifest.Omit this attribute or enter `0` to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. | ### HlsPackage Parameters for Apple HLS packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | adMarkers | stringValues: `NONE \| SCTE35_ENHANCED \| PASSTHROUGH \| DATERANGE` | False | Controls how ad markers are included in the packaged endpoint.Value description: `NONE` - Omits all SCTE-35 ad markers from the output. `PASSTHROUGH` - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest. `SCTE35_ENHANCED` - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest. `DATERANGE` - Inserts SCTE-35 `EXT-X-DATERANGE` tags to signal ad and program transition events in HLS and CMAF manifests. If you use `DATERANGE`, you must set a `programDateTimeIntervalSeconds` value greater than `0`. To learn more about `DATERANGE`, see [SCTE-35 Ad Marker EXT-X-DATERANGE](https://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html). | | adsOnDeliveryRestrictions | [AdsOnDeliveryRestrictions](#origin_endpoints-id-model-adsondeliveryrestrictions) | False | The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | adTriggers | Array of type string | False | The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see [SCTE-35 Message Options in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/scte.html). | | encryption | [HlsEncryption](#origin_endpoints-id-model-hlsencryption) | False | Parameters for encrypting content. | | includeDvbSubtitles | boolean | False | When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output. | | includeIframeOnlyStream | boolean | False | Only applies to stream sets with a single video track. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. | | playlistType | stringValues: `NONE \| EVENT \| VOD` | False | When specified as either `event` or `vod`, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content. | | playlistWindowSeconds | integer | False | Time window (in seconds) contained in each parent manifest. | | programDateTimeIntervalSeconds | integer | False | Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify in seconds between each EXT-XPROGRAM-DATE-TIME tag. If the interval is not specified, or is set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted in the manifest.Omit this attribute or enter `0` to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. | | streamSelection | [StreamSelection](#origin_endpoints-id-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | | useAudioRenditionGroup | boolean | False | When true, AWS Elemental 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. | ### MssEncryption Holds encryption information so that access to the content can be controlled by a DRM solution. | Property | Type | Required | Description | | --- |--- |--- |--- | | spekeKeyProvider | [SpekeKeyProvider](#origin_endpoints-id-model-spekekeyprovider) | True | Parameters for the SPEKE key provider. | ### MssPackage Parameters for Microsoft Smooth Streaming packaging. | Property | Type | Required | Description | | --- |--- |--- |--- | | encryption | [MssEncryption](#origin_endpoints-id-model-mssencryption) | False | Parameters for encrypting content. | | manifestWindowSeconds | integer | False | Time window (in seconds) contained in each manifest. | | segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. | | streamSelection | [StreamSelection](#origin_endpoints-id-model-streamselection) | False | Limitations for outputs from the endpoint, based on the video bitrate. | ### OriginEndpoint OriginEndpoint configuration. | Property | Type | Required | Description | | --- |--- |--- |--- | | arn | string | False | The endpoint's unique system-generated resource name, based on the AWS record. | | authorization | [Authorization](#origin_endpoints-id-model-authorization) | False | Parameters for CDN authorization. | | channelId | string | False | The ID of the channel associated with this endpoint. | | cmafPackage | [CmafPackage](#origin_endpoints-id-model-cmafpackage) | False | Parameters for CMAF packaging. | | createdAt | string | False | The date and time the OriginEndpoint was created. | | dashPackage | [DashPackage](#origin_endpoints-id-model-dashpackage) | False | Parameters for DASH packaging. | | description | string | False | Any descriptive information that you want to add to the endpoint for future identification purposes. | | hlsPackage | [HlsPackage](#origin_endpoints-id-model-hlspackage) | False | Parameters for Apple HLS packaging. | | id | string | False | The endpoint identifier. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. | | mssPackage | [MssPackage](#origin_endpoints-id-model-msspackage) | False | Parameters for Microsoft Smooth Streaming packaging. | | origination | stringValues: `ALLOW \| DENY` | False | Controls video origination from this endpoint. Value description: `ALLOW` - Enables this endpoint to serve content to requesting devices. `DENY` - Prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see [Live-to-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html). | | startoverWindowSeconds | integer | False | Maximum duration (seconds) of content to retain for startover playback. A `0` indicates that startover playback is disabled for this endpoint. | | tags | [Tags](#origin_endpoints-id-model-tags) | False | The tags assigned to the endpoint. | | timeDelaySeconds | integer | False | Minimum duration (seconds) of delay to enforce on the playback of live content. A `0` indicates that there is no time delay in effect for this endpoint | | url | string | False | The URL that's used to request content from this endpoint. | | whitelist | Array of type string | False | The IP addresses that can access this endpoint. | ### OriginEndpointUpdateParameters OriginEndpoint configuration | Property | Type | Required | Description | | --- |--- |--- |--- | | authorization | [Authorization](#origin_endpoints-id-model-authorization) | False | Parameters for CDN authorization. | | cmafPackage | [CmafPackageCreateOrUpdateParameters](#origin_endpoints-id-model-cmafpackagecreateorupdateparameters) | False | Parameters for CMAF packaging. | | dashPackage | [DashPackage](#origin_endpoints-id-model-dashpackage) | False | Parameters for DASH packaging. | | description | string | False | Any descriptive information that you want to add to the endpoint for future identification purposes. | | hlsPackage | [HlsPackage](#origin_endpoints-id-model-hlspackage) | False | Parameters for Apple HLS packaging. | | manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. | | mssPackage | [MssPackage](#origin_endpoints-id-model-msspackage) | False | Parameters for Microsoft Smooth Streaming packaging. | | origination | stringValues: `ALLOW \| DENY` | False | Controls video origination from this endpoint. Value description: `ALLOW` - Enables this endpoint to serve content to requesting devices. `DENY` - Prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see [Live-to-VOD Requirements](https://docs.aws.amazon.com/mediapackage/latest/ug/ltov-reqmts.html). | | startoverWindowSeconds | integer | False | Maximum duration (seconds) of content to retain for startover playback. Enter `0` to indicate that startover playback is disabled for this endpoint. | | timeDelaySeconds | integer | False | Minimum duration (seconds) of delay to enforce on the playback of live content. Enter `0` to indicate that there is no time delay in effect for this endpoint. | | whitelist | Array of type string | False | The IP addresses that can access this endpoint. | ### SpekeKeyProvider Keyprovider settings for DRM. | Property | Type | Required | Description | | --- |--- |--- |--- | | certificateArn | string | False | The Amazon Resource Name (ARN) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint. For this feature to work, your DRM key provider must support content key encryption. | | encryptionContractConfiguration | [EncryptionContractConfiguration](#origin_endpoints-id-model-encryptioncontractconfiguration) | False | Use `encryptionContractConfiguration` to 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. | | resourceId | string | True | Unique identifier for this endpoint, as it is configured in the key provider service. | | roleArn | string | True | 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 AWS Elemental MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Valid format: `arn:aws:iam::accountID:role/name` | | systemIds | Array of type string | True | List of unique identifiers for the DRM systems to use, as defined in the CPIX specification. | | url | string | True | URL for the key provider’s key retrieval API endpoint. Must start with https://. | ### StreamSelection Limitations for outputs from the endpoint, based on the video bitrate. | Property | Type | Required | Description | | --- |--- |--- |--- | | maxVideoBitsPerSecond | integer | False | The upper limit of the bitrates that this endpoint serves. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output. If you don't specify a value, it defaults to 2147483647 bits per second. | | minVideoBitsPerSecond | integer | False | The lower limit of the bitrates that this endpoint serves. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output. If you don't specify a value, it defaults to 0 bits per second. | | streamOrder | stringValues: `ORIGINAL \| VIDEO_BITRATE_ASCENDING \| VIDEO_BITRATE_DESCENDING` | False | Order in which the different video bitrates are presented to the player. | ### Tags A collection of tags associated with a resource. Value description: + **Property**: `"key1": "value1"` + **Type**: string + **Required**: True + **Description**: A comma-separated list of tag key:value pairs that you define. For example: ``` { "Key1": "Value1", "Key2": "Value2" } ``` | Property | Type | Required | Description | | --- |--- |--- |--- | | `*` | string | False | | ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### DescribeOriginEndpoint + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/DescribeOriginEndpoint) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/DescribeOriginEndpoint) ### UpdateOriginEndpoint + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/UpdateOriginEndpoint) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/UpdateOriginEndpoint) ### DeleteOriginEndpoint + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/DeleteOriginEndpoint) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/DeleteOriginEndpoint) # Tags resource-arn Manage tags for AWS Elemental MediaPackage channels and endpoints. Tags are key-value pairs that you can associate with Amazon resources. MediaPackage offers tagging support for channel and endpoint resources. For information about tagging, see [Tagging Resources in AWS Elemental MediaPackage](https://docs.aws.amazon.com/mediapackage/latest/ug/tagging.html). ## URI `/tags/resource-arn` ## HTTP methods ### GET **Operation ID:** `ListTagsForResource` Returns a list of the tags assigned to the specified resource (either a channel or endpoint). **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resource-arn | String | True | The Amazon Resource Name (ARN) for the channel or endpoint. You can get this from the response to any request to the resource. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | tagsModel | `200 OK` responseThe list of tags is returned successfully. | ### POST **Operation ID:** `TagResource` Adds tags to the specified channel or endpoint resource. You can specify one or more tags to add. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resource-arn | String | True | The Amazon Resource Name (ARN) for the channel or endpoint. You can get this from the response to any request to the resource. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 204 | None | The request was successful. There is no content in the response. | ### DELETE **Operation ID:** `UntagResource` Removes tags from the specified channel or endpoint resource. You can specify one or more tags to remove. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resource-arn | String | True | The Amazon Resource Name (ARN) for the channel or endpoint. You can get this from the response to any request to the resource. | **Query parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | tagKeys | String | True | A comma-separated list of the tag keys to remove from the channel or endpoint. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 204 | None | The request was successful. There is no content in the response. | ### OPTIONS Enable CORS by returning correct headers. **Path parameters** | Name | Type | Required | Description | | --- |--- |--- |--- | | resource-arn | String | True | The Amazon Resource Name (ARN) for the channel or endpoint. You can get this from the response to any request to the resource. | **Responses** | Status code | Response model | Description | | --- |--- |--- | | 200 | None | Default response for CORS method. | ## Schemas ### Request bodies #### POST schema POST ``` { "tags": { } } ``` ### Response bodies #### tagsModel schema tagsModel ``` { "tags": { } } ``` ## Properties ### tagsModel The key:value pairs used in a tag. | Property | Type | Required | Description | | --- |--- |--- |--- | | tags | object | True | A comma-separated list of tag key:value pairs. For example: 
 {
   "Key1": "Value1",
   "Key2": "Value2"
 }
| ## See also For more information about using this API in one of the language-specific AWS SDKs and references, see the following: ### ListTagsForResource + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/ListTagsForResource) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/ListTagsForResource) ### TagResource + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/TagResource) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/TagResource) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/TagResource) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/TagResource) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/TagResource) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/TagResource) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/TagResource) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/TagResource) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/TagResource) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/TagResource) ### UntagResource + [AWS Command Line Interface V2](/goto/cli2/mediapackage-2017-10-12/UntagResource) + [AWS SDK for .NET V4](/goto/DotNetSDKV4/mediapackage-2017-10-12/UntagResource) + [AWS SDK for C\$1\$1](/goto/SdkForCpp/mediapackage-2017-10-12/UntagResource) + [AWS SDK for Go v2](/goto/SdkForGoV2/mediapackage-2017-10-12/UntagResource) + [AWS SDK for Java V2](/goto/SdkForJavaV2/mediapackage-2017-10-12/UntagResource) + [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/mediapackage-2017-10-12/UntagResource) + [AWS SDK for Kotlin](/goto/SdkForKotlin/mediapackage-2017-10-12/UntagResource) + [AWS SDK for PHP V3](/goto/SdkForPHPV3/mediapackage-2017-10-12/UntagResource) + [AWS SDK for Python](/goto/boto3/mediapackage-2017-10-12/UntagResource) + [AWS SDK for Ruby V3](/goto/SdkForRubyV3/mediapackage-2017-10-12/UntagResource)