awscc.kendra_index¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - kendra:DescribeIndex, kendra:DeleteIndex
update¶
Parent base class for filters and actions.
definitions:
Arn:
maxLength: 1000
type: string
CapacityUnitsConfiguration:
additionalProperties: false
properties:
QueryCapacityUnits:
minimum: 0
type: integer
StorageCapacityUnits:
minimum: 0
type: integer
required:
- StorageCapacityUnits
- QueryCapacityUnits
type: object
ClaimRegex:
maxLength: 100
minLength: 1
type: string
Description:
maxLength: 1000
type: string
DocumentAttributeValueType:
enum:
- STRING_VALUE
- STRING_LIST_VALUE
- LONG_VALUE
- DATE_VALUE
type: string
DocumentMetadataConfiguration:
additionalProperties: false
properties:
Name:
maxLength: 30
minLength: 1
type: string
Relevance:
additionalProperties: false
properties:
Duration:
maxLength: 10
minLength: 1
pattern: '[0-9]+[s]'
type: string
Freshness:
type: boolean
Importance:
maximum: 10
minimum: 1
type: integer
RankOrder:
enum:
- ASCENDING
- DESCENDING
type: string
ValueImportanceItems:
items:
additionalProperties: false
properties:
Key:
maxLength: 50
minLength: 1
type: string
Value:
maximum: 10
minimum: 1
type: integer
type: object
type: array
type: object
Search:
additionalProperties: false
properties:
Displayable:
type: boolean
Facetable:
type: boolean
Searchable:
type: boolean
Sortable:
type: boolean
type: object
Type:
enum:
- STRING_VALUE
- STRING_LIST_VALUE
- LONG_VALUE
- DATE_VALUE
type: string
required:
- Name
- Type
type: object
DocumentMetadataConfigurationList:
items:
additionalProperties: false
properties:
Name:
maxLength: 30
minLength: 1
type: string
Relevance:
additionalProperties: false
properties:
Duration:
maxLength: 10
minLength: 1
pattern: '[0-9]+[s]'
type: string
Freshness:
type: boolean
Importance:
maximum: 10
minimum: 1
type: integer
RankOrder:
enum:
- ASCENDING
- DESCENDING
type: string
ValueImportanceItems:
items:
additionalProperties: false
properties:
Key:
maxLength: 50
minLength: 1
type: string
Value:
maximum: 10
minimum: 1
type: integer
type: object
type: array
type: object
Search:
additionalProperties: false
properties:
Displayable:
type: boolean
Facetable:
type: boolean
Searchable:
type: boolean
Sortable:
type: boolean
type: object
Type:
enum:
- STRING_VALUE
- STRING_LIST_VALUE
- LONG_VALUE
- DATE_VALUE
type: string
required:
- Name
- Type
type: object
maxItems: 500
type: array
DocumentMetadataConfigurationName:
maxLength: 30
minLength: 1
type: string
Duration:
maxLength: 10
minLength: 1
pattern: '[0-9]+[s]'
type: string
Edition:
description: Edition of index
enum:
- DEVELOPER_EDITION
- ENTERPRISE_EDITION
type: string
Freshness:
type: boolean
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
Id:
description: Unique ID of index
maxLength: 36
minLength: 36
type: string
Importance:
maximum: 10
minimum: 1
type: integer
Issuer:
maxLength: 65
minLength: 1
type: string
JsonTokenTypeConfiguration:
additionalProperties: false
properties:
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- UserNameAttributeField
- GroupAttributeField
type: object
JwtTokenTypeConfiguration:
additionalProperties: false
properties:
ClaimRegex:
maxLength: 100
minLength: 1
type: string
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
Issuer:
maxLength: 65
minLength: 1
type: string
KeyLocation:
enum:
- URL
- SECRET_MANAGER
type: string
SecretManagerArn:
description: Role Arn
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
URL:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file):\/\/([^\s]*)
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- KeyLocation
type: object
KeyLocation:
enum:
- URL
- SECRET_MANAGER
type: string
KmsKeyId:
maxLength: 2048
minLength: 1
type: string
Name:
description: Name of index
maxLength: 1000
minLength: 1
type: string
Order:
enum:
- ASCENDING
- DESCENDING
type: string
QueryCapacityUnits:
minimum: 0
type: integer
Relevance:
additionalProperties: false
properties:
Duration:
maxLength: 10
minLength: 1
pattern: '[0-9]+[s]'
type: string
Freshness:
type: boolean
Importance:
maximum: 10
minimum: 1
type: integer
RankOrder:
enum:
- ASCENDING
- DESCENDING
type: string
ValueImportanceItems:
items:
additionalProperties: false
properties:
Key:
maxLength: 50
minLength: 1
type: string
Value:
maximum: 10
minimum: 1
type: integer
type: object
type: array
type: object
RoleArn:
description: Role Arn
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Search:
additionalProperties: false
properties:
Displayable:
type: boolean
Facetable:
type: boolean
Searchable:
type: boolean
Sortable:
type: boolean
type: object
ServerSideEncryptionConfiguration:
additionalProperties: false
properties:
KmsKeyId:
maxLength: 2048
minLength: 1
type: string
type: object
StorageCapacityUnits:
minimum: 0
type: integer
Tag:
additionalProperties: false
description: A label for tagging Kendra resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
TagList:
description: List of tags
items:
additionalProperties: false
description: A label for tagging Kendra resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
maxItems: 200
type: array
Url:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file):\/\/([^\s]*)
type: string
UserContextPolicy:
enum:
- ATTRIBUTE_FILTER
- USER_TOKEN
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
UserTokenConfiguration:
additionalProperties: false
properties:
JsonTokenTypeConfiguration:
additionalProperties: false
properties:
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- UserNameAttributeField
- GroupAttributeField
type: object
JwtTokenTypeConfiguration:
additionalProperties: false
properties:
ClaimRegex:
maxLength: 100
minLength: 1
type: string
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
Issuer:
maxLength: 65
minLength: 1
type: string
KeyLocation:
enum:
- URL
- SECRET_MANAGER
type: string
SecretManagerArn:
description: Role Arn
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
URL:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file):\/\/([^\s]*)
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- KeyLocation
type: object
type: object
UserTokenConfigurationList:
items:
additionalProperties: false
properties:
JsonTokenTypeConfiguration:
additionalProperties: false
properties:
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- UserNameAttributeField
- GroupAttributeField
type: object
JwtTokenTypeConfiguration:
additionalProperties: false
properties:
ClaimRegex:
maxLength: 100
minLength: 1
type: string
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
Issuer:
maxLength: 65
minLength: 1
type: string
KeyLocation:
enum:
- URL
- SECRET_MANAGER
type: string
SecretManagerArn:
description: Role Arn
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
URL:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file):\/\/([^\s]*)
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- KeyLocation
type: object
type: object
maxItems: 1
type: array
ValueImportanceItem:
additionalProperties: false
properties:
Key:
maxLength: 50
minLength: 1
type: string
Value:
maximum: 10
minimum: 1
type: integer
type: object
ValueImportanceItemKey:
maxLength: 50
minLength: 1
type: string
ValueImportanceItems:
items:
additionalProperties: false
properties:
Key:
maxLength: 50
minLength: 1
type: string
Value:
maximum: 10
minimum: 1
type: integer
type: object
type: array
properties:
CapacityUnits:
additionalProperties: false
properties:
QueryCapacityUnits:
minimum: 0
type: integer
StorageCapacityUnits:
minimum: 0
type: integer
required:
- StorageCapacityUnits
- QueryCapacityUnits
type: object
Description:
maxLength: 1000
type: string
DocumentMetadataConfigurations:
items:
additionalProperties: false
properties:
Name:
maxLength: 30
minLength: 1
type: string
Relevance:
additionalProperties: false
properties:
Duration:
maxLength: 10
minLength: 1
pattern: '[0-9]+[s]'
type: string
Freshness:
type: boolean
Importance:
maximum: 10
minimum: 1
type: integer
RankOrder:
enum:
- ASCENDING
- DESCENDING
type: string
ValueImportanceItems:
items:
additionalProperties: false
properties:
Key:
maxLength: 50
minLength: 1
type: string
Value:
maximum: 10
minimum: 1
type: integer
type: object
type: array
type: object
Search:
additionalProperties: false
properties:
Displayable:
type: boolean
Facetable:
type: boolean
Searchable:
type: boolean
Sortable:
type: boolean
type: object
Type:
enum:
- STRING_VALUE
- STRING_LIST_VALUE
- LONG_VALUE
- DATE_VALUE
type: string
required:
- Name
- Type
type: object
maxItems: 500
type: array
Name:
description: Name of index
maxLength: 1000
minLength: 1
type: string
RoleArn:
description: Role Arn
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
Tags:
description: List of tags
items:
additionalProperties: false
description: A label for tagging Kendra resources
properties:
Key:
description: A string used to identify this tag
maxLength: 128
minLength: 1
type: string
Value:
description: A string containing the value for the tag
maxLength: 256
minLength: 0
type: string
required:
- Key
- Value
type: object
maxItems: 200
type: array
UserContextPolicy:
enum:
- ATTRIBUTE_FILTER
- USER_TOKEN
type: string
UserTokenConfigurations:
items:
additionalProperties: false
properties:
JsonTokenTypeConfiguration:
additionalProperties: false
properties:
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- UserNameAttributeField
- GroupAttributeField
type: object
JwtTokenTypeConfiguration:
additionalProperties: false
properties:
ClaimRegex:
maxLength: 100
minLength: 1
type: string
GroupAttributeField:
maxLength: 100
minLength: 1
type: string
Issuer:
maxLength: 65
minLength: 1
type: string
KeyLocation:
enum:
- URL
- SECRET_MANAGER
type: string
SecretManagerArn:
description: Role Arn
maxLength: 1284
minLength: 1
pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
type: string
URL:
maxLength: 2048
minLength: 1
pattern: ^(https?|ftp|file):\/\/([^\s]*)
type: string
UserNameAttributeField:
maxLength: 100
minLength: 1
type: string
required:
- KeyLocation
type: object
type: object
maxItems: 1
type: array
type:
enum:
- update
Permissions - kendra:DescribeIndex, kendra:UpdateIndex, kendra:ListTagsForResource, kendra:TagResource, kendra:UntagResource, iam:PassRole