Connect / Client / start_attached_file_upload

start_attached_file_upload

Connect.Client.start_attached_file_upload(**kwargs)

Provides a pre-signed Amazon S3 URL in response for uploading your content.

Warning

You may only use this API to upload attachments to a Connect Case.

See also: AWS API Documentation

Request Syntax

response = client.start_attached_file_upload(
    ClientToken='string',
    InstanceId='string',
    FileName='string',
    FileSizeInBytes=123,
    UrlExpiryInSeconds=123,
    FileUseCaseType='ATTACHMENT',
    AssociatedResourceArn='string',
    CreatedBy={
        'ConnectUserArn': 'string',
        'AWSIdentityArn': 'string'
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

• ClientToken (string) –

  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.

  This field is autopopulated if not provided.

• InstanceId (string) –

  [REQUIRED]

  The unique identifier of the Connect instance.

• FileName (string) –

  [REQUIRED]

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

• FileSizeInBytes (integer) –

  [REQUIRED]

  The size of the attached file in bytes.

• UrlExpiryInSeconds (integer) – Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

• FileUseCaseType (string) –

  [REQUIRED]

  The use case for the file.

• AssociatedResourceArn (string) –

  [REQUIRED]

  The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.

  Note

  This value must be a valid ARN.

• CreatedBy (dict) –

  Represents the identity that created the file.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: ConnectUserArn, AWSIdentityArn.

  • ConnectUserArn (string) –

    An agent ARN representing a connect user.

  • AWSIdentityArn (string) –

    STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

• Tags (dict) –

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

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'FileArn': 'string',
    'FileId': 'string',
    'CreationTime': 'string',
    'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
    'CreatedBy': {
        'ConnectUserArn': 'string',
        'AWSIdentityArn': 'string'
    },
    'UploadUrlMetadata': {
        'Url': 'string',
        'UrlExpiry': 'string',
        'HeadersToInclude': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) – Response from StartAttachedFileUpload API.

  • FileArn (string) –

    The unique identifier of the attached file resource (ARN).

  • FileId (string) –

    The unique identifier of the attached file resource.

  • CreationTime (string) –

    The time of Creation of the file resource as an ISO timestamp. It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

  • FileStatus (string) –

    The current status of the attached file.

  • CreatedBy (dict) –

    Represents the identity that created the file.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: ConnectUserArn, AWSIdentityArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • ConnectUserArn (string) –

      An agent ARN representing a connect user.

    • AWSIdentityArn (string) –

      STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

  • UploadUrlMetadata (dict) –

    Information to be used while uploading the attached file.

    • Url (string) –

      A pre-signed S3 URL that should be used for uploading the attached file.

    • UrlExpiry (string) –

      The expiration time of the URL in ISO timestamp. It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

    • HeadersToInclude (dict) –

      A map of headers that should be provided when uploading the attached file.

      • (string) –

        • (string) –

Exceptions

• Connect.Client.exceptions.AccessDeniedException

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.ResourceConflictException

• Connect.Client.exceptions.ServiceQuotaExceededException