Skip to content

CreatePromptRequest

Source code in docs_src/capo_connect/types/create_prompt_request.py
class CreatePromptRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    name: "capo_connect.types.common_name_length127.CommonNameLength127"
    """<p>The name of the prompt.</p>"""
    description: NotRequired["capo_connect.types.prompt_description.PromptDescription"]
    """<p>The description of the prompt.</p>"""
    s3_uri: "capo_connect.types.s3_uri.S3Uri"
    """<p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a> API instead of providing S3 URIs.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>"""

description instance-attribute

description: NotRequired[PromptDescription]

The description of the prompt.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name instance-attribute

The name of the prompt.

s3_uri instance-attribute

s3_uri: S3Uri

The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.