UpdatePhoneNumberMetadataCommand

Suggest an Edit

Updates a phone number’s metadata.

To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber  API.

Example Syntax

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

import { ConnectClient, UpdatePhoneNumberMetadataCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdatePhoneNumberMetadataCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdatePhoneNumberMetadataRequest
  PhoneNumberId: "STRING_VALUE", // required
  PhoneNumberDescription: "STRING_VALUE",
  ClientToken: "STRING_VALUE",
};
const command = new UpdatePhoneNumberMetadataCommand(input);
const response = await client.send(command);
// {};

UpdatePhoneNumberMetadataCommand Input

See UpdatePhoneNumberMetadataCommandInput for more details

Parameter
Type
Description
PhoneNumberId
Required
string | undefined

The Amazon Resource Name (ARN) or resource ID of the phone number.

ClientToken
string | undefined

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .

PhoneNumberDescription
string | undefined

The description of the phone number.

UpdatePhoneNumberMetadataCommand Output

See UpdatePhoneNumberMetadataCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action.

IdempotencyException
client

An entity with the same 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.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.