2025/06/26 - QBusiness - 5 updated api methods
Changes Added support for App level authentication for QBusiness DataAccessor using AWS IAM Identity center Trusted Token issuer
{'conditions': [{'conditionKey': 'string',
'conditionOperator': 'StringEquals',
'conditionValues': ['string']}]}
Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.
See also: AWS API Documentation
Request Syntax
client.associate_permission(
applicationId='string',
statementId='string',
actions=[
'string',
],
conditions=[
{
'conditionOperator': 'StringEquals',
'conditionKey': 'string',
'conditionValues': [
'string',
]
},
],
principal='string'
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application.
string
[REQUIRED]
A unique identifier for the policy statement.
list
[REQUIRED]
The list of Amazon Q Business actions that the ISV is allowed to perform.
(string) --
list
The conditions that restrict when the permission is effective. These conditions can be used to limit the permission based on specific attributes of the request.
(dict) --
Defines a condition that restricts when a permission is effective. Conditions allow you to control access based on specific attributes of the request.
conditionOperator (string) -- [REQUIRED]
The operator to use for the condition evaluation. This determines how the condition values are compared.
conditionKey (string) -- [REQUIRED]
The key for the condition. This identifies the attribute that the condition applies to.
conditionValues (list) -- [REQUIRED]
The values to compare against using the specified condition operator.
(string) --
string
[REQUIRED]
The Amazon Resource Name of the IAM role for the ISV that is being granted permission.
dict
Response Syntax
{
'statement': 'string'
}
Response Structure
(dict) --
statement (string) --
The JSON representation of the added permission statement.
{'authenticationDetail': {'authenticationConfiguration': {'idcTrustedTokenIssuerConfiguration': {'idcTrustedTokenIssuerArn': 'string'}},
'authenticationType': 'AWS_IAM_IDC_TTI | '
'AWS_IAM_IDC_AUTH_CODE',
'externalIds': ['string']}}
Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
See also: AWS API Documentation
Request Syntax
client.create_data_accessor(
applicationId='string',
principal='string',
actionConfigurations=[
{
'action': 'string',
'filterConfiguration': {
'documentAttributeFilter': {
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
}
}
},
],
clientToken='string',
displayName='string',
authenticationDetail={
'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE',
'authenticationConfiguration': {
'idcTrustedTokenIssuerConfiguration': {
'idcTrustedTokenIssuerArn': 'string'
}
},
'externalIds': [
'string',
]
},
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.
list
[REQUIRED]
A list of action configurations specifying the allowed actions and any associated filters.
(dict) --
Specifies an allowed action and its associated filter configuration.
action (string) -- [REQUIRED]
The Amazon Q Business action that is allowed.
filterConfiguration (dict) --
The filter configuration for the action, if any.
documentAttributeFilter (dict) -- [REQUIRED]
Enables filtering of responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
string
A unique, case-sensitive identifier you provide to ensure idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
A friendly name for the data accessor.
dict
The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.
authenticationType (string) -- [REQUIRED]
The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:
AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.
authenticationConfiguration (dict) --
The specific authentication configuration based on the authentication type.
idcTrustedTokenIssuerConfiguration (dict) --
Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is AWS_IAM_IDC_TTI.
idcTrustedTokenIssuerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.
externalIds (list) --
A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.
(string) --
list
The tags to associate with the data accessor.
(dict) --
A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
key (string) -- [REQUIRED]
The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
value (string) -- [REQUIRED]
The value associated with the tag. The value may be an empty string but it can't be null.
dict
Response Syntax
{
'dataAccessorId': 'string',
'idcApplicationArn': 'string',
'dataAccessorArn': 'string'
}
Response Structure
(dict) --
dataAccessorId (string) --
The unique identifier of the created data accessor.
idcApplicationArn (string) --
The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.
dataAccessorArn (string) --
The Amazon Resource Name (ARN) of the created data accessor.
{'authenticationDetail': {'authenticationConfiguration': {'idcTrustedTokenIssuerConfiguration': {'idcTrustedTokenIssuerArn': 'string'}},
'authenticationType': 'AWS_IAM_IDC_TTI | '
'AWS_IAM_IDC_AUTH_CODE',
'externalIds': ['string']}}
Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.
See also: AWS API Documentation
Request Syntax
client.get_data_accessor(
applicationId='string',
dataAccessorId='string'
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application.
string
[REQUIRED]
The unique identifier of the data accessor to retrieve.
dict
Response Syntax
{
'displayName': 'string',
'dataAccessorId': 'string',
'dataAccessorArn': 'string',
'applicationId': 'string',
'idcApplicationArn': 'string',
'principal': 'string',
'actionConfigurations': [
{
'action': 'string',
'filterConfiguration': {
'documentAttributeFilter': {
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
}
}
},
],
'authenticationDetail': {
'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE',
'authenticationConfiguration': {
'idcTrustedTokenIssuerConfiguration': {
'idcTrustedTokenIssuerArn': 'string'
}
},
'externalIds': [
'string',
]
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
displayName (string) --
The friendly name of the data accessor.
dataAccessorId (string) --
The unique identifier of the data accessor.
dataAccessorArn (string) --
The Amazon Resource Name (ARN) of the data accessor.
applicationId (string) --
The unique identifier of the Amazon Q Business application associated with this data accessor.
idcApplicationArn (string) --
The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.
principal (string) --
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
actionConfigurations (list) --
The list of action configurations specifying the allowed actions and any associated filters.
(dict) --
Specifies an allowed action and its associated filter configuration.
action (string) --
The Amazon Q Business action that is allowed.
filterConfiguration (dict) --
The filter configuration for the action, if any.
documentAttributeFilter (dict) --
Enables filtering of responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) --
The identifier for the attribute.
value (dict) --
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
authenticationDetail (dict) --
The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.
authenticationType (string) --
The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:
AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.
authenticationConfiguration (dict) --
The specific authentication configuration based on the authentication type.
idcTrustedTokenIssuerConfiguration (dict) --
Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is AWS_IAM_IDC_TTI.
idcTrustedTokenIssuerArn (string) --
The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.
externalIds (list) --
A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.
(string) --
createdAt (datetime) --
The timestamp when the data accessor was created.
updatedAt (datetime) --
The timestamp when the data accessor was last updated.
{'dataAccessors': {'authenticationDetail': {'authenticationConfiguration': {'idcTrustedTokenIssuerConfiguration': {'idcTrustedTokenIssuerArn': 'string'}},
'authenticationType': 'AWS_IAM_IDC_TTI '
'| '
'AWS_IAM_IDC_AUTH_CODE',
'externalIds': ['string']}}}
Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.
See also: AWS API Documentation
Request Syntax
client.list_data_accessors(
applicationId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application.
string
The token for the next set of results. (You received this token from a previous call.)
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'dataAccessors': [
{
'displayName': 'string',
'dataAccessorId': 'string',
'dataAccessorArn': 'string',
'idcApplicationArn': 'string',
'principal': 'string',
'authenticationDetail': {
'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE',
'authenticationConfiguration': {
'idcTrustedTokenIssuerConfiguration': {
'idcTrustedTokenIssuerArn': 'string'
}
},
'externalIds': [
'string',
]
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataAccessors (list) --
The list of data accessors.
(dict) --
Provides summary information about a data accessor.
displayName (string) --
The friendly name of the data accessor.
dataAccessorId (string) --
The unique identifier of the data accessor.
dataAccessorArn (string) --
The Amazon Resource Name (ARN) of the data accessor.
idcApplicationArn (string) --
The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
principal (string) --
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
authenticationDetail (dict) --
The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.
authenticationType (string) --
The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:
AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.
authenticationConfiguration (dict) --
The specific authentication configuration based on the authentication type.
idcTrustedTokenIssuerConfiguration (dict) --
Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is AWS_IAM_IDC_TTI.
idcTrustedTokenIssuerArn (string) --
The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.
externalIds (list) --
A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.
(string) --
createdAt (datetime) --
The timestamp when the data accessor was created.
updatedAt (datetime) --
The timestamp when the data accessor was last updated.
nextToken (string) --
The token to use to retrieve the next set of results, if there are any.
{'authenticationDetail': {'authenticationConfiguration': {'idcTrustedTokenIssuerConfiguration': {'idcTrustedTokenIssuerArn': 'string'}},
'authenticationType': 'AWS_IAM_IDC_TTI | '
'AWS_IAM_IDC_AUTH_CODE',
'externalIds': ['string']}}
Updates an existing data accessor. This operation allows modifying the action configurations (the allowed actions and associated filters) and the display name of the data accessor. It does not allow changing the IAM role associated with the data accessor or other core properties of the data accessor.
See also: AWS API Documentation
Request Syntax
client.update_data_accessor(
applicationId='string',
dataAccessorId='string',
actionConfigurations=[
{
'action': 'string',
'filterConfiguration': {
'documentAttributeFilter': {
'andAllFilters': [
{'... recursive ...'},
],
'orAllFilters': [
{'... recursive ...'},
],
'notFilter': {'... recursive ...'},
'equalsTo': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAll': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'containsAny': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'greaterThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThan': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
},
'lessThanOrEquals': {
'name': 'string',
'value': {
'stringValue': 'string',
'stringListValue': [
'string',
],
'longValue': 123,
'dateValue': datetime(2015, 1, 1)
}
}
}
}
},
],
authenticationDetail={
'authenticationType': 'AWS_IAM_IDC_TTI'|'AWS_IAM_IDC_AUTH_CODE',
'authenticationConfiguration': {
'idcTrustedTokenIssuerConfiguration': {
'idcTrustedTokenIssuerArn': 'string'
}
},
'externalIds': [
'string',
]
},
displayName='string'
)
string
[REQUIRED]
The unique identifier of the Amazon Q Business application.
string
[REQUIRED]
The unique identifier of the data accessor to update.
list
[REQUIRED]
The updated list of action configurations specifying the allowed actions and any associated filters.
(dict) --
Specifies an allowed action and its associated filter configuration.
action (string) -- [REQUIRED]
The Amazon Q Business action that is allowed.
filterConfiguration (dict) --
The filter configuration for the action, if any.
documentAttributeFilter (dict) -- [REQUIRED]
Enables filtering of responses based on document attributes or metadata fields.
andAllFilters (list) --
Performs a logical AND operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
orAllFilters (list) --
Performs a logical OR operation on all supplied filters.
(dict) --
Enables filtering of responses based on document attributes or metadata fields.
notFilter (dict) --
Performs a logical NOT operation on all supplied filters.
equalsTo (dict) --
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAll (dict) --
Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
containsAny (dict) --
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThan (dict) --
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
greaterThanOrEquals (dict) --
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThan (dict) --
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
lessThanOrEquals (dict) --
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue and longValue.
name (string) -- [REQUIRED]
The identifier for the attribute.
value (dict) -- [REQUIRED]
The value of the attribute.
stringValue (string) --
A string.
stringListValue (list) --
A list of strings.
(string) --
longValue (integer) --
A long integer value.
dateValue (datetime) --
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
dict
The updated authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.
authenticationType (string) -- [REQUIRED]
The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:
AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.
authenticationConfiguration (dict) --
The specific authentication configuration based on the authentication type.
idcTrustedTokenIssuerConfiguration (dict) --
Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is AWS_IAM_IDC_TTI.
idcTrustedTokenIssuerArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.
externalIds (list) --
A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.
(string) --
string
The updated friendly name for the data accessor.
dict
Response Syntax
{}
Response Structure
(dict) --