UpdateInboundConnector
Updates an inbound connector. You can change its name, description, status, and configuration. You can't change the connector type after the connector is created.
Request Syntax
PATCH /accounts/AwsAccountId/inbound-connectors/InboundConnectorId HTTP/1.1
Content-type: application/json
{
"Description": "string",
"InboundConnectorConfiguration": {
"InboundConnectorType": "string"
},
"InboundConnectorStatus": "string",
"Name": "string"
}
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account that contains the Quick Sight account.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
- InboundConnectorId
-
The ID of the inbound connector.
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- Description
-
The new description of the inbound connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[A-Za-z0-9 _.,!?\-]*Required: No
- InboundConnectorConfiguration
-
The new configuration of the inbound connector. You can't change the
InboundConnectorType.Type: InboundConnectorConfig object
Required: No
- InboundConnectorStatus
-
The new status of the inbound connector.
Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
- Name
-
The new name of the inbound connector.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"InboundConnectorId": "string",
"InboundConnectorStatus": "string",
"LastUpdatedTime": number,
"RequestId": "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 ARN of the inbound connector.
Type: String
- InboundConnectorId
-
The ID of the inbound connector.
Type: String
- InboundConnectorStatus
-
The status of the inbound connector.
Type: String
Valid Values:
ENABLED | DISABLED - LastUpdatedTime
-
The time when the inbound connector was last updated.
Type: Timestamp
- RequestId
-
The AWS request ID for this operation.
Type: String
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 400
- ResourceNotFoundException
-
One or more resources can't be found.
- RequestId
-
The AWS request ID for this request.
- ResourceType
-
The resource type for this request.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: