DataExchangeClient#
Index > DataExchange > DataExchangeClient
Auto-generated documentation for DataExchange type annotations stubs module mypy-boto3-dataexchange.
DataExchangeClient#
Type annotations and code completion for boto3.client("dataexchange")
.
boto3 documentation
# DataExchangeClient usage example
from boto3.session import Session
from mypy_boto3_dataexchange.client import DataExchangeClient
def get_dataexchange_client() -> DataExchangeClient:
return Session().client("dataexchange")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("dataexchange").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("dataexchange")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceLimitExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_dataexchange.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("dataexchange").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_job#
This operation cancels a job.
Type annotations and code completion for boto3.client("dataexchange").cancel_job
method.
boto3 documentation
# cancel_job method definition
def cancel_job(
self,
*,
JobId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# cancel_job method usage example with argument unpacking
kwargs: CancelJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.cancel_job(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("dataexchange").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_data_set#
This operation creates a data set.
Type annotations and code completion for boto3.client("dataexchange").create_data_set
method.
boto3 documentation
# create_data_set method definition
def create_data_set(
self,
*,
AssetType: AssetTypeType, # (1)
Description: str,
Name: str,
Tags: Mapping[str, str] = ...,
) -> CreateDataSetResponseTypeDef: # (2)
...
# create_data_set method usage example with argument unpacking
kwargs: CreateDataSetRequestRequestTypeDef = { # (1)
"AssetType": ...,
"Description": ...,
"Name": ...,
}
parent.create_data_set(**kwargs)
create_event_action#
This operation creates an event action.
Type annotations and code completion for boto3.client("dataexchange").create_event_action
method.
boto3 documentation
# create_event_action method definition
def create_event_action(
self,
*,
Action: ActionTypeDef, # (1)
Event: EventTypeDef, # (2)
) -> CreateEventActionResponseTypeDef: # (3)
...
# create_event_action method usage example with argument unpacking
kwargs: CreateEventActionRequestRequestTypeDef = { # (1)
"Action": ...,
"Event": ...,
}
parent.create_event_action(**kwargs)
create_job#
This operation creates a job.
Type annotations and code completion for boto3.client("dataexchange").create_job
method.
boto3 documentation
# create_job method definition
def create_job(
self,
*,
Details: RequestDetailsTypeDef, # (1)
Type: TypeType, # (2)
) -> CreateJobResponseTypeDef: # (3)
...
- See RequestDetailsTypeDef
- See TypeType
- See CreateJobResponseTypeDef
# create_job method usage example with argument unpacking
kwargs: CreateJobRequestRequestTypeDef = { # (1)
"Details": ...,
"Type": ...,
}
parent.create_job(**kwargs)
create_revision#
This operation creates a revision for a data set.
Type annotations and code completion for boto3.client("dataexchange").create_revision
method.
boto3 documentation
# create_revision method definition
def create_revision(
self,
*,
DataSetId: str,
Comment: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateRevisionResponseTypeDef: # (1)
...
# create_revision method usage example with argument unpacking
kwargs: CreateRevisionRequestRequestTypeDef = { # (1)
"DataSetId": ...,
}
parent.create_revision(**kwargs)
delete_asset#
This operation deletes an asset.
Type annotations and code completion for boto3.client("dataexchange").delete_asset
method.
boto3 documentation
# delete_asset method definition
def delete_asset(
self,
*,
AssetId: str,
DataSetId: str,
RevisionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_asset method usage example with argument unpacking
kwargs: DeleteAssetRequestRequestTypeDef = { # (1)
"AssetId": ...,
"DataSetId": ...,
"RevisionId": ...,
}
parent.delete_asset(**kwargs)
delete_data_set#
This operation deletes a data set.
Type annotations and code completion for boto3.client("dataexchange").delete_data_set
method.
boto3 documentation
# delete_data_set method definition
def delete_data_set(
self,
*,
DataSetId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_data_set method usage example with argument unpacking
kwargs: DeleteDataSetRequestRequestTypeDef = { # (1)
"DataSetId": ...,
}
parent.delete_data_set(**kwargs)
delete_event_action#
This operation deletes the event action.
Type annotations and code completion for boto3.client("dataexchange").delete_event_action
method.
boto3 documentation
# delete_event_action method definition
def delete_event_action(
self,
*,
EventActionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_event_action method usage example with argument unpacking
kwargs: DeleteEventActionRequestRequestTypeDef = { # (1)
"EventActionId": ...,
}
parent.delete_event_action(**kwargs)
delete_revision#
This operation deletes a revision.
Type annotations and code completion for boto3.client("dataexchange").delete_revision
method.
boto3 documentation
# delete_revision method definition
def delete_revision(
self,
*,
DataSetId: str,
RevisionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_revision method usage example with argument unpacking
kwargs: DeleteRevisionRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"RevisionId": ...,
}
parent.delete_revision(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("dataexchange").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_asset#
This operation returns information about an asset.
Type annotations and code completion for boto3.client("dataexchange").get_asset
method.
boto3 documentation
# get_asset method definition
def get_asset(
self,
*,
AssetId: str,
DataSetId: str,
RevisionId: str,
) -> GetAssetResponseTypeDef: # (1)
...
# get_asset method usage example with argument unpacking
kwargs: GetAssetRequestRequestTypeDef = { # (1)
"AssetId": ...,
"DataSetId": ...,
"RevisionId": ...,
}
parent.get_asset(**kwargs)
get_data_set#
This operation returns information about a data set.
Type annotations and code completion for boto3.client("dataexchange").get_data_set
method.
boto3 documentation
# get_data_set method definition
def get_data_set(
self,
*,
DataSetId: str,
) -> GetDataSetResponseTypeDef: # (1)
...
# get_data_set method usage example with argument unpacking
kwargs: GetDataSetRequestRequestTypeDef = { # (1)
"DataSetId": ...,
}
parent.get_data_set(**kwargs)
get_event_action#
This operation retrieves information about an event action.
Type annotations and code completion for boto3.client("dataexchange").get_event_action
method.
boto3 documentation
# get_event_action method definition
def get_event_action(
self,
*,
EventActionId: str,
) -> GetEventActionResponseTypeDef: # (1)
...
# get_event_action method usage example with argument unpacking
kwargs: GetEventActionRequestRequestTypeDef = { # (1)
"EventActionId": ...,
}
parent.get_event_action(**kwargs)
get_job#
This operation returns information about a job.
Type annotations and code completion for boto3.client("dataexchange").get_job
method.
boto3 documentation
# get_job method definition
def get_job(
self,
*,
JobId: str,
) -> GetJobResponseTypeDef: # (1)
...
# get_job method usage example with argument unpacking
kwargs: GetJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.get_job(**kwargs)
get_revision#
This operation returns information about a revision.
Type annotations and code completion for boto3.client("dataexchange").get_revision
method.
boto3 documentation
# get_revision method definition
def get_revision(
self,
*,
DataSetId: str,
RevisionId: str,
) -> GetRevisionResponseTypeDef: # (1)
...
# get_revision method usage example with argument unpacking
kwargs: GetRevisionRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"RevisionId": ...,
}
parent.get_revision(**kwargs)
list_data_set_revisions#
This operation lists a data set's revisions sorted by CreatedAt in descending order.
Type annotations and code completion for boto3.client("dataexchange").list_data_set_revisions
method.