CreateEncoderConfiguration

$result = $client->createEncoderConfiguration([/* ... */]);
$promise = $client->createEncoderConfigurationAsync([/* ... */]);

Creates an EncoderConfiguration object.

Parameter Syntax

$result = $client->createEncoderConfiguration([
    'name' => '<string>',
    'tags' => ['<string>', ...],
    'video' => [
        'bitrate' => <integer>,
        'framerate' => <float>,
        'height' => <integer>,
        'width' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'encoderConfiguration' => [
        'arn' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'video' => [
            'bitrate' => <integer>,
            'framerate' => <float>,
            'height' => <integer>,
            'width' => <integer>,
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

PendingVerification:

CreateIngestConfiguration

$result = $client->createIngestConfiguration([/* ... */]);
$promise = $client->createIngestConfigurationAsync([/* ... */]);

Creates a new IngestConfiguration resource, used to specify the ingest protocol for a stage.

Parameter Syntax

$result = $client->createIngestConfiguration([
    'attributes' => ['<string>', ...],
    'ingestProtocol' => 'RTMP|RTMPS', // REQUIRED
    'insecureIngest' => true || false,
    'name' => '<string>',
    'stageArn' => '<string>',
    'tags' => ['<string>', ...],
    'userId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ingestConfiguration' => [
        'arn' => '<string>',
        'attributes' => ['<string>', ...],
        'ingestProtocol' => 'RTMP|RTMPS',
        'name' => '<string>',
        'participantId' => '<string>',
        'stageArn' => '<string>',
        'state' => 'ACTIVE|INACTIVE',
        'streamKey' => '<string>',
        'tags' => ['<string>', ...],
        'userId' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

AccessDeniedException:

ServiceQuotaExceededException:

PendingVerification:

CreateParticipantToken

$result = $client->createParticipantToken([/* ... */]);
$promise = $client->createParticipantTokenAsync([/* ... */]);

Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.

Encryption keys are owned by Amazon IVS and never used directly by your application.

Parameter Syntax

$result = $client->createParticipantToken([
    'attributes' => ['<string>', ...],
    'capabilities' => ['<string>', ...],
    'duration' => <integer>,
    'stageArn' => '<string>', // REQUIRED
    'userId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'participantToken' => [
        'attributes' => ['<string>', ...],
        'capabilities' => ['<string>', ...],
        'duration' => <integer>,
        'expirationTime' => <DateTime>,
        'participantId' => '<string>',
        'token' => '<string>',
        'userId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

ServiceQuotaExceededException:

PendingVerification:

CreateStage

$result = $client->createStage([/* ... */]);
$promise = $client->createStageAsync([/* ... */]);

Creates a new stage (and optionally participant tokens).

Parameter Syntax

$result = $client->createStage([
    'autoParticipantRecordingConfiguration' => [
        'mediaTypes' => ['<string>', ...],
        'storageConfigurationArn' => '<string>', // REQUIRED
        'thumbnailConfiguration' => [
            'recordingMode' => 'INTERVAL|DISABLED',
            'storage' => ['<string>', ...],
            'targetIntervalSeconds' => <integer>,
        ],
    ],
    'name' => '<string>',
    'participantTokenConfigurations' => [
        [
            'attributes' => ['<string>', ...],
            'capabilities' => ['<string>', ...],
            'duration' => <integer>,
            'userId' => '<string>',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'participantTokens' => [
        [
            'attributes' => ['<string>', ...],
            'capabilities' => ['<string>', ...],
            'duration' => <integer>,
            'expirationTime' => <DateTime>,
            'participantId' => '<string>',
            'token' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
    'stage' => [
        'activeSessionId' => '<string>',
        'arn' => '<string>',
        'autoParticipantRecordingConfiguration' => [
            'mediaTypes' => ['<string>', ...],
            'storageConfigurationArn' => '<string>',
            'thumbnailConfiguration' => [
                'recordingMode' => 'INTERVAL|DISABLED',
                'storage' => ['<string>', ...],
                'targetIntervalSeconds' => <integer>,
            ],
        ],
        'endpoints' => [
            'events' => '<string>',
            'rtmp' => '<string>',
            'rtmps' => '<string>',
            'whip' => '<string>',
        ],
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

AccessDeniedException:

ServiceQuotaExceededException:

PendingVerification:

CreateStorageConfiguration

$result = $client->createStorageConfiguration([/* ... */]);
$promise = $client->createStorageConfigurationAsync([/* ... */]);

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'storageConfiguration' => [
        'arn' => '<string>',
        'name' => '<string>',
        's3' => [
            'bucketName' => '<string>',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

PendingVerification:

DeleteEncoderConfiguration

$result = $client->deleteEncoderConfiguration([/* ... */]);
$promise = $client->deleteEncoderConfigurationAsync([/* ... */]);

Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

DeleteIngestConfiguration

$result = $client->deleteIngestConfiguration([/* ... */]);
$promise = $client->deleteIngestConfigurationAsync([/* ... */]);

Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless force is set to true.

Parameter Syntax

$result = $client->deleteIngestConfiguration([
    'arn' => '<string>', // REQUIRED
    'force' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

ConflictException:

PendingVerification:

DeletePublicKey

$result = $client->deletePublicKey([/* ... */]);
$promise = $client->deletePublicKeyAsync([/* ... */]);

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

ConflictException:

PendingVerification:

DeleteStage

$result = $client->deleteStage([/* ... */]);
$promise = $client->deleteStageAsync([/* ... */]);

Shuts down and deletes the specified stage (disconnecting all participants). This operation also removes the stageArn from the associated IngestConfiguration, if there are participants using the IngestConfiguration to publish to the stage.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

ConflictException:

PendingVerification:

DeleteStorageConfiguration

$result = $client->deleteStorageConfiguration([/* ... */]);
$promise = $client->deleteStorageConfigurationAsync([/* ... */]);

Deletes the storage configuration for the specified ARN.

If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

DisconnectParticipant

$result = $client->disconnectParticipant([/* ... */]);
$promise = $client->disconnectParticipantAsync([/* ... */]);

Disconnects a specified participant from a specified stage. If the participant is publishing using an IngestConfiguration, DisconnectParticipant also updates the stageArn in the IngestConfiguration to be an empty string.

Parameter Syntax

$result = $client->disconnectParticipant([
    'participantId' => '<string>', // REQUIRED
    'reason' => '<string>',
    'stageArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

PendingVerification:

GetComposition

$result = $client->getComposition([/* ... */]);
$promise = $client->getCompositionAsync([/* ... */]);

Get information about the specified Composition resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'composition' => [
        'arn' => '<string>',
        'destinations' => [
            [
                'configuration' => [
                    'channel' => [
                        'channelArn' => '<string>',
                        'encoderConfigurationArn' => '<string>',
                    ],
                    'name' => '<string>',
                    's3' => [
                        'encoderConfigurationArns' => ['<string>', ...],
                        'recordingConfiguration' => [
                            'format' => 'HLS',
                        ],
                        'storageConfigurationArn' => '<string>',
                        'thumbnailConfigurations' => [
                            [
                                'storage' => ['<string>', ...],
                                'targetIntervalSeconds' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                ],
                'detail' => [
                    's3' => [
                        'recordingPrefix' => '<string>',
                    ],
                ],
                'endTime' => <DateTime>,
                'id' => '<string>',
                'startTime' => <DateTime>,
                'state' => 'STARTING|ACTIVE|STOPPING|RECONNECTING|FAILED|STOPPED',
            ],
            // ...
        ],
        'endTime' => <DateTime>,
        'layout' => [
            'grid' => [
                'featuredParticipantAttribute' => '<string>',
                'gridGap' => <integer>,
                'omitStoppedVideo' => true || false,
                'videoAspectRatio' => 'AUTO|VIDEO|SQUARE|PORTRAIT',
                'videoFillMode' => 'FILL|COVER|CONTAIN',
            ],
            'pip' => [
                'featuredParticipantAttribute' => '<string>',
                'gridGap' => <integer>,
                'omitStoppedVideo' => true || false,
                'pipBehavior' => 'STATIC|DYNAMIC',
                'pipHeight' => <integer>,
                'pipOffset' => <integer>,
                'pipParticipantAttribute' => '<string>',
                'pipPosition' => 'TOP_LEFT|TOP_RIGHT|BOTTOM_LEFT|BOTTOM_RIGHT',
                'pipWidth' => <integer>,
                'videoFillMode' => 'FILL|COVER|CONTAIN',
            ],
        ],
        'stageArn' => '<string>',
        'startTime' => <DateTime>,
        'state' => 'STARTING|ACTIVE|STOPPING|FAILED|STOPPED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

GetEncoderConfiguration

$result = $client->getEncoderConfiguration([/* ... */]);
$promise = $client->getEncoderConfigurationAsync([/* ... */]);

Gets information about the specified EncoderConfiguration resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'encoderConfiguration' => [
        'arn' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'video' => [
            'bitrate' => <integer>,
            'framerate' => <float>,
            'height' => <integer>,
            'width' => <integer>,
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

GetIngestConfiguration

$result = $client->getIngestConfiguration([/* ... */]);
$promise = $client->getIngestConfigurationAsync([/* ... */]);

Gets information about the specified IngestConfiguration.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ingestConfiguration' => [
        'arn' => '<string>',
        'attributes' => ['<string>', ...],
        'ingestProtocol' => 'RTMP|RTMPS',
        'name' => '<string>',
        'participantId' => '<string>',
        'stageArn' => '<string>',
        'state' => 'ACTIVE|INACTIVE',
        'streamKey' => '<string>',
        'tags' => ['<string>', ...],
        'userId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

GetParticipant

$result = $client->getParticipant([/* ... */]);
$promise = $client->getParticipantAsync([/* ... */]);

Gets information about the specified participant token.

Parameter Syntax

$result = $client->getParticipant([
    'participantId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
    'stageArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'participant' => [
        'attributes' => ['<string>', ...],
        'browserName' => '<string>',
        'browserVersion' => '<string>',
        'firstJoinTime' => <DateTime>,
        'ispName' => '<string>',
        'osName' => '<string>',
        'osVersion' => '<string>',
        'participantId' => '<string>',
        'protocol' => 'UNKNOWN|WHIP|RTMP|RTMPS',
        'published' => true || false,
        'recordingS3BucketName' => '<string>',
        'recordingS3Prefix' => '<string>',
        'recordingState' => 'STARTING|ACTIVE|STOPPING|STOPPED|FAILED|DISABLED',
        'sdkVersion' => '<string>',
        'state' => 'CONNECTED|DISCONNECTED',
        'userId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

GetPublicKey

$result = $client->getPublicKey([/* ... */]);
$promise = $client->getPublicKeyAsync([/* ... */]);

Gets information for the specified public key.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

GetStage

$result = $client->getStage([/* ... */]);
$promise = $client->getStageAsync([/* ... */]);

Gets information for the specified stage.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'stage' => [
        'activeSessionId' => '<string>',
        'arn' => '<string>',
        'autoParticipantRecordingConfiguration' => [
            'mediaTypes' => ['<string>', ...],
            'storageConfigurationArn' => '<string>',
            'thumbnailConfiguration' => [
                'recordingMode' => 'INTERVAL|DISABLED',
                'storage' => ['<string>', ...],
                'targetIntervalSeconds' => <integer>,
            ],
        ],
        'endpoints' => [
            'events' => '<string>',
            'rtmp' => '<string>',
            'rtmps' => '<string>',
            'whip' => '<string>',
        ],
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

GetStageSession

$result = $client->getStageSession([/* ... */]);
$promise = $client->getStageSessionAsync([/* ... */]);

Gets information for the specified stage session.

Parameter Syntax

$result = $client->getStageSession([
    'sessionId' => '<string>', // REQUIRED
    'stageArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'stageSession' => [
        'endTime' => <DateTime>,
        'sessionId' => '<string>',
        'startTime' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

GetStorageConfiguration

$result = $client->getStorageConfiguration([/* ... */]);
$promise = $client->getStorageConfigurationAsync([/* ... */]);

Gets the storage configuration for the specified ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'storageConfiguration' => [
        'arn' => '<string>',
        'name' => '<string>',
        's3' => [
            'bucketName' => '<string>',
        ],
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

ImportPublicKey

$result = $client->importPublicKey([/* ... */]);
$promise = $client->importPublicKeyAsync([/* ... */]);

Import a public key to be used for signing stage participant tokens.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

AccessDeniedException:

ServiceQuotaExceededException:

ConflictException:

PendingVerification:

ListCompositions

$result = $client->listCompositions([/* ... */]);
$promise = $client->listCompositionsAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'compositions' => [
        [
            'arn' => '<string>',
            'destinations' => [
                [
                    'endTime' => <DateTime>,
                    'id' => '<string>',
                    'startTime' => <DateTime>,
                    'state' => 'STARTING|ACTIVE|STOPPING|RECONNECTING|FAILED|STOPPED',
                ],
                // ...
            ],
            'endTime' => <DateTime>,
            'stageArn' => '<string>',
            'startTime' => <DateTime>,
            'state' => 'STARTING|ACTIVE|STOPPING|FAILED|STOPPED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

ListEncoderConfigurations

$result = $client->listEncoderConfigurations([/* ... */]);
$promise = $client->listEncoderConfigurationsAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

ListIngestConfigurations

$result = $client->listIngestConfigurations([/* ... */]);
$promise = $client->listIngestConfigurationsAsync([/* ... */]);

Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.

Parameter Syntax

$result = $client->listIngestConfigurations([
    'filterByStageArn' => '<string>',
    'filterByState' => 'ACTIVE|INACTIVE',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ingestConfigurations' => [
        [
            'arn' => '<string>',
            'ingestProtocol' => 'RTMP|RTMPS',
            'name' => '<string>',
            'participantId' => '<string>',
            'stageArn' => '<string>',
            'state' => 'ACTIVE|INACTIVE',
            'userId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

AccessDeniedException:

ListParticipantEvents

$result = $client->listParticipantEvents([/* ... */]);
$promise = $client->listParticipantEventsAsync([/* ... */]);

Lists events for a specified participant that occurred during a specified stage session.

Parameter Syntax

$result = $client->listParticipantEvents([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'participantId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
    'stageArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'events' => [
        [
            'errorCode' => 'INSUFFICIENT_CAPABILITIES|QUOTA_EXCEEDED|PUBLISHER_NOT_FOUND|BITRATE_EXCEEDED|RESOLUTION_EXCEEDED|STREAM_DURATION_EXCEEDED|INVALID_AUDIO_CODEC|INVALID_VIDEO_CODEC|INVALID_PROTOCOL|INVALID_STREAM_KEY|REUSE_OF_STREAM_KEY|B_FRAME_PRESENT|INVALID_INPUT|INTERNAL_SERVER_EXCEPTION',
            'eventTime' => <DateTime>,
            'name' => 'JOINED|LEFT|PUBLISH_STARTED|PUBLISH_STOPPED|SUBSCRIBE_STARTED|SUBSCRIBE_STOPPED|PUBLISH_ERROR|SUBSCRIBE_ERROR|JOIN_ERROR',
            'participantId' => '<string>',
            'remoteParticipantId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

AccessDeniedException:

ListParticipants

$result = $client->listParticipants([/* ... */]);
$promise = $client->listParticipantsAsync([/* ... */]);

Lists all participants in a specified stage session.

Parameter Syntax

$result = $client->listParticipants([
    'filterByPublished' => true || false,
    'filterByRecordingState' => 'STARTING|ACTIVE|STOPPING|STOPPED|FAILED',
    'filterByState' => 'CONNECTED|DISCONNECTED',
    'filterByUserId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sessionId' => '<string>', // REQUIRED
    'stageArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'participants' => [
        [
            'firstJoinTime' => <DateTime>,
            'participantId' => '<string>',
            'published' => true || false,
            'recordingState' => 'STARTING|ACTIVE|STOPPING|STOPPED|FAILED|DISABLED',
            'state' => 'CONNECTED|DISCONNECTED',
            'userId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

AccessDeniedException:

ListPublicKeys

$result = $client->listPublicKeys([/* ... */]);
$promise = $client->listPublicKeysAsync([/* ... */]);

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

AccessDeniedException:

ListStageSessions

$result = $client->listStageSessions([/* ... */]);
$promise = $client->listStageSessionsAsync([/* ... */]);

Gets all sessions for a specified stage.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'stageSessions' => [
        [
            'endTime' => <DateTime>,
            'sessionId' => '<string>',
            'startTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

AccessDeniedException:

ListStages

$result = $client->listStages([/* ... */]);
$promise = $client->listStagesAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

AccessDeniedException:

ConflictException:

ListStorageConfigurations

$result = $client->listStorageConfigurations([/* ... */]);
$promise = $client->listStorageConfigurationsAsync([/* ... */]);

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'storageConfigurations' => [
        [
            'arn' => '<string>',
            'name' => '<string>',
            's3' => [
                'bucketName' => '<string>',
            ],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

ListTagsForResource

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

Gets information about AWS tags for the specified ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

ValidationException:

InternalServerException:

StartComposition

$result = $client->startComposition([/* ... */]);
$promise = $client->startCompositionAsync([/* ... */]);

Starts a Composition from a stage based on the configuration provided in the request.

A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:

• When StopComposition is called.

• After a 1-minute timeout, when all participants are disconnected from the stage.

• After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.

• When broadcasting to the IVS channel fails and all retries are exhausted.

• When broadcasting is disconnected and all attempts to reconnect are exhausted.

Parameter Syntax

$result = $client->startComposition([
    'destinations' => [ // REQUIRED
        [
            'channel' => [
                'channelArn' => '<string>', // REQUIRED
                'encoderConfigurationArn' => '<string>',
            ],
            'name' => '<string>',
            's3' => [
                'encoderConfigurationArns' => ['<string>', ...], // REQUIRED
                'recordingConfiguration' => [
                    'format' => 'HLS',
                ],
                'storageConfigurationArn' => '<string>', // REQUIRED
                'thumbnailConfigurations' => [
                    [
                        'storage' => ['<string>', ...],
                        'targetIntervalSeconds' => <integer>,
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'idempotencyToken' => '<string>',
    'layout' => [
        'grid' => [
            'featuredParticipantAttribute' => '<string>',
            'gridGap' => <integer>,
            'omitStoppedVideo' => true || false,
            'videoAspectRatio' => 'AUTO|VIDEO|SQUARE|PORTRAIT',
            'videoFillMode' => 'FILL|COVER|CONTAIN',
        ],
        'pip' => [
            'featuredParticipantAttribute' => '<string>',
            'gridGap' => <integer>,
            'omitStoppedVideo' => true || false,
            'pipBehavior' => 'STATIC|DYNAMIC',
            'pipHeight' => <integer>,
            'pipOffset' => <integer>,
            'pipParticipantAttribute' => '<string>',
            'pipPosition' => 'TOP_LEFT|TOP_RIGHT|BOTTOM_LEFT|BOTTOM_RIGHT',
            'pipWidth' => <integer>,
            'videoFillMode' => 'FILL|COVER|CONTAIN',
        ],
    ],
    'stageArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'composition' => [
        'arn' => '<string>',
        'destinations' => [
            [
                'configuration' => [
                    'channel' => [
                        'channelArn' => '<string>',
                        'encoderConfigurationArn' => '<string>',
                    ],
                    'name' => '<string>',
                    's3' => [
                        'encoderConfigurationArns' => ['<string>', ...],
                        'recordingConfiguration' => [
                            'format' => 'HLS',
                        ],
                        'storageConfigurationArn' => '<string>',
                        'thumbnailConfigurations' => [
                            [
                                'storage' => ['<string>', ...],
                                'targetIntervalSeconds' => <integer>,
                            ],
                            // ...
                        ],
                    ],
                ],
                'detail' => [
                    's3' => [
                        'recordingPrefix' => '<string>',
                    ],
                ],
                'endTime' => <DateTime>,
                'id' => '<string>',
                'startTime' => <DateTime>,
                'state' => 'STARTING|ACTIVE|STOPPING|RECONNECTING|FAILED|STOPPED',
            ],
            // ...
        ],
        'endTime' => <DateTime>,
        'layout' => [
            'grid' => [
                'featuredParticipantAttribute' => '<string>',
                'gridGap' => <integer>,
                'omitStoppedVideo' => true || false,
                'videoAspectRatio' => 'AUTO|VIDEO|SQUARE|PORTRAIT',
                'videoFillMode' => 'FILL|COVER|CONTAIN',
            ],
            'pip' => [
                'featuredParticipantAttribute' => '<string>',
                'gridGap' => <integer>,
                'omitStoppedVideo' => true || false,
                'pipBehavior' => 'STATIC|DYNAMIC',
                'pipHeight' => <integer>,
                'pipOffset' => <integer>,
                'pipParticipantAttribute' => '<string>',
                'pipPosition' => 'TOP_LEFT|TOP_RIGHT|BOTTOM_LEFT|BOTTOM_RIGHT',
                'pipWidth' => <integer>,
                'videoFillMode' => 'FILL|COVER|CONTAIN',
            ],
        ],
        'stageArn' => '<string>',
        'startTime' => <DateTime>,
        'state' => 'STARTING|ACTIVE|STOPPING|FAILED|STOPPED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

PendingVerification:

StopComposition

$result = $client->stopComposition([/* ... */]);
$promise = $client->stopCompositionAsync([/* ... */]);

Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

InternalServerException:

ServiceQuotaExceededException:

ConflictException:

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

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

InternalServerException:

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:

ValidationException:

InternalServerException:

UpdateIngestConfiguration

$result = $client->updateIngestConfiguration([/* ... */]);
$promise = $client->updateIngestConfigurationAsync([/* ... */]);

Updates a specified IngestConfiguration. Only the stage ARN attached to the IngestConfiguration can be updated. An IngestConfiguration that is active cannot be updated.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ingestConfiguration' => [
        'arn' => '<string>',
        'attributes' => ['<string>', ...],
        'ingestProtocol' => 'RTMP|RTMPS',
        'name' => '<string>',
        'participantId' => '<string>',
        'stageArn' => '<string>',
        'state' => 'ACTIVE|INACTIVE',
        'streamKey' => '<string>',
        'tags' => ['<string>', ...],
        'userId' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

ConflictException:

PendingVerification:

UpdateStage

$result = $client->updateStage([/* ... */]);
$promise = $client->updateStageAsync([/* ... */]);

Updates a stage’s configuration.

Parameter Syntax

$result = $client->updateStage([
    'arn' => '<string>', // REQUIRED
    'autoParticipantRecordingConfiguration' => [
        'mediaTypes' => ['<string>', ...],
        'storageConfigurationArn' => '<string>', // REQUIRED
        'thumbnailConfiguration' => [
            'recordingMode' => 'INTERVAL|DISABLED',
            'storage' => ['<string>', ...],
            'targetIntervalSeconds' => <integer>,
        ],
    ],
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'stage' => [
        'activeSessionId' => '<string>',
        'arn' => '<string>',
        'autoParticipantRecordingConfiguration' => [
            'mediaTypes' => ['<string>', ...],
            'storageConfigurationArn' => '<string>',
            'thumbnailConfiguration' => [
                'recordingMode' => 'INTERVAL|DISABLED',
                'storage' => ['<string>', ...],
                'targetIntervalSeconds' => <integer>,
            ],
        ],
        'endpoints' => [
            'events' => '<string>',
            'rtmp' => '<string>',
            'rtmps' => '<string>',
            'whip' => '<string>',
        ],
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

ValidationException:

AccessDeniedException:

ServiceQuotaExceededException:

ConflictException:

PendingVerification: