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

# POST /CreateRecordingConfiguration

`POST /CreateRecordingConfiguration`

Creates a new recording configuration, used to enable recording to Amazon S3.

**Known issue:** In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the `state` of the recording configuration is `CREATE_FAILED` (instead of `ACTIVE`). (In other regions, the CLI correctly returns failure if the bucket is in a different region.)

**Workaround:** Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.

## Request body

- object
  - `destinationConfiguration` object, required — A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
    - `s3` object — An S3 destination configuration where recorded videos will be stored.
      - `bucketName` string, required — Location (S3 bucket name) where recorded videos will be stored.
  - `name` string — Recording-configuration name. The value does not need to be unique.
  - `recordingReconnectWindowSeconds` integer — If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
  - `tags` object — Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
  - `thumbnailConfiguration` object — An object representing a configuration of thumbnails for recorded video.
    - `recordingMode` 'DISABLED' | 'INTERVAL' — Thumbnail recording mode. Default: <code>INTERVAL</code>.
    - `targetIntervalSeconds` integer — <p>The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p> <p> <b>Important:</b> Setting a value for <code>targetIntervalSeconds</code> does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the <code>targetIntervalSeconds</code> interval, the <code>IDR/Keyframe</code> value for the input video must be less than the <code>targetIntervalSeconds</code> value. See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html"> Amazon IVS Streaming Configuration</a> for information on setting <code>IDR/Keyframe</code> to the recommended value in video-encoder settings.</p>

## Response `200`

Success

- CreateRecordingConfigurationResponse
  - `recordingConfiguration` object — <zonbook></zonbook><xhtml></xhtml>
    - `arn` string, required — Recording-configuration ARN.
    - `destinationConfiguration` object, required — A complex type that contains information about where recorded video will be stored.
      - `s3` object — An S3 destination configuration where recorded videos will be stored.
        - `bucketName` string, required — Location (S3 bucket name) where recorded videos will be stored.
    - `name` string — Recording-configuration name. The value does not need to be unique.
    - `recordingReconnectWindowSeconds` integer — If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.
    - `state` 'CREATING' | 'CREATE_FAILED' | 'ACTIVE', required — Indicates the current state of the recording configuration. When the state is <code>ACTIVE</code>, the configuration is ready for recording a channel stream.
    - `tags` object — Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - `thumbnailConfiguration` object — A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
      - `recordingMode` 'DISABLED' | 'INTERVAL' — Thumbnail recording mode. Default: <code>INTERVAL</code>.
      - `targetIntervalSeconds` integer — <p>The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p> <p> <b>Important:</b> Setting a value for <code>targetIntervalSeconds</code> does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the <code>targetIntervalSeconds</code> interval, the <code>IDR/Keyframe</code> value for the input video must be less than the <code>targetIntervalSeconds</code> value. See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html"> Amazon IVS Streaming Configuration</a> for information on setting <code>IDR/Keyframe</code> to the recommended value in video-encoder settings.</p>

## Other responses

- `480` — InternalServerException
- `481` — AccessDeniedException
- `482` — ValidationException
- `483` — PendingVerification
- `484` — ConflictException
- `485` — ServiceQuotaExceededException

---

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