CreateStorageConfigurationCommand

Suggest an Edit

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IVSRealTimeClient, CreateStorageConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, CreateStorageConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // CreateStorageConfigurationRequest
  name: "STRING_VALUE",
  s3: { // S3StorageConfiguration
    bucketName: "STRING_VALUE", // required
  },
  tags: { // Tags
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateStorageConfigurationCommand(input);
const response = await client.send(command);
// { // CreateStorageConfigurationResponse
//   storageConfiguration: { // StorageConfiguration
//     arn: "STRING_VALUE", // required
//     name: "STRING_VALUE",
//     s3: { // S3StorageConfiguration
//       bucketName: "STRING_VALUE", // required
//     },
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//   },
// };

CreateStorageConfigurationCommand Input

See CreateStorageConfigurationCommandInput for more details

Parameter
Type
Description
s3
Required
S3StorageConfiguration | undefined

A complex type that contains a storage configuration for where recorded video will be stored.

name
string | undefined

Storage configuration name. The value does not need to be unique.

tags
Record<string, string> | undefined

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies  in Tagging AWS Resources and Tag Editor 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.

CreateStorageConfigurationCommand Output

See CreateStorageConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
storageConfiguration
StorageConfiguration | undefined

The StorageConfiguration that was created.

Throws

Name
Fault
Details
AccessDeniedException
client
<p/>
ConflictException
client
<p/>
InternalServerException
server
<p/>
PendingVerification
client
<p/>
ResourceNotFoundException
client
<p/>
ServiceQuotaExceededException
client
<p/>
ValidationException
client
<p/>
IVSRealTimeServiceException
Base exception class for all service exceptions from IVSRealTime service.