- 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.
UpdateViewMetadataCommand
Updates the view metadata. Note that either Name
or Description
must be provided.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConnectClient, UpdateViewMetadataCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateViewMetadataCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateViewMetadataRequest
InstanceId: "STRING_VALUE", // required
ViewId: "STRING_VALUE", // required
Name: "STRING_VALUE",
Description: "STRING_VALUE",
};
const command = new UpdateViewMetadataCommand(input);
const response = await client.send(command);
// {};
UpdateViewMetadataCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
InstanceId Required | string | undefined | The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. |
ViewId Required | string | undefined | The identifier of the view. Both |
Description | string | undefined | The description of the view. |
Name | string | undefined | The name of the view. |
UpdateViewMetadataCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient permissions to perform this action. |
DuplicateResourceException | client | A resource with the specified name already exists. |
InternalServiceException | server | Request processing failed because of an error or failure with the service. |
InvalidParameterException | client | One or more of the specified parameters are not valid. |
InvalidRequestException | client | The request is not valid. |
ResourceInUseException | client | That resource is already in use. Please try another. |
ResourceNotFoundException | client | The specified resource was not found. |
TooManyRequestsException | client | Displayed when rate-related API limits are exceeded. |
ConnectServiceException | Base exception class for all service exceptions from Connect service. |