Esta documentação é somente para a versão 1 da AWS CLI. Para obter a documentação relacionada à AWS CLI versão 2, consulte o Guia do usuário da versão 2.
Exemplos do MediaPackage usando a AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o MediaPackage.
Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
Tópicos
Ações
O código de exemplo a seguir mostra como usar create-channel
.
- AWS CLI
-
Para criar um canal
O comando
create-channel
a seguir cria um canal chamadosportschannel
na conta atual.aws mediapackage create-channel --id
sportschannel
Saída:
{ "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", "HlsIngest": { "IngestEndpoints": [ { "Id": "6d345804ec3f46c9b454a91d4a80d0e0", "Password": "generatedwebdavpassword1", "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", "Username": "generatedwebdavusername1" }, { "Id": "2daa32878af24803b24183727211b8ff", "Password": "generatedwebdavpassword2", "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", "Username": "generatedwebdavusername2" } ] }, "Id": "sportschannel", "Tags": { "region": "west" } }
Para obter mais informações, consulte Criar um canal no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte CreateChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar create-origin-endpoint
.
- AWS CLI
-
Para criar um endpoint de origem
O comando
create-origin-endpoint
a seguir cria um endpoint de origem chamadocmafsports
com as configurações de pacote fornecidas em um arquivo JSON e as configurações de endpoint especificadas.aws mediapackage create-origin-endpoint \ --channel-id
sportschannel
\ --idcmafsports
\ --cmaf-packagefile://file/path/cmafpkg.json
--description"cmaf output of sports"
\ --idcmaf_sports
\ --manifest-namesports_channel
\ --startover-window-seconds300
\ --tagsregion=west,media=sports
\ --time-delay-seconds10
Saída:
{ "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", "ChannelId": "sportschannel", "CmafPackage": { "HlsManifests": [ { "AdMarkers": "PASSTHROUGH", "Id": "cmaf_sports_endpoint", "IncludeIframeOnlyStream": true, "ManifestName": "index", "PlaylistType": "EVENT", "PlaylistWindowSeconds": 300, "ProgramDateTimeIntervalSeconds": 300, "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" } ], "SegmentDurationSeconds": 2, "SegmentPrefix": "sportschannel" }, "Description": "cmaf output of sports", "Id": "cmaf_sports", "ManifestName": "sports_channel", "StartoverWindowSeconds": 300, "Tags": { "region": "west", "media": "sports" }, "TimeDelaySeconds": 10, "Url": "", "Whitelist": [] }
Para obter mais informações, consulte Criar um endpoint no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte CreateOriginEndpoint
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-channel
.
- AWS CLI
-
Para excluir um canal
O comando
delete-channel
a seguir o canal chamadotest
.aws mediapackage delete-channel \ --id
test
Este comando não produz saída.
Para obter mais informações, consulte Excluir um canal no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte DeleteChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-origin-endpoint
.
- AWS CLI
-
Para excluir um endpoint
O comando
delete-origin-endpoint
a seguir exclui o endpoint de origem chamadotester2
.aws mediapackage delete-origin-endpoint \ --id
tester2
Para obter mais informações, consulte Excluir um endpoint no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte DeleteOriginEndpoint
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-channel
.
- AWS CLI
-
Para descrever um canal
O comando
describe-channel
a seguir exibe todos os detalhes do canal chamadotest
.aws mediapackage describe-channel \ --id
test
Saída:
{ "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", "HlsIngest": { "IngestEndpoints": [ { "Id": "584797f1740548c389a273585dd22a63", "Password": "webdavgeneratedpassword1", "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", "Username": "webdavgeneratedusername1" }, { "Id": "7d187c8616fd455f88aaa5a9fcf74442", "Password": "webdavgeneratedpassword2", "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", "Username": "webdavgeneratedusername2" } ] }, "Id": "test", "Tags": {} }
Para obter mais informações, consulte Visualizar detalhes do canal <https://docs.aws.amazon.com/mediapackage/latest/ug/channels-view.html> no Guia do usuário do AWS Elemental MediaPackage
-
Para ver detalhes da API, consulte DescribeChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-origin-endpoint
.
- AWS CLI
-
Para descrever um endpoint de origem
O comando
describe-origin-endpoint
a seguir exibe todos os detalhes do endpoint de origem chamadocmaf_sports
.aws mediapackage describe-origin-endpoint \ --id
cmaf_sports
Saída:
{ "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", "ChannelId": "sportschannel", "CmafPackage": { "HlsManifests": [ { "AdMarkers": "NONE", "Id": "cmaf_sports_endpoint", "IncludeIframeOnlyStream": false, "PlaylistType": "EVENT", "PlaylistWindowSeconds": 60, "ProgramDateTimeIntervalSeconds": 0, "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" } ], "SegmentDurationSeconds": 2, "SegmentPrefix": "sportschannel" }, "Id": "cmaf_sports", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": { "region": "west", "media": "sports" }, "TimeDelaySeconds": 0, "Url": "", "Whitelist": [] }
Para obter mais informações, consulte Visualizar um único endpoint no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte DescribeOriginEndpoint
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-channels
.
- AWS CLI
-
Para listar todos os canais
O comando
list-channels
a seguir lista todos os canais configurados na conta da AWS atual.aws mediapackage list-channels
Saída:
{ "Channels": [ { "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", "HlsIngest": { "IngestEndpoints": [ { "Id": "584797f1740548c389a273585dd22a63", "Password": "webdavgeneratedpassword1", "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", "Username": "webdavgeneratedusername1" }, { "Id": "7d187c8616fd455f88aaa5a9fcf74442", "Password": "webdavgeneratedpassword2", "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", "Username": "webdavgeneratedusername2" } ] }, "Id": "test", "Tags": {} } ] }
Para obter mais informações, consulte Como visualizar detalhes do canal no Guia do usuário do AWS Elemental MediaPackage.
-
Para obter detalhes da API, consulte ListChannels
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-origin-endpoints
.
- AWS CLI
-
Para listar todos os endpoints de origem de um canal
O comando
list-origin-endpoints
a seguir lista todos endpoints de origem que estão configurados no canaltest
.aws mediapackage list-origin-endpoints \ --channel-id
test
Saída:
{ "OriginEndpoints": [ { "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/247cff871f2845d3805129be22f2c0a2", "ChannelId": "test", "DashPackage": { "ManifestLayout": "FULL", "ManifestWindowSeconds": 60, "MinBufferTimeSeconds": 30, "MinUpdatePeriodSeconds": 15, "PeriodTriggers": [], "Profile": "NONE", "SegmentDurationSeconds": 2, "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", "StreamSelection": { "MaxVideoBitsPerSecond": 2147483647, "MinVideoBitsPerSecond": 0, "StreamOrder": "ORIGINAL" }, "SuggestedPresentationDelaySeconds": 25 }, "Id": "tester2", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": {}, "TimeDelaySeconds": 0, "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/247cff871f2845d3805129be22f2c0a2/index.mpd", "Whitelist": [] }, { "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/869e237f851549e9bcf10e3bc2830839", "ChannelId": "test", "HlsPackage": { "AdMarkers": "NONE", "IncludeIframeOnlyStream": false, "PlaylistType": "EVENT", "PlaylistWindowSeconds": 60, "ProgramDateTimeIntervalSeconds": 0, "SegmentDurationSeconds": 6, "StreamSelection": { "MaxVideoBitsPerSecond": 2147483647, "MinVideoBitsPerSecond": 0, "StreamOrder": "ORIGINAL" }, "UseAudioRenditionGroup": false }, "Id": "tester", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": {}, "TimeDelaySeconds": 0, "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/869e237f851549e9bcf10e3bc2830839/index.m3u8", "Whitelist": [] } ] }
Para obter mais informações, consulte Visualizar todos os endpoints associados a um canal no Guia do usuário do AWS Elemental MediaPackage.
-
Para obter detalhes da API, consulte ListOriginEndpoints
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-tags-for-resource
.
- AWS CLI
-
Para listar tags atribuídas a um recurso
O comando
list-tags-for-resource
a seguir lista todas as tags atribuídas ao recurso especificado.aws mediapackage list-tags-for-resource \ --resource-arn
arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0
Saída:
{ "Tags": { "region": "west" } }
Para obter mais informações, consulte Atribuir tags a recursos no AWS Elemental MediaPackage no Guia do usuário do AWS Elemental MediaPackage.
-
Para obter detalhes sobre a API, consulte ListTagsForResource
na AWS CLI Command Reference.
-
O código de exemplo a seguir mostra como usar rotate-ingest-endpoint-credentials
.
- AWS CLI
-
Para rotacionar as credenciais de ingestão
O comando
rotate-ingest-endpoint-credentials
a seguir rotaciona o nome de usuário WebDAV e a senha para o endpoint de ingestão especificado.aws mediapackage rotate-ingest-endpoint-credentials \ --id
test
\ --ingest-endpoint-id584797f1740548c389a273585dd22a63
Saída:
{ "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", "HlsIngest": { "IngestEndpoints": [ { "Id": "584797f1740548c389a273585dd22a63", "Password": "webdavregeneratedpassword1", "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", "Username": "webdavregeneratedusername1" }, { "Id": "7d187c8616fd455f88aaa5a9fcf74442", "Password": "webdavgeneratedpassword2", "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", "Username": "webdavgeneratedusername2" } ] }, "Id": "test", "Tags": {} }
Para obter mais informações, consulte Rotacionar credenciais em um URL de entrada no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte RotateIngestEndpointCredentials
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar tag-resource
.
- AWS CLI
-
Para adicionar uma tag a um recurso
Os comandos
tag-resource
a seguir adicionam um par de chave-valorregion=west
ao recurso especificado.aws mediapackage tag-resource \ --resource-arn
arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0
\ --tagsregion=west
Este comando não produz saída.
Para obter mais informações, consulte Atribuir tags a recursos no AWS Elemental MediaPackage no Guia do usuário do AWS Elemental MediaPackage.
-
Para obter detalhes da API, consulte TagResource
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar untag-resource
.
- AWS CLI
-
Para remover uma tag de um recurso
O comando
untag-resource
a seguir remove a tag com a chaveregion
do canal especificado.aws mediapackage untag-resource \ --resource-arn
arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0
\ --tag-keysregion
Para obter mais informações, consulte Atribuir tags a recursos no AWS Elemental MediaPackage no Guia do usuário do AWS Elemental MediaPackage.
-
Para obter detalhes sobre a API, consulte UntagResource
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar update-channel
.
- AWS CLI
-
Para atualizar um canal
O comando
update-channel
a seguir atualiza o canal chamadosportschannel
para incluir a descrição24x7 sports
.aws mediapackage update-channel \ --id
sportschannel
\ --description"24x7 sports"
Saída:
{ "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", "Description": "24x7 sports", "HlsIngest": { "IngestEndpoints": [ { "Id": "6d345804ec3f46c9b454a91d4a80d0e0", "Password": "generatedwebdavpassword1", "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", "Username": "generatedwebdavusername1" }, { "Id": "2daa32878af24803b24183727211b8ff", "Password": "generatedwebdavpassword2", "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", "Username": "generatedwebdavusername2" } ] }, "Id": "sportschannel", "Tags": {} }
Para obter mais informações, consulte Editar um canal no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte UpdateChannel
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar update-origin-endpoint
.
- AWS CLI
-
Para atualizar um endpoint de origem
O comando
update-origin-endpoint
a seguir atualiza o endpoint de origem chamadocmaf_sports
. Ele altera o tempo de atraso para0
segundos.aws mediapackage update-origin-endpoint \ --id
cmaf_sports
\ --time-delay-seconds0
Saída:
{ "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", "ChannelId": "sportschannel", "CmafPackage": { "HlsManifests": [ { "AdMarkers": "NONE", "Id": "cmaf_sports_endpoint", "IncludeIframeOnlyStream": false, "PlaylistType": "EVENT", "PlaylistWindowSeconds": 60, "ProgramDateTimeIntervalSeconds": 0, "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" } ], "SegmentDurationSeconds": 2, "SegmentPrefix": "sportschannel" }, "Id": "cmaf_sports", "ManifestName": "index", "StartoverWindowSeconds": 0, "Tags": { "region": "west", "media": "sports" }, "TimeDelaySeconds": 0, "Url": "", "Whitelist": [] }
Para obter mais informações, consulte Editar um endpoint no Guia do usuário do AWS Elemental MediaPackage.
-
Para ver detalhes da API, consulte UpdateOriginEndpoint
na Referência de comandos da AWS CLI.
-