DescribeImageGenerationConfiguration
Gets the ImageGenerationConfiguration
for a given Kinesis video stream.
Request Syntax
POST /describeImageGenerationConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string
",
"StreamName": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- StreamARN
-
The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the
StreamName
or theStreamARN
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
Required: No
- StreamName
-
The name of the stream from which to retrieve the image generation configuration. You must specify either the
StreamName
or theStreamARN
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_.-]+
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ImageGenerationConfiguration": {
"DestinationConfig": {
"DestinationRegion": "string",
"Uri": "string"
},
"Format": "string",
"FormatConfig": {
"string" : "string"
},
"HeightPixels": number,
"ImageSelectorType": "string",
"SamplingInterval": number,
"Status": "string",
"WidthPixels": number
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ImageGenerationConfiguration
-
The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.
Type: ImageGenerationConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have required permissions to perform this operation.
HTTP Status Code: 401
- ClientLimitExceededException
-
Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.
HTTP Status Code: 400
- InvalidArgumentException
-
The value for this input parameter is invalid.
HTTP Status Code: 400
- ResourceNotFoundException
-
Amazon Kinesis Video Streams can't find the stream that you specified.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: