UpdateVPCConnection
Updates a VPC connection.
Request Syntax
PUT /accounts/AwsAccountId
/vpc-connections/VPCConnectionId
HTTP/1.1
Content-type: application/json
{
"DnsResolvers": [ "string
" ],
"Name": "string
",
"RoleArn": "string
",
"SecurityGroupIds": [ "string
" ],
"SubnetIds": [ "string
" ]
}
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The AWS account ID of the account that contains the VPC connection that you want to update.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$
Required: Yes
- VPCConnectionId
-
The ID of the VPC connection that you're updating. This ID is a unique identifier for each AWS Region in an AWS account.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Name
-
The display name for the VPC connection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- RoleArn
-
An IAM role associated with the VPC connection.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
- SecurityGroupIds
-
A list of security group IDs for the VPC connection.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 16 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^sg-[0-9a-z]*$
Required: Yes
- SubnetIds
-
A list of subnet IDs for the VPC connection.
Type: Array of strings
Array Members: Minimum number of 2 items. Maximum number of 15 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^subnet-[0-9a-z]*$
Required: Yes
- DnsResolvers
-
A list of IP addresses of DNS resolver endpoints for the VPC connection.
Type: Array of strings
Array Members: Maximum number of 15 items.
Length Constraints: Minimum length of 7. Maximum length of 15.
Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"AvailabilityStatus": "string",
"RequestId": "string",
"UpdateStatus": "string",
"VPCConnectionId": "string"
}
Response Elements
If the action is successful, the service sends back the following HTTP response.
- Status
-
The HTTP status of the request.
The following data is returned in JSON format by the service.
- Arn
-
The Amazon Resource Name (ARN) of the VPC connection.
Type: String
- AvailabilityStatus
-
The availability status of the VPC connection.
Type: String
Valid Values:
AVAILABLE | UNAVAILABLE | PARTIALLY_AVAILABLE
- RequestId
-
The AWS request ID for this operation.
Type: String
- UpdateStatus
-
The update status of the VPC connection's last update.
Type: String
Valid Values:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETION_IN_PROGRESS | DELETION_FAILED | DELETED
- VPCConnectionId
-
The ID of the VPC connection that you are updating. This ID is a unique identifier for each AWS Region in anAWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
HTTP Status Code: 429
- UnsupportedUserEditionException
-
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
HTTP Status Code: 403
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: