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

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.

Usage example

client = boto3.client("dataexchange")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceLimitExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

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

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

Method definition

def cancel_job(
    self,
    *,
    JobId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: CancelJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.cancel_job(**kwargs)

1. See CancelJobRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("dataexchange").close method. boto3 documentation

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

Method definition

def create_data_set(
    self,
    *,
    AssetType: AssetTypeType,  # (1)
    Description: str,
    Name: str,
    Tags: Mapping[str, str] = ...,
) -> CreateDataSetResponseTypeDef:  # (2)
    ...

1. See AssetTypeType
2. See CreateDataSetResponseTypeDef

Usage example with kwargs

kwargs: CreateDataSetRequestRequestTypeDef = {  # (1)
    "AssetType": ...,
    "Description": ...,
    "Name": ...,
}

parent.create_data_set(**kwargs)

1. See CreateDataSetRequestRequestTypeDef

create_event_action

This operation creates an event action.

Type annotations and code completion for boto3.client("dataexchange").create_event_action method. boto3 documentation

Method definition

def create_event_action(
    self,
    *,
    Action: ActionTypeDef,  # (1)
    Event: EventTypeDef,  # (2)
) -> CreateEventActionResponseTypeDef:  # (3)
    ...

1. See ActionTypeDef
2. See EventTypeDef
3. See CreateEventActionResponseTypeDef

Usage example with kwargs

kwargs: CreateEventActionRequestRequestTypeDef = {  # (1)
    "Action": ...,
    "Event": ...,
}

parent.create_event_action(**kwargs)

1. See CreateEventActionRequestRequestTypeDef

create_job

This operation creates a job.

Type annotations and code completion for boto3.client("dataexchange").create_job method. boto3 documentation

Method definition

def create_job(
    self,
    *,
    Details: RequestDetailsTypeDef,  # (1)
    Type: TypeType,  # (2)
) -> CreateJobResponseTypeDef:  # (3)
    ...

1. See RequestDetailsTypeDef
2. See TypeType
3. See CreateJobResponseTypeDef

Usage example with kwargs

kwargs: CreateJobRequestRequestTypeDef = {  # (1)
    "Details": ...,
    "Type": ...,
}

parent.create_job(**kwargs)

1. See CreateJobRequestRequestTypeDef

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

Method definition

def create_revision(
    self,
    *,
    DataSetId: str,
    Comment: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateRevisionResponseTypeDef:  # (1)
    ...

1. See CreateRevisionResponseTypeDef

Usage example with kwargs

kwargs: CreateRevisionRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
}

parent.create_revision(**kwargs)

1. See CreateRevisionRequestRequestTypeDef

delete_asset

This operation deletes an asset.

Type annotations and code completion for boto3.client("dataexchange").delete_asset method. boto3 documentation

Method definition

def delete_asset(
    self,
    *,
    AssetId: str,
    DataSetId: str,
    RevisionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteAssetRequestRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "RevisionId": ...,
}

parent.delete_asset(**kwargs)

1. See DeleteAssetRequestRequestTypeDef

delete_data_set

This operation deletes a data set.

Type annotations and code completion for boto3.client("dataexchange").delete_data_set method. boto3 documentation

Method definition

def delete_data_set(
    self,
    *,
    DataSetId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteDataSetRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
}

parent.delete_data_set(**kwargs)

1. See DeleteDataSetRequestRequestTypeDef

delete_event_action

This operation deletes the event action.

Type annotations and code completion for boto3.client("dataexchange").delete_event_action method. boto3 documentation

Method definition

def delete_event_action(
    self,
    *,
    EventActionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteEventActionRequestRequestTypeDef = {  # (1)
    "EventActionId": ...,
}

parent.delete_event_action(**kwargs)

1. See DeleteEventActionRequestRequestTypeDef

delete_revision

This operation deletes a revision.

Type annotations and code completion for boto3.client("dataexchange").delete_revision method. boto3 documentation

Method definition

def delete_revision(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteRevisionRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}

parent.delete_revision(**kwargs)

1. See DeleteRevisionRequestRequestTypeDef

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

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

Method definition

def get_asset(
    self,
    *,
    AssetId: str,
    DataSetId: str,
    RevisionId: str,
) -> GetAssetResponseTypeDef:  # (1)
    ...

1. See GetAssetResponseTypeDef

Usage example with kwargs

kwargs: GetAssetRequestRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "RevisionId": ...,
}

parent.get_asset(**kwargs)

1. See GetAssetRequestRequestTypeDef

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

Method definition

def get_data_set(
    self,
    *,
    DataSetId: str,
) -> GetDataSetResponseTypeDef:  # (1)
    ...

1. See GetDataSetResponseTypeDef

Usage example with kwargs

kwargs: GetDataSetRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
}

parent.get_data_set(**kwargs)

1. See GetDataSetRequestRequestTypeDef

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

Method definition

def get_event_action(
    self,
    *,
    EventActionId: str,
) -> GetEventActionResponseTypeDef:  # (1)
    ...

1. See GetEventActionResponseTypeDef

Usage example with kwargs

kwargs: GetEventActionRequestRequestTypeDef = {  # (1)
    "EventActionId": ...,
}

parent.get_event_action(**kwargs)

1. See GetEventActionRequestRequestTypeDef

get_job

This operation returns information about a job.

Type annotations and code completion for boto3.client("dataexchange").get_job method. boto3 documentation

Method definition

def get_job(
    self,
    *,
    JobId: str,
) -> GetJobResponseTypeDef:  # (1)
    ...

1. See GetJobResponseTypeDef

Usage example with kwargs

kwargs: GetJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_job(**kwargs)

1. See GetJobRequestRequestTypeDef

get_revision

This operation returns information about a revision.

Type annotations and code completion for boto3.client("dataexchange").get_revision method. boto3 documentation

Method definition

def get_revision(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
) -> GetRevisionResponseTypeDef:  # (1)
    ...

1. See GetRevisionResponseTypeDef

Usage example with kwargs

kwargs: GetRevisionRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}

parent.get_revision(**kwargs)

1. See GetRevisionRequestRequestTypeDef

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

Method definition

def list_data_set_revisions(
    self,
    *,
    DataSetId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDataSetRevisionsResponseTypeDef:  # (1)
    ...

1. See ListDataSetRevisionsResponseTypeDef

Usage example with kwargs

kwargs: ListDataSetRevisionsRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
}

parent.list_data_set_revisions(**kwargs)

1. See ListDataSetRevisionsRequestRequestTypeDef

list_data_sets

This operation lists your data sets.

Type annotations and code completion for boto3.client("dataexchange").list_data_sets method. boto3 documentation

Method definition

def list_data_sets(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Origin: str = ...,
) -> ListDataSetsResponseTypeDef:  # (1)
    ...

1. See ListDataSetsResponseTypeDef

Usage example with kwargs

kwargs: ListDataSetsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_data_sets(**kwargs)

1. See ListDataSetsRequestRequestTypeDef

list_event_actions

This operation lists your event actions.

Type annotations and code completion for boto3.client("dataexchange").list_event_actions method. boto3 documentation

Method definition

def list_event_actions(
    self,
    *,
    EventSourceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListEventActionsResponseTypeDef:  # (1)
    ...

1. See ListEventActionsResponseTypeDef

Usage example with kwargs

kwargs: ListEventActionsRequestRequestTypeDef = {  # (1)
    "EventSourceId": ...,
}

parent.list_event_actions(**kwargs)

1. See ListEventActionsRequestRequestTypeDef

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

Method definition

def list_jobs(
    self,
    *,
    DataSetId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    RevisionId: str = ...,
) -> ListJobsResponseTypeDef:  # (1)
    ...

1. See ListJobsResponseTypeDef

Usage example with kwargs

kwargs: ListJobsRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
}

parent.list_jobs(**kwargs)

1. See ListJobsRequestRequestTypeDef

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

Method definition

def list_revision_assets(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRevisionAssetsResponseTypeDef:  # (1)
    ...

1. See ListRevisionAssetsResponseTypeDef

Usage example with kwargs

kwargs: ListRevisionAssetsRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}

parent.list_revision_assets(**kwargs)

1. See ListRevisionAssetsRequestRequestTypeDef

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

revoke_revision

This operation revokes subscribers' access to a revision.

Type annotations and code completion for boto3.client("dataexchange").revoke_revision method. boto3 documentation

Method definition

def revoke_revision(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
    RevocationComment: str,
) -> RevokeRevisionResponseTypeDef:  # (1)
    ...

1. See RevokeRevisionResponseTypeDef

Usage example with kwargs

kwargs: RevokeRevisionRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
    "RevocationComment": ...,
}

parent.revoke_revision(**kwargs)

1. See RevokeRevisionRequestRequestTypeDef

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

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)
    ...

1. See SendApiAssetResponseTypeDef

Usage example with kwargs

kwargs: SendApiAssetRequestRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "RevisionId": ...,
}

parent.send_api_asset(**kwargs)

1. See SendApiAssetRequestRequestTypeDef

start_job

This operation starts a job.

Type annotations and code completion for boto3.client("dataexchange").start_job method. boto3 documentation

Method definition

def start_job(
    self,
    *,
    JobId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StartJobRequestRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.start_job(**kwargs)

1. See StartJobRequestRequestTypeDef

tag_resource

This operation tags a resource.

Type annotations and code completion for boto3.client("dataexchange").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_asset

This operation updates an asset.

Type annotations and code completion for boto3.client("dataexchange").update_asset method. boto3 documentation

Method definition

def update_asset(
    self,
    *,
    AssetId: str,
    DataSetId: str,
    Name: str,
    RevisionId: str,
) -> UpdateAssetResponseTypeDef:  # (1)
    ...

1. See UpdateAssetResponseTypeDef

Usage example with kwargs

kwargs: UpdateAssetRequestRequestTypeDef = {  # (1)
    "AssetId": ...,
    "DataSetId": ...,
    "Name": ...,
    "RevisionId": ...,
}

parent.update_asset(**kwargs)

1. See UpdateAssetRequestRequestTypeDef

update_data_set

This operation updates a data set.

Type annotations and code completion for boto3.client("dataexchange").update_data_set method. boto3 documentation

Method definition

def update_data_set(
    self,
    *,
    DataSetId: str,
    Description: str = ...,
    Name: str = ...,
) -> UpdateDataSetResponseTypeDef:  # (1)
    ...

1. See UpdateDataSetResponseTypeDef

Usage example with kwargs

kwargs: UpdateDataSetRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
}

parent.update_data_set(**kwargs)

1. See UpdateDataSetRequestRequestTypeDef

update_event_action

This operation updates the event action.

Type annotations and code completion for boto3.client("dataexchange").update_event_action method. boto3 documentation

Method definition

def update_event_action(
    self,
    *,
    EventActionId: str,
    Action: ActionTypeDef = ...,  # (1)
) -> UpdateEventActionResponseTypeDef:  # (2)
    ...

1. See ActionTypeDef
2. See UpdateEventActionResponseTypeDef

Usage example with kwargs

kwargs: UpdateEventActionRequestRequestTypeDef = {  # (1)
    "EventActionId": ...,
}

parent.update_event_action(**kwargs)

1. See UpdateEventActionRequestRequestTypeDef

update_revision

This operation updates a revision.

Type annotations and code completion for boto3.client("dataexchange").update_revision method. boto3 documentation

Method definition

def update_revision(
    self,
    *,
    DataSetId: str,
    RevisionId: str,
    Comment: str = ...,
    Finalized: bool = ...,
) -> UpdateRevisionResponseTypeDef:  # (1)
    ...

1. See UpdateRevisionResponseTypeDef

Usage example with kwargs

kwargs: UpdateRevisionRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "RevisionId": ...,
}

parent.update_revision(**kwargs)

1. See UpdateRevisionRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("dataexchange").get_paginator method with overloads.

• 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_revision_assets") -> ListRevisionAssetsPaginator