presigned_urls

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

Overview

Name	presigned_urls
Type	Resource
Id	aws.qapps.presigned_urls

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_presigned_url	insert	instance-id, region, cardId, appId, fileContentsSha256, fileName, scope		Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level. The IAM permissions are derived from the qapps:ImportDocument action. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.

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
instance-id	string	The unique identifier of the Amazon Q Business application environment instance.
region	string	AWS region (default: us-east-1)

INSERT examples

create_presigned_url

Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level. The IAM permissions are derived from the qapps:ImportDocument action. For more information on the IAM policy for Amazon Q Apps, see IAM permissions for using Amazon Q Apps.

INSERT INTO aws.qapps.presigned_urls (
cardId,
appId,
fileContentsSha256,
fileName,
scope,
sessionId,
`instance-id`,
region
)
SELECT 
'{{ cardId }}' /* required */,
'{{ appId }}' /* required */,
'{{ fileContentsSha256 }}' /* required */,
'{{ fileName }}' /* required */,
'{{ scope }}' /* required */,
'{{ sessionId }}',
'{{ instance-id }}',
'{{ region }}'
RETURNING
file_id,
presigned_url,
presigned_url_expiration,
presigned_url_fields
;

Manifest

# Description fields are for documentation purposes
- name: presigned_urls
props:
  - name: instance-id
    value: "{{ instance-id }}"
    description: Required parameter for the presigned_urls resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the presigned_urls resource.
  - name: cardId
    value: "{{ cardId }}"
  - name: appId
    value: "{{ appId }}"
  - name: fileContentsSha256
    value: "{{ fileContentsSha256 }}"
  - name: fileName
    value: "{{ fileName }}"
  - name: scope
    value: "{{ scope }}"
    valid_values: ['APPLICATION', 'SESSION']
  - name: sessionId
    value: "{{ sessionId }}"