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	awscc.qbusiness.retrievers

Fields

get (all properties)

Name	Datatype	Description
application_id	string
configuration	object
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.

list (identifiers only)

Name	Datatype	Description
application_id	string
retriever_id	string
region	string	AWS region.

For more information, see AWS::QBusiness::Retriever.

Methods

Name	Resource	Accessible by	Required Params
create_resource	retrievers	INSERT	ApplicationId, Configuration, DisplayName, Type, region
delete_resource	retrievers	DELETE	Identifier, region
update_resource	retrievers	UPDATE	Identifier, PatchDocument, region
list_resources	retrievers_list_only	SELECT	region
get_resource	retrievers	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.qbusiness.retrievers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ retriever_id }}';

list (identifiers only)

Lists all retrievers in a region.

SELECT
  region,
  application_id,
  retriever_id
FROM awscc.qbusiness.retrievers_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.qbusiness.retrievers (
  ApplicationId,
  Configuration,
  DisplayName,
  Type,
  region
)
SELECT
  '{{ application_id }}',
  '{{ configuration }}',
  '{{ display_name }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.qbusiness.retrievers (
  ApplicationId,
  Configuration,
  DisplayName,
  RoleArn,
  Tags,
  Type,
  region
)
SELECT
  '{{ application_id }}',
  '{{ configuration }}',
  '{{ display_name }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: retriever
  props:
    - name: application_id
      value: '{{ application_id }}'
    - name: configuration
      value: null
    - name: display_name
      value: '{{ display_name }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: type
      value: '{{ type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.qbusiness.retrievers
SET PatchDocument = string('{{ {
    "Configuration": configuration,
    "DisplayName": display_name,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ application_id }}|{{ retriever_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.qbusiness.retrievers
WHERE
  Identifier = '{{ application_id }}|{{ retriever_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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