Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Module: Aws::ConnectCases::Types

Defined in:
gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb

Defined Under Namespace

Classes: AccessDeniedException, AuditEvent, AuditEventField, AuditEventFieldValueUnion, AuditEventPerformedBy, BasicLayout, BatchGetFieldRequest, BatchGetFieldResponse, BatchPutFieldOptionsRequest, BatchPutFieldOptionsResponse, CaseEventIncludedData, CaseFilter, CaseSummary, CommentContent, ConflictException, Contact, ContactContent, ContactFilter, CreateCaseRequest, CreateCaseResponse, CreateDomainRequest, CreateDomainResponse, CreateFieldRequest, CreateFieldResponse, CreateLayoutRequest, CreateLayoutResponse, CreateRelatedItemRequest, CreateRelatedItemResponse, CreateTemplateRequest, CreateTemplateResponse, DeleteDomainRequest, DeleteDomainResponse, DeleteFieldRequest, DeleteFieldResponse, DeleteLayoutRequest, DeleteLayoutResponse, DeleteTemplateRequest, DeleteTemplateResponse, DomainSummary, EventBridgeConfiguration, EventIncludedData, FieldError, FieldFilter, FieldGroup, FieldIdentifier, FieldItem, FieldOption, FieldOptionError, FieldSummary, FieldValue, FieldValueUnion, FileContent, FileFilter, GetCaseAuditEventsRequest, GetCaseAuditEventsResponse, GetCaseEventConfigurationRequest, GetCaseEventConfigurationResponse, GetCaseRequest, GetCaseResponse, GetDomainRequest, GetDomainResponse, GetFieldResponse, GetLayoutRequest, GetLayoutResponse, GetTemplateRequest, GetTemplateResponse, InternalServerException, LayoutConfiguration, LayoutContent, LayoutSections, LayoutSummary, ListCasesForContactRequest, ListCasesForContactResponse, ListDomainsRequest, ListDomainsResponse, ListFieldOptionsRequest, ListFieldOptionsResponse, ListFieldsRequest, ListFieldsResponse, ListLayoutsRequest, ListLayoutsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, ListTemplatesRequest, ListTemplatesResponse, PutCaseEventConfigurationRequest, PutCaseEventConfigurationResponse, RelatedItemContent, RelatedItemEventIncludedData, RelatedItemInputContent, RelatedItemTypeFilter, RequiredField, ResourceNotFoundException, SearchCasesRequest, SearchCasesResponse, SearchCasesResponseItem, SearchRelatedItemsRequest, SearchRelatedItemsResponse, SearchRelatedItemsResponseItem, Section, ServiceQuotaExceededException, Sort, TagResourceRequest, TemplateSummary, ThrottlingException, UntagResourceRequest, UpdateCaseRequest, UpdateCaseResponse, UpdateFieldRequest, UpdateFieldResponse, UpdateLayoutRequest, UpdateLayoutResponse, UpdateTemplateRequest, UpdateTemplateResponse, UserUnion, ValidationException

Instance Attribute Summary collapse

Instance Attribute Details

#and_allArray<Types::CaseFilter>

Provides "and all" filtering.

Returns:


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 285

