AWS SDK for PHP 3.x

Service ID: ivs

Version: 2020-07-14

This page describes the parameters and results for the operations of the Amazon Interactive Video Service (2020-07-14), and shows how to use the Aws\IVS\IVSClient object to call the described operations. This documentation is specific to the 2020-07-14 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchGetChannel ( array $params = [] )
Performs GetChannel on multiple ARNs simultaneously.
BatchGetStreamKey ( array $params = [] )
Performs GetStreamKey on multiple ARNs simultaneously.
CreateChannel ( array $params = [] )
Creates a new channel and an associated stream key to start streaming.
CreateStreamKey ( array $params = [] )
Creates a stream key, used to initiate a stream, for the specified channel ARN.
DeleteChannel ( array $params = [] )
Deletes the specified channel and its associated stream keys.
DeletePlaybackKeyPair ( array $params = [] )
Deletes a specified authorization key pair.
DeleteStreamKey ( array $params = [] )
Deletes the stream key for the specified ARN, so it can no longer be used to stream.
GetChannel ( array $params = [] )
Gets the channel configuration for the specified channel ARN.
GetPlaybackKeyPair ( array $params = [] )
Gets a specified playback authorization key pair and returns the arn and fingerprint.
GetStream ( array $params = [] )
Gets information about the active (live) stream on a specified channel.
GetStreamKey ( array $params = [] )
Gets stream-key information for a specified ARN.
ImportPlaybackKeyPair ( array $params = [] )
Imports the public portion of a new key pair and returns its arn and fingerprint.
ListChannels ( array $params = [] )
Gets summary information about all channels in your account, in the AWS region where the API request is processed.
ListPlaybackKeyPairs ( array $params = [] )
Gets summary information about playback key pairs.
ListStreamKeys ( array $params = [] )
Gets summary information about stream keys for the specified channel.
ListStreams ( array $params = [] )
Gets summary information about live streams in your account, in the AWS region where the API request is processed.
ListTagsForResource ( array $params = [] )
Gets information about AWS tags for the specified ARN.
PutMetadata ( array $params = [] )
Inserts metadata into an RTMPS stream for the specified channel.
StopStream ( array $params = [] )
Disconnects the incoming RTMPS stream for the specified channel.
TagResource ( array $params = [] )
Adds or updates tags for the AWS resource with the specified ARN.
UntagResource ( array $params = [] )
Removes tags from the resource with the specified ARN.
UpdateChannel ( array $params = [] )
Updates a channel's configuration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListChannels
ListPlaybackKeyPairs
ListStreamKeys
ListStreams
ListTagsForResource

Operations

BatchGetChannel

$result = $client->batchGetChannel([/* ... */]);
$promise = $client->batchGetChannelAsync([/* ... */]);

Performs GetChannel on multiple ARNs simultaneously.

Parameter Syntax

