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

GetIngestConfiguration

Gets information about the specified IngestConfiguration.

Request Syntax


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

{
   "arn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

ARN of the ingest for which the information is to be retrieved.

Type: String

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

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ingestConfiguration": { 
      "arn": "string",
      "attributes": { 
         "string" : "string" 
      },
      "ingestProtocol": "string",
      "name": "string",
      "participantId": "string",
      "stageArn": "string",
      "state": "string",
      "streamKey": "string",
      "tags": { 
         "string" : "string" 
      },
      "userId": "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.

ingestConfiguration

The IngestConfiguration that was returned.

Type: IngestConfiguration object

Errors

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

AccessDeniedException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: User does not have sufficient access to perform this action.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 403

ResourceNotFoundException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: Request references a resource which does not exist.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 404

ValidationException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: The input fails to satisfy the constraints specified by an AWS service.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 400