retrievers

Creates, updates, deletes or gets a retriever resource or lists retrievers in a region

Overview

Name	retrievers
Type	Resource
Description	Definition of AWS::QBusiness::Retriever Resource Type
Id	aws.qbusiness.retrievers

Fields

Name	Datatype	Description
application_id	string
configuration	undefined
created_at	string
display_name	string
retriever_arn	string
retriever_id	string
role_arn	string
status	string
tags	array
type	string
updated_at	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ApplicationId, Configuration, DisplayName, Type, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all retrievers in a region.

SELECT
region,
application_id,
configuration,
created_at,
display_name,
retriever_arn,
retriever_id,
role_arn,
status,
tags,
type,
updated_at
FROM aws.qbusiness.retrievers
WHERE region = 'us-east-1';

Gets all properties from an individual retriever.

SELECT
region,
application_id,
configuration,
created_at,
display_name,
retriever_arn,
retriever_id,
role_arn,
status,
tags,
type,
updated_at
FROM aws.qbusiness.retrievers
WHERE region = 'us-east-1' AND data__Identifier = '<ApplicationId>|<RetrieverId>';

INSERT example

Use the following StackQL query and manifest file to create a new retriever resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.qbusiness.retrievers (
 ApplicationId,
 Configuration,
 DisplayName,
 Type,
 region
)
SELECT 
'{{ ApplicationId }}',
 '{{ Configuration }}',
 '{{ DisplayName }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.qbusiness.retrievers (
 ApplicationId,
 Configuration,
 DisplayName,
 RoleArn,
 Tags,
 Type,
 region
)
SELECT 
 '{{ ApplicationId }}',
 '{{ Configuration }}',
 '{{ DisplayName }}',
 '{{ RoleArn }}',
 '{{ Tags }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: retriever
    props:
      - name: ApplicationId
        value: '{{ ApplicationId }}'
      - name: Configuration
        value: null
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.qbusiness.retrievers
WHERE data__Identifier = '<ApplicationId|RetrieverId>'
AND region = 'us-east-1';

Permissions

To operate on the retrievers resource, the following permissions are required:

Create

iam:PassRole,
qbusiness:CreateRetriever,
qbusiness:GetRetriever,
qbusiness:ListTagsForResource,
qbusiness:TagResource

Read

qbusiness:GetRetriever,
qbusiness:ListTagsForResource

Update

iam:PassRole,
qbusiness:GetRetriever,
qbusiness:ListTagsForResource,
qbusiness:TagResource,
qbusiness:UntagResource,
qbusiness:UpdateRetriever

Delete

qbusiness:DeleteRetriever,
qbusiness:GetRetriever

List

qbusiness:ListRetrievers