Skip to content

delete_data_source

Operation

delete_data_source

delete_data_source(request: DeleteDataSourceInput | DeleteDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDataSourceInputDict]) -> DeleteDataSourceOutput

Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

Parameters:

Name Type Description Default
request DeleteDataSourceInput | DeleteDataSourceInputDict | 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[DeleteDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDataSourceOutput

An instance of DeleteDataSourceOutput.

delete_data_source async

delete_data_source(request: DeleteDataSourceInput | DeleteDataSourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDataSourceInputDict]) -> DeleteDataSourceOutput

Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

Parameters:

Name Type Description Default
request DeleteDataSourceInput | DeleteDataSourceInputDict | 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[DeleteDataSourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteDataSourceOutput

An instance of DeleteDataSourceOutput.

Input

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

DeleteDataSourceInputDict

Bases: TypedDict

Dictionary form of DeleteDataSourceInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application used with the data source connector.

data_source_id instance-attribute
data_source_id: Required[str]

The identifier of the data source connector that you want to delete.

index_id instance-attribute
index_id: Required[str]

The identifier of the index used with the data source connector.

DeleteDataSourceInput dataclass

Bases: _SerdeShape

Dataclass for DeleteDataSourceInput structure.

Attributes

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

The identifier of the Amazon Q Business application used with the data source connector.

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

The identifier of the data source connector that you want to delete.

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

The identifier of the index used with the data source connector.

Output

DeleteDataSourceOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteDataSourceOutput structure.

Attributes

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.