Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.ConnectCases
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- BatchGetField
- BatchPutFieldOptions
- CreateCase
- CreateDomain
- CreateField
- CreateLayout
- CreateRelatedItem
- CreateTemplate
- GetCase
- GetCaseEventConfiguration
- GetDomain
- GetLayout
- GetTemplate
- ListCasesForContact
- ListDomains
- ListFieldOptions
- ListFields
- ListLayouts
- ListTagsForResource
- ListTemplates
- PutCaseEventConfiguration
- SearchCases (Paginated)
- SearchRelatedItems (Paginated)
- TagResource
- UntagResource
- UpdateCase
- UpdateField
- UpdateLayout
- UpdateTemplate
- Types
- CommentBodyTextType
- DomainStatus
- FieldNamespace
- FieldType
- Order
- RelatedItemType
- TemplateStatus
- BasicLayout
- CaseEventIncludedData
- CaseFilter
- CaseSummary
- CommentContent
- CommentFilter
- Contact
- ContactContent
- ContactFilter
- DomainSummary
- EventBridgeConfiguration
- EventIncludedData
- FieldError
- FieldFilter
- FieldGroup
- FieldIdentifier
- FieldItem
- FieldOption
- FieldOptionError
- FieldSummary
- FieldValue
- FieldValueUnion
- GetFieldResponse
- LayoutConfiguration
- LayoutContent
- LayoutSections
- LayoutSummary
- RelatedItemContent
- RelatedItemEventIncludedData
- RelatedItemInputContent
- RelatedItemTypeFilter
- RequiredField
- SearchCasesResponseItem
- SearchRelatedItemsResponseItem
- Section
- Sort
- TemplateSummary
Description
Derived from API version 2022-10-03
of the AWS service descriptions, licensed under Apache 2.0.
Welcome to the Amazon Connect Cases API Reference. This guide provides information about the Amazon Connect Cases API, which you can use to create, update, get, and list Cases domains, fields, field options, layouts, templates, cases, related items, and tags.
<p>For more information about Amazon Connect Cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data BatchGetField = BatchGetField' Text (NonEmpty FieldIdentifier)
- newBatchGetField :: Text -> NonEmpty FieldIdentifier -> BatchGetField
- data BatchGetFieldResponse = BatchGetFieldResponse' Int [FieldError] [GetFieldResponse]
- newBatchGetFieldResponse :: Int -> BatchGetFieldResponse
- data BatchPutFieldOptions = BatchPutFieldOptions' Text Text [FieldOption]
- newBatchPutFieldOptions :: Text -> Text -> BatchPutFieldOptions
- data BatchPutFieldOptionsResponse = BatchPutFieldOptionsResponse' (Maybe [FieldOptionError]) Int
- newBatchPutFieldOptionsResponse :: Int -> BatchPutFieldOptionsResponse
- data CreateCase = CreateCase' (Maybe Text) Text [FieldValue] Text
- newCreateCase :: Text -> Text -> CreateCase
- data CreateCaseResponse = CreateCaseResponse' Int Text Text
- newCreateCaseResponse :: Int -> Text -> Text -> CreateCaseResponse
- data CreateDomain = CreateDomain' Text
- newCreateDomain :: Text -> CreateDomain
- data CreateDomainResponse = CreateDomainResponse' Int Text Text DomainStatus
- newCreateDomainResponse :: Int -> Text -> Text -> DomainStatus -> CreateDomainResponse
- data CreateField = CreateField' (Maybe Text) Text Text FieldType
- newCreateField :: Text -> Text -> FieldType -> CreateField
- data CreateFieldResponse = CreateFieldResponse' Int Text Text
- newCreateFieldResponse :: Int -> Text -> Text -> CreateFieldResponse
- data CreateLayout = CreateLayout' LayoutContent Text Text
- newCreateLayout :: LayoutContent -> Text -> Text -> CreateLayout
- data CreateLayoutResponse = CreateLayoutResponse' Int Text Text
- newCreateLayoutResponse :: Int -> Text -> Text -> CreateLayoutResponse
- data CreateRelatedItem = CreateRelatedItem' Text RelatedItemInputContent Text RelatedItemType
- newCreateRelatedItem :: Text -> RelatedItemInputContent -> Text -> RelatedItemType -> CreateRelatedItem
- data CreateRelatedItemResponse = CreateRelatedItemResponse' Int Text Text
- newCreateRelatedItemResponse :: Int -> Text -> Text -> CreateRelatedItemResponse
- data CreateTemplate = CreateTemplate' (Maybe Text) (Maybe LayoutConfiguration) (Maybe [RequiredField]) (Maybe TemplateStatus) Text Text
- newCreateTemplate :: Text -> Text -> CreateTemplate
- data CreateTemplateResponse = CreateTemplateResponse' Int Text Text
- newCreateTemplateResponse :: Int -> Text -> Text -> CreateTemplateResponse
- data GetCase = GetCase' (Maybe Text) Text Text (NonEmpty FieldIdentifier)
- newGetCase :: Text -> Text -> NonEmpty FieldIdentifier -> GetCase
- data GetCaseResponse = GetCaseResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int [FieldValue] Text
- newGetCaseResponse :: Int -> Text -> GetCaseResponse
- data GetCaseEventConfiguration = GetCaseEventConfiguration' Text
- newGetCaseEventConfiguration :: Text -> GetCaseEventConfiguration
- data GetCaseEventConfigurationResponse = GetCaseEventConfigurationResponse' Int EventBridgeConfiguration
- newGetCaseEventConfigurationResponse :: Int -> EventBridgeConfiguration -> GetCaseEventConfigurationResponse
- data GetDomain = GetDomain' Text
- newGetDomain :: Text -> GetDomain
- data GetDomainResponse = GetDomainResponse' (Maybe (HashMap Text Text)) Int ISO8601 Text Text DomainStatus Text
- newGetDomainResponse :: Int -> UTCTime -> Text -> Text -> DomainStatus -> Text -> GetDomainResponse
- data GetLayout = GetLayout' Text Text
- newGetLayout :: Text -> Text -> GetLayout
- data GetLayoutResponse = GetLayoutResponse' (Maybe (HashMap Text Text)) Int LayoutContent Text Text Text
- newGetLayoutResponse :: Int -> LayoutContent -> Text -> Text -> Text -> GetLayoutResponse
- data GetTemplate = GetTemplate' Text Text
- newGetTemplate :: Text -> Text -> GetTemplate
- data GetTemplateResponse = GetTemplateResponse' (Maybe Text) (Maybe LayoutConfiguration) (Maybe [RequiredField]) (Maybe (HashMap Text Text)) Int Text TemplateStatus Text Text
- newGetTemplateResponse :: Int -> Text -> TemplateStatus -> Text -> Text -> GetTemplateResponse
- data ListCasesForContact = ListCasesForContact' (Maybe Natural) (Maybe Text) Text Text
- newListCasesForContact :: Text -> Text -> ListCasesForContact
- data ListCasesForContactResponse = ListCasesForContactResponse' (Maybe Text) Int [CaseSummary]
- newListCasesForContactResponse :: Int -> ListCasesForContactResponse
- data ListDomains = ListDomains' (Maybe Natural) (Maybe Text)
- newListDomains :: ListDomains
- data ListDomainsResponse = ListDomainsResponse' (Maybe Text) Int [DomainSummary]
- newListDomainsResponse :: Int -> ListDomainsResponse
- data ListFieldOptions = ListFieldOptions' (Maybe Natural) (Maybe Text) (Maybe [Text]) Text Text
- newListFieldOptions :: Text -> Text -> ListFieldOptions
- data ListFieldOptionsResponse = ListFieldOptionsResponse' (Maybe Text) Int [FieldOption]
- newListFieldOptionsResponse :: Int -> ListFieldOptionsResponse
- data ListFields = ListFields' (Maybe Natural) (Maybe Text) Text
- newListFields :: Text -> ListFields
- data ListFieldsResponse = ListFieldsResponse' (Maybe Text) Int [FieldSummary]
- newListFieldsResponse :: Int -> ListFieldsResponse
- data ListLayouts = ListLayouts' (Maybe Natural) (Maybe Text) Text
- newListLayouts :: Text -> ListLayouts
- data ListLayoutsResponse = ListLayoutsResponse' (Maybe Text) Int [LayoutSummary]
- newListLayoutsResponse :: Int -> ListLayoutsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListTemplates = ListTemplates' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty TemplateStatus)) Text
- newListTemplates :: Text -> ListTemplates
- data ListTemplatesResponse = ListTemplatesResponse' (Maybe Text) Int [TemplateSummary]
- newListTemplatesResponse :: Int -> ListTemplatesResponse
- data PutCaseEventConfiguration = PutCaseEventConfiguration' Text EventBridgeConfiguration
- newPutCaseEventConfiguration :: Text -> EventBridgeConfiguration -> PutCaseEventConfiguration
- data PutCaseEventConfigurationResponse = PutCaseEventConfigurationResponse' Int
- newPutCaseEventConfigurationResponse :: Int -> PutCaseEventConfigurationResponse
- data SearchCases = SearchCases' (Maybe [FieldIdentifier]) (Maybe CaseFilter) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [Sort]) Text
- newSearchCases :: Text -> SearchCases
- data SearchCasesResponse = SearchCasesResponse' (Maybe Text) Int [SearchCasesResponseItem]
- newSearchCasesResponse :: Int -> SearchCasesResponse
- data SearchRelatedItems = SearchRelatedItems' (Maybe [RelatedItemTypeFilter]) (Maybe Natural) (Maybe Text) Text Text
- newSearchRelatedItems :: Text -> Text -> SearchRelatedItems
- data SearchRelatedItemsResponse = SearchRelatedItemsResponse' (Maybe Text) Int [SearchRelatedItemsResponseItem]
- newSearchRelatedItemsResponse :: Int -> SearchRelatedItemsResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateCase = UpdateCase' Text Text [FieldValue]
- newUpdateCase :: Text -> Text -> UpdateCase
- data UpdateCaseResponse = UpdateCaseResponse' Int
- newUpdateCaseResponse :: Int -> UpdateCaseResponse
- data UpdateField = UpdateField' (Maybe Text) (Maybe Text) Text Text
- newUpdateField :: Text -> Text -> UpdateField
- data UpdateFieldResponse = UpdateFieldResponse' Int
- newUpdateFieldResponse :: Int -> UpdateFieldResponse
- data UpdateLayout = UpdateLayout' (Maybe LayoutContent) (Maybe Text) Text Text
- newUpdateLayout :: Text -> Text -> UpdateLayout
- data UpdateLayoutResponse = UpdateLayoutResponse' Int
- newUpdateLayoutResponse :: Int -> UpdateLayoutResponse
- data UpdateTemplate = UpdateTemplate' (Maybe Text) (Maybe LayoutConfiguration) (Maybe Text) (Maybe [RequiredField]) (Maybe TemplateStatus) Text Text
- newUpdateTemplate :: Text -> Text -> UpdateTemplate
- data UpdateTemplateResponse = UpdateTemplateResponse' Int
- newUpdateTemplateResponse :: Int -> UpdateTemplateResponse
- newtype CommentBodyTextType where
- newtype DomainStatus where
- DomainStatus' { }
- pattern DomainStatus_Active :: DomainStatus
- pattern DomainStatus_CreationFailed :: DomainStatus
- pattern DomainStatus_CreationInProgress :: DomainStatus
- newtype FieldNamespace where
- FieldNamespace' { }
- pattern FieldNamespace_Custom :: FieldNamespace
- pattern FieldNamespace_System :: FieldNamespace
- newtype FieldType where
- FieldType' { }
- pattern FieldType_Boolean :: FieldType
- pattern FieldType_DateTime :: FieldType
- pattern FieldType_Number :: FieldType
- pattern FieldType_SingleSelect :: FieldType
- pattern FieldType_Text :: FieldType
- newtype Order where
- newtype RelatedItemType where
- RelatedItemType' { }
- pattern RelatedItemType_Comment :: RelatedItemType
- pattern RelatedItemType_Contact :: RelatedItemType
- newtype TemplateStatus where
- TemplateStatus' { }
- pattern TemplateStatus_Active :: TemplateStatus
- pattern TemplateStatus_Inactive :: TemplateStatus
- data BasicLayout = BasicLayout' (Maybe LayoutSections) (Maybe LayoutSections)
- newBasicLayout :: BasicLayout
- data CaseEventIncludedData = CaseEventIncludedData' [FieldIdentifier]
- newCaseEventIncludedData :: CaseEventIncludedData
- data CaseFilter = CaseFilter' (Maybe [CaseFilter]) (Maybe FieldFilter) (Maybe CaseFilter)
- newCaseFilter :: CaseFilter
- data CaseSummary = CaseSummary' Text Text
- newCaseSummary :: Text -> Text -> CaseSummary
- data CommentContent = CommentContent' Text CommentBodyTextType
- newCommentContent :: Text -> CommentBodyTextType -> CommentContent
- data CommentFilter = CommentFilter' {
- newCommentFilter :: CommentFilter
- data Contact = Contact' Text
- newContact :: Text -> Contact
- data ContactContent = ContactContent' Text ISO8601 Text
- newContactContent :: Text -> UTCTime -> Text -> ContactContent
- data ContactFilter = ContactFilter' (Maybe [Text]) (Maybe Text)
- newContactFilter :: ContactFilter
- data DomainSummary = DomainSummary' Text Text Text
- newDomainSummary :: Text -> Text -> Text -> DomainSummary
- data EventBridgeConfiguration = EventBridgeConfiguration' (Maybe EventIncludedData) Bool
- newEventBridgeConfiguration :: Bool -> EventBridgeConfiguration
- data EventIncludedData = EventIncludedData' (Maybe CaseEventIncludedData) (Maybe RelatedItemEventIncludedData)
- newEventIncludedData :: EventIncludedData
- data FieldError = FieldError' (Maybe Text) Text Text
- newFieldError :: Text -> Text -> FieldError
- data FieldFilter = FieldFilter' (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue)
- newFieldFilter :: FieldFilter
- data FieldGroup = FieldGroup' (Maybe Text) [FieldItem]
- newFieldGroup :: FieldGroup
- data FieldIdentifier = FieldIdentifier' Text
- newFieldIdentifier :: Text -> FieldIdentifier
- data FieldItem = FieldItem' Text
- newFieldItem :: Text -> FieldItem
- data FieldOption = FieldOption' Bool Text Text
- newFieldOption :: Bool -> Text -> Text -> FieldOption
- data FieldOptionError = FieldOptionError' Text Text Text
- newFieldOptionError :: Text -> Text -> Text -> FieldOptionError
- data FieldSummary = FieldSummary' Text Text Text FieldNamespace FieldType
- newFieldSummary :: Text -> Text -> Text -> FieldNamespace -> FieldType -> FieldSummary
- data FieldValue = FieldValue' Text FieldValueUnion
- newFieldValue :: Text -> FieldValueUnion -> FieldValue
- data FieldValueUnion = FieldValueUnion' (Maybe Bool) (Maybe Double) (Maybe Text)
- newFieldValueUnion :: FieldValueUnion
- data GetFieldResponse = GetFieldResponse' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text FieldNamespace FieldType
- newGetFieldResponse :: Text -> Text -> Text -> FieldNamespace -> FieldType -> GetFieldResponse
- data LayoutConfiguration = LayoutConfiguration' (Maybe Text)
- newLayoutConfiguration :: LayoutConfiguration
- data LayoutContent = LayoutContent' (Maybe BasicLayout)
- newLayoutContent :: LayoutContent
- data LayoutSections = LayoutSections' (Maybe [Section])
- newLayoutSections :: LayoutSections
- data LayoutSummary = LayoutSummary' Text Text Text
- newLayoutSummary :: Text -> Text -> Text -> LayoutSummary
- data RelatedItemContent = RelatedItemContent' (Maybe CommentContent) (Maybe ContactContent)
- newRelatedItemContent :: RelatedItemContent
- data RelatedItemEventIncludedData = RelatedItemEventIncludedData' Bool
- newRelatedItemEventIncludedData :: Bool -> RelatedItemEventIncludedData
- data RelatedItemInputContent = RelatedItemInputContent' (Maybe CommentContent) (Maybe Contact)
- newRelatedItemInputContent :: RelatedItemInputContent
- data RelatedItemTypeFilter = RelatedItemTypeFilter' (Maybe CommentFilter) (Maybe ContactFilter)
- newRelatedItemTypeFilter :: RelatedItemTypeFilter
- data RequiredField = RequiredField' Text
- newRequiredField :: Text -> RequiredField
- data SearchCasesResponseItem = SearchCasesResponseItem' (Maybe (HashMap Text Text)) Text [FieldValue] Text
- newSearchCasesResponseItem :: Text -> Text -> SearchCasesResponseItem
- data SearchRelatedItemsResponseItem = SearchRelatedItemsResponseItem' (Maybe (HashMap Text Text)) ISO8601 RelatedItemContent Text RelatedItemType
- newSearchRelatedItemsResponseItem :: UTCTime -> RelatedItemContent -> Text -> RelatedItemType -> SearchRelatedItemsResponseItem
- data Section = Section' (Maybe FieldGroup)
- newSection :: Section
- data Sort = Sort' Text Order
- newSort :: Text -> Order -> Sort
- data TemplateSummary = TemplateSummary' Text TemplateStatus Text Text
- newTemplateSummary :: Text -> TemplateStatus -> Text -> Text -> TemplateSummary
Service Configuration
defaultService :: Service Source #
API version 2022-10-03
of the Amazon Connect Cases SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ConnectCases
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
We couldn't process your request because of an issue with the server. Try again later.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The rate has been exceeded for this API. Please try again after a few minutes.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The request isn't valid. Check the syntax and try again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchGetField
data BatchGetField Source #
See: newBatchGetField
smart constructor.
Constructors
BatchGetField' Text (NonEmpty FieldIdentifier) |
Instances
Arguments
:: Text | |
-> NonEmpty FieldIdentifier | |
-> BatchGetField |
Create a value of BatchGetField
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchGetField
, batchGetField_domainId
- The unique identifier of the Cases domain.
BatchGetField
, batchGetField_fields
- A list of unique field identifiers.
data BatchGetFieldResponse Source #
See: newBatchGetFieldResponse
smart constructor.
Constructors
BatchGetFieldResponse' Int [FieldError] [GetFieldResponse] |
Instances
newBatchGetFieldResponse Source #
Create a value of BatchGetFieldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:BatchGetFieldResponse'
, batchGetFieldResponse_httpStatus
- The response's http status code.
$sel:errors:BatchGetFieldResponse'
, batchGetFieldResponse_errors
- A list of field errors.
BatchGetField
, batchGetFieldResponse_fields
- A list of detailed field information.
BatchPutFieldOptions
data BatchPutFieldOptions Source #
See: newBatchPutFieldOptions
smart constructor.
Constructors
BatchPutFieldOptions' Text Text [FieldOption] |
Instances
newBatchPutFieldOptions Source #
Arguments
:: Text | |
-> Text | |
-> BatchPutFieldOptions |
Create a value of BatchPutFieldOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchPutFieldOptions
, batchPutFieldOptions_domainId
- The unique identifier of the Cases domain.
BatchPutFieldOptions
, batchPutFieldOptions_fieldId
- The unique identifier of a field.
$sel:options:BatchPutFieldOptions'
, batchPutFieldOptions_options
- A list of FieldOption
objects.
data BatchPutFieldOptionsResponse Source #
See: newBatchPutFieldOptionsResponse
smart constructor.
Constructors
BatchPutFieldOptionsResponse' (Maybe [FieldOptionError]) Int |
Instances
newBatchPutFieldOptionsResponse Source #
Create a value of BatchPutFieldOptionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errors:BatchPutFieldOptionsResponse'
, batchPutFieldOptionsResponse_errors
- A list of field errors.
$sel:httpStatus:BatchPutFieldOptionsResponse'
, batchPutFieldOptionsResponse_httpStatus
- The response's http status code.
CreateCase
data CreateCase Source #
See: newCreateCase
smart constructor.
Constructors
CreateCase' (Maybe Text) Text [FieldValue] Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateCase |
Create a value of CreateCase
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateCase'
, createCase_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.
CreateCase
, createCase_domainId
- The unique identifier of the Cases domain.
CreateCase
, createCase_fields
- An array of objects with field ID (matching ListFields/DescribeField)
and value union data.
CreateCase
, createCase_templateId
- A unique identifier of a template.
data CreateCaseResponse Source #
See: newCreateCaseResponse
smart constructor.
Constructors
CreateCaseResponse' Int Text Text |
Instances
newCreateCaseResponse Source #
Arguments
:: Int | |
-> Text | |
-> Text | |
-> CreateCaseResponse |
Create a value of CreateCaseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateCaseResponse'
, createCaseResponse_httpStatus
- The response's http status code.
$sel:caseArn:CreateCaseResponse'
, createCaseResponse_caseArn
- The Amazon Resource Name (ARN) of the case.
CreateCaseResponse
, createCaseResponse_caseId
- A unique identifier of the case.
CreateDomain
data CreateDomain Source #
See: newCreateDomain
smart constructor.
Constructors
CreateDomain' Text |
Instances
Arguments
:: Text | |
-> CreateDomain |
Create a value of CreateDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDomain
, createDomain_name
- The name for your Cases domain. It must be unique for your Amazon Web
Services account.
data CreateDomainResponse Source #
See: newCreateDomainResponse
smart constructor.
Constructors
CreateDomainResponse' Int Text Text DomainStatus |
Instances
newCreateDomainResponse Source #
Arguments
:: Int | |
-> Text | |
-> Text | |
-> DomainStatus | |
-> CreateDomainResponse |
Create a value of CreateDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateDomainResponse'
, createDomainResponse_httpStatus
- The response's http status code.
CreateDomainResponse
, createDomainResponse_domainArn
- The Amazon Resource Name (ARN) for the Cases domain.
CreateDomainResponse
, createDomainResponse_domainId
- The unique identifier of the Cases domain.
$sel:domainStatus:CreateDomainResponse'
, createDomainResponse_domainStatus
- The status of the domain.
CreateField
data CreateField Source #
See: newCreateField
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> FieldType | |
-> CreateField |
Create a value of CreateField
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateField
, createField_description
- The description of the field.
CreateField
, createField_domainId
- The unique identifier of the Cases domain.
CreateField
, createField_name
- The name of the field.
CreateField
, createField_type
- Defines the data type, some system constraints, and default display of
the field.
data CreateFieldResponse Source #
See: newCreateFieldResponse
smart constructor.
Constructors
CreateFieldResponse' Int Text Text |
Instances
newCreateFieldResponse Source #
Arguments
:: Int | |
-> Text | |
-> Text | |
-> CreateFieldResponse |
Create a value of CreateFieldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateFieldResponse'
, createFieldResponse_httpStatus
- The response's http status code.
CreateFieldResponse
, createFieldResponse_fieldArn
- The Amazon Resource Name (ARN) of the field.
CreateFieldResponse
, createFieldResponse_fieldId
- The unique identifier of a field.
CreateLayout
data CreateLayout Source #
See: newCreateLayout
smart constructor.
Constructors
CreateLayout' LayoutContent Text Text |
Instances
Arguments
:: LayoutContent | |
-> Text | |
-> Text | |
-> CreateLayout |
Create a value of CreateLayout
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLayout
, createLayout_content
- Information about which fields will be present in the layout, and
information about the order of the fields.
CreateLayout
, createLayout_domainId
- The unique identifier of the Cases domain.
CreateLayout
, createLayout_name
- The name of the layout. It must be unique for the Cases domain.
data CreateLayoutResponse Source #
See: newCreateLayoutResponse
smart constructor.
Constructors
CreateLayoutResponse' Int Text Text |
Instances
newCreateLayoutResponse Source #
Arguments
:: Int | |
-> Text | |
-> Text | |
-> CreateLayoutResponse |
Create a value of CreateLayoutResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateLayoutResponse'
, createLayoutResponse_httpStatus
- The response's http status code.
CreateLayoutResponse
, createLayoutResponse_layoutArn
- The Amazon Resource Name (ARN) of the newly created layout.
CreateLayoutResponse
, createLayoutResponse_layoutId
- The unique identifier of the layout.
CreateRelatedItem
data CreateRelatedItem Source #
See: newCreateRelatedItem
smart constructor.
Constructors
CreateRelatedItem' Text RelatedItemInputContent Text RelatedItemType |
Instances
Arguments
:: Text | |
-> RelatedItemInputContent | |
-> Text | |
-> RelatedItemType | |
-> CreateRelatedItem |
Create a value of CreateRelatedItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateRelatedItem
, createRelatedItem_caseId
- A unique identifier of the case.
CreateRelatedItem
, createRelatedItem_content
- The content of a related item to be created.
CreateRelatedItem
, createRelatedItem_domainId
- The unique identifier of the Cases domain.
CreateRelatedItem
, createRelatedItem_type
- The type of a related item.
data CreateRelatedItemResponse Source #
See: newCreateRelatedItemResponse
smart constructor.
Constructors
CreateRelatedItemResponse' Int Text Text |
Instances
newCreateRelatedItemResponse Source #
Arguments
:: Int | |
-> Text | |
-> Text | |
-> CreateRelatedItemResponse |
Create a value of CreateRelatedItemResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateRelatedItemResponse'
, createRelatedItemResponse_httpStatus
- The response's http status code.
$sel:relatedItemArn:CreateRelatedItemResponse'
, createRelatedItemResponse_relatedItemArn
- The Amazon Resource Name (ARN) of the related item.
CreateRelatedItemResponse
, createRelatedItemResponse_relatedItemId
- The unique identifier of the related item.
CreateTemplate
data CreateTemplate Source #
See: newCreateTemplate
smart constructor.
Constructors
CreateTemplate' (Maybe Text) (Maybe LayoutConfiguration) (Maybe [RequiredField]) (Maybe TemplateStatus) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateTemplate |
Create a value of CreateTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateTemplate
, createTemplate_description
- A brief description of the template.
$sel:layoutConfiguration:CreateTemplate'
, createTemplate_layoutConfiguration
- Configuration of layouts associated to the template.
$sel:requiredFields:CreateTemplate'
, createTemplate_requiredFields
- A list of fields that must contain a value for a case to be successfully
created with this template.
CreateTemplate
, createTemplate_status
- The status of the template.
CreateTemplate
, createTemplate_domainId
- The unique identifier of the Cases domain.
CreateTemplate
, createTemplate_name
- A name for the template. It must be unique per domain.
data CreateTemplateResponse Source #
See: newCreateTemplateResponse
smart constructor.
Constructors
CreateTemplateResponse' Int Text Text |
Instances
newCreateTemplateResponse Source #
Arguments
:: Int | |
-> Text | |
-> Text | |
-> CreateTemplateResponse |
Create a value of CreateTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateTemplateResponse'
, createTemplateResponse_httpStatus
- The response's http status code.
CreateTemplateResponse
, createTemplateResponse_templateArn
- The Amazon Resource Name (ARN) of the newly created template.
CreateTemplateResponse
, createTemplateResponse_templateId
- A unique identifier of a template.
GetCase
See: newGetCase
smart constructor.
Instances
Create a value of GetCase
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCase
, getCase_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
GetCase
, getCase_caseId
- A unique identifier of the case.
GetCase
, getCase_domainId
- The unique identifier of the Cases domain.
GetCase
, getCase_fields
- A list of unique field identifiers.
data GetCaseResponse Source #
See: newGetCaseResponse
smart constructor.
Constructors
GetCaseResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int [FieldValue] Text |
Instances
Arguments
:: Int | |
-> Text | |
-> GetCaseResponse |
Create a value of GetCaseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCase
, getCaseResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
GetCaseResponse
, getCaseResponse_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:httpStatus:GetCaseResponse'
, getCaseResponse_httpStatus
- The response's http status code.
GetCase
, getCaseResponse_fields
- A list of detailed field information.
GetCaseResponse
, getCaseResponse_templateId
- A unique identifier of a template.
GetCaseEventConfiguration
data GetCaseEventConfiguration Source #
See: newGetCaseEventConfiguration
smart constructor.
Constructors
GetCaseEventConfiguration' Text |
Instances
newGetCaseEventConfiguration Source #
Arguments
:: Text | |
-> GetCaseEventConfiguration |
Create a value of GetCaseEventConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetCaseEventConfiguration
, getCaseEventConfiguration_domainId
- The unique identifier of the Cases domain.
data GetCaseEventConfigurationResponse Source #
See: newGetCaseEventConfigurationResponse
smart constructor.
Instances
newGetCaseEventConfigurationResponse Source #
Arguments
:: Int | |
-> EventBridgeConfiguration | |
-> GetCaseEventConfigurationResponse |
Create a value of GetCaseEventConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetCaseEventConfigurationResponse'
, getCaseEventConfigurationResponse_httpStatus
- The response's http status code.
$sel:eventBridge:GetCaseEventConfigurationResponse'
, getCaseEventConfigurationResponse_eventBridge
- Configuration to enable EventBridge case event delivery and determine
what data is delivered.
GetDomain
See: newGetDomain
smart constructor.
Constructors
GetDomain' Text |
Instances
Create a value of GetDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDomain
, getDomain_domainId
- The unique identifier of the Cases domain.
data GetDomainResponse Source #
See: newGetDomainResponse
smart constructor.
Instances
Arguments
:: Int | |
-> UTCTime | |
-> Text | |
-> Text | |
-> DomainStatus | |
-> Text | |
-> GetDomainResponse |
Create a value of GetDomainResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDomainResponse
, getDomainResponse_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:httpStatus:GetDomainResponse'
, getDomainResponse_httpStatus
- The response's http status code.
$sel:createdTime:GetDomainResponse'
, getDomainResponse_createdTime
- The timestamp when the Cases domain was created.
GetDomainResponse
, getDomainResponse_domainArn
- The Amazon Resource Name (ARN) for the Cases domain.
GetDomain
, getDomainResponse_domainId
- The unique identifier of the Cases domain.
$sel:domainStatus:GetDomainResponse'
, getDomainResponse_domainStatus
- The status of the Cases domain.
GetDomainResponse
, getDomainResponse_name
- The name of the Cases domain.
GetLayout
See: newGetLayout
smart constructor.
Constructors
GetLayout' Text Text |
Instances
Create a value of GetLayout
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetLayout
, getLayout_domainId
- The unique identifier of the Cases domain.
GetLayout
, getLayout_layoutId
- The unique identifier of the layout.
data GetLayoutResponse Source #
See: newGetLayoutResponse
smart constructor.
Constructors
GetLayoutResponse' (Maybe (HashMap Text Text)) Int LayoutContent Text Text Text |
Instances
Arguments
:: Int | |
-> LayoutContent | |
-> Text | |
-> Text | |
-> Text | |
-> GetLayoutResponse |
Create a value of GetLayoutResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetLayoutResponse
, getLayoutResponse_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:httpStatus:GetLayoutResponse'
, getLayoutResponse_httpStatus
- The response's http status code.
GetLayoutResponse
, getLayoutResponse_content
- Information about which fields will be present in the layout, the order
of the fields, and read-only attribute of the field.
GetLayoutResponse
, getLayoutResponse_layoutArn
- The Amazon Resource Name (ARN) of the newly created layout.
GetLayout
, getLayoutResponse_layoutId
- The unique identifier of the layout.
GetLayoutResponse
, getLayoutResponse_name
- The name of the layout. It must be unique.
GetTemplate
data GetTemplate Source #
See: newGetTemplate
smart constructor.
Constructors
GetTemplate' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> GetTemplate |
Create a value of GetTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTemplate
, getTemplate_domainId
- The unique identifier of the Cases domain.
GetTemplate
, getTemplate_templateId
- A unique identifier of a template.
data GetTemplateResponse Source #
See: newGetTemplateResponse
smart constructor.
Constructors
GetTemplateResponse' (Maybe Text) (Maybe LayoutConfiguration) (Maybe [RequiredField]) (Maybe (HashMap Text Text)) Int Text TemplateStatus Text Text |
Instances
newGetTemplateResponse Source #
Arguments
:: Int | |
-> Text | |
-> TemplateStatus | |
-> Text | |
-> Text | |
-> GetTemplateResponse |
Create a value of GetTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTemplateResponse
, getTemplateResponse_description
- A brief description of the template.
$sel:layoutConfiguration:GetTemplateResponse'
, getTemplateResponse_layoutConfiguration
- Configuration of layouts associated to the template.
$sel:requiredFields:GetTemplateResponse'
, getTemplateResponse_requiredFields
- A list of fields that must contain a value for a case to be successfully
created with this template.
GetTemplateResponse
, getTemplateResponse_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:httpStatus:GetTemplateResponse'
, getTemplateResponse_httpStatus
- The response's http status code.
GetTemplateResponse
, getTemplateResponse_name
- The name of the template.
GetTemplateResponse
, getTemplateResponse_status
- The status of the template.
GetTemplateResponse
, getTemplateResponse_templateArn
- The Amazon Resource Name (ARN) of the template.
GetTemplate
, getTemplateResponse_templateId
- A unique identifier of a template.
ListCasesForContact
data ListCasesForContact Source #
See: newListCasesForContact
smart constructor.
Instances
newListCasesForContact Source #
Arguments
:: Text | |
-> Text | |
-> ListCasesForContact |
Create a value of ListCasesForContact
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListCasesForContact'
, listCasesForContact_maxResults
- The maximum number of results to return per page.
ListCasesForContact
, listCasesForContact_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
ListCasesForContact
, listCasesForContact_contactArn
- A unique identifier of a contact in Amazon Connect.
ListCasesForContact
, listCasesForContact_domainId
- The unique identifier of the Cases domain.
data ListCasesForContactResponse Source #
See: newListCasesForContactResponse
smart constructor.
Constructors
ListCasesForContactResponse' (Maybe Text) Int [CaseSummary] |
Instances
newListCasesForContactResponse Source #
Create a value of ListCasesForContactResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListCasesForContact
, listCasesForContactResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:ListCasesForContactResponse'
, listCasesForContactResponse_httpStatus
- The response's http status code.
$sel:cases:ListCasesForContactResponse'
, listCasesForContactResponse_cases
- A list of Case summary information.
ListDomains
data ListDomains Source #
See: newListDomains
smart constructor.
Constructors
ListDomains' (Maybe Natural) (Maybe Text) |
Instances
newListDomains :: ListDomains Source #
Create a value of ListDomains
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDomains'
, listDomains_maxResults
- The maximum number of results to return per page.
ListDomains
, listDomains_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
data ListDomainsResponse Source #
See: newListDomainsResponse
smart constructor.
Constructors
ListDomainsResponse' (Maybe Text) Int [DomainSummary] |
Instances
newListDomainsResponse Source #
Arguments
:: Int | |
-> ListDomainsResponse |
Create a value of ListDomainsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDomains
, listDomainsResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:ListDomainsResponse'
, listDomainsResponse_httpStatus
- The response's http status code.
$sel:domains:ListDomainsResponse'
, listDomainsResponse_domains
- The Cases domain.
ListFieldOptions
data ListFieldOptions Source #
See: newListFieldOptions
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> ListFieldOptions |
Create a value of ListFieldOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListFieldOptions'
, listFieldOptions_maxResults
- The maximum number of results to return per page.
ListFieldOptions
, listFieldOptions_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:values:ListFieldOptions'
, listFieldOptions_values
- A list of FieldOption
values to filter on for ListFieldOptions
.
ListFieldOptions
, listFieldOptions_domainId
- The unique identifier of the Cases domain.
ListFieldOptions
, listFieldOptions_fieldId
- The unique identifier of a field.
data ListFieldOptionsResponse Source #
See: newListFieldOptionsResponse
smart constructor.
Constructors
ListFieldOptionsResponse' (Maybe Text) Int [FieldOption] |
Instances
newListFieldOptionsResponse Source #
Create a value of ListFieldOptionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListFieldOptions
, listFieldOptionsResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:ListFieldOptionsResponse'
, listFieldOptionsResponse_httpStatus
- The response's http status code.
$sel:options:ListFieldOptionsResponse'
, listFieldOptionsResponse_options
- A list of FieldOption
objects.
ListFields
data ListFields Source #
See: newListFields
smart constructor.
Instances
Arguments
:: Text | |
-> ListFields |
Create a value of ListFields
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListFields'
, listFields_maxResults
- The maximum number of results to return per page.
ListFields
, listFields_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
ListFields
, listFields_domainId
- The unique identifier of the Cases domain.
data ListFieldsResponse Source #
See: newListFieldsResponse
smart constructor.
Constructors
ListFieldsResponse' (Maybe Text) Int [FieldSummary] |
Instances
newListFieldsResponse Source #
Arguments
:: Int | |
-> ListFieldsResponse |
Create a value of ListFieldsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListFields
, listFieldsResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:ListFieldsResponse'
, listFieldsResponse_httpStatus
- The response's http status code.
ListFieldsResponse
, listFieldsResponse_fields
- List of detailed field information.
ListLayouts
data ListLayouts Source #
See: newListLayouts
smart constructor.
Instances
Arguments
:: Text | |
-> ListLayouts |
Create a value of ListLayouts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListLayouts'
, listLayouts_maxResults
- The maximum number of results to return per page.
ListLayouts
, listLayouts_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
ListLayouts
, listLayouts_domainId
- The unique identifier of the Cases domain.
data ListLayoutsResponse Source #
See: newListLayoutsResponse
smart constructor.
Constructors
ListLayoutsResponse' (Maybe Text) Int [LayoutSummary] |
Instances
newListLayoutsResponse Source #
Arguments
:: Int | |
-> ListLayoutsResponse |
Create a value of ListLayoutsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListLayouts
, listLayoutsResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:ListLayoutsResponse'
, listLayoutsResponse_httpStatus
- The response's http status code.
$sel:layouts:ListLayoutsResponse'
, listLayoutsResponse_layouts
- The layouts for the domain.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Constructors
ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
:: Text | |
-> ListTagsForResource |
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ListTagsForResource'
, listTagsForResource_arn
- The Amazon Resource Name (ARN)
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListTemplates
data ListTemplates Source #
See: newListTemplates
smart constructor.
Constructors
ListTemplates' (Maybe Natural) (Maybe Text) (Maybe (NonEmpty TemplateStatus)) Text |
Instances
Arguments
:: Text | |
-> ListTemplates |
Create a value of ListTemplates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTemplates'
, listTemplates_maxResults
- The maximum number of results to return per page.
ListTemplates
, listTemplates_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
ListTemplates
, listTemplates_status
- A list of status values to filter on.
ListTemplates
, listTemplates_domainId
- The unique identifier of the Cases domain.
data ListTemplatesResponse Source #
See: newListTemplatesResponse
smart constructor.
Constructors
ListTemplatesResponse' (Maybe Text) Int [TemplateSummary] |
Instances
newListTemplatesResponse Source #
Create a value of ListTemplatesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTemplates
, listTemplatesResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:ListTemplatesResponse'
, listTemplatesResponse_httpStatus
- The response's http status code.
$sel:templates:ListTemplatesResponse'
, listTemplatesResponse_templates
- List of template summary objects.
PutCaseEventConfiguration
data PutCaseEventConfiguration Source #
See: newPutCaseEventConfiguration
smart constructor.
Constructors
PutCaseEventConfiguration' Text EventBridgeConfiguration |
Instances
newPutCaseEventConfiguration Source #
Arguments
:: Text | |
-> EventBridgeConfiguration | |
-> PutCaseEventConfiguration |
Create a value of PutCaseEventConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutCaseEventConfiguration
, putCaseEventConfiguration_domainId
- The unique identifier of the Cases domain.
$sel:eventBridge:PutCaseEventConfiguration'
, putCaseEventConfiguration_eventBridge
- Configuration to enable EventBridge case event delivery and determine
what data is delivered.
data PutCaseEventConfigurationResponse Source #
See: newPutCaseEventConfigurationResponse
smart constructor.
Constructors
PutCaseEventConfigurationResponse' Int |
Instances
newPutCaseEventConfigurationResponse Source #
Arguments
:: Int | |
-> PutCaseEventConfigurationResponse |
Create a value of PutCaseEventConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PutCaseEventConfigurationResponse'
, putCaseEventConfigurationResponse_httpStatus
- The response's http status code.
SearchCases (Paginated)
data SearchCases Source #
See: newSearchCases
smart constructor.
Constructors
SearchCases' (Maybe [FieldIdentifier]) (Maybe CaseFilter) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe [Sort]) Text |
Instances
Arguments
:: Text | |
-> SearchCases |
Create a value of SearchCases
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchCases
, searchCases_fields
- The list of field identifiers to be returned as part of the response.
$sel:filter':SearchCases'
, searchCases_filter
- A list of filter objects.
$sel:maxResults:SearchCases'
, searchCases_maxResults
- The maximum number of cases to return. The current maximum supported
value is 25. This is also the default value when no other value is
provided.
SearchCases
, searchCases_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
$sel:searchTerm:SearchCases'
, searchCases_searchTerm
- A word or phrase used to perform a quick search.
$sel:sorts:SearchCases'
, searchCases_sorts
- A list of sorts where each sort specifies a field and their sort order
to be applied to the results.
SearchCases
, searchCases_domainId
- The unique identifier of the Cases domain.
data SearchCasesResponse Source #
See: newSearchCasesResponse
smart constructor.
Constructors
SearchCasesResponse' (Maybe Text) Int [SearchCasesResponseItem] |
Instances
newSearchCasesResponse Source #
Arguments
:: Int | |
-> SearchCasesResponse |
Create a value of SearchCasesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchCases
, searchCasesResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:SearchCasesResponse'
, searchCasesResponse_httpStatus
- The response's http status code.
$sel:cases:SearchCasesResponse'
, searchCasesResponse_cases
- A list of case documents where each case contains the properties
CaseId
and Fields
where each field is a complex union structure.
SearchRelatedItems (Paginated)
data SearchRelatedItems Source #
See: newSearchRelatedItems
smart constructor.
Constructors
SearchRelatedItems' (Maybe [RelatedItemTypeFilter]) (Maybe Natural) (Maybe Text) Text Text |
Instances
newSearchRelatedItems Source #
Arguments
:: Text | |
-> Text | |
-> SearchRelatedItems |
Create a value of SearchRelatedItems
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:SearchRelatedItems'
, searchRelatedItems_filters
- The list of types of related items and their parameters to use for
filtering.
$sel:maxResults:SearchRelatedItems'
, searchRelatedItems_maxResults
- The maximum number of results to return per page.
SearchRelatedItems
, searchRelatedItems_nextToken
- The token for the next set of results. Use the value returned in the
previous response in the next request to retrieve the next set of
results.
SearchRelatedItems
, searchRelatedItems_caseId
- A unique identifier of the case.
SearchRelatedItems
, searchRelatedItems_domainId
- The unique identifier of the Cases domain.
data SearchRelatedItemsResponse Source #
See: newSearchRelatedItemsResponse
smart constructor.
Constructors
SearchRelatedItemsResponse' (Maybe Text) Int [SearchRelatedItemsResponseItem] |
Instances
newSearchRelatedItemsResponse Source #
Create a value of SearchRelatedItemsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchRelatedItems
, searchRelatedItemsResponse_nextToken
- The token for the next set of results. This is null if there are no more
results to return.
$sel:httpStatus:SearchRelatedItemsResponse'
, searchRelatedItemsResponse_httpStatus
- The response's http status code.
$sel:relatedItems:SearchRelatedItemsResponse'
, searchRelatedItemsResponse_relatedItems
- A list of items related to a case.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Constructors
TagResource' Text (HashMap Text Text) |
Instances
Arguments
:: Text | |
-> TagResource |
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:TagResource'
, tagResource_arn
- The Amazon Resource Name (ARN)
TagResource
, tagResource_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Constructors
TagResourceResponse' | |
Instances
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Constructors
UntagResource' Text [Text] |
Instances
Arguments
:: Text | |
-> UntagResource |
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:UntagResource'
, untagResource_arn
- The Amazon Resource Name (ARN)
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- List of tag keys.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Constructors
UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateCase
data UpdateCase Source #
See: newUpdateCase
smart constructor.
Constructors
UpdateCase' Text Text [FieldValue] |
Instances
Arguments
:: Text | |
-> Text | |
-> UpdateCase |
Create a value of UpdateCase
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateCase
, updateCase_caseId
- A unique identifier of the case.
UpdateCase
, updateCase_domainId
- The unique identifier of the Cases domain.
UpdateCase
, updateCase_fields
- An array of objects with fieldId
(matching ListFields/DescribeField)
and value union data, structured identical to CreateCase
.
data UpdateCaseResponse Source #
See: newUpdateCaseResponse
smart constructor.
Constructors
UpdateCaseResponse' Int |
Instances
newUpdateCaseResponse Source #
Arguments
:: Int | |
-> UpdateCaseResponse |
Create a value of UpdateCaseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateCaseResponse'
, updateCaseResponse_httpStatus
- The response's http status code.
UpdateField
data UpdateField Source #
See: newUpdateField
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> UpdateField |
Create a value of UpdateField
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateField
, updateField_description
- The description of a field.
UpdateField
, updateField_name
- The name of the field.
UpdateField
, updateField_domainId
- The unique identifier of the Cases domain.
UpdateField
, updateField_fieldId
- The unique identifier of a field.
data UpdateFieldResponse Source #
See: newUpdateFieldResponse
smart constructor.
Constructors
UpdateFieldResponse' Int |
Instances
newUpdateFieldResponse Source #
Arguments
:: Int | |
-> UpdateFieldResponse |
Create a value of UpdateFieldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateFieldResponse'
, updateFieldResponse_httpStatus
- The response's http status code.
UpdateLayout
data UpdateLayout Source #
See: newUpdateLayout
smart constructor.
Constructors
UpdateLayout' (Maybe LayoutContent) (Maybe Text) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> UpdateLayout |
Create a value of UpdateLayout
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateLayout
, updateLayout_content
- Information about which fields will be present in the layout, the order
of the fields, and a read-only attribute of the field.
UpdateLayout
, updateLayout_name
- The name of the layout. It must be unique per domain.
UpdateLayout
, updateLayout_domainId
- The unique identifier of the Cases domain.
UpdateLayout
, updateLayout_layoutId
- The unique identifier of the layout.
data UpdateLayoutResponse Source #
See: newUpdateLayoutResponse
smart constructor.
Constructors
UpdateLayoutResponse' Int |
Instances
newUpdateLayoutResponse Source #
Arguments
:: Int | |
-> UpdateLayoutResponse |
Create a value of UpdateLayoutResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateLayoutResponse'
, updateLayoutResponse_httpStatus
- The response's http status code.
UpdateTemplate
data UpdateTemplate Source #
See: newUpdateTemplate
smart constructor.
Constructors
UpdateTemplate' (Maybe Text) (Maybe LayoutConfiguration) (Maybe Text) (Maybe [RequiredField]) (Maybe TemplateStatus) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> UpdateTemplate |
Create a value of UpdateTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateTemplate
, updateTemplate_description
- A brief description of the template.
$sel:layoutConfiguration:UpdateTemplate'
, updateTemplate_layoutConfiguration
- Configuration of layouts associated to the template.
UpdateTemplate
, updateTemplate_name
- The name of the template. It must be unique per domain.
$sel:requiredFields:UpdateTemplate'
, updateTemplate_requiredFields
- A list of fields that must contain a value for a case to be successfully
created with this template.
UpdateTemplate
, updateTemplate_status
- The status of the template.
UpdateTemplate
, updateTemplate_domainId
- The unique identifier of the Cases domain.
UpdateTemplate
, updateTemplate_templateId
- A unique identifier for the template.
data UpdateTemplateResponse Source #
See: newUpdateTemplateResponse
smart constructor.
Constructors
UpdateTemplateResponse' Int |
Instances
newUpdateTemplateResponse Source #
Create a value of UpdateTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateTemplateResponse'
, updateTemplateResponse_httpStatus
- The response's http status code.
Types
CommentBodyTextType
newtype CommentBodyTextType Source #
Constructors
CommentBodyTextType' | |
Fields |
Bundled Patterns
pattern CommentBodyTextType_Text_Plain :: CommentBodyTextType |
Instances
DomainStatus
newtype DomainStatus Source #
Constructors
DomainStatus' | |
Fields |
Bundled Patterns
pattern DomainStatus_Active :: DomainStatus | |
pattern DomainStatus_CreationFailed :: DomainStatus | |
pattern DomainStatus_CreationInProgress :: DomainStatus |
Instances
FieldNamespace
newtype FieldNamespace Source #
Constructors
FieldNamespace' | |
Fields |
Bundled Patterns
pattern FieldNamespace_Custom :: FieldNamespace | |
pattern FieldNamespace_System :: FieldNamespace |
Instances
FieldType
Constructors
FieldType' | |
Fields |
Bundled Patterns
pattern FieldType_Boolean :: FieldType | |
pattern FieldType_DateTime :: FieldType | |
pattern FieldType_Number :: FieldType | |
pattern FieldType_SingleSelect :: FieldType | |
pattern FieldType_Text :: FieldType |
Instances
Order
Bundled Patterns
pattern Order_Asc :: Order | |
pattern Order_Desc :: Order |
Instances
RelatedItemType
newtype RelatedItemType Source #
Constructors
RelatedItemType' | |
Fields |
Bundled Patterns
pattern RelatedItemType_Comment :: RelatedItemType | |
pattern RelatedItemType_Contact :: RelatedItemType |
Instances
TemplateStatus
newtype TemplateStatus Source #
Status of a template
Constructors
TemplateStatus' | |
Fields |
Bundled Patterns
pattern TemplateStatus_Active :: TemplateStatus | |
pattern TemplateStatus_Inactive :: TemplateStatus |
Instances
BasicLayout
data BasicLayout Source #
Content specific to BasicLayout
type. It configures fields in the top
panel and More Info tab of agent application.
See: newBasicLayout
smart constructor.
Constructors
BasicLayout' (Maybe LayoutSections) (Maybe LayoutSections) |
Instances
newBasicLayout :: BasicLayout Source #
Create a value of BasicLayout
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:moreInfo:BasicLayout'
, basicLayout_moreInfo
- This represents sections in a tab of the page layout.
$sel:topPanel:BasicLayout'
, basicLayout_topPanel
- This represents sections in a panel of the page layout.
CaseEventIncludedData
data CaseEventIncludedData Source #
Details of what case data is published through the case event stream.
See: newCaseEventIncludedData
smart constructor.
Constructors
CaseEventIncludedData' [FieldIdentifier] |
Instances
newCaseEventIncludedData :: CaseEventIncludedData Source #
Create a value of CaseEventIncludedData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fields:CaseEventIncludedData'
, caseEventIncludedData_fields
- List of field identifiers.
CaseFilter
data CaseFilter Source #
A filter for cases. Only one value can be provided.
See: newCaseFilter
smart constructor.
Constructors
CaseFilter' (Maybe [CaseFilter]) (Maybe FieldFilter) (Maybe CaseFilter) |
Instances
newCaseFilter :: CaseFilter Source #
Create a value of CaseFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:andAll:CaseFilter'
, caseFilter_andAll
- Provides "and all" filtering.
$sel:field:CaseFilter'
, caseFilter_field
- A list of fields to filter on.
$sel:not:CaseFilter'
, caseFilter_not
- Undocumented member.
CaseSummary
data CaseSummary Source #
Case summary information.
See: newCaseSummary
smart constructor.
Constructors
CaseSummary' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CaseSummary |
Create a value of CaseSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:caseId:CaseSummary'
, caseSummary_caseId
- A unique identifier of the case.
$sel:templateId:CaseSummary'
, caseSummary_templateId
- A unique identifier of a template.
CommentContent
data CommentContent Source #
Represents the content of a Comment
to be returned to agents.
See: newCommentContent
smart constructor.
Constructors
CommentContent' Text CommentBodyTextType |
Instances
Arguments
:: Text | |
-> CommentBodyTextType | |
-> CommentContent |
Create a value of CommentContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:body:CommentContent'
, commentContent_body
- Text in the body of a Comment
on a case.
$sel:contentType:CommentContent'
, commentContent_contentType
- Type of the text in the box of a Comment
on a case.
CommentFilter
data CommentFilter Source #
A filter for related items of type Comment
.
See: newCommentFilter
smart constructor.
Constructors
CommentFilter' | |
Instances
newCommentFilter :: CommentFilter Source #
Create a value of CommentFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Contact
An object that represents an Amazon Connect contact object.
See: newContact
smart constructor.
Instances
ToJSON Contact Source # | |
Defined in Amazonka.ConnectCases.Types.Contact | |
Generic Contact Source # | |
Read Contact Source # | |
Show Contact Source # | |
NFData Contact Source # | |
Defined in Amazonka.ConnectCases.Types.Contact | |
Eq Contact Source # | |
Hashable Contact Source # | |
Defined in Amazonka.ConnectCases.Types.Contact | |
type Rep Contact Source # | |
Defined in Amazonka.ConnectCases.Types.Contact |
Create a value of Contact
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contactArn:Contact'
, contact_contactArn
- A unique identifier of a contact in Amazon Connect.
ContactContent
data ContactContent Source #
An object that represents a content of an Amazon Connect contact object.
See: newContactContent
smart constructor.
Constructors
ContactContent' Text ISO8601 Text |
Instances
Arguments
:: Text | |
-> UTCTime | |
-> Text | |
-> ContactContent |
Create a value of ContactContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channel:ContactContent'
, contactContent_channel
- A list of channels to filter on for related items of type Contact
.
$sel:connectedToSystemTime:ContactContent'
, contactContent_connectedToSystemTime
- The difference between the InitiationTimestamp
and the
DisconnectTimestamp
of the contact.
$sel:contactArn:ContactContent'
, contactContent_contactArn
- A unique identifier of a contact in Amazon Connect.
ContactFilter
data ContactFilter Source #
A filter for related items of type Contact
.
See: newContactFilter
smart constructor.
Constructors
ContactFilter' (Maybe [Text]) (Maybe Text) |
Instances
newContactFilter :: ContactFilter Source #
Create a value of ContactFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:channel:ContactFilter'
, contactFilter_channel
- A list of channels to filter on for related items of type Contact
.
$sel:contactArn:ContactFilter'
, contactFilter_contactArn
- A unique identifier of a contact in Amazon Connect.
DomainSummary
data DomainSummary Source #
Object for the summarized details of the domain.
See: newDomainSummary
smart constructor.
Constructors
DomainSummary' Text Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> DomainSummary |
Create a value of DomainSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainArn:DomainSummary'
, domainSummary_domainArn
- The Amazon Resource Name (ARN) of the domain.
$sel:domainId:DomainSummary'
, domainSummary_domainId
- The unique identifier of the domain.
$sel:name:DomainSummary'
, domainSummary_name
- The name of the domain.
EventBridgeConfiguration
data EventBridgeConfiguration Source #
Configuration to enable EventBridge case event delivery and determine what data is delivered.
See: newEventBridgeConfiguration
smart constructor.
Constructors
EventBridgeConfiguration' (Maybe EventIncludedData) Bool |
Instances
newEventBridgeConfiguration Source #
Create a value of EventBridgeConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includedData:EventBridgeConfiguration'
, eventBridgeConfiguration_includedData
- Details of what case and related item data is published through the case
event stream.
$sel:enabled:EventBridgeConfiguration'
, eventBridgeConfiguration_enabled
- Indicates whether the to broadcast case event data to the customer.
EventIncludedData
data EventIncludedData Source #
Details of what case and related item data is published through the case event stream.
See: newEventIncludedData
smart constructor.
Constructors
EventIncludedData' (Maybe CaseEventIncludedData) (Maybe RelatedItemEventIncludedData) |
Instances
newEventIncludedData :: EventIncludedData Source #
Create a value of EventIncludedData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:caseData:EventIncludedData'
, eventIncludedData_caseData
- Details of what case data is published through the case event stream.
$sel:relatedItemData:EventIncludedData'
, eventIncludedData_relatedItemData
- Details of what related item data is published through the case event
stream.
FieldError
data FieldError Source #
Object for errors on fields.
See: newFieldError
smart constructor.
Constructors
FieldError' (Maybe Text) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> FieldError |
Create a value of FieldError
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:FieldError'
, fieldError_message
- The error message from getting a field.
$sel:errorCode:FieldError'
, fieldError_errorCode
- The error code from getting a field.
$sel:id:FieldError'
, fieldError_id
- The field identifier that caused the error.
FieldFilter
data FieldFilter Source #
A filter for fields. Only one value can be provided.
See: newFieldFilter
smart constructor.
Constructors
FieldFilter' (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue) (Maybe FieldValue) |
Instances
newFieldFilter :: FieldFilter Source #
Create a value of FieldFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contains:FieldFilter'
, fieldFilter_contains
- Object containing field identifier and value information.
$sel:equalTo:FieldFilter'
, fieldFilter_equalTo
- Object containing field identifier and value information.
$sel:greaterThan:FieldFilter'
, fieldFilter_greaterThan
- Object containing field identifier and value information.
$sel:greaterThanOrEqualTo:FieldFilter'
, fieldFilter_greaterThanOrEqualTo
- Object containing field identifier and value information.
$sel:lessThan:FieldFilter'
, fieldFilter_lessThan
- Object containing field identifier and value information.
$sel:lessThanOrEqualTo:FieldFilter'
, fieldFilter_lessThanOrEqualTo
- Object containing field identifier and value information.
FieldGroup
data FieldGroup Source #
Object for a group of fields and associated properties.
See: newFieldGroup
smart constructor.
Constructors
FieldGroup' (Maybe Text) [FieldItem] |
Instances
newFieldGroup :: FieldGroup Source #
Create a value of FieldGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:FieldGroup'
, fieldGroup_name
- Name of the field group.
$sel:fields:FieldGroup'
, fieldGroup_fields
- Represents an ordered list containing field related information.
FieldIdentifier
data FieldIdentifier Source #
Object for unique identifier of a field.
See: newFieldIdentifier
smart constructor.
Constructors
FieldIdentifier' Text |
Instances
Arguments
:: Text | |
-> FieldIdentifier |
Create a value of FieldIdentifier
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:FieldIdentifier'
, fieldIdentifier_id
- Unique identifier of a field.
FieldItem
Object for field related information.
See: newFieldItem
smart constructor.
Constructors
FieldItem' Text |
Instances
FromJSON FieldItem Source # | |
ToJSON FieldItem Source # | |
Defined in Amazonka.ConnectCases.Types.FieldItem | |
Generic FieldItem Source # | |
Read FieldItem Source # | |
Show FieldItem Source # | |
NFData FieldItem Source # | |
Defined in Amazonka.ConnectCases.Types.FieldItem | |
Eq FieldItem Source # | |
Hashable FieldItem Source # | |
Defined in Amazonka.ConnectCases.Types.FieldItem | |
type Rep FieldItem Source # | |
Defined in Amazonka.ConnectCases.Types.FieldItem |
Create a value of FieldItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:FieldItem'
, fieldItem_id
- Unique identifier of a field.
FieldOption
data FieldOption Source #
Object for field Options information.
See: newFieldOption
smart constructor.
Constructors
FieldOption' Bool Text Text |
Instances
Arguments
:: Bool | |
-> Text | |
-> Text | |
-> FieldOption |
Create a value of FieldOption
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:active:FieldOption'
, fieldOption_active
- Describes whether the FieldOption
is active (displayed) or inactive.
$sel:name:FieldOption'
, fieldOption_name
- FieldOptionName
has max length 100 and disallows trailing spaces.
$sel:value:FieldOption'
, fieldOption_value
- FieldOptionValue
has max length 100 and must be alphanumeric with
hyphens and underscores.
FieldOptionError
data FieldOptionError Source #
Object for field Options errors.
See: newFieldOptionError
smart constructor.
Constructors
FieldOptionError' Text Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> FieldOptionError |
Create a value of FieldOptionError
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:FieldOptionError'
, fieldOptionError_errorCode
- Error code from creating or updating field option.
$sel:message:FieldOptionError'
, fieldOptionError_message
- Error message from creating or updating field option.
$sel:value:FieldOptionError'
, fieldOptionError_value
- The field option value that caused the error.
FieldSummary
data FieldSummary Source #
Object for the summarized details of the field.
See: newFieldSummary
smart constructor.
Constructors
FieldSummary' Text Text Text FieldNamespace FieldType |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> FieldNamespace | |
-> FieldType | |
-> FieldSummary |
Create a value of FieldSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldArn:FieldSummary'
, fieldSummary_fieldArn
- The Amazon Resource Name (ARN) of the field.
$sel:fieldId:FieldSummary'
, fieldSummary_fieldId
- The unique identifier of a field.
$sel:name:FieldSummary'
, fieldSummary_name
- Name of the field.
$sel:namespace:FieldSummary'
, fieldSummary_namespace
- The namespace of a field.
$sel:type':FieldSummary'
, fieldSummary_type
- The type of a field.
FieldValue
data FieldValue Source #
Object for case field values.
See: newFieldValue
smart constructor.
Constructors
FieldValue' Text FieldValueUnion |
Instances
Arguments
:: Text | |
-> FieldValueUnion | |
-> FieldValue |
Create a value of FieldValue
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:FieldValue'
, fieldValue_id
- Unique identifier of a field.
$sel:value:FieldValue'
, fieldValue_value
- Union of potential field value types.
FieldValueUnion
data FieldValueUnion Source #
Object to store union of Field values.
See: newFieldValueUnion
smart constructor.
Instances
newFieldValueUnion :: FieldValueUnion Source #
Create a value of FieldValueUnion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:booleanValue:FieldValueUnion'
, fieldValueUnion_booleanValue
- Can be either null, or have a Boolean value type. Only one value can be
provided.
$sel:doubleValue:FieldValueUnion'
, fieldValueUnion_doubleValue
- Can be either null, or have a Double number value type. Only one value
can be provided.
$sel:stringValue:FieldValueUnion'
, fieldValueUnion_stringValue
- String value type.
GetFieldResponse
data GetFieldResponse Source #
Object to store detailed field information.
See: newGetFieldResponse
smart constructor.
Constructors
GetFieldResponse' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text FieldNamespace FieldType |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> FieldNamespace | |
-> FieldType | |
-> GetFieldResponse |
Create a value of GetFieldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:GetFieldResponse'
, getFieldResponse_description
- Description of the field.
$sel:tags:GetFieldResponse'
, getFieldResponse_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:fieldArn:GetFieldResponse'
, getFieldResponse_fieldArn
- The Amazon Resource Name (ARN) of the field.
$sel:fieldId:GetFieldResponse'
, getFieldResponse_fieldId
- Unique identifier of the field.
$sel:name:GetFieldResponse'
, getFieldResponse_name
- Name of the field.
$sel:namespace:GetFieldResponse'
, getFieldResponse_namespace
- Namespace of the field.
$sel:type':GetFieldResponse'
, getFieldResponse_type
- Type of the field.
LayoutConfiguration
data LayoutConfiguration Source #
Object to store configuration of layouts associated to the template.
See: newLayoutConfiguration
smart constructor.
Constructors
LayoutConfiguration' (Maybe Text) |
Instances
newLayoutConfiguration :: LayoutConfiguration Source #
Create a value of LayoutConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultLayout:LayoutConfiguration'
, layoutConfiguration_defaultLayout
- Unique identifier of a layout.
LayoutContent
data LayoutContent Source #
Object to store union of different versions of layout content.
See: newLayoutContent
smart constructor.
Constructors
LayoutContent' (Maybe BasicLayout) |
Instances
newLayoutContent :: LayoutContent Source #
Create a value of LayoutContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:basic:LayoutContent'
, layoutContent_basic
- Content specific to BasicLayout
type. It configures fields in the top
panel and More Info tab of Cases user interface.
LayoutSections
data LayoutSections Source #
Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.
See: newLayoutSections
smart constructor.
Constructors
LayoutSections' (Maybe [Section]) |
Instances
newLayoutSections :: LayoutSections Source #
Create a value of LayoutSections
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sections:LayoutSections'
, layoutSections_sections
- Undocumented member.
LayoutSummary
data LayoutSummary Source #
Object for the summarized details of the layout.
See: newLayoutSummary
smart constructor.
Constructors
LayoutSummary' Text Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> LayoutSummary |
Create a value of LayoutSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:layoutArn:LayoutSummary'
, layoutSummary_layoutArn
- The Amazon Resource Name (ARN) of the layout.
$sel:layoutId:LayoutSummary'
, layoutSummary_layoutId
- The unique identifier for of the layout.
$sel:name:LayoutSummary'
, layoutSummary_name
- The name of the layout.
RelatedItemContent
data RelatedItemContent Source #
Represents the content of a particular type of related item.
See: newRelatedItemContent
smart constructor.
Constructors
RelatedItemContent' (Maybe CommentContent) (Maybe ContactContent) |
Instances
newRelatedItemContent :: RelatedItemContent Source #
Create a value of RelatedItemContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:RelatedItemContent'
, relatedItemContent_comment
- Represents the content of a comment to be returned to agents.
$sel:contact:RelatedItemContent'
, relatedItemContent_contact
- Represents the content of a contact to be returned to agents.
RelatedItemEventIncludedData
data RelatedItemEventIncludedData Source #
Details of what related item data is published through the case event stream.
See: newRelatedItemEventIncludedData
smart constructor.
Constructors
RelatedItemEventIncludedData' Bool |
Instances
newRelatedItemEventIncludedData Source #
Create a value of RelatedItemEventIncludedData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeContent:RelatedItemEventIncludedData'
, relatedItemEventIncludedData_includeContent
- Details of what related item data is published through the case event
stream.
RelatedItemInputContent
data RelatedItemInputContent Source #
Represents the content of a related item to be created.
See: newRelatedItemInputContent
smart constructor.
Constructors
RelatedItemInputContent' (Maybe CommentContent) (Maybe Contact) |
Instances
newRelatedItemInputContent :: RelatedItemInputContent Source #
Create a value of RelatedItemInputContent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:RelatedItemInputContent'
, relatedItemInputContent_comment
- Represents the content of a comment to be returned to agents.
$sel:contact:RelatedItemInputContent'
, relatedItemInputContent_contact
- Object representing a contact in Amazon Connect as an API request field.
RelatedItemTypeFilter
data RelatedItemTypeFilter Source #
The list of types of related items and their parameters to use for filtering.
See: newRelatedItemTypeFilter
smart constructor.
Constructors
RelatedItemTypeFilter' (Maybe CommentFilter) (Maybe ContactFilter) |
Instances
newRelatedItemTypeFilter :: RelatedItemTypeFilter Source #
Create a value of RelatedItemTypeFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:RelatedItemTypeFilter'
, relatedItemTypeFilter_comment
- A filter for related items of type Comment
.
$sel:contact:RelatedItemTypeFilter'
, relatedItemTypeFilter_contact
- A filter for related items of type Contact
.
RequiredField
data RequiredField Source #
List of fields that must have a value provided to create a case.
See: newRequiredField
smart constructor.
Constructors
RequiredField' Text |
Instances
Arguments
:: Text | |
-> RequiredField |
Create a value of RequiredField
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldId:RequiredField'
, requiredField_fieldId
- Unique identifier of a field.
SearchCasesResponseItem
data SearchCasesResponseItem Source #
A list of items that represent cases.
See: newSearchCasesResponseItem
smart constructor.
Constructors
SearchCasesResponseItem' (Maybe (HashMap Text Text)) Text [FieldValue] Text |
Instances
newSearchCasesResponseItem Source #
Arguments
:: Text | |
-> Text | |
-> SearchCasesResponseItem |
Create a value of SearchCasesResponseItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:SearchCasesResponseItem'
, searchCasesResponseItem_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:caseId:SearchCasesResponseItem'
, searchCasesResponseItem_caseId
- A unique identifier of the case.
$sel:fields:SearchCasesResponseItem'
, searchCasesResponseItem_fields
- List of case field values.
$sel:templateId:SearchCasesResponseItem'
, searchCasesResponseItem_templateId
- A unique identifier of a template.
SearchRelatedItemsResponseItem
data SearchRelatedItemsResponseItem Source #
A list of items that represent RelatedItems.
See: newSearchRelatedItemsResponseItem
smart constructor.
Constructors
SearchRelatedItemsResponseItem' (Maybe (HashMap Text Text)) ISO8601 RelatedItemContent Text RelatedItemType |
Instances
newSearchRelatedItemsResponseItem Source #
Arguments
:: UTCTime | |
-> RelatedItemContent | |
-> Text | |
-> RelatedItemType | |
-> SearchRelatedItemsResponseItem |
Create a value of SearchRelatedItemsResponseItem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:SearchRelatedItemsResponseItem'
, searchRelatedItemsResponseItem_tags
- A map of of key-value pairs that represent tags on a resource. Tags are
used to organize, track, or control access for this resource.
$sel:associationTime:SearchRelatedItemsResponseItem'
, searchRelatedItemsResponseItem_associationTime
- Time at which a related item was associated with a case.
$sel:content:SearchRelatedItemsResponseItem'
, searchRelatedItemsResponseItem_content
- Represents the content of a particular type of related item.
$sel:relatedItemId:SearchRelatedItemsResponseItem'
, searchRelatedItemsResponseItem_relatedItemId
- Unique identifier of a related item.
$sel:type':SearchRelatedItemsResponseItem'
, searchRelatedItemsResponseItem_type
- Type of a related item.
Section
This represents a sections within a panel or tab of the page layout.
See: newSection
smart constructor.
Constructors
Section' (Maybe FieldGroup) |
Instances
FromJSON Section Source # | |
ToJSON Section Source # | |
Defined in Amazonka.ConnectCases.Types.Section | |
Generic Section Source # | |
Read Section Source # | |
Show Section Source # | |
NFData Section Source # | |
Defined in Amazonka.ConnectCases.Types.Section | |
Eq Section Source # | |
Hashable Section Source # | |
Defined in Amazonka.ConnectCases.Types.Section | |
type Rep Section Source # | |
Defined in Amazonka.ConnectCases.Types.Section type Rep Section = D1 ('MetaData "Section" "Amazonka.ConnectCases.Types.Section" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "Section'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fieldGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FieldGroup)))) |
newSection :: Section Source #
Create a value of Section
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldGroup:Section'
, section_fieldGroup
- Consists of a group of fields and associated properties.
Sort
A structured set of sort terms.
See: newSort
smart constructor.
Instances
ToJSON Sort Source # | |
Defined in Amazonka.ConnectCases.Types.Sort | |
Generic Sort Source # | |
Read Sort Source # | |
Show Sort Source # | |
NFData Sort Source # | |
Defined in Amazonka.ConnectCases.Types.Sort | |
Eq Sort Source # | |
Hashable Sort Source # | |
Defined in Amazonka.ConnectCases.Types.Sort | |
type Rep Sort Source # | |
Defined in Amazonka.ConnectCases.Types.Sort type Rep Sort = D1 ('MetaData "Sort" "Amazonka.ConnectCases.Types.Sort" "amazonka-connectcases-2.0-9RA5jvVYRVL9KmD8hfMfHn" 'False) (C1 ('MetaCons "Sort'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fieldId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Order))) |
Create a value of Sort
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fieldId:Sort'
, sort_fieldId
- Unique identifier of a field.
$sel:sortOrder:Sort'
, sort_sortOrder
- A structured set of sort terms
TemplateSummary
data TemplateSummary Source #
Template summary information.
See: newTemplateSummary
smart constructor.
Constructors
TemplateSummary' Text TemplateStatus Text Text |
Instances
Arguments
:: Text | |
-> TemplateStatus | |
-> Text | |
-> Text | |
-> TemplateSummary |
Create a value of TemplateSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TemplateSummary'
, templateSummary_name
- The template name.
$sel:status:TemplateSummary'
, templateSummary_status
- The status of the template.
$sel:templateArn:TemplateSummary'
, templateSummary_templateArn
- The Amazon Resource Name (ARN) of the template.
$sel:templateId:TemplateSummary'
, templateSummary_templateId
- The unique identifier for the template.