- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetStorageConfigurationCommand
Gets the storage configuration for the specified ARN.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IVSRealTimeClient, GetStorageConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, GetStorageConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // GetStorageConfigurationRequest
arn: "STRING_VALUE", // required
};
const command = new GetStorageConfigurationCommand(input);
const response = await client.send(command);
// { // GetStorageConfigurationResponse
// storageConfiguration: { // StorageConfiguration
// arn: "STRING_VALUE", // required
// name: "STRING_VALUE",
// s3: { // S3StorageConfiguration
// bucketName: "STRING_VALUE", // required
// },
// tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// },
// };
GetStorageConfigurationCommand Input
See GetStorageConfigurationCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
arnRequired | string | undefined | ARN of the storage configuration to be retrieved. |
GetStorageConfigurationCommand Output
See GetStorageConfigurationCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
storageConfiguration | StorageConfiguration | undefined | The StorageConfiguration that was returned. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | <p/> |
| ConflictException | client | <p/> |
| InternalServerException | server | <p/> |
| ResourceNotFoundException | client | <p/> |
| ServiceQuotaExceededException | client | <p/> |
| ValidationException | client | <p/> |
| IVSRealTimeServiceException | Base exception class for all service exceptions from IVSRealTime service. |