UpdateApplicationWithTokenExchangeGrantCommand

Suggest an Edit

Updates an Amazon QuickSight application with a token exchange grant. This operation only supports Amazon QuickSight applications that are registered with IAM Identity Center.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QuickSightClient, UpdateApplicationWithTokenExchangeGrantCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, UpdateApplicationWithTokenExchangeGrantCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // UpdateApplicationWithTokenExchangeGrantRequest
  AwsAccountId: "STRING_VALUE", // required
  Namespace: "STRING_VALUE", // required
};
const command = new UpdateApplicationWithTokenExchangeGrantCommand(input);
const response = await client.send(command);
// { // UpdateApplicationWithTokenExchangeGrantResponse
//   Status: Number("int"),
//   RequestId: "STRING_VALUE",
// };

UpdateApplicationWithTokenExchangeGrantCommand Input

See UpdateApplicationWithTokenExchangeGrantCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The ID of the Amazon Web Services account to be updated with a token exchange grant.

Namespace
Required
string | undefined

The namespace of the Amazon QuickSight application.

UpdateApplicationWithTokenExchangeGrantCommand Output

See UpdateApplicationWithTokenExchangeGrantCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
RequestId
string | undefined

The Amazon Web Services request ID for this operation.

Status
number | undefined

The HTTP status of the request.

Throws

Name
Fault
Details
AccessDeniedException
client

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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

InternalFailureException
server

An internal failure occurred.

InvalidParameterValueException
client

One or more parameters has a value that isn't valid.

InvalidRequestException
client

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

LimitExceededException
client

A limit is exceeded.

ResourceNotFoundException
client

One or more resources can't be found.

ThrottlingException
client

Access is throttled.

QuickSightServiceException
Base exception class for all service exceptions from QuickSight service.