[ aws . quicksight ]

create-inbound-connector

Description

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.

See also: AWS API Documentation

Synopsis

  create-inbound-connector
--aws-account-id <value>
--inbound-connector-id <value>
--name <value>
[--description <value>]
--inbound-connector-configuration <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--aws-account-id (string) [required]

The ID of the Amazon Web Services account that contains the Quick Sight account.

Constraints:

  • min: 12
  • max: 12
  • pattern: ^[0-9]{12}$

--inbound-connector-id (string) [required]

The ID for the inbound connector. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

For a QUICK_DESKTOP inbound connector, the ID must be ibc-desktop- followed by your Amazon Web Services 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.

Constraints:

  • min: 1
  • max: 512
  • pattern: [\w\-]+

--name (string) [required]

The name of the inbound connector.

Constraints:

  • min: 1
  • max: 128

--description (string)

The description of the inbound connector.

Constraints:

  • min: 1
  • max: 512
  • pattern: [A-Za-z0-9 _.,!?\-]*

--inbound-connector-configuration (structure) [required]

The configuration of the inbound connector.

InboundConnectorType -> (string) [required]

The type of the inbound connector. You can’t change the type after the connector is created.

Possible values:

  • QUICK_DESKTOP

Shorthand Syntax:

InboundConnectorType=string

JSON Syntax:

{
  "InboundConnectorType": "QUICK_DESKTOP"
}

--tags (list)

The tags to assign to the inbound connector.

Constraints:

  • min: 1
  • max: 200

(structure)

The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

Key -> (string) [required]

Tag key.

Constraints:

  • min: 1
  • max: 128

Value -> (string) [required]

Tag value.

Constraints:

  • min: 1
  • max: 256

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

InboundConnectorId -> (string)

The ID of the inbound connector.

Arn -> (string)

The ARN of the inbound connector.

TenantUrl -> (string)

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

InboundConnectorStatus -> (string)

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

Possible values:

  • ENABLED
  • DISABLED

CreatedTime -> (timestamp)

The time when the inbound connector was created.