UpdateDataAccessorCommand

Suggest an Edit

Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.

Example Syntax

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

import { QBusinessClient, UpdateDataAccessorCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, UpdateDataAccessorCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // UpdateDataAccessorRequest
  applicationId: "STRING_VALUE", // required
  dataAccessorId: "STRING_VALUE", // required
  actionConfigurations: [ // ActionConfigurationList // required
    { // ActionConfiguration
      action: "STRING_VALUE", // required
      filterConfiguration: { // ActionFilterConfiguration
        documentAttributeFilter: { // AttributeFilter
          andAllFilters: [ // AttributeFilters
            {
              andAllFilters: [
                "<AttributeFilter>",
              ],
              orAllFilters: [
                "<AttributeFilter>",
              ],
              notFilter: "<AttributeFilter>",
              equalsTo: { // DocumentAttribute
                name: "STRING_VALUE", // required
                value: { // DocumentAttributeValue Union: only one key present
                  stringValue: "STRING_VALUE",
                  stringListValue: [ // DocumentAttributeStringListValue
                    "STRING_VALUE",
                  ],
                  longValue: Number("long"),
                  dateValue: new Date("TIMESTAMP"),
                },
              },
              containsAll: {
                name: "STRING_VALUE", // required
                value: {//  Union: only one key present
                  stringValue: "STRING_VALUE",
                  stringListValue: [
                    "STRING_VALUE",
                  ],
                  longValue: Number("long"),
                  dateValue: new Date("TIMESTAMP"),
                },
              },
              containsAny: {
                name: "STRING_VALUE", // required
                value: {//  Union: only one key present
                  stringValue: "STRING_VALUE",
                  stringListValue: [
                    "STRING_VALUE",
                  ],
                  longValue: Number("long"),
                  dateValue: new Date("TIMESTAMP"),
                },
              },
              greaterThan: {
                name: "STRING_VALUE", // required
                value: {//  Union: only one key present
                  stringValue: "STRING_VALUE",
                  stringListValue: [
                    "STRING_VALUE",
                  ],
                  longValue: Number("long"),
                  dateValue: new Date("TIMESTAMP"),
                },
              },
              greaterThanOrEquals: {
                name: "STRING_VALUE", // required
                value: {//  Union: only one key present
                  stringValue: "STRING_VALUE",
                  stringListValue: [
                    "STRING_VALUE",
                  ],
                  longValue: Number("long"),
                  dateValue: new Date("TIMESTAMP"),
                },
              },
              lessThan: "<DocumentAttribute>",
              lessThanOrEquals: "<DocumentAttribute>",
            },
          ],
          orAllFilters: [
            "<AttributeFilter>",
          ],
          notFilter: "<AttributeFilter>",
          equalsTo: "<DocumentAttribute>",
          containsAll: "<DocumentAttribute>",
          containsAny: "<DocumentAttribute>",
          greaterThan: "<DocumentAttribute>",
          greaterThanOrEquals: "<DocumentAttribute>",
          lessThan: "<DocumentAttribute>",
          lessThanOrEquals: "<DocumentAttribute>",
        },
      },
    },
  ],
  displayName: "STRING_VALUE",
};
const command = new UpdateDataAccessorCommand(input);
const response = await client.send(command);
// {};

UpdateDataAccessorCommand Input

See UpdateDataAccessorCommandInput for more details

Parameter
Type
Description
actionConfigurations
Required
ActionConfiguration[] | undefined

The updated list of action configurations specifying the allowed actions and any associated filters.

applicationId
Required
string | undefined

The unique identifier of the Amazon Q Business application.

dataAccessorId
Required
string | undefined

The unique identifier of the data accessor to update.

displayName
string | undefined

The updated friendly name for the data accessor.

UpdateDataAccessorCommand Output

See UpdateDataAccessorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ConflictException
client

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.