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

BatchGetStreamKey

Performs GetStreamKey on multiple ARNs simultaneously.

Request Syntax


POST /BatchGetStreamKey HTTP/1.1
Content-type: application/json

{
   "arns": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arns

Array of ARNs, one per stream key.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

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

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "arn": "string",
         "code": "string",
         "message": "string"
      }
   ],
   "streamKeys": [ 
      { 
         "arn": "string",
         "channelArn": "string",
         "tags": { 
            "string" : "string" 
         },
         "value": "string"
      }
   ]
}

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.

errors

Type: Array of BatchError objects

streamKeys

Type: Array of StreamKey objects

Errors

For information about the errors that are common to all actions, see Common Errors.