ListIngestConfigurations
Lists all IngestConfigurations in your account, in the AWS region where the API request is processed.
Request Syntax
POST /ListIngestConfigurations HTTP/1.1
Content-type: application/json
{
"filterByStageArn": "string
",
"filterByState": "string
",
"maxResults": number
,
"nextToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- filterByStageArn
-
Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+
Required: No
- filterByState
-
Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.
Type: String
Valid Values:
ACTIVE | INACTIVE
Required: No
- maxResults
-
Maximum number of results to return. Default: 50.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
The first IngestConfiguration to retrieve. This is used for pagination; see the
nextToken
response field.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[a-zA-Z0-9+/=_-]*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ingestConfigurations": [
{
"arn": "string",
"ingestProtocol": "string",
"name": "string",
"participantId": "string",
"stageArn": "string",
"state": "string",
"userId": "string"
}
],
"nextToken": "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.
- ingestConfigurations
-
List of the matching ingest configurations (summary information only).
Type: Array of IngestConfigurationSummary objects
- nextToken
-
If there are more IngestConfigurations than
maxResults
, usenextToken
in the request to get the next set.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[a-zA-Z0-9+/=_-]*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: