| 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.Lens
Contents
- Operations
- BatchGetField
- BatchPutFieldOptions
- CreateCase
- CreateDomain
- CreateField
- CreateLayout
- CreateRelatedItem
- CreateTemplate
- GetCase
- GetCaseEventConfiguration
- GetDomain
- GetLayout
- GetTemplate
- ListCasesForContact
- ListDomains
- ListFieldOptions
- ListFields
- ListLayouts
- ListTagsForResource
- ListTemplates
- PutCaseEventConfiguration
- SearchCases
- SearchRelatedItems
- TagResource
- UntagResource
- UpdateCase
- UpdateField
- UpdateLayout
- UpdateTemplate
- Types
- 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
Synopsis
- batchGetField_domainId :: Lens' BatchGetField Text
- batchGetField_fields :: Lens' BatchGetField (NonEmpty FieldIdentifier)
- batchGetFieldResponse_httpStatus :: Lens' BatchGetFieldResponse Int
- batchGetFieldResponse_errors :: Lens' BatchGetFieldResponse [FieldError]
- batchGetFieldResponse_fields :: Lens' BatchGetFieldResponse [GetFieldResponse]
- batchPutFieldOptions_domainId :: Lens' BatchPutFieldOptions Text
- batchPutFieldOptions_fieldId :: Lens' BatchPutFieldOptions Text
- batchPutFieldOptions_options :: Lens' BatchPutFieldOptions [FieldOption]
- batchPutFieldOptionsResponse_errors :: Lens' BatchPutFieldOptionsResponse (Maybe [FieldOptionError])
- batchPutFieldOptionsResponse_httpStatus :: Lens' BatchPutFieldOptionsResponse Int
- createCase_clientToken :: Lens' CreateCase (Maybe Text)
- createCase_domainId :: Lens' CreateCase Text
- createCase_fields :: Lens' CreateCase [FieldValue]
- createCase_templateId :: Lens' CreateCase Text
- createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int
- createCaseResponse_caseArn :: Lens' CreateCaseResponse Text
- createCaseResponse_caseId :: Lens' CreateCaseResponse Text
- createDomain_name :: Lens' CreateDomain Text
- createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int
- createDomainResponse_domainArn :: Lens' CreateDomainResponse Text
- createDomainResponse_domainId :: Lens' CreateDomainResponse Text
- createDomainResponse_domainStatus :: Lens' CreateDomainResponse DomainStatus
- createField_description :: Lens' CreateField (Maybe Text)
- createField_domainId :: Lens' CreateField Text
- createField_name :: Lens' CreateField Text
- createField_type :: Lens' CreateField FieldType
- createFieldResponse_httpStatus :: Lens' CreateFieldResponse Int
- createFieldResponse_fieldArn :: Lens' CreateFieldResponse Text
- createFieldResponse_fieldId :: Lens' CreateFieldResponse Text
- createLayout_content :: Lens' CreateLayout LayoutContent
- createLayout_domainId :: Lens' CreateLayout Text
- createLayout_name :: Lens' CreateLayout Text
- createLayoutResponse_httpStatus :: Lens' CreateLayoutResponse Int
- createLayoutResponse_layoutArn :: Lens' CreateLayoutResponse Text
- createLayoutResponse_layoutId :: Lens' CreateLayoutResponse Text
- createRelatedItem_caseId :: Lens' CreateRelatedItem Text
- createRelatedItem_content :: Lens' CreateRelatedItem RelatedItemInputContent
- createRelatedItem_domainId :: Lens' CreateRelatedItem Text
- createRelatedItem_type :: Lens' CreateRelatedItem RelatedItemType
- createRelatedItemResponse_httpStatus :: Lens' CreateRelatedItemResponse Int
- createRelatedItemResponse_relatedItemArn :: Lens' CreateRelatedItemResponse Text
- createRelatedItemResponse_relatedItemId :: Lens' CreateRelatedItemResponse Text
- createTemplate_description :: Lens' CreateTemplate (Maybe Text)
- createTemplate_layoutConfiguration :: Lens' CreateTemplate (Maybe LayoutConfiguration)
- createTemplate_requiredFields :: Lens' CreateTemplate (Maybe [RequiredField])
- createTemplate_status :: Lens' CreateTemplate (Maybe TemplateStatus)
- createTemplate_domainId :: Lens' CreateTemplate Text
- createTemplate_name :: Lens' CreateTemplate Text
- createTemplateResponse_httpStatus :: Lens' CreateTemplateResponse Int
- createTemplateResponse_templateArn :: Lens' CreateTemplateResponse Text
- createTemplateResponse_templateId :: Lens' CreateTemplateResponse Text
- getCase_nextToken :: Lens' GetCase (Maybe Text)
- getCase_caseId :: Lens' GetCase Text
- getCase_domainId :: Lens' GetCase Text
- getCase_fields :: Lens' GetCase (NonEmpty FieldIdentifier)
- getCaseResponse_nextToken :: Lens' GetCaseResponse (Maybe Text)
- getCaseResponse_tags :: Lens' GetCaseResponse (Maybe (HashMap Text Text))
- getCaseResponse_httpStatus :: Lens' GetCaseResponse Int
- getCaseResponse_fields :: Lens' GetCaseResponse [FieldValue]
- getCaseResponse_templateId :: Lens' GetCaseResponse Text
- getCaseEventConfiguration_domainId :: Lens' GetCaseEventConfiguration Text
- getCaseEventConfigurationResponse_httpStatus :: Lens' GetCaseEventConfigurationResponse Int
- getCaseEventConfigurationResponse_eventBridge :: Lens' GetCaseEventConfigurationResponse EventBridgeConfiguration
- getDomain_domainId :: Lens' GetDomain Text
- getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text))
- getDomainResponse_httpStatus :: Lens' GetDomainResponse Int
- getDomainResponse_createdTime :: Lens' GetDomainResponse UTCTime
- getDomainResponse_domainArn :: Lens' GetDomainResponse Text
- getDomainResponse_domainId :: Lens' GetDomainResponse Text
- getDomainResponse_domainStatus :: Lens' GetDomainResponse DomainStatus
- getDomainResponse_name :: Lens' GetDomainResponse Text
- getLayout_domainId :: Lens' GetLayout Text
- getLayout_layoutId :: Lens' GetLayout Text
- getLayoutResponse_tags :: Lens' GetLayoutResponse (Maybe (HashMap Text Text))
- getLayoutResponse_httpStatus :: Lens' GetLayoutResponse Int
- getLayoutResponse_content :: Lens' GetLayoutResponse LayoutContent
- getLayoutResponse_layoutArn :: Lens' GetLayoutResponse Text
- getLayoutResponse_layoutId :: Lens' GetLayoutResponse Text
- getLayoutResponse_name :: Lens' GetLayoutResponse Text
- getTemplate_domainId :: Lens' GetTemplate Text
- getTemplate_templateId :: Lens' GetTemplate Text
- getTemplateResponse_description :: Lens' GetTemplateResponse (Maybe Text)
- getTemplateResponse_layoutConfiguration :: Lens' GetTemplateResponse (Maybe LayoutConfiguration)
- getTemplateResponse_requiredFields :: Lens' GetTemplateResponse (Maybe [RequiredField])
- getTemplateResponse_tags :: Lens' GetTemplateResponse (Maybe (HashMap Text Text))
- getTemplateResponse_httpStatus :: Lens' GetTemplateResponse Int
- getTemplateResponse_name :: Lens' GetTemplateResponse Text
- getTemplateResponse_status :: Lens' GetTemplateResponse TemplateStatus
- getTemplateResponse_templateArn :: Lens' GetTemplateResponse Text
- getTemplateResponse_templateId :: Lens' GetTemplateResponse Text
- listCasesForContact_maxResults :: Lens' ListCasesForContact (Maybe Natural)
- listCasesForContact_nextToken :: Lens' ListCasesForContact (Maybe Text)
- listCasesForContact_contactArn :: Lens' ListCasesForContact Text
- listCasesForContact_domainId :: Lens' ListCasesForContact Text
- listCasesForContactResponse_nextToken :: Lens' ListCasesForContactResponse (Maybe Text)
- listCasesForContactResponse_httpStatus :: Lens' ListCasesForContactResponse Int
- listCasesForContactResponse_cases :: Lens' ListCasesForContactResponse [CaseSummary]
- listDomains_maxResults :: Lens' ListDomains (Maybe Natural)
- listDomains_nextToken :: Lens' ListDomains (Maybe Text)
- listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text)
- listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int
- listDomainsResponse_domains :: Lens' ListDomainsResponse [DomainSummary]
- listFieldOptions_maxResults :: Lens' ListFieldOptions (Maybe Natural)
- listFieldOptions_nextToken :: Lens' ListFieldOptions (Maybe Text)
- listFieldOptions_values :: Lens' ListFieldOptions (Maybe [Text])
- listFieldOptions_domainId :: Lens' ListFieldOptions Text
- listFieldOptions_fieldId :: Lens' ListFieldOptions Text
- listFieldOptionsResponse_nextToken :: Lens' ListFieldOptionsResponse (Maybe Text)
- listFieldOptionsResponse_httpStatus :: Lens' ListFieldOptionsResponse Int
- listFieldOptionsResponse_options :: Lens' ListFieldOptionsResponse [FieldOption]
- listFields_maxResults :: Lens' ListFields (Maybe Natural)
- listFields_nextToken :: Lens' ListFields (Maybe Text)
- listFields_domainId :: Lens' ListFields Text
- listFieldsResponse_nextToken :: Lens' ListFieldsResponse (Maybe Text)
- listFieldsResponse_httpStatus :: Lens' ListFieldsResponse Int
- listFieldsResponse_fields :: Lens' ListFieldsResponse [FieldSummary]
- listLayouts_maxResults :: Lens' ListLayouts (Maybe Natural)
- listLayouts_nextToken :: Lens' ListLayouts (Maybe Text)
- listLayouts_domainId :: Lens' ListLayouts Text
- listLayoutsResponse_nextToken :: Lens' ListLayoutsResponse (Maybe Text)
- listLayoutsResponse_httpStatus :: Lens' ListLayoutsResponse Int
- listLayoutsResponse_layouts :: Lens' ListLayoutsResponse [LayoutSummary]
- listTagsForResource_arn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural)
- listTemplates_nextToken :: Lens' ListTemplates (Maybe Text)
- listTemplates_status :: Lens' ListTemplates (Maybe (NonEmpty TemplateStatus))
- listTemplates_domainId :: Lens' ListTemplates Text
- listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text)
- listTemplatesResponse_httpStatus :: Lens' ListTemplatesResponse Int
- listTemplatesResponse_templates :: Lens' ListTemplatesResponse [TemplateSummary]
- putCaseEventConfiguration_domainId :: Lens' PutCaseEventConfiguration Text
- putCaseEventConfiguration_eventBridge :: Lens' PutCaseEventConfiguration EventBridgeConfiguration
- putCaseEventConfigurationResponse_httpStatus :: Lens' PutCaseEventConfigurationResponse Int
- searchCases_fields :: Lens' SearchCases (Maybe [FieldIdentifier])
- searchCases_filter :: Lens' SearchCases (Maybe CaseFilter)
- searchCases_maxResults :: Lens' SearchCases (Maybe Natural)
- searchCases_nextToken :: Lens' SearchCases (Maybe Text)
- searchCases_searchTerm :: Lens' SearchCases (Maybe Text)
- searchCases_sorts :: Lens' SearchCases (Maybe [Sort])
- searchCases_domainId :: Lens' SearchCases Text
- searchCasesResponse_nextToken :: Lens' SearchCasesResponse (Maybe Text)
- searchCasesResponse_httpStatus :: Lens' SearchCasesResponse Int
- searchCasesResponse_cases :: Lens' SearchCasesResponse [SearchCasesResponseItem]
- searchRelatedItems_filters :: Lens' SearchRelatedItems (Maybe [RelatedItemTypeFilter])
- searchRelatedItems_maxResults :: Lens' SearchRelatedItems (Maybe Natural)
- searchRelatedItems_nextToken :: Lens' SearchRelatedItems (Maybe Text)
- searchRelatedItems_caseId :: Lens' SearchRelatedItems Text
- searchRelatedItems_domainId :: Lens' SearchRelatedItems Text
- searchRelatedItemsResponse_nextToken :: Lens' SearchRelatedItemsResponse (Maybe Text)
- searchRelatedItemsResponse_httpStatus :: Lens' SearchRelatedItemsResponse Int
- searchRelatedItemsResponse_relatedItems :: Lens' SearchRelatedItemsResponse [SearchRelatedItemsResponseItem]
- tagResource_arn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- untagResource_arn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- updateCase_caseId :: Lens' UpdateCase Text
- updateCase_domainId :: Lens' UpdateCase Text
- updateCase_fields :: Lens' UpdateCase [FieldValue]
- updateCaseResponse_httpStatus :: Lens' UpdateCaseResponse Int
- updateField_description :: Lens' UpdateField (Maybe Text)
- updateField_name :: Lens' UpdateField (Maybe Text)
- updateField_domainId :: Lens' UpdateField Text
- updateField_fieldId :: Lens' UpdateField Text
- updateFieldResponse_httpStatus :: Lens' UpdateFieldResponse Int
- updateLayout_content :: Lens' UpdateLayout (Maybe LayoutContent)
- updateLayout_name :: Lens' UpdateLayout (Maybe Text)
- updateLayout_domainId :: Lens' UpdateLayout Text
- updateLayout_layoutId :: Lens' UpdateLayout Text
- updateLayoutResponse_httpStatus :: Lens' UpdateLayoutResponse Int
- updateTemplate_description :: Lens' UpdateTemplate (Maybe Text)
- updateTemplate_layoutConfiguration :: Lens' UpdateTemplate (Maybe LayoutConfiguration)
- updateTemplate_name :: Lens' UpdateTemplate (Maybe Text)
- updateTemplate_requiredFields :: Lens' UpdateTemplate (Maybe [RequiredField])
- updateTemplate_status :: Lens' UpdateTemplate (Maybe TemplateStatus)
- updateTemplate_domainId :: Lens' UpdateTemplate Text
- updateTemplate_templateId :: Lens' UpdateTemplate Text
- updateTemplateResponse_httpStatus :: Lens' UpdateTemplateResponse Int
- basicLayout_moreInfo :: Lens' BasicLayout (Maybe LayoutSections)
- basicLayout_topPanel :: Lens' BasicLayout (Maybe LayoutSections)
- caseEventIncludedData_fields :: Lens' CaseEventIncludedData [FieldIdentifier]
- caseFilter_andAll :: Lens' CaseFilter (Maybe [CaseFilter])
- caseFilter_field :: Lens' CaseFilter (Maybe FieldFilter)
- caseFilter_not :: Lens' CaseFilter (Maybe CaseFilter)
- caseSummary_caseId :: Lens' CaseSummary Text
- caseSummary_templateId :: Lens' CaseSummary Text
- commentContent_body :: Lens' CommentContent Text
- commentContent_contentType :: Lens' CommentContent CommentBodyTextType
- contact_contactArn :: Lens' Contact Text
- contactContent_channel :: Lens' ContactContent Text
- contactContent_connectedToSystemTime :: Lens' ContactContent UTCTime
- contactContent_contactArn :: Lens' ContactContent Text
- contactFilter_channel :: Lens' ContactFilter (Maybe [Text])
- contactFilter_contactArn :: Lens' ContactFilter (Maybe Text)
- domainSummary_domainArn :: Lens' DomainSummary Text
- domainSummary_domainId :: Lens' DomainSummary Text
- domainSummary_name :: Lens' DomainSummary Text
- eventBridgeConfiguration_includedData :: Lens' EventBridgeConfiguration (Maybe EventIncludedData)
- eventBridgeConfiguration_enabled :: Lens' EventBridgeConfiguration Bool
- eventIncludedData_caseData :: Lens' EventIncludedData (Maybe CaseEventIncludedData)
- eventIncludedData_relatedItemData :: Lens' EventIncludedData (Maybe RelatedItemEventIncludedData)
- fieldError_message :: Lens' FieldError (Maybe Text)
- fieldError_errorCode :: Lens' FieldError Text
- fieldError_id :: Lens' FieldError Text
- fieldFilter_contains :: Lens' FieldFilter (Maybe FieldValue)
- fieldFilter_equalTo :: Lens' FieldFilter (Maybe FieldValue)
- fieldFilter_greaterThan :: Lens' FieldFilter (Maybe FieldValue)
- fieldFilter_greaterThanOrEqualTo :: Lens' FieldFilter (Maybe FieldValue)
- fieldFilter_lessThan :: Lens' FieldFilter (Maybe FieldValue)
- fieldFilter_lessThanOrEqualTo :: Lens' FieldFilter (Maybe FieldValue)
- fieldGroup_name :: Lens' FieldGroup (Maybe Text)
- fieldGroup_fields :: Lens' FieldGroup [FieldItem]
- fieldIdentifier_id :: Lens' FieldIdentifier Text
- fieldItem_id :: Lens' FieldItem Text
- fieldOption_active :: Lens' FieldOption Bool
- fieldOption_name :: Lens' FieldOption Text
- fieldOption_value :: Lens' FieldOption Text
- fieldOptionError_errorCode :: Lens' FieldOptionError Text
- fieldOptionError_message :: Lens' FieldOptionError Text
- fieldOptionError_value :: Lens' FieldOptionError Text
- fieldSummary_fieldArn :: Lens' FieldSummary Text
- fieldSummary_fieldId :: Lens' FieldSummary Text
- fieldSummary_name :: Lens' FieldSummary Text
- fieldSummary_namespace :: Lens' FieldSummary FieldNamespace
- fieldSummary_type :: Lens' FieldSummary FieldType
- fieldValue_id :: Lens' FieldValue Text
- fieldValue_value :: Lens' FieldValue FieldValueUnion
- fieldValueUnion_booleanValue :: Lens' FieldValueUnion (Maybe Bool)
- fieldValueUnion_doubleValue :: Lens' FieldValueUnion (Maybe Double)
- fieldValueUnion_stringValue :: Lens' FieldValueUnion (Maybe Text)
- getFieldResponse_description :: Lens' GetFieldResponse (Maybe Text)
- getFieldResponse_tags :: Lens' GetFieldResponse (Maybe (HashMap Text Text))
- getFieldResponse_fieldArn :: Lens' GetFieldResponse Text
- getFieldResponse_fieldId :: Lens' GetFieldResponse Text
- getFieldResponse_name :: Lens' GetFieldResponse Text
- getFieldResponse_namespace :: Lens' GetFieldResponse FieldNamespace
- getFieldResponse_type :: Lens' GetFieldResponse FieldType
- layoutConfiguration_defaultLayout :: Lens' LayoutConfiguration (Maybe Text)
- layoutContent_basic :: Lens' LayoutContent (Maybe BasicLayout)
- layoutSections_sections :: Lens' LayoutSections (Maybe [Section])
- layoutSummary_layoutArn :: Lens' LayoutSummary Text
- layoutSummary_layoutId :: Lens' LayoutSummary Text
- layoutSummary_name :: Lens' LayoutSummary Text
- relatedItemContent_comment :: Lens' RelatedItemContent (Maybe CommentContent)
- relatedItemContent_contact :: Lens' RelatedItemContent (Maybe ContactContent)
- relatedItemEventIncludedData_includeContent :: Lens' RelatedItemEventIncludedData Bool
- relatedItemInputContent_comment :: Lens' RelatedItemInputContent (Maybe CommentContent)
- relatedItemInputContent_contact :: Lens' RelatedItemInputContent (Maybe Contact)
- relatedItemTypeFilter_comment :: Lens' RelatedItemTypeFilter (Maybe CommentFilter)
- relatedItemTypeFilter_contact :: Lens' RelatedItemTypeFilter (Maybe ContactFilter)
- requiredField_fieldId :: Lens' RequiredField Text
- searchCasesResponseItem_tags :: Lens' SearchCasesResponseItem (Maybe (HashMap Text Text))
- searchCasesResponseItem_caseId :: Lens' SearchCasesResponseItem Text
- searchCasesResponseItem_fields :: Lens' SearchCasesResponseItem [FieldValue]
- searchCasesResponseItem_templateId :: Lens' SearchCasesResponseItem Text
- searchRelatedItemsResponseItem_tags :: Lens' SearchRelatedItemsResponseItem (Maybe (HashMap Text Text))
- searchRelatedItemsResponseItem_associationTime :: Lens' SearchRelatedItemsResponseItem UTCTime
- searchRelatedItemsResponseItem_content :: Lens' SearchRelatedItemsResponseItem RelatedItemContent
- searchRelatedItemsResponseItem_relatedItemId :: Lens' SearchRelatedItemsResponseItem Text
- searchRelatedItemsResponseItem_type :: Lens' SearchRelatedItemsResponseItem RelatedItemType
- section_fieldGroup :: Lens' Section (Maybe FieldGroup)
- sort_fieldId :: Lens' Sort Text
- sort_sortOrder :: Lens' Sort Order
- templateSummary_name :: Lens' TemplateSummary Text
- templateSummary_status :: Lens' TemplateSummary TemplateStatus
- templateSummary_templateArn :: Lens' TemplateSummary Text
- templateSummary_templateId :: Lens' TemplateSummary Text
Operations
BatchGetField
batchGetField_domainId :: Lens' BatchGetField Text Source #
The unique identifier of the Cases domain.
batchGetField_fields :: Lens' BatchGetField (NonEmpty FieldIdentifier) Source #
A list of unique field identifiers.
batchGetFieldResponse_httpStatus :: Lens' BatchGetFieldResponse Int Source #
The response's http status code.
batchGetFieldResponse_errors :: Lens' BatchGetFieldResponse [FieldError] Source #
A list of field errors.
batchGetFieldResponse_fields :: Lens' BatchGetFieldResponse [GetFieldResponse] Source #
A list of detailed field information.
BatchPutFieldOptions
batchPutFieldOptions_domainId :: Lens' BatchPutFieldOptions Text Source #
The unique identifier of the Cases domain.
batchPutFieldOptions_fieldId :: Lens' BatchPutFieldOptions Text Source #
The unique identifier of a field.
batchPutFieldOptions_options :: Lens' BatchPutFieldOptions [FieldOption] Source #
A list of FieldOption objects.
batchPutFieldOptionsResponse_errors :: Lens' BatchPutFieldOptionsResponse (Maybe [FieldOptionError]) Source #
A list of field errors.
batchPutFieldOptionsResponse_httpStatus :: Lens' BatchPutFieldOptionsResponse Int Source #
The response's http status code.
CreateCase
createCase_clientToken :: Lens' CreateCase (Maybe Text) Source #
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_domainId :: Lens' CreateCase Text Source #
The unique identifier of the Cases domain.
createCase_fields :: Lens' CreateCase [FieldValue] Source #
An array of objects with field ID (matching ListFields/DescribeField) and value union data.
createCase_templateId :: Lens' CreateCase Text Source #
A unique identifier of a template.
createCaseResponse_httpStatus :: Lens' CreateCaseResponse Int Source #
The response's http status code.
createCaseResponse_caseArn :: Lens' CreateCaseResponse Text Source #
The Amazon Resource Name (ARN) of the case.
createCaseResponse_caseId :: Lens' CreateCaseResponse Text Source #
A unique identifier of the case.
CreateDomain
createDomain_name :: Lens' CreateDomain Text Source #
The name for your Cases domain. It must be unique for your Amazon Web Services account.
createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #
The response's http status code.
createDomainResponse_domainArn :: Lens' CreateDomainResponse Text Source #
The Amazon Resource Name (ARN) for the Cases domain.
createDomainResponse_domainId :: Lens' CreateDomainResponse Text Source #
The unique identifier of the Cases domain.
createDomainResponse_domainStatus :: Lens' CreateDomainResponse DomainStatus Source #
The status of the domain.
CreateField
createField_description :: Lens' CreateField (Maybe Text) Source #
The description of the field.
createField_domainId :: Lens' CreateField Text Source #
The unique identifier of the Cases domain.
createField_name :: Lens' CreateField Text Source #
The name of the field.
createField_type :: Lens' CreateField FieldType Source #
Defines the data type, some system constraints, and default display of the field.
createFieldResponse_httpStatus :: Lens' CreateFieldResponse Int Source #
The response's http status code.
createFieldResponse_fieldArn :: Lens' CreateFieldResponse Text Source #
The Amazon Resource Name (ARN) of the field.
createFieldResponse_fieldId :: Lens' CreateFieldResponse Text Source #
The unique identifier of a field.
CreateLayout
createLayout_content :: Lens' CreateLayout LayoutContent Source #
Information about which fields will be present in the layout, and information about the order of the fields.
createLayout_domainId :: Lens' CreateLayout Text Source #
The unique identifier of the Cases domain.
createLayout_name :: Lens' CreateLayout Text Source #
The name of the layout. It must be unique for the Cases domain.
createLayoutResponse_httpStatus :: Lens' CreateLayoutResponse Int Source #
The response's http status code.
createLayoutResponse_layoutArn :: Lens' CreateLayoutResponse Text Source #
The Amazon Resource Name (ARN) of the newly created layout.
createLayoutResponse_layoutId :: Lens' CreateLayoutResponse Text Source #
The unique identifier of the layout.
CreateRelatedItem
createRelatedItem_caseId :: Lens' CreateRelatedItem Text Source #
A unique identifier of the case.
createRelatedItem_content :: Lens' CreateRelatedItem RelatedItemInputContent Source #
The content of a related item to be created.
createRelatedItem_domainId :: Lens' CreateRelatedItem Text Source #
The unique identifier of the Cases domain.
createRelatedItem_type :: Lens' CreateRelatedItem RelatedItemType Source #
The type of a related item.
createRelatedItemResponse_httpStatus :: Lens' CreateRelatedItemResponse Int Source #
The response's http status code.
createRelatedItemResponse_relatedItemArn :: Lens' CreateRelatedItemResponse Text Source #
The Amazon Resource Name (ARN) of the related item.
createRelatedItemResponse_relatedItemId :: Lens' CreateRelatedItemResponse Text Source #
The unique identifier of the related item.
CreateTemplate
createTemplate_description :: Lens' CreateTemplate (Maybe Text) Source #
A brief description of the template.
createTemplate_layoutConfiguration :: Lens' CreateTemplate (Maybe LayoutConfiguration) Source #
Configuration of layouts associated to the template.
createTemplate_requiredFields :: Lens' CreateTemplate (Maybe [RequiredField]) Source #
A list of fields that must contain a value for a case to be successfully created with this template.
createTemplate_status :: Lens' CreateTemplate (Maybe TemplateStatus) Source #
The status of the template.
createTemplate_domainId :: Lens' CreateTemplate Text Source #
The unique identifier of the Cases domain.
createTemplate_name :: Lens' CreateTemplate Text Source #
A name for the template. It must be unique per domain.
createTemplateResponse_httpStatus :: Lens' CreateTemplateResponse Int Source #
The response's http status code.
createTemplateResponse_templateArn :: Lens' CreateTemplateResponse Text Source #
The Amazon Resource Name (ARN) of the newly created template.
createTemplateResponse_templateId :: Lens' CreateTemplateResponse Text Source #
A unique identifier of a template.
GetCase
getCase_nextToken :: Lens' GetCase (Maybe Text) Source #
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_fields :: Lens' GetCase (NonEmpty FieldIdentifier) Source #
A list of unique field identifiers.
getCaseResponse_nextToken :: Lens' GetCaseResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
getCaseResponse_tags :: Lens' GetCaseResponse (Maybe (HashMap Text Text)) Source #
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.
getCaseResponse_httpStatus :: Lens' GetCaseResponse Int Source #
The response's http status code.
getCaseResponse_fields :: Lens' GetCaseResponse [FieldValue] Source #
A list of detailed field information.
getCaseResponse_templateId :: Lens' GetCaseResponse Text Source #
A unique identifier of a template.
GetCaseEventConfiguration
getCaseEventConfiguration_domainId :: Lens' GetCaseEventConfiguration Text Source #
The unique identifier of the Cases domain.
getCaseEventConfigurationResponse_httpStatus :: Lens' GetCaseEventConfigurationResponse Int Source #
The response's http status code.
getCaseEventConfigurationResponse_eventBridge :: Lens' GetCaseEventConfigurationResponse EventBridgeConfiguration Source #
Configuration to enable EventBridge case event delivery and determine what data is delivered.
GetDomain
getDomainResponse_tags :: Lens' GetDomainResponse (Maybe (HashMap Text Text)) Source #
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.
getDomainResponse_httpStatus :: Lens' GetDomainResponse Int Source #
The response's http status code.
getDomainResponse_createdTime :: Lens' GetDomainResponse UTCTime Source #
The timestamp when the Cases domain was created.
getDomainResponse_domainArn :: Lens' GetDomainResponse Text Source #
The Amazon Resource Name (ARN) for the Cases domain.
getDomainResponse_domainId :: Lens' GetDomainResponse Text Source #
The unique identifier of the Cases domain.
getDomainResponse_domainStatus :: Lens' GetDomainResponse DomainStatus Source #
The status of the Cases domain.
getDomainResponse_name :: Lens' GetDomainResponse Text Source #
The name of the Cases domain.
GetLayout
getLayoutResponse_tags :: Lens' GetLayoutResponse (Maybe (HashMap Text Text)) Source #
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.
getLayoutResponse_httpStatus :: Lens' GetLayoutResponse Int Source #
The response's http status code.
getLayoutResponse_content :: Lens' GetLayoutResponse LayoutContent Source #
Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.
getLayoutResponse_layoutArn :: Lens' GetLayoutResponse Text Source #
The Amazon Resource Name (ARN) of the newly created layout.
getLayoutResponse_layoutId :: Lens' GetLayoutResponse Text Source #
The unique identifier of the layout.
getLayoutResponse_name :: Lens' GetLayoutResponse Text Source #
The name of the layout. It must be unique.
GetTemplate
getTemplate_domainId :: Lens' GetTemplate Text Source #
The unique identifier of the Cases domain.
getTemplate_templateId :: Lens' GetTemplate Text Source #
A unique identifier of a template.
getTemplateResponse_description :: Lens' GetTemplateResponse (Maybe Text) Source #
A brief description of the template.
getTemplateResponse_layoutConfiguration :: Lens' GetTemplateResponse (Maybe LayoutConfiguration) Source #
Configuration of layouts associated to the template.
getTemplateResponse_requiredFields :: Lens' GetTemplateResponse (Maybe [RequiredField]) Source #
A list of fields that must contain a value for a case to be successfully created with this template.
getTemplateResponse_tags :: Lens' GetTemplateResponse (Maybe (HashMap Text Text)) Source #
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.
getTemplateResponse_httpStatus :: Lens' GetTemplateResponse Int Source #
The response's http status code.
getTemplateResponse_name :: Lens' GetTemplateResponse Text Source #
The name of the template.
getTemplateResponse_status :: Lens' GetTemplateResponse TemplateStatus Source #
The status of the template.
getTemplateResponse_templateArn :: Lens' GetTemplateResponse Text Source #
The Amazon Resource Name (ARN) of the template.
getTemplateResponse_templateId :: Lens' GetTemplateResponse Text Source #
A unique identifier of a template.
ListCasesForContact
listCasesForContact_maxResults :: Lens' ListCasesForContact (Maybe Natural) Source #
The maximum number of results to return per page.
listCasesForContact_nextToken :: Lens' ListCasesForContact (Maybe Text) Source #
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_contactArn :: Lens' ListCasesForContact Text Source #
A unique identifier of a contact in Amazon Connect.
listCasesForContact_domainId :: Lens' ListCasesForContact Text Source #
The unique identifier of the Cases domain.
listCasesForContactResponse_nextToken :: Lens' ListCasesForContactResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
listCasesForContactResponse_httpStatus :: Lens' ListCasesForContactResponse Int Source #
The response's http status code.
listCasesForContactResponse_cases :: Lens' ListCasesForContactResponse [CaseSummary] Source #
A list of Case summary information.
ListDomains
listDomains_maxResults :: Lens' ListDomains (Maybe Natural) Source #
The maximum number of results to return per page.
listDomains_nextToken :: Lens' ListDomains (Maybe Text) Source #
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.
listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #
The response's http status code.
listDomainsResponse_domains :: Lens' ListDomainsResponse [DomainSummary] Source #
The Cases domain.
ListFieldOptions
listFieldOptions_maxResults :: Lens' ListFieldOptions (Maybe Natural) Source #
The maximum number of results to return per page.
listFieldOptions_nextToken :: Lens' ListFieldOptions (Maybe Text) Source #
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.
listFieldOptions_values :: Lens' ListFieldOptions (Maybe [Text]) Source #
A list of FieldOption values to filter on for ListFieldOptions.
listFieldOptions_domainId :: Lens' ListFieldOptions Text Source #
The unique identifier of the Cases domain.
listFieldOptions_fieldId :: Lens' ListFieldOptions Text Source #
The unique identifier of a field.
listFieldOptionsResponse_nextToken :: Lens' ListFieldOptionsResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
listFieldOptionsResponse_httpStatus :: Lens' ListFieldOptionsResponse Int Source #
The response's http status code.
listFieldOptionsResponse_options :: Lens' ListFieldOptionsResponse [FieldOption] Source #
A list of FieldOption objects.
ListFields
listFields_maxResults :: Lens' ListFields (Maybe Natural) Source #
The maximum number of results to return per page.
listFields_nextToken :: Lens' ListFields (Maybe Text) Source #
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_domainId :: Lens' ListFields Text Source #
The unique identifier of the Cases domain.
listFieldsResponse_nextToken :: Lens' ListFieldsResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
listFieldsResponse_httpStatus :: Lens' ListFieldsResponse Int Source #
The response's http status code.
listFieldsResponse_fields :: Lens' ListFieldsResponse [FieldSummary] Source #
List of detailed field information.
ListLayouts
listLayouts_maxResults :: Lens' ListLayouts (Maybe Natural) Source #
The maximum number of results to return per page.
listLayouts_nextToken :: Lens' ListLayouts (Maybe Text) Source #
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_domainId :: Lens' ListLayouts Text Source #
The unique identifier of the Cases domain.
listLayoutsResponse_nextToken :: Lens' ListLayoutsResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
listLayoutsResponse_httpStatus :: Lens' ListLayoutsResponse Int Source #
The response's http status code.
listLayoutsResponse_layouts :: Lens' ListLayoutsResponse [LayoutSummary] Source #
The layouts for the domain.
ListTagsForResource
listTagsForResource_arn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN)
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
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.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListTemplates
listTemplates_maxResults :: Lens' ListTemplates (Maybe Natural) Source #
The maximum number of results to return per page.
listTemplates_nextToken :: Lens' ListTemplates (Maybe Text) Source #
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_status :: Lens' ListTemplates (Maybe (NonEmpty TemplateStatus)) Source #
A list of status values to filter on.
listTemplates_domainId :: Lens' ListTemplates Text Source #
The unique identifier of the Cases domain.
listTemplatesResponse_nextToken :: Lens' ListTemplatesResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
listTemplatesResponse_httpStatus :: Lens' ListTemplatesResponse Int Source #
The response's http status code.
listTemplatesResponse_templates :: Lens' ListTemplatesResponse [TemplateSummary] Source #
List of template summary objects.
PutCaseEventConfiguration
putCaseEventConfiguration_domainId :: Lens' PutCaseEventConfiguration Text Source #
The unique identifier of the Cases domain.
putCaseEventConfiguration_eventBridge :: Lens' PutCaseEventConfiguration EventBridgeConfiguration Source #
Configuration to enable EventBridge case event delivery and determine what data is delivered.
putCaseEventConfigurationResponse_httpStatus :: Lens' PutCaseEventConfigurationResponse Int Source #
The response's http status code.
SearchCases
searchCases_fields :: Lens' SearchCases (Maybe [FieldIdentifier]) Source #
The list of field identifiers to be returned as part of the response.
searchCases_filter :: Lens' SearchCases (Maybe CaseFilter) Source #
A list of filter objects.
searchCases_maxResults :: Lens' SearchCases (Maybe Natural) Source #
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_nextToken :: Lens' SearchCases (Maybe Text) Source #
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.
searchCases_searchTerm :: Lens' SearchCases (Maybe Text) Source #
A word or phrase used to perform a quick search.
searchCases_sorts :: Lens' SearchCases (Maybe [Sort]) Source #
A list of sorts where each sort specifies a field and their sort order to be applied to the results.
searchCases_domainId :: Lens' SearchCases Text Source #
The unique identifier of the Cases domain.
searchCasesResponse_nextToken :: Lens' SearchCasesResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
searchCasesResponse_httpStatus :: Lens' SearchCasesResponse Int Source #
The response's http status code.
searchCasesResponse_cases :: Lens' SearchCasesResponse [SearchCasesResponseItem] Source #
A list of case documents where each case contains the properties
CaseId and Fields where each field is a complex union structure.
SearchRelatedItems
searchRelatedItems_filters :: Lens' SearchRelatedItems (Maybe [RelatedItemTypeFilter]) Source #
The list of types of related items and their parameters to use for filtering.
searchRelatedItems_maxResults :: Lens' SearchRelatedItems (Maybe Natural) Source #
The maximum number of results to return per page.
searchRelatedItems_nextToken :: Lens' SearchRelatedItems (Maybe Text) Source #
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_caseId :: Lens' SearchRelatedItems Text Source #
A unique identifier of the case.
searchRelatedItems_domainId :: Lens' SearchRelatedItems Text Source #
The unique identifier of the Cases domain.
searchRelatedItemsResponse_nextToken :: Lens' SearchRelatedItemsResponse (Maybe Text) Source #
The token for the next set of results. This is null if there are no more results to return.
searchRelatedItemsResponse_httpStatus :: Lens' SearchRelatedItemsResponse Int Source #
The response's http status code.
searchRelatedItemsResponse_relatedItems :: Lens' SearchRelatedItemsResponse [SearchRelatedItemsResponseItem] Source #
A list of items related to a case.
TagResource
tagResource_arn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN)
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
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.
UntagResource
untagResource_arn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN)
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
List of tag keys.
UpdateCase
updateCase_caseId :: Lens' UpdateCase Text Source #
A unique identifier of the case.
updateCase_domainId :: Lens' UpdateCase Text Source #
The unique identifier of the Cases domain.
updateCase_fields :: Lens' UpdateCase [FieldValue] Source #
An array of objects with fieldId (matching ListFields/DescribeField)
and value union data, structured identical to CreateCase.
updateCaseResponse_httpStatus :: Lens' UpdateCaseResponse Int Source #
The response's http status code.
UpdateField
updateField_description :: Lens' UpdateField (Maybe Text) Source #
The description of a field.
updateField_name :: Lens' UpdateField (Maybe Text) Source #
The name of the field.
updateField_domainId :: Lens' UpdateField Text Source #
The unique identifier of the Cases domain.
updateField_fieldId :: Lens' UpdateField Text Source #
The unique identifier of a field.
updateFieldResponse_httpStatus :: Lens' UpdateFieldResponse Int Source #
The response's http status code.
UpdateLayout
updateLayout_content :: Lens' UpdateLayout (Maybe LayoutContent) Source #
Information about which fields will be present in the layout, the order of the fields, and a read-only attribute of the field.
updateLayout_name :: Lens' UpdateLayout (Maybe Text) Source #
The name of the layout. It must be unique per domain.
updateLayout_domainId :: Lens' UpdateLayout Text Source #
The unique identifier of the Cases domain.
updateLayout_layoutId :: Lens' UpdateLayout Text Source #
The unique identifier of the layout.
updateLayoutResponse_httpStatus :: Lens' UpdateLayoutResponse Int Source #
The response's http status code.
UpdateTemplate
updateTemplate_description :: Lens' UpdateTemplate (Maybe Text) Source #
A brief description of the template.
updateTemplate_layoutConfiguration :: Lens' UpdateTemplate (Maybe LayoutConfiguration) Source #
Configuration of layouts associated to the template.
updateTemplate_name :: Lens' UpdateTemplate (Maybe Text) Source #
The name of the template. It must be unique per domain.
updateTemplate_requiredFields :: Lens' UpdateTemplate (Maybe [RequiredField]) Source #
A list of fields that must contain a value for a case to be successfully created with this template.
updateTemplate_status :: Lens' UpdateTemplate (Maybe TemplateStatus) Source #
The status of the template.
updateTemplate_domainId :: Lens' UpdateTemplate Text Source #
The unique identifier of the Cases domain.
updateTemplate_templateId :: Lens' UpdateTemplate Text Source #
A unique identifier for the template.
updateTemplateResponse_httpStatus :: Lens' UpdateTemplateResponse Int Source #
The response's http status code.
Types
BasicLayout
basicLayout_moreInfo :: Lens' BasicLayout (Maybe LayoutSections) Source #
This represents sections in a tab of the page layout.
basicLayout_topPanel :: Lens' BasicLayout (Maybe LayoutSections) Source #
This represents sections in a panel of the page layout.
CaseEventIncludedData
caseEventIncludedData_fields :: Lens' CaseEventIncludedData [FieldIdentifier] Source #
List of field identifiers.
CaseFilter
caseFilter_andAll :: Lens' CaseFilter (Maybe [CaseFilter]) Source #
Provides "and all" filtering.
caseFilter_field :: Lens' CaseFilter (Maybe FieldFilter) Source #
A list of fields to filter on.
caseFilter_not :: Lens' CaseFilter (Maybe CaseFilter) Source #
Undocumented member.
CaseSummary
caseSummary_caseId :: Lens' CaseSummary Text Source #
A unique identifier of the case.
caseSummary_templateId :: Lens' CaseSummary Text Source #
A unique identifier of a template.
CommentContent
commentContent_body :: Lens' CommentContent Text Source #
Text in the body of a Comment on a case.
commentContent_contentType :: Lens' CommentContent CommentBodyTextType Source #
Type of the text in the box of a Comment on a case.
CommentFilter
Contact
contact_contactArn :: Lens' Contact Text Source #
A unique identifier of a contact in Amazon Connect.
ContactContent
contactContent_channel :: Lens' ContactContent Text Source #
A list of channels to filter on for related items of type Contact.
contactContent_connectedToSystemTime :: Lens' ContactContent UTCTime Source #
The difference between the InitiationTimestamp and the
DisconnectTimestamp of the contact.
contactContent_contactArn :: Lens' ContactContent Text Source #
A unique identifier of a contact in Amazon Connect.
ContactFilter
contactFilter_channel :: Lens' ContactFilter (Maybe [Text]) Source #
A list of channels to filter on for related items of type Contact.
contactFilter_contactArn :: Lens' ContactFilter (Maybe Text) Source #
A unique identifier of a contact in Amazon Connect.
DomainSummary
domainSummary_domainArn :: Lens' DomainSummary Text Source #
The Amazon Resource Name (ARN) of the domain.
domainSummary_domainId :: Lens' DomainSummary Text Source #
The unique identifier of the domain.
domainSummary_name :: Lens' DomainSummary Text Source #
The name of the domain.
EventBridgeConfiguration
eventBridgeConfiguration_includedData :: Lens' EventBridgeConfiguration (Maybe EventIncludedData) Source #
Details of what case and related item data is published through the case event stream.
eventBridgeConfiguration_enabled :: Lens' EventBridgeConfiguration Bool Source #
Indicates whether the to broadcast case event data to the customer.
EventIncludedData
eventIncludedData_caseData :: Lens' EventIncludedData (Maybe CaseEventIncludedData) Source #
Details of what case data is published through the case event stream.
eventIncludedData_relatedItemData :: Lens' EventIncludedData (Maybe RelatedItemEventIncludedData) Source #
Details of what related item data is published through the case event stream.
FieldError
fieldError_message :: Lens' FieldError (Maybe Text) Source #
The error message from getting a field.
fieldError_errorCode :: Lens' FieldError Text Source #
The error code from getting a field.
fieldError_id :: Lens' FieldError Text Source #
The field identifier that caused the error.
FieldFilter
fieldFilter_contains :: Lens' FieldFilter (Maybe FieldValue) Source #
Object containing field identifier and value information.
fieldFilter_equalTo :: Lens' FieldFilter (Maybe FieldValue) Source #
Object containing field identifier and value information.
fieldFilter_greaterThan :: Lens' FieldFilter (Maybe FieldValue) Source #
Object containing field identifier and value information.
fieldFilter_greaterThanOrEqualTo :: Lens' FieldFilter (Maybe FieldValue) Source #
Object containing field identifier and value information.
fieldFilter_lessThan :: Lens' FieldFilter (Maybe FieldValue) Source #
Object containing field identifier and value information.
fieldFilter_lessThanOrEqualTo :: Lens' FieldFilter (Maybe FieldValue) Source #
Object containing field identifier and value information.
FieldGroup
fieldGroup_name :: Lens' FieldGroup (Maybe Text) Source #
Name of the field group.
fieldGroup_fields :: Lens' FieldGroup [FieldItem] Source #
Represents an ordered list containing field related information.
FieldIdentifier
fieldIdentifier_id :: Lens' FieldIdentifier Text Source #
Unique identifier of a field.
FieldItem
FieldOption
fieldOption_active :: Lens' FieldOption Bool Source #
Describes whether the FieldOption is active (displayed) or inactive.
fieldOption_name :: Lens' FieldOption Text Source #
FieldOptionName has max length 100 and disallows trailing spaces.
fieldOption_value :: Lens' FieldOption Text Source #
FieldOptionValue has max length 100 and must be alphanumeric with
hyphens and underscores.
FieldOptionError
fieldOptionError_errorCode :: Lens' FieldOptionError Text Source #
Error code from creating or updating field option.
fieldOptionError_message :: Lens' FieldOptionError Text Source #
Error message from creating or updating field option.
fieldOptionError_value :: Lens' FieldOptionError Text Source #
The field option value that caused the error.
FieldSummary
fieldSummary_fieldArn :: Lens' FieldSummary Text Source #
The Amazon Resource Name (ARN) of the field.
fieldSummary_fieldId :: Lens' FieldSummary Text Source #
The unique identifier of a field.
fieldSummary_name :: Lens' FieldSummary Text Source #
Name of the field.
fieldSummary_namespace :: Lens' FieldSummary FieldNamespace Source #
The namespace of a field.
fieldSummary_type :: Lens' FieldSummary FieldType Source #
The type of a field.
FieldValue
fieldValue_id :: Lens' FieldValue Text Source #
Unique identifier of a field.
fieldValue_value :: Lens' FieldValue FieldValueUnion Source #
Union of potential field value types.
FieldValueUnion
fieldValueUnion_booleanValue :: Lens' FieldValueUnion (Maybe Bool) Source #
Can be either null, or have a Boolean value type. Only one value can be provided.
fieldValueUnion_doubleValue :: Lens' FieldValueUnion (Maybe Double) Source #
Can be either null, or have a Double number value type. Only one value can be provided.
fieldValueUnion_stringValue :: Lens' FieldValueUnion (Maybe Text) Source #
String value type.
GetFieldResponse
getFieldResponse_description :: Lens' GetFieldResponse (Maybe Text) Source #
Description of the field.
getFieldResponse_tags :: Lens' GetFieldResponse (Maybe (HashMap Text Text)) Source #
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.
getFieldResponse_fieldArn :: Lens' GetFieldResponse Text Source #
The Amazon Resource Name (ARN) of the field.
getFieldResponse_fieldId :: Lens' GetFieldResponse Text Source #
Unique identifier of the field.
getFieldResponse_name :: Lens' GetFieldResponse Text Source #
Name of the field.
getFieldResponse_namespace :: Lens' GetFieldResponse FieldNamespace Source #
Namespace of the field.
getFieldResponse_type :: Lens' GetFieldResponse FieldType Source #
Type of the field.
LayoutConfiguration
layoutConfiguration_defaultLayout :: Lens' LayoutConfiguration (Maybe Text) Source #
Unique identifier of a layout.
LayoutContent
layoutContent_basic :: Lens' LayoutContent (Maybe BasicLayout) Source #
Content specific to BasicLayout type. It configures fields in the top
panel and More Info tab of Cases user interface.
LayoutSections
layoutSections_sections :: Lens' LayoutSections (Maybe [Section]) Source #
Undocumented member.
LayoutSummary
layoutSummary_layoutArn :: Lens' LayoutSummary Text Source #
The Amazon Resource Name (ARN) of the layout.
layoutSummary_layoutId :: Lens' LayoutSummary Text Source #
The unique identifier for of the layout.
layoutSummary_name :: Lens' LayoutSummary Text Source #
The name of the layout.
RelatedItemContent
relatedItemContent_comment :: Lens' RelatedItemContent (Maybe CommentContent) Source #
Represents the content of a comment to be returned to agents.
relatedItemContent_contact :: Lens' RelatedItemContent (Maybe ContactContent) Source #
Represents the content of a contact to be returned to agents.
RelatedItemEventIncludedData
relatedItemEventIncludedData_includeContent :: Lens' RelatedItemEventIncludedData Bool Source #
Details of what related item data is published through the case event stream.
RelatedItemInputContent
relatedItemInputContent_comment :: Lens' RelatedItemInputContent (Maybe CommentContent) Source #
Represents the content of a comment to be returned to agents.
relatedItemInputContent_contact :: Lens' RelatedItemInputContent (Maybe Contact) Source #
Object representing a contact in Amazon Connect as an API request field.
RelatedItemTypeFilter
relatedItemTypeFilter_comment :: Lens' RelatedItemTypeFilter (Maybe CommentFilter) Source #
A filter for related items of type Comment.
relatedItemTypeFilter_contact :: Lens' RelatedItemTypeFilter (Maybe ContactFilter) Source #
A filter for related items of type Contact.
RequiredField
requiredField_fieldId :: Lens' RequiredField Text Source #
Unique identifier of a field.
SearchCasesResponseItem
searchCasesResponseItem_tags :: Lens' SearchCasesResponseItem (Maybe (HashMap Text Text)) Source #
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.
searchCasesResponseItem_caseId :: Lens' SearchCasesResponseItem Text Source #
A unique identifier of the case.
searchCasesResponseItem_fields :: Lens' SearchCasesResponseItem [FieldValue] Source #
List of case field values.
searchCasesResponseItem_templateId :: Lens' SearchCasesResponseItem Text Source #
A unique identifier of a template.
SearchRelatedItemsResponseItem
searchRelatedItemsResponseItem_tags :: Lens' SearchRelatedItemsResponseItem (Maybe (HashMap Text Text)) Source #
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.
searchRelatedItemsResponseItem_associationTime :: Lens' SearchRelatedItemsResponseItem UTCTime Source #
Time at which a related item was associated with a case.
searchRelatedItemsResponseItem_content :: Lens' SearchRelatedItemsResponseItem RelatedItemContent Source #
Represents the content of a particular type of related item.
searchRelatedItemsResponseItem_relatedItemId :: Lens' SearchRelatedItemsResponseItem Text Source #
Unique identifier of a related item.
searchRelatedItemsResponseItem_type :: Lens' SearchRelatedItemsResponseItem RelatedItemType Source #
Type of a related item.
Section
section_fieldGroup :: Lens' Section (Maybe FieldGroup) Source #
Consists of a group of fields and associated properties.
Sort
TemplateSummary
templateSummary_name :: Lens' TemplateSummary Text Source #
The template name.
templateSummary_status :: Lens' TemplateSummary TemplateStatus Source #
The status of the template.
templateSummary_templateArn :: Lens' TemplateSummary Text Source #
The Amazon Resource Name (ARN) of the template.
templateSummary_templateId :: Lens' TemplateSummary Text Source #
The unique identifier for the template.