2018/08/29 - AWS Elemental MediaPackage - 1 new5 updated api methods
Changes Update mediapackage client to latest version
Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
See also: AWS API Documentation
Request Syntax
client.rotate_ingest_endpoint_credentials(
Id='string',
IngestEndpointId='string'
)
string
[REQUIRED] The ID of the channel the IngestEndpoint is on.
string
[REQUIRED] The id of the IngestEndpoint whose credentials should be rotated
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string'
}
Response Structure
(dict) -- The updated Channel record.
Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
Description (string) -- A short text description of the Channel.
HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
(dict) -- An endpoint for ingesting source content for a Channel.
Id (string) -- The system generated unique identifier for the IngestEndpoint
Password (string) -- The system generated password for ingest authentication.
Url (string) -- The ingest URL to which the source stream should be sent.
Username (string) -- The system generated username for ingest authentication.
Id (string) -- The ID of the Channel.
{'HlsIngest': {'IngestEndpoints': {'Id': 'string'}}}
Creates a new Channel.
See also: AWS API Documentation
Request Syntax
client.create_channel(
Description='string',
Id='string'
)
string
A short text description of the Channel.
string
[REQUIRED] The ID of the Channel. The ID must be unique within the region and it cannot be changed after a Channel is created.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string'
}
Response Structure
(dict) -- The new Channel record.
Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
Description (string) -- A short text description of the Channel.
HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
(dict) -- An endpoint for ingesting source content for a Channel.
Id (string) -- The system generated unique identifier for the IngestEndpoint
Password (string) -- The system generated password for ingest authentication.
Url (string) -- The ingest URL to which the source stream should be sent.
Username (string) -- The system generated username for ingest authentication.
Id (string) -- The ID of the Channel.
{'HlsIngest': {'IngestEndpoints': {'Id': 'string'}}}
Gets details about a Channel.
See also: AWS API Documentation
Request Syntax
client.describe_channel(
Id='string'
)
string
[REQUIRED] The ID of a Channel.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string'
}
Response Structure
(dict) -- A Channel record.
Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
Description (string) -- A short text description of the Channel.
HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
(dict) -- An endpoint for ingesting source content for a Channel.
Id (string) -- The system generated unique identifier for the IngestEndpoint
Password (string) -- The system generated password for ingest authentication.
Url (string) -- The ingest URL to which the source stream should be sent.
Username (string) -- The system generated username for ingest authentication.
Id (string) -- The ID of the Channel.
{'Channels': {'HlsIngest': {'IngestEndpoints': {'Id': 'string'}}}}
Returns a collection of Channels.
See also: AWS API Documentation
Request Syntax
client.list_channels(
MaxResults=123,
NextToken='string'
)
integer
Upper bound on number of records to return.
string
A token used to resume pagination from the end of a previous request.
dict
Response Syntax
{
'Channels': [
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) -- A collection of Channel records.
Channels (list) -- A list of Channel records.
(dict) -- A Channel resource configuration.
Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
Description (string) -- A short text description of the Channel.
HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
(dict) -- An endpoint for ingesting source content for a Channel.
Id (string) -- The system generated unique identifier for the IngestEndpoint
Password (string) -- The system generated password for ingest authentication.
Url (string) -- The ingest URL to which the source stream should be sent.
Username (string) -- The system generated username for ingest authentication.
Id (string) -- The ID of the Channel.
NextToken (string) -- A token that can be used to resume pagination from the end of the collection.
{'HlsIngest': {'IngestEndpoints': {'Id': 'string'}}}
Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
See also: AWS API Documentation
Request Syntax
client.rotate_channel_credentials(
Id='string'
)
string
[REQUIRED] The ID of the channel to update.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string'
}
Response Structure
(dict) -- The updated Channel record.
Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
Description (string) -- A short text description of the Channel.
HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
(dict) -- An endpoint for ingesting source content for a Channel.
Id (string) -- The system generated unique identifier for the IngestEndpoint
Password (string) -- The system generated password for ingest authentication.
Url (string) -- The ingest URL to which the source stream should be sent.
Username (string) -- The system generated username for ingest authentication.
Id (string) -- The ID of the Channel.
{'HlsIngest': {'IngestEndpoints': {'Id': 'string'}}}
Updates an existing Channel.
See also: AWS API Documentation
Request Syntax
client.update_channel(
Description='string',
Id='string'
)
string
A short text description of the Channel.
string
[REQUIRED] The ID of the Channel to update.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string'
}
Response Structure
(dict) -- The updated Channel record.
Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
Description (string) -- A short text description of the Channel.
HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
(dict) -- An endpoint for ingesting source content for a Channel.
Id (string) -- The system generated unique identifier for the IngestEndpoint
Password (string) -- The system generated password for ingest authentication.
Url (string) -- The ingest URL to which the source stream should be sent.
Username (string) -- The system generated username for ingest authentication.
Id (string) -- The ID of the Channel.