github.com/aavshr/aws-sdk-go@v1.41.3/service/ivs/doc.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package ivs provides the client and types for making API 4 // requests to Amazon Interactive Video Service. 5 // 6 // Introduction 7 // 8 // The Amazon Interactive Video Service (IVS) API is REST compatible, using 9 // a standard HTTP API and an AWS EventBridge event stream for responses. JSON 10 // is used for both requests and responses, including errors. 11 // 12 // The API is an AWS regional service, currently in these regions: us-west-2, 13 // us-east-1, and eu-west-1. 14 // 15 // All API request parameters and URLs are case sensitive. 16 // 17 // For a summary of notable documentation changes in each release, see Document 18 // History (https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html). 19 // 20 // Service Endpoints 21 // 22 // The following are the Amazon IVS service endpoints (all HTTPS): 23 // 24 // Region name: US West (Oregon) 25 // 26 // * Region: us-west-2 27 // 28 // * Endpoint: ivs.us-west-2.amazonaws.com 29 // 30 // Region name: US East (Virginia) 31 // 32 // * Region: us-east-1 33 // 34 // * Endpoint: ivs.us-east-1.amazonaws.com 35 // 36 // Region name: EU West (Dublin) 37 // 38 // * Region: eu-west-1 39 // 40 // * Endpoint: ivs.eu-west-1.amazonaws.com 41 // 42 // Allowed Header Values 43 // 44 // * Accept: application/json 45 // 46 // * Accept-Encoding: gzip, deflate 47 // 48 // * Content-Type: application/json 49 // 50 // Resources 51 // 52 // The following resources contain information about your IVS live stream (see 53 // Getting Started with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html)): 54 // 55 // * Channel — Stores configuration data related to your live stream. You 56 // first create a channel and then use the channel’s stream key to start 57 // your live stream. See the Channel endpoints for more information. 58 // 59 // * Stream key — An identifier assigned by Amazon IVS when you create 60 // a channel, which is then used to authorize streaming. See the StreamKey 61 // endpoints for more information. Treat the stream key like a secret, since 62 // it allows anyone to stream to the channel. 63 // 64 // * Playback key pair — Video playback may be restricted using playback-authorization 65 // tokens, which use public-key encryption. A playback key pair is the public-private 66 // pair of keys used to sign and validate the playback-authorization token. 67 // See the PlaybackKeyPair endpoints for more information. 68 // 69 // * Recording configuration — Stores configuration related to recording 70 // a live stream and where to store the recorded content. Multiple channels 71 // can reference the same recording configuration. See the Recording Configuration 72 // endpoints for more information. 73 // 74 // Tagging 75 // 76 // A tag is a metadata label that you assign to an AWS resource. A tag comprises 77 // a key and a value, both set by you. For example, you might set a tag as topic:nature 78 // to label a particular video category. See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 79 // for more information, including restrictions that apply to tags. 80 // 81 // Tags can help you identify and organize your AWS resources. For example, 82 // you can use the same tag for different resources to indicate that they are 83 // related. You can also use tags to manage access (see Access Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)). 84 // 85 // The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, 86 // and ListTagsForResource. The following resources support tagging: Channels, 87 // Stream Keys, Playback Key Pairs, and Recording Configurations. 88 // 89 // Authentication versus Authorization 90 // 91 // Note the differences between these concepts: 92 // 93 // * Authentication is about verifying identity. You need to be authenticated 94 // to sign Amazon IVS API requests. 95 // 96 // * Authorization is about granting permissions. You need to be authorized 97 // to view Amazon IVS private channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html). 98 // (Private channels are channels that are enabled for "playback authorization.") 99 // 100 // Authentication 101 // 102 // All Amazon IVS API requests must be authenticated with a signature. The AWS 103 // Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing 104 // the underlying API calls for you. However, if your application calls the 105 // Amazon IVS API directly, it’s your responsibility to sign the requests. 106 // 107 // You generate a signature using valid AWS credentials that have permission 108 // to perform the requested action. For example, you must sign PutMetadata requests 109 // with a signature generated from an IAM user account that has the ivs:PutMetadata 110 // permission. 111 // 112 // For more information: 113 // 114 // * Authentication and generating signatures — See Authenticating Requests 115 // (AWS Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) 116 // in the AWS General Reference. 117 // 118 // * Managing Amazon IVS permissions — See Identity and Access Management 119 // (https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) on 120 // the Security page of the Amazon IVS User Guide. 121 // 122 // Channel Endpoints 123 // 124 // * CreateChannel — Creates a new channel and an associated stream key 125 // to start streaming. 126 // 127 // * GetChannel — Gets the channel configuration for the specified channel 128 // ARN (Amazon Resource Name). 129 // 130 // * BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously. 131 // 132 // * ListChannels — Gets summary information about all channels in your 133 // account, in the AWS region where the API request is processed. This list 134 // can be filtered to match a specified name or recording-configuration ARN. 135 // Filters are mutually exclusive and cannot be used together. If you try 136 // to use both filters, you will get an error (409 Conflict Exception). 137 // 138 // * UpdateChannel — Updates a channel's configuration. This does not affect 139 // an ongoing stream of this channel. You must stop and restart the stream 140 // for the changes to take effect. 141 // 142 // * DeleteChannel — Deletes the specified channel. 143 // 144 // StreamKey Endpoints 145 // 146 // * CreateStreamKey — Creates a stream key, used to initiate a stream, 147 // for the specified channel ARN. 148 // 149 // * GetStreamKey — Gets stream key information for the specified ARN. 150 // 151 // * BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously. 152 // 153 // * ListStreamKeys — Gets summary information about stream keys for the 154 // specified channel. 155 // 156 // * DeleteStreamKey — Deletes the stream key for the specified ARN, so 157 // it can no longer be used to stream. 158 // 159 // Stream Endpoints 160 // 161 // * GetStream — Gets information about the active (live) stream on a specified 162 // channel. 163 // 164 // * ListStreams — Gets summary information about live streams in your 165 // account, in the AWS region where the API request is processed. 166 // 167 // * StopStream — Disconnects the incoming RTMPS stream for the specified 168 // channel. Can be used in conjunction with DeleteStreamKey to prevent further 169 // streaming to a channel. 170 // 171 // * PutMetadata — Inserts metadata into the active stream of the specified 172 // channel. A maximum of 5 requests per second per channel is allowed, each 173 // with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, 174 // we recommend batching your data into a single PutMetadata call.) 175 // 176 // PlaybackKeyPair Endpoints 177 // 178 // For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) 179 // in the Amazon IVS User Guide. 180 // 181 // * ImportPlaybackKeyPair — Imports the public portion of a new key pair 182 // and returns its arn and fingerprint. The privateKey can then be used to 183 // generate viewer authorization tokens, to grant viewers access to private 184 // channels (channels enabled for playback authorization). 185 // 186 // * GetPlaybackKeyPair — Gets a specified playback authorization key pair 187 // and returns the arn and fingerprint. The privateKey held by the caller 188 // can be used to generate viewer authorization tokens, to grant viewers 189 // access to private channels. 190 // 191 // * ListPlaybackKeyPairs — Gets summary information about playback key 192 // pairs. 193 // 194 // * DeletePlaybackKeyPair — Deletes a specified authorization key pair. 195 // This invalidates future viewer tokens generated using the key pair’s 196 // privateKey. 197 // 198 // RecordingConfiguration Endpoints 199 // 200 // * CreateRecordingConfiguration — Creates a new recording configuration, 201 // used to enable recording to Amazon S3. 202 // 203 // * GetRecordingConfiguration — Gets the recording-configuration metadata 204 // for the specified ARN. 205 // 206 // * ListRecordingConfigurations — Gets summary information about all recording 207 // configurations in your account, in the AWS region where the API request 208 // is processed. 209 // 210 // * DeleteRecordingConfiguration — Deletes the recording configuration 211 // for the specified ARN. 212 // 213 // AWS Tags Endpoints 214 // 215 // * TagResource — Adds or updates tags for the AWS resource with the specified 216 // ARN. 217 // 218 // * UntagResource — Removes tags from the resource with the specified 219 // ARN. 220 // 221 // * ListTagsForResource — Gets information about AWS tags for the specified 222 // ARN. 223 // 224 // See https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14 for more information on this service. 225 // 226 // See ivs package documentation for more information. 227 // https://docs.aws.amazon.com/sdk-for-go/api/service/ivs/ 228 // 229 // Using the Client 230 // 231 // To contact Amazon Interactive Video Service with the SDK use the New function to create 232 // a new service client. With that client you can make API requests to the service. 233 // These clients are safe to use concurrently. 234 // 235 // See the SDK's documentation for more information on how to use the SDK. 236 // https://docs.aws.amazon.com/sdk-for-go/api/ 237 // 238 // See aws.Config documentation for more information on configuring SDK clients. 239 // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config 240 // 241 // See the Amazon Interactive Video Service client IVS for more 242 // information on creating client for this service. 243 // https://docs.aws.amazon.com/sdk-for-go/api/service/ivs/#New 244 package ivs