class CaseFilter < Struct.new(
  :and_all,
  :field,
  :not,
  :or_all,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < CaseFilter; end
  class Field < CaseFilter; end
  class Not < CaseFilter; end
  class OrAll < CaseFilter; end
  class Unknown < CaseFilter; end
end

#basicTypes::BasicLayout

Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of Cases user interface.

Returns:


1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1608

class LayoutContent < Struct.new(
  :basic,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Basic < LayoutContent; end
  class Unknown < LayoutContent; end
end

#boolean_valueBoolean

Can be either null, or have a Boolean value type. Only one value can be provided.

Returns:

  • (Boolean)

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 123

class AuditEventFieldValueUnion < Struct.new(
  :boolean_value,
  :double_value,
  :empty_value,
  :string_value,
  :user_arn_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanValue < AuditEventFieldValueUnion; end
  class DoubleValue < AuditEventFieldValueUnion; end
  class EmptyValue < AuditEventFieldValueUnion; end
  class StringValue < AuditEventFieldValueUnion; end
  class UserArnValue < AuditEventFieldValueUnion; end
  class Unknown < AuditEventFieldValueUnion; end
end

#commentTypes::CommentFilter

A filter for related items of type Comment.

Returns:

  • (Types::CommentFilter)

1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1991

class RelatedItemContent < Struct.new(
  :comment,
  :contact,
  :file,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Comment < RelatedItemContent; end
  class Contact < RelatedItemContent; end
  class File < RelatedItemContent; end
  class Unknown < RelatedItemContent; end
end

#contactTypes::ContactFilter

A filter for related items of type Contact.


1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1991

class RelatedItemContent < Struct.new(
  :comment,
  :contact,
  :file,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Comment < RelatedItemContent; end
  class Contact < RelatedItemContent; end
  class File < RelatedItemContent; end
  class Unknown < RelatedItemContent; end
end

#containsTypes::FieldValue

Object containing field identifier and value information.

Returns:


919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 919

class FieldFilter < Struct.new(
  :contains,
  :equal_to,
  :greater_than,
  :greater_than_or_equal_to,
  :less_than,
  :less_than_or_equal_to,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Contains < FieldFilter; end
  class EqualTo < FieldFilter; end
  class GreaterThan < FieldFilter; end
  class GreaterThanOrEqualTo < FieldFilter; end
  class LessThan < FieldFilter; end
  class LessThanOrEqualTo < FieldFilter; end
  class Unknown < FieldFilter; end
end

#double_valueFloat

Can be either null, or have a Double number value type. Only one value can be provided.

Returns:

  • (Float)

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 123

class AuditEventFieldValueUnion < Struct.new(
  :boolean_value,
  :double_value,
  :empty_value,
  :string_value,
  :user_arn_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanValue < AuditEventFieldValueUnion; end
  class DoubleValue < AuditEventFieldValueUnion; end
  class EmptyValue < AuditEventFieldValueUnion; end
  class StringValue < AuditEventFieldValueUnion; end
  class UserArnValue < AuditEventFieldValueUnion; end
  class Unknown < AuditEventFieldValueUnion; end
end

#empty_valueTypes::EmptyFieldValue

An empty value.

Returns:

  • (Types::EmptyFieldValue)

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 123

class AuditEventFieldValueUnion < Struct.new(
  :boolean_value,
  :double_value,
  :empty_value,
  :string_value,
  :user_arn_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanValue < AuditEventFieldValueUnion; end
  class DoubleValue < AuditEventFieldValueUnion; end
  class EmptyValue < AuditEventFieldValueUnion; end
  class StringValue < AuditEventFieldValueUnion; end
  class UserArnValue < AuditEventFieldValueUnion; end
  class Unknown < AuditEventFieldValueUnion; end
end

#equal_toTypes::FieldValue

Object containing field identifier and value information.

Returns:


919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 919

class FieldFilter < Struct.new(
  :contains,
  :equal_to,
  :greater_than,
  :greater_than_or_equal_to,
  :less_than,
  :less_than_or_equal_to,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Contains < FieldFilter; end
  class EqualTo < FieldFilter; end
  class GreaterThan < FieldFilter; end
  class GreaterThanOrEqualTo < FieldFilter; end
  class LessThan < FieldFilter; end
  class LessThanOrEqualTo < FieldFilter; end
  class Unknown < FieldFilter; end
end

#fieldTypes::FieldFilter

A list of fields to filter on.

Returns:


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 285

class CaseFilter < Struct.new(
  :and_all,
  :field,
  :not,
  :or_all,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < CaseFilter; end
  class Field < CaseFilter; end
  class Not < CaseFilter; end
  class OrAll < CaseFilter; end
  class Unknown < CaseFilter; end
end

#field_groupTypes::FieldGroup

Consists of a group of fields and associated properties.

Returns:


2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 2331

class Section < Struct.new(
  :field_group,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class FieldGroup < Section; end
  class Unknown < Section; end
end

#fileTypes::FileFilter

A filter for related items of this type of File.

Returns:


1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 1991

class RelatedItemContent < Struct.new(
  :comment,
  :contact,
  :file,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Comment < RelatedItemContent; end
  class Contact < RelatedItemContent; end
  class File < RelatedItemContent; end
  class Unknown < RelatedItemContent; end
end

#greater_thanTypes::FieldValue

Object containing field identifier and value information.

Returns:


919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 919

class FieldFilter < Struct.new(
  :contains,
  :equal_to,
  :greater_than,
  :greater_than_or_equal_to,
  :less_than,
  :less_than_or_equal_to,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Contains < FieldFilter; end
  class EqualTo < FieldFilter; end
  class GreaterThan < FieldFilter; end
  class GreaterThanOrEqualTo < FieldFilter; end
  class LessThan < FieldFilter; end
  class LessThanOrEqualTo < FieldFilter; end
  class Unknown < FieldFilter; end
end

#greater_than_or_equal_toTypes::FieldValue

Object containing field identifier and value information.

Returns:


919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 919

class FieldFilter < Struct.new(
  :contains,
  :equal_to,
  :greater_than,
  :greater_than_or_equal_to,
  :less_than,
  :less_than_or_equal_to,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Contains < FieldFilter; end
  class EqualTo < FieldFilter; end
  class GreaterThan < FieldFilter; end
  class GreaterThanOrEqualTo < FieldFilter; end
  class LessThan < FieldFilter; end
  class LessThanOrEqualTo < FieldFilter; end
  class Unknown < FieldFilter; end
end

#less_thanTypes::FieldValue

Object containing field identifier and value information.

Returns:


919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 919

class FieldFilter < Struct.new(
  :contains,
  :equal_to,
  :greater_than,
  :greater_than_or_equal_to,
  :less_than,
  :less_than_or_equal_to,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Contains < FieldFilter; end
  class EqualTo < FieldFilter; end
  class GreaterThan < FieldFilter; end
  class GreaterThanOrEqualTo < FieldFilter; end
  class LessThan < FieldFilter; end
  class LessThanOrEqualTo < FieldFilter; end
  class Unknown < FieldFilter; end
end

#less_than_or_equal_toTypes::FieldValue

Object containing field identifier and value information.

Returns:


919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 919

class FieldFilter < Struct.new(
  :contains,
  :equal_to,
  :greater_than,
  :greater_than_or_equal_to,
  :less_than,
  :less_than_or_equal_to,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Contains < FieldFilter; end
  class EqualTo < FieldFilter; end
  class GreaterThan < FieldFilter; end
  class GreaterThanOrEqualTo < FieldFilter; end
  class LessThan < FieldFilter; end
  class LessThanOrEqualTo < FieldFilter; end
  class Unknown < FieldFilter; end
end

#notTypes::CaseFilter

A filter for cases. Only one value can be provided.

Returns:


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 285

class CaseFilter < Struct.new(
  :and_all,
  :field,
  :not,
  :or_all,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < CaseFilter; end
  class Field < CaseFilter; end
  class Not < CaseFilter; end
  class OrAll < CaseFilter; end
  class Unknown < CaseFilter; end
end

#or_allArray<Types::CaseFilter>

Provides "or all" filtering.

Returns:


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 285

class CaseFilter < Struct.new(
  :and_all,
  :field,
  :not,
  :or_all,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class AndAll < CaseFilter; end
  class Field < CaseFilter; end
  class Not < CaseFilter; end
  class OrAll < CaseFilter; end
  class Unknown < CaseFilter; end
end

#string_valueString

String value type.

Returns:

  • (String)

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 123

class AuditEventFieldValueUnion < Struct.new(
  :boolean_value,
  :double_value,
  :empty_value,
  :string_value,
  :user_arn_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanValue < AuditEventFieldValueUnion; end
  class DoubleValue < AuditEventFieldValueUnion; end
  class EmptyValue < AuditEventFieldValueUnion; end
  class StringValue < AuditEventFieldValueUnion; end
  class UserArnValue < AuditEventFieldValueUnion; end
  class Unknown < AuditEventFieldValueUnion; end
end

#user_arnString

Represents the Amazon Connect ARN of the user.

Returns:

  • (String)

2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 2613

class UserUnion < Struct.new(
  :user_arn,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class UserArn < UserUnion; end
  class Unknown < UserUnion; end
end

#user_arn_valueString

Represents the user that performed the audit.

Returns:

  • (String)

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'gems/aws-sdk-connectcases/lib/aws-sdk-connectcases/types.rb', line 123

class AuditEventFieldValueUnion < Struct.new(
  :boolean_value,
  :double_value,
  :empty_value,
  :string_value,
  :user_arn_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BooleanValue < AuditEventFieldValueUnion; end
  class DoubleValue < AuditEventFieldValueUnion; end
  class EmptyValue < AuditEventFieldValueUnion; end
  class StringValue < AuditEventFieldValueUnion; end
  class UserArnValue < AuditEventFieldValueUnion; end
  class Unknown < AuditEventFieldValueUnion; end
end