UpdateVoiceConnectorGroup - Amazon Chime SDK


Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

Request Syntax

PUT /voice-connector-groups/voiceConnectorGroupId HTTP/1.1 Content-type: application/json { "Name": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.


The Amazon Chime Voice Connector group ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.


The name of the Amazon Chime Voice Connector group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes


The VoiceConnectorItems to associate with the group.

Type: Array of VoiceConnectorItem objects

Required: Yes

Response Syntax

HTTP/1.1 202 Content-type: application/json { "VoiceConnectorGroup": { "CreatedTimestamp": number, "Name": "string", "UpdatedTimestamp": number, "VoiceConnectorGroupArn": "string", "VoiceConnectorGroupId": "string", "VoiceConnectorItems": [ { "Priority": number, "VoiceConnectorId": "string" } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.


The updated Amazon Chime Voice Connector group details.

Type: VoiceConnectorGroup object


For information about the errors that are common to all actions, see Common Errors.


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409


The client is permanently forbidden from making the request.

HTTP Status Code: 403


One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


The client is not currently authorized to make the request.

HTTP Status Code: 401


In the following example or examples, the Authorization header contents( AUTHPARAMS ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.


This example updates the name of the specified Amazon Chime Voice Connector group.

Sample Request

PUT /voice-connector-groups/123a456b-c7d8-90e1-fg23-4h567jkl8901 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191028T190056Z Authorization: AUTHPARAMS Content-Length: 112 {"Name": "newGroupName", "VoiceConnectorItems": [{"VoiceConnectorId": "abcdef1ghij2klmno3pqr4", "Priority": 1}]}

Sample Response

HTTP/1.1 202 Accepted x-amzn-RequestId: a19ab97e-a397-4e33-b23f-6df54a2089f6 Content-Type: application/json Content-Length: 307 Date: Mon, 28 Oct 2019 19:00:57 GMT Connection: keep-alive {"VoiceConnectorGroup":{"CreatedTimestamp":"2019-09-18T16:38:34.734Z","Name":"newGroupName","UpdatedTimestamp":"2019-10-28T19:00:57.081Z","VoiceConnectorGroupId":"123a456b-c7d8-90e1-fg23-4h567jkl8901","VoiceConnectorItems":[{"Priority":1,"Voice Connector":null,"VoiceConnectorId":"abcdef1ghij2klmno3pqr4"}]}}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: