data_accessors

Creates, updates, deletes, gets or lists a data_accessors resource.

Overview

Name	data_accessors
Type	Resource
Id	aws.qbusiness.data_accessors

Fields

The following fields are returned by SELECT queries:

get_data_accessor

Name	Datatype	Description
action_configurations	array	The list of action configurations specifying the allowed actions and any associated filters.
application_id	string	The unique identifier of the Amazon Q Business application associated with this data accessor. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
authentication_detail	object	Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.
created_at	string (date-time)	The timestamp when the data accessor was created.
data_accessor_arn	string	The Amazon Resource Name (ARN) of the data accessor. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
data_accessor_id	string	The unique identifier of the data accessor. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
display_name	string	The friendly name of the data accessor. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
idc_application_arn	string	The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor. (pattern: <code>arn:[a-z0-9-.]{1,63}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}</code>)
principal	string	The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor. (pattern: <code>arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+</code>)
updated_at	string (date-time)	The timestamp when the data accessor was last updated.

list_data_accessors

Name	Datatype	Description
authentication_detail	object	Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.
created_at	string (date-time)	The timestamp when the data accessor was created.
data_accessor_arn	string	The Amazon Resource Name (ARN) of the data accessor. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
data_accessor_id	string	The unique identifier of the data accessor. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
display_name	string	The friendly name of the data accessor. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
idc_application_arn	string	The Amazon Resource Name (ARN) of the associated IAM Identity Center application. (pattern: <code>arn:[a-z0-9-.]{1,63}:sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}</code>)
principal	string	The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor. (pattern: <code>arn:[a-z0-9-.]{1,63}:iam::[0-9]{12}:role/[a-zA-Z0-9_/+=,.@-]+</code>)
updated_at	string (date-time)	The timestamp when the data accessor was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_accessor	select	application_id, data_accessor_id, region		Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
list_data_accessors	select	application_id, region	nextToken, maxResults	Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.
create_data_accessor	insert	application_id, region, principal, actionConfigurations, displayName		Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
update_data_accessor	update	application_id, data_accessor_id, region, actionConfigurations		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.
delete_data_accessor	delete	application_id, data_accessor_id, region		Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The unique identifier of the Amazon Q Business application.
data_accessor_id	string	The unique identifier of the data accessor to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in a single call.
nextToken	string	The token for the next set of results. (You received this token from a previous call.)

SELECT examples

get_data_accessor

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

SELECT
action_configurations,
application_id,
authentication_detail,
created_at,
data_accessor_arn,
data_accessor_id,
display_name,
idc_application_arn,
principal,
updated_at
FROM aws.qbusiness.data_accessors
WHERE application_id = '{{ application_id }}' -- required
AND data_accessor_id = '{{ data_accessor_id }}' -- required
AND region = '{{ region }}' -- required
;

list_data_accessors

Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

SELECT
authentication_detail,
created_at,
data_accessor_arn,
data_accessor_id,
display_name,
idc_application_arn,
principal,
updated_at
FROM aws.qbusiness.data_accessors
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_data_accessor

Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.

INSERT INTO aws.qbusiness.data_accessors (
principal,
actionConfigurations,
clientToken,
displayName,
authenticationDetail,
tags,
application_id,
region
)
SELECT 
'{{ principal }}' /* required */,
'{{ actionConfigurations }}' /* required */,
'{{ clientToken }}',
'{{ displayName }}' /* required */,
'{{ authenticationDetail }}',
'{{ tags }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
data_accessor_arn,
data_accessor_id,
idc_application_arn
;

Manifest

# Description fields are for documentation purposes
- name: data_accessors
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the data_accessors resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_accessors resource.
  - name: principal
    value: "{{ principal }}"
  - name: actionConfigurations
    value:
      - action: "{{ action }}"
        filterConfiguration:
          documentAttributeFilter:
            andAllFilters:
              - andAllFilters: "{{ andAllFilters }}"
                orAllFilters: "{{ orAllFilters }}"
                notFilter:
                  andAllFilters: "{{ andAllFilters }}"
                  orAllFilters: "{{ orAllFilters }}"
                  notFilter: "{{ notFilter }}"
                  equalsTo: "{{ equalsTo }}"
                  containsAll: "{{ containsAll }}"
                  containsAny: "{{ containsAny }}"
                  greaterThan: "{{ greaterThan }}"
                  greaterThanOrEquals: "{{ greaterThanOrEquals }}"
                  lessThan: "{{ lessThan }}"
                  lessThanOrEquals: "{{ lessThanOrEquals }}"
                equalsTo:
                  name: "{{ name }}"
                  value: "{{ value }}"
                containsAll:
                  name: "{{ name }}"
                  value: "{{ value }}"
                containsAny:
                  name: "{{ name }}"
                  value: "{{ value }}"
                greaterThan:
                  name: "{{ name }}"
                  value: "{{ value }}"
                greaterThanOrEquals:
                  name: "{{ name }}"
                  value: "{{ value }}"
                lessThan:
                  name: "{{ name }}"
                  value: "{{ value }}"
                lessThanOrEquals:
                  name: "{{ name }}"
                  value: "{{ value }}"
            orAllFilters:
              - andAllFilters: "{{ andAllFilters }}"
                orAllFilters: "{{ orAllFilters }}"
                notFilter:
                  andAllFilters: "{{ andAllFilters }}"
                  orAllFilters: "{{ orAllFilters }}"
                  notFilter: "{{ notFilter }}"
                  equalsTo: "{{ equalsTo }}"
                  containsAll: "{{ containsAll }}"
                  containsAny: "{{ containsAny }}"
                  greaterThan: "{{ greaterThan }}"
                  greaterThanOrEquals: "{{ greaterThanOrEquals }}"
                  lessThan: "{{ lessThan }}"
                  lessThanOrEquals: "{{ lessThanOrEquals }}"
                equalsTo:
                  name: "{{ name }}"
                  value: "{{ value }}"
                containsAll:
                  name: "{{ name }}"
                  value: "{{ value }}"
                containsAny:
                  name: "{{ name }}"
                  value: "{{ value }}"
                greaterThan:
                  name: "{{ name }}"
                  value: "{{ value }}"
                greaterThanOrEquals:
                  name: "{{ name }}"
                  value: "{{ value }}"
                lessThan:
                  name: "{{ name }}"
                  value: "{{ value }}"
                lessThanOrEquals:
                  name: "{{ name }}"
                  value: "{{ value }}"
            notFilter:
              andAllFilters:
                - andAllFilters: "{{ andAllFilters }}"
                  orAllFilters: "{{ orAllFilters }}"
                  notFilter:
                    andAllFilters: "{{ andAllFilters }}"
                    orAllFilters: "{{ orAllFilters }}"
                    notFilter: "{{ notFilter }}"
                    equalsTo: "{{ equalsTo }}"
                    containsAll: "{{ containsAll }}"
                    containsAny: "{{ containsAny }}"
                    greaterThan: "{{ greaterThan }}"
                    greaterThanOrEquals: "{{ greaterThanOrEquals }}"
                    lessThan: "{{ lessThan }}"
                    lessThanOrEquals: "{{ lessThanOrEquals }}"
                  equalsTo:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  containsAll:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  containsAny:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  greaterThan:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  greaterThanOrEquals:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  lessThan:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  lessThanOrEquals:
                    name: "{{ name }}"
                    value: "{{ value }}"
              orAllFilters:
                - andAllFilters: "{{ andAllFilters }}"
                  orAllFilters: "{{ orAllFilters }}"
                  notFilter:
                    andAllFilters: "{{ andAllFilters }}"
                    orAllFilters: "{{ orAllFilters }}"
                    notFilter: "{{ notFilter }}"
                    equalsTo: "{{ equalsTo }}"
                    containsAll: "{{ containsAll }}"
                    containsAny: "{{ containsAny }}"
                    greaterThan: "{{ greaterThan }}"
                    greaterThanOrEquals: "{{ greaterThanOrEquals }}"
                    lessThan: "{{ lessThan }}"
                    lessThanOrEquals: "{{ lessThanOrEquals }}"
                  equalsTo:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  containsAll:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  containsAny:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  greaterThan:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  greaterThanOrEquals:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  lessThan:
                    name: "{{ name }}"
                    value: "{{ value }}"
                  lessThanOrEquals:
                    name: "{{ name }}"
                    value: "{{ value }}"
              notFilter:
                andAllFilters: "{{ andAllFilters }}"
                orAllFilters: "{{ orAllFilters }}"
                notFilter: "{{ notFilter }}"
                equalsTo: "{{ equalsTo }}"
                containsAll: "{{ containsAll }}"
                containsAny: "{{ containsAny }}"
                greaterThan: "{{ greaterThan }}"
                greaterThanOrEquals: "{{ greaterThanOrEquals }}"
                lessThan: "{{ lessThan }}"
                lessThanOrEquals: "{{ lessThanOrEquals }}"
              equalsTo:
                name: "{{ name }}"
                value: "{{ value }}"
              containsAll:
                name: "{{ name }}"
                value: "{{ value }}"
              containsAny:
                name: "{{ name }}"
                value: "{{ value }}"
              greaterThan:
                name: "{{ name }}"
                value: "{{ value }}"
              greaterThanOrEquals:
                name: "{{ name }}"
                value: "{{ value }}"
              lessThan:
                name: "{{ name }}"
                value: "{{ value }}"
              lessThanOrEquals:
                name: "{{ name }}"
                value: "{{ value }}"
            equalsTo:
              name: "{{ name }}"
              value:
                stringValue: "{{ stringValue }}"
                stringListValue: "{{ stringListValue }}"
                longValue: {{ longValue }}
                dateValue: "{{ dateValue }}"
            containsAll:
              name: "{{ name }}"
              value:
                stringValue: "{{ stringValue }}"
                stringListValue: "{{ stringListValue }}"
                longValue: {{ longValue }}
                dateValue: "{{ dateValue }}"
            containsAny:
              name: "{{ name }}"
              value:
                stringValue: "{{ stringValue }}"
                stringListValue: "{{ stringListValue }}"
                longValue: {{ longValue }}
                dateValue: "{{ dateValue }}"
            greaterThan:
              name: "{{ name }}"
              value:
                stringValue: "{{ stringValue }}"
                stringListValue: "{{ stringListValue }}"
                longValue: {{ longValue }}
                dateValue: "{{ dateValue }}"
            greaterThanOrEquals:
              name: "{{ name }}"
              value:
                stringValue: "{{ stringValue }}"
                stringListValue: "{{ stringListValue }}"
                longValue: {{ longValue }}
                dateValue: "{{ dateValue }}"
            lessThan:
              name: "{{ name }}"
              value:
                stringValue: "{{ stringValue }}"
                stringListValue: "{{ stringListValue }}"
                longValue: {{ longValue }}
                dateValue: "{{ dateValue }}"
            lessThanOrEquals:
              name: "{{ name }}"
              value:
                stringValue: "{{ stringValue }}"
                stringListValue: "{{ stringListValue }}"
                longValue: {{ longValue }}
                dateValue: "{{ dateValue }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: displayName
    value: "{{ displayName }}"
  - name: authenticationDetail
    description: |
      Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.
    value:
      authenticationType: "{{ authenticationType }}"
      authenticationConfiguration:
        idcTrustedTokenIssuerConfiguration:
          idcTrustedTokenIssuerArn: "{{ idcTrustedTokenIssuerArn }}"
      externalIds:
        - "{{ externalIds }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_data_accessor

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.

UPDATE aws.qbusiness.data_accessors
SET 
actionConfigurations = '{{ actionConfigurations }}',
authenticationDetail = '{{ authenticationDetail }}',
displayName = '{{ displayName }}'
WHERE 
application_id = '{{ application_id }}' --required
AND data_accessor_id = '{{ data_accessor_id }}' --required
AND region = '{{ region }}' --required
AND actionConfigurations = '{{ actionConfigurations }}' --required;

DELETE examples

delete_data_accessor

Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.

DELETE FROM aws.qbusiness.data_accessors
WHERE application_id = '{{ application_id }}' --required
AND data_accessor_id = '{{ data_accessor_id }}' --required
AND region = '{{ region }}' --required
;