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.9.0 published on Monday, Nov 18, 2024 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.9.0 published on Monday, Nov 18, 2024 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)
// Output-based functions aren't available in Java yet

    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

    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

    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

    PromptTemplateConfigurationProperties

    PromptTemplateType

    PromptTextPromptTemplateConfiguration

    InputVariables []PromptInputVariable
    List of input variables
    Text string
    Prompt content for String prompt template
    TextS3Location PromptTextS3Location
    inputVariables List<PromptInputVariable>
    List of input variables
    text String
    Prompt content for String prompt template
    textS3Location PromptTextS3Location
    inputVariables PromptInputVariable[]
    List of input variables
    text string
    Prompt content for String prompt template
    textS3Location PromptTextS3Location
    input_variables Sequence[PromptInputVariable]
    List of input variables
    text str
    Prompt content for String prompt template
    text_s3_location PromptTextS3Location
    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

    PromptVariant

    Name string
    Name for a variant.
    TemplateConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    TemplateType Pulumi.AwsNative.Bedrock.PromptTemplateType
    The type of prompt template to use.
    InferenceConfiguration Pulumi.AwsNative.Bedrock.Inputs.PromptInferenceConfigurationProperties
    Contains inference configurations for the 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 PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    TemplateType PromptTemplateType
    The type of prompt template to use.
    InferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the 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 PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    templateType PromptTemplateType
    The type of prompt template to use.
    inferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the 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 PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    templateType PromptTemplateType
    The type of prompt template to use.
    inferenceConfiguration PromptInferenceConfigurationProperties
    Contains inference configurations for the 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 PromptTemplateConfigurationProperties
    Contains configurations for the prompt template.
    template_type PromptTemplateType
    The type of prompt template to use.
    inference_configuration PromptInferenceConfigurationProperties
    Contains inference configurations for the 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
    Contains configurations for the prompt template.
    templateType "TEXT"
    The type of prompt template to use.
    inferenceConfiguration Property Map
    Contains inference configurations for the 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.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native