Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. bedrock
  5. getPrompt

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.getPrompt

Explore with Pulumi AI

aws-native logo

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

    Definition of AWS::Bedrock::Prompt Resource Type

    Using getPrompt

    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 getPrompt(args: GetPromptArgs, opts?: InvokeOptions): Promise<GetPromptResult>
function getPromptOutput(args: GetPromptOutputArgs, opts?: InvokeOptions): Output<GetPromptResult>
    def get_prompt(arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPromptResult
def get_prompt_output(arn: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPromptResult]
    func LookupPrompt(ctx *Context, args *LookupPromptArgs, opts ...InvokeOption) (*LookupPromptResult, error)
func LookupPromptOutput(ctx *Context, args *LookupPromptOutputArgs, opts ...InvokeOption) LookupPromptResultOutput

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

    public static class GetPrompt 
{
    public static Task<GetPromptResult> InvokeAsync(GetPromptArgs args, InvokeOptions? opts = null)
    public static Output<GetPromptResult> Invoke(GetPromptInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPromptResult> getPrompt(GetPromptArgs args, InvokeOptions options)
public static Output<GetPromptResult> getPrompt(GetPromptArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Arn string
    ARN of a prompt resource possibly with a version
    Arn string
    ARN of a prompt resource possibly with a version
    arn String
    ARN of a prompt resource possibly with a version
    arn string
    ARN of a prompt resource possibly with a version
    arn str
    ARN of a prompt resource possibly with a version
    arn String
    ARN of a prompt resource possibly with a version

    getPrompt Result

    The following output properties are available:

    Arn string
    ARN of a prompt resource possibly with a version
    CreatedAt string
    Time Stamp.
    CustomerEncryptionKeyArn string
    A KMS key ARN
    DefaultVariant string
    Name for a variant.
    Description string
    Name for a prompt resource.
    Id string
    Identifier for a Prompt
    Name string
    Name for a prompt resource.
    Tags Dictionary<string, string>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    Time Stamp.
    Variants List<Pulumi.AwsNative.Bedrock.Outputs.PromptVariant>
    List of prompt variants
    Version string
    Draft Version.
    Arn string
    ARN of a prompt resource possibly with a version
    CreatedAt string
    Time Stamp.
    CustomerEncryptionKeyArn string
    A KMS key ARN
    DefaultVariant string
    Name for a variant.
    Description string
    Name for a prompt resource.
    Id string
    Identifier for a Prompt
    Name string
    Name for a prompt resource.
    Tags map[string]string
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    UpdatedAt string
    Time Stamp.
    Variants []PromptVariant
    List of prompt variants
    Version string
    Draft Version.
    arn String
    ARN of a prompt resource possibly with a version
    createdAt String
    Time Stamp.
    customerEncryptionKeyArn String
    A KMS key ARN
    defaultVariant String
    Name for a variant.
    description String
    Name for a prompt resource.
    id String
    Identifier for a Prompt
    name String
    Name for a prompt resource.
    tags Map<String,String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    Time Stamp.
    variants List<PromptVariant>
    List of prompt variants
    version String
    Draft Version.
    arn string
    ARN of a prompt resource possibly with a version
    createdAt string
    Time Stamp.
    customerEncryptionKeyArn string
    A KMS key ARN
    defaultVariant string
    Name for a variant.
    description string
    Name for a prompt resource.
    id string
    Identifier for a Prompt
    name string
    Name for a prompt resource.
    tags {[key: string]: string}
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt string
    Time Stamp.
    variants PromptVariant[]
    List of prompt variants
    version string
    Draft Version.
    arn str
    ARN of a prompt resource possibly with a version
    created_at str
    Time Stamp.
    customer_encryption_key_arn str
    A KMS key ARN
    default_variant str
    Name for a variant.
    description str
    Name for a prompt resource.
    id str
    Identifier for a Prompt
    name str
    Name for a prompt resource.
    tags Mapping[str, str]
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updated_at str
    Time Stamp.
    variants Sequence[PromptVariant]
    List of prompt variants
    version str
    Draft Version.
    arn String
    ARN of a prompt resource possibly with a version
    createdAt String
    Time Stamp.
    customerEncryptionKeyArn String
    A KMS key ARN
    defaultVariant String
    Name for a variant.
    description String
    Name for a prompt resource.
    id String
    Identifier for a Prompt
    name String
    Name for a prompt resource.
    tags Map<String>
    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:

    updatedAt String
    Time Stamp.
    variants List<Property Map>
    List of prompt variants
    version String
    Draft Version.

    Supporting Types

    PromptAgentResource

    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.

    PromptCachePointBlock

    PromptCachePointType

    PromptChatPromptTemplateConfiguration

    Messages List<Pulumi.AwsNative.Bedrock.Inputs.PromptMessage>
    List of messages for chat prompt template
    InputVariables List<Pulumi.AwsNative.Bedrock.Inputs.PromptInputVariable>
    List of input variables
    System List<Union<Pulumi.AwsNative.Bedrock.Inputs.PromptSystemContentBlock0Properties, Pulumi.AwsNative.Bedrock.Inputs.PromptSystemContentBlock1Properties>>
    Configuration for chat prompt template
    ToolConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptToolConfiguration
    Messages []PromptMessage
    List of messages for chat prompt template
    InputVariables []PromptInputVariable
    List of input variables
    System []interface{}
    Configuration for chat prompt template
    ToolConfiguration PromptToolConfiguration
    messages List<PromptMessage>
    List of messages for chat prompt template
    inputVariables List<PromptInputVariable>
    List of input variables
    system List<Either<PromptSystemContentBlock0Properties,PromptSystemContentBlock1Properties>>
    Configuration for chat prompt template
    toolConfiguration PromptToolConfiguration
    messages PromptMessage[]
    List of messages for chat prompt template
    inputVariables PromptInputVariable[]
    List of input variables
    system (PromptSystemContentBlock0Properties | PromptSystemContentBlock1Properties)[]
    Configuration for chat prompt template
    toolConfiguration PromptToolConfiguration
    messages Sequence[PromptMessage]
    List of messages for chat prompt template
    input_variables Sequence[PromptInputVariable]
    List of input variables
    system Sequence[Union[PromptSystemContentBlock0Properties, PromptSystemContentBlock1Properties]]
    Configuration for chat prompt template
    tool_configuration PromptToolConfiguration
    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

    PromptContentBlock0Properties

    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

    PromptContentBlock1Properties

    PromptConversationRole

    PromptGenAiResourceProperties

    PromptInferenceConfigurationProperties

    PromptInputVariable

    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

    PromptMessage

    Content List<Union<Pulumi.AwsNative.Bedrock.Inputs.PromptContentBlock0Properties, Pulumi.AwsNative.Bedrock.Inputs.PromptContentBlock1Properties>>
    List of Content Blocks
    Role Pulumi.AwsNative.Bedrock.PromptConversationRole
    Content []interface{}
    List of Content Blocks
    Role PromptConversationRole
    content List<Either<PromptContentBlock0Properties,PromptContentBlock1Properties>>
    List of Content Blocks
    role PromptConversationRole
    content (PromptContentBlock0Properties | PromptContentBlock1Properties)[]
    List of Content Blocks
    role PromptConversationRole
    content Sequence[Union[PromptContentBlock0Properties, PromptContentBlock1Properties]]
    List of Content Blocks
    role PromptConversationRole
    content List<Property Map | Property Map>
    List of Content Blocks
    role "user" | "assistant"

    PromptMetadataEntry

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    PromptModelInferenceConfiguration

    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

    PromptSpecificToolChoice

    Name string
    Tool name
    Name string
    Tool name
    name String
    Tool name
    name string
    Tool name
    name str
    Tool name
    name String
    Tool name

    PromptSystemContentBlock0Properties

    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

    PromptSystemContentBlock1Properties

    PromptTemplateConfiguration0Properties

    PromptTemplateConfiguration1Properties

    PromptTemplateType

    PromptTextPromptTemplateConfiguration

    CachePoint PromptCachePointBlock
    InputVariables []PromptInputVariable
    List of input variables
    Text string
    Prompt content for String prompt template
    TextS3Location PromptTextS3Location
    cachePoint PromptCachePointBlock
    inputVariables List<PromptInputVariable>
    List of input variables
    text String
    Prompt content for String prompt template
    textS3Location PromptTextS3Location
    cachePoint PromptCachePointBlock
    inputVariables PromptInputVariable[]
    List of input variables
    text string
    Prompt content for String prompt template
    textS3Location PromptTextS3Location
    cachePoint Property Map
    inputVariables List<Property Map>
    List of input variables
    text String
    Prompt content for String prompt template
    textS3Location Property Map

    PromptTextS3Location

    Bucket string
    A bucket in S3
    Key string
    A object key in S3
    Version string
    The version of the the S3 object to use
    Bucket string
    A bucket in S3
    Key string
    A object key in S3
    Version string
    The version of the the S3 object to use
    bucket String
    A bucket in S3
    key String
    A object key in S3
    version String
    The version of the the S3 object to use
    bucket string
    A bucket in S3
    key string
    A object key in S3
    version string
    The version of the the S3 object to use
    bucket str
    A bucket in S3
    key str
    A object key in S3
    version str
    The version of the the S3 object to use
    bucket String
    A bucket in S3
    key String
    A object key in S3
    version String
    The version of the the S3 object to use

    PromptTool0Properties

    PromptTool1Properties

    PromptToolChoice0Properties

    PromptToolChoice1Properties

    PromptToolChoice2Properties

    PromptToolConfiguration

    Tools List<Union<Pulumi.AwsNative.Bedrock.Inputs.PromptTool0Properties, Pulumi.AwsNative.Bedrock.Inputs.PromptTool1Properties>>
    List of Tools
    ToolChoice Pulumi.AwsNative.Bedrock.Inputs.PromptToolChoice0Properties | Pulumi.AwsNative.Bedrock.Inputs.PromptToolChoice1Properties | Pulumi.AwsNative.Bedrock.Inputs.PromptToolChoice2Properties
    tools List<Either<PromptTool0Properties,PromptTool1Properties>>
    List of Tools
    toolChoice PromptToolChoice0Properties | PromptToolChoice1Properties | PromptToolChoice2Properties
    tools (PromptTool0Properties | PromptTool1Properties)[]
    List of Tools
    toolChoice PromptToolChoice0Properties | PromptToolChoice1Properties | PromptToolChoice2Properties
    tools Sequence[Union[PromptTool0Properties, PromptTool1Properties]]
    List of Tools
    tool_choice PromptToolChoice0Properties | PromptToolChoice1Properties | PromptToolChoice2Properties
    tools List<Property Map | Property Map>
    List of Tools
    toolChoice Property Map | Property Map | Property Map

    PromptToolInputSchemaProperties

    Json object
    Json interface{}
    json Object
    json any
    json Any
    json Any

    PromptToolSpecification

    PromptVariant

    Name string
    Name for a variant.
    TemplateConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptTemplateConfiguration0Properties | Pulumi.AwsNative.Bedrock.Inputs.PromptTemplateConfiguration1Properties
    Contains configurations for the prompt template.
    TemplateType Pulumi.AwsNative.Bedrock.PromptTemplateType
    The type of prompt template to use.
    AdditionalModelRequestFields Pulumi.AwsNative.Bedrock.Inputs.PromptAdditionalModelRequestFields
    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.PromptGenAiResourceProperties
    Specifies a generative AI resource with which to use the prompt.
    InferenceConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    Metadata List<Pulumi.AwsNative.Bedrock.Inputs.PromptMetadataEntry>
    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 PromptTemplateConfiguration0Properties | PromptTemplateConfiguration1Properties
    Contains configurations for the prompt template.
    TemplateType PromptTemplateType
    The type of prompt template to use.
    AdditionalModelRequestFields PromptAdditionalModelRequestFields
    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 PromptGenAiResourceProperties
    Specifies a generative AI resource with which to use the prompt.
    InferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    Metadata []PromptMetadataEntry
    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 PromptTemplateConfiguration0Properties | PromptTemplateConfiguration1Properties
    Contains configurations for the prompt template.
    templateType PromptTemplateType
    The type of prompt template to use.
    additionalModelRequestFields PromptAdditionalModelRequestFields
    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 PromptGenAiResourceProperties
    Specifies a generative AI resource with which to use the prompt.
    inferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    metadata List<PromptMetadataEntry>
    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 PromptTemplateConfiguration0Properties | PromptTemplateConfiguration1Properties
    Contains configurations for the prompt template.
    templateType PromptTemplateType
    The type of prompt template to use.
    additionalModelRequestFields PromptAdditionalModelRequestFields
    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 PromptGenAiResourceProperties
    Specifies a generative AI resource with which to use the prompt.
    inferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    metadata PromptMetadataEntry[]
    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 PromptTemplateConfiguration0Properties | PromptTemplateConfiguration1Properties
    Contains configurations for the prompt template.
    template_type PromptTemplateType
    The type of prompt template to use.
    additional_model_request_fields PromptAdditionalModelRequestFields
    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 PromptGenAiResourceProperties
    Specifies a generative AI resource with which to use the prompt.
    inference_configuration PromptInferenceConfigurationProperties
    Contains inference configurations for the prompt variant.
    metadata Sequence[PromptMetadataEntry]
    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.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    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