Skip to content

create_data_accessor

Operation

create_data_accessor

create_data_accessor(request: CreateDataAccessorInput | CreateDataAccessorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDataAccessorInputDict]) -> CreateDataAccessorOutput

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.

Parameters:

Name Type Description Default
request CreateDataAccessorInput | CreateDataAccessorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateDataAccessorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDataAccessorOutput

An instance of CreateDataAccessorOutput.

create_data_accessor async

create_data_accessor(request: CreateDataAccessorInput | CreateDataAccessorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDataAccessorInputDict]) -> CreateDataAccessorOutput

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.

Parameters:

Name Type Description Default
request CreateDataAccessorInput | CreateDataAccessorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateDataAccessorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDataAccessorOutput

An instance of CreateDataAccessorOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateDataAccessorInputDict

Bases: TypedDict

Dictionary form of CreateDataAccessorInput.

Attributes

action_configurations instance-attribute

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

application_id instance-attribute
application_id: Required[str]

The unique identifier of the Amazon Q Business application.

authentication_detail instance-attribute

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: str | None

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

This field is autopopulated if not provided.

display_name instance-attribute
display_name: Required[str]

A friendly name for the data accessor.

principal instance-attribute
principal: Required[str]

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

tags instance-attribute
tags: Sequence[Tag | TagDict] | None

The tags to associate with the data accessor.

CreateDataAccessorInput dataclass

Bases: _SerdeShape

Dataclass for CreateDataAccessorInput structure.

Attributes

action_configurations class-attribute instance-attribute
action_configurations: list[ActionConfiguration] | None = ...

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

application_id class-attribute instance-attribute
application_id: str | None = ...

The unique identifier of the Amazon Q Business application.

authentication_detail class-attribute instance-attribute
authentication_detail: DataAccessorAuthenticationDetail | None = ...

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

client_token class-attribute instance-attribute
client_token: str | None = ...

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

This field is autopopulated if not provided.

display_name class-attribute instance-attribute
display_name: str | None = ...

A friendly name for the data accessor.

principal class-attribute instance-attribute
principal: str | None = ...

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

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

The tags to associate with the data accessor.

Output

CreateDataAccessorOutput dataclass

Bases: _SerdeShape

Dataclass for CreateDataAccessorOutput structure.

Attributes

data_accessor_arn instance-attribute
data_accessor_arn: str

The Amazon Resource Name (ARN) of the created data accessor.

data_accessor_id instance-attribute
data_accessor_id: str

The unique identifier of the created data accessor.

idc_application_arn instance-attribute
idc_application_arn: str

The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.