Class: Aws::Connect::Types::StartAttachedFileUploadRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::StartAttachedFileUploadRequest

Defined in:

gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #associated_resource_arn ⇒ String

  The resource to which the attached file is (being) uploaded to.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #created_by ⇒ Types::CreatedByInfo

  Represents the identity that created the file.

• #file_name ⇒ String

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

• #file_size_in_bytes ⇒ Integer

  The size of the attached file in bytes.

• #file_use_case_type ⇒ String

  The use case for the file.

• #instance_id ⇒ String

  The unique identifier of the Connect Customer instance.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #url_expiry_in_seconds ⇒ Integer

  Optional override for the expiry of the pre-signed S3 URL in seconds.

Instance Attribute Details

#associated_resource_arn ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ 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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ Types::CreatedByInfo

Represents the identity that created the file.

Returns:

• (Types::CreatedByInfo)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#file_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#file_size_in_bytes ⇒ Integer

The size of the attached file in bytes.

Returns:

• (Integer)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#file_use_case_type ⇒ String

The use case for the file.

Only ATTACHMENTS are supported.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The unique identifier of the Connect Customer instance.

Returns:

• (String)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#url_expiry_in_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 34240

class StartAttachedFileUploadRequest < Struct.new(
  :client_token,
  :instance_id,
  :file_name,
  :file_size_in_bytes,
  :url_expiry_in_seconds,
  :file_use_case_type,
  :associated_resource_arn,
  :created_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end