- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateIdentityPropagationConfigCommand
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, UpdateIdentityPropagationConfigCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, UpdateIdentityPropagationConfigCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // UpdateIdentityPropagationConfigRequest
AwsAccountId: "STRING_VALUE", // required
Service: "REDSHIFT" || "QBUSINESS", // required
AuthorizedTargets: [ // AuthorizedTargetsList
"STRING_VALUE",
],
};
const command = new UpdateIdentityPropagationConfigCommand(input);
const response = await client.send(command);
// { // UpdateIdentityPropagationConfigResponse
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
UpdateIdentityPropagationConfigCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
AwsAccountIdRequired | string | undefined | The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update. |
ServiceRequired | ServiceType | undefined | The name of the Amazon Web Services service that contains the authorized targets that you want to add or update. |
AuthorizedTargets | string[] | undefined | Specifies a list of application ARNs that represent the authorized targets for a service. |
UpdateIdentityPropagationConfigCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | 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 |
|---|
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. |
| 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. |