1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
// Code generated by smithy-go-codegen DO NOT EDIT.
// Package ivsrealtime provides the API client, operations, and parameter types
// for Amazon Interactive Video Service RealTime.
//
// Introduction The Amazon Interactive Video Service (IVS) real-time API is REST
// compatible, using a standard HTTP API and an AWS EventBridge event stream for
// responses. JSON is used for both requests and responses, including errors.
// Terminology:
// - A stage is a virtual space where participants can exchange video in real
// time.
// - A participant token is a token that authenticates a participant when they
// join a stage.
// - A participant object represents participants (people) in the stage and
// contains information about them. When a token is created, it includes a
// participant ID; when a participant uses that token to join a stage, the
// participant is associated with that participant ID. There is a 1:1 mapping
// between participant tokens and participants.
// - Server-side composition: The composition process composites participants of
// a stage into a single video and forwards it to a set of outputs (e.g., IVS
// channels). Composition endpoints support this process.
// - Server-side composition: A composition controls the look of the outputs,
// including how participants are positioned in the video.
//
// Resources The following resources contain information about your IVS live
// stream (see Getting Started with Amazon IVS Real-Time Streaming (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html)
// ):
// - Stage — A stage is a virtual space where participants can exchange video in
// real time.
//
// Tagging A tag is a metadata label that you assign to an AWS resource. A tag
// comprises a key and a value, both set by you. For example, you might set a tag
// as topic:nature to label a particular video category. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
// for more information, including restrictions that apply to tags and "Tag naming
// limits and requirements"; Amazon IVS stages has no service-specific constraints
// beyond what is documented there. Tags can help you identify and organize your
// AWS resources. For example, you can use the same tag for different resources to
// indicate that they are related. You can also use tags to manage access (see
// Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)
// ). The Amazon IVS real-time API has these tag-related endpoints: TagResource ,
// UntagResource , and ListTagsForResource . The following resource supports
// tagging: Stage. At most 50 tags can be applied to a resource. Stages Endpoints
// - CreateParticipantToken — Creates an additional token for a specified stage.
// This can be done after stage creation or when tokens expire.
// - CreateStage — Creates a new stage (and optionally participant tokens).
// - DeleteStage — Shuts down and deletes the specified stage (disconnecting all
// participants).
// - DisconnectParticipant — Disconnects a specified participant and revokes the
// participant permanently from a specified stage.
// - GetParticipant — Gets information about the specified participant token.
// - GetStage — Gets information for the specified stage.
// - GetStageSession — Gets information for the specified stage session.
// - ListParticipantEvents — Lists events for a specified participant that
// occurred during a specified stage session.
// - ListParticipants — Lists all participants in a specified stage session.
// - ListStages — Gets summary information about all stages in your account, in
// the AWS region where the API request is processed.
// - ListStageSessions — Gets all sessions for a specified stage.
// - UpdateStage — Updates a stage’s configuration.
//
// Composition Endpoints
// - GetComposition — Gets information about the specified Composition resource.
// - ListCompositions — Gets summary information about all Compositions in your
// account, in the AWS region where the API request is processed.
// - StartComposition — Starts a Composition from a stage based on the
// configuration provided in the request.
// - StopComposition — Stops and deletes a Composition resource. Any broadcast
// from the Composition resource is stopped.
//
// EncoderConfiguration Endpoints
// - CreateEncoderConfiguration — Creates an EncoderConfiguration object.
// - DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource.
// Ensures that no Compositions are using this template; otherwise, returns an
// error.
// - GetEncoderConfiguration — Gets information about the specified
// EncoderConfiguration resource.
// - ListEncoderConfigurations — Gets summary information about all
// EncoderConfigurations in your account, in the AWS region where the API request
// is processed.
//
// StorageConfiguration Endpoints
// - CreateStorageConfiguration — Creates a new storage configuration, used to
// enable recording to Amazon S3.
// - DeleteStorageConfiguration — Deletes the storage configuration for the
// specified ARN.
// - GetStorageConfiguration — Gets the storage configuration for the specified
// ARN.
// - ListStorageConfigurations — Gets summary information about all storage
// configurations in your account, in the AWS region where the API request is
// processed.
//
// Tags Endpoints
// - ListTagsForResource — Gets information about AWS tags for the specified ARN.
// - TagResource — Adds or updates tags for the AWS resource with the specified
// ARN.
// - UntagResource — Removes tags from the resource with the specified ARN.
package ivsrealtime
|
