AWS Cloud Control v1.26.0, Mar 12 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.bedrock.getPromptVersion

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi

pulumi/pulumi-aws-native

Using getPromptVersion

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPromptVersion(args: GetPromptVersionArgs, opts?: InvokeOptions): Promise<GetPromptVersionResult>
function getPromptVersionOutput(args: GetPromptVersionOutputArgs, opts?: InvokeOptions): Output<GetPromptVersionResult>

def get_prompt_version(arn: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPromptVersionResult
def get_prompt_version_output(arn: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPromptVersionResult]

func LookupPromptVersion(ctx *Context, args *LookupPromptVersionArgs, opts ...InvokeOption) (*LookupPromptVersionResult, error)
func LookupPromptVersionOutput(ctx *Context, args *LookupPromptVersionOutputArgs, opts ...InvokeOption) LookupPromptVersionResultOutput

> Note: This function is named LookupPromptVersion in the Go SDK.

public static class GetPromptVersion 
{
    public static Task<GetPromptVersionResult> InvokeAsync(GetPromptVersionArgs args, InvokeOptions? opts = null)
    public static Output<GetPromptVersionResult> Invoke(GetPromptVersionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPromptVersionResult> getPromptVersion(GetPromptVersionArgs args, InvokeOptions options)
public static Output<GetPromptVersionResult> getPromptVersion(GetPromptVersionArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:bedrock:getPromptVersion
  arguments:
    # arguments dictionary

The following arguments are supported:

Arn string: ARN of a prompt version resource

Arn string: ARN of a prompt version resource

arn String: ARN of a prompt version resource

arn string: ARN of a prompt version resource

arn str: ARN of a prompt version resource

arn String: ARN of a prompt version resource

getPromptVersion Result

The following output properties are available:

Arn string: ARN of a prompt version resource
CreatedAt string: Time Stamp.
CustomerEncryptionKeyArn string: A KMS key ARN
DefaultVariant string: Name for a variant.
Name string: Name for a prompt resource.
PromptId string: Identifier for a Prompt
UpdatedAt string: Time Stamp.
Variants List<Pulumi.AwsNative.Bedrock.Outputs.PromptVersionPromptVariant>: List of prompt variants
Version string: Version.

Arn string: ARN of a prompt version resource
CreatedAt string: Time Stamp.
CustomerEncryptionKeyArn string: A KMS key ARN
DefaultVariant string: Name for a variant.
Name string: Name for a prompt resource.
PromptId string: Identifier for a Prompt
UpdatedAt string: Time Stamp.
Variants []PromptVersionPromptVariant: List of prompt variants
Version string: Version.

arn String: ARN of a prompt version resource
createdAt String: Time Stamp.
customerEncryptionKeyArn String: A KMS key ARN
defaultVariant String: Name for a variant.
name String: Name for a prompt resource.
promptId String: Identifier for a Prompt
updatedAt String: Time Stamp.
variants List<PromptVersionPromptVariant>: List of prompt variants
version String: Version.

arn string: ARN of a prompt version resource
createdAt string: Time Stamp.
customerEncryptionKeyArn string: A KMS key ARN
defaultVariant string: Name for a variant.
name string: Name for a prompt resource.
promptId string: Identifier for a Prompt
updatedAt string: Time Stamp.
variants PromptVersionPromptVariant[]: List of prompt variants
version string: Version.

arn str: ARN of a prompt version resource
created_at str: Time Stamp.
customer_encryption_key_arn str: A KMS key ARN
default_variant str: Name for a variant.
name str: Name for a prompt resource.
prompt_id str: Identifier for a Prompt
updated_at str: Time Stamp.
variants Sequence[PromptVersionPromptVariant]: List of prompt variants
version str: Version.

arn String: ARN of a prompt version resource
createdAt String: Time Stamp.
customerEncryptionKeyArn String: A KMS key ARN
defaultVariant String: Name for a variant.
name String: Name for a prompt resource.
promptId String: Identifier for a Prompt
updatedAt String: Time Stamp.
variants List<Property Map>: List of prompt variants
version String: Version.

Supporting Types

PromptVersionCachePointBlock

Type Pulumi.AwsNative.Bedrock.PromptVersionCachePointType

Type PromptVersionCachePointType

type PromptVersionCachePointType

type PromptVersionCachePointType

type PromptVersionCachePointType

type "default"

PromptVersionCachePointType

PromptVersionChatPromptTemplateConfiguration

Messages List<Pulumi.AwsNative.Bedrock.Inputs.PromptVersionMessage>: List of messages for chat prompt template
InputVariables List<Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptInputVariable>: List of input variables
System List<Union<Pulumi.AwsNative.Bedrock.Inputs.PromptVersionSystemContentBlock0Properties, Pulumi.AwsNative.Bedrock.Inputs.PromptVersionSystemContentBlock1Properties>>: Configuration for chat prompt template
ToolConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptVersionToolConfiguration

Messages []PromptVersionMessage: List of messages for chat prompt template
InputVariables []PromptVersionPromptInputVariable: List of input variables
System []interface{}: Configuration for chat prompt template
ToolConfiguration PromptVersionToolConfiguration

messages List<PromptVersionMessage>: List of messages for chat prompt template
inputVariables List<PromptVersionPromptInputVariable>: List of input variables
system List<Either<PromptVersionSystemContentBlock0Properties,PromptVersionSystemContentBlock1Properties>>: Configuration for chat prompt template
toolConfiguration PromptVersionToolConfiguration

messages PromptVersionMessage[]: List of messages for chat prompt template
inputVariables PromptVersionPromptInputVariable[]: List of input variables
system (PromptVersionSystemContentBlock0Properties | PromptVersionSystemContentBlock1Properties)[]: Configuration for chat prompt template
toolConfiguration PromptVersionToolConfiguration

messages Sequence[PromptVersionMessage]: List of messages for chat prompt template
input_variables Sequence[PromptVersionPromptInputVariable]: List of input variables
system Sequence[Union[PromptVersionSystemContentBlock0Properties, PromptVersionSystemContentBlock1Properties]]: Configuration for chat prompt template
tool_configuration PromptVersionToolConfiguration

messages List<Property Map>: List of messages for chat prompt template
inputVariables List<Property Map>: List of input variables
system List<Property Map | Property Map>: Configuration for chat prompt template
toolConfiguration Property Map

PromptVersionContentBlock0Properties

Text string: Configuration for chat prompt template

Text string: Configuration for chat prompt template

text String: Configuration for chat prompt template

text string: Configuration for chat prompt template

text str: Configuration for chat prompt template

text String: Configuration for chat prompt template

PromptVersionContentBlock1Properties

CachePoint Pulumi.AwsNative.Bedrock.Inputs.PromptVersionCachePointBlock

CachePoint PromptVersionCachePointBlock

cachePoint PromptVersionCachePointBlock

cachePoint PromptVersionCachePointBlock

cache_point PromptVersionCachePointBlock

cachePoint Property Map

PromptVersionConversationRole

PromptVersionMessage

Content List<Union<Pulumi.AwsNative.Bedrock.Inputs.PromptVersionContentBlock0Properties, Pulumi.AwsNative.Bedrock.Inputs.PromptVersionContentBlock1Properties>>: List of Content Blocks
Role Pulumi.AwsNative.Bedrock.PromptVersionConversationRole

Content []interface{}: List of Content Blocks
Role PromptVersionConversationRole

content List<Either<PromptVersionContentBlock0Properties,PromptVersionContentBlock1Properties>>: List of Content Blocks
role PromptVersionConversationRole

content (PromptVersionContentBlock0Properties | PromptVersionContentBlock1Properties)[]: List of Content Blocks
role PromptVersionConversationRole

content Sequence[Union[PromptVersionContentBlock0Properties, PromptVersionContentBlock1Properties]]: List of Content Blocks
role PromptVersionConversationRole

content List<Property Map | Property Map>: List of Content Blocks
role "user" | "assistant"

PromptVersionPromptAgentResource

AgentIdentifier string: Arn representation of the Agent Alias.

AgentIdentifier string: Arn representation of the Agent Alias.

agentIdentifier String: Arn representation of the Agent Alias.

agentIdentifier string: Arn representation of the Agent Alias.

agent_identifier str: Arn representation of the Agent Alias.

agentIdentifier String: Arn representation of the Agent Alias.

PromptVersionPromptGenAiResourceProperties

Agent Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptAgentResource

Agent PromptVersionPromptAgentResource

agent PromptVersionPromptAgentResource

agent PromptVersionPromptAgentResource

agent PromptVersionPromptAgentResource

agent Property Map

PromptVersionPromptInferenceConfigurationProperties

Text Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptModelInferenceConfiguration

Text PromptVersionPromptModelInferenceConfiguration

text PromptVersionPromptModelInferenceConfiguration

text PromptVersionPromptModelInferenceConfiguration

text PromptVersionPromptModelInferenceConfiguration

text Property Map

PromptVersionPromptInputVariable

Name string: Name for an input variable

Name string: Name for an input variable

name String: Name for an input variable

name string: Name for an input variable

name str: Name for an input variable

name String: Name for an input variable

PromptVersionPromptMetadataEntry

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

PromptVersionPromptModelInferenceConfiguration

MaxTokens double: Maximum length of output
StopSequences List<string>: List of stop sequences
Temperature double: Controls randomness, higher values increase diversity
TopP double: Cumulative probability cutoff for token selection

MaxTokens float64: Maximum length of output
StopSequences []string: List of stop sequences
Temperature float64: Controls randomness, higher values increase diversity
TopP float64: Cumulative probability cutoff for token selection

maxTokens Double: Maximum length of output
stopSequences List<String>: List of stop sequences
temperature Double: Controls randomness, higher values increase diversity
topP Double: Cumulative probability cutoff for token selection

maxTokens number: Maximum length of output
stopSequences string[]: List of stop sequences
temperature number: Controls randomness, higher values increase diversity
topP number: Cumulative probability cutoff for token selection

max_tokens float: Maximum length of output
stop_sequences Sequence[str]: List of stop sequences
temperature float: Controls randomness, higher values increase diversity
top_p float: Cumulative probability cutoff for token selection

maxTokens Number: Maximum length of output
stopSequences List<String>: List of stop sequences
temperature Number: Controls randomness, higher values increase diversity
topP Number: Cumulative probability cutoff for token selection

PromptVersionPromptTemplateConfiguration0Properties

Text Pulumi.AwsNative.Bedrock.Inputs.PromptVersionTextPromptTemplateConfiguration

Text PromptVersionTextPromptTemplateConfiguration

text PromptVersionTextPromptTemplateConfiguration

text PromptVersionTextPromptTemplateConfiguration

text PromptVersionTextPromptTemplateConfiguration

text Property Map

PromptVersionPromptTemplateConfiguration1Properties

Chat Pulumi.AwsNative.Bedrock.Inputs.PromptVersionChatPromptTemplateConfiguration

Chat PromptVersionChatPromptTemplateConfiguration

chat PromptVersionChatPromptTemplateConfiguration

chat PromptVersionChatPromptTemplateConfiguration

chat PromptVersionChatPromptTemplateConfiguration

chat Property Map

PromptVersionPromptTemplateType

PromptVersionPromptVariant

Name string: Name for a variant.
TemplateConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptTemplateConfiguration0Properties | Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptTemplateConfiguration1Properties: Contains configurations for the prompt template.
TemplateType Pulumi.AwsNative.Bedrock.PromptVersionPromptTemplateType: The type of prompt template to use.
AdditionalModelRequestFields Pulumi.AwsNative.Bedrock.Inputs.PromptVersionAdditionalModelRequestFields: Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .
GenAiResource Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptGenAiResourceProperties: Specifies a generative AI resource with which to use the prompt.
InferenceConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptInferenceConfigurationProperties: Contains inference configurations for the prompt variant.
Metadata List<Pulumi.AwsNative.Bedrock.Inputs.PromptVersionPromptMetadataEntry>: An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
ModelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

Name string: Name for a variant.
TemplateConfiguration PromptVersionPromptTemplateConfiguration0Properties | PromptVersionPromptTemplateConfiguration1Properties: Contains configurations for the prompt template.
TemplateType PromptVersionPromptTemplateType: The type of prompt template to use.
AdditionalModelRequestFields PromptVersionAdditionalModelRequestFields: Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .
GenAiResource PromptVersionPromptGenAiResourceProperties: Specifies a generative AI resource with which to use the prompt.
InferenceConfiguration PromptVersionPromptInferenceConfigurationProperties: Contains inference configurations for the prompt variant.
Metadata []PromptVersionPromptMetadataEntry: An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
ModelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

name String: Name for a variant.
templateConfiguration PromptVersionPromptTemplateConfiguration0Properties | PromptVersionPromptTemplateConfiguration1Properties: Contains configurations for the prompt template.
templateType PromptVersionPromptTemplateType: The type of prompt template to use.
additionalModelRequestFields PromptVersionAdditionalModelRequestFields: Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .
genAiResource PromptVersionPromptGenAiResourceProperties: Specifies a generative AI resource with which to use the prompt.
inferenceConfiguration PromptVersionPromptInferenceConfigurationProperties: Contains inference configurations for the prompt variant.
metadata List<PromptVersionPromptMetadataEntry>: An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
modelId String: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

name string: Name for a variant.
templateConfiguration PromptVersionPromptTemplateConfiguration0Properties | PromptVersionPromptTemplateConfiguration1Properties: Contains configurations for the prompt template.
templateType PromptVersionPromptTemplateType: The type of prompt template to use.
additionalModelRequestFields PromptVersionAdditionalModelRequestFields: Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .
genAiResource PromptVersionPromptGenAiResourceProperties: Specifies a generative AI resource with which to use the prompt.
inferenceConfiguration PromptVersionPromptInferenceConfigurationProperties: Contains inference configurations for the prompt variant.
metadata PromptVersionPromptMetadataEntry[]: An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
modelId string: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

name str: Name for a variant.
template_configuration PromptVersionPromptTemplateConfiguration0Properties | PromptVersionPromptTemplateConfiguration1Properties: Contains configurations for the prompt template.
template_type PromptVersionPromptTemplateType: The type of prompt template to use.
additional_model_request_fields PromptVersionAdditionalModelRequestFields: Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .
gen_ai_resource PromptVersionPromptGenAiResourceProperties: Specifies a generative AI resource with which to use the prompt.
inference_configuration PromptVersionPromptInferenceConfigurationProperties: Contains inference configurations for the prompt variant.
metadata Sequence[PromptVersionPromptMetadataEntry]: An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
model_id str: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.

name String: Name for a variant.
templateConfiguration Property Map | Property Map: Contains configurations for the prompt template.
templateType "TEXT" | "CHAT": The type of prompt template to use.
additionalModelRequestFields Property Map: Contains model-specific inference configurations that aren't in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .
genAiResource Property Map: Specifies a generative AI resource with which to use the prompt.
inferenceConfiguration Property Map: Contains inference configurations for the prompt variant.
metadata List<Property Map>: An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
modelId String: ARN or Id of a Bedrock Foundational Model or Inference Profile, or the ARN of a imported model, or a provisioned throughput ARN for custom models.