AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qbusiness ]

get-application

Description

Gets information about an existing Amazon Q Business application.

See also: AWS API Documentation

Synopsis

  get-application
--application-id <value>
[--cli-input-json <value>]
[--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>]

Options

--application-id (string)

The identifier of the Amazon Q Business application.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

Output

displayName -> (string)

The name of the Amazon Q Business application.

applicationId -> (string)

The identifier of the Amazon Q Business application.

applicationArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Q Business application.

identityType -> (string)

The authentication type being used by a Amazon Q Business application.

iamIdentityProviderArn -> (string)

The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.

identityCenterApplicationArn -> (string)

The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

status -> (string)

The status of the Amazon Q Business application.

description -> (string)

A description for the Amazon Q Business application.

encryptionConfiguration -> (structure)

The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

kmsKeyId -> (string)

The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.

createdAt -> (timestamp)

The Unix timestamp when the Amazon Q Business application was last updated.

updatedAt -> (timestamp)

The Unix timestamp when the Amazon Q Business application was last updated.

error -> (structure)

If the Status field is set to ERROR , the ErrorMessage field contains a description of the error that caused the synchronization to fail.

errorMessage -> (string)

The message explaining the data source sync error.

errorCode -> (string)

The code associated with the data source sync error.

attachmentsConfiguration -> (structure)

Settings for whether end users can upload files directly during chat.

attachmentsControlMode -> (string)

Information about whether file upload during chat functionality is activated for your application.

qAppsConfiguration -> (structure)

Settings for whether end users can create and use Amazon Q Apps in the web experience.

qAppsControlMode -> (string)

Status information about whether end users can create and use Amazon Q Apps in the web experience.

personalizationConfiguration -> (structure)

Configuration information about chat response personalization. For more information, see Personalizing chat responses .

personalizationControlMode -> (string)

An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.

autoSubscriptionConfiguration -> (structure)

Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.

autoSubscribe -> (string)

Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.

defaultSubscriptionType -> (string)

Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.

clientIdsForOIDC -> (list)

The OIDC client ID for a Amazon Q Business application.

(string)