prompt_versions

Creates, updates, deletes or gets a prompt_version resource or lists prompt_versions in a region

Overview

Name	prompt_versions
Type	Resource
Description	Definition of AWS::Bedrock::PromptVersion Resource Type
Id	awscc.bedrock.prompt_versions

Fields

get (all properties)

Name	Datatype	Description
prompt_arn	string	ARN of a prompt resource possibly with a version
arn	string	ARN of a prompt version resource
created_at	string	Time Stamp.
prompt_id	string	Identifier for a Prompt
updated_at	string	Time Stamp.
version	string	Version.
▶variants	array	List of prompt variants
default_variant	string	Name for a variant.
description	string	Description for a prompt version resource.
customer_encryption_key_arn	string	A KMS key ARN
name	string	Name for a prompt resource.
tags	object	A map of tag keys and values
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	ARN of a prompt version resource
region	string	AWS region.

For more information, see AWS::Bedrock::PromptVersion.

Methods

Name	Resource	Accessible by	Required Params
create_resource	prompt_versions	INSERT	PromptArn, region
delete_resource	prompt_versions	DELETE	Identifier, region
list_resources	prompt_versions_list_only	SELECT	region
get_resource	prompt_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual prompt_version.

SELECT
  region,
  prompt_arn,
  arn,
  created_at,
  prompt_id,
  updated_at,
  version,
  variants,
  default_variant,
  description,
  customer_encryption_key_arn,
  name,
  tags
FROM awscc.bedrock.prompt_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all prompt_versions in a region.

SELECT
  region,
  arn
FROM awscc.bedrock.prompt_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.bedrock.prompt_versions (
  PromptArn,
  region
)
SELECT
  '{{ prompt_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.bedrock.prompt_versions (
  PromptArn,
  Description,
  Tags,
  region
)
SELECT
  '{{ prompt_arn }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ 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: prompt_version
  props:
    - name: prompt_arn
      value: '{{ prompt_arn }}'
    - name: description
      value: '{{ description }}'
    - name: tags
      value: {}

DELETE example

/*+ delete */
DELETE FROM awscc.bedrock.prompt_versions
WHERE
  Identifier = '{{ arn }}' 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 prompt_versions resource, the following permissions are required:

Create

bedrock:CreatePromptVersion,
bedrock:GetPrompt,
bedrock:TagResource,
bedrock:ListTagsForResource,
kms:GenerateDataKey,
kms:Decrypt

Read

bedrock:GetPrompt,
bedrock:ListTagsForResource,
kms:Decrypt

Delete

bedrock:DeletePrompt,
bedrock:GetPrompt

List

bedrock:ListPrompts