Skip to content

StartAttachedFileUploadRequest

Source code in docs_src/capo_connect/types/start_attached_file_upload_request.py
class StartAttachedFileUploadRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The unique identifier of the Connect Customer instance.</p>"""
    file_name: "capo_connect.types.file_name.FileName"
    """<p>A case-sensitive name of the attached file being uploaded.</p>"""
    file_size_in_bytes: "capo_connect.types.file_size_in_bytes.FileSizeInBytes"
    """<p>The size of the attached file in bytes.</p>"""
    url_expiry_in_seconds: NotRequired[
        "capo_connect.types.url_expiry_in_seconds.URLExpiryInSeconds"
    ]
    """<p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>"""
    file_use_case_type: "capo_connect.types.file_use_case_type.FileUseCaseType"
    """<p>The use case for the file.</p> <important> <p> Only <code>ATTACHMENTS</code> are supported.</p> </important>"""
    associated_resource_arn: "capo_connect.types.arn.ARN"
    """<p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a>, <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>, and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-getting-started-tasks.html">Task</a>.</p> <note> <p>This value must be a valid ARN.</p> </note>"""
    created_by: NotRequired["capo_connect.types.created_by_info.CreatedByInfo"]
    """<p>Represents the identity that created the file.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>"""

associated_resource_arn instance-attribute

associated_resource_arn: ARN

The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

This value must be a valid ARN.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

created_by instance-attribute

created_by: NotRequired[CreatedByInfo]

Represents the identity that created the file.

file_name instance-attribute

file_name: FileName

A case-sensitive name of the attached file being uploaded.

file_size_in_bytes instance-attribute

file_size_in_bytes: FileSizeInBytes

The size of the attached file in bytes.

file_use_case_type instance-attribute

file_use_case_type: FileUseCaseType

The use case for the file.

Only ATTACHMENTS are supported.

instance_id instance-attribute

instance_id: InstanceId

The unique identifier of the Connect Customer instance.

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"} }.

url_expiry_in_seconds instance-attribute

url_expiry_in_seconds: NotRequired[URLExpiryInSeconds]

Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.