[ aws . quicksight ]
Updates an access control application. You can change its name, description, status, IdP settings such as the client ID and issuer URL, and its Quick Sight authentication settings such as redirect URIs.
You can’t change the IdpAuthorizingType , the QuickAuthenticationType , or the trusted token issuer after the application is created. To manage client secrets, use CreateAccessControlApplicationSecret , UpdateAccessControlApplicationSecret , and DeleteAccessControlApplicationSecret .
See also: AWS API Documentation
update-access-control-application
--aws-account-id <value>
--application-id <value>
[--name <value>]
[--description <value>]
[--idp-authorizing-configuration <value>]
[--quick-authentication-configuration <value>]
[--status <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]
--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}$
--application-id (string) [required]
The ID of the access control application.
Constraints:
- min:
1- max:
512- pattern:
[\w\-]+
--name (string)
The new name of the access control application.
Constraints:
- min:
1- max:
128
--description (string)
The new description of the access control application.
Constraints:
- min:
1- max:
256- pattern:
[A-Za-z0-9 _.,!?\-]*
--idp-authorizing-configuration (structure)
The identity provider settings to update, such as the client ID and issuer URL. You can’t change the
IdpAuthorizingTypeor the trusted token issuer. To manage client secrets, use the client secret operations.IdpAuthorizingType -> (string) [required]
How users of the access control application are authenticated.
Possible values:
EXTERNAL_IDP_PUBLIC_AUTH_CODEEXTERNAL_IDP_CONFIDENTIAL_AUTH_CODEQUICK_MANAGED_AUTH_CODEIDC_AUTH_CODEIdpAuthorizingConfigurationDetailInput -> (tagged union structure)
The details of the external IdP configuration. This is present when the
IdpAuthorizingTypeisEXTERNAL_IDP_PUBLIC_AUTH_CODEorEXTERNAL_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:
256IssuerUrl -> (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:
256IssuerUrl -> (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}
Shorthand Syntax:
IdpAuthorizingType=string,IdpAuthorizingConfigurationDetailInput={ExternalIdpPublicAuthCode={ClientId=string,IssuerUrl=string},ExternalIdpConfidentialAuthCode={ClientId=string,IssuerUrl=string}},IdcTrustedTokenIssuerConfiguration={IdcTrustedTokenIssuerArn=string}
JSON Syntax:
{
"IdpAuthorizingType": "EXTERNAL_IDP_PUBLIC_AUTH_CODE"|"EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE"|"QUICK_MANAGED_AUTH_CODE"|"IDC_AUTH_CODE",
"IdpAuthorizingConfigurationDetailInput": {
"ExternalIdpPublicAuthCode": {
"ClientId": "string",
"IssuerUrl": "string"
},
"ExternalIdpConfidentialAuthCode": {
"ClientId": "string",
"IssuerUrl": "string"
}
},
"IdcTrustedTokenIssuerConfiguration": {
"IdcTrustedTokenIssuerArn": "string"
}
}
--quick-authentication-configuration (structure)
The Quick Sight authentication settings to update, such as redirect URIs. You can’t change the
QuickAuthenticationType.QuickAuthenticationType -> (string) [required]
How the external client authenticates to Quick Sight.
Possible values:
QUICK_MANAGED_PUBLIC_AUTH_CODEQuickAuthenticationConfigurationDetailInput -> (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+&@/%=~_|]
JSON Syntax:
{
"QuickAuthenticationType": "QUICK_MANAGED_PUBLIC_AUTH_CODE",
"QuickAuthenticationConfigurationDetailInput": {
"QuickManagedPublicAuthCode": {
"RedirectUris": ["string", ...]
}
}
}
--status (string)
The new status of the access control application.
Possible values:
ENABLEDDISABLED
--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.
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
Status -> (integer)
The HTTP status of the request.
RequestId -> (string)
The Amazon Web Services request ID for this operation.
ApplicationId -> (string)
The ID of the access control application.
Arn -> (string)
The ARN of the access control application.
AccessControlApplicationStatus -> (string)
The status of the access control application.
Possible values:
ENABLEDDISABLED
LastUpdatedTime -> (timestamp)
The time when the access control application was last updated.