The Channels API from Amazon MediaPackage — 5 operation(s) for channels.
openapi: 3.0.0
info:
version: 2017-10-12
x-release: v4
title: AWS Elemental MediaPackage Channels API
description: AWS Elemental MediaPackage
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: mediapackage
x-aws-signingName: mediapackage
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediapackage-2017-10-12.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://mediapackage.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaPackage multi-region endpoint
- url: https://mediapackage.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaPackage multi-region endpoint
- url: http://mediapackage.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaPackage endpoint for China (Beijing) and China (Ningxia)
- url: https://mediapackage.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaPackage endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Channels
paths:
/channels/{id}/configure_logs:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
put:
operationId: ConfigureLogs
description: Changes the Channel's properities to configure log subscription
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigureLogsResponse'
examples:
ConfigureLogs200Example:
summary: Default ConfigureLogs 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreatedAt: example-value
Description: Example description
EgressAccessLogs: example-value
HlsIngest: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
ConfigureLogs480Example:
summary: Default ConfigureLogs 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ConfigureLogs481Example:
summary: Default ConfigureLogs 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ConfigureLogs482Example:
summary: Default ConfigureLogs 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ConfigureLogs483Example:
summary: Default ConfigureLogs 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
ConfigureLogs484Example:
summary: Default ConfigureLogs 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
ConfigureLogs485Example:
summary: Default ConfigureLogs 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: The ID of the channel to log subscription.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
egressAccessLogs:
description: Configure egress access logging.
type: object
properties:
LogGroupName:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: logGroupName
description: Customize the log group name.
ingressAccessLogs:
description: Configure ingress access logging.
type: object
properties:
LogGroupName:
allOf:
- $ref: '#/components/schemas/__string'
- xml:
name: logGroupName
description: Customize the log group name.
summary: Amazon MediaPackage Configure Logs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channels
/channels:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateChannel
description: Creates a new Channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateChannelResponse'
examples:
CreateChannel200Example:
summary: Default CreateChannel 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreatedAt: example-value
Description: Example description
EgressAccessLogs: example-value
HlsIngest: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
CreateChannel480Example:
summary: Default CreateChannel 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
CreateChannel481Example:
summary: Default CreateChannel 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
CreateChannel482Example:
summary: Default CreateChannel 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
CreateChannel483Example:
summary: Default CreateChannel 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
CreateChannel484Example:
summary: Default CreateChannel 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
CreateChannel485Example:
summary: Default CreateChannel 485 response
x-microcks-default: true
value: {}
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
properties:
description:
description: A short text description of the Channel.
type: string
id:
description: 'The ID of the Channel. The ID must be unique within the region and it
cannot be changed after a Channel is created.
'
type: string
tags:
description: A collection of tags associated with a resource
type: object
additionalProperties:
$ref: '#/components/schemas/__string'
summary: Amazon MediaPackage Create Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channels
get:
operationId: ListChannels
description: Returns a collection of Channels.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListChannelsResponse'
examples:
ListChannels200Example:
summary: Default ListChannels 200 response
x-microcks-default: true
value:
Channels: example-value
NextToken: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
ListChannels480Example:
summary: Default ListChannels 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
ListChannels481Example:
summary: Default ListChannels 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
ListChannels482Example:
summary: Default ListChannels 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
ListChannels483Example:
summary: Default ListChannels 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
ListChannels484Example:
summary: Default ListChannels 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
ListChannels485Example:
summary: Default ListChannels 485 response
x-microcks-default: true
value: {}
parameters:
- name: maxResults
in: query
required: false
description: Upper bound on number of records to return.
schema:
type: integer
minimum: 1
maximum: 1000
- name: nextToken
in: query
required: false
description: A token used to resume pagination from the end of a previous request.
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon MediaPackage List Channels
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channels
/channels/{id}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteChannel
description: Deletes an existing Channel.
responses:
'202':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteChannelResponse'
examples:
DeleteChannel202Example:
summary: Default DeleteChannel 202 response
x-microcks-default: true
value: {}
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
DeleteChannel480Example:
summary: Default DeleteChannel 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DeleteChannel481Example:
summary: Default DeleteChannel 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
DeleteChannel482Example:
summary: Default DeleteChannel 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
DeleteChannel483Example:
summary: Default DeleteChannel 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
DeleteChannel484Example:
summary: Default DeleteChannel 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
DeleteChannel485Example:
summary: Default DeleteChannel 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: The ID of the Channel to delete.
schema:
type: string
summary: Amazon MediaPackage Delete Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channels
get:
operationId: DescribeChannel
description: Gets details about a Channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeChannelResponse'
examples:
DescribeChannel200Example:
summary: Default DescribeChannel 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreatedAt: example-value
Description: Example description
EgressAccessLogs: example-value
HlsIngest: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
DescribeChannel480Example:
summary: Default DescribeChannel 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
DescribeChannel481Example:
summary: Default DescribeChannel 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
DescribeChannel482Example:
summary: Default DescribeChannel 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
DescribeChannel483Example:
summary: Default DescribeChannel 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
DescribeChannel484Example:
summary: Default DescribeChannel 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
DescribeChannel485Example:
summary: Default DescribeChannel 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: The ID of a Channel.
schema:
type: string
summary: Amazon MediaPackage Describe Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channels
put:
operationId: UpdateChannel
description: Updates an existing Channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateChannelResponse'
examples:
UpdateChannel200Example:
summary: Default UpdateChannel 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreatedAt: example-value
Description: Example description
EgressAccessLogs: example-value
HlsIngest: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
UpdateChannel480Example:
summary: Default UpdateChannel 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
UpdateChannel481Example:
summary: Default UpdateChannel 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
UpdateChannel482Example:
summary: Default UpdateChannel 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
UpdateChannel483Example:
summary: Default UpdateChannel 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
UpdateChannel484Example:
summary: Default UpdateChannel 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
UpdateChannel485Example:
summary: Default UpdateChannel 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: The ID of the Channel to update.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
description: A short text description of the Channel.
type: string
summary: Amazon MediaPackage Update Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channels
/channels/{id}/credentials:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
put:
deprecated: true
operationId: RotateChannelCredentials
description: Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RotateChannelCredentialsResponse'
examples:
RotateChannelCredentials200Example:
summary: Default RotateChannelCredentials 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreatedAt: example-value
Description: Example description
EgressAccessLogs: example-value
HlsIngest: example-value
'480':
description: UnprocessableEntityException
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityException'
examples:
RotateChannelCredentials480Example:
summary: Default RotateChannelCredentials 480 response
x-microcks-default: true
value: {}
'481':
description: InternalServerErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorException'
examples:
RotateChannelCredentials481Example:
summary: Default RotateChannelCredentials 481 response
x-microcks-default: true
value: {}
'482':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenException'
examples:
RotateChannelCredentials482Example:
summary: Default RotateChannelCredentials 482 response
x-microcks-default: true
value: {}
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
examples:
RotateChannelCredentials483Example:
summary: Default RotateChannelCredentials 483 response
x-microcks-default: true
value: {}
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
examples:
RotateChannelCredentials484Example:
summary: Default RotateChannelCredentials 484 response
x-microcks-default: true
value: {}
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
examples:
RotateChannelCredentials485Example:
summary: Default RotateChannelCredentials 485 response
x-microcks-default: true
value: {}
parameters:
- name: id
in: path
required: true
description: The ID of the channel to update.
schema:
type: string
summary: Amazon MediaPackage Rotate Channel Credentials
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channels
/channels/{id}/ingest_endpoints/{ingest_endpoint_id}/credentials:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
put:
operationId: RotateIngestEndpointCredentials
description: Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RotateIngestEndpointCredentialsResponse'
examples:
RotateIngestEndpointCredentials200Example:
summary: Default RotateIngestEndpointCredentials 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:12345678
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediapackage/refs/heads/main/openapi/amazon-mediapackage-channels-api-openapi.yml