Ivs Realtime

This page documents function available when using the Ivs_Realtime module, created with @service Ivs_Realtime.

Index

Documentation

Main.Ivs_Realtime.create_participant_tokenMethod
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.
Main.Ivs_Realtime.create_stageMethod
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:

  • "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.
Main.Ivs_Realtime.delete_stageMethod
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.
Main.Ivs_Realtime.disconnect_participantMethod
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.
Main.Ivs_Realtime.get_participantMethod
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.
Main.Ivs_Realtime.get_stageMethod
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.
Main.Ivs_Realtime.get_stage_sessionMethod
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.
Main.Ivs_Realtime.list_participant_eventsMethod
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 to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs_Realtime.list_participantsMethod
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, or filterByState can be provided per request.
  • "filterByState": Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.
  • "filterByUserId": Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or filterByState 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.
Main.Ivs_Realtime.list_stage_sessionsMethod
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 to retrieve. This is used for pagination; see the nextToken response field.
Main.Ivs_Realtime.list_stagesMethod
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.
Main.Ivs_Realtime.list_tags_for_resourceMethod
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.
Main.Ivs_Realtime.tag_resourceMethod
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.
Main.Ivs_Realtime.untag_resourceMethod
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.
Main.Ivs_Realtime.update_stageMethod
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:

  • "name": Name of the stage to be updated.