Ivs Realtime

create_encoder_configuration()
create_encoder_configuration(params::Dict{String,<:Any})

Creates an EncoderConfiguration object.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "name": Optional name to identify the resource.
• "tags": Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.
• "video": Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.

create_participant_token(stage_arn)
create_participant_token(stage_arn, params::Dict{String,<:Any})

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.

Arguments

• stage_arn: ARN of the stage to which this token is scoped.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "attributes": Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
• "capabilities": Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.
• "duration": Duration (in minutes), after which the token expires. Default: 720 (12 hours).
• "userId": Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

create_stage()
create_stage(params::Dict{String,<:Any})

Creates a new stage (and optionally participant tokens).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "autoParticipantRecordingConfiguration": Auto participant recording configuration object attached to the stage.
• "name": Optional name that can be specified for the stage being created.
• "participantTokenConfigurations": Array of participant token configuration objects to attach to the new stage.
• "tags": Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

create_storage_configuration(s3)
create_storage_configuration(s3, params::Dict{String,<:Any})

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.

Arguments

• s3: A complex type that contains a storage configuration for where recorded video will be stored.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "name": Storage configuration name. The value does not need to be unique.
• "tags": Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

delete_encoder_configuration(arn)
delete_encoder_configuration(arn, params::Dict{String,<:Any})

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

Arguments

• arn: ARN of the EncoderConfiguration.

delete_stage(arn)
delete_stage(arn, params::Dict{String,<:Any})

Shuts down and deletes the specified stage (disconnecting all participants).

Arguments

• arn: ARN of the stage to be deleted.

delete_storage_configuration(arn)
delete_storage_configuration(arn, params::Dict{String,<:Any})

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.

Arguments

• arn: ARN of the storage configuration to be deleted.

disconnect_participant(participant_id, stage_arn)
disconnect_participant(participant_id, stage_arn, params::Dict{String,<:Any})

Disconnects a specified participant and revokes the participant permanently from a specified stage.

Arguments

• participant_id: Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.
• stage_arn: ARN of the stage to which the participant is attached.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "reason": Description of why this participant is being disconnected.

get_composition(arn)
get_composition(arn, params::Dict{String,<:Any})

Get information about the specified Composition resource.

Arguments

• arn: ARN of the Composition resource.

get_encoder_configuration(arn)
get_encoder_configuration(arn, params::Dict{String,<:Any})

Gets information about the specified EncoderConfiguration resource.

Arguments

• arn: ARN of the EncoderConfiguration resource.

get_participant(participant_id, session_id, stage_arn)
get_participant(participant_id, session_id, stage_arn, params::Dict{String,<:Any})

Gets information about the specified participant token.

Arguments

• participant_id: Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.
• session_id: ID of a session within the stage.
• stage_arn: Stage ARN.

get_stage(arn)
get_stage(arn, params::Dict{String,<:Any})

Gets information for the specified stage.

Arguments

• arn: ARN of the stage for which the information is to be retrieved.

get_stage_session(session_id, stage_arn)
get_stage_session(session_id, stage_arn, params::Dict{String,<:Any})

Gets information for the specified stage session.

Arguments

• session_id: ID of a session within the stage.
• stage_arn: ARN of the stage for which the information is to be retrieved.

get_storage_configuration(arn)
get_storage_configuration(arn, params::Dict{String,<:Any})

Gets the storage configuration for the specified ARN.

Arguments

• arn: ARN of the storage configuration to be retrieved.

list_compositions()
list_compositions(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filterByEncoderConfigurationArn": Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.
• "filterByStageArn": Filters the Composition list to match the specified Stage ARN.
• "maxResults": Maximum number of results to return. Default: 100.
• "nextToken": The first Composition to retrieve. This is used for pagination; see the nextToken response field.

list_encoder_configurations()
list_encoder_configurations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Maximum number of results to return. Default: 100.
• "nextToken": The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.

list_participant_events(participant_id, session_id, stage_arn)
list_participant_events(participant_id, session_id, stage_arn, params::Dict{String,<:Any})

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

Arguments

• participant_id: Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.
• session_id: ID of a session within the stage.
• stage_arn: Stage ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Maximum number of results to return. Default: 50.
• "nextToken": The first participant event to retrieve. This is used for pagination; see the nextToken response field.

list_participants(session_id, stage_arn)
list_participants(session_id, stage_arn, params::Dict{String,<:Any})

Lists all participants in a specified stage session.

Arguments

• session_id: ID of the session within the stage.
• stage_arn: Stage ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "filterByPublished": Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
• "filterByRecordingState": Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
• "filterByState": Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
• "filterByUserId": Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
• "maxResults": Maximum number of results to return. Default: 50.
• "nextToken": The first participant to retrieve. This is used for pagination; see the nextToken response field.

list_stage_sessions(stage_arn)
list_stage_sessions(stage_arn, params::Dict{String,<:Any})

Gets all sessions for a specified stage.

Arguments

• stage_arn: Stage ARN.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Maximum number of results to return. Default: 50.
• "nextToken": The first stage session to retrieve. This is used for pagination; see the nextToken response field.

list_stages()
list_stages(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Maximum number of results to return. Default: 50.
• "nextToken": The first stage to retrieve. This is used for pagination; see the nextToken response field.

list_storage_configurations()
list_storage_configurations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.
• "nextToken": The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Gets information about AWS tags for the specified ARN.

Arguments

• resource_arn: The ARN of the resource to be retrieved. The ARN must be URL-encoded.

start_composition(destinations, stage_arn)
start_composition(destinations, stage_arn, params::Dict{String,<:Any})

Starts a Composition from a stage based on the configuration provided in the request. A Composition is an ephemeral resource that exists after this endpoint 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.

Arguments

• destinations: Array of destination configuration.
• stage_arn: ARN of the stage to be used for compositing.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "idempotencyToken": Idempotency token.
• "layout": Layout object to configure composition parameters.
• "tags": Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

stop_composition(arn)
stop_composition(arn, params::Dict{String,<:Any})

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

Arguments

• arn: ARN of the Composition.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The ARN of the resource to be tagged. The ARN must be URL-encoded.
• tags: Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from the resource with the specified ARN.

Arguments

• resource_arn: The ARN of the resource to be untagged. The ARN must be URL-encoded.
• tag_keys: Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.

update_stage(arn)
update_stage(arn, params::Dict{String,<:Any})

Updates a stage’s configuration.

Arguments

• arn: ARN of the stage to be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "autoParticipantRecordingConfiguration": Auto-participant-recording configuration object to attach to the stage. Auto-participant-recording configuration cannot be updated while recording is active.
• "name": Name of the stage to be updated.