---
title: "POST /GetIngestConfiguration"
method: POST
path: "/GetIngestConfiguration"
---

# POST /GetIngestConfiguration

`POST /GetIngestConfiguration`

Gets information about the specified IngestConfiguration.

## Request body

- object
  - `arn` string, required — ARN of the ingest for which the information is to be retrieved.

## Response `200`

Success

- GetIngestConfigurationResponse
  - `ingestConfiguration` object — The IngestConfiguration that was returned.
    - `name` string — Ingest name
    - `arn` string, required — Ingest configuration ARN.
    - `ingestProtocol` 'RTMP' | 'RTMPS', required — Type of ingest protocol that the user employs for broadcasting.
    - `streamKey` string, password, required — Ingest-key value for the RTMP(S) protocol.
    - `stageArn` string, required — ARN of the stage with which the IngestConfiguration is associated.
    - `participantId` string, required — ID of the participant within the stage.
    - `state` 'ACTIVE' | 'INACTIVE', required — State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is publishing to the stage associated with the ingest configuration.
    - `userId` string — Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
    - `redundantIngest` boolean — Indicates whether redundant ingest is enabled for the ingest configuration.
    - `redundantIngestCredentials` RedundantIngestCredential[] — A list of redundant ingest credentials, present only when <code>redundantIngest</code> is set to <code>true</code>. See <a href="https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-rtmp-publishing.html#redundant-ingest">Redundant Ingest</a> in <i>IVS RTMP Publishing</i> for details.
      - `participantId` string — ID of the participant within the stage.
      - `streamKey` string, password — Ingest-key value.
    - `attributes` object — Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
    - `tags` object — Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

## Other responses

- `480` — ResourceNotFoundException
- `481` — ValidationException
- `482` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/ivs-realtime.md) · [All operations](https://skmtc.net/aws/apis/ivs-realtime/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/ivs-realtime/versions/f8857274a50f/schema)