Skip to content

DataZoneClient#

Index > DataZone > DataZoneClient

Auto-generated documentation for DataZone type annotations stubs module mypy-boto3-datazone.

DataZoneClient#

Type annotations and code completion for boto3.client("datazone"). boto3 documentation

# DataZoneClient usage example

from boto3.session import Session
from mypy_boto3_datazone.client import DataZoneClient

def get_datazone_client() -> DataZoneClient:
    return Session().client("datazone")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("datazone").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("datazone")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnauthorizedException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_datazone.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

accept_predictions#

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

Type annotations and code completion for boto3.client("datazone").accept_predictions method. boto3 documentation

# accept_predictions method definition

def accept_predictions(
    self,
    *,
    domainIdentifier: str,
    identifier: str,
    acceptChoices: Sequence[AcceptChoiceTypeDef] = ...,  # (1)
    acceptRule: AcceptRuleTypeDef = ...,  # (2)
    clientToken: str = ...,
    revision: str = ...,
) -> AcceptPredictionsOutputTypeDef:  # (3)
    ...
  1. See AcceptChoiceTypeDef
  2. See AcceptRuleTypeDef
  3. See AcceptPredictionsOutputTypeDef
# accept_predictions method usage example with argument unpacking

kwargs: AcceptPredictionsInputRequestTypeDef = {  # (1)
    "domainIdentifier": ...,
    "identifier": ...,
}

parent.accept_predictions(**kwargs)
  1. See AcceptPredictionsInputRequestTypeDef

accept_subscription_request#

Accepts a subscription request to a specific asset.

Type annotations and code completion for boto3.client("datazone").accept_subscription_request method. boto3 documentation

# accept_subscription_request method definition

def accept_subscription_request(
    self,
    *,
    domainIdentifier: str,
    identifier: str,
    decisionComment: str = ...,
) -> AcceptSubscriptionRequestOutputTypeDef:  # (1)
    ...
  1. See AcceptSubscriptionRequestOutputTypeDef
# accept_subscription_request method usage example with argument unpacking

kwargs: AcceptSubscriptionRequestInputRequestTypeDef = {  # (1)
    "domainIdentifier": ...,
    "identifier": ...,
}

parent.accept_subscription_request(**kwargs)
  1. See AcceptSubscriptionRequestInputRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("datazone").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_subscription#

Cancels the subscription to the specified asset.

Type annotations and code completion for boto3.client("datazone").cancel_subscription method. boto3 documentation

# cancel_subscription method definition

def cancel_subscription(
    self,
    *,
    domainIdentifier: str,
    identifier: str,
) -> CancelSubscriptionOutputTypeDef:  # (1)
    ...
  1. See CancelSubscriptionOutputTypeDef
# cancel_subscription method usage example with argument unpacking

kwargs: CancelSubscriptionInputRequestTypeDef = {  # (1)
    "domainIdentifier": ...,
    "identifier": ...,
}

parent.cancel_subscription(**kwargs)
  1. See CancelSubscriptionInputRequestTypeDef

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

create_asset#

Creates an asset in Amazon DataZone catalog.

Type annotations and code completion for boto3.client("datazone").create_asset method. boto3 documentation

# create_asset method definition

def create_asset(
    self,
    *,
    domainIdentifier: str,
    name: str,
    owningProjectIdentifier: str,
    typeIdentifier: str,
    clientToken: str = ...,
    description: str = ...,
    externalIdentifier: str = ...,
    formsInput: Sequence[FormInputTypeDef] = ...,  # (1)
    glossaryTerms: Sequence[str] = ...,
    predictionConfiguration: PredictionConfigurationTypeDef = ...,  # (2)
    typeRevision: str = ...,
) -> CreateAssetOutputTypeDef:  # (3)
    ...
  1. See FormInputTypeDef
  2. See PredictionConfigurationTypeDef
  3. See CreateAssetOutputTypeDef
# create_asset method usage example with argument unpacking

kwargs: CreateAssetInputRequestTypeDef = {  # (1)
    "domainIdentifier": ...,
    "name": ...,
    "owningProjectIdentifier": ...,
    "typeIdentifier": ...,
}

parent.create_asset(**kwargs)
  1. See CreateAssetInputRequestTypeDef

create_asset_revision#

Creates a revision of the asset.

Type annotations and code completion for boto3.client("datazone").create_asset_revision method. boto3 documentation

# create_asset_revision method definition

def create_asset_revision(
    self,
    *,
    domainIdentifier: str,
    identifier: str,
    name: str,
    clientToken: str = ...,
    description: str = ...,
    formsInput: Sequence[FormInputTypeDef] = ...,  # (1)
    glossaryTerms: Sequence[str] = ...,
    predictionConfiguration: PredictionConfigurationTypeDef = ...,  # (2)
    typeRevision: str = ...,
) -> CreateAssetRevisionOutputTypeDef:  # (3)
    ...
  1. See FormInputTypeDef
  2. See PredictionConfigurationTypeDef
  3. See CreateAssetRevisionOutputTypeDef
# create_asset_revision method usage example with argument unpacking

kwargs: CreateAssetRevisionInputRequestTypeDef = {  # (1)
    "domainIdentifier": ...,
    "identifier": ...,
    "name": ...,
}

parent.create_asset_revision(**kwargs)
  1. See CreateAssetRevisionInputRequestTypeDef

create_asset_type#

Creates a custom asset type.

Type annotations and code completion for boto3.client("datazone").create_asset_type method. boto3 documentation

# create_asset_type method definition

def create_asset_type(
    self,
    *,
    domainIdentifier: str,
    formsInput: Mapping[str, FormEntryInputTypeDef],  # (1)
    name: str,
    owningProjectIdentifier: str,
    description: str = ...,
) -> CreateAssetTypeOutputTypeDef:  # (2)
    ...
  1. See FormEntryInputTypeDef
  2. See CreateAssetTypeOutputTypeDef
# create_asset_type method usage example with argument unpacking

kwargs: CreateAssetTypeInputRequestTypeDef = {  # (1)
    "domainIdentifier": ...,
    "formsInput": ...,
    "name": ...,
    "owningProjectIdentifier": ...,
}

parent.create_asset_type(**kwargs)
  1. See CreateAssetTypeInputRequestTypeDef

create_data_source#

Creates an Amazon DataZone data source.

Type annotations and code completion for boto3.client("datazone").create_data_source method. boto3 documentation

# create_data_source method definition

def create_data_source(
    self,
    *,
    domainIdentifier: str,
    environmentIdentifier: str,
    name: str,
    projectIdentifier: str,
    type: str,
    assetFormsInput: Sequence[FormInputTypeDef] = ...,  # (1)
    clientToken: str = ...,
    configuration: DataSourceConfigurationInputTypeDef = ...,  # (2)
    description: str = ...,
    enableSetting: EnableSettingType = ...,  # (3)
    publishOnImport: bool = ...,
    recommendation: RecommendationConfigurationTypeDef = ...,  # (4)
    schedule: ScheduleConfigurationTypeDef = ...,  # (5)
) -> CreateDataS