<a id="cli-aws-quicksight-list-access-control-applications"></a>

# list-access-control-applications

## Description

Lists the access control applications in a Quick Sight account in the current Amazon Web Services Region. You can filter the results by namespace. Quick Sight paginates the results. To retrieve additional results, use the `NextToken` parameter.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAccessControlApplications)

`list-access-control-applications` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument.
When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `AccessControlApplications`

## Synopsis

```
  list-access-control-applications
--aws-account-id <value>
[--namespace <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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}$`

`--namespace` (string)

> The namespace to filter by. If you don’t specify a namespace, access control applications in all namespaces are returned.

> Constraints:

> * max: `64`
> * pattern: `^[a-zA-Z0-9._-]*$`

`--starting-token` (string)

> A token to specify where to start paginating. This is the `NextToken` from a previously truncated response.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

`--page-size` (integer)

> The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

> Constraints:

> * min: `1`
> * max: `100`

`--max-items` (integer)

> The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a `NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

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

AccessControlApplications -> (list)

> A list of access control application summaries.

> (structure)

> > A summary of an access control application, including its ID, ARN, name, namespace, authentication type, status, and timestamps.

> > ApplicationId -> (string) [required]

> > > The ID of the access control application.

> > > Constraints:

> > > * min: `1`
> > > * max: `512`
> > > * pattern: `[\w\-]+`

> > Arn -> (string) [required]

> > > The ARN of the access control application.

> > Name -> (string) [required]

> > > The name of the access control application.

> > > Constraints:

> > > * min: `1`
> > > * max: `128`

> > Namespace -> (string) [required]

> > > The Quick Sight namespace that the access control application belongs to.

> > AuthenticationType -> (string) [required]

> > > The authentication protocol that the access control application uses.

> > > Possible values:

> > > * `OIDC`

> > Status -> (string) [required]

> > > The status of the access control application.

> > > Possible values:

> > > * `ENABLED`
> > > * `DISABLED`

> > CreatedTime -> (timestamp) [required]

> > > The time when the access control application was created.

> > LastUpdatedTime -> (timestamp) [required]

> > > The time when the access control application was last updated.

> > TenantUrl -> (string) [required]

> > > The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as `/authorize` , `/token` , `/.well-known/openid-configuration` , and `/jwks` .

> > IdpAuthorizingConfiguration -> (structure)

> > > A summary of the identity provider configuration of the access control application, without client secret information.

> > > IdpAuthorizingType -> (string) [required]

> > > > How users of the access control application are authenticated.

> > > > Possible values:

> > > > * `EXTERNAL_IDP_PUBLIC_AUTH_CODE`
> > > > * `EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE`
> > > > * `QUICK_MANAGED_AUTH_CODE`
> > > > * `IDC_AUTH_CODE`

> > > IdpAuthorizingConfigurationSummaryDetail -> (tagged union structure)

> > > > The details of the external IdP configuration. This is present when the `IdpAuthorizingType` is `EXTERNAL_IDP_PUBLIC_AUTH_CODE` or `EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE` .

> > > > #### NOTE
> > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `ExternalIdpPublicAuthCode`, `ExternalIdpConfidentialAuthCode`.

> > > > ExternalIdpPublicAuthCode -> (structure)

> > > > > The configuration for an external IdP with a public client.

> > > > > ClientId -> (string) [required]

> > > > > > The OAuth 2.0 client ID.

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `256`

> > > > > IssuerUrl -> (string) [required]

> > > > > > The issuer URL of the external OpenID Connect IdP.

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `2048`
> > > > > > * pattern: `https?://[-a-zA-Z0-9+&@/%=~_|!:,.;]*[-a-zA-Z0-9+&@/%=~_|]`

> > > > ExternalIdpConfidentialAuthCode -> (structure)

> > > > > The configuration for an external IdP with a confidential client.

> > > > > ClientId -> (string) [required]

> > > > > > The OAuth 2.0 client ID.

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `256`

> > > > > IssuerUrl -> (string) [required]

> > > > > > The issuer URL of the external OpenID Connect IdP.

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `2048`
> > > > > > * pattern: `https?://[-a-zA-Z0-9+&@/%=~_|!:,.;]*[-a-zA-Z0-9+&@/%=~_|]`

> > > IdcTrustedTokenIssuerConfiguration -> (structure)

> > > > A trusted token issuer configuration. When you provide it, Quick Sight authenticates the user with the external IdP and then exchanges the token with IAM Identity Center through the specified trusted token issuer. You can’t change it after the application is created.

> > > > IdcTrustedTokenIssuerArn -> (string) [required]

> > > > > The ARN of the trusted token issuer in IAM Identity Center.

> > > > > Constraints:

> > > > > * min: `20`
> > > > > * max: `1284`
> > > > > * pattern: `arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:trustedTokenIssuer/(sso)?ins-[a-zA-Z0-9-.]{16}/tti-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`

> > QuickAuthenticationConfiguration -> (structure)

> > > The Quick Sight authentication configuration of the access control application. Client secret values are never included.

> > > QuickAuthenticationType -> (string) [required]

> > > > How the external client authenticates to Quick Sight.

> > > > Possible values:

> > > > * `QUICK_MANAGED_PUBLIC_AUTH_CODE`

> > > QuickAuthenticationConfigurationDetail -> (tagged union structure)

> > > > The details of the Quick Sight authentication configuration.

> > > > #### NOTE
> > > > This is a Tagged Union structure. Only one of the following top level keys can be set: `QuickManagedPublicAuthCode`.

> > > > QuickManagedPublicAuthCode -> (structure)

> > > > > The configuration of a Quick Sight-managed public client.

> > > > > RedirectUris -> (list) [required]

> > > > > > The OAuth 2.0 redirect URIs of the client.

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `10`

> > > > > > (string)

> > > > > > > An HTTP or HTTPS URI.

> > > > > > > Constraints:

> > > > > > > * min: `1`
> > > > > > > * max: `2048`
> > > > > > > * pattern: `https?://[-a-zA-Z0-9+&@/%=~_|!:,.;]*[-a-zA-Z0-9+&@/%=~_|]`

> > > > > ClientId -> (string) [required]

> > > > > > The OAuth 2.0 client ID.

> > > > > > Constraints:

> > > > > > * min: `1`
> > > > > > * max: `256`

> > Description -> (string)

> > > The description of the access control application.

> > > Constraints:

> > > * min: `1`
> > > * max: `256`
> > > * pattern: `[A-Za-z0-9 _.,!?\-]*`

NextToken -> (string)

> The token for the next set of results, or null if there are no more results.
