View a markdown version of this page

CreateInboundConnector - AWS Quick

CreateInboundConnector

Creates an inbound connector in a Quick Sight account. An inbound connector is the endpoint that an external client, such as the Quick Sight desktop application, uses to reach Quick Sight in your account.

Your users authenticate through the access control applications that are associated with the connector. To manage these associations, use UpdateInboundConnectorApplicationAssociations.

An account can have one QUICK_DESKTOP inbound connector in each Region.

Request Syntax

POST /accounts/AwsAccountId/inbound-connectors HTTP/1.1 Content-type: application/json { "Description": "string", "InboundConnectorConfiguration": { "InboundConnectorType": "string" }, "InboundConnectorId": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "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

Request Body

The request accepts the following data in JSON format.

InboundConnectorConfiguration

The configuration of the inbound connector.

Type: InboundConnectorConfig object

Required: Yes

InboundConnectorId

The ID for the inbound connector. This ID is unique per AWS Region for each AWS account.

For a QUICK_DESKTOP inbound connector, the ID must be ibc-desktop- followed by your AWS account ID and the Region that you call, separated by a hyphen. For example, ibc-desktop-111122223333-us-east-1. Quick Sight reserves IDs that start with ibc-desktop- for QUICK_DESKTOP inbound connectors.

Type: String

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

Pattern: [\w\-]+

Required: Yes

Name

The name of the inbound connector.

Type: String

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

Required: Yes

Description

The description of the inbound connector.

Type: String

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

Pattern: [A-Za-z0-9 _.,!?\-]*

Required: No

Tags

The tags to assign to the inbound connector.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "CreatedTime": number, "InboundConnectorId": "string", "InboundConnectorStatus": "string", "RequestId": "string", "TenantUrl": "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

CreatedTime

The time when the inbound connector was created.

Type: Timestamp

InboundConnectorId

The ID of the inbound connector.

Type: String

InboundConnectorStatus

The status of the inbound connector. A new connector is always ENABLED.

Type: String

Valid Values: ENABLED | DISABLED

RequestId

The AWS request ID for this operation.

Type: String

TenantUrl

The endpoint URL that clients use to reach Quick Sight through the inbound connector.

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

LimitExceededException

A limit is exceeded.

RequestId

The AWS request ID for this request.

ResourceType

Limit exceeded.

HTTP Status Code: 409

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: