BatchGetChannel

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

Performs GetChannel on multiple ARNs simultaneously.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'channels' => [
        [
            'arn' => '<string>',
            'authorized' => true || false,
            'containerFormat' => 'TS|FRAGMENTED_MP4',
            'ingestEndpoint' => '<string>',
            'insecureIngest' => true || false,
            'latencyMode' => 'NORMAL|LOW',
            'multitrackInputConfiguration' => [
                'enabled' => true || false,
                'maximumResolution' => 'SD|HD|FULL_HD',
                'policy' => 'ALLOW|REQUIRE',
            ],
            'name' => '<string>',
            'playbackRestrictionPolicyArn' => '<string>',
            'playbackUrl' => '<string>',
            'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
            'recordingConfigurationArn' => '<string>',
            'srt' => [
                'endpoint' => '<string>',
                'passphrase' => '<string>',
            ],
            'tags' => ['<string>', ...],
            'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
        ],
        // ...
    ],
    'errors' => [
        [
            'arn' => '<string>',
            'code' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

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

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

BatchStartViewerSessionRevocation

$result = $client->batchStartViewerSessionRevocation([/* ... */]);
$promise = $client->batchStartViewerSessionRevocationAsync([/* ... */]);

Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

Parameter Syntax

$result = $client->batchStartViewerSessionRevocation([
    'viewerSessions' => [ // REQUIRED
        [
            'channelArn' => '<string>', // REQUIRED
            'viewerId' => '<string>', // REQUIRED
            'viewerSessionVersionsLessThanOrEqualTo' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'channelArn' => '<string>',
            'code' => '<string>',
            'message' => '<string>',
            'viewerId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

ValidationException:

PendingVerification:

ThrottlingException:

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,
    'containerFormat' => 'TS|FRAGMENTED_MP4',
    'insecureIngest' => true || false,
    'latencyMode' => 'NORMAL|LOW',
    'multitrackInputConfiguration' => [
        'enabled' => true || false,
        'maximumResolution' => 'SD|HD|FULL_HD',
        'policy' => 'ALLOW|REQUIRE',
    ],
    'name' => '<string>',
    'playbackRestrictionPolicyArn' => '<string>',
    'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
    'recordingConfigurationArn' => '<string>',
    'tags' => ['<string>', ...],
    'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
]);

Parameter Details

Result Syntax

[
    'channel' => [
        'arn' => '<string>',
        'authorized' => true || false,
        'containerFormat' => 'TS|FRAGMENTED_MP4',
        'ingestEndpoint' => '<string>',
        'insecureIngest' => true || false,
        'latencyMode' => 'NORMAL|LOW',
        'multitrackInputConfiguration' => [
            'enabled' => true || false,
            'maximumResolution' => 'SD|HD|FULL_HD',
            'policy' => 'ALLOW|REQUIRE',
        ],
        'name' => '<string>',
        'playbackRestrictionPolicyArn' => '<string>',
        'playbackUrl' => '<string>',
        'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
        'recordingConfigurationArn' => '<string>',
        'srt' => [
            'endpoint' => '<string>',
            'passphrase' => '<string>',
        ],
        'tags' => ['<string>', ...],
        'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
    ],
    'streamKey' => [
        'arn' => '<string>',
        'channelArn' => '<string>',
        'tags' => ['<string>', ...],
        'value' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

ServiceQuotaExceededException:

CreatePlaybackRestrictionPolicy

$result = $client->createPlaybackRestrictionPolicy([/* ... */]);
$promise = $client->createPlaybackRestrictionPolicyAsync([/* ... */]);

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

Parameter Syntax

$result = $client->createPlaybackRestrictionPolicy([
    'allowedCountries' => ['<string>', ...],
    'allowedOrigins' => ['<string>', ...],
    'enableStrictOriginEnforcement' => true || false,
    'name' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'playbackRestrictionPolicy' => [
        'allowedCountries' => ['<string>', ...],
        'allowedOrigins' => ['<string>', ...],
        'arn' => '<string>',
        'enableStrictOriginEnforcement' => true || false,
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

AccessDeniedException:

ValidationException:

PendingVerification:

ThrottlingException:

ServiceQuotaExceededException:

CreateRecordingConfiguration

$result = $client->createRecordingConfiguration([/* ... */]);
$promise = $client->createRecordingConfigurationAsync([/* ... */]);

Creates a new recording configuration, used to enable recording to Amazon S3.

Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

Parameter Syntax

$result = $client->createRecordingConfiguration([
    'destinationConfiguration' => [ // REQUIRED
        's3' => [
            'bucketName' => '<string>', // REQUIRED
        ],
    ],
    'name' => '<string>',
    'recordingReconnectWindowSeconds' => <integer>,
    'renditionConfiguration' => [
        'renditionSelection' => 'ALL|NONE|CUSTOM',
        'renditions' => ['<string>', ...],
    ],
    'tags' => ['<string>', ...],
    'thumbnailConfiguration' => [
        'recordingMode' => 'DISABLED|INTERVAL',
        'resolution' => 'SD|HD|FULL_HD|LOWEST_RESOLUTION',
        'storage' => ['<string>', ...],
        'targetIntervalSeconds' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'recordingConfiguration' => [
        'arn' => '<string>',
        'destinationConfiguration' => [
            's3' => [
                'bucketName' => '<string>',
            ],
        ],
        'name' => '<string>',
        'recordingReconnectWindowSeconds' => <integer>,
        'renditionConfiguration' => [
            'renditionSelection' => 'ALL|NONE|CUSTOM',
            'renditions' => ['<string>', ...],
        ],
        'state' => 'CREATING|CREATE_FAILED|ACTIVE',
        'tags' => ['<string>', ...],
        'thumbnailConfiguration' => [
            'recordingMode' => 'DISABLED|INTERVAL',
            'resolution' => 'SD|HD|FULL_HD|LOWEST_RESOLUTION',
            'storage' => ['<string>', ...],
            'targetIntervalSeconds' => <integer>,
        ],
    ],
]

Result Details

Errors

InternalServerException:

AccessDeniedException:

ValidationException:

PendingVerification:

ConflictException:

ServiceQuotaExceededException:

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

ServiceQuotaExceededException:

DeleteChannel

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

Deletes the specified channel and its associated stream keys.

If you try to delete a live channel, you will get an error (409 ConflictException). To delete a channel that is live, call StopStream, wait for the Amazon EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

ConflictException:

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. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

DeletePlaybackRestrictionPolicy

$result = $client->deletePlaybackRestrictionPolicy([/* ... */]);
$promise = $client->deletePlaybackRestrictionPolicyAsync([/* ... */]);

Deletes the specified playback restriction policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

ConflictException:

DeleteRecordingConfiguration

$result = $client->deleteRecordingConfiguration([/* ... */]);
$promise = $client->deleteRecordingConfigurationAsync([/* ... */]);

Deletes the recording configuration for the specified ARN.

If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

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

Result Syntax

[
    'channel' => [
        'arn' => '<string>',
        'authorized' => true || false,
        'containerFormat' => 'TS|FRAGMENTED_MP4',
        'ingestEndpoint' => '<string>',
        'insecureIngest' => true || false,
        'latencyMode' => 'NORMAL|LOW',
        'multitrackInputConfiguration' => [
            'enabled' => true || false,
            'maximumResolution' => 'SD|HD|FULL_HD',
            'policy' => 'ALLOW|REQUIRE',
        ],
        'name' => '<string>',
        'playbackRestrictionPolicyArn' => '<string>',
        'playbackUrl' => '<string>',
        'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
        'recordingConfigurationArn' => '<string>',
        'srt' => [
            'endpoint' => '<string>',
            'passphrase' => '<string>',
        ],
        'tags' => ['<string>', ...],
        'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
    ],
]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

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 private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

GetPlaybackRestrictionPolicy

$result = $client->getPlaybackRestrictionPolicy([/* ... */]);
$promise = $client->getPlaybackRestrictionPolicyAsync([/* ... */]);

Gets the specified playback restriction policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'playbackRestrictionPolicy' => [
        'allowedCountries' => ['<string>', ...],
        'allowedOrigins' => ['<string>', ...],
        'arn' => '<string>',
        'enableStrictOriginEnforcement' => true || false,
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

GetRecordingConfiguration

$result = $client->getRecordingConfiguration([/* ... */]);
$promise = $client->getRecordingConfigurationAsync([/* ... */]);

Gets the recording configuration for the specified ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'recordingConfiguration' => [
        'arn' => '<string>',
        'destinationConfiguration' => [
            's3' => [
                'bucketName' => '<string>',
            ],
        ],
        'name' => '<string>',
        'recordingReconnectWindowSeconds' => <integer>,
        'renditionConfiguration' => [
            'renditionSelection' => 'ALL|NONE|CUSTOM',
            'renditions' => ['<string>', ...],
        ],
        'state' => 'CREATING|CREATE_FAILED|ACTIVE',
        'tags' => ['<string>', ...],
        'thumbnailConfiguration' => [
            'recordingMode' => 'DISABLED|INTERVAL',
            'resolution' => 'SD|HD|FULL_HD|LOWEST_RESOLUTION',
            'storage' => ['<string>', ...],
            'targetIntervalSeconds' => <integer>,
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

ChannelNotBroadcasting:

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

GetStreamSession

$result = $client->getStreamSession([/* ... */]);
$promise = $client->getStreamSessionAsync([/* ... */]);

Gets metadata on a specified stream.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'streamSession' => [
        'channel' => [
            'arn' => '<string>',
            'authorized' => true || false,
            'containerFormat' => 'TS|FRAGMENTED_MP4',
            'ingestEndpoint' => '<string>',
            'insecureIngest' => true || false,
            'latencyMode' => 'NORMAL|LOW',
            'multitrackInputConfiguration' => [
                'enabled' => true || false,
                'maximumResolution' => 'SD|HD|FULL_HD',
                'policy' => 'ALLOW|REQUIRE',
            ],
            'name' => '<string>',
            'playbackRestrictionPolicyArn' => '<string>',
            'playbackUrl' => '<string>',
            'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
            'recordingConfigurationArn' => '<string>',
            'srt' => [
                'endpoint' => '<string>',
                'passphrase' => '<string>',
            ],
            'tags' => ['<string>', ...],
            'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
        ],
        'endTime' => <DateTime>,
        'ingestConfiguration' => [
            'audio' => [
                'channels' => <integer>,
                'codec' => '<string>',
                'sampleRate' => <integer>,
                'targetBitrate' => <integer>,
                'track' => '<string>',
            ],
            'video' => [
                'avcLevel' => '<string>',
                'avcProfile' => '<string>',
                'codec' => '<string>',
                'encoder' => '<string>',
                'level' => '<string>',
                'profile' => '<string>',
                'targetBitrate' => <integer>,
                'targetFramerate' => <integer>,
                'track' => '<string>',
                'videoHeight' => <integer>,
                'videoWidth' => <integer>,
            ],
        ],
        'ingestConfigurations' => [
            'audioConfigurations' => [
                [
                    'channels' => <integer>,
                    'codec' => '<string>',
                    'sampleRate' => <integer>,
                    'targetBitrate' => <integer>,
                    'track' => '<string>',
                ],
                // ...
            ],
            'videoConfigurations' => [
                [
                    'avcLevel' => '<string>',
                    'avcProfile' => '<string>',
                    'codec' => '<string>',
                    'encoder' => '<string>',
                    'level' => '<string>',
                    'profile' => '<string>',
                    'targetBitrate' => <integer>,
                    'targetFramerate' => <integer>,
                    'track' => '<string>',
                    'videoHeight' => <integer>,
                    'videoWidth' => <integer>,
                ],
                // ...
            ],
        ],
        'recordingConfiguration' => [
            'arn' => '<string>',
            'destinationConfiguration' => [
                's3' => [
                    'bucketName' => '<string>',
                ],
            ],
            'name' => '<string>',
            'recordingReconnectWindowSeconds' => <integer>,
            'renditionConfiguration' => [
                'renditionSelection' => 'ALL|NONE|CUSTOM',
                'renditions' => ['<string>', ...],
            ],
            'state' => 'CREATING|CREATE_FAILED|ACTIVE',
            'tags' => ['<string>', ...],
            'thumbnailConfiguration' => [
                'recordingMode' => 'DISABLED|INTERVAL',
                'resolution' => 'SD|HD|FULL_HD|LOWEST_RESOLUTION',
                'storage' => ['<string>', ...],
                'targetIntervalSeconds' => <integer>,
            ],
        ],
        'startTime' => <DateTime>,
        'streamId' => '<string>',
        'truncatedEvents' => [
            [
                'code' => '<string>',
                'eventTime' => <DateTime>,
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

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 private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

ValidationException:

PendingVerification:

ConflictException:

ServiceQuotaExceededException:

ListChannels

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

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'channels' => [
        [
            'arn' => '<string>',
            'authorized' => true || false,
            'insecureIngest' => true || false,
            'latencyMode' => 'NORMAL|LOW',
            'name' => '<string>',
            'playbackRestrictionPolicyArn' => '<string>',
            'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
            'recordingConfigurationArn' => '<string>',
            'tags' => ['<string>', ...],
            'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

ValidationException:

ConflictException:

ListPlaybackKeyPairs

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

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

ValidationException:

ListPlaybackRestrictionPolicies

$result = $client->listPlaybackRestrictionPolicies([/* ... */]);
$promise = $client->listPlaybackRestrictionPoliciesAsync([/* ... */]);

Gets summary information about playback restriction policies.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'playbackRestrictionPolicies' => [
        [
            'allowedCountries' => ['<string>', ...],
            'allowedOrigins' => ['<string>', ...],
            'arn' => '<string>',
            'enableStrictOriginEnforcement' => true || false,
            'name' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

ValidationException:

PendingVerification:

ConflictException:

ListRecordingConfigurations

$result = $client->listRecordingConfigurations([/* ... */]);
$promise = $client->listRecordingConfigurationsAsync([/* ... */]);

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'recordingConfigurations' => [
        [
            'arn' => '<string>',
            'destinationConfiguration' => [
                's3' => [
                    'bucketName' => '<string>',
                ],
            ],
            'name' => '<string>',
            'state' => 'CREATING|CREATE_FAILED|ACTIVE',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

AccessDeniedException:

ValidationException:

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

ListStreamSessions

$result = $client->listStreamSessions([/* ... */]);
$promise = $client->listStreamSessionsAsync([/* ... */]);

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'streamSessions' => [
        [
            'endTime' => <DateTime>,
            'hasErrorEvent' => true || false,
            'startTime' => <DateTime>,
            'streamId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

ListStreams

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

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

Parameter Syntax

$result = $client->listStreams([
    'filterBy' => [
        'health' => 'HEALTHY|STARVING|UNKNOWN',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

ValidationException:

ListTagsForResource

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

Gets information about Amazon Web Services tags for the specified ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

ValidationException:

PutMetadata

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

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

ChannelNotBroadcasting:

ThrottlingException:

StartViewerSessionRevocation

$result = $client->startViewerSessionRevocation([/* ... */]);
$promise = $client->startViewerSessionRevocationAsync([/* ... */]);

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

Parameter Syntax

$result = $client->startViewerSessionRevocation([
    'channelArn' => '<string>', // REQUIRED
    'viewerId' => '<string>', // REQUIRED
    'viewerSessionVersionsLessThanOrEqualTo' => <integer>,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

AccessDeniedException:

ValidationException:

PendingVerification:

ThrottlingException:

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

ChannelNotBroadcasting:

StreamUnavailable:

TagResource

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

Adds or updates tags for the Amazon Web Services resource with the specified ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

ValidationException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

InternalServerException:

ValidationException:

UpdateChannel

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

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

Parameter Syntax

$result = $client->updateChannel([
    'arn' => '<string>', // REQUIRED
    'authorized' => true || false,
    'containerFormat' => 'TS|FRAGMENTED_MP4',
    'insecureIngest' => true || false,
    'latencyMode' => 'NORMAL|LOW',
    'multitrackInputConfiguration' => [
        'enabled' => true || false,
        'maximumResolution' => 'SD|HD|FULL_HD',
        'policy' => 'ALLOW|REQUIRE',
    ],
    'name' => '<string>',
    'playbackRestrictionPolicyArn' => '<string>',
    'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
    'recordingConfigurationArn' => '<string>',
    'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
]);

Parameter Details

Result Syntax

[
    'channel' => [
        'arn' => '<string>',
        'authorized' => true || false,
        'containerFormat' => 'TS|FRAGMENTED_MP4',
        'ingestEndpoint' => '<string>',
        'insecureIngest' => true || false,
        'latencyMode' => 'NORMAL|LOW',
        'multitrackInputConfiguration' => [
            'enabled' => true || false,
            'maximumResolution' => 'SD|HD|FULL_HD',
            'policy' => 'ALLOW|REQUIRE',
        ],
        'name' => '<string>',
        'playbackRestrictionPolicyArn' => '<string>',
        'playbackUrl' => '<string>',
        'preset' => 'HIGHER_BANDWIDTH_DELIVERY|CONSTRAINED_BANDWIDTH_DELIVERY',
        'recordingConfigurationArn' => '<string>',
        'srt' => [
            'endpoint' => '<string>',
            'passphrase' => '<string>',
        ],
        'tags' => ['<string>', ...],
        'type' => 'BASIC|STANDARD|ADVANCED_SD|ADVANCED_HD',
    ],
]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

ConflictException:

UpdatePlaybackRestrictionPolicy

$result = $client->updatePlaybackRestrictionPolicy([/* ... */]);
$promise = $client->updatePlaybackRestrictionPolicyAsync([/* ... */]);

Updates a specified playback restriction policy.

Parameter Syntax

$result = $client->updatePlaybackRestrictionPolicy([
    'allowedCountries' => ['<string>', ...],
    'allowedOrigins' => ['<string>', ...],
    'arn' => '<string>', // REQUIRED
    'enableStrictOriginEnforcement' => true || false,
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'playbackRestrictionPolicy' => [
        'allowedCountries' => ['<string>', ...],
        'allowedOrigins' => ['<string>', ...],
        'arn' => '<string>',
        'enableStrictOriginEnforcement' => true || false,
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

AccessDeniedException:

ValidationException:

PendingVerification:

ConflictException: