Class: Aws::ConnectCases::Types::BatchUpdateCaseRequest

Inherits:

Struct

• Object
• Struct
• Aws::ConnectCases::Types::BatchUpdateCaseRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:title]

Instance Attribute Summary

• #cases ⇒ Array<Types::BatchUpdateCaseIdentifier>

  The list of cases to update.

• #client_token ⇒ String

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

• #customer_id ⇒ String

  The ARN of the customer profile to associate with all cases in the request.

• #domain_id ⇒ String

  The unique identifier of the Cases domain.

• #fields ⇒ Array<Types::FieldValueInput>

  An array of objects, each with a fieldIdentifier and a value.

• #performed_by ⇒ Types::UserUnion

  The entity that performed the action.

• #status ⇒ String

  The status to apply to all cases in the request.

• #title ⇒ String

  The title to apply to all cases in the request.

Instance Attribute Details

#cases ⇒ Array<Types::BatchUpdateCaseIdentifier>

The list of cases to update. All cases must belong to the same domain.

Returns:

• (Array<Types::BatchUpdateCaseIdentifier>)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  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.

If you retry a request with the same client token, the service returns the original response instead of processing the request again. If you reuse a client token with different request parameters, the request fails with a ConflictException.

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

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  include Aws::Structure
end

#customer_id ⇒ String

The ARN of the customer profile to associate with all cases in the request.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  include Aws::Structure
end

#domain_id ⇒ String

The unique identifier of the Cases domain.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  include Aws::Structure
end

#fields ⇒ Array<Types::FieldValueInput>

An array of objects, each with a fieldIdentifier and a value. You can identify each field by its ID or by its name; identifying a field by name is supported only in BatchUpdateCase. The same field values are applied to every case in the request. This field must be present, but can be an empty list when you provide the top-level title, status, or customerId parameters. Do not include title, status, or customerId in this list; set those values only through their top-level parameters. Duplicating them in fields results in a validation error.

Returns:

• (Array<Types::FieldValueInput>)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  include Aws::Structure
end

#performed_by ⇒ Types::UserUnion

The entity that performed the action.

Returns:

• (Types::UserUnion)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  include Aws::Structure
end

#status ⇒ String

The status to apply to all cases in the request.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  include Aws::Structure
end

#title ⇒ String

The title to apply to all cases in the request.

Returns:

• (String)

# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 584

class BatchUpdateCaseRequest < Struct.new(
  :domain_id,
  :cases,
  :fields,
  :performed_by,
  :title,
  :status,
  :customer_id,
  :client_token)
  SENSITIVE = [:title]
  include Aws::Structure
end