URI
/prod/batch/start
HTTP methods
POST
Operation ID: BatchStart
| Status code | Response model | Description |
|---|---|---|
200 | BatchStartResultModel | 200 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
404 | ResourceNotFound | 404 response |
409 | ResourceConflict | 409 response |
429 | LimitExceeded | 429 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
Schemas
Request bodies
{
"channelIds": [
"string"
],
"multiplexIds": [
"string"
]
}Response bodies
{
"failed": [
{
"arn": "string",
"code": "string",
"id": "string",
"message": "string"
}
],
"successful": [
{
"arn": "string",
"id": "string",
"state": "string"
}
]
}{
"message": "string"
}{
"message": "string"
}{
"message": "string"
}{
"message": "string"
}{
"message": "string"
}{
"message": "string"
}{
"message": "string"
}{
"message": "string"
}Properties
AccessDenied
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
BadGatewayException
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
BatchFailedResultModel
Details from a failed operation
| Property | Type | Required | Description |
|---|---|---|---|
arn | string | False | ARN of the resource |
code | string | False | Error code for the failed operation |
id | string | False | ID of the resource |
message | string | False | Error message for the failed operation |
BatchStart
Batch start resource request
| Property | Type | Required | Description |
|---|---|---|---|
channelIds | Array of type string | False | List of channel IDs |
multiplexIds | Array of type string | False | List of multiplex IDs |
BatchStartResultModel
Batch start resource results
| Property | Type | Required | Description |
|---|---|---|---|
failed | Array of type BatchFailedResultModel | False | List of failed operations |
successful | Array of type BatchSuccessfulResultModel | False | List of successful operations |
BatchSuccessfulResultModel
Details from a successful operation
| Property | Type | Required | Description |
|---|---|---|---|
arn | string | False | ARN of the resource |
id | string | False | ID of the resource |
state | string | False | Current state of the resource |
GatewayTimeoutException
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
InternalServiceError
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
InvalidRequest
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
LimitExceeded
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ResourceConflict
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ResourceNotFound
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
BatchStart
