"documentation":"<p>Creates a stream key, used to initiate a stream, for the specified channel ARN.</p> <p>Note that <a>CreateChannel</a> creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use <a>DeleteStreamKey</a> and then CreateStreamKey.</p>"
"documentation":"<p>Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>.</p>"
"documentation":"<p>Gets the channel configuration for the specified channel ARN. See also <a>BatchGetChannel</a>.</p>"
},
"GetPlaybackKeyPair":{
"name":"GetPlaybackKeyPair",
"http":{
"method":"POST",
"requestUri":"/GetPlaybackKeyPair"
},
"input":{"shape":"GetPlaybackKeyPairRequest"},
"output":{"shape":"GetPlaybackKeyPairResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets a specified playback authorization key pair and returns the <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to generate viewer authorization tokens, to grant viewers access to authorized channels.</p>"
"documentation":"<p>Imports the public portion of a new key pair and returns its <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer authorization tokens, to grant viewers access to authorized channels.</p>"
"documentation":"<p>Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.</p>"
"documentation":"<p>Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.</p>"
"documentation":"<p>Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to prevent further streaming to a channel.</p> <note> <p>Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the <code>streamKey</code> attached to the channel.</p> </note>"
"documentation":"<p>Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.</p>"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"exceptionMessage":{
"shape":"errorMessage",
"documentation":"<p>User does not have sufficient access to perform this action.</p>"
}
},
"error":{"httpStatusCode":403},
"exception":true
},
"BatchError":{
"type":"structure",
"members":{
"arn":{
"shape":"ResourceArn",
"documentation":"<p>Channel ARN.</p>"
},
"code":{
"shape":"errorCode",
"documentation":"<p>Error code.</p>"
},
"message":{
"shape":"errorMessage",
"documentation":"<p>Error message, determined by the application.</p>"
}
},
"documentation":"<p>Error related to a specific channel, specified by its ARN.</p>"
},
"BatchErrors":{
"type":"list",
"member":{"shape":"BatchError"}
},
"BatchGetChannelRequest":{
"type":"structure",
"required":["arns"],
"members":{
"arns":{
"shape":"ChannelArnList",
"documentation":"<p>Array of ARNs, one per channel.</p>"
}
}
},
"BatchGetChannelResponse":{
"type":"structure",
"members":{
"channels":{"shape":"Channels"},
"errors":{
"shape":"BatchErrors",
"documentation":"<p>Each error object is related to a specific ARN in the request.</p>"
}
}
},
"BatchGetStreamKeyRequest":{
"type":"structure",
"required":["arns"],
"members":{
"arns":{
"shape":"StreamKeyArnList",
"documentation":"<p>Array of ARNs, one per channel.</p>"
"documentation":"<p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.</i> Valid values:</p> <ul> <li> <p> <code>STANDARD</code>: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.</p> </li> <li> <p> <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.</p> </li> </ul> <p>Default: <code>STANDARD</code>.</p>"
"documentation":"<p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.</i> Valid values:</p> <ul> <li> <p> <code>STANDARD</code>: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.</p> </li> <li> <p> <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.</p> </li> </ul> <p>Default: <code>STANDARD</code>.</p>"
},
"authorized":{
"shape":"Boolean",
"documentation":"<p>Whether the channel is authorized. Default: <code>false</code>.</p>"
"documentation":"<p>The public portion of a customer-generated key pair.</p>"
},
"name":{
"shape":"PlaybackKeyPairName",
"documentation":"<p>An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>Any tags provided with the request are added to the playback key pair tags.</p>"
"documentation":"<p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately.</i> Valid values:</p> <ul> <li> <p> <code>STANDARD</code>: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.</p> </li> <li> <p> <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps.</p> </li> </ul> <p>Default: <code>STANDARD</code>.</p>"
},
"authorized":{
"shape":"Boolean",
"documentation":"<p>Whether the channel is authorized. Default: <code>false</code>.</p>"
"documentation":"<p> <b>Introduction</b> </p> <p>The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an <a href=\"http://aws.amazon.com/sns\">AWS SNS</a> event stream for responses. JSON is used for both requests and responses, including errors.</p> <p>The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and eu-west-1.</p> <p> <i> <b>All API request parameters and URLs are case sensitive. </b> </i> </p> <p>For a summary of notable documentation changes in each release, see <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html\"> Document History</a>.</p> <p> <b>Service Endpoints</b> </p> <p>The following are the Amazon IVS service endpoints (all HTTPS): </p> <p>Region name: US West (Oregon)</p> <ul> <li> <p>Region: <code>us-west-2</code> </p> </li> <li> <p>Endpoint: <code>ivs.us-west-2.amazonaws.com</code> </p> </li> </ul> <p>Region name: US East (Virginia)</p> <ul> <li> <p>Region: <code>us-east-1</code> </p> </li> <li> <p>Endpoint: <code>ivs.us-east-1.amazonaws.com</code> </p> </li> </ul> <p>Region name: EU West (Dublin)</p> <ul> <li> <p>Region: <code>eu-west-1</code> </p> </li> <li> <p>Endpoint: <code>ivs.eu-west-1.amazonaws.com</code> </p> </li> </ul> <p> <b>Allowed Header Values</b> </p> <ul> <li> <p> <code> <b>Accept:</b> </code> application/json</p> </li> <li> <p> <code> <b>Accept-Encoding:</b> </code> gzip, deflate</p> </li> <li> <p> <code> <b>Content-Type:</b> </code>application/json</p> </li> </ul> <p> <b>Resources</b> </p> <p>The following resources contain information about your IVS live stream (see <a href=\"https://docs.aws.amazon.com/ivs/latest/userguide/GSIVS.html\"> Getting Started with Amazon IVS</a>):</p> <ul> <li> <p>Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information. </p> </li> <li> <p>Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. <i> <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b> </i> </p> </li> <li> <p>Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.</p> </li> </ul> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> for more information, including restrictions that apply to tags.</p> <p>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 <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html\">AccessTags</a>).</p><p>TheAmazonIVSAPIhasthesetag-relatedendpoints:<a>TagResource</a>,<a>UntagResource</a>,and<a>ListTagsForResource</a>.Thefollowingresourcessupporttagging:Channels,StreamKeys,andPlaybackKeyPairs.</p><p><b>ChannelEndpoints</b></p><ul><li><p><a>CreateChannel</a>—Createsanewchannelandanassociatedstreamkeytostartstreaming.</p></li><li><p><a>GetChannel</a>—GetsthechannelconfigurationforthespecifiedchannelARN(AmazonResourceName).</p></li><li><p><a>BatchGetChannel</a>—Performs<a>GetChannel</a>onmultipleARNssimultaneously.</p></li><li><p><a>ListChannels</a>—Getssummaryinformationaboutallchannelsinyouraccount,intheAWSregionwheretheAPIrequestisprocessed.