V1 Flows flowArn Source-thumbnail
URI
/v1/flows/
flowArn
/source-thumbnail
HTTP methods
GET
Operation ID: DescribeFlowSourceThumbnail
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
flowArn | String | True | The Amazon Resource Name (ARN) of the flow. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | DescribeFlowSourceThumbnailResponse | MediaConnect returned the flow details successfully. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
202 | DescribeFlowSourceThumbnailResponse | MediaConnect is starting the flow. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | ResponseError | The request that you submitted is not valid. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ResponseError | You don't have the required permissions to perform this operation. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ResponseError | MediaConnect did not find the resource that you specified in the request. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | ResponseError | You have exceeded the service request rate limit for your MediaConnect account. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | ResponseError | MediaConnect can't fulfill your request because it encountered an unexpected condition. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
503 | ResponseError | MediaConnect is currently unavailable. Try again later. |
Schemas
Response bodies
{ "thumbnailDetails": { "thumbnail": "string", "flowArn": "string", "thumbnailMessages": [ { "code": "string", "resourceName": "string", "message": "string" } ], "timecode": "string", "timestamp": "string" } }
{ "message": "string" }
Properties
DescribeFlowSourceThumbnailResponse
The result of a successful DescribeFlowSourceThumbnail request.
Property | Type | Required | Description |
---|---|---|---|
thumbnailDetails | True |
MessageDetail
Property | Type | Required | Description |
---|---|---|---|
code | string | True | The error code. |
message | string | True | The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. |
resourceName | string | False | The name of the resource. |
ResponseError
An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.
Property | Type | Required | Description |
---|---|---|---|
message | string | True | The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed. |
ThumbnailDetails
The details of the thumbnail, including thumbnail base64 string, timecode and the time when thumbnail was generated.
Property | Type | Required | Description |
---|---|---|---|
flowArn | string | True | The ARN of the flow that DescribeFlowSourceThumbnail was performed on. |
thumbnail | string Format: byte | False | Thumbnail Base64 string. |
thumbnailMessages | Array of type MessageDetail | True | Status code and messages about the flow source thumbnail. |
timecode | string | False | Timecode of thumbnail. |
timestamp | string Format: date-time | False | The timestamp of when thumbnail was generated. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: