Skip to content

CreateDataAccessorRequest

Source code in docs_src/capo_qbusiness/types/create_data_accessor_request.py
class CreateDataAccessorRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The unique identifier of the Amazon Q Business application.</p>"""
    principal: "capo_qbusiness.types.principal_role_arn.PrincipalRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.</p>"""
    action_configurations: (
        "capo_qbusiness.types.action_configuration_list.ActionConfigurationList"
    )
    """<p>A list of action configurations specifying the allowed actions and any associated filters.</p>"""
    client_token: NotRequired["capo_qbusiness.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier you provide to ensure idempotency of the request.</p>"""
    display_name: "capo_qbusiness.types.data_accessor_name.DataAccessorName"
    """<p>A friendly name for the data accessor.</p>"""
    authentication_detail: NotRequired[
        "capo_qbusiness.types.data_accessor_authentication_detail.DataAccessorAuthenticationDetail"
    ]
    """<p>The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.</p>"""
    tags: NotRequired["capo_qbusiness.types.tags.Tags"]
    """<p>The tags to associate with the data accessor.</p>"""

action_configurations instance-attribute

action_configurations: ActionConfigurationList

A list of action configurations specifying the allowed actions and any associated filters.

application_id instance-attribute

application_id: ApplicationId

The unique identifier of the Amazon Q Business application.

authentication_detail instance-attribute

authentication_detail: NotRequired[DataAccessorAuthenticationDetail]

The authentication configuration details for the data accessor. This specifies how the ISV will authenticate when accessing data through this data accessor.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier you provide to ensure idempotency of the request.

display_name instance-attribute

display_name: DataAccessorName

A friendly name for the data accessor.

principal instance-attribute

principal: PrincipalRoleArn

The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.

tags instance-attribute

tags: NotRequired[Tags]

The tags to associate with the data accessor.