- 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.
UpdateRoutingProfileNameCommand
Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least 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, UpdateRoutingProfileNameCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateRoutingProfileNameCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateRoutingProfileNameRequest
InstanceId: "STRING_VALUE", // required
RoutingProfileId: "STRING_VALUE", // required
Name: "STRING_VALUE",
Description: "STRING_VALUE",
};
const command = new UpdateRoutingProfileNameCommand(input);
const response = await client.send(command);
// {};
UpdateRoutingProfileNameCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
InstanceIdRequired | string | undefined | The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
RoutingProfileIdRequired | string | undefined | The identifier of the routing profile. |
Description | string | undefined | The description of the routing profile. Must not be more than 250 characters. |
Name | string | undefined | The name of the routing profile. Must not be more than 127 characters. |
UpdateRoutingProfileNameCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| 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. |
| ResourceNotFoundException | client | The specified resource was not found. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ConnectServiceException | Base exception class for all service exceptions from Connect service. |