Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeStream

Gets information about a stream.

Requires permission to access the DescribeStream action.

Request Syntax


GET /streams/streamId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

streamId

The stream ID.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "streamInfo": { 
      "createdAt": number,
      "description": "string",
      "files": [ 
         { 
            "fileId": number,
            "s3Location": { 
               "bucket": "string",
               "key": "string",
               "version": "string"
            }
         }
      ],
      "lastUpdatedAt": number,
      "roleArn": "string",
      "streamArn": "string",
      "streamId": "string",
      "streamVersion": 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.

streamInfo

Information about the stream.

Type: StreamInfo object

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401