$result = $client->batchGetChannel([
    'arns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

arns

Required: Yes
Type: Array of strings

Array of ARNs, one per channel.

Result Syntax

[
    'channels' => [
        [
            'arn' => '<string>',
            'authorized' => true || false,
            'ingestEndpoint' => '<string>',
            'latencyMode' => 'NORMAL|LOW',
            'name' => '<string>',
            'playbackUrl' => '<string>',
            'tags' => ['<string>', ...],
            'type' => 'BASIC|STANDARD',
        ],
        // ...
    ],
    'errors' => [
        [
            'arn' => '<string>',
            'code' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

channels

Type: Array of Channel structures

errors

Type: Array of BatchError structures

Each error object is related to a specific ARN in the request.

Errors

There are no errors described for this operation.

BatchGetStreamKey

$result = $client->batchGetStreamKey([/* ... */]);
$promise = $client->batchGetStreamKeyAsync([/* ... */]);

Performs GetStreamKey on multiple ARNs simultaneously.

Parameter Syntax

$result = $client->batchGetStreamKey([
    'arns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

arns

Required: Yes
Type: Array of strings

Array of ARNs, one per channel.

Result Syntax

[
    'errors' => [
        [
            'arn' => '<string>',
            'code' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'streamKeys' => [
        [
            'arn' => '<string>',
            'channelArn' => '<string>',
            'tags' => ['<string>', ...],
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

errors

Type: Array of BatchError structures

streamKeys

Type: Array of StreamKey structures

Errors

There are no errors described for this operation.

CreateChannel

$result = $client->createChannel([/* ... */]);
$promise = $client->createChannelAsync([/* ... */]);

Creates a new channel and an associated stream key to start streaming.

Parameter Syntax

$result = $client->createChannel([
    'authorized' => true || false,
    'latencyMode' => 'NORMAL|LOW',
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'type' => 'BASIC|STANDARD',
]);

Parameter Details

Members

authorized

Type: boolean

Whether the channel is authorized. Default: false.

latencyMode

Type: string

Channel latency mode. Default: LOW.

name

Type: string

Channel name.

tags

Type: Associative array of custom strings keys (TagKey) to strings

See Channel$tags.

type

Type: string

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.

Default: STANDARD.

Result Syntax

[
    'channel' => [
        'arn' => '<string>',
        'authorized' => true || false,
        'ingestEndpoint' => '<string>',
        'latencyMode' => 'NORMAL|LOW',
        'name' => '<string>',
        'playbackUrl' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'BASIC|STANDARD',
    ],
    'streamKey' => [
        'arn' => '<string>',
        'channelArn' => '<string>',
        'tags' => ['<string>', ...],
        'value' => '<string>',
    ],
]

Result Details

Members

channel

Type: Channel structure

Object specifying a channel.

streamKey

Type: StreamKey structure

Object specifying a stream key.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ServiceQuotaExceededException:
This error does not currently have a description.
PendingVerification:
This error does not currently have a description.

CreateStreamKey

$result = $client->createStreamKey([/* ... */]);
$promise = $client->createStreamKeyAsync([/* ... */]);

Creates a stream key, used to initiate a stream, for the specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

Parameter Syntax

$result = $client->createStreamKey([
    'channelArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

channelArn

Required: Yes
Type: string

ARN of the channel for which to create the stream key.

tags

Type: Associative array of custom strings keys (TagKey) to strings

See Channel$tags.

Result Syntax

[
    'streamKey' => [
        'arn' => '<string>',
        'channelArn' => '<string>',
        'tags' => ['<string>', ...],
        'value' => '<string>',
    ],
]

Result Details

Members

streamKey

Type: StreamKey structure

Stream key used to authenticate an RTMPS stream for ingestion.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.
ServiceQuotaExceededException:
This error does not currently have a description.
PendingVerification:
This error does not currently have a description.

DeleteChannel

$result = $client->deleteChannel([/* ... */]);
$promise = $client->deleteChannelAsync([/* ... */]);

Deletes the specified channel and its associated stream keys.

Parameter Syntax

$result = $client->deleteChannel([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

Required: Yes
Type: string

ARN of the channel to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.
ConflictException:
This error does not currently have a description.
PendingVerification:
This error does not currently have a description.

DeletePlaybackKeyPair

$result = $client->deletePlaybackKeyPair([/* ... */]);
$promise = $client->deletePlaybackKeyPairAsync([/* ... */]);

Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.

Parameter Syntax

$result = $client->deletePlaybackKeyPair([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

Required: Yes
Type: string

ARN of the key pair to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.
PendingVerification:
This error does not currently have a description.

DeleteStreamKey

$result = $client->deleteStreamKey([/* ... */]);
$promise = $client->deleteStreamKeyAsync([/* ... */]);

Deletes the stream key for the specified ARN, so it can no longer be used to stream.

Parameter Syntax

$result = $client->deleteStreamKey([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

Required: Yes
Type: string

ARN of the stream key to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.
PendingVerification:
This error does not currently have a description.

GetChannel

$result = $client->getChannel([/* ... */]);
$promise = $client->getChannelAsync([/* ... */]);

Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.

Parameter Syntax

$result = $client->getChannel([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

Required: Yes
Type: string

ARN of the channel for which the configuration is to be retrieved.

Result Syntax

[
    'channel' => [
        'arn' => '<string>',
        'authorized' => true || false,
        'ingestEndpoint' => '<string>',
        'latencyMode' => 'NORMAL|LOW',
        'name' => '<string>',
        'playbackUrl' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'BASIC|STANDARD',
    ],
]

Result Details

Members

channel

Type: Channel structure

Object specifying a channel.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.

GetPlaybackKeyPair

$result = $client->getPlaybackKeyPair([/* ... */]);
$promise = $client->getPlaybackKeyPairAsync([/* ... */]);

Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to authorized channels.

Parameter Syntax

$result = $client->getPlaybackKeyPair([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

Required: Yes
Type: string

ARN of the key pair to be returned.

Result Syntax

[
    'keyPair' => [
        'arn' => '<string>',
        'fingerprint' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

keyPair

Type: PlaybackKeyPair structure

A key pair used to sign and validate a playback authorization token.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.

GetStream

$result = $client->getStream([/* ... */]);
$promise = $client->getStreamAsync([/* ... */]);

Gets information about the active (live) stream on a specified channel.

Parameter Syntax

$result = $client->getStream([
    'channelArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelArn

Required: Yes
Type: string

Channel ARN for stream to be accessed.

Result Syntax

[
    'stream' => [
        'channelArn' => '<string>',
        'health' => 'HEALTHY|STARVING|UNKNOWN',
        'playbackUrl' => '<string>',
        'startTime' => <DateTime>,
        'state' => 'LIVE|OFFLINE',
        'viewerCount' => <integer>,
    ],
]

Result Details

Members

stream

Type: Stream structure

Specifies a live video stream that has been ingested and distributed.

Errors

ResourceNotFoundException:
This error does not currently have a description.
ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ChannelNotBroadcasting:
This error does not currently have a description.

GetStreamKey

$result = $client->getStreamKey([/* ... */]);
$promise = $client->getStreamKeyAsync([/* ... */]);

Gets stream-key information for a specified ARN.

Parameter Syntax

$result = $client->getStreamKey([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

arn

Required: Yes
Type: string

ARN for the stream key to be retrieved.

Result Syntax

[
    'streamKey' => [
        'arn' => '<string>',
        'channelArn' => '<string>',
        'tags' => ['<string>', ...],
        'value' => '<string>',
    ],
]

Result Details

Members

streamKey

Type: StreamKey structure

Object specifying a stream key.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.

ImportPlaybackKeyPair

$result = $client->importPlaybackKeyPair([/* ... */]);
$promise = $client->importPlaybackKeyPairAsync([/* ... */]);

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to authorized channels.

Parameter Syntax

$result = $client->importPlaybackKeyPair([
    'name' => '<string>',
    'publicKeyMaterial' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

name

Type: string

An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.

publicKeyMaterial

Required: Yes
Type: string

The public portion of a customer-generated key pair.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Any tags provided with the request are added to the playback key pair tags.

Result Syntax

[
    'keyPair' => [
        'arn' => '<string>',
        'fingerprint' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Members

keyPair

Type: PlaybackKeyPair structure

A key pair used to sign and validate a playback authorization token.

Errors

ValidationException:
This error does not currently have a description.
ConflictException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ServiceQuotaExceededException:
This error does not currently have a description.
PendingVerification:
This error does not currently have a description.

ListChannels

$result = $client->listChannels([/* ... */]);
$promise = $client->listChannelsAsync([/* ... */]);

Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.

Parameter Syntax

$result = $client->listChannels([
    'filterByName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filterByName

Type: string

Filters the channel list to match the specified name.

maxResults

Type: int

Maximum number of channels to return.

nextToken

Type: string

The first channel to retrieve. This is used for pagination; see the nextToken response field.

Result Syntax

[
    'channels' => [
        [
            'arn' => '<string>',
            'authorized' => true || false,
            'latencyMode' => 'NORMAL|LOW',
            'name' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

channels

Required: Yes
Type: Array of ChannelSummary structures

List of the matching channels.

nextToken

Type: string

If there are more channels than maxResults, use nextToken in the request to get the next set.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.

ListPlaybackKeyPairs

$result = $client->listPlaybackKeyPairs([/* ... */]);
$promise = $client->listPlaybackKeyPairsAsync([/* ... */]);

Gets summary information about playback key pairs.

Parameter Syntax

$result = $client->listPlaybackKeyPairs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

Type: int

The first key pair to retrieve. This is used for pagination; see the nextToken response field.

nextToken

Type: string

Maximum number of key pairs to return.

Result Syntax

[
    'keyPairs' => [
        [
            'arn' => '<string>',
            'name' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

keyPairs

Required: Yes
Type: Array of PlaybackKeyPairSummary structures

List of key pairs.

nextToken

Type: string

If there are more key pairs than maxResults, use nextToken in the request to get the next set.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.

ListStreamKeys

$result = $client->listStreamKeys([/* ... */]);
$promise = $client->listStreamKeysAsync([/* ... */]);

Gets summary information about stream keys for the specified channel.

Parameter Syntax

$result = $client->listStreamKeys([
    'channelArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

channelArn

Required: Yes
Type: string

Channel ARN used to filter the list.

maxResults

Type: int

Maximum number of streamKeys to return.

nextToken

Type: string

The first stream key to retrieve. This is used for pagination; see the nextToken response field.

Result Syntax

[
    'nextToken' => '<string>',
    'streamKeys' => [
        [
            'arn' => '<string>',
            'channelArn' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

If there are more stream keys than maxResults, use nextToken in the request to get the next set.

streamKeys

Required: Yes
Type: Array of StreamKeySummary structures

List of stream keys.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.

ListStreams

$result = $client->listStreams([/* ... */]);
$promise = $client->listStreamsAsync([/* ... */]);

Gets summary information about live streams in your account, in the AWS region where the API request is processed.

Parameter Syntax

$result = $client->listStreams([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

Type: int

Maximum number of streams to return.

nextToken

Type: string

The first stream to retrieve. This is used for pagination; see the nextToken response field.

Result Syntax

[
    'nextToken' => '<string>',
    'streams' => [
        [
            'channelArn' => '<string>',
            'health' => 'HEALTHY|STARVING|UNKNOWN',
            'startTime' => <DateTime>,
            'state' => 'LIVE|OFFLINE',
            'viewerCount' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

If there are more streams than maxResults, use nextToken in the request to get the next set.

streams

Required: Yes
Type: Array of StreamSummary structures

List of streams.

Errors

AccessDeniedException:
This error does not currently have a description.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Gets information about AWS tags for the specified ARN.

Parameter Syntax

$result = $client->listTagsForResource([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

Type: int

Maximum number of tags to return.

nextToken

Type: string

The first tag to retrieve. This is used for pagination; see the nextToken response field.

resourceArn

Required: Yes
Type: string

The ARN of the resource to be retrieved.

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Members

nextToken

Type: string

If there are more tags than maxResults, use nextToken in the request to get the next set.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

Errors

InternalServerException:
This error does not currently have a description.
ValidationException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.

PutMetadata

$result = $client->putMetadata([/* ... */]);
$promise = $client->putMetadataAsync([/* ... */]);

Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.

Parameter Syntax

$result = $client->putMetadata([
    'channelArn' => '<string>', // REQUIRED
    'metadata' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelArn

Required: Yes
Type: string

ARN of the channel into which metadata is inserted. This channel must have an active stream.

metadata

Required: Yes
Type: string

Metadata to insert into the stream. Maximum: 1 KB per request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.
ChannelNotBroadcasting:
This error does not currently have a description.
ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.

StopStream

$result = $client->stopStream([/* ... */]);
$promise = $client->stopStreamAsync([/* ... */]);

Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

Parameter Syntax

$result = $client->stopStream([
    'channelArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

channelArn

Required: Yes
Type: string

ARN of the channel for which the stream is to be stopped.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
This error does not currently have a description.
ChannelNotBroadcasting:
This error does not currently have a description.
ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
StreamUnavailable:
This error does not currently have a description.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or updates tags for the AWS resource with the specified ARN.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

ARN of the resource for which tags are to be added or updated.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

Array of tags to be added or updated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
This error does not currently have a description.
ValidationException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the resource with the specified ARN.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

ARN of the resource for which tags are to be removed.

tagKeys

Required: Yes
Type: Array of strings

Array of tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServerException:
This error does not currently have a description.
ValidationException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.

UpdateChannel

$result = $client->updateChannel([/* ... */]);
$promise = $client->updateChannelAsync([/* ... */]);

Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

Parameter Syntax

$result = $client->updateChannel([
    'arn' => '<string>', // REQUIRED
    'authorized' => true || false,
    'latencyMode' => 'NORMAL|LOW',
    'name' => '<string>',
    'type' => 'BASIC|STANDARD',
]);

Parameter Details

Members

arn

Required: Yes
Type: string

ARN of the channel to be updated.

authorized

Type: boolean

Whether the channel is authorized. Default: false.

latencyMode

Type: string

Channel latency mode. Default: LOW.

name

Type: string

Channel name.

type

Type: string

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.

Default: STANDARD.

Result Syntax

[
    'channel' => [
        'arn' => '<string>',
        'authorized' => true || false,
        'ingestEndpoint' => '<string>',
        'latencyMode' => 'NORMAL|LOW',
        'name' => '<string>',
        'playbackUrl' => '<string>',
        'tags' => ['<string>', ...],
        'type' => 'BASIC|STANDARD',
    ],
]

Result Details

Members

channel

Type: Channel structure

Object specifying a channel.

Errors

ValidationException:
This error does not currently have a description.
AccessDeniedException:
This error does not currently have a description.
ResourceNotFoundException:
This error does not currently have a description.
ConflictException:
This error does not currently have a description.
PendingVerification:
This error does not currently have a description.

Shapes

AccessDeniedException

Members

exceptionMessage

Type: string

User does not have sufficient access to perform this action.

BatchError

Description

Error related to a specific channel, specified by its ARN.

Members

arn

Type: string

Channel ARN.

code

Type: string

Error code.

message

Type: string

Error message, determined by the application.

Channel

Description

Object specifying a channel.

Members

arn

Type: string

Channel ARN.

authorized

Type: boolean

Whether the channel is authorized.

ingestEndpoint

Type: string

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

latencyMode

Type: string

Channel latency mode. Default: LOW.

name

Type: string

Channel name.

playbackUrl

Type: string

Channel playback URL.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Array of 1-50 maps, each of the form string:string (key:value).

type

Type: string

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values:

STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.

Default: STANDARD.

ChannelNotBroadcasting

Members

exceptionMessage

Type: string

The stream is offline for the given channel ARN.

ChannelSummary

Description

Summary information about a channel.

Members

arn

Type: string

Channel ARN.

authorized

Type: boolean

Whether the channel is authorized.

latencyMode

Type: string

Channel latency mode. Default: LOW.

name

Type: string

Channel name.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Array of 1-50 maps, each of the form string:string (key:value).

ConflictException

Members

exceptionMessage

Type: string

Updating or deleting a resource can cause an inconsistent state.

InternalServerException

Members

exceptionMessage

Type: string

Unexpected error during processing of request.

PendingVerification

Members

exceptionMessage

Type: string

Your account is pending verification.

PlaybackKeyPair

Description

A key pair used to sign and validate a playback authorization token.

Members

arn

Type: string

Key-pair ARN.

fingerprint

Type: string

Key-pair identifier.

name

Type: string

Key-pair name.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Array of 1-50 maps, each of the form string:string (key:value).

PlaybackKeyPairSummary

Description

Summary information about a playback key pair.

Members

arn

Type: string

Key-pair ARN.

name

Type: string

Key-pair name.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Array of 1-50 maps, each of the form string:string (key:value)

ResourceNotFoundException

Members

exceptionMessage

Type: string

Request references a resource which does not exist.

ServiceQuotaExceededException

Members

exceptionMessage

Type: string

Request would cause a service quota to be exceeded.

Stream

Description

Specifies a live video stream that has been ingested and distributed.

Members

channelArn

Type: string

Channel ARN for the stream.

health

Type: string

The stream’s health.

playbackUrl

Type: string

URL of the video master manifest, required by the video player to play the HLS stream.

startTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

ISO-8601 formatted timestamp of the stream’s start.

state

Type: string

The stream’s state.

viewerCount

Type: long (int|float)

Number of current viewers of the stream.

StreamKey

Description

Object specifying a stream key.

Members

arn

Type: string

Stream-key ARN.

channelArn

Type: string

Channel ARN for the stream.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Array of 1-50 maps, each of the form string:string (key:value).

value

Type: string

Stream-key value.

StreamKeySummary

Description

Summary information about a stream key.

Members

arn

Type: string

Stream-key ARN.

channelArn

Type: string

Channel ARN for the stream.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Array of 1-50 maps, each of the form string:string (key:value).

StreamSummary

Description

Summary information about a stream.

Members

channelArn

Type: string

Channel ARN for the stream.

health

Type: string

The stream’s health.

startTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

ISO-8601 formatted timestamp of the stream’s start.

state

Type: string

The stream’s state.

viewerCount

Type: long (int|float)

Number of current viewers of the stream.

StreamUnavailable

Members

exceptionMessage

Type: string

The stream is temporarily unavailable.

ThrottlingException

Members

exceptionMessage

Type: string

Request was denied due to request throttling.

ValidationException

Members

exceptionMessage

Type: string

The input fails to satisfy the constraints specified by an AWS service.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Interactive Video Service 2020-07-14

Operation Summary

Paginators

Operations

BatchGetChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchGetStreamKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateStreamKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeletePlaybackKeyPair

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteStreamKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetChannel

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetPlaybackKeyPair

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetStream