create_prompt `async` ¶

create_prompt(
    instance_id: InstanceId,
    name: CommonNameLength127,
    s3_uri: S3Uri,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    description: Optional[PromptDescription] = None,
    tags: Optional[TagMap] = None,
) -> CreatePromptResponse

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Connect Customer Administrator Guide.

Parameters:

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 (CommonNameLength127) –

The name of the prompt.
description (Optional[PromptDescription], default: None ) –

The description of the prompt.
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 (Optional[TagMap], default: None ) –

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

Raises:

DuplicateResourceException –

A resource with the specified name already exists.
InternalServiceException –

Request processing failed because of an error or failure with the service.
InvalidParameterException –

One or more of the specified parameters are not valid.
InvalidRequestException –

The request is not valid.
LimitExceededException –

The allowed limit for the resource has been exceeded.
ThrottlingException –

The throttling limit has been exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_connect/_services/async_connect.py

async def create_prompt(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    name: "capo_connect.types.common_name_length127.CommonNameLength127",
    s3_uri: "capo_connect.types.s3_uri.S3Uri",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    description: Optional[
        "capo_connect.types.prompt_description.PromptDescription"
    ] = None,
    tags: Optional["capo_connect.types.tag_map.TagMap"] = None,
) -> "capo_connect.types.create_prompt_response.CreatePromptResponse":
    """<p>Creates a prompt. For more information about prompts, such as supported file types and maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Connect Customer Administrator Guide</i>.</p>

    Args:
        instance_id: <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: <p>The name of the prompt.</p>
        description: <p>The description of the prompt.</p>
        s3_uri: <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: <p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>

    Raises:
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.limit_exceeded_exception.LimitExceededException: <p>The allowed limit for the resource has been exceeded.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.create_prompt_request.CreatePromptRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.create_prompt_response.CreatePromptResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.create_prompt

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.create_prompt.async_create_prompt(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreatePrompt")
    )
    input_: capo_connect.types.create_prompt_request.CreatePromptRequest = {
        "instance_id": instance_id,
        "name": name,
        "s3_uri": s3_uri,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_prompt async ¶

create_prompt `async` ¶