DataExchangeClient#
Index > DataExchange > DataExchangeClient
Auto-generated documentation for DataExchange type annotations stubs module types-boto3-dataexchange.
DataExchangeClient#
Type annotations and code completion for boto3.client("dataexchange").
 boto3 documentation
# DataExchangeClient usage example
from boto3.session import Session
from types_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 types_boto3_dataexchange.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
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:
    ...generate_presigned_url#
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:
    ...accept_data_grant#
This operation accepts a data grant.
Type annotations and code completion for boto3.client("dataexchange").accept_data_grant method.
 boto3 documentation
# accept_data_grant method definition
def accept_data_grant(
    self,
    *,
    DataGrantArn: str,
) -> AcceptDataGrantResponseTypeDef:  # (1)
    ...# accept_data_grant method usage example with argument unpacking
kwargs: AcceptDataGrantRequestTypeDef = {  # (1)
    "DataGrantArn": ...,
}
parent.accept_data_grant(**kwargs)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: CancelJobRequestTypeDef = {  # (1)
    "JobId": ...,
}
parent.cancel_job(**kwargs)create_data_grant#
This operation creates a data grant.
Type annotations and code completion for boto3.client("dataexchange").create_data_grant method.
 boto3 documentation
# create_data_grant method definition
def create_data_grant(
    self,
    *,
    Name: str,
    GrantDistributionScope: GrantDistributionScopeType,  # (1)
    ReceiverPrincipal: str,
    SourceDataSetId: str,
    EndsAt: TimestampTypeDef = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateDataGrantResponseTypeDef:  # (2)
    ...# create_data_grant method usage example with argument unpacking
kwargs: CreateDataGrantRequestTypeDef = {  # (1)
    "Name": ...,
    "GrantDistributionScope": ...,
    "ReceiverPrincipal": ...,
    "SourceDataSetId": ...,
}
parent.create_data_grant(**kwargs)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: CreateDataSetRequestTypeDef = {  # (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)
    Tags: Mapping[str, str] = ...,
) -> CreateEventActionResponseTypeDef:  # (3)
    ...# create_event_action method usage example with argument unpacking
kwargs: CreateEventActionRequestTypeDef = {  # (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: CreateJobRequestTypeDef = {  # (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: CreateRevisionRequestTypeDef = {  # (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: DeleteAssetRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "RevisionId": ...,
}
parent.delete_asset(**kwargs)delete_data_grant#
This operation deletes a data grant.
Type annotations and code completion for boto3.client("dataexchange").delete_data_grant method.
 boto3 documentation
# delete_data_grant method definition
def delete_data_grant(
    self,
    *,
    DataGrantId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# delete_data_grant method usage example with argument unpacking
kwargs: DeleteDataGrantRequestTypeDef = {  # (1)
    "DataGrantId": ...,
}
parent.delete_data_grant(**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: DeleteDataSetRequestTypeDef = {  # (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: DeleteEventActionRequestTypeDef = {  # (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: DeleteRevisionRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}
parent.delete_revision(**kwargs)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: GetAssetRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "RevisionId": ...,
}
parent.get_asset(**kwargs)get_data_grant#
This operation returns information about a data grant.
Type annotations and code completion for boto3.client("dataexchange").get_data_grant method.
 boto3 documentation
# get_data_grant method definition
def get_data_grant(
    self,
    *,
    DataGrantId: str,
) -> GetDataGrantResponseTypeDef:  # (1)
    ...# get_data_grant method usage example with argument unpacking
kwargs: GetDataGrantRequestTypeDef = {  # (1)
    "DataGrantId": ...,
}
parent.get_data_grant(**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: GetDataSetRequestTypeDef = {  # (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: GetEventActionRequestTypeDef = {  # (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: GetJobRequestTypeDef = {  # (1)
    "JobId": ...,
}
parent.get_job(**kwargs)get_received_data_grant#
This operation returns information about a received data grant.
Type annotations and code completion for boto3.client("dataexchange").get_received_data_grant method.
 boto3 documentation
# get_received_data_grant method definition
def get_received_data_grant(
    self,
    *,
    DataGrantArn: str,
) -> GetReceivedDataGrantResponseTypeDef:  # (1)
    ...# get_received_data_grant method usage example with argument unpacking
kwargs: GetReceivedDataGrantRequestTypeDef = {  # (1)
    "DataGrantArn": ...,
}
parent.get_received_data_grant(**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: GetRevisionRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}
parent.get_revision(**kwargs)list_data_grants#
This operation returns information about all data grants.
Type annotations and code completion for boto3.client("dataexchange").list_data_grants method.
 boto3 documentation
# list_data_grants method definition
def list_data_grants(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDataGrantsResponseTypeDef:  # (1)
    ...# list_data_grants method usage example with argument unpacking
kwargs: ListDataGrantsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_data_grants(**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.
 boto3 documentation
# list_data_set_revisions method definition
def list_data_set_revisions(
    self,
    *,
    DataSetId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDataSetRevisionsResponseTypeDef:  # (1)
    ...# list_data_set_revisions method usage example with argument unpacking
kwargs: ListDataSetRevisionsRequestTypeDef = {  # (1)
    "DataSetId": ...,
}
parent.list_data_set_revisions(**kwargs)list_data_sets#
This operation lists your data sets.
Type annotations and code completion for boto3.client("dataexchange").list_data_sets method.
 boto3 documentation
# list_data_sets method definition
def list_data_sets(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Origin: str = ...,
) -> ListDataSetsResponseTypeDef:  # (1)
    ...# list_data_sets method usage example with argument unpacking
kwargs: ListDataSetsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_data_sets(**kwargs)list_event_actions#
This operation lists your event actions.
Type annotations and code completion for boto3.client("dataexchange").list_event_actions method.
 boto3 documentation
# list_event_actions method definition
def list_event_actions(
    self,
    *,
    EventSourceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListEventActionsResponseTypeDef:  # (1)
    ...# list_event_actions method usage example with argument unpacking
kwargs: ListEventActionsRequestTypeDef = {  # (1)
    "EventSourceId": ...,
}
parent.list_event_actions(**kwargs)list_jobs#
This operation lists your jobs sorted by CreatedAt in descending order.
Type annotations and code completion for boto3.client("dataexchange").list_jobs method.
 boto3 documentation
# list_jobs method definition
def list_jobs(
    self,
    *,
    DataSetId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    RevisionId: str = ...,
) -> ListJobsResponseTypeDef:  # (1)
    ...# list_jobs method usage example with argument unpacking
kwargs: ListJobsRequestTypeDef = {  # (1)
    "DataSetId": ...,
}
parent.list_jobs(**kwargs)list_received_data_grants#
This operation returns information about all received data grants.
Type annotations and code completion for boto3.client("dataexchange").list_received_data_grants method.
 boto3 documentation
# list_received_data_grants method definition
def list_received_data_grants(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    AcceptanceState: Sequence[AcceptanceStateFilterValueType] = ...,  # (1)
) -> ListReceivedDataGrantsResponseTypeDef:  # (2)
    ...- See Sequence[AcceptanceStateFilterValueType]
- See ListReceivedDataGrantsResponseTypeDef
# list_received_data_grants method usage example with argument unpacking
kwargs: ListReceivedDataGrantsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_received_data_grants(**kwargs)list_revision_assets#
This operation lists a revision's assets sorted alphabetically in descending order.
Type annotations and code completion for boto3.client("dataexchange").list_revision_assets method.
 boto3 documentation
# list_revision_assets method definition
def list_revision_assets(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRevisionAssetsResponseTypeDef:  # (1)
    ...# list_revision_assets method usage example with argument unpacking
kwargs: ListRevisionAssetsRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}
parent.list_revision_assets(**kwargs)list_tags_for_resource#
This operation lists the tags on the resource.
Type annotations and code completion for boto3.client("dataexchange").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)revoke_revision#
This operation revokes subscribers' access to a revision.
Type annotations and code completion for boto3.client("dataexchange").revoke_revision method.
 boto3 documentation
# revoke_revision method definition
def revoke_revision(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
    RevocationComment: str,
) -> RevokeRevisionResponseTypeDef:  # (1)
    ...# revoke_revision method usage example with argument unpacking
kwargs: RevokeRevisionRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
    "RevocationComment": ...,
}
parent.revoke_revision(**kwargs)send_api_asset#
This operation invokes an API Gateway API asset.
Type annotations and code completion for boto3.client("dataexchange").send_api_asset method.
 boto3 documentation
# send_api_asset method definition
def send_api_asset(
    self,
    *,
    AssetId: str,
    DataSetId: str,
    RevisionId: str,
    Body: str = ...,
    QueryStringParameters: Mapping[str, str] = ...,
    RequestHeaders: Mapping[str, str] = ...,
    Method: str = ...,
    Path: str = ...,
) -> SendApiAssetResponseTypeDef:  # (1)
    ...# send_api_asset method usage example with argument unpacking
kwargs: SendApiAssetRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "RevisionId": ...,
}
parent.send_api_asset(**kwargs)send_data_set_notification#
The type of event associated with the data set.
Type annotations and code completion for boto3.client("dataexchange").send_data_set_notification method.
 boto3 documentation
# send_data_set_notification method definition
def send_data_set_notification(
    self,
    *,
    DataSetId: str,
    Type: NotificationTypeType,  # (1)
    Scope: ScopeDetailsTypeDef = ...,  # (2)
    ClientToken: str = ...,
    Comment: str = ...,
    Details: NotificationDetailsTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...# send_data_set_notification method usage example with argument unpacking
kwargs: SendDataSetNotificationRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "Type": ...,
}
parent.send_data_set_notification(**kwargs)start_job#
This operation starts a job.
Type annotations and code completion for boto3.client("dataexchange").start_job method.
 boto3 documentation
# start_job method definition
def start_job(
    self,
    *,
    JobId: str,
) -> Dict[str, Any]:
    ...# start_job method usage example with argument unpacking
kwargs: StartJobRequestTypeDef = {  # (1)
    "JobId": ...,
}
parent.start_job(**kwargs)tag_resource#
This operation tags a resource.
Type annotations and code completion for boto3.client("dataexchange").tag_resource method.
 boto3 documentation
# tag_resource method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
This operation removes one or more tags from a resource.
Type annotations and code completion for boto3.client("dataexchange").untag_resource method.
 boto3 documentation
# untag_resource method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}
parent.untag_resource(**kwargs)update_asset#
This operation updates an asset.
Type annotations and code completion for boto3.client("dataexchange").update_asset method.
 boto3 documentation
# update_asset method definition
def update_asset(
    self,
    *,
    AssetId: str,
    DataSetId: str,
    Name: str,
    RevisionId: str,
) -> UpdateAssetResponseTypeDef:  # (1)
    ...# update_asset method usage example with argument unpacking
kwargs: UpdateAssetRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "Name": ...,
    "RevisionId": ...,
}
parent.update_asset(**kwargs)update_data_set#
This operation updates a data set.
Type annotations and code completion for boto3.client("dataexchange").update_data_set method.
 boto3 documentation
# update_data_set method definition
def update_data_set(
    self,
    *,
    DataSetId: str,
    Description: str = ...,
    Name: str = ...,
) -> UpdateDataSetResponseTypeDef:  # (1)
    ...# update_data_set method usage example with argument unpacking
kwargs: UpdateDataSetRequestTypeDef = {  # (1)
    "DataSetId": ...,
}
parent.update_data_set(**kwargs)update_event_action#
This operation updates the event action.
Type annotations and code completion for boto3.client("dataexchange").update_event_action method.
 boto3 documentation
# update_event_action method definition
def update_event_action(
    self,
    *,
    EventActionId: str,
    Action: ActionTypeDef = ...,  # (1)
) -> UpdateEventActionResponseTypeDef:  # (2)
    ...# update_event_action method usage example with argument unpacking
kwargs: UpdateEventActionRequestTypeDef = {  # (1)
    "EventActionId": ...,
}
parent.update_event_action(**kwargs)update_revision#
This operation updates a revision.
Type annotations and code completion for boto3.client("dataexchange").update_revision method.
 boto3 documentation
# update_revision method definition
def update_revision(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
    Comment: str = ...,
    Finalized: bool = ...,
) -> UpdateRevisionResponseTypeDef:  # (1)
    ...# update_revision method usage example with argument unpacking
kwargs: UpdateRevisionRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}
parent.update_revision(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("dataexchange").get_paginator method with overloads.
- client.get_paginator("list_data_grants")-> ListDataGrantsPaginator
- client.get_paginator("list_data_set_revisions")-> ListDataSetRevisionsPaginator
- client.get_paginator("list_data_sets")-> ListDataSetsPaginator
- client.get_paginator("list_event_actions")-> ListEventActionsPaginator
- client.get_paginator("list_jobs")-> ListJobsPaginator
- client.get_paginator("list_received_data_grants")-> ListReceivedDataGrantsPaginator
- client.get_paginator("list_revision_assets")-> ListRevisionAssetsPaginator