The CreateRecordingConfiguration API from Amazon Interactive Video Service — 1 operation(s) for createrecordingconfiguration.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-interactive-video-service-createrecordingconfiguration-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: '2020-07-14'
x-release: v4
title: Amazon Interactive Video Service Create Recording…
description: 'Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses.'
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: ivs
x-aws-signingName: ivs
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ivs-2020-07-14.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://ivs.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon IVS multi-region endpoint
- url: https://ivs.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon IVS multi-region endpoint
- url: http://ivs.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon IVS endpoint for China (Beijing) and China (Ningxia)
- url: https://ivs.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon IVS endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: CreateRecordingConfiguration
paths:
/CreateRecordingConfiguration:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateRecordingConfiguration
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRecordingConfigurationResponse'
'480':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: PendingVerification
content:
application/json:
schema:
$ref: '#/components/schemas/PendingVerification'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- destinationConfiguration
properties:
destinationConfiguration:
description: 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.
type: object
properties:
s3:
allOf:
- $ref: '#/components/schemas/S3DestinationConfiguration'
- description: An S3 destination configuration where recorded videos will be stored.
name:
description: Recording-configuration name. The value does not need to be unique.
type: string
pattern: ^[a-zA-Z0-9-_]*$
minLength: 0
maxLength: 128
recordingReconnectWindowSeconds:
description: '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.'
type: integer
minimum: 0
maximum: 300
renditionConfiguration:
description: Object that describes which renditions should be recorded for a stream.
type: object
properties:
renditionSelection:
allOf:
- $ref: '#/components/schemas/RenditionConfigurationRenditionSelection'
- description: 'Indicates which set of renditions are recorded for a stream. For <code>BASIC</code> channels, the <code>CUSTOM</code> value has no effect. If <code>CUSTOM</code> is specified, a set of renditions must be specified in the <code>renditions</code> field. Default: <code>ALL</code>.'
renditions:
allOf:
- $ref: '#/components/schemas/RenditionConfigurationRenditionList'
- description: Indicates which renditions are recorded for a stream, if <code>renditionSelection</code> is <code>CUSTOM</code>; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>.
tags:
description: 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.
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
thumbnailConfiguration:
description: An object representing a configuration of thumbnails for recorded video.
type: object
properties:
recordingMode:
allOf:
- $ref: '#/components/schemas/RecordingMode'
- description: 'Thumbnail recording mode. Default: <code>INTERVAL</code>.'
resolution:
allOf:
- $ref: '#/components/schemas/ThumbnailConfigurationResolution'
- description: 'Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>. Default: Null (source resolution is returned).'
storage:
allOf:
- $ref: '#/components/schemas/ThumbnailConfigurationStorageList'
- description: 'Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails in a serial manner, to the media/thumbnails directory. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.'
targetIntervalSeconds:
allOf:
- $ref: '#/components/schemas/TargetIntervalSeconds'
- description: '<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> For the <code>BASIC</code> channel type, 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>'
summary: Amazon Interactive Video Service Create Recording Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- CreateRecordingConfiguration
components:
schemas:
RecordingMode:
type: string
enum:
- DISABLED
- INTERVAL
RecordingConfigurationArn:
type: string
pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$
minLength: 0
maxLength: 128
S3DestinationConfiguration:
type: object
required:
- bucketName
properties:
bucketName:
allOf:
- $ref: '#/components/schemas/S3DestinationBucketName'
- description: Location (S3 bucket name) where recorded videos will be stored.
description: A complex type that describes an S3 location where recorded videos will be stored.
RecordingConfigurationName:
type: string
pattern: ^[a-zA-Z0-9-_]*$
minLength: 0
maxLength: 128
ConflictException: {}
AccessDeniedException: {}
ServiceQuotaExceededException: {}
RecordingReconnectWindowSeconds:
type: integer
minimum: 0
maximum: 300
CreateRecordingConfigurationResponse:
type: object
properties:
recordingConfiguration:
allOf:
- $ref: '#/components/schemas/RecordingConfiguration'
- description: <zonbook></zonbook><xhtml></xhtml>
TargetIntervalSeconds:
type: integer
minimum: 1
maximum: 60
ValidationException: {}
ThumbnailConfigurationResolution:
type: string
enum:
- FULL_HD
- HD
- SD
- LOWEST_RESOLUTION
PendingVerification: {}
RenditionConfigurationRendition:
type: string
enum:
- FULL_HD
- HD
- SD
- LOWEST_RESOLUTION
RenditionConfiguration:
type: object
properties:
renditionSelection:
allOf:
- $ref: '#/components/schemas/RenditionConfigurationRenditionSelection'
- description: 'Indicates which set of renditions are recorded for a stream. For <code>BASIC</code> channels, the <code>CUSTOM</code> value has no effect. If <code>CUSTOM</code> is specified, a set of renditions must be specified in the <code>renditions</code> field. Default: <code>ALL</code>.'
renditions:
allOf:
- $ref: '#/components/schemas/RenditionConfigurationRenditionList'
- description: Indicates which renditions are recorded for a stream, if <code>renditionSelection</code> is <code>CUSTOM</code>; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>.
description: Object that describes which renditions should be recorded for a stream.
RecordingConfiguration:
type: object
required:
- arn
- destinationConfiguration
- state
properties:
arn:
allOf:
- $ref: '#/components/schemas/RecordingConfigurationArn'
- description: Recording-configuration ARN.
destinationConfiguration:
allOf:
- $ref: '#/components/schemas/DestinationConfiguration'
- description: A complex type that contains information about where recorded video will be stored.
name:
allOf:
- $ref: '#/components/schemas/RecordingConfigurationName'
- description: Recording-configuration name. The value does not need to be unique.
recordingReconnectWindowSeconds:
allOf:
- $ref: '#/components/schemas/RecordingReconnectWindowSeconds'
- description: '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.'
renditionConfiguration:
allOf:
- $ref: '#/components/schemas/RenditionConfiguration'
- description: Object that describes which renditions should be recorded for a stream.
state:
allOf:
- $ref: '#/components/schemas/RecordingConfigurationState'
- description: 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:
allOf:
- $ref: '#/components/schemas/Tags'
- description: 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:
allOf:
- $ref: '#/components/schemas/ThumbnailConfiguration'
- description: 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.
description: An object representing a configuration to record a channel stream.
ThumbnailConfiguration:
type: object
properties:
recordingMode:
allOf:
- $ref: '#/components/schemas/RecordingMode'
- description: 'Thumbnail recording mode. Default: <code>INTERVAL</code>.'
resolution:
allOf:
- $ref: '#/components/schemas/ThumbnailConfigurationResolution'
- description: 'Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>. Default: Null (source resolution is returned).'
storage:
allOf:
- $ref: '#/components/schemas/ThumbnailConfigurationStorageList'
- description: 'Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails in a serial manner, to the media/thumbnails directory. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.'
targetIntervalSeconds:
allOf:
- $ref: '#/components/schemas/TargetIntervalSeconds'
- description: '<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> For the <code>BASIC</code> channel type, 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>'
description: An object representing a configuration of thumbnails for recorded video.
DestinationConfiguration:
type: object
properties:
s3:
allOf:
- $ref: '#/components/schemas/S3DestinationConfiguration'
- description: An S3 destination configuration where recorded videos will be stored.
description: 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.
InternalServerException: {}
RenditionConfigurationRenditionSelection:
type: string
enum:
- ALL
- NONE
- CUSTOM
TagValue:
type: string
minLength: 0
maxLength: 256
S3DestinationBucketName:
type: string
pattern: ^[a-z0-9-.]+$
minLength: 3
maxLength: 63
ThumbnailConfigurationStorageList:
type: array
items:
$ref: '#/components/schemas/ThumbnailConfigurationStorage'
ThumbnailConfigurationStorage:
type: string
enum:
- SEQUENTIAL
- LATEST
RecordingConfigurationState:
type: string
enum:
- CREATING
- CREATE_FAILED
- ACTIVE
RenditionConfigurationRenditionList:
type: array
items:
$ref: '#/components/schemas/RenditionConfigurationRendition'
Tags:
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/ivs/
x-hasEquivalentPaths: true