DataZone ******** Client ====== class DataZone.Client A low-level client representing Amazon DataZone Amazon DataZone is a data management service that enables you to catalog, discover, govern, share, and analyze your data. With Amazon DataZone, you can share and access your data across accounts and supported regions. Amazon DataZone simplifies your experience across Amazon Web Services services, including, but not limited to, Amazon Redshift, Amazon Athena, Amazon Web Services Glue, and Amazon Web Services Lake Formation. import boto3 client = boto3.client('datazone') These are the available methods: * accept_predictions * accept_subscription_request * add_entity_owner * add_policy_grant * associate_environment_role * can_paginate * cancel_metadata_generation_run * cancel_subscription * close * create_asset * create_asset_filter * create_asset_revision * create_asset_type * create_connection * create_data_product * create_data_product_revision * create_data_source * create_domain * create_domain_unit * create_environment * create_environment_action * create_environment_profile * create_form_type * create_glossary * create_glossary_term * create_group_profile * create_listing_change_set * create_project * create_project_membership * create_project_profile * create_rule * create_subscription_grant * create_subscription_request * create_subscription_target * create_user_profile * delete_asset * delete_asset_filter * delete_asset_type * delete_connection * delete_data_product * delete_data_source * delete_domain * delete_domain_unit * delete_environment * delete_environment_action * delete_environment_blueprint_configuration * delete_environment_profile * delete_form_type * delete_glossary * delete_glossary_term * delete_listing * delete_project * delete_project_membership * delete_project_profile * delete_rule * delete_subscription_grant * delete_subscription_request * delete_subscription_target * delete_time_series_data_points * disassociate_environment_role * get_asset * get_asset_filter * get_asset_type * get_connection * get_data_product * get_data_source * get_data_source_run * get_domain * get_domain_unit * get_environment * get_environment_action * get_environment_blueprint * get_environment_blueprint_configuration * get_environment_credentials * get_environment_profile * get_form_type * get_glossary * get_glossary_term * get_group_profile * get_iam_portal_login_url * get_job_run * get_lineage_event * get_lineage_node * get_listing * get_metadata_generation_run * get_paginator * get_project * get_project_profile * get_rule * get_subscription * get_subscription_grant * get_subscription_request_details * get_subscription_target * get_time_series_data_point * get_user_profile * get_waiter * list_asset_filters * list_asset_revisions * list_connections * list_data_product_revisions * list_data_source_run_activities * list_data_source_runs * list_data_sources * list_domain_units_for_parent * list_domains * list_entity_owners * list_environment_actions * list_environment_blueprint_configurations * list_environment_blueprints * list_environment_profiles * list_environments * list_job_runs * list_lineage_events * list_lineage_node_history * list_metadata_generation_runs * list_notifications * list_policy_grants * list_project_memberships * list_project_profiles * list_projects * list_rules * list_subscription_grants * list_subscription_requests * list_subscription_targets * list_subscriptions * list_tags_for_resource * list_time_series_data_points * post_lineage_event * post_time_series_data_points * put_environment_blueprint_configuration * reject_predictions * reject_subscription_request * remove_entity_owner * remove_policy_grant * revoke_subscription * search * search_group_profiles * search_listings * search_types * search_user_profiles * start_data_source_run * start_metadata_generation_run * tag_resource * untag_resource * update_asset_filter * update_connection * update_data_source * update_domain * update_domain_unit * update_environment * update_environment_action * update_environment_profile * update_glossary * update_glossary_term * update_group_profile * update_project * update_project_profile * update_rule * update_subscription_grant_status * update_subscription_request * update_subscription_target * update_user_profile Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListAssetFilters * ListAssetRevisions * ListConnections * ListDataProductRevisions * ListDataSourceRunActivities * ListDataSourceRuns * ListDataSources * ListDomainUnitsForParent * ListDomains * ListEntityOwners * ListEnvironmentActions * ListEnvironmentBlueprintConfigurations * ListEnvironmentBlueprints * ListEnvironmentProfiles * ListEnvironments * ListJobRuns * ListLineageEvents * ListLineageNodeHistory * ListMetadataGenerationRuns * ListNotifications * ListPolicyGrants * ListProjectMemberships * ListProjectProfiles * ListProjects * ListRules * ListSubscriptionGrants * ListSubscriptionRequests * ListSubscriptionTargets * ListSubscriptions * ListTimeSeriesDataPoints * Search * SearchGroupProfiles * SearchListings * SearchTypes * SearchUserProfiles DataZone / Paginator / ListSubscriptions ListSubscriptions ***************** class DataZone.Paginator.ListSubscriptions paginator = client.get_paginator('list_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( approverProjectId='string', domainIdentifier='string', owningProjectId='string', sortBy='CREATED_AT'|'UPDATED_AT', sortOrder='ASCENDING'|'DESCENDING', status='APPROVED'|'REVOKED'|'CANCELLED', subscribedListingId='string', subscriptionRequestIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **approverProjectId** (*string*) -- The identifier of the project for the subscription's approver. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **owningProjectId** (*string*) -- The identifier of the owning project. * **sortBy** (*string*) -- Specifies the way in which the results of this action are to be sorted. * **sortOrder** (*string*) -- Specifies the sort order for the results of this action. * **status** (*string*) -- The status of the subscriptions that you want to list. Note: This is not a required parameter, but if not provided, by default, Amazon DataZone returns only "APPROVED" subscriptions. * **subscribedListingId** (*string*) -- The identifier of the subscribed listing for the subscriptions that you want to list. * **subscriptionRequestIdentifier** (*string*) -- The identifier of the subscription request for the subscriptions that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'retainPermissions': True|False, 'status': 'APPROVED'|'REVOKED'|'CANCELLED', 'subscribedListing': { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, 'subscribedPrincipal': { 'project': { 'id': 'string', 'name': 'string' } }, 'subscriptionRequestId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListSubscriptions" action. * *(dict) --* The details of the subscription. * **createdAt** *(datetime) --* The timestamp of when the subscription was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a subscription exists. * **id** *(string) --* The identifier of the subscription. * **retainPermissions** *(boolean) --* The retain permissions included in the subscription. * **status** *(string) --* The status of the subscription. * **subscribedListing** *(dict) --* The listing included in the subscription. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipal** *(dict) --* The principal included in the subscription. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **subscriptionRequestId** *(string) --* The identifier of the subscription request for the subscription. * **updatedAt** *(datetime) --* The timestamp of when the subscription was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListLineageNodeHistory ListLineageNodeHistory ********************** class DataZone.Paginator.ListLineageNodeHistory paginator = client.get_paginator('list_lineage_node_history') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_lineage_node_history()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( direction='UPSTREAM'|'DOWNSTREAM', domainIdentifier='string', eventTimestampGTE=datetime(2015, 1, 1), eventTimestampLTE=datetime(2015, 1, 1), identifier='string', sortOrder='ASCENDING'|'DESCENDING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **direction** (*string*) -- The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is "UPSTREAM", the "ListLineageNodeHistory" API responds with historical versions with upstream neighbors only. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list the history of the specified data lineage node. * **eventTimestampGTE** (*datetime*) -- Specifies whether the action is to return data lineage node history from the time after the event timestamp. * **eventTimestampLTE** (*datetime*) -- Specifies whether the action is to return data lineage node history from the time prior of the event timestamp. * **identifier** (*string*) -- **[REQUIRED]** The ID of the data lineage node whose history you want to list. * **sortOrder** (*string*) -- The order by which you want data lineage node history to be sorted. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'nodes': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'eventTimestamp': datetime(2015, 1, 1), 'id': 'string', 'name': 'string', 'sourceIdentifier': 'string', 'typeName': 'string', 'typeRevision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **nodes** *(list) --* The nodes returned by the ListLineageNodeHistory action. * *(dict) --* The summary of the data lineage node. * **createdAt** *(datetime) --* The timestamp at which the data lineage node was created. * **createdBy** *(string) --* The user who created the data lineage node. * **description** *(string) --* The description of the data lineage node. * **domainId** *(string) --* The ID of the domain of the data lineage node. * **eventTimestamp** *(datetime) --* The event timestamp of the data lineage node. * **id** *(string) --* The ID of the data lineage node. * **name** *(string) --* The name of the data lineage node. * **sourceIdentifier** *(string) --* The alternate ID of the data lineage node. * **typeName** *(string) --* The name of the type of the data lineage node. * **typeRevision** *(string) --* The type of the revision of the data lineage node. * **updatedAt** *(datetime) --* The timestamp at which the data lineage node was updated. * **updatedBy** *(string) --* The user who updated the data lineage node. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListProjectMemberships ListProjectMemberships ********************** class DataZone.Paginator.ListProjectMemberships paginator = client.get_paginator('list_project_memberships') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_project_memberships()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', projectIdentifier='string', sortBy='NAME', sortOrder='ASCENDING'|'DESCENDING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which you want to list project memberships. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the project whose memberships you want to list. * **sortBy** (*string*) -- The method by which you want to sort the project memberships. * **sortOrder** (*string*) -- The sort order of the project memberships. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'members': [ { 'designation': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD', 'memberDetails': { 'group': { 'groupId': 'string' }, 'user': { 'userId': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members of the project. * *(dict) --* The details of a project member. * **designation** *(string) --* The designated role of a project member. * **memberDetails** *(dict) --* The membership details of a project member. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "group", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **group** *(dict) --* The group details of a project member. * **groupId** *(string) --* The identifier of the group in Amazon DataZone. * **user** *(dict) --* The user details of a project member. * **userId** *(string) --* The identifier of the Amazon DataZone user. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListDataSourceRuns ListDataSourceRuns ****************** class DataZone.Paginator.ListDataSourceRuns paginator = client.get_paginator('list_data_source_runs') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_data_source_runs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( dataSourceIdentifier='string', domainIdentifier='string', status='REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **dataSourceIdentifier** (*string*) -- **[REQUIRED]** The identifier of the data source. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to invoke the "ListDataSourceRuns" action. * **status** (*string*) -- The status of the data source. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'dataSourceId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'lineageSummary': { 'importStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'PARTIALLY_SUCCEEDED' }, 'projectId': 'string', 'runStatisticsForAssets': { 'added': 123, 'failed': 123, 'skipped': 123, 'unchanged': 123, 'updated': 123 }, 'startedAt': datetime(2015, 1, 1), 'status': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'stoppedAt': datetime(2015, 1, 1), 'type': 'PRIORITIZED'|'SCHEDULED', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDataSourceRuns" action. * *(dict) --* The details of a data source run. * **createdAt** *(datetime) --* The timestamp of when a data source run was created. * **dataSourceId** *(string) --* The identifier of the data source of the data source run. * **errorMessage** *(dict) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The identifier of the data source run. * **lineageSummary** *(dict) --* The run lineage summary of a data source. * **importStatus** *(string) --* The import status that's part of the run lineage summary of a data source. * **projectId** *(string) --* The project ID of the data source run. * **runStatisticsForAssets** *(dict) --* The asset statistics from the data source run. * **added** *(integer) --* The "added" statistic for the data source run. * **failed** *(integer) --* The "failed" statistic for the data source run. * **skipped** *(integer) --* The "skipped" statistic for the data source run. * **unchanged** *(integer) --* The "unchanged" statistic for the data source run. * **updated** *(integer) --* The "updated" statistic for the data source run. * **startedAt** *(datetime) --* The timestamp of when a data source run was started. * **status** *(string) --* The status of the data source run. * **stoppedAt** *(datetime) --* The timestamp of when a data source run was stopped. * **type** *(string) --* The type of the data source run. * **updatedAt** *(datetime) --* The timestamp of when a data source run was updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListTimeSeriesDataPoints ListTimeSeriesDataPoints ************************ class DataZone.Paginator.ListTimeSeriesDataPoints paginator = client.get_paginator('list_time_series_data_points') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_time_series_data_points()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', endedAt=datetime(2015, 1, 1), entityIdentifier='string', entityType='ASSET'|'LISTING', formName='string', startedAt=datetime(2015, 1, 1), PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points. * **endedAt** (*datetime*) -- The timestamp at which the data points that you wanted to list ended. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the asset for which you want to list data points. * **entityType** (*string*) -- **[REQUIRED]** The type of the asset for which you want to list data points. * **formName** (*string*) -- **[REQUIRED]** The name of the time series data points form. * **startedAt** (*datetime*) -- The timestamp at which the data points that you want to list started. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListTimeSeriesDataPoints action. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListProjects ListProjects ************ class DataZone.Paginator.ListProjects paginator = client.get_paginator('list_projects') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_projects()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', groupIdentifier='string', name='string', userIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **groupIdentifier** (*string*) -- The identifier of a group. * **name** (*string*) -- The name of the project. * **userIdentifier** (*string*) -- The identifier of the Amazon DataZone user. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'failureReasons': [ { 'code': 'string', 'message': 'string' }, ], 'id': 'string', 'name': 'string', 'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListProjects" action. * *(dict) --* The details of a Amazon DataZone project. * **createdAt** *(datetime) --* The timestamp of when a project was created. * **createdBy** *(string) --* The Amazon DataZone user who created the project. * **description** *(string) --* The description of a project. * **domainId** *(string) --* The identifier of a Amazon DataZone domain where the project exists. * **domainUnitId** *(string) --* The ID of the domain unit. * **failureReasons** *(list) --* Specifies the error message that is returned if the operation cannot be successfully completed. * *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **code** *(string) --* The code of the project deletion error. * **message** *(string) --* The message of the project deletion error. * **id** *(string) --* The identifier of a project. * **name** *(string) --* The name of a project. * **projectStatus** *(string) --* The status of the project. * **updatedAt** *(datetime) --* The timestamp of when the project was updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / SearchUserProfiles SearchUserProfiles ****************** class DataZone.Paginator.SearchUserProfiles paginator = client.get_paginator('search_user_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.search_user_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', searchText='string', userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which you want to search user profiles. * **searchText** (*string*) -- Specifies the text for which to search. * **userType** (*string*) -- **[REQUIRED]** Specifies the user type for the "SearchUserProfiles" action. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'details': { 'iam': { 'arn': 'string' }, 'sso': { 'firstName': 'string', 'lastName': 'string', 'username': 'string' } }, 'domainId': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED', 'type': 'IAM'|'SSO' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "SearchUserProfiles" action. * *(dict) --* The details of the user profile. * **details** *(dict) --* The details of the user profile. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "iam", "sso". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **iam** *(dict) --* The IAM details included in the user profile details. * **arn** *(string) --* The ARN of an IAM user profile in Amazon DataZone. * **sso** *(dict) --* The single sign-on details included in the user profile details. * **firstName** *(string) --* The first name included in the single sign-on details of the user profile. * **lastName** *(string) --* The last name included in the single sign-on details of the user profile. * **username** *(string) --* The username included in the single sign-on details of the user profile. * **domainId** *(string) --* The ID of the Amazon DataZone domain of the user profile. * **id** *(string) --* The ID of the user profile. * **status** *(string) --* The status of the user profile. * **type** *(string) --* The type of the user profile. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListPolicyGrants ListPolicyGrants **************** class DataZone.Paginator.ListPolicyGrants paginator = client.get_paginator('list_policy_grants') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_policy_grants()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', entityIdentifier='string', entityType='DOMAIN_UNIT'|'ENVIRONMENT_BLUEPRINT_CONFIGURATION'|'ENVIRONMENT_PROFILE'|'ASSET_TYPE', policyType='CREATE_DOMAIN_UNIT'|'OVERRIDE_DOMAIN_UNIT_OWNERS'|'ADD_TO_PROJECT_MEMBER_POOL'|'OVERRIDE_PROJECT_OWNERS'|'CREATE_GLOSSARY'|'CREATE_FORM_TYPE'|'CREATE_ASSET_TYPE'|'CREATE_PROJECT'|'CREATE_ENVIRONMENT_PROFILE'|'DELEGATE_CREATE_ENVIRONMENT_PROFILE'|'CREATE_ENVIRONMENT'|'CREATE_ENVIRONMENT_FROM_BLUEPRINT'|'CREATE_PROJECT_FROM_PROJECT_PROFILE'|'USE_ASSET_TYPE', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list policy grants. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the entity for which you want to list policy grants. * **entityType** (*string*) -- **[REQUIRED]** The type of entity for which you want to list policy grants. * **policyType** (*string*) -- **[REQUIRED]** The type of policy that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'grantList': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'detail': { 'addToProjectMemberPool': { 'includeChildDomainUnits': True|False }, 'createAssetType': { 'includeChildDomainUnits': True|False }, 'createDomainUnit': { 'includeChildDomainUnits': True|False }, 'createEnvironment': {}, 'createEnvironmentFromBlueprint': {}, 'createEnvironmentProfile': { 'domainUnitId': 'string' }, 'createFormType': { 'includeChildDomainUnits': True|False }, 'createGlossary': { 'includeChildDomainUnits': True|False }, 'createProject': { 'includeChildDomainUnits': True|False }, 'createProjectFromProjectProfile': { 'includeChildDomainUnits': True|False, 'projectProfiles': [ 'string', ] }, 'delegateCreateEnvironmentProfile': {}, 'overrideDomainUnitOwners': { 'includeChildDomainUnits': True|False }, 'overrideProjectOwners': { 'includeChildDomainUnits': True|False }, 'useAssetType': { 'domainUnitId': 'string' } }, 'principal': { 'domainUnit': { 'domainUnitDesignation': 'OWNER', 'domainUnitGrantFilter': { 'allDomainUnitsGrantFilter': {} }, 'domainUnitIdentifier': 'string' }, 'group': { 'groupIdentifier': 'string' }, 'project': { 'projectDesignation': 'OWNER'|'CONTRIBUTOR'|'PROJECT_CATALOG_STEWARD', 'projectGrantFilter': { 'domainUnitFilter': { 'domainUnit': 'string', 'includeChildDomainUnits': True|False } }, 'projectIdentifier': 'string' }, 'user': { 'allUsersGrantFilter': {}, 'userIdentifier': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **grantList** *(list) --* The results of this action - the listed grants. * *(dict) --* A member of the policy grant list. * **createdAt** *(datetime) --* Specifies the timestamp at which policy grant member was created. * **createdBy** *(string) --* Specifies the user who created the policy grant member. * **detail** *(dict) --* The details of the policy grant member. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "addToProjectMemberPool", "createAssetType", "createDomainUnit", "createEnvironment", "createEnvironmentFromBlueprint", "createEnvironmentProfile", "createFormType", "createGlossary", "createProject", "createProjectFromProjectProfile", "delegateCreateEnvironmentProfile", "overrideDomainUnitOwners", "overrideProjectOwners", "useAssetType". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **addToProjectMemberPool** *(dict) --* Specifies that the policy grant is to be added to the members of the project. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createAssetType** *(dict) --* Specifies that this is a create asset type policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createDomainUnit** *(dict) --* Specifies that this is a create domain unit policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createEnvironment** *(dict) --* Specifies that this is a create environment policy. * **createEnvironmentFromBlueprint** *(dict) --* The details of the policy of creating an environment. * **createEnvironmentProfile** *(dict) --* Specifies that this is a create environment profile policy. * **domainUnitId** *(string) --* The ID of the domain unit. * **createFormType** *(dict) --* Specifies that this is a create form type policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createGlossary** *(dict) --* Specifies that this is a create glossary policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createProject** *(dict) --* Specifies that this is a create project policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createProjectFromProjectProfile** *(dict) --* Specifies whether to create a project from project profile. * **includeChildDomainUnits** *(boolean) --* Specifies whether to include child domain units when creating a project from project profile policy grant details * **projectProfiles** *(list) --* Specifies project profiles when creating a project from project profile policy grant details * *(string) --* * **delegateCreateEnvironmentProfile** *(dict) --* Specifies that this is the delegation of the create environment profile policy. * **overrideDomainUnitOwners** *(dict) --* Specifies whether to override domain unit owners. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy is inherited by child domain units. * **overrideProjectOwners** *(dict) --* Specifies whether to override project owners. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy is inherited by child domain units. * **useAssetType** *(dict) --* Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions. * **domainUnitId** *(string) --* The ID of the domain unit. * **principal** *(dict) --* The principal of the policy grant member. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "domainUnit", "group", "project", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **domainUnit** *(dict) --* The domain unit of the policy grant principal. * **domainUnitDesignation** *(string) --* Specifes the designation of the domain unit users. * **domainUnitGrantFilter** *(dict) --* The grant filter for the domain unit. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "allDomainUnitsGrantFilter". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **allDomainUnitsGrantFilter** *(dict) --* Specifies a grant filter containing all domain units. * **domainUnitIdentifier** *(string) --* The ID of the domain unit. * **group** *(dict) --* The group of the policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "groupIdentifier". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **groupIdentifier** *(string) --* The ID Of the group of the group principal. * **project** *(dict) --* The project of the policy grant principal. * **projectDesignation** *(string) --* The project designation of the project policy grant principal. * **projectGrantFilter** *(dict) --* The project grant filter of the project policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "domainUnitFilter". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **domainUnitFilter** *(dict) --* The domain unit filter of the project grant filter. * **domainUnit** *(string) --* The domain unit ID to use in the filter. * **includeChildDomainUnits** *(boolean) --* Specifies whether to include child domain units. * **projectIdentifier** *(string) --* The project ID of the project policy grant principal. * **user** *(dict) --* The user of the policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "allUsersGrantFilter", "userIdentifier". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **allUsersGrantFilter** *(dict) --* The all users grant filter of the user policy grant principal. * **userIdentifier** *(string) --* The user ID of the user policy grant principal. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / Search Search ****** class DataZone.Paginator.Search paginator = client.get_paginator('search') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.search()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( additionalAttributes=[ 'FORMS'|'TIME_SERIES_DATA_POINT_FORMS'|'TEXT_MATCH_RATIONALE', ], domainIdentifier='string', filters={ 'and': [ {'... recursive ...'}, ], 'filter': { 'attribute': 'string', 'value': 'string' }, 'or': [ {'... recursive ...'}, ] }, owningProjectIdentifier='string', searchIn=[ { 'attribute': 'string' }, ], searchScope='ASSET'|'GLOSSARY'|'GLOSSARY_TERM'|'DATA_PRODUCT', searchText='string', sort={ 'attribute': 'string', 'order': 'ASCENDING'|'DESCENDING' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **additionalAttributes** (*list*) -- Specifies additional attributes for the "Search" action. * *(string) --* * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **filters** (*dict*) -- Specifies the search filters. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **and** *(list) --* The 'and' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **filter** *(dict) --* A search filter in Amazon DataZone. * **attribute** *(string) --* **[REQUIRED]** A search filter attribute in Amazon DataZone. * **value** *(string) --* **[REQUIRED]** A search filter value in Amazon DataZone. * **or** *(list) --* The 'or' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **owningProjectIdentifier** (*string*) -- The identifier of the owning project specified for the search. * **searchIn** (*list*) -- The details of the search. * *(dict) --* The details of the search. * **attribute** *(string) --* **[REQUIRED]** The search attribute. * **searchScope** (*string*) -- **[REQUIRED]** The scope of the search. * **searchText** (*string*) -- Specifies the text for which to search. * **sort** (*dict*) -- Specifies the way in which the search results are to be sorted. * **attribute** *(string) --* **[REQUIRED]** The attribute detail of the way to sort search results. * **order** *(string) --* The order detail of the wya to sort search results. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'assetItem': { 'additionalAttributes': { 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'latestTimeSeriesDataPointFormsOutput': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ], 'readOnlyFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'externalIdentifier': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'glossaryTerms': [ 'string', ], 'identifier': 'string', 'name': 'string', 'owningProjectId': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, 'dataProductItem': { 'additionalAttributes': { 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'name': 'string', 'owningProjectId': 'string' }, 'glossaryItem': { 'additionalAttributes': { 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'id': 'string', 'name': 'string', 'owningProjectId': 'string', 'status': 'DISABLED'|'ENABLED', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, 'glossaryTermItem': { 'additionalAttributes': { 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'glossaryId': 'string', 'id': 'string', 'longDescription': 'string', 'name': 'string', 'shortDescription': 'string', 'status': 'ENABLED'|'DISABLED', 'termRelations': { 'classifies': [ 'string', ], 'isA': [ 'string', ] }, 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } }, ], 'totalMatchCount': 123, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "Search" action. * *(dict) --* The details of the search results. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetItem", "dataProductItem", "glossaryItem", "glossaryTermItem". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetItem** *(dict) --* The asset item included in the search results. * **additionalAttributes** *(dict) --* The additional attributes of a Amazon DataZone inventory asset. * **formsOutput** *(list) --* The forms included in the additional attributes of an inventory asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **latestTimeSeriesDataPointFormsOutput** *(list) --* The latest time series data points forms included in the additional attributes of an asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **readOnlyFormsOutput** *(list) --* The read-only forms included in the additional attributes of an inventory asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **createdAt** *(datetime) --* The timestamp of when the Amazon DataZone inventory asset was created. * **createdBy** *(string) --* The Amazon DataZone user who created the inventory asset. * **description** *(string) --* The description of an Amazon DataZone inventory asset. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the inventory asset exists. * **externalIdentifier** *(string) --* The external identifier of the Amazon DataZone inventory asset. * **firstRevisionCreatedAt** *(datetime) --* The timestamp of when the first revision of the inventory asset was created. * **firstRevisionCreatedBy** *(string) --* The Amazon DataZone user who created the first revision of the inventory asset. * **glossaryTerms** *(list) --* The glossary terms attached to the Amazon DataZone inventory asset. * *(string) --* * **identifier** *(string) --* the identifier of the Amazon DataZone inventory asset. * **name** *(string) --* The name of the Amazon DataZone inventory asset. * **owningProjectId** *(string) --* The identifier of the Amazon DataZone project that owns the inventory asset. * **typeIdentifier** *(string) --* The identifier of the asset type of the specified Amazon DataZone inventory asset. * **typeRevision** *(string) --* The revision of the inventory asset type. * **dataProductItem** *(dict) --* The data product. * **additionalAttributes** *(dict) --* The additional attributes of an Amazon DataZone data product. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp at which the data product was created. * **createdBy** *(string) --* The user who created the data product. * **description** *(string) --* The description of the data product. * **domainId** *(string) --* The ID of the domain where the data product lives. * **firstRevisionCreatedAt** *(datetime) --* The timestamp at which first revision of the data product was created. * **firstRevisionCreatedBy** *(string) --* The user who created the first revision of the data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **id** *(string) --* The ID of the data product. * **name** *(string) --* The name of the data product. * **owningProjectId** *(string) --* The ID of the owning project of the data product. * **glossaryItem** *(dict) --* The glossary item included in the search results. * **additionalAttributes** *(dict) --* The additional attributes of an Amazon DataZone glossary. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp of when the glossary was created. * **createdBy** *(string) --* The Amazon DataZone user who created the glossary. * **description** *(string) --* The business glossary description. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the business glossary exists. * **id** *(string) --* The identifier of the glossary. * **name** *(string) --* The name of the glossary. * **owningProjectId** *(string) --* The identifier of the project that owns the business glosary. * **status** *(string) --* The business glossary status. * **updatedAt** *(datetime) --* The timestamp of when the business glossary was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the business glossary. * **glossaryTermItem** *(dict) --* The glossary term item included in the search results. * **additionalAttributes** *(dict) --* The additional attributes of an Amazon DataZone glossary term. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp of when a business glossary term was created. * **createdBy** *(string) --* The Amazon DataZone user who created the business glossary. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the business glossary exists. * **glossaryId** *(string) --* The identifier of the business glossary to which the term belongs. * **id** *(string) --* The identifier of the business glossary term. * **longDescription** *(string) --* The long description of the business glossary term. * **name** *(string) --* The name of the business glossary term. * **shortDescription** *(string) --* The short description of the business glossary term. * **status** *(string) --* The status of the business glossary term. * **termRelations** *(dict) --* The relations of the business glossary term. * **classifies** *(list) --* The classifies of the term relations. * *(string) --* * **isA** *(list) --* The "isA" property of the term relations. * *(string) --* * **updatedAt** *(datetime) --* The timestamp of when a business glossary term was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the business glossary term. * **totalMatchCount** *(integer) --* Total number of search results. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListMetadataGenerationRuns ListMetadataGenerationRuns ************************** class DataZone.Paginator.ListMetadataGenerationRuns paginator = client.get_paginator('list_metadata_generation_runs') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_metadata_generation_runs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', status='SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED', type='BUSINESS_DESCRIPTIONS', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where you want to list metadata generation runs. * **status** (*string*) -- The status of the metadata generation runs. * **type** (*string*) -- The type of the metadata generation runs. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'owningProjectId': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED', 'target': { 'identifier': 'string', 'revision': 'string', 'type': 'ASSET' }, 'type': 'BUSINESS_DESCRIPTIONS' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListMetadataGenerationRuns action. * *(dict) --* The metadata generation run. * **createdAt** *(datetime) --* The timestamp at which the metadata generation run was created. * **createdBy** *(string) --* The user who created the metadata generation run. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the metadata generation run was created. * **id** *(string) --* The ID of the metadata generation run. * **owningProjectId** *(string) --* The ID of the project that owns the asset for which the metadata generation was ran. * **status** *(string) --* The status of the metadata generation run. * **target** *(dict) --* The asset for which metadata was generated. * **identifier** *(string) --* The ID of the metadata generation run's target. * **revision** *(string) --* The revision of the asset for which metadata was generated. * **type** *(string) --* The type of the asset for which metadata was generated. * **type** *(string) --* The type of the metadata generation run. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListProjectProfiles ListProjectProfiles ******************* class DataZone.Paginator.ListProjectProfiles paginator = client.get_paginator('list_project_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_project_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', name='string', sortBy='NAME', sortOrder='ASCENDING'|'DESCENDING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list project profiles. * **name** (*string*) -- The name of a project profile. * **sortBy** (*string*) -- Specifies by what to sort project profiles. * **sortOrder** (*string*) -- Specifies the sort order of the project profiles. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ENABLED'|'DISABLED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListProjectProfiles action. * *(dict) --* The summary of a project profile. * **createdAt** *(datetime) --* The timestamp of when the project profile was created. * **createdBy** *(string) --* The user who created the project profile. * **description** *(string) --* The description of the project profile. * **domainId** *(string) --* The domain ID of the project profile. * **domainUnitId** *(string) --* The domain unit ID of the project profile. * **id** *(string) --* The ID of the project profile. * **lastUpdatedAt** *(datetime) --* The timestamp at which a project profile was last updated. * **name** *(string) --* The name of a project profile. * **status** *(string) --* The status of a project profile. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListDomains ListDomains *********** class DataZone.Paginator.ListDomains paginator = client.get_paginator('list_domains') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_domains()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( status='CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **status** (*string*) -- The status of the data source. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainVersion': 'V1'|'V2', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'managedAccountId': 'string', 'name': 'string', 'portalUrl': 'string', 'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDomains" action. * *(dict) --* A summary of a Amazon DataZone domain. * **arn** *(string) --* The ARN of the Amazon DataZone domain. * **createdAt** *(datetime) --* A timestamp of when a Amazon DataZone domain was created. * **description** *(string) --* A description of an Amazon DataZone domain. * **domainVersion** *(string) --* The domain version. * **id** *(string) --* The ID of the Amazon DataZone domain. * **lastUpdatedAt** *(datetime) --* A timestamp of when a Amazon DataZone domain was last updated. * **managedAccountId** *(string) --* The identifier of the Amazon Web Services account that manages the domain. * **name** *(string) --* A name of an Amazon DataZone domain. * **portalUrl** *(string) --* The data portal URL for the Amazon DataZone domain. * **status** *(string) --* The status of the Amazon DataZone domain. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListEnvironmentBlueprintConfigurations ListEnvironmentBlueprintConfigurations ************************************** class DataZone.Paginator.ListEnvironmentBlueprintConfigurations paginator = client.get_paginator('list_environment_blueprint_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_environment_blueprint_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'domainId': 'string', 'enabledRegions': [ 'string', ], 'environmentBlueprintId': 'string', 'environmentRolePermissionBoundary': 'string', 'manageAccessRoleArn': 'string', 'provisioningConfigurations': [ { 'lakeFormationConfiguration': { 'locationRegistrationExcludeS3Locations': [ 'string', ], 'locationRegistrationRole': 'string' } }, ], 'provisioningRoleArn': 'string', 'regionalParameters': { 'string': { 'string': 'string' } }, 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListEnvironmentBlueprintConfigurations" action. * *(dict) --* The configuration details of an environment blueprint. * **createdAt** *(datetime) --* The timestamp of when an environment blueprint was created. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which an environment blueprint exists. * **enabledRegions** *(list) --* The enabled Amazon Web Services Regions specified in a blueprint configuration. * *(string) --* * **environmentBlueprintId** *(string) --* The identifier of the environment blueprint. * **environmentRolePermissionBoundary** *(string) --* The environment role permission boundary. * **manageAccessRoleArn** *(string) --* The ARN of the manage access role specified in the environment blueprint configuration. * **provisioningConfigurations** *(list) --* The provisioning configuration of a blueprint. * *(dict) --* The provisioning configuration of the blueprint. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "lakeFormationConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **lakeFormationConfiguration** *(dict) --* The Lake Formation configuration of the Data Lake blueprint. * **locationRegistrationExcludeS3Locations** *(list) --* Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode. * *(string) --* * **locationRegistrationRole** *(string) --* The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode. * **provisioningRoleArn** *(string) --* The ARN of the provisioning role specified in the environment blueprint configuration. * **regionalParameters** *(dict) --* The regional parameters of the environment blueprint. * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **updatedAt** *(datetime) --* The timestamp of when the environment blueprint was updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListDataProductRevisions ListDataProductRevisions ************************ class DataZone.Paginator.ListDataProductRevisions paginator = client.get_paginator('list_data_product_revisions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_data_product_revisions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', identifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain of the data product revisions that you want to list. * **identifier** (*string*) -- **[REQUIRED]** The ID of the data product revision. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'revision': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDataProductRevisions" action. * *(dict) --* The data product revision. * **createdAt** *(datetime) --* The timestamp at which the data product revision was created. * **createdBy** *(string) --* The user who created the data product revision. * **domainId** *(string) --* The ID of the domain where the data product revision lives. * **id** *(string) --* The ID of the data product revision. * **revision** *(string) --* The data product revision. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListAssetRevisions ListAssetRevisions ****************** class DataZone.Paginator.ListAssetRevisions paginator = client.get_paginator('list_asset_revisions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_asset_revisions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', identifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the domain. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the asset. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'revision': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListAssetRevisions" action. * *(dict) --* The revision of an inventory asset. * **createdAt** *(datetime) --* The timestamp of when an inventory asset revison was created. * **createdBy** *(string) --* The Amazon DataZone user who created the asset revision. * **domainId** *(string) --* The Amazon DataZone user who created the inventory asset. * **id** *(string) --* The identifier of the inventory asset revision. * **revision** *(string) --* The revision details of the inventory asset. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListSubscriptionTargets ListSubscriptionTargets *********************** class DataZone.Paginator.ListSubscriptionTargets paginator = client.get_paginator('list_subscription_targets') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_subscription_targets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', environmentIdentifier='string', sortBy='CREATED_AT'|'UPDATED_AT', sortOrder='ASCENDING'|'DESCENDING', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain where you want to list subscription targets. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The identifier of the environment where you want to list subscription targets. * **sortBy** (*string*) -- Specifies the way in which the results of this action are to be sorted. * **sortOrder** (*string*) -- Specifies the sort order for the results of this action. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'applicableAssetTypes': [ 'string', ], 'authorizedPrincipals': [ 'string', ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'environmentId': 'string', 'id': 'string', 'manageAccessRole': 'string', 'name': 'string', 'projectId': 'string', 'provider': 'string', 'subscriptionTargetConfig': [ { 'content': 'string', 'formName': 'string' }, ], 'type': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListSubscriptionTargets" action. * *(dict) --* The details of the subscription target. * **applicableAssetTypes** *(list) --* The asset types included in the subscription target. * *(string) --* * **authorizedPrincipals** *(list) --* The authorized principals included in the subscription target. * *(string) --* * **createdAt** *(datetime) --* The timestamp of when the subscription target was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription target. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the subscription target exists. * **environmentId** *(string) --* The identifier of the environment of the subscription target. * **id** *(string) --* The identifier of the subscription target. * **manageAccessRole** *(string) --* The manage access role specified in the subscription target. * **name** *(string) --* The name of the subscription target. * **projectId** *(string) --* The identifier of the project specified in the subscription target. * **provider** *(string) --* The provider of the subscription target. * **subscriptionTargetConfig** *(list) --* The configuration of the subscription target. * *(dict) --* The details of the subscription target configuration. * **content** *(string) --* The content of the subscription target configuration. * **formName** *(string) --* The form name included in the subscription target configuration. * **type** *(string) --* The type of the subscription target. * **updatedAt** *(datetime) --* The timestamp of when the subscription target was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription target. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListDataSources ListDataSources *************** class DataZone.Paginator.ListDataSources paginator = client.get_paginator('list_data_sources') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_data_sources()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( connectionIdentifier='string', domainIdentifier='string', environmentIdentifier='string', name='string', projectIdentifier='string', status='CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', type='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **connectionIdentifier** (*string*) -- The ID of the connection. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to list the data sources. * **environmentIdentifier** (*string*) -- The identifier of the environment in which to list the data sources. * **name** (*string*) -- The name of the data source. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the project in which to list data sources. * **status** (*string*) -- The status of the data source. * **type** (*string*) -- The type of the data source. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'connectionId': 'string', 'createdAt': datetime(2015, 1, 1), 'dataSourceId': 'string', 'description': 'string', 'domainId': 'string', 'enableSetting': 'ENABLED'|'DISABLED', 'environmentId': 'string', 'lastRunAssetCount': 123, 'lastRunAt': datetime(2015, 1, 1), 'lastRunErrorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'name': 'string', 'schedule': { 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' }, 'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', 'type': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDataSources" action. * *(dict) --* The details of the data source. * **connectionId** *(string) --* The connection ID that's part of the data source summary. * **createdAt** *(datetime) --* The timestamp of when the data source was created. * **dataSourceId** *(string) --* The ID of the data source. * **description** *(string) --* The data source description. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the data source exists. * **enableSetting** *(string) --* Specifies whether the data source is enabled. * **environmentId** *(string) --* The ID of the environment in which the data source exists. * **lastRunAssetCount** *(integer) --* The count of the assets created during the last data source run. * **lastRunAt** *(datetime) --* The timestamp of when the data source run was last performed. * **lastRunErrorMessage** *(dict) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **lastRunStatus** *(string) --* The status of the last data source run. * **name** *(string) --* The name of the data source. * **schedule** *(dict) --* The details of the schedule of the data source runs. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. * **status** *(string) --* The status of the data source. * **type** *(string) --* The type of the data source. * **updatedAt** *(datetime) --* The timestamp of when the data source was updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / SearchTypes SearchTypes *********** class DataZone.Paginator.SearchTypes paginator = client.get_paginator('search_types') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.search_types()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', filters={ 'and': [ {'... recursive ...'}, ], 'filter': { 'attribute': 'string', 'value': 'string' }, 'or': [ {'... recursive ...'}, ] }, managed=True|False, searchIn=[ { 'attribute': 'string' }, ], searchScope='ASSET_TYPE'|'FORM_TYPE'|'LINEAGE_NODE_TYPE', searchText='string', sort={ 'attribute': 'string', 'order': 'ASCENDING'|'DESCENDING' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to invoke the "SearchTypes" action. * **filters** (*dict*) -- The filters for the "SearchTypes" action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **and** *(list) --* The 'and' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **filter** *(dict) --* A search filter in Amazon DataZone. * **attribute** *(string) --* **[REQUIRED]** A search filter attribute in Amazon DataZone. * **value** *(string) --* **[REQUIRED]** A search filter value in Amazon DataZone. * **or** *(list) --* The 'or' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **managed** (*boolean*) -- **[REQUIRED]** Specifies whether the search is managed. * **searchIn** (*list*) -- The details of the search. * *(dict) --* The details of the search. * **attribute** *(string) --* **[REQUIRED]** The search attribute. * **searchScope** (*string*) -- **[REQUIRED]** Specifies the scope of the search for types. * **searchText** (*string*) -- Specifies the text for which to search. * **sort** (*dict*) -- The specifies the way to sort the "SearchTypes" results. * **attribute** *(string) --* **[REQUIRED]** The attribute detail of the way to sort search results. * **order** *(string) --* The order detail of the wya to sort search results. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'assetTypeItem': { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'formsOutput': { 'string': { 'required': True|False, 'typeName': 'string', 'typeRevision': 'string' } }, 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, 'formTypeItem': { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'imports': [ { 'name': 'string', 'revision': 'string' }, ], 'model': { 'smithy': 'string' }, 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string', 'status': 'ENABLED'|'DISABLED' }, 'lineageNodeTypeItem': { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'formsOutput': { 'string': { 'required': True|False, 'typeName': 'string', 'typeRevision': 'string' } }, 'name': 'string', 'revision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } }, ], 'totalMatchCount': 123, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "SearchTypes" action. * *(dict) --* The details of the results of the "SearchTypes" action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetTypeItem", "formTypeItem", "lineageNodeTypeItem". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetTypeItem** *(dict) --* The asset type included in the results of the "SearchTypes" action. * **createdAt** *(datetime) --* The timestamp of when the asset type was created. * **createdBy** *(string) --* The Amazon DataZone user who created the asset type. * **description** *(string) --* The description of the asset type. * **domainId** *(string) --* The identifier of the Amazon DataZone domain where the asset type exists. * **formsOutput** *(dict) --* The forms included in the details of the asset type. * *(string) --* * *(dict) --* The details of the form entry. * **required** *(boolean) --* Specifies whether a form entry is required. * **typeName** *(string) --* The name of the type of the form entry. * **typeRevision** *(string) --* The type revision of the form entry. * **name** *(string) --* The name of the asset type. * **originDomainId** *(string) --* The identifier of the Amazon DataZone domain where the asset type was originally created. * **originProjectId** *(string) --* The identifier of the Amazon DataZone project where the asset type exists. * **owningProjectId** *(string) --* The identifier of the Amazon DataZone project that owns the asset type. * **revision** *(string) --* The revision of the asset type. * **updatedAt** *(datetime) --* The timestamp of when the asset type was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the asset type. * **formTypeItem** *(dict) --* The form type included in the results of the "SearchTypes" action. * **createdAt** *(datetime) --* The timestamp of when the metadata form type was created. * **createdBy** *(string) --* The Amazon DataZone user who created teh metadata form type. * **description** *(string) --* The description of the metadata form type. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the form type exists. * **imports** *(list) --* The imports specified in the form type. * *(dict) --* The details of the import of the metadata form type. * **name** *(string) --* The name of the import. * **revision** *(string) --* The revision of the import. * **model** *(dict) --* The model of the form type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "smithy". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **smithy** *(string) --* Indicates the smithy model of the API. * **name** *(string) --* The name of the form type. * **originDomainId** *(string) --* The identifier of the Amazon DataZone domain in which the form type was originally created. * **originProjectId** *(string) --* The identifier of the project in which the form type was originally created. * **owningProjectId** *(string) --* The identifier of the project that owns the form type. * **revision** *(string) --* The revision of the form type. * **status** *(string) --* The status of the form type. * **lineageNodeTypeItem** *(dict) --* The details of a data lineage node type. * **createdAt** *(datetime) --* The timestamp at which the data lineage node type was created. * **createdBy** *(string) --* The user who created the data lineage node type. * **description** *(string) --* The description of the data lineage node type. * **domainId** *(string) --* The ID of the domain where the data lineage node type lives. * **formsOutput** *(dict) --* The forms output of the data lineage node type. * *(string) --* * *(dict) --* The details of the form entry. * **required** *(boolean) --* Specifies whether a form entry is required. * **typeName** *(string) --* The name of the type of the form entry. * **typeRevision** *(string) --* The type revision of the form entry. * **name** *(string) --* The name of the data lineage node type. * **revision** *(string) --* The revision of the data lineage node type. * **updatedAt** *(datetime) --* The timestamp at which the data lineage node type was updated. * **updatedBy** *(string) --* The user who updated the data lineage node type. * **totalMatchCount** *(integer) --* Total number of search results. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListNotifications ListNotifications ***************** class DataZone.Paginator.ListNotifications paginator = client.get_paginator('list_notifications') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_notifications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( afterTimestamp=datetime(2015, 1, 1), beforeTimestamp=datetime(2015, 1, 1), domainIdentifier='string', subjects=[ 'string', ], taskStatus='ACTIVE'|'INACTIVE', type='TASK'|'EVENT', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **afterTimestamp** (*datetime*) -- The time after which you want to list notifications. * **beforeTimestamp** (*datetime*) -- The time before which you want to list notifications. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **subjects** (*list*) -- The subjects of notifications. * *(string) --* * **taskStatus** (*string*) -- The task status of notifications. * **type** (*string*) -- **[REQUIRED]** The type of notifications. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'notifications': [ { 'actionLink': 'string', 'creationTimestamp': datetime(2015, 1, 1), 'domainIdentifier': 'string', 'identifier': 'string', 'lastUpdatedTimestamp': datetime(2015, 1, 1), 'message': 'string', 'metadata': { 'string': 'string' }, 'status': 'ACTIVE'|'INACTIVE', 'title': 'string', 'topic': { 'resource': { 'id': 'string', 'name': 'string', 'type': 'PROJECT' }, 'role': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_VIEWER'|'DOMAIN_OWNER'|'PROJECT_SUBSCRIBER', 'subject': 'string' }, 'type': 'TASK'|'EVENT' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **notifications** *(list) --* The results of the "ListNotifications" action. * *(dict) --* The details of a notification generated in Amazon DataZone. * **actionLink** *(string) --* The action link included in the notification. * **creationTimestamp** *(datetime) --* The timestamp of when a notification was created. * **domainIdentifier** *(string) --* The identifier of a Amazon DataZone domain in which the notification exists. * **identifier** *(string) --* The identifier of the notification. * **lastUpdatedTimestamp** *(datetime) --* The timestamp of when the notification was last updated. * **message** *(string) --* The message included in the notification. * **metadata** *(dict) --* The metadata included in the notification. * *(string) --* * *(string) --* * **status** *(string) --* The status included in the notification. * **title** *(string) --* The title of the notification. * **topic** *(dict) --* The topic of the notification. * **resource** *(dict) --* The details of the resource mentioned in a notification. * **id** *(string) --* The ID of the resource mentioned in a notification. * **name** *(string) --* The name of the resource mentioned in a notification. * **type** *(string) --* The type of the resource mentioned in a notification. * **role** *(string) --* The role of the resource mentioned in a notification. * **subject** *(string) --* The subject of the resource mentioned in a notification. * **type** *(string) --* The type of the notification. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListEnvironmentActions ListEnvironmentActions ********************** class DataZone.Paginator.ListEnvironmentActions paginator = client.get_paginator('list_environment_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_environment_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', environmentIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the environment actions are listed. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the envrironment whose environment actions are listed. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'description': 'string', 'domainId': 'string', 'environmentId': 'string', 'id': 'string', 'name': 'string', 'parameters': { 'awsConsoleLink': { 'uri': 'string' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of "ListEnvironmentActions". * *(dict) --* The details about the specified action configured for an environment. For example, the details of the specified console links for an analytics tool that is available in this environment. * **description** *(string) --* The environment action description. * **domainId** *(string) --* The Amazon DataZone domain ID of the environment action. * **environmentId** *(string) --* The environment ID of the environment action. * **id** *(string) --* The ID of the environment action. * **name** *(string) --* The name of the environment action. * **parameters** *(dict) --* The parameters of the environment action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "awsConsoleLink". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **awsConsoleLink** *(dict) --* The console link specified as part of the environment action. * **uri** *(string) --* The URI of the console link specified as part of the environment action. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListLineageEvents ListLineageEvents ***************** class DataZone.Paginator.ListLineageEvents paginator = client.get_paginator('list_lineage_events') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_lineage_events()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', processingStatus='REQUESTED'|'PROCESSING'|'SUCCESS'|'FAILED', sortOrder='ASCENDING'|'DESCENDING', timestampAfter=datetime(2015, 1, 1), timestampBefore=datetime(2015, 1, 1), PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list lineage events. * **processingStatus** (*string*) -- The processing status of a lineage event. * **sortOrder** (*string*) -- The sort order of the lineage events. * **timestampAfter** (*datetime*) -- The after timestamp of a lineage event. * **timestampBefore** (*datetime*) -- The before timestamp of a lineage event. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'eventSummary': { 'openLineageRunEventSummary': { 'eventType': 'START'|'RUNNING'|'COMPLETE'|'ABORT'|'FAIL'|'OTHER', 'inputs': [ { 'name': 'string', 'namespace': 'string' }, ], 'job': { 'name': 'string', 'namespace': 'string' }, 'outputs': [ { 'name': 'string', 'namespace': 'string' }, ], 'runId': 'string' } }, 'eventTime': datetime(2015, 1, 1), 'id': 'string', 'processingStatus': 'REQUESTED'|'PROCESSING'|'SUCCESS'|'FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListLineageEvents action. * *(dict) --* The data lineage event summary. * **createdAt** *(datetime) --* The timestamp at which data lineage event was created. * **createdBy** *(string) --* The user who created the data lineage event. * **domainId** *(string) --* The domain ID of the lineage event. * **eventSummary** *(dict) --* The summary of the data lineate event. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "openLineageRunEventSummary". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **openLineageRunEventSummary** *(dict) --* The open lineage run event summary. * **eventType** *(string) --* The event type of the open lineage run event summary. * **inputs** *(list) --* The inputs of the open lineage run event summary. * *(dict) --* The name identifier. * **name** *(string) --* The name in the name identifier. * **namespace** *(string) --* The namespace in the name identifier. * **job** *(dict) --* The job of the open lineage run event summary. * **name** *(string) --* The name in the name identifier. * **namespace** *(string) --* The namespace in the name identifier. * **outputs** *(list) --* The outputs of the open lineage run event summary. * *(dict) --* The name identifier. * **name** *(string) --* The name in the name identifier. * **namespace** *(string) --* The namespace in the name identifier. * **runId** *(string) --* The runID of the open lineage run event summary. * **eventTime** *(datetime) --* The time of the data lineage event. * **id** *(string) --* The ID of the data lineage event. * **processingStatus** *(string) --* The processing status of the data lineage event. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListJobRuns ListJobRuns *********** class DataZone.Paginator.ListJobRuns paginator = client.get_paginator('list_job_runs') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_job_runs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', jobIdentifier='string', sortOrder='ASCENDING'|'DESCENDING', status='SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list job runs. * **jobIdentifier** (*string*) -- **[REQUIRED]** The ID of the job run. * **sortOrder** (*string*) -- Specifies the order in which job runs are to be sorted. * **status** (*string*) -- The status of a job run. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'endTime': datetime(2015, 1, 1), 'error': { 'message': 'string' }, 'jobId': 'string', 'jobType': 'LINEAGE', 'runId': 'string', 'runMode': 'SCHEDULED'|'ON_DEMAND', 'startTime': datetime(2015, 1, 1), 'status': 'SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListJobRuns action. * *(dict) --* The job run summary. * **createdAt** *(datetime) --* The timestamp at which job run was created. * **createdBy** *(string) --* The user who created the job run. * **domainId** *(string) --* The domain ID of the job run. * **endTime** *(datetime) --* The end time of a job run. * **error** *(dict) --* The error of a job run. * **message** *(string) --* The job run error message. * **jobId** *(string) --* The job ID of a job run. * **jobType** *(string) --* The job type of a job run. * **runId** *(string) --* The run ID of a job run. * **runMode** *(string) --* The run mode of a job run. * **startTime** *(datetime) --* The start time of a job run. * **status** *(string) --* The status of a job run. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListEntityOwners ListEntityOwners **************** class DataZone.Paginator.ListEntityOwners paginator = client.get_paginator('list_entity_owners') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_entity_owners()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', entityIdentifier='string', entityType='DOMAIN_UNIT', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list entity owners. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the entity that you want to list. * **entityType** (*string*) -- **[REQUIRED]** The type of the entity that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'owners': [ { 'group': { 'groupId': 'string' }, 'user': { 'userId': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **owners** *(list) --* The owners of the entity. * *(dict) --* The ID of the domain unit owners group. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "group", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **group** *(dict) --* Specifies that the domain unit owner is a group. * **groupId** *(string) --* The ID of the domain unit owners group. * **user** *(dict) --* Specifies that the domain unit owner is a user. * **userId** *(string) --* The ID of the owner user. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListConnections ListConnections *************** class DataZone.Paginator.ListConnections paginator = client.get_paginator('list_connections') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_connections()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', environmentIdentifier='string', name='string', projectIdentifier='string', sortBy='NAME', sortOrder='ASCENDING'|'DESCENDING', type='ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list connections. * **environmentIdentifier** (*string*) -- The ID of the environment where you want to list connections. * **name** (*string*) -- The name of the connection. * **projectIdentifier** (*string*) -- **[REQUIRED]** The ID of the project where you want to list connections. * **sortBy** (*string*) -- Specifies how you want to sort the listed connections. * **sortOrder** (*string*) -- Specifies the sort order for the listed connections. * **type** (*string*) -- The type of connection. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'connectionId': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentId': 'string', 'name': 'string', 'physicalEndpoints': [ { 'awsLocation': { 'accessRole': 'string', 'awsAccountId': 'string', 'awsRegion': 'string', 'iamConnectionId': 'string' }, 'glueConnection': { 'athenaProperties': { 'string': 'string' }, 'authenticationConfiguration': { 'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM', 'oAuth2Properties': { 'authorizationCodeProperties': { 'authorizationCode': 'string', 'redirectUri': 'string' }, 'oAuth2ClientApplication': { 'aWSManagedClientApplicationReference': 'string', 'userManagedClientApplicationClientId': 'string' }, 'oAuth2Credentials': { 'accessToken': 'string', 'jwtToken': 'string', 'refreshToken': 'string', 'userManagedClientApplicationClientSecret': 'string' }, 'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER', 'tokenUrl': 'string', 'tokenUrlParametersMap': { 'string': 'string' } }, 'secretArn': 'string' }, 'compatibleComputeEnvironments': [ 'SPARK'|'ATHENA'|'PYTHON', ], 'connectionProperties': { 'string': 'string' }, 'connectionSchemaVersion': 123, 'connectionType': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'lastConnectionValidationTime': datetime(2015, 1, 1), 'lastUpdatedBy': 'string', 'lastUpdatedTime': datetime(2015, 1, 1), 'matchCriteria': [ 'string', ], 'name': 'string', 'physicalConnectionRequirements': { 'availabilityZone': 'string', 'securityGroupIdList': [ 'string', ], 'subnetId': 'string', 'subnetIdList': [ 'string', ] }, 'pythonProperties': { 'string': 'string' }, 'sparkProperties': { 'string': 'string' }, 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED', 'statusReason': 'string' }, 'glueConnectionName': 'string', 'host': 'string', 'port': 123, 'protocol': 'ATHENA'|'GLUE_INTERACTIVE_SESSION'|'HTTPS'|'JDBC'|'LIVY'|'ODBC'|'PRISM', 'stage': 'string' }, ], 'projectId': 'string', 'props': { 'athenaProperties': { 'workgroupName': 'string' }, 'glueProperties': { 'errorMessage': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED' }, 'hyperPodProperties': { 'clusterArn': 'string', 'clusterName': 'string', 'orchestrator': 'EKS'|'SLURM' }, 'iamProperties': { 'environmentId': 'string', 'glueLineageSyncEnabled': True|False }, 'redshiftProperties': { 'credentials': { 'secretArn': 'string', 'usernamePassword': { 'password': 'string', 'username': 'string' } }, 'databaseName': 'string', 'isProvisionedSecret': True|False, 'jdbcIamUrl': 'string', 'jdbcUrl': 'string', 'lineageSync': { 'enabled': True|False, 'lineageJobId': 'string', 'schedule': { 'schedule': 'string' } }, 'redshiftTempDir': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED', 'storage': { 'clusterName': 'string', 'workgroupName': 'string' } }, 's3Properties': { 'errorMessage': 'string', 's3AccessGrantLocationId': 'string', 's3Uri': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED' }, 'sparkEmrProperties': { 'computeArn': 'string', 'credentials': { 'password': 'string', 'username': 'string' }, 'credentialsExpiration': datetime(2015, 1, 1), 'governanceType': 'AWS_MANAGED'|'USER_MANAGED', 'instanceProfileArn': 'string', 'javaVirtualEnv': 'string', 'livyEndpoint': 'string', 'logUri': 'string', 'pythonVirtualEnv': 'string', 'runtimeRole': 'string', 'trustedCertificatesS3Uri': 'string' }, 'sparkGlueProperties': { 'additionalArgs': { 'connection': 'string' }, 'glueConnectionName': 'string', 'glueVersion': 'string', 'idleTimeout': 123, 'javaVirtualEnv': 'string', 'numberOfWorkers': 123, 'pythonVirtualEnv': 'string', 'workerType': 'string' } }, 'type': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListConnections action. * *(dict) --* The summary of a connection. * **connectionId** *(string) --* The ID of a connection. * **domainId** *(string) --* The domain ID of a connection. * **domainUnitId** *(string) --* The domain unit ID of a connection. * **environmentId** *(string) --* The environment ID of a connection. * **name** *(string) --* The connection name. * **physicalEndpoints** *(list) --* The connection physical endpoints. * *(dict) --* The physical endpoints of a connection. * **awsLocation** *(dict) --* The location of a connection. * **accessRole** *(string) --* The access role of a connection. * **awsAccountId** *(string) --* The account ID of a connection. * **awsRegion** *(string) --* The Region of a connection. * **iamConnectionId** *(string) --* The IAM connection ID of a connection. * **glueConnection** *(dict) --* The Amazon Web Services Glue connection. * **athenaProperties** *(dict) --* The Amazon Athena properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **authenticationConfiguration** *(dict) --* The authentication configuration of the Amazon Web Services Glue connection. * **authenticationType** *(string) --* The authentication type of a connection. * **oAuth2Properties** *(dict) --* The oAuth2 properties of a connection. * **authorizationCodeProperties** *(dict) --* The authorization code properties of the OAuth2 properties. * **authorizationCode** *(string) --* The authorization code of a connection. * **redirectUri** *(string) --* The redirect URI of a connection. * **oAuth2ClientApplication** *(dict) --* The OAuth2 client application of the OAuth2 properties. * **aWSManagedClientApplicationReference** *(string) --* The Amazon Web Services managed client application reference in the OAuth2Client application. * **userManagedClientApplicationClientId** *(string) --* The user managed client application client ID in the OAuth2Client application. * **oAuth2Credentials** *(dict) --* The OAuth2 credentials of the OAuth2 properties. * **accessToken** *(string) --* The access token of a connection. * **jwtToken** *(string) --* The jwt token of the connection. * **refreshToken** *(string) --* The refresh token of the connection. * **userManagedClientApplicationClientSecr et** *(string) --* The user managed client application client secret of the connection. * **oAuth2GrantType** *(string) --* The OAuth2 grant type of the OAuth2 properties. * **tokenUrl** *(string) --* The OAuth2 token URL of the OAuth2 properties. * **tokenUrlParametersMap** *(dict) --* The OAuth2 token URL parameter map of the OAuth2 properties. * *(string) --* * *(string) --* * **secretArn** *(string) --* The secret ARN of a connection. * **compatibleComputeEnvironments** *(list) --* The compatible compute environments of the Amazon Web Services Glue connection. * *(string) --* * **connectionProperties** *(dict) --* The properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **connectionSchemaVersion** *(integer) --* The connection schema version of the Amazon Web Services Glue connection. * **connectionType** *(string) --* The type of the Amazon Web Services Glue connection. * **creationTime** *(datetime) --* The creation time of the Amazon Web Services Glue connection. * **description** *(string) --* The description of the Amazon Web Services Glue connection. * **lastConnectionValidationTime** *(datetime) --* The last validation time of the Amazon Web Services Glue connection. * **lastUpdatedBy** *(string) --* The user who last updated the Amazon Web Services Glue connection. * **lastUpdatedTime** *(datetime) --* The timestamp at which the Amazon Web Services Glue connection was last updated. * **matchCriteria** *(list) --* The match criteria of the Amazon Web Services Glue connection. * *(string) --* * **name** *(string) --* The name of the Amazon Web Services Glue connection. * **physicalConnectionRequirements** *(dict) --* The physical connection requirements of the Amazon Web Services Glue connection. * **availabilityZone** *(string) --* The availability zone of the physical connection requirements of a connection. * **securityGroupIdList** *(list) --* The group ID list of the physical connection requirements of a connection. * *(string) --* * **subnetId** *(string) --* The subnet ID of the physical connection requirements of a connection. * **subnetIdList** *(list) --* The subnet ID list of the physical connection requirements of a connection. * *(string) --* * **pythonProperties** *(dict) --* The Python properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **sparkProperties** *(dict) --* The Spark properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **status** *(string) --* The status of the Amazon Web Services Glue connection. * **statusReason** *(string) --* The status reason of the Amazon Web Services Glue connection. * **glueConnectionName** *(string) --* The Amazon Web Services Glue connection name. * **host** *(string) --* The host in the physical endpoints of a connection. * **port** *(integer) --* The port in the physical endpoints of a connection. * **protocol** *(string) --* The protocol in the physical endpoints of a connection. * **stage** *(string) --* The stage in the physical endpoints of a connection. * **projectId** *(string) --* The connection project ID. * **props** *(dict) --* The connection props. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "athenaProperties", "glueProperties", "hyperPodProperties", "iamProperties", "redshiftProperties", "s3Properties", "sparkEmrProperties", "sparkGlueProperties". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **athenaProperties** *(dict) --* The Amazon Athena properties of a connection. * **workgroupName** *(string) --* The Amazon Athena workgroup name of a connection. * **glueProperties** *(dict) --* The Amazon Web Services Glue properties of a connection. * **errorMessage** *(string) --* The error message generated if the action is not completed successfully. * **status** *(string) --* The status of a connection. * **hyperPodProperties** *(dict) --* The hyper pod properties of a connection. * **clusterArn** *(string) --* The cluster ARN of the hyper pod properties. * **clusterName** *(string) --* The cluster name the hyper pod properties. * **orchestrator** *(string) --* The orchestrator of the hyper pod properties. * **iamProperties** *(dict) --* The IAM properties of a connection. * **environmentId** *(string) --* The environment ID of the connection. * **glueLineageSyncEnabled** *(boolean) --* Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection. * **redshiftProperties** *(dict) --* The Amazon Redshift properties of a connection. * **credentials** *(dict) --* The Amazon Redshift credentials. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "secretArn", "usernamePassword". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **secretArn** *(string) --* The secret ARN of the Amazon Redshift credentials of a connection. * **usernamePassword** *(dict) --* The username and password of the Amazon Redshift credentials of a connection. * **password** *(string) --* The password of a connection. * **username** *(string) --* The username of a connection. * **databaseName** *(string) --* The Amazon Redshift database name. * **isProvisionedSecret** *(boolean) --* Specifies whether Amaon Redshift properties has a provisioned secret. * **jdbcIamUrl** *(string) --* The jdbcIam URL of the Amazon Redshift properties. * **jdbcUrl** *(string) --* The jdbcURL of the Amazon Redshift properties. * **lineageSync** *(dict) --* The lineage syn of the Amazon Redshift properties. * **enabled** *(boolean) --* Specifies whether the Amaon Redshift lineage sync configuration is enabled. * **lineageJobId** *(string) --* The lineage job ID of the Amaon Redshift lineage sync configuration. * **schedule** *(dict) --* The schedule of teh Amaon Redshift lineage sync configuration. * **schedule** *(string) --* The lineage sync schedule. * **redshiftTempDir** *(string) --* The redshiftTempDir of the Amazon Redshift properties. * **status** *(string) --* The status in the Amazon Redshift properties. * **storage** *(dict) --* The storage in the Amazon Redshift properties. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "clusterName", "workgroupName". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **clusterName** *(string) --* The cluster name in the Amazon Redshift storage properties. * **workgroupName** *(string) --* The workgroup name in the Amazon Redshift storage properties. * **s3Properties** *(dict) --* The Amazon S3 properties of a connection. * **errorMessage** *(string) --* The error message that gets displayed. * **s3AccessGrantLocationId** *(string) --* The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection. * **s3Uri** *(string) --* The Amazon S3 URI that's part of the Amazon S3 properties of a connection. * **status** *(string) --* The status of the Amazon S3 connection. * **sparkEmrProperties** *(dict) --* The Spark EMR properties of a connection. * **computeArn** *(string) --* The compute ARN of the Spark EMR. * **credentials** *(dict) --* The credentials of the Spark EMR. * **password** *(string) --* The password of a connection. * **username** *(string) --* The username of a connection. * **credentialsExpiration** *(datetime) --* The credential expiration of the Spark EMR. * **governanceType** *(string) --* The governance type of the Spark EMR. * **instanceProfileArn** *(string) --* The instance profile ARN of the Spark EMR. * **javaVirtualEnv** *(string) --* The Java virtual env of the Spark EMR. * **livyEndpoint** *(string) --* The livy endpoint of the Spark EMR. * **logUri** *(string) --* The log URI of the Spark EMR. * **pythonVirtualEnv** *(string) --* The Python virtual env of the Spark EMR. * **runtimeRole** *(string) --* The runtime role of the Spark EMR. * **trustedCertificatesS3Uri** *(string) --* The trusted certificate S3 URL of the Spark EMR. * **sparkGlueProperties** *(dict) --* The Spark Amazon Web Services Glue properties of a connection. * **additionalArgs** *(dict) --* The additional args in the Spark Amazon Web Services Glue properties. * **connection** *(string) --* The connection in the Spark Amazon Web Services Glue args. * **glueConnectionName** *(string) --* The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties. * **glueVersion** *(string) --* The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties. * **idleTimeout** *(integer) --* The idle timeout in the Spark Amazon Web Services Glue properties. * **javaVirtualEnv** *(string) --* The Java virtual env in the Spark Amazon Web Services Glue properties. * **numberOfWorkers** *(integer) --* The number of workers in the Spark Amazon Web Services Glue properties. * **pythonVirtualEnv** *(string) --* The Python virtual env in the Spark Amazon Web Services Glue properties. * **workerType** *(string) --* The worker type in the Spark Amazon Web Services Glue properties. * **type** *(string) --* The connection type. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListEnvironmentBlueprints ListEnvironmentBlueprints ************************* class DataZone.Paginator.ListEnvironmentBlueprints paginator = client.get_paginator('list_environment_blueprints') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_environment_blueprints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', managed=True|False, name='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **managed** (*boolean*) -- Specifies whether the environment blueprint is managed by Amazon DataZone. * **name** (*string*) -- The name of the Amazon DataZone environment. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'id': 'string', 'name': 'string', 'provider': 'string', 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListEnvironmentBlueprints" action. * *(dict) --* The details of an environment blueprint summary. * **createdAt** *(datetime) --* The timestamp of when an environment blueprint was created. * **description** *(string) --* The description of a blueprint. * **id** *(string) --* The identifier of the blueprint. * **name** *(string) --* The name of the blueprint. * **provider** *(string) --* The provider of the blueprint. * **provisioningProperties** *(dict) --* The provisioning properties of the blueprint. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "cloudFormation". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **cloudFormation** *(dict) --* The cloud formation properties included as part of the provisioning properties of an environment blueprint. * **templateUrl** *(string) --* The template URL of the cloud formation provisioning properties of the environment blueprint. * **updatedAt** *(datetime) --* The timestamp of when the blueprint was enabled. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListDataSourceRunActivities ListDataSourceRunActivities *************************** class DataZone.Paginator.ListDataSourceRunActivities paginator = client.get_paginator('list_data_source_run_activities') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_data_source_run_activities()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', identifier='string', status='FAILED'|'PUBLISHING_FAILED'|'SUCCEEDED_CREATED'|'SUCCEEDED_UPDATED'|'SKIPPED_ALREADY_IMPORTED'|'SKIPPED_ARCHIVED'|'SKIPPED_NO_ACCESS'|'UNCHANGED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to list data source run activities. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the data source run. * **status** (*string*) -- The status of the data source run. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'dataAssetId': 'string', 'dataAssetStatus': 'FAILED'|'PUBLISHING_FAILED'|'SUCCEEDED_CREATED'|'SUCCEEDED_UPDATED'|'SKIPPED_ALREADY_IMPORTED'|'SKIPPED_ARCHIVED'|'SKIPPED_NO_ACCESS'|'UNCHANGED', 'dataSourceRunId': 'string', 'database': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'lineageSummary': { 'errorMessage': 'string', 'eventId': 'string', 'eventStatus': 'REQUESTED'|'PROCESSING'|'SUCCESS'|'FAILED' }, 'projectId': 'string', 'technicalDescription': 'string', 'technicalName': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDataSourceRunActivities" action. * *(dict) --* The activity details of the data source run. * **createdAt** *(datetime) --* The timestamp of when data source run activity was created. * **dataAssetId** *(string) --* The identifier of the asset included in the data source run activity. * **dataAssetStatus** *(string) --* The status of the asset included in the data source run activity. * **dataSourceRunId** *(string) --* The identifier of the data source for the data source run activity. * **database** *(string) --* The database included in the data source run activity. * **errorMessage** *(dict) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **lineageSummary** *(dict) --* The data lineage summary. * **errorMessage** *(string) --* The data lineage error message. * **eventId** *(string) --* The data lineage event ID. * **eventStatus** *(string) --* The data lineage event status. * **projectId** *(string) --* The project ID included in the data source run activity. * **technicalDescription** *(string) --* The technical description included in the data source run activity. * **technicalName** *(string) --* The technical name included in the data source run activity. * **updatedAt** *(datetime) --* The timestamp of when data source run activity was updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListDomainUnitsForParent ListDomainUnitsForParent ************************ class DataZone.Paginator.ListDomainUnitsForParent paginator = client.get_paginator('list_domain_units_for_parent') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_domain_units_for_parent()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', parentDomainUnitIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain in which you want to list domain units for a parent domain unit. * **parentDomainUnitIdentifier** (*string*) -- **[REQUIRED]** The ID of the parent domain unit. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'id': 'string', 'name': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results returned by this action. * *(dict) --* The summary of the domain unit. * **id** *(string) --* The ID of the domain unit summary. * **name** *(string) --* The name of the domain unit summary. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListSubscriptionGrants ListSubscriptionGrants ********************** class DataZone.Paginator.ListSubscriptionGrants paginator = client.get_paginator('list_subscription_grants') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_subscription_grants()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', environmentId='string', owningProjectId='string', sortBy='CREATED_AT'|'UPDATED_AT', sortOrder='ASCENDING'|'DESCENDING', subscribedListingId='string', subscriptionId='string', subscriptionTargetId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **environmentId** (*string*) -- The identifier of the Amazon DataZone environment. * **owningProjectId** (*string*) -- The ID of the owning project of the subscription grants. * **sortBy** (*string*) -- Specifies the way of sorting the results of this action. * **sortOrder** (*string*) -- Specifies the sort order of this action. * **subscribedListingId** (*string*) -- The identifier of the subscribed listing. * **subscriptionId** (*string*) -- The identifier of the subscription. * **subscriptionTargetId** (*string*) -- The identifier of the subscription target. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'assets': [ { 'assetId': 'string', 'assetRevision': 'string', 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'failureCause': { 'message': 'string' }, 'failureTimestamp': datetime(2015, 1, 1), 'grantedTimestamp': datetime(2015, 1, 1), 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED', 'targetName': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'grantedEntity': { 'listing': { 'id': 'string', 'revision': 'string' } }, 'id': 'string', 'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE', 'subscriptionId': 'string', 'subscriptionTargetId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListSubscriptionGrants" action. * *(dict) --* The details of the subscription grant. * **assets** *(list) --* The assets included in the subscription grant. * *(dict) --* The details of the asset for which the subscription grant is created. * **assetId** *(string) --* The identifier of the asset for which the subscription grant is created. * **assetRevision** *(string) --* The revision of the asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **failureCause** *(dict) --* The failure cause included in the details of the asset for which the subscription grant is created. * **message** *(string) --* The description of the error message. * **failureTimestamp** *(datetime) --* The failure timestamp included in the details of the asset for which the subscription grant is created. * **grantedTimestamp** *(datetime) --* The timestamp of when the subscription grant to the asset is created. * **status** *(string) --* The status of the asset for which the subscription grant is created. * **targetName** *(string) --* The target name of the asset for which the subscription grant is created. * **createdAt** *(datetime) --* The timestamp of when a subscription grant was created. * **createdBy** *(string) --* The datazone user who created the subscription grant. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a subscription grant exists. * **grantedEntity** *(dict) --* The entity to which the subscription is granted. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "listing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **listing** *(dict) --* The listing for which a subscription is granted. * **id** *(string) --* An identifier of a revision of an asset published in a Amazon DataZone catalog. * **revision** *(string) --* The details of a revision of an asset published in a Amazon DataZone catalog. * **id** *(string) --* The identifier of the subscription grant. * **status** *(string) --* The status of the subscription grant. * **subscriptionId** *(string) --* The ID of the subscription. * **subscriptionTargetId** *(string) --* The identifier of the target of the subscription grant. * **updatedAt** *(datetime) --* The timestampf of when the subscription grant was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription grant. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListAssetFilters ListAssetFilters **************** class DataZone.Paginator.ListAssetFilters paginator = client.get_paginator('list_asset_filters') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_asset_filters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( assetIdentifier='string', domainIdentifier='string', status='VALID'|'INVALID', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **assetIdentifier** (*string*) -- **[REQUIRED]** The ID of the data asset. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list asset filters. * **status** (*string*) -- The status of the asset filter. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'assetId': 'string', 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'effectiveColumnNames': [ 'string', ], 'effectiveRowFilter': 'string', 'errorMessage': 'string', 'id': 'string', 'name': 'string', 'status': 'VALID'|'INVALID' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListAssetFilters" action. * *(dict) --* The summary of the asset filter. * **assetId** *(string) --* The ID of the data asset. * **createdAt** *(datetime) --* The timestamp at which the asset filter was created. * **description** *(string) --* The description of the asset filter. * **domainId** *(string) --* The ID of the domain where the asset filter lives. * **effectiveColumnNames** *(list) --* The effective column names of the asset filter. * *(string) --* * **effectiveRowFilter** *(string) --* The effective row filter of the asset filter. * **errorMessage** *(string) --* The error message that is displayed if the action does not succeed. * **id** *(string) --* The ID of the asset filter. * **name** *(string) --* The name of the asset filter. * **status** *(string) --* The status of the asset filter. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / SearchGroupProfiles SearchGroupProfiles ******************* class DataZone.Paginator.SearchGroupProfiles paginator = client.get_paginator('search_group_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.search_group_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( domainIdentifier='string', groupType='SSO_GROUP'|'DATAZONE_SSO_GROUP', searchText='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which you want to search group profiles. * **groupType** (*string*) -- **[REQUIRED]** The group type for which to search. * **searchText** (*string*) -- Specifies the text for which to search. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'domainId': 'string', 'groupName': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "SearchGroupProfiles" action. * *(dict) --* The details of a group profile. * **domainId** *(string) --* The ID of the Amazon DataZone domain of a group profile. * **groupName** *(string) --* The group name of a group profile. * **id** *(string) --* The ID of a group profile. * **status** *(string) --* The status of a group profile. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListEnvironments ListEnvironments **************** class DataZone.Paginator.ListEnvironments paginator = client.get_paginator('list_environments') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_environments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( awsAccountId='string', awsAccountRegion='string', domainIdentifier='string', environmentBlueprintIdentifier='string', environmentProfileIdentifier='string', name='string', projectIdentifier='string', provider='string', status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **awsAccountId** (*string*) -- The identifier of the Amazon Web Services account where you want to list environments. * **awsAccountRegion** (*string*) -- The Amazon Web Services region where you want to list environments. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **environmentBlueprintIdentifier** (*string*) -- The identifier of the Amazon DataZone blueprint. * **environmentProfileIdentifier** (*string*) -- The identifier of the environment profile. * **name** (*string*) -- The name of the environment. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone project. * **provider** (*string*) -- The provider of the environment. * **status** (*string*) -- The status of the environments that you want to list. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentConfigurationId': 'string', 'environmentProfileId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'provider': 'string', 'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListEnvironments" action. * *(dict) --* The details of an environment. * **awsAccountId** *(string) --* The identifier of the Amazon Web Services account in which an environment exists. * **awsAccountRegion** *(string) --* The Amazon Web Services Region in which an environment exists. * **createdAt** *(datetime) --* The timestamp of when the environment was created. * **createdBy** *(string) --* The Amazon DataZone user who created the environment. * **description** *(string) --* The description of the environment. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the environment exists. * **environmentConfigurationId** *(string) --* The configuration ID with which the environment is created. * **environmentProfileId** *(string) --* The identifier of the environment profile with which the environment was created. * **id** *(string) --* The identifier of the environment. * **name** *(string) --* The name of the environment. * **projectId** *(string) --* The identifier of the project in which the environment exists. * **provider** *(string) --* The provider of the environment. * **status** *(string) --* The status of the environment. * **updatedAt** *(datetime) --* The timestamp of when the environment was updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListSubscriptionRequests ListSubscriptionRequests ************************ class DataZone.Paginator.ListSubscriptionRequests paginator = client.get_paginator('list_subscription_requests') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_subscription_requests()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( approverProjectId='string', domainIdentifier='string', owningProjectId='string', sortBy='CREATED_AT'|'UPDATED_AT', sortOrder='ASCENDING'|'DESCENDING', status='PENDING'|'ACCEPTED'|'REJECTED', subscribedListingId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **approverProjectId** (*string*) -- The identifier of the subscription request approver's project. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **owningProjectId** (*string*) -- The identifier of the project for the subscription requests. * **sortBy** (*string*) -- Specifies the way to sort the results of this action. * **sortOrder** (*string*) -- Specifies the sort order for the results of this action. * **status** (*string*) -- Specifies the status of the subscription requests. Note: This is not a required parameter, but if not specified, by default, Amazon DataZone returns only "PENDING" subscription requests. * **subscribedListingId** (*string*) -- The identifier of the subscribed listing. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'decisionComment': 'string', 'domainId': 'string', 'existingSubscriptionId': 'string', 'id': 'string', 'metadataFormsSummary': [ { 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'requestReason': 'string', 'reviewerId': 'string', 'status': 'PENDING'|'ACCEPTED'|'REJECTED', 'subscribedListings': [ { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, ], 'subscribedPrincipals': [ { 'project': { 'id': 'string', 'name': 'string' } }, ], 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListSubscriptionRequests" action. * *(dict) --* The details of the subscription request. * **createdAt** *(datetime) --* The timestamp of when a subscription request was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription request. * **decisionComment** *(string) --* The decision comment of the subscription request. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a subscription request exists. * **existingSubscriptionId** *(string) --* The ID of the existing subscription. * **id** *(string) --* The identifier of the subscription request. * **metadataFormsSummary** *(list) --* The summary of the metadata forms. * *(dict) --* The summary of the metadata form. * **formName** *(string) --* The form name of the metadata form. * **typeName** *(string) --* The type name of the metadata form. * **typeRevision** *(string) --* The type revision of the metadata form. * **requestReason** *(string) --* The reason for the subscription request. * **reviewerId** *(string) --* The identifier of the subscription request reviewer. * **status** *(string) --* The status of the subscription request. * **subscribedListings** *(list) --* The listings included in the subscription request. * *(dict) --* The details of the published asset for which the subscription grant is created. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipals** *(list) --* The principals included in the subscription request. * *(dict) --* The principal that has the subscription grant for the asset. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **updatedAt** *(datetime) --* The timestamp of when the subscription request was updated. * **updatedBy** *(string) --* The identifier of the Amazon DataZone user who updated the subscription request. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / SearchListings SearchListings ************** class DataZone.Paginator.SearchListings paginator = client.get_paginator('search_listings') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.search_listings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( additionalAttributes=[ 'FORMS'|'TIME_SERIES_DATA_POINT_FORMS'|'TEXT_MATCH_RATIONALE', ], aggregations=[ { 'attribute': 'string', 'displayValue': 'string' }, ], domainIdentifier='string', filters={ 'and': [ {'... recursive ...'}, ], 'filter': { 'attribute': 'string', 'value': 'string' }, 'or': [ {'... recursive ...'}, ] }, searchIn=[ { 'attribute': 'string' }, ], searchText='string', sort={ 'attribute': 'string', 'order': 'ASCENDING'|'DESCENDING' }, PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **additionalAttributes** (*list*) -- Specifies additional attributes for the search. * *(string) --* * **aggregations** (*list*) -- Enables you to specify one or more attributes to compute and return counts grouped by field values. * *(dict) --* An aggregation list item. * **attribute** *(string) --* **[REQUIRED]** An attribute on which to compute aggregations. * **displayValue** *(string) --* The display value of the aggregation list item. Supported values include "value" and "glossaryTerm.name". * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the domain in which to search listings. * **filters** (*dict*) -- Specifies the filters for the search of listings. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **and** *(list) --* The 'and' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **filter** *(dict) --* A search filter in Amazon DataZone. * **attribute** *(string) --* **[REQUIRED]** A search filter attribute in Amazon DataZone. * **value** *(string) --* **[REQUIRED]** A search filter value in Amazon DataZone. * **or** *(list) --* The 'or' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **searchIn** (*list*) -- The details of the search. * *(dict) --* The details of the search. * **attribute** *(string) --* **[REQUIRED]** The search attribute. * **searchText** (*string*) -- Specifies the text for which to search. * **sort** (*dict*) -- Specifies the way for sorting the search results. * **attribute** *(string) --* **[REQUIRED]** The attribute detail of the way to sort search results. * **order** *(string) --* The order detail of the wya to sort search results. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'aggregates': [ { 'attribute': 'string', 'displayValue': 'string', 'items': [ { 'count': 123, 'displayValue': 'string', 'value': 'string' }, ] }, ], 'items': [ { 'assetListing': { 'additionalAttributes': { 'forms': 'string', 'latestTimeSeriesDataPointForms': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'listingCreatedBy': 'string', 'listingId': 'string', 'listingRevision': 'string', 'listingUpdatedBy': 'string', 'name': 'string', 'owningProjectId': 'string' }, 'dataProductListing': { 'additionalAttributes': { 'forms': 'string', 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'items': [ { 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'listingId': 'string', 'listingRevision': 'string' }, ], 'listingCreatedBy': 'string', 'listingId': 'string', 'listingRevision': 'string', 'listingUpdatedBy': 'string', 'name': 'string', 'owningProjectId': 'string' } }, ], 'totalMatchCount': 123, 'NextToken': 'string' } **Response Structure** * *(dict) --* * **aggregates** *(list) --* Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings. * *(dict) --* The aggregation for an attribute. * **attribute** *(string) --* The attribute for this aggregation. * **displayValue** *(string) --* The display value of the aggregation output item. * **items** *(list) --* A list of aggregation output items. * *(dict) --* An aggregation output item. * **count** *(integer) --* The count of the aggregation output item. * **displayValue** *(string) --* The display value of the aggregation. If the attribute being aggregated corresponds to the id of a public resource, the service automatically resolves the id to the provided display value. * **value** *(string) --* The attribute value of the aggregation output item. * **items** *(list) --* The results of the "SearchListings" action. * *(dict) --* The details of the results of the "SearchListings" action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "dataProductListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset listing included in the results of the "SearchListings" action. * **additionalAttributes** *(dict) --* The additional attributes of an asset published in an Amazon DataZone catalog. * **forms** *(string) --* The metadata forms that form additional attributes of the metadata asset. * **latestTimeSeriesDataPointForms** *(list) --* The latest time series data points forms included in the additional attributes of an asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp of when an asset published in an Amazon DataZone catalog was created. * **description** *(string) --* The description of an asset published in an Amazon DataZone catalog. * **entityId** *(string) --* The identifier of the inventory asset. * **entityRevision** *(string) --* The revision of the inventory asset. * **entityType** *(string) --* The type of the inventory asset. * **glossaryTerms** *(list) --* Glossary terms attached to the inventory asset. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **listingCreatedBy** *(string) --* The Amazon DataZone user who created the listing. * **listingId** *(string) --* The identifier of the listing (asset published in Amazon DataZone catalog). * **listingRevision** *(string) --* The revision of the listing (asset published in Amazon DataZone catalog). * **listingUpdatedBy** *(string) --* The Amazon DataZone user who updated the listing. * **name** *(string) --* The name of the inventory asset. * **owningProjectId** *(string) --* The identifier of the project that owns the inventory asset. * **dataProductListing** *(dict) --* The data product listing. * **additionalAttributes** *(dict) --* The additional attributes of the asset of the data product. * **forms** *(string) --* The metadata forms of the asset of the data product. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp at which the asset of the data product listing was created. * **description** *(string) --* The description of the asset of the asset of the data product. * **entityId** *(string) --* The entity ID of the asset of the asset of the data product. * **entityRevision** *(string) --* The revision of the asset of the asset of the data product. * **glossaryTerms** *(list) --* The glossary terms of the asset of the asset of the data product. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **items** *(list) --* The data of the asset of the data product. * *(dict) --* The results of the data product summary. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **listingId** *(string) --* The ID of the data product listing. * **listingRevision** *(string) --* The revision of the data product listing. * **listingCreatedBy** *(string) --* The timestamp at which the listing was created. * **listingId** *(string) --* The ID of the listing. * **listingRevision** *(string) --* The revision of the listing. * **listingUpdatedBy** *(string) --* The user who updated the listing. * **name** *(string) --* The name of the asset of the data product. * **owningProjectId** *(string) --* The ID of the owning project of the asset of the data product. * **totalMatchCount** *(integer) --* Total number of search results. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListEnvironmentProfiles ListEnvironmentProfiles *********************** class DataZone.Paginator.ListEnvironmentProfiles paginator = client.get_paginator('list_environment_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_environment_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( awsAccountId='string', awsAccountRegion='string', domainIdentifier='string', environmentBlueprintIdentifier='string', name='string', projectIdentifier='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **awsAccountId** (*string*) -- The identifier of the Amazon Web Services account where you want to list environment profiles. * **awsAccountRegion** (*string*) -- The Amazon Web Services region where you want to list environment profiles. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **environmentBlueprintIdentifier** (*string*) -- The identifier of the blueprint that was used to create the environment profiles that you want to list. * **name** (*string*) * **projectIdentifier** (*string*) -- The identifier of the Amazon DataZone project. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListEnvironmentProfiles" action. * *(dict) --* The details of an environment profile. * **awsAccountId** *(string) --* The identifier of an Amazon Web Services account in which an environment profile exists. * **awsAccountRegion** *(string) --* The Amazon Web Services Region in which an environment profile exists. * **createdAt** *(datetime) --* The timestamp of when an environment profile was created. * **createdBy** *(string) --* The Amazon DataZone user who created the environment profile. * **description** *(string) --* The description of the environment profile. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the environment profile exists. * **environmentBlueprintId** *(string) --* The identifier of a blueprint with which an environment profile is created. * **id** *(string) --* The identifier of the environment profile. * **name** *(string) --* The name of the environment profile. * **projectId** *(string) --* The identifier of a project in which an environment profile exists. * **updatedAt** *(datetime) --* The timestamp of when the environment profile was updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Paginator / ListRules ListRules ********* class DataZone.Paginator.ListRules paginator = client.get_paginator('list_rules') paginate(**kwargs) Creates an iterator that will paginate through responses from "DataZone.Client.list_rules()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( action='CREATE_LISTING_CHANGE_SET'|'CREATE_SUBSCRIPTION_REQUEST', assetTypes=[ 'string', ], dataProduct=True|False, domainIdentifier='string', includeCascaded=True|False, projectIds=[ 'string', ], ruleType='METADATA_FORM_ENFORCEMENT', targetIdentifier='string', targetType='DOMAIN_UNIT', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **action** (*string*) -- The action of the rule. * **assetTypes** (*list*) -- The asset types of the rule. * *(string) --* * **dataProduct** (*boolean*) -- The data product of the rule. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain in which the rules are to be listed. * **includeCascaded** (*boolean*) -- Specifies whether to include cascading rules in the results. * **projectIds** (*list*) -- The IDs of projects in which rules are to be listed. * *(string) --* * **ruleType** (*string*) -- The type of the rule. * **targetIdentifier** (*string*) -- **[REQUIRED]** The target ID of the rule. * **targetType** (*string*) -- **[REQUIRED]** The target type of the rule. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'items': [ { 'action': 'CREATE_LISTING_CHANGE_SET'|'CREATE_SUBSCRIPTION_REQUEST', 'identifier': 'string', 'lastUpdatedBy': 'string', 'name': 'string', 'revision': 'string', 'ruleType': 'METADATA_FORM_ENFORCEMENT', 'scope': { 'assetType': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificAssetTypes': [ 'string', ] }, 'dataProduct': True|False, 'project': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificProjects': [ 'string', ] } }, 'target': { 'domainUnitTarget': { 'domainUnitId': 'string', 'includeChildDomainUnits': True|False } }, 'targetType': 'DOMAIN_UNIT', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListRules" action. * *(dict) --* The summary of the rule. * **action** *(string) --* The action of the rule. * **identifier** *(string) --* The ID of the rule. * **lastUpdatedBy** *(string) --* The timestamp at which the rule was last updated. * **name** *(string) --* The name of the rule. * **revision** *(string) --* The revision of the rule. * **ruleType** *(string) --* The type of the rule. * **scope** *(dict) --* The scope of the rule. * **assetType** *(dict) --* The asset type included in the rule scope. * **selectionMode** *(string) --* The selection mode for the rule. * **specificAssetTypes** *(list) --* The specific asset types that are included in the rule. * *(string) --* * **dataProduct** *(boolean) --* The data product included in the rule scope. * **project** *(dict) --* The project included in the rule scope. * **selectionMode** *(string) --* The selection mode of the rule. * **specificProjects** *(list) --* The specific projects in which the rule is created. * *(string) --* * **target** *(dict) --* The target of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "domainUnitTarget". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **domainUnitTarget** *(dict) --* The ID of the domain unit. * **domainUnitId** *(string) --* The ID of the domain unit. * **includeChildDomainUnits** *(boolean) --* Specifies whether to apply a rule to the child domain units. * **targetType** *(string) --* The target type of the rule. * **updatedAt** *(datetime) --* The timestamp at which the rule was last updated. * **NextToken** *(string) --* A token to resume pagination. DataZone / Client / update_subscription_grant_status update_subscription_grant_status ******************************** DataZone.Client.update_subscription_grant_status(**kwargs) Updates the status of the specified subscription grant status in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_subscription_grant_status( assetIdentifier='string', domainIdentifier='string', failureCause={ 'message': 'string' }, identifier='string', status='GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED', targetName='string' ) Parameters: * **assetIdentifier** (*string*) -- **[REQUIRED]** The identifier of the asset the subscription grant status of which is to be updated. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated. * **failureCause** (*dict*) -- Specifies the error message that is returned if the operation cannot be successfully completed. * **message** *(string) --* The description of the error message. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the subscription grant the status of which is to be updated. * **status** (*string*) -- **[REQUIRED]** The status to be updated as part of the "UpdateSubscriptionGrantStatus" action. * **targetName** (*string*) -- The target name to be updated as part of the "UpdateSubscriptionGrantStatus" action. Return type: dict Returns: **Response Syntax** { 'assets': [ { 'assetId': 'string', 'assetRevision': 'string', 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'failureCause': { 'message': 'string' }, 'failureTimestamp': datetime(2015, 1, 1), 'grantedTimestamp': datetime(2015, 1, 1), 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED', 'targetName': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'grantedEntity': { 'listing': { 'id': 'string', 'revision': 'string' } }, 'id': 'string', 'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE', 'subscriptionId': 'string', 'subscriptionTargetId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **assets** *(list) --* The details of the asset for which the subscription grant is created. * *(dict) --* The details of the asset for which the subscription grant is created. * **assetId** *(string) --* The identifier of the asset for which the subscription grant is created. * **assetRevision** *(string) --* The revision of the asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **failureCause** *(dict) --* The failure cause included in the details of the asset for which the subscription grant is created. * **message** *(string) --* The description of the error message. * **failureTimestamp** *(datetime) --* The failure timestamp included in the details of the asset for which the subscription grant is created. * **grantedTimestamp** *(datetime) --* The timestamp of when the subscription grant to the asset is created. * **status** *(string) --* The status of the asset for which the subscription grant is created. * **targetName** *(string) --* The target name of the asset for which the subscription grant is created. * **createdAt** *(datetime) --* The timestamp of when the subscription grant status was created. * **createdBy** *(string) --* The Amazon DataZone domain user who created the subscription grant status. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated. * **grantedEntity** *(dict) --* The granted entity to be updated as part of the "UpdateSubscriptionGrantStatus" action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "listing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **listing** *(dict) --* The listing for which a subscription is granted. * **id** *(string) --* An identifier of a revision of an asset published in a Amazon DataZone catalog. * **revision** *(string) --* The details of a revision of an asset published in a Amazon DataZone catalog. * **id** *(string) --* The identifier of the subscription grant. * **status** *(string) --* The status to be updated as part of the "UpdateSubscriptionGrantStatus" action. * **subscriptionId** *(string) --* The identifier of the subscription. * **subscriptionTargetId** *(string) --* The identifier of the subscription target whose subscription grant status is to be updated. * **updatedAt** *(datetime) --* The timestamp of when the subscription grant status is to be updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription grant status. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_glossary delete_glossary *************** DataZone.Client.delete_glossary(**kwargs) Deletes a business glossary in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_glossary( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the business glossary is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the business glossary that is deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_environment get_environment *************** DataZone.Client.get_environment(**kwargs) Gets an Amazon DataZone environment. See also: AWS API Documentation **Request Syntax** response = client.get_environment( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where the environment exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone environment. Return type: dict Returns: **Response Syntax** { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'deploymentProperties': { 'endTimeoutMinutes': 123, 'startTimeoutMinutes': 123 }, 'description': 'string', 'domainId': 'string', 'environmentActions': [ { 'auth': 'IAM'|'HTTPS', 'parameters': [ { 'key': 'string', 'value': 'string' }, ], 'type': 'string' }, ], 'environmentBlueprintId': 'string', 'environmentConfigurationId': 'string', 'environmentProfileId': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'lastDeployment': { 'deploymentId': 'string', 'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT', 'deploymentType': 'CREATE'|'UPDATE'|'DELETE', 'failureReason': { 'code': 'string', 'message': 'string' }, 'isDeploymentComplete': True|False, 'messages': [ 'string', ] }, 'name': 'string', 'projectId': 'string', 'provider': 'string', 'provisionedResources': [ { 'name': 'string', 'provider': 'string', 'type': 'string', 'value': 'string' }, ], 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'keyName': 'string' }, ] } **Response Structure** * *(dict) --* * **awsAccountId** *(string) --* The ID of the Amazon Web Services account where the environment exists. * **awsAccountRegion** *(string) --* The Amazon Web Services region where the environment exists. * **createdAt** *(datetime) --* The timestamp of when the environment was created. * **createdBy** *(string) --* The Amazon DataZone user who created the environment. * **deploymentProperties** *(dict) --* The deployment properties of the environment. * **endTimeoutMinutes** *(integer) --* The end timeout of the environment blueprint deployment. * **startTimeoutMinutes** *(integer) --* The start timeout of the environment blueprint deployment. * **description** *(string) --* The description of the environment. * **domainId** *(string) --* The ID of the Amazon DataZone domain where the environment exists. * **environmentActions** *(list) --* The actions of the environment. * *(dict) --* The configurable action of a Amazon DataZone environment. * **auth** *(string) --* The authentication type of a configurable action of a Amazon DataZone environment. * **parameters** *(list) --* The parameters of a configurable action in a Amazon DataZone environment. * *(dict) --* The details of the parameters for the configurable environment action. * **key** *(string) --* The key of the configurable action parameter. * **value** *(string) --* The value of the configurable action parameter. * **type** *(string) --* The type of a configurable action in a Amazon DataZone environment. * **environmentBlueprintId** *(string) --* The blueprint with which the environment is created. * **environmentConfigurationId** *(string) --* The configuration ID that is used to create the environment. * **environmentProfileId** *(string) --* The ID of the environment profile with which the environment is created. * **glossaryTerms** *(list) --* The business glossary terms that can be used in this environment. * *(string) --* * **id** *(string) --* The ID of the environment. * **lastDeployment** *(dict) --* The details of the last deployment of the environment. * **deploymentId** *(string) --* The identifier of the last deployment of the environment. * **deploymentStatus** *(string) --* The status of the last deployment of the environment. * **deploymentType** *(string) --* The type of the last deployment of the environment. * **failureReason** *(dict) --* The failure reason of the last deployment of the environment. * **code** *(string) --* The error code for the failure reason for the environment deployment. * **message** *(string) --* The error message for the failure reason for the environment deployment. * **isDeploymentComplete** *(boolean) --* Specifies whether the last deployment of the environment is complete. * **messages** *(list) --* The messages of the last deployment of the environment. * *(string) --* * **name** *(string) --* The name of the environment. * **projectId** *(string) --* The ID of the Amazon DataZone project in which this environment is created. * **provider** *(string) --* The provider of this Amazon DataZone environment. * **provisionedResources** *(list) --* The provisioned resources of this Amazon DataZone environment. * *(dict) --* The details of a provisioned resource of this Amazon DataZone environment. * **name** *(string) --* The name of a provisioned resource of this Amazon DataZone environment. * **provider** *(string) --* The provider of a provisioned resource of this Amazon DataZone environment. * **type** *(string) --* The type of a provisioned resource of this Amazon DataZone environment. * **value** *(string) --* The value of a provisioned resource of this Amazon DataZone environment. * **provisioningProperties** *(dict) --* The provisioning properties of this Amazon DataZone environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "cloudFormation". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **cloudFormation** *(dict) --* The cloud formation properties included as part of the provisioning properties of an environment blueprint. * **templateUrl** *(string) --* The template URL of the cloud formation provisioning properties of the environment blueprint. * **status** *(string) --* The status of this Amazon DataZone environment. * **updatedAt** *(datetime) --* The timestamp of when this environment was updated. * **userParameters** *(list) --* The user parameters of this Amazon DataZone environment. * *(dict) --* The details of user parameters of an environment blueprint. * **defaultValue** *(string) --* The default value of the parameter. * **description** *(string) --* The description of the parameter. * **fieldType** *(string) --* The filed type of the parameter. * **isEditable** *(boolean) --* Specifies whether the parameter is editable. * **isOptional** *(boolean) --* Specifies whether the custom parameter is optional. * **keyName** *(string) --* The key name of the parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_subscription_request create_subscription_request *************************** DataZone.Client.create_subscription_request(**kwargs) Creates a subscription request in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.create_subscription_request( clientToken='string', domainIdentifier='string', metadataForms=[ { 'content': 'string', 'formName': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], requestReason='string', subscribedListings=[ { 'identifier': 'string' }, ], subscribedPrincipals=[ { 'project': { 'identifier': 'string' } }, ] ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the subscription request is created. * **metadataForms** (*list*) -- The metadata form included in the subscription request. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* **[REQUIRED]** The name of the metadata form. * **typeIdentifier** *(string) --* The ID of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **requestReason** (*string*) -- **[REQUIRED]** The reason for the subscription request. * **subscribedListings** (*list*) -- **[REQUIRED]** The published asset for which the subscription grant is to be created. * *(dict) --* The published asset for which the subscription grant is to be created. * **identifier** *(string) --* **[REQUIRED]** The identifier of the published asset for which the subscription grant is to be created. * **subscribedPrincipals** (*list*) -- **[REQUIRED]** The Amazon DataZone principals for whom the subscription request is created. * *(dict) --* The principal that is to be given a subscriptiong grant. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "project". * **project** *(dict) --* The project that is to be given a subscription grant. * **identifier** *(string) --* The identifier of the project that is to be given a subscription grant. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'decisionComment': 'string', 'domainId': 'string', 'existingSubscriptionId': 'string', 'id': 'string', 'metadataForms': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'requestReason': 'string', 'reviewerId': 'string', 'status': 'PENDING'|'ACCEPTED'|'REJECTED', 'subscribedListings': [ { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, ], 'subscribedPrincipals': [ { 'project': { 'id': 'string', 'name': 'string' } }, ], 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* A timestamp of when the subscription request is created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription request. * **decisionComment** *(string) --* The decision comment of the subscription request. * **domainId** *(string) --* The ID of the Amazon DataZone domain in whcih the subscription request is created. * **existingSubscriptionId** *(string) --* The ID of the existing subscription. * **id** *(string) --* The ID of the subscription request. * **metadataForms** *(list) --* The metadata form included in the subscription request. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **requestReason** *(string) --* The reason for the subscription request. * **reviewerId** *(string) --* The ID of the reviewer of the subscription request. * **status** *(string) --* The status of the subscription request. * **subscribedListings** *(list) --* The published asset for which the subscription grant is to be created. * *(dict) --* The details of the published asset for which the subscription grant is created. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipals** *(list) --* The subscribed principals of the subscription request. * *(dict) --* The principal that has the subscription grant for the asset. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **updatedAt** *(datetime) --* The timestamp of when the subscription request was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription request. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_environment_blueprint_configuration delete_environment_blueprint_configuration ****************************************** DataZone.Client.delete_environment_blueprint_configuration(**kwargs) Deletes the blueprint configuration in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_environment_blueprint_configuration( domainIdentifier='string', environmentBlueprintIdentifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the blueprint configuration is deleted. * **environmentBlueprintIdentifier** (*string*) -- **[REQUIRED]** The ID of the blueprint the configuration of which is deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_entity_owners list_entity_owners ****************** DataZone.Client.list_entity_owners(**kwargs) Lists the entity (domain units) owners. See also: AWS API Documentation **Request Syntax** response = client.list_entity_owners( domainIdentifier='string', entityIdentifier='string', entityType='DOMAIN_UNIT', maxResults=123, nextToken='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list entity owners. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the entity that you want to list. * **entityType** (*string*) -- **[REQUIRED]** The type of the entity that you want to list. * **maxResults** (*integer*) -- The maximum number of entities to return in a single call to "ListEntityOwners". When the number of entities to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListEntityOwners" to list the next set of entities. * **nextToken** (*string*) -- When the number of entities is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of entities, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEntityOwners" to list the next set of entities. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'owners': [ { 'group': { 'groupId': 'string' }, 'user': { 'userId': 'string' } }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* When the number of entities is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of entities, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEntityOwners" to list the next set of entities. * **owners** *(list) --* The owners of the entity. * *(dict) --* The ID of the domain unit owners group. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "group", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **group** *(dict) --* Specifies that the domain unit owner is a group. * **groupId** *(string) --* The ID of the domain unit owners group. * **user** *(dict) --* Specifies that the domain unit owner is a user. * **userId** *(string) --* The ID of the owner user. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_asset_filter delete_asset_filter ******************* DataZone.Client.delete_asset_filter(**kwargs) Deletes an asset filter. See also: AWS API Documentation **Request Syntax** response = client.delete_asset_filter( assetIdentifier='string', domainIdentifier='string', identifier='string' ) Parameters: * **assetIdentifier** (*string*) -- **[REQUIRED]** The ID of the data asset. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to delete an asset filter. * **identifier** (*string*) -- **[REQUIRED]** The ID of the asset filter that you want to delete. Returns: None **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_environment_profile delete_environment_profile ************************** DataZone.Client.delete_environment_profile(**kwargs) Deletes an environment profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_environment_profile( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the environment profile is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the environment profile that is deleted. Returns: None **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_paginator get_paginator ************* DataZone.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. DataZone / Client / create_project_membership create_project_membership ************************* DataZone.Client.create_project_membership(**kwargs) Creates a project membership in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.create_project_membership( designation='PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD', domainIdentifier='string', member={ 'groupIdentifier': 'string', 'userIdentifier': 'string' }, projectIdentifier='string' ) Parameters: * **designation** (*string*) -- **[REQUIRED]** The designation of the project membership. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which project membership is created. * **member** (*dict*) -- **[REQUIRED]** The project member whose project membership was created. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "groupIdentifier", "userIdentifier". * **groupIdentifier** *(string) --* The ID of the group of a project member. * **userIdentifier** *(string) --* The user ID of a project member. * **projectIdentifier** (*string*) -- **[REQUIRED]** The ID of the project for which this project membership was created. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / associate_environment_role associate_environment_role ************************** DataZone.Client.associate_environment_role(**kwargs) Associates the environment role in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.associate_environment_role( domainIdentifier='string', environmentIdentifier='string', environmentRoleArn='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the environment role is associated. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone environment. * **environmentRoleArn** (*string*) -- **[REQUIRED]** The ARN of the environment role. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_time_series_data_points delete_time_series_data_points ****************************** DataZone.Client.delete_time_series_data_points(**kwargs) Deletes the specified time series form for the specified asset. See also: AWS API Documentation **Request Syntax** response = client.delete_time_series_data_points( clientToken='string', domainIdentifier='string', entityIdentifier='string', entityType='ASSET'|'LISTING', formName='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the asset for which you want to delete a time series form. * **entityType** (*string*) -- **[REQUIRED]** The type of the asset for which you want to delete a time series form. * **formName** (*string*) -- **[REQUIRED]** The name of the time series form that you want to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_data_product create_data_product ******************* DataZone.Client.create_data_product(**kwargs) Creates a data product. See also: AWS API Documentation **Request Syntax** response = client.create_data_product( clientToken='string', description='string', domainIdentifier='string', formsInput=[ { 'content': 'string', 'formName': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], glossaryTerms=[ 'string', ], items=[ { 'glossaryTerms': [ 'string', ], 'identifier': 'string', 'itemType': 'ASSET', 'revision': 'string' }, ], name='string', owningProjectIdentifier='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description of the data product. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where the data product is created. * **formsInput** (*list*) -- The metadata forms of the data product. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* **[REQUIRED]** The name of the metadata form. * **typeIdentifier** *(string) --* The ID of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** (*list*) -- The glossary terms of the data product. * *(string) --* * **items** (*list*) -- The data assets of the data product. * *(dict) --* The data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **identifier** *(string) --* **[REQUIRED]** The ID of the data product. * **itemType** *(string) --* **[REQUIRED]** The type of the data product. * **revision** *(string) --* The revision of the data product. * **name** (*string*) -- **[REQUIRED]** The name of the data product. * **owningProjectIdentifier** (*string*) -- **[REQUIRED]** The ID of the owning project of the data product. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'items': [ { 'glossaryTerms': [ 'string', ], 'identifier': 'string', 'itemType': 'ASSET', 'revision': 'string' }, ], 'name': 'string', 'owningProjectId': 'string', 'revision': 'string', 'status': 'CREATED'|'CREATING'|'CREATE_FAILED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp at which the data product was created. * **createdBy** *(string) --* The user who created the data product. * **description** *(string) --* The description of the data product. * **domainId** *(string) --* The ID of the domain where the data product lives. * **firstRevisionCreatedAt** *(datetime) --* The timestamp at which the first revision of the data product was created. * **firstRevisionCreatedBy** *(string) --* The user who created the first revision of the data product. * **formsOutput** *(list) --* The metadata forms of the data product. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **id** *(string) --* The ID of the data product. * **items** *(list) --* The data assets of the data product. * *(dict) --* The data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **identifier** *(string) --* The ID of the data product. * **itemType** *(string) --* The type of the data product. * **revision** *(string) --* The revision of the data product. * **name** *(string) --* The name of the data product. * **owningProjectId** *(string) --* The ID of the owning project of the data product. * **revision** *(string) --* The revision of the data product. * **status** *(string) --* The status of the data product. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / start_metadata_generation_run start_metadata_generation_run ***************************** DataZone.Client.start_metadata_generation_run(**kwargs) Starts the metadata generation run. See also: AWS API Documentation **Request Syntax** response = client.start_metadata_generation_run( clientToken='string', domainIdentifier='string', owningProjectIdentifier='string', target={ 'identifier': 'string', 'revision': 'string', 'type': 'ASSET' }, type='BUSINESS_DESCRIPTIONS' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where you want to start a metadata generation run. * **owningProjectIdentifier** (*string*) -- **[REQUIRED]** The ID of the project that owns the asset for which you want to start a metadata generation run. * **target** (*dict*) -- **[REQUIRED]** The asset for which you want to start a metadata generation run. * **identifier** *(string) --* **[REQUIRED]** The ID of the metadata generation run's target. * **revision** *(string) --* The revision of the asset for which metadata was generated. * **type** *(string) --* **[REQUIRED]** The type of the asset for which metadata was generated. * **type** (*string*) -- **[REQUIRED]** The type of the metadata generation run. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'owningProjectId': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED', 'type': 'BUSINESS_DESCRIPTIONS' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp at which the metadata generation run was started. * **createdBy** *(string) --* The ID of the user who started the metadata generation run. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the metadata generation run was started. * **id** *(string) --* The ID of the metadata generation run. * **owningProjectId** *(string) --* The ID of the project that owns the asset for which the metadata generation run was started. * **status** *(string) --* The status of the metadata generation run. * **type** *(string) --* The type of the metadata generation run. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_data_source get_data_source *************** DataZone.Client.get_data_source(**kwargs) Gets an Amazon DataZone data source. See also: AWS API Documentation **Request Syntax** response = client.get_data_source( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the data source exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone data source. Return type: dict Returns: **Response Syntax** { 'assetFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'configuration': { 'glueRunConfiguration': { 'accountId': 'string', 'autoImportDataQualityResult': True|False, 'catalogName': 'string', 'dataAccessRole': 'string', 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'redshiftRunConfiguration': { 'accountId': 'string', 'dataAccessRole': 'string', 'redshiftCredentialConfiguration': { 'secretManagerArn': 'string' }, 'redshiftStorage': { 'redshiftClusterSource': { 'clusterName': 'string' }, 'redshiftServerlessSource': { 'workgroupName': 'string' } }, 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'sageMakerRunConfiguration': { 'accountId': 'string', 'region': 'string', 'trackingAssets': { 'string': [ 'string', ] } } }, 'connectionId': 'string', 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'enableSetting': 'ENABLED'|'DISABLED', 'environmentId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'lastRunAssetCount': 123, 'lastRunAt': datetime(2015, 1, 1), 'lastRunErrorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'name': 'string', 'projectId': 'string', 'publishOnImport': True|False, 'recommendation': { 'enableBusinessNameGeneration': True|False }, 'schedule': { 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' }, 'selfGrantStatus': { 'glueSelfGrantStatus': { 'selfGrantStatusDetails': [ { 'databaseName': 'string', 'failureCause': 'string', 'schemaName': 'string', 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'GRANT_FAILED'|'REVOKE_FAILED' }, ] }, 'redshiftSelfGrantStatus': { 'selfGrantStatusDetails': [ { 'databaseName': 'string', 'failureCause': 'string', 'schemaName': 'string', 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'GRANT_FAILED'|'REVOKE_FAILED' }, ] } }, 'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', 'type': 'string', 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **assetFormsOutput** *(list) --* The metadata forms attached to the assets created by this data source. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **configuration** *(dict) --* The configuration of the data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "glueRunConfiguration", "redshiftRunConfiguration", "sageMakerRunConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **glueRunConfiguration** *(dict) --* The configuration of the Amazon Web Services Glue data source. * **accountId** *(string) --* The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source. * **autoImportDataQualityResult** *(boolean) --* Specifies whether to automatically import data quality metrics as part of the data source run. * **catalogName** *(string) --* The catalog name in the Amazon Web Services Glue run configuration. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Web Services Glue data source. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. * **relationalFilterConfigurations** *(list) --* The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **redshiftRunConfiguration** *(dict) --* The configuration of the Amazon Redshift data source. * **accountId** *(string) --* The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Redshift data source. * **redshiftCredentialConfiguration** *(dict) --* The details of the credentials required to access an Amazon Redshift cluster. * **secretManagerArn** *(string) --* The ARN of a secret manager for an Amazon Redshift cluster. * **redshiftStorage** *(dict) --* The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "redshiftClusterSource", "redshiftServerlessSource". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **redshiftClusterSource** *(dict) --* The details of the Amazon Redshift cluster source. * **clusterName** *(string) --* The name of an Amazon Redshift cluster. * **redshiftServerlessSource** *(dict) --* The details of the Amazon Redshift Serverless workgroup source. * **workgroupName** *(string) --* The name of the Amazon Redshift Serverless workgroup. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Redshift data source. * **relationalFilterConfigurations** *(list) --* The relational filger configurations included in the configuration details of the Amazon Redshift data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **sageMakerRunConfiguration** *(dict) --* The Amazon SageMaker run configuration. * **accountId** *(string) --* The Amazon SageMaker account ID. * **region** *(string) --* The Amazon SageMaker Region. * **trackingAssets** *(dict) --* The tracking assets of the Amazon SageMaker. * *(string) --* * *(list) --* * *(string) --* * **connectionId** *(string) --* The ID of the connection. * **createdAt** *(datetime) --* The timestamp of when the data source was created. * **description** *(string) --* The description of the data source. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the data source exists. * **enableSetting** *(string) --* Specifies whether this data source is enabled or not. * **environmentId** *(string) --* The ID of the environment where this data source creates and publishes assets, * **errorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The ID of the data source. * **lastRunAssetCount** *(integer) --* The number of assets created by the data source during its last run. * **lastRunAt** *(datetime) --* The timestamp of the last run of the data source. * **lastRunErrorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **lastRunStatus** *(string) --* The status of the last run of the data source. * **name** *(string) --* The name of the data source. * **projectId** *(string) --* The ID of the project where the data source creates and publishes assets. * **publishOnImport** *(boolean) --* Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. * **recommendation** *(dict) --* The recommendation configuration of the data source. * **enableBusinessNameGeneration** *(boolean) --* Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. * **schedule** *(dict) --* The schedule of the data source runs. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. * **selfGrantStatus** *(dict) --* Specifies the status of the self-granting functionality. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "glueSelfGrantStatus", "redshiftSelfGrantStatus". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **glueSelfGrantStatus** *(dict) --* The details for the self granting status for a Glue data source. * **selfGrantStatusDetails** *(list) --* The details for the self granting status for a Glue data source. * *(dict) --* The details for the self granting status. * **databaseName** *(string) --* The name of the database used for the data source. * **failureCause** *(string) --* The reason for why the operation failed. * **schemaName** *(string) --* The name of the schema used in the data source. * **status** *(string) --* The self granting status of the data source. * **redshiftSelfGrantStatus** *(dict) --* The details for the self granting status for an Amazon Redshift data source. * **selfGrantStatusDetails** *(list) --* The details for the self granting status for an Amazon Redshift data source. * *(dict) --* The details for the self granting status. * **databaseName** *(string) --* The name of the database used for the data source. * **failureCause** *(string) --* The reason for why the operation failed. * **schemaName** *(string) --* The name of the schema used in the data source. * **status** *(string) --* The self granting status of the data source. * **status** *(string) --* The status of the data source. * **type** *(string) --* The type of the data source. * **updatedAt** *(datetime) --* The timestamp of when the data source was updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / accept_predictions accept_predictions ****************** DataZone.Client.accept_predictions(**kwargs) Accepts automatically generated business-friendly metadata for your Amazon DataZone assets. See also: AWS API Documentation **Request Syntax** response = client.accept_predictions( acceptChoices=[ { 'editedValue': 'string', 'predictionChoice': 123, 'predictionTarget': 'string' }, ], acceptRule={ 'rule': 'ALL'|'NONE', 'threshold': ... }, clientToken='string', domainIdentifier='string', identifier='string', revision='string' ) Parameters: * **acceptChoices** (*list*) -- Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted. * *(dict) --* Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted. * **editedValue** *(string) --* The edit of the prediction. * **predictionChoice** *(integer) --* Specifies the prediction (aka, the automatically generated piece of metadata) that can be accepted. * **predictionTarget** *(string) --* **[REQUIRED]** Specifies the target (for example, a column name) where a prediction can be accepted. * **acceptRule** (*dict*) -- Specifies the rule (or the conditions) under which a prediction can be accepted. * **rule** *(string) --* Specifies whether you want to accept the top prediction for all targets or none. * **threshold** *(float) --* The confidence score that specifies the condition at which a prediction can be accepted. * **clientToken** (*string*) -- A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the asset. * **revision** (*string*) -- The revision that is to be made to the asset. Return type: dict Returns: **Response Syntax** { 'assetId': 'string', 'domainId': 'string', 'revision': 'string' } **Response Structure** * *(dict) --* * **assetId** *(string) --* The ID of the asset. * **domainId** *(string) --* The identifier of the Amazon DataZone domain. * **revision** *(string) --* The revision that is to be made to the asset. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_glossary_term update_glossary_term ******************** DataZone.Client.update_glossary_term(**kwargs) Updates a business glossary term in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_glossary_term( domainIdentifier='string', glossaryIdentifier='string', identifier='string', longDescription='string', name='string', shortDescription='string', status='ENABLED'|'DISABLED', termRelations={ 'classifies': [ 'string', ], 'isA': [ 'string', ] } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which a business glossary term is to be updated. * **glossaryIdentifier** (*string*) -- The identifier of the business glossary in which a term is to be updated. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the business glossary term that is to be updated. * **longDescription** (*string*) -- The long description to be updated as part of the "UpdateGlossaryTerm" action. * **name** (*string*) -- The name to be updated as part of the "UpdateGlossaryTerm" action. * **shortDescription** (*string*) -- The short description to be updated as part of the "UpdateGlossaryTerm" action. * **status** (*string*) -- The status to be updated as part of the "UpdateGlossaryTerm" action. * **termRelations** (*dict*) -- The term relations to be updated as part of the "UpdateGlossaryTerm" action. * **classifies** *(list) --* The classifies of the term relations. * *(string) --* * **isA** *(list) --* The "isA" property of the term relations. * *(string) --* Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'glossaryId': 'string', 'id': 'string', 'longDescription': 'string', 'name': 'string', 'shortDescription': 'string', 'status': 'ENABLED'|'DISABLED', 'termRelations': { 'classifies': [ 'string', ], 'isA': [ 'string', ] } } **Response Structure** * *(dict) --* * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a business glossary term is to be updated. * **glossaryId** *(string) --* The identifier of the business glossary in which a term is to be updated. * **id** *(string) --* The identifier of the business glossary term that is to be updated. * **longDescription** *(string) --* The long description to be updated as part of the "UpdateGlossaryTerm" action. * **name** *(string) --* The name to be updated as part of the "UpdateGlossaryTerm" action. * **shortDescription** *(string) --* The short description to be updated as part of the "UpdateGlossaryTerm" action. * **status** *(string) --* The status to be updated as part of the "UpdateGlossaryTerm" action. * **termRelations** *(dict) --* The term relations to be updated as part of the "UpdateGlossaryTerm" action. * **classifies** *(list) --* The classifies of the term relations. * *(string) --* * **isA** *(list) --* The "isA" property of the term relations. * *(string) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_domains list_domains ************ DataZone.Client.list_domains(**kwargs) Lists Amazon DataZone domains. See also: AWS API Documentation **Request Syntax** response = client.list_domains( maxResults=123, nextToken='string', status='CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED' ) Parameters: * **maxResults** (*integer*) -- The maximum number of domains to return in a single call to "ListDomains". When the number of domains to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListDomains" to list the next set of domains. * **nextToken** (*string*) -- When the number of domains is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of domains, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListDomains" to list the next set of domains. * **status** (*string*) -- The status of the data source. Return type: dict Returns: **Response Syntax** { 'items': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainVersion': 'V1'|'V2', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'managedAccountId': 'string', 'name': 'string', 'portalUrl': 'string', 'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDomains" action. * *(dict) --* A summary of a Amazon DataZone domain. * **arn** *(string) --* The ARN of the Amazon DataZone domain. * **createdAt** *(datetime) --* A timestamp of when a Amazon DataZone domain was created. * **description** *(string) --* A description of an Amazon DataZone domain. * **domainVersion** *(string) --* The domain version. * **id** *(string) --* The ID of the Amazon DataZone domain. * **lastUpdatedAt** *(datetime) --* A timestamp of when a Amazon DataZone domain was last updated. * **managedAccountId** *(string) --* The identifier of the Amazon Web Services account that manages the domain. * **name** *(string) --* A name of an Amazon DataZone domain. * **portalUrl** *(string) --* The data portal URL for the Amazon DataZone domain. * **status** *(string) --* The status of the Amazon DataZone domain. * **nextToken** *(string) --* When the number of domains is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of domains, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListDomains" to list the next set of domains. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_rule create_rule *********** DataZone.Client.create_rule(**kwargs) Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards. See also: AWS API Documentation **Request Syntax** response = client.create_rule( action='CREATE_LISTING_CHANGE_SET'|'CREATE_SUBSCRIPTION_REQUEST', clientToken='string', description='string', detail={ 'metadataFormEnforcementDetail': { 'requiredMetadataForms': [ { 'typeIdentifier': 'string', 'typeRevision': 'string' }, ] } }, domainIdentifier='string', name='string', scope={ 'assetType': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificAssetTypes': [ 'string', ] }, 'dataProduct': True|False, 'project': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificProjects': [ 'string', ] } }, target={ 'domainUnitTarget': { 'domainUnitId': 'string', 'includeChildDomainUnits': True|False } } ) Parameters: * **action** (*string*) -- **[REQUIRED]** The action of the rule. * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description of the rule. * **detail** (*dict*) -- **[REQUIRED]** The detail of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "metadataFormEnforcementDetail". * **metadataFormEnforcementDetail** *(dict) --* The enforcement detail of the metadata form. * **requiredMetadataForms** *(list) --* The required metadata forms. * *(dict) --* The reference of a metadata form. * **typeIdentifier** *(string) --* **[REQUIRED]** The type ID of the metadata form reference. * **typeRevision** *(string) --* **[REQUIRED]** The type revision of the metadata form reference. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where the rule is created. * **name** (*string*) -- **[REQUIRED]** The name of the rule. * **scope** (*dict*) -- **[REQUIRED]** The scope of the rule. * **assetType** *(dict) --* The asset type included in the rule scope. * **selectionMode** *(string) --* **[REQUIRED]** The selection mode for the rule. * **specificAssetTypes** *(list) --* The specific asset types that are included in the rule. * *(string) --* * **dataProduct** *(boolean) --* The data product included in the rule scope. * **project** *(dict) --* The project included in the rule scope. * **selectionMode** *(string) --* **[REQUIRED]** The selection mode of the rule. * **specificProjects** *(list) --* The specific projects in which the rule is created. * *(string) --* * **target** (*dict*) -- **[REQUIRED]** The target of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "domainUnitTarget". * **domainUnitTarget** *(dict) --* The ID of the domain unit. * **domainUnitId** *(string) --* **[REQUIRED]** The ID of the domain unit. * **includeChildDomainUnits** *(boolean) --* Specifies whether to apply a rule to the child domain units. Return type: dict Returns: **Response Syntax** { 'action': 'CREATE_LISTING_CHANGE_SET'|'CREATE_SUBSCRIPTION_REQUEST', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'detail': { 'metadataFormEnforcementDetail': { 'requiredMetadataForms': [ { 'typeIdentifier': 'string', 'typeRevision': 'string' }, ] } }, 'identifier': 'string', 'name': 'string', 'ruleType': 'METADATA_FORM_ENFORCEMENT', 'scope': { 'assetType': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificAssetTypes': [ 'string', ] }, 'dataProduct': True|False, 'project': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificProjects': [ 'string', ] } }, 'target': { 'domainUnitTarget': { 'domainUnitId': 'string', 'includeChildDomainUnits': True|False } }, 'targetType': 'DOMAIN_UNIT' } **Response Structure** * *(dict) --* * **action** *(string) --* The action of the rule. * **createdAt** *(datetime) --* The timestamp at which the rule is created. * **createdBy** *(string) --* The user who creates the rule. * **description** *(string) --* The description of the rule. * **detail** *(dict) --* The detail of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "metadataFormEnforcementDetail". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **metadataFormEnforcementDetail** *(dict) --* The enforcement detail of the metadata form. * **requiredMetadataForms** *(list) --* The required metadata forms. * *(dict) --* The reference of a metadata form. * **typeIdentifier** *(string) --* The type ID of the metadata form reference. * **typeRevision** *(string) --* The type revision of the metadata form reference. * **identifier** *(string) --* The ID of the rule. * **name** *(string) --* The name of the rule. * **ruleType** *(string) --* The type of the rule. * **scope** *(dict) --* The scope of the rule. * **assetType** *(dict) --* The asset type included in the rule scope. * **selectionMode** *(string) --* The selection mode for the rule. * **specificAssetTypes** *(list) --* The specific asset types that are included in the rule. * *(string) --* * **dataProduct** *(boolean) --* The data product included in the rule scope. * **project** *(dict) --* The project included in the rule scope. * **selectionMode** *(string) --* The selection mode of the rule. * **specificProjects** *(list) --* The specific projects in which the rule is created. * *(string) --* * **target** *(dict) --* The target of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "domainUnitTarget". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **domainUnitTarget** *(dict) --* The ID of the domain unit. * **domainUnitId** *(string) --* The ID of the domain unit. * **includeChildDomainUnits** *(boolean) --* Specifies whether to apply a rule to the child domain units. * **targetType** *(string) --* The target type of the rule. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_data_product get_data_product **************** DataZone.Client.get_data_product(**kwargs) Gets the data product. See also: AWS API Documentation **Request Syntax** response = client.get_data_product( domainIdentifier='string', identifier='string', revision='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where the data product lives. * **identifier** (*string*) -- **[REQUIRED]** The ID of the data product. * **revision** (*string*) -- The revision of the data product. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'items': [ { 'glossaryTerms': [ 'string', ], 'identifier': 'string', 'itemType': 'ASSET', 'revision': 'string' }, ], 'name': 'string', 'owningProjectId': 'string', 'revision': 'string', 'status': 'CREATED'|'CREATING'|'CREATE_FAILED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp at which the data product is created. * **createdBy** *(string) --* The user who created the data product. * **description** *(string) --* The description of the data product. * **domainId** *(string) --* The ID of the domain where the data product lives. * **firstRevisionCreatedAt** *(datetime) --* The timestamp at which the first revision of the data product is created. * **firstRevisionCreatedBy** *(string) --* The user who created the first revision of the data product. * **formsOutput** *(list) --* The metadata forms of the data product. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **id** *(string) --* The ID of the data product. * **items** *(list) --* The data assets of the data product. * *(dict) --* The data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **identifier** *(string) --* The ID of the data product. * **itemType** *(string) --* The type of the data product. * **revision** *(string) --* The revision of the data product. * **name** *(string) --* The name of the data product. * **owningProjectId** *(string) --* The ID of the owning project of the data product. * **revision** *(string) --* The revision of the data product. * **status** *(string) --* The status of the data product. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / search_user_profiles search_user_profiles ******************** DataZone.Client.search_user_profiles(**kwargs) Searches user profiles in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.search_user_profiles( domainIdentifier='string', maxResults=123, nextToken='string', searchText='string', userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which you want to search user profiles. * **maxResults** (*integer*) -- The maximum number of results to return in a single call to "SearchUserProfiles". When the number of results to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "SearchUserProfiles" to list the next set of results. * **nextToken** (*string*) -- When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchUserProfiles" to list the next set of results. * **searchText** (*string*) -- Specifies the text for which to search. * **userType** (*string*) -- **[REQUIRED]** Specifies the user type for the "SearchUserProfiles" action. Return type: dict Returns: **Response Syntax** { 'items': [ { 'details': { 'iam': { 'arn': 'string' }, 'sso': { 'firstName': 'string', 'lastName': 'string', 'username': 'string' } }, 'domainId': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED', 'type': 'IAM'|'SSO' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "SearchUserProfiles" action. * *(dict) --* The details of the user profile. * **details** *(dict) --* The details of the user profile. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "iam", "sso". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **iam** *(dict) --* The IAM details included in the user profile details. * **arn** *(string) --* The ARN of an IAM user profile in Amazon DataZone. * **sso** *(dict) --* The single sign-on details included in the user profile details. * **firstName** *(string) --* The first name included in the single sign-on details of the user profile. * **lastName** *(string) --* The last name included in the single sign-on details of the user profile. * **username** *(string) --* The username included in the single sign-on details of the user profile. * **domainId** *(string) --* The ID of the Amazon DataZone domain of the user profile. * **id** *(string) --* The ID of the user profile. * **status** *(string) --* The status of the user profile. * **type** *(string) --* The type of the user profile. * **nextToken** *(string) --* When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchUserProfiles" to list the next set of results. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_environment_blueprint get_environment_blueprint ************************* DataZone.Client.get_environment_blueprint(**kwargs) Gets an Amazon DataZone blueprint. See also: AWS API Documentation **Request Syntax** response = client.get_environment_blueprint( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the domain in which this blueprint exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of this Amazon DataZone blueprint. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'deploymentProperties': { 'endTimeoutMinutes': 123, 'startTimeoutMinutes': 123 }, 'description': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'name': 'string', 'provider': 'string', 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'keyName': 'string' }, ] } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* A timestamp of when this blueprint was created. * **deploymentProperties** *(dict) --* The deployment properties of this Amazon DataZone blueprint. * **endTimeoutMinutes** *(integer) --* The end timeout of the environment blueprint deployment. * **startTimeoutMinutes** *(integer) --* The start timeout of the environment blueprint deployment. * **description** *(string) --* The description of this Amazon DataZone blueprint. * **glossaryTerms** *(list) --* The glossary terms attached to this Amazon DataZone blueprint. * *(string) --* * **id** *(string) --* The ID of this Amazon DataZone blueprint. * **name** *(string) --* The name of this Amazon DataZone blueprint. * **provider** *(string) --* The provider of this Amazon DataZone blueprint. * **provisioningProperties** *(dict) --* The provisioning properties of this Amazon DataZone blueprint. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "cloudFormation". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **cloudFormation** *(dict) --* The cloud formation properties included as part of the provisioning properties of an environment blueprint. * **templateUrl** *(string) --* The template URL of the cloud formation provisioning properties of the environment blueprint. * **updatedAt** *(datetime) --* The timestamp of when this blueprint was updated. * **userParameters** *(list) --* The user parameters of this blueprint. * *(dict) --* The details of user parameters of an environment blueprint. * **defaultValue** *(string) --* The default value of the parameter. * **description** *(string) --* The description of the parameter. * **fieldType** *(string) --* The filed type of the parameter. * **isEditable** *(boolean) --* Specifies whether the parameter is editable. * **isOptional** *(boolean) --* Specifies whether the custom parameter is optional. * **keyName** *(string) --* The key name of the parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_group_profile update_group_profile ******************** DataZone.Client.update_group_profile(**kwargs) Updates the specified group profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_group_profile( domainIdentifier='string', groupIdentifier='string', status='ASSIGNED'|'NOT_ASSIGNED' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which a group profile is updated. * **groupIdentifier** (*string*) -- **[REQUIRED]** The identifier of the group profile that is updated. * **status** (*string*) -- **[REQUIRED]** The status of the group profile that is updated. Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'groupName': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED' } **Response Structure** * *(dict) --* * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a group profile is updated. * **groupName** *(string) --* The name of the group profile that is updated. * **id** *(string) --* The identifier of the group profile that is updated. * **status** *(string) --* The status of the group profile that is updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_lineage_event get_lineage_event ***************** DataZone.Client.get_lineage_event(**kwargs) Describes the lineage event. See also: AWS API Documentation **Request Syntax** response = client.get_lineage_event( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain. * **identifier** (*string*) -- **[REQUIRED]** The ID of the lineage event. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'event': StreamingBody(), 'eventTime': datetime(2015, 1, 1), 'id': 'string', 'processingStatus': 'REQUESTED'|'PROCESSING'|'SUCCESS'|'FAILED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the lineage event was created. * **createdBy** *(string) --* The user who created the lineage event. * **domainId** *(string) --* The ID of the domain. * **event** ("StreamingBody") -- The lineage event details. * **eventTime** *(datetime) --* The time of the lineage event. * **id** *(string) --* The ID of the lineage event. * **processingStatus** *(string) --* The progressing status of the lineage event. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_subscription_request update_subscription_request *************************** DataZone.Client.update_subscription_request(**kwargs) Updates a specified subscription request in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_subscription_request( domainIdentifier='string', identifier='string', requestReason='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which a subscription request is to be updated. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the subscription request that is to be updated. * **requestReason** (*string*) -- **[REQUIRED]** The reason for the "UpdateSubscriptionRequest" action. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'decisionComment': 'string', 'domainId': 'string', 'existingSubscriptionId': 'string', 'id': 'string', 'metadataForms': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'requestReason': 'string', 'reviewerId': 'string', 'status': 'PENDING'|'ACCEPTED'|'REJECTED', 'subscribedListings': [ { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, ], 'subscribedPrincipals': [ { 'project': { 'id': 'string', 'name': 'string' } }, ], 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the subscription request was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription request. * **decisionComment** *(string) --* The decision comment of the "UpdateSubscriptionRequest" action. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a subscription request is to be updated. * **existingSubscriptionId** *(string) --* The ID of the existing subscription. * **id** *(string) --* The identifier of the subscription request that is to be updated. * **metadataForms** *(list) --* Metadata forms included in the subscription request. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **requestReason** *(string) --* The reason for the "UpdateSubscriptionRequest" action. * **reviewerId** *(string) --* The identifier of the Amazon DataZone user who reviews the subscription request. * **status** *(string) --* The status of the subscription request. * **subscribedListings** *(list) --* The subscribed listings of the subscription request. * *(dict) --* The details of the published asset for which the subscription grant is created. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipals** *(list) --* The subscribed principals of the subscription request. * *(dict) --* The principal that has the subscription grant for the asset. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **updatedAt** *(datetime) --* The timestamp of when the subscription request was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription request. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_environment delete_environment ****************** DataZone.Client.delete_environment(**kwargs) Deletes an environment in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_environment( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the environment is deleted. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the environment that is to be deleted. Returns: None **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_listing_change_set create_listing_change_set ************************* DataZone.Client.create_listing_change_set(**kwargs) Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog. See also: AWS API Documentation **Request Syntax** response = client.create_listing_change_set( action='PUBLISH'|'UNPUBLISH', clientToken='string', domainIdentifier='string', entityIdentifier='string', entityRevision='string', entityType='ASSET'|'DATA_PRODUCT' ) Parameters: * **action** (*string*) -- **[REQUIRED]** Specifies whether to publish or unpublish a listing. * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the asset. * **entityRevision** (*string*) -- The revision of an asset. * **entityType** (*string*) -- **[REQUIRED]** The type of an entity. Return type: dict Returns: **Response Syntax** { 'listingId': 'string', 'listingRevision': 'string', 'status': 'CREATING'|'ACTIVE'|'INACTIVE' } **Response Structure** * *(dict) --* * **listingId** *(string) --* The ID of the listing (a record of an asset at a given time). * **listingRevision** *(string) --* The revision of a listing. * **status** *(string) --* Specifies the status of the listing. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_environment_profile get_environment_profile *********************** DataZone.Client.get_environment_profile(**kwargs) Gets an evinronment profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_environment_profile( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this environment profile exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the environment profile. Return type: dict Returns: **Response Syntax** { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'keyName': 'string' }, ] } **Response Structure** * *(dict) --* * **awsAccountId** *(string) --* The ID of the Amazon Web Services account where this environment profile exists. * **awsAccountRegion** *(string) --* The Amazon Web Services region where this environment profile exists. * **createdAt** *(datetime) --* The timestamp of when this environment profile was created. * **createdBy** *(string) --* The Amazon DataZone user who created this environment profile. * **description** *(string) --* The description of the environment profile. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which this environment profile exists. * **environmentBlueprintId** *(string) --* The ID of the blueprint with which this environment profile is created. * **id** *(string) --* The ID of the environment profile. * **name** *(string) --* The name of the environment profile. * **projectId** *(string) --* The ID of the Amazon DataZone project in which this environment profile is created. * **updatedAt** *(datetime) --* The timestamp of when this environment profile was upated. * **userParameters** *(list) --* The user parameters of the environment profile. * *(dict) --* The details of user parameters of an environment blueprint. * **defaultValue** *(string) --* The default value of the parameter. * **description** *(string) --* The description of the parameter. * **fieldType** *(string) --* The filed type of the parameter. * **isEditable** *(boolean) --* Specifies whether the parameter is editable. * **isOptional** *(boolean) --* Specifies whether the custom parameter is optional. * **keyName** *(string) --* The key name of the parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / can_paginate can_paginate ************ DataZone.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. DataZone / Client / create_data_product_revision create_data_product_revision **************************** DataZone.Client.create_data_product_revision(**kwargs) Creates a data product revision. See also: AWS API Documentation **Request Syntax** response = client.create_data_product_revision( clientToken='string', description='string', domainIdentifier='string', formsInput=[ { 'content': 'string', 'formName': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], glossaryTerms=[ 'string', ], identifier='string', items=[ { 'glossaryTerms': [ 'string', ], 'identifier': 'string', 'itemType': 'ASSET', 'revision': 'string' }, ], name='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description of the data product revision. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where the data product revision is created. * **formsInput** (*list*) -- The metadata forms of the data product revision. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* **[REQUIRED]** The name of the metadata form. * **typeIdentifier** *(string) --* The ID of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** (*list*) -- The glossary terms of the data product revision. * *(string) --* * **identifier** (*string*) -- **[REQUIRED]** The ID of the data product revision. * **items** (*list*) -- The data assets of the data product revision. * *(dict) --* The data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **identifier** *(string) --* **[REQUIRED]** The ID of the data product. * **itemType** *(string) --* **[REQUIRED]** The type of the data product. * **revision** *(string) --* The revision of the data product. * **name** (*string*) -- **[REQUIRED]** The name of the data product revision. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'items': [ { 'glossaryTerms': [ 'string', ], 'identifier': 'string', 'itemType': 'ASSET', 'revision': 'string' }, ], 'name': 'string', 'owningProjectId': 'string', 'revision': 'string', 'status': 'CREATED'|'CREATING'|'CREATE_FAILED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp at which the data product revision is created. * **createdBy** *(string) --* The user who created the data product revision. * **description** *(string) --* The description of the data product revision. * **domainId** *(string) --* The ID of the domain where data product revision is created. * **firstRevisionCreatedAt** *(datetime) --* The timestamp at which the first revision of the data product is created. * **firstRevisionCreatedBy** *(string) --* The user who created the first revision of the data product. * **formsOutput** *(list) --* The metadata forms of the data product revision. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** *(list) --* The glossary terms of the data product revision. * *(string) --* * **id** *(string) --* The ID of the data product revision. * **items** *(list) --* The data assets of the data product revision. * *(dict) --* The data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **identifier** *(string) --* The ID of the data product. * **itemType** *(string) --* The type of the data product. * **revision** *(string) --* The revision of the data product. * **name** *(string) --* The name of the data product revision. * **owningProjectId** *(string) --* The ID of the owning project of the data product revision. * **revision** *(string) --* The revision of the data product revision. * **status** *(string) --* The status of the data product revision. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_asset_type get_asset_type ************** DataZone.Client.get_asset_type(**kwargs) Gets an Amazon DataZone asset type. See also: AWS API Documentation **Request Syntax** response = client.get_asset_type( domainIdentifier='string', identifier='string', revision='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the asset type exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the asset type. * **revision** (*string*) -- The revision of the asset type. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'formsOutput': { 'string': { 'required': True|False, 'typeName': 'string', 'typeRevision': 'string' } }, 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the asset type was created. * **createdBy** *(string) --* The Amazon DataZone user who created the asset type. * **description** *(string) --* The description of the asset type. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the asset type exists. * **formsOutput** *(dict) --* The metadata forms attached to the asset type. * *(string) --* * *(dict) --* The details of the form entry. * **required** *(boolean) --* Specifies whether a form entry is required. * **typeName** *(string) --* The name of the type of the form entry. * **typeRevision** *(string) --* The type revision of the form entry. * **name** *(string) --* The name of the asset type. * **originDomainId** *(string) --* The ID of the Amazon DataZone domain in which the asset type was originally created. * **originProjectId** *(string) --* The ID of the Amazon DataZone project in which the asset type was originally created. * **owningProjectId** *(string) --* The ID of the Amazon DataZone project that owns the asset type. * **revision** *(string) --* The revision of the asset type. * **updatedAt** *(datetime) --* The timestamp of when the asset type was updated. * **updatedBy** *(string) --* The Amazon DataZone user that updated the asset type. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_environment create_environment ****************** DataZone.Client.create_environment(**kwargs) Create an Amazon DataZone environment. See also: AWS API Documentation **Request Syntax** response = client.create_environment( deploymentOrder=123, description='string', domainIdentifier='string', environmentAccountIdentifier='string', environmentAccountRegion='string', environmentBlueprintIdentifier='string', environmentConfigurationId='string', environmentProfileIdentifier='string', glossaryTerms=[ 'string', ], name='string', projectIdentifier='string', userParameters=[ { 'name': 'string', 'value': 'string' }, ] ) Parameters: * **deploymentOrder** (*integer*) -- The deployment order of the environment. * **description** (*string*) -- The description of the Amazon DataZone environment. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which the environment is created. * **environmentAccountIdentifier** (*string*) -- The ID of the account in which the environment is being created. * **environmentAccountRegion** (*string*) -- The region of the account in which the environment is being created. * **environmentBlueprintIdentifier** (*string*) -- The ID of the blueprint with which the environment is being created. * **environmentConfigurationId** (*string*) -- The configuration ID of the environment. * **environmentProfileIdentifier** (*string*) -- The identifier of the environment profile that is used to create this Amazon DataZone environment. * **glossaryTerms** (*list*) -- The glossary terms that can be used in this Amazon DataZone environment. * *(string) --* * **name** (*string*) -- **[REQUIRED]** The name of the Amazon DataZone environment. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone project in which this environment is created. * **userParameters** (*list*) -- The user parameters of this Amazon DataZone environment. * *(dict) --* The parameter details of an evironment profile. * **name** *(string) --* The name of an environment profile parameter. * **value** *(string) --* The value of an environment profile parameter. Return type: dict Returns: **Response Syntax** { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'deploymentProperties': { 'endTimeoutMinutes': 123, 'startTimeoutMinutes': 123 }, 'description': 'string', 'domainId': 'string', 'environmentActions': [ { 'auth': 'IAM'|'HTTPS', 'parameters': [ { 'key': 'string', 'value': 'string' }, ], 'type': 'string' }, ], 'environmentBlueprintId': 'string', 'environmentConfigurationId': 'string', 'environmentProfileId': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'lastDeployment': { 'deploymentId': 'string', 'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT', 'deploymentType': 'CREATE'|'UPDATE'|'DELETE', 'failureReason': { 'code': 'string', 'message': 'string' }, 'isDeploymentComplete': True|False, 'messages': [ 'string', ] }, 'name': 'string', 'projectId': 'string', 'provider': 'string', 'provisionedResources': [ { 'name': 'string', 'provider': 'string', 'type': 'string', 'value': 'string' }, ], 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'keyName': 'string' }, ] } **Response Structure** * *(dict) --* * **awsAccountId** *(string) --* The Amazon Web Services account in which the Amazon DataZone environment is created. * **awsAccountRegion** *(string) --* The Amazon Web Services region in which the Amazon DataZone environment is created. * **createdAt** *(datetime) --* The timestamp of when the environment was created. * **createdBy** *(string) --* The Amazon DataZone user who created this environment. * **deploymentProperties** *(dict) --* The deployment properties of this Amazon DataZone environment. * **endTimeoutMinutes** *(integer) --* The end timeout of the environment blueprint deployment. * **startTimeoutMinutes** *(integer) --* The start timeout of the environment blueprint deployment. * **description** *(string) --* The description of this Amazon DataZone environment. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the environment is created. * **environmentActions** *(list) --* The configurable actions of this Amazon DataZone environment. * *(dict) --* The configurable action of a Amazon DataZone environment. * **auth** *(string) --* The authentication type of a configurable action of a Amazon DataZone environment. * **parameters** *(list) --* The parameters of a configurable action in a Amazon DataZone environment. * *(dict) --* The details of the parameters for the configurable environment action. * **key** *(string) --* The key of the configurable action parameter. * **value** *(string) --* The value of the configurable action parameter. * **type** *(string) --* The type of a configurable action in a Amazon DataZone environment. * **environmentBlueprintId** *(string) --* The ID of the blueprint with which this Amazon DataZone environment was created. * **environmentConfigurationId** *(string) --* The configuration ID of the environment. * **environmentProfileId** *(string) --* The ID of the environment profile with which this Amazon DataZone environment was created. * **glossaryTerms** *(list) --* The glossary terms that can be used in this Amazon DataZone environment. * *(string) --* * **id** *(string) --* The ID of this Amazon DataZone environment. * **lastDeployment** *(dict) --* The details of the last deployment of this Amazon DataZone environment. * **deploymentId** *(string) --* The identifier of the last deployment of the environment. * **deploymentStatus** *(string) --* The status of the last deployment of the environment. * **deploymentType** *(string) --* The type of the last deployment of the environment. * **failureReason** *(dict) --* The failure reason of the last deployment of the environment. * **code** *(string) --* The error code for the failure reason for the environment deployment. * **message** *(string) --* The error message for the failure reason for the environment deployment. * **isDeploymentComplete** *(boolean) --* Specifies whether the last deployment of the environment is complete. * **messages** *(list) --* The messages of the last deployment of the environment. * *(string) --* * **name** *(string) --* The name of this environment. * **projectId** *(string) --* The ID of the Amazon DataZone project in which this environment is created. * **provider** *(string) --* The provider of this Amazon DataZone environment. * **provisionedResources** *(list) --* The provisioned resources of this Amazon DataZone environment. * *(dict) --* The details of a provisioned resource of this Amazon DataZone environment. * **name** *(string) --* The name of a provisioned resource of this Amazon DataZone environment. * **provider** *(string) --* The provider of a provisioned resource of this Amazon DataZone environment. * **type** *(string) --* The type of a provisioned resource of this Amazon DataZone environment. * **value** *(string) --* The value of a provisioned resource of this Amazon DataZone environment. * **provisioningProperties** *(dict) --* The provisioning properties of this Amazon DataZone environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "cloudFormation". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **cloudFormation** *(dict) --* The cloud formation properties included as part of the provisioning properties of an environment blueprint. * **templateUrl** *(string) --* The template URL of the cloud formation provisioning properties of the environment blueprint. * **status** *(string) --* The status of this Amazon DataZone environment. * **updatedAt** *(datetime) --* The timestamp of when this environment was updated. * **userParameters** *(list) --* The user parameters of this Amazon DataZone environment. * *(dict) --* The details of user parameters of an environment blueprint. * **defaultValue** *(string) --* The default value of the parameter. * **description** *(string) --* The description of the parameter. * **fieldType** *(string) --* The filed type of the parameter. * **isEditable** *(boolean) --* Specifies whether the parameter is editable. * **isOptional** *(boolean) --* Specifies whether the custom parameter is optional. * **keyName** *(string) --* The key name of the parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_time_series_data_point get_time_series_data_point ************************** DataZone.Client.get_time_series_data_point(**kwargs) Gets the existing data point for the asset. See also: AWS API Documentation **Request Syntax** response = client.get_time_series_data_point( domainIdentifier='string', entityIdentifier='string', entityType='ASSET'|'LISTING', formName='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the asset for which you want to get the data point. * **entityType** (*string*) -- **[REQUIRED]** The type of the asset for which you want to get the data point. * **formName** (*string*) -- **[REQUIRED]** The name of the time series form that houses the data point that you want to get. * **identifier** (*string*) -- **[REQUIRED]** The ID of the data point that you want to get. Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'entityId': 'string', 'entityType': 'ASSET'|'LISTING', 'form': { 'content': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, 'formName': 'string' } **Response Structure** * *(dict) --* * **domainId** *(string) --* The ID of the Amazon DataZone domain that houses the asset data point that you want to get. * **entityId** *(string) --* The ID of the asset for which you want to get the data point. * **entityType** *(string) --* The type of the asset for which you want to get the data point. * **form** *(dict) --* The time series form that houses the data point that you want to get. * **content** *(string) --* The content of the time series data points form. * **formName** *(string) --* The name of the time series data points form. * **id** *(string) --* The ID of the time series data points form. * **timestamp** *(datetime) --* The timestamp of the time series data points form. * **typeIdentifier** *(string) --* The ID of the type of the time series data points form. * **typeRevision** *(string) --* The revision type of the time series data points form. * **formName** *(string) --* The name of the time series form that houses the data point that you want to get. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / disassociate_environment_role disassociate_environment_role ***************************** DataZone.Client.disassociate_environment_role(**kwargs) Disassociates the environment role in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.disassociate_environment_role( domainIdentifier='string', environmentIdentifier='string', environmentRoleArn='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which an environment role is disassociated. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the environment. * **environmentRoleArn** (*string*) -- **[REQUIRED]** The ARN of the environment role. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_rule delete_rule *********** DataZone.Client.delete_rule(**kwargs) Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards. See also: AWS API Documentation **Request Syntax** response = client.delete_rule( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain that where the rule is to be deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the rule that is to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_subscription_grant get_subscription_grant ********************** DataZone.Client.get_subscription_grant(**kwargs) Gets the subscription grant in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_subscription_grant( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the subscription grant exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the subscription grant. Return type: dict Returns: **Response Syntax** { 'assets': [ { 'assetId': 'string', 'assetRevision': 'string', 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'failureCause': { 'message': 'string' }, 'failureTimestamp': datetime(2015, 1, 1), 'grantedTimestamp': datetime(2015, 1, 1), 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED', 'targetName': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'grantedEntity': { 'listing': { 'id': 'string', 'revision': 'string' } }, 'id': 'string', 'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE', 'subscriptionId': 'string', 'subscriptionTargetId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **assets** *(list) --* The assets for which the subscription grant is created. * *(dict) --* The details of the asset for which the subscription grant is created. * **assetId** *(string) --* The identifier of the asset for which the subscription grant is created. * **assetRevision** *(string) --* The revision of the asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **failureCause** *(dict) --* The failure cause included in the details of the asset for which the subscription grant is created. * **message** *(string) --* The description of the error message. * **failureTimestamp** *(datetime) --* The failure timestamp included in the details of the asset for which the subscription grant is created. * **grantedTimestamp** *(datetime) --* The timestamp of when the subscription grant to the asset is created. * **status** *(string) --* The status of the asset for which the subscription grant is created. * **targetName** *(string) --* The target name of the asset for which the subscription grant is created. * **createdAt** *(datetime) --* The timestamp of when the subscription grant is created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription grant. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the subscription grant exists. * **grantedEntity** *(dict) --* The entity to which the subscription is granted. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "listing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **listing** *(dict) --* The listing for which a subscription is granted. * **id** *(string) --* An identifier of a revision of an asset published in a Amazon DataZone catalog. * **revision** *(string) --* The details of a revision of an asset published in a Amazon DataZone catalog. * **id** *(string) --* The ID of the subscription grant. * **status** *(string) --* The status of the subscription grant. * **subscriptionId** *(string) --* The identifier of the subscription. * **subscriptionTargetId** *(string) --* The subscription target ID associated with the subscription grant. * **updatedAt** *(datetime) --* The timestamp of when the subscription grant was upated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription grant. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_subscriptions list_subscriptions ****************** DataZone.Client.list_subscriptions(**kwargs) Lists subscriptions in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.list_subscriptions( approverProjectId='string', domainIdentifier='string', maxResults=123, nextToken='string', owningProjectId='string', sortBy='CREATED_AT'|'UPDATED_AT', sortOrder='ASCENDING'|'DESCENDING', status='APPROVED'|'REVOKED'|'CANCELLED', subscribedListingId='string', subscriptionRequestIdentifier='string' ) Parameters: * **approverProjectId** (*string*) -- The identifier of the project for the subscription's approver. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **maxResults** (*integer*) -- The maximum number of subscriptions to return in a single call to "ListSubscriptions". When the number of subscriptions to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListSubscriptions" to list the next set of Subscriptions. * **nextToken** (*string*) -- When the number of subscriptions is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of subscriptions, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListSubscriptions" to list the next set of subscriptions. * **owningProjectId** (*string*) -- The identifier of the owning project. * **sortBy** (*string*) -- Specifies the way in which the results of this action are to be sorted. * **sortOrder** (*string*) -- Specifies the sort order for the results of this action. * **status** (*string*) -- The status of the subscriptions that you want to list. Note: This is not a required parameter, but if not provided, by default, Amazon DataZone returns only "APPROVED" subscriptions. * **subscribedListingId** (*string*) -- The identifier of the subscribed listing for the subscriptions that you want to list. * **subscriptionRequestIdentifier** (*string*) -- The identifier of the subscription request for the subscriptions that you want to list. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'retainPermissions': True|False, 'status': 'APPROVED'|'REVOKED'|'CANCELLED', 'subscribedListing': { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, 'subscribedPrincipal': { 'project': { 'id': 'string', 'name': 'string' } }, 'subscriptionRequestId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListSubscriptions" action. * *(dict) --* The details of the subscription. * **createdAt** *(datetime) --* The timestamp of when the subscription was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a subscription exists. * **id** *(string) --* The identifier of the subscription. * **retainPermissions** *(boolean) --* The retain permissions included in the subscription. * **status** *(string) --* The status of the subscription. * **subscribedListing** *(dict) --* The listing included in the subscription. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipal** *(dict) --* The principal included in the subscription. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **subscriptionRequestId** *(string) --* The identifier of the subscription request for the subscription. * **updatedAt** *(datetime) --* The timestamp of when the subscription was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription. * **nextToken** *(string) --* When the number of subscriptions is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of subscriptions, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListSubscriptions" to list the next set of subscriptions. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_subscription_request delete_subscription_request *************************** DataZone.Client.delete_subscription_request(**kwargs) Deletes a subscription request in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_subscription_request( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the subscription request is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the subscription request that is deleted. Returns: None **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_glossary_term delete_glossary_term ******************** DataZone.Client.delete_glossary_term(**kwargs) Deletes a business glossary term in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_glossary_term( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the business glossary term is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the business glossary term that is deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_environment_action create_environment_action ************************* DataZone.Client.create_environment_action(**kwargs) Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment. See also: AWS API Documentation **Request Syntax** response = client.create_environment_action( description='string', domainIdentifier='string', environmentIdentifier='string', name='string', parameters={ 'awsConsoleLink': { 'uri': 'string' } } ) Parameters: * **description** (*string*) -- The description of the environment action that is being created in the environment. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the environment action is created. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the environment in which the environment action is created. * **name** (*string*) -- **[REQUIRED]** The name of the environment action. * **parameters** (*dict*) -- **[REQUIRED]** The parameters of the environment action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "awsConsoleLink". * **awsConsoleLink** *(dict) --* The console link specified as part of the environment action. * **uri** *(string) --* The URI of the console link specified as part of the environment action. Return type: dict Returns: **Response Syntax** { 'description': 'string', 'domainId': 'string', 'environmentId': 'string', 'id': 'string', 'name': 'string', 'parameters': { 'awsConsoleLink': { 'uri': 'string' } } } **Response Structure** * *(dict) --* * **description** *(string) --* The description of the environment action. * **domainId** *(string) --* The ID of the domain in which the environment action is created. * **environmentId** *(string) --* The ID of the environment in which the environment is created. * **id** *(string) --* The ID of the environment action. * **name** *(string) --* The name of the environment action. * **parameters** *(dict) --* The parameters of the environment action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "awsConsoleLink". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **awsConsoleLink** *(dict) --* The console link specified as part of the environment action. * **uri** *(string) --* The URI of the console link specified as part of the environment action. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_domain_unit update_domain_unit ****************** DataZone.Client.update_domain_unit(**kwargs) Updates the domain unit. See also: AWS API Documentation **Request Syntax** response = client.update_domain_unit( description='string', domainIdentifier='string', identifier='string', name='string' ) Parameters: * **description** (*string*) -- The description of the domain unit that you want to update. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to update a domain unit. * **identifier** (*string*) -- **[REQUIRED]** The ID of the domain unit that you want to update. * **name** (*string*) -- The name of the domain unit that you want to update. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lastUpdatedBy': 'string', 'name': 'string', 'owners': [ { 'group': { 'groupId': 'string' }, 'user': { 'userId': 'string' } }, ], 'parentDomainUnitId': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The time stamp at which the domain unit that you want to update was created. * **createdBy** *(string) --* The user who created the domain unit that you want to update. * **description** *(string) --* The description of the domain unit that you want to update. * **domainId** *(string) --* The ID of the domain where you want to update the domain unit. * **id** *(string) --* The ID of the domain unit that you want to update. * **lastUpdatedAt** *(datetime) --* The timestamp at which the domain unit was last updated. * **lastUpdatedBy** *(string) --* The user who last updated the domain unit. * **name** *(string) --* The name of the domain unit that you want to update. * **owners** *(list) --* The owners of the domain unit that you want to update. * *(dict) --* The properties of the domain unit owner. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "group", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **group** *(dict) --* Indicates that the domain unit owner is a group. * **groupId** *(string) --* The ID of the domain unit group. * **user** *(dict) --* Indicates that the domain unit owner is a user. * **userId** *(string) --* The ID of teh domain unit user. * **parentDomainUnitId** *(string) --* The ID of the parent domain unit. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_time_series_data_points list_time_series_data_points **************************** DataZone.Client.list_time_series_data_points(**kwargs) Lists time series data points. See also: AWS API Documentation **Request Syntax** response = client.list_time_series_data_points( domainIdentifier='string', endedAt=datetime(2015, 1, 1), entityIdentifier='string', entityType='ASSET'|'LISTING', formName='string', maxResults=123, nextToken='string', startedAt=datetime(2015, 1, 1) ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points. * **endedAt** (*datetime*) -- The timestamp at which the data points that you wanted to list ended. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the asset for which you want to list data points. * **entityType** (*string*) -- **[REQUIRED]** The type of the asset for which you want to list data points. * **formName** (*string*) -- **[REQUIRED]** The name of the time series data points form. * **maxResults** (*integer*) -- The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points. * **nextToken** (*string*) -- When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points. * **startedAt** (*datetime*) -- The timestamp at which the data points that you want to list started. Return type: dict Returns: **Response Syntax** { 'items': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListTimeSeriesDataPoints action. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **nextToken** *(string) --* When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / accept_subscription_request accept_subscription_request *************************** DataZone.Client.accept_subscription_request(**kwargs) Accepts a subscription request to a specific asset. See also: AWS API Documentation **Request Syntax** response = client.accept_subscription_request( assetScopes=[ { 'assetId': 'string', 'filterIds': [ 'string', ] }, ], decisionComment='string', domainIdentifier='string', identifier='string' ) Parameters: * **assetScopes** (*list*) -- The asset scopes of the accept subscription request. * *(dict) --* The accepted asset scope. * **assetId** *(string) --* **[REQUIRED]** The asset ID of the accepted asset scope. * **filterIds** *(list) --* **[REQUIRED]** The filter IDs of the accepted asset scope. * *(string) --* * **decisionComment** (*string*) -- A description that specifies the reason for accepting the specified subscription request. * **domainIdentifier** (*string*) -- **[REQUIRED]** The Amazon DataZone domain where the specified subscription request is being accepted. * **identifier** (*string*) -- **[REQUIRED]** The unique identifier of the subscription request that is to be accepted. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'decisionComment': 'string', 'domainId': 'string', 'existingSubscriptionId': 'string', 'id': 'string', 'metadataForms': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'requestReason': 'string', 'reviewerId': 'string', 'status': 'PENDING'|'ACCEPTED'|'REJECTED', 'subscribedListings': [ { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, ], 'subscribedPrincipals': [ { 'project': { 'id': 'string', 'name': 'string' } }, ], 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp that specifies when the subscription request was accepted. * **createdBy** *(string) --* Specifies the Amazon DataZone user that accepted the specified subscription request. * **decisionComment** *(string) --* Specifies the reason for accepting the subscription request. * **domainId** *(string) --* The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted. * **existingSubscriptionId** *(string) --* The ID of the existing subscription. * **id** *(string) --* The identifier of the subscription request. * **metadataForms** *(list) --* The metadata form in the subscription request. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **requestReason** *(string) --* Specifies the reason for requesting a subscription to the asset. * **reviewerId** *(string) --* Specifes the ID of the Amazon DataZone user who reviewed the subscription request. * **status** *(string) --* Specifies the status of the subscription request. * **subscribedListings** *(list) --* Specifies the asset for which the subscription request was created. * *(dict) --* The details of the published asset for which the subscription grant is created. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipals** *(list) --* Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request. * *(dict) --* The principal that has the subscription grant for the asset. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **updatedAt** *(datetime) --* Specifies the timestamp when subscription request was updated. * **updatedBy** *(string) --* Specifies the Amazon DataZone user who updated the subscription request. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / search search ****** DataZone.Client.search(**kwargs) Searches for assets in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.search( additionalAttributes=[ 'FORMS'|'TIME_SERIES_DATA_POINT_FORMS'|'TEXT_MATCH_RATIONALE', ], domainIdentifier='string', filters={ 'and': [ {'... recursive ...'}, ], 'filter': { 'attribute': 'string', 'value': 'string' }, 'or': [ {'... recursive ...'}, ] }, maxResults=123, nextToken='string', owningProjectIdentifier='string', searchIn=[ { 'attribute': 'string' }, ], searchScope='ASSET'|'GLOSSARY'|'GLOSSARY_TERM'|'DATA_PRODUCT', searchText='string', sort={ 'attribute': 'string', 'order': 'ASCENDING'|'DESCENDING' } ) Parameters: * **additionalAttributes** (*list*) -- Specifies additional attributes for the "Search" action. * *(string) --* * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **filters** (*dict*) -- Specifies the search filters. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **and** *(list) --* The 'and' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **filter** *(dict) --* A search filter in Amazon DataZone. * **attribute** *(string) --* **[REQUIRED]** A search filter attribute in Amazon DataZone. * **value** *(string) --* **[REQUIRED]** A search filter value in Amazon DataZone. * **or** *(list) --* The 'or' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **maxResults** (*integer*) -- The maximum number of results to return in a single call to "Search". When the number of results to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "Search" to list the next set of results. * **nextToken** (*string*) -- When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "Search" to list the next set of results. * **owningProjectIdentifier** (*string*) -- The identifier of the owning project specified for the search. * **searchIn** (*list*) -- The details of the search. * *(dict) --* The details of the search. * **attribute** *(string) --* **[REQUIRED]** The search attribute. * **searchScope** (*string*) -- **[REQUIRED]** The scope of the search. * **searchText** (*string*) -- Specifies the text for which to search. * **sort** (*dict*) -- Specifies the way in which the search results are to be sorted. * **attribute** *(string) --* **[REQUIRED]** The attribute detail of the way to sort search results. * **order** *(string) --* The order detail of the wya to sort search results. Return type: dict Returns: **Response Syntax** { 'items': [ { 'assetItem': { 'additionalAttributes': { 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'latestTimeSeriesDataPointFormsOutput': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ], 'readOnlyFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'externalIdentifier': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'glossaryTerms': [ 'string', ], 'identifier': 'string', 'name': 'string', 'owningProjectId': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, 'dataProductItem': { 'additionalAttributes': { 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'name': 'string', 'owningProjectId': 'string' }, 'glossaryItem': { 'additionalAttributes': { 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'id': 'string', 'name': 'string', 'owningProjectId': 'string', 'status': 'DISABLED'|'ENABLED', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, 'glossaryTermItem': { 'additionalAttributes': { 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'glossaryId': 'string', 'id': 'string', 'longDescription': 'string', 'name': 'string', 'shortDescription': 'string', 'status': 'ENABLED'|'DISABLED', 'termRelations': { 'classifies': [ 'string', ], 'isA': [ 'string', ] }, 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } }, ], 'nextToken': 'string', 'totalMatchCount': 123 } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "Search" action. * *(dict) --* The details of the search results. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetItem", "dataProductItem", "glossaryItem", "glossaryTermItem". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetItem** *(dict) --* The asset item included in the search results. * **additionalAttributes** *(dict) --* The additional attributes of a Amazon DataZone inventory asset. * **formsOutput** *(list) --* The forms included in the additional attributes of an inventory asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **latestTimeSeriesDataPointFormsOutput** *(list) --* The latest time series data points forms included in the additional attributes of an asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **readOnlyFormsOutput** *(list) --* The read-only forms included in the additional attributes of an inventory asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **createdAt** *(datetime) --* The timestamp of when the Amazon DataZone inventory asset was created. * **createdBy** *(string) --* The Amazon DataZone user who created the inventory asset. * **description** *(string) --* The description of an Amazon DataZone inventory asset. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the inventory asset exists. * **externalIdentifier** *(string) --* The external identifier of the Amazon DataZone inventory asset. * **firstRevisionCreatedAt** *(datetime) --* The timestamp of when the first revision of the inventory asset was created. * **firstRevisionCreatedBy** *(string) --* The Amazon DataZone user who created the first revision of the inventory asset. * **glossaryTerms** *(list) --* The glossary terms attached to the Amazon DataZone inventory asset. * *(string) --* * **identifier** *(string) --* the identifier of the Amazon DataZone inventory asset. * **name** *(string) --* The name of the Amazon DataZone inventory asset. * **owningProjectId** *(string) --* The identifier of the Amazon DataZone project that owns the inventory asset. * **typeIdentifier** *(string) --* The identifier of the asset type of the specified Amazon DataZone inventory asset. * **typeRevision** *(string) --* The revision of the inventory asset type. * **dataProductItem** *(dict) --* The data product. * **additionalAttributes** *(dict) --* The additional attributes of an Amazon DataZone data product. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp at which the data product was created. * **createdBy** *(string) --* The user who created the data product. * **description** *(string) --* The description of the data product. * **domainId** *(string) --* The ID of the domain where the data product lives. * **firstRevisionCreatedAt** *(datetime) --* The timestamp at which first revision of the data product was created. * **firstRevisionCreatedBy** *(string) --* The user who created the first revision of the data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(string) --* * **id** *(string) --* The ID of the data product. * **name** *(string) --* The name of the data product. * **owningProjectId** *(string) --* The ID of the owning project of the data product. * **glossaryItem** *(dict) --* The glossary item included in the search results. * **additionalAttributes** *(dict) --* The additional attributes of an Amazon DataZone glossary. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp of when the glossary was created. * **createdBy** *(string) --* The Amazon DataZone user who created the glossary. * **description** *(string) --* The business glossary description. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the business glossary exists. * **id** *(string) --* The identifier of the glossary. * **name** *(string) --* The name of the glossary. * **owningProjectId** *(string) --* The identifier of the project that owns the business glosary. * **status** *(string) --* The business glossary status. * **updatedAt** *(datetime) --* The timestamp of when the business glossary was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the business glossary. * **glossaryTermItem** *(dict) --* The glossary term item included in the search results. * **additionalAttributes** *(dict) --* The additional attributes of an Amazon DataZone glossary term. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp of when a business glossary term was created. * **createdBy** *(string) --* The Amazon DataZone user who created the business glossary. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the business glossary exists. * **glossaryId** *(string) --* The identifier of the business glossary to which the term belongs. * **id** *(string) --* The identifier of the business glossary term. * **longDescription** *(string) --* The long description of the business glossary term. * **name** *(string) --* The name of the business glossary term. * **shortDescription** *(string) --* The short description of the business glossary term. * **status** *(string) --* The status of the business glossary term. * **termRelations** *(dict) --* The relations of the business glossary term. * **classifies** *(list) --* The classifies of the term relations. * *(string) --* * **isA** *(list) --* The "isA" property of the term relations. * *(string) --* * **updatedAt** *(datetime) --* The timestamp of when a business glossary term was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the business glossary term. * **nextToken** *(string) --* When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "Search" to list the next set of results. * **totalMatchCount** *(integer) --* Total number of search results. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_environments list_environments ***************** DataZone.Client.list_environments(**kwargs) Lists Amazon DataZone environments. See also: AWS API Documentation **Request Syntax** response = client.list_environments( awsAccountId='string', awsAccountRegion='string', domainIdentifier='string', environmentBlueprintIdentifier='string', environmentProfileIdentifier='string', maxResults=123, name='string', nextToken='string', projectIdentifier='string', provider='string', status='ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE' ) Parameters: * **awsAccountId** (*string*) -- The identifier of the Amazon Web Services account where you want to list environments. * **awsAccountRegion** (*string*) -- The Amazon Web Services region where you want to list environments. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **environmentBlueprintIdentifier** (*string*) -- The identifier of the Amazon DataZone blueprint. * **environmentProfileIdentifier** (*string*) -- The identifier of the environment profile. * **maxResults** (*integer*) -- The maximum number of environments to return in a single call to "ListEnvironments". When the number of environments to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListEnvironments" to list the next set of environments. * **name** (*string*) -- The name of the environment. * **nextToken** (*string*) -- When the number of environments is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of environments, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEnvironments" to list the next set of environments. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone project. * **provider** (*string*) -- The provider of the environment. * **status** (*string*) -- The status of the environments that you want to list. Return type: dict Returns: **Response Syntax** { 'items': [ { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentConfigurationId': 'string', 'environmentProfileId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'provider': 'string', 'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListEnvironments" action. * *(dict) --* The details of an environment. * **awsAccountId** *(string) --* The identifier of the Amazon Web Services account in which an environment exists. * **awsAccountRegion** *(string) --* The Amazon Web Services Region in which an environment exists. * **createdAt** *(datetime) --* The timestamp of when the environment was created. * **createdBy** *(string) --* The Amazon DataZone user who created the environment. * **description** *(string) --* The description of the environment. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the environment exists. * **environmentConfigurationId** *(string) --* The configuration ID with which the environment is created. * **environmentProfileId** *(string) --* The identifier of the environment profile with which the environment was created. * **id** *(string) --* The identifier of the environment. * **name** *(string) --* The name of the environment. * **projectId** *(string) --* The identifier of the project in which the environment exists. * **provider** *(string) --* The provider of the environment. * **status** *(string) --* The status of the environment. * **updatedAt** *(datetime) --* The timestamp of when the environment was updated. * **nextToken** *(string) --* When the number of environments is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of environments, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEnvironments" to list the next set of environments. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_connection create_connection ***************** DataZone.Client.create_connection(**kwargs) Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. See also: AWS API Documentation **Request Syntax** response = client.create_connection( awsLocation={ 'accessRole': 'string', 'awsAccountId': 'string', 'awsRegion': 'string', 'iamConnectionId': 'string' }, clientToken='string', description='string', domainIdentifier='string', environmentIdentifier='string', name='string', props={ 'athenaProperties': { 'workgroupName': 'string' }, 'glueProperties': { 'glueConnectionInput': { 'athenaProperties': { 'string': 'string' }, 'authenticationConfiguration': { 'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM', 'basicAuthenticationCredentials': { 'password': 'string', 'userName': 'string' }, 'customAuthenticationCredentials': { 'string': 'string' }, 'kmsKeyArn': 'string', 'oAuth2Properties': { 'authorizationCodeProperties': { 'authorizationCode': 'string', 'redirectUri': 'string' }, 'oAuth2ClientApplication': { 'aWSManagedClientApplicationReference': 'string', 'userManagedClientApplicationClientId': 'string' }, 'oAuth2Credentials': { 'accessToken': 'string', 'jwtToken': 'string', 'refreshToken': 'string', 'userManagedClientApplicationClientSecret': 'string' }, 'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER', 'tokenUrl': 'string', 'tokenUrlParametersMap': { 'string': 'string' } }, 'secretArn': 'string' }, 'connectionProperties': { 'string': 'string' }, 'connectionType': 'SNOWFLAKE'|'BIGQUERY'|'DOCUMENTDB'|'DYNAMODB'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'SAPHANA'|'SQLSERVER'|'TERADATA'|'VERTICA', 'description': 'string', 'matchCriteria': 'string', 'name': 'string', 'physicalConnectionRequirements': { 'availabilityZone': 'string', 'securityGroupIdList': [ 'string', ], 'subnetId': 'string', 'subnetIdList': [ 'string', ] }, 'pythonProperties': { 'string': 'string' }, 'sparkProperties': { 'string': 'string' }, 'validateCredentials': True|False, 'validateForComputeEnvironments': [ 'SPARK'|'ATHENA'|'PYTHON', ] } }, 'hyperPodProperties': { 'clusterName': 'string' }, 'iamProperties': { 'glueLineageSyncEnabled': True|False }, 'redshiftProperties': { 'credentials': { 'secretArn': 'string', 'usernamePassword': { 'password': 'string', 'username': 'string' } }, 'databaseName': 'string', 'host': 'string', 'lineageSync': { 'enabled': True|False, 'schedule': { 'schedule': 'string' } }, 'port': 123, 'storage': { 'clusterName': 'string', 'workgroupName': 'string' } }, 's3Properties': { 's3AccessGrantLocationId': 'string', 's3Uri': 'string' }, 'sparkEmrProperties': { 'computeArn': 'string', 'instanceProfileArn': 'string', 'javaVirtualEnv': 'string', 'logUri': 'string', 'pythonVirtualEnv': 'string', 'runtimeRole': 'string', 'trustedCertificatesS3Uri': 'string' }, 'sparkGlueProperties': { 'additionalArgs': { 'connection': 'string' }, 'glueConnectionName': 'string', 'glueVersion': 'string', 'idleTimeout': 123, 'javaVirtualEnv': 'string', 'numberOfWorkers': 123, 'pythonVirtualEnv': 'string', 'workerType': 'string' } } ) Parameters: * **awsLocation** (*dict*) -- The location where the connection is created. * **accessRole** *(string) --* The access role of a connection. * **awsAccountId** *(string) --* The account ID of a connection. * **awsRegion** *(string) --* The Region of a connection. * **iamConnectionId** *(string) --* The IAM connection ID of a connection. * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- A connection description. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where the connection is created. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the environment where the connection is created. * **name** (*string*) -- **[REQUIRED]** The connection name. * **props** (*dict*) -- The connection props. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "athenaProperties", "glueProperties", "hyperPodProperties", "iamProperties", "redshiftProperties", "s3Properties", "sparkEmrProperties", "sparkGlueProperties". * **athenaProperties** *(dict) --* The Amazon Athena properties of a connection. * **workgroupName** *(string) --* The Amazon Athena workgroup name of a connection. * **glueProperties** *(dict) --* The Amazon Web Services Glue properties of a connection. * **glueConnectionInput** *(dict) --* The Amazon Web Services Glue connection. * **athenaProperties** *(dict) --* The Amazon Athena properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **authenticationConfiguration** *(dict) --* The authentication configuration of the Amazon Web Services Glue connection. * **authenticationType** *(string) --* The authentication type of a connection. * **basicAuthenticationCredentials** *(dict) --* The basic authentication credentials of a connection. * **password** *(string) --* The password for a connection. * **userName** *(string) --* The user name for the connecion. * **customAuthenticationCredentials** *(dict) --* The custom authentication credentials of a connection. * *(string) --* * *(string) --* * **kmsKeyArn** *(string) --* The KMS key ARN of a connection. * **oAuth2Properties** *(dict) --* The oAuth2 properties of a connection. * **authorizationCodeProperties** *(dict) --* The authorization code properties of the OAuth2 properties. * **authorizationCode** *(string) --* The authorization code of a connection. * **redirectUri** *(string) --* The redirect URI of a connection. * **oAuth2ClientApplication** *(dict) --* The OAuth2 client application of the OAuth2 properties. * **aWSManagedClientApplicationReference** *(string) --* The Amazon Web Services managed client application reference in the OAuth2Client application. * **userManagedClientApplicationClientId** *(string) --* The user managed client application client ID in the OAuth2Client application. * **oAuth2Credentials** *(dict) --* The OAuth2 credentials of the OAuth2 properties. * **accessToken** *(string) --* The access token of a connection. * **jwtToken** *(string) --* The jwt token of the connection. * **refreshToken** *(string) --* The refresh token of the connection. * **userManagedClientApplicationClientSecret** *(string) --* The user managed client application client secret of the connection. * **oAuth2GrantType** *(string) --* The OAuth2 grant type of the OAuth2 properties. * **tokenUrl** *(string) --* The OAuth2 token URL of the OAuth2 properties. * **tokenUrlParametersMap** *(dict) --* The OAuth2 token URL parameter map of the OAuth2 properties. * *(string) --* * *(string) --* * **secretArn** *(string) --* The secret ARN of a connection. * **connectionProperties** *(dict) --* The connection properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **connectionType** *(string) --* The connection type of the Amazon Web Services Glue connection. * **description** *(string) --* The description of the Amazon Web Services Glue connection. * **matchCriteria** *(string) --* The match criteria of the Amazon Web Services Glue connection. * **name** *(string) --* The name of the Amazon Web Services Glue connection. * **physicalConnectionRequirements** *(dict) --* The physical connection requirements for the Amazon Web Services Glue connection. * **availabilityZone** *(string) --* The availability zone of the physical connection requirements of a connection. * **securityGroupIdList** *(list) --* The group ID list of the physical connection requirements of a connection. * *(string) --* * **subnetId** *(string) --* The subnet ID of the physical connection requirements of a connection. * **subnetIdList** *(list) --* The subnet ID list of the physical connection requirements of a connection. * *(string) --* * **pythonProperties** *(dict) --* The Python properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **sparkProperties** *(dict) --* The Spark properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **validateCredentials** *(boolean) --* Speciefies whether to validate credentials of the Amazon Web Services Glue connection. * **validateForComputeEnvironments** *(list) --* Speciefies whether to validate for compute environments of the Amazon Web Services Glue connection. * *(string) --* * **hyperPodProperties** *(dict) --* The hyper pod properties of a connection. * **clusterName** *(string) --* **[REQUIRED]** The cluster name the hyper pod properties. * **iamProperties** *(dict) --* The IAM properties of a connection. * **glueLineageSyncEnabled** *(boolean) --* Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection. * **redshiftProperties** *(dict) --* The Amazon Redshift properties of a connection. * **credentials** *(dict) --* The Amaon Redshift credentials. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "secretArn", "usernamePassword". * **secretArn** *(string) --* The secret ARN of the Amazon Redshift credentials of a connection. * **usernamePassword** *(dict) --* The username and password of the Amazon Redshift credentials of a connection. * **password** *(string) --* **[REQUIRED]** The password of a connection. * **username** *(string) --* **[REQUIRED]** The username of a connection. * **databaseName** *(string) --* The Amazon Redshift database name. * **host** *(string) --* The Amazon Redshift host. * **lineageSync** *(dict) --* The lineage sync of the Amazon Redshift. * **enabled** *(boolean) --* Specifies whether the Amaon Redshift lineage sync configuration is enabled. * **schedule** *(dict) --* The schedule of the Amaon Redshift lineage sync configuration. * **schedule** *(string) --* The lineage sync schedule. * **port** *(integer) --* The Amaon Redshift port. * **storage** *(dict) --* The Amazon Redshift storage. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "clusterName", "workgroupName". * **clusterName** *(string) --* The cluster name in the Amazon Redshift storage properties. * **workgroupName** *(string) --* The workgroup name in the Amazon Redshift storage properties. * **s3Properties** *(dict) --* The Amazon S3 properties of a connection. * **s3AccessGrantLocationId** *(string) --* The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection. * **s3Uri** *(string) --* **[REQUIRED]** The Amazon S3 URI that's part of the Amazon S3 properties of a connection. * **sparkEmrProperties** *(dict) --* The Spark EMR properties of a connection. * **computeArn** *(string) --* The compute ARN of Spark EMR. * **instanceProfileArn** *(string) --* The instance profile ARN of Spark EMR. * **javaVirtualEnv** *(string) --* The java virtual env of the Spark EMR. * **logUri** *(string) --* The log URI of the Spark EMR. * **pythonVirtualEnv** *(string) --* The Python virtual env of the Spark EMR. * **runtimeRole** *(string) --* The runtime role of the Spark EMR. * **trustedCertificatesS3Uri** *(string) --* The certificates S3 URI of the Spark EMR. * **sparkGlueProperties** *(dict) --* The Spark Amazon Web Services Glue properties of a connection. * **additionalArgs** *(dict) --* The additional args in the Spark Amazon Web Services Glue properties. * **connection** *(string) --* The connection in the Spark Amazon Web Services Glue args. * **glueConnectionName** *(string) --* The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties. * **glueVersion** *(string) --* The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties. * **idleTimeout** *(integer) --* The idle timeout in the Spark Amazon Web Services Glue properties. * **javaVirtualEnv** *(string) --* The Java virtual env in the Spark Amazon Web Services Glue properties. * **numberOfWorkers** *(integer) --* The number of workers in the Spark Amazon Web Services Glue properties. * **pythonVirtualEnv** *(string) --* The Python virtual env in the Spark Amazon Web Services Glue properties. * **workerType** *(string) --* The worker type in the Spark Amazon Web Services Glue properties. Return type: dict Returns: **Response Syntax** { 'connectionId': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentId': 'string', 'name': 'string', 'physicalEndpoints': [ { 'awsLocation': { 'accessRole': 'string', 'awsAccountId': 'string', 'awsRegion': 'string', 'iamConnectionId': 'string' }, 'glueConnection': { 'athenaProperties': { 'string': 'string' }, 'authenticationConfiguration': { 'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM', 'oAuth2Properties': { 'authorizationCodeProperties': { 'authorizationCode': 'string', 'redirectUri': 'string' }, 'oAuth2ClientApplication': { 'aWSManagedClientApplicationReference': 'string', 'userManagedClientApplicationClientId': 'string' }, 'oAuth2Credentials': { 'accessToken': 'string', 'jwtToken': 'string', 'refreshToken': 'string', 'userManagedClientApplicationClientSecret': 'string' }, 'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER', 'tokenUrl': 'string', 'tokenUrlParametersMap': { 'string': 'string' } }, 'secretArn': 'string' }, 'compatibleComputeEnvironments': [ 'SPARK'|'ATHENA'|'PYTHON', ], 'connectionProperties': { 'string': 'string' }, 'connectionSchemaVersion': 123, 'connectionType': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'lastConnectionValidationTime': datetime(2015, 1, 1), 'lastUpdatedBy': 'string', 'lastUpdatedTime': datetime(2015, 1, 1), 'matchCriteria': [ 'string', ], 'name': 'string', 'physicalConnectionRequirements': { 'availabilityZone': 'string', 'securityGroupIdList': [ 'string', ], 'subnetId': 'string', 'subnetIdList': [ 'string', ] }, 'pythonProperties': { 'string': 'string' }, 'sparkProperties': { 'string': 'string' }, 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED', 'statusReason': 'string' }, 'glueConnectionName': 'string', 'host': 'string', 'port': 123, 'protocol': 'ATHENA'|'GLUE_INTERACTIVE_SESSION'|'HTTPS'|'JDBC'|'LIVY'|'ODBC'|'PRISM', 'stage': 'string' }, ], 'projectId': 'string', 'props': { 'athenaProperties': { 'workgroupName': 'string' }, 'glueProperties': { 'errorMessage': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED' }, 'hyperPodProperties': { 'clusterArn': 'string', 'clusterName': 'string', 'orchestrator': 'EKS'|'SLURM' }, 'iamProperties': { 'environmentId': 'string', 'glueLineageSyncEnabled': True|False }, 'redshiftProperties': { 'credentials': { 'secretArn': 'string', 'usernamePassword': { 'password': 'string', 'username': 'string' } }, 'databaseName': 'string', 'isProvisionedSecret': True|False, 'jdbcIamUrl': 'string', 'jdbcUrl': 'string', 'lineageSync': { 'enabled': True|False, 'lineageJobId': 'string', 'schedule': { 'schedule': 'string' } }, 'redshiftTempDir': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED', 'storage': { 'clusterName': 'string', 'workgroupName': 'string' } }, 's3Properties': { 'errorMessage': 'string', 's3AccessGrantLocationId': 'string', 's3Uri': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED' }, 'sparkEmrProperties': { 'computeArn': 'string', 'credentials': { 'password': 'string', 'username': 'string' }, 'credentialsExpiration': datetime(2015, 1, 1), 'governanceType': 'AWS_MANAGED'|'USER_MANAGED', 'instanceProfileArn': 'string', 'javaVirtualEnv': 'string', 'livyEndpoint': 'string', 'logUri': 'string', 'pythonVirtualEnv': 'string', 'runtimeRole': 'string', 'trustedCertificatesS3Uri': 'string' }, 'sparkGlueProperties': { 'additionalArgs': { 'connection': 'string' }, 'glueConnectionName': 'string', 'glueVersion': 'string', 'idleTimeout': 123, 'javaVirtualEnv': 'string', 'numberOfWorkers': 123, 'pythonVirtualEnv': 'string', 'workerType': 'string' } }, 'type': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA' } **Response Structure** * *(dict) --* * **connectionId** *(string) --* The ID of the connection. * **description** *(string) --* The connection description. * **domainId** *(string) --* The ID of the domain where the connection is created. * **domainUnitId** *(string) --* The ID of the domain unit where the connection is created. * **environmentId** *(string) --* The ID of the environment where the connection is created. * **name** *(string) --* The connection name. * **physicalEndpoints** *(list) --* The physical endpoints of the connection. * *(dict) --* The physical endpoints of a connection. * **awsLocation** *(dict) --* The location of a connection. * **accessRole** *(string) --* The access role of a connection. * **awsAccountId** *(string) --* The account ID of a connection. * **awsRegion** *(string) --* The Region of a connection. * **iamConnectionId** *(string) --* The IAM connection ID of a connection. * **glueConnection** *(dict) --* The Amazon Web Services Glue connection. * **athenaProperties** *(dict) --* The Amazon Athena properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **authenticationConfiguration** *(dict) --* The authentication configuration of the Amazon Web Services Glue connection. * **authenticationType** *(string) --* The authentication type of a connection. * **oAuth2Properties** *(dict) --* The oAuth2 properties of a connection. * **authorizationCodeProperties** *(dict) --* The authorization code properties of the OAuth2 properties. * **authorizationCode** *(string) --* The authorization code of a connection. * **redirectUri** *(string) --* The redirect URI of a connection. * **oAuth2ClientApplication** *(dict) --* The OAuth2 client application of the OAuth2 properties. * **aWSManagedClientApplicationReference** *(string) --* The Amazon Web Services managed client application reference in the OAuth2Client application. * **userManagedClientApplicationClientId** *(string) --* The user managed client application client ID in the OAuth2Client application. * **oAuth2Credentials** *(dict) --* The OAuth2 credentials of the OAuth2 properties. * **accessToken** *(string) --* The access token of a connection. * **jwtToken** *(string) --* The jwt token of the connection. * **refreshToken** *(string) --* The refresh token of the connection. * **userManagedClientApplicationClientSecret** *(string) --* The user managed client application client secret of the connection. * **oAuth2GrantType** *(string) --* The OAuth2 grant type of the OAuth2 properties. * **tokenUrl** *(string) --* The OAuth2 token URL of the OAuth2 properties. * **tokenUrlParametersMap** *(dict) --* The OAuth2 token URL parameter map of the OAuth2 properties. * *(string) --* * *(string) --* * **secretArn** *(string) --* The secret ARN of a connection. * **compatibleComputeEnvironments** *(list) --* The compatible compute environments of the Amazon Web Services Glue connection. * *(string) --* * **connectionProperties** *(dict) --* The properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **connectionSchemaVersion** *(integer) --* The connection schema version of the Amazon Web Services Glue connection. * **connectionType** *(string) --* The type of the Amazon Web Services Glue connection. * **creationTime** *(datetime) --* The creation time of the Amazon Web Services Glue connection. * **description** *(string) --* The description of the Amazon Web Services Glue connection. * **lastConnectionValidationTime** *(datetime) --* The last validation time of the Amazon Web Services Glue connection. * **lastUpdatedBy** *(string) --* The user who last updated the Amazon Web Services Glue connection. * **lastUpdatedTime** *(datetime) --* The timestamp at which the Amazon Web Services Glue connection was last updated. * **matchCriteria** *(list) --* The match criteria of the Amazon Web Services Glue connection. * *(string) --* * **name** *(string) --* The name of the Amazon Web Services Glue connection. * **physicalConnectionRequirements** *(dict) --* The physical connection requirements of the Amazon Web Services Glue connection. * **availabilityZone** *(string) --* The availability zone of the physical connection requirements of a connection. * **securityGroupIdList** *(list) --* The group ID list of the physical connection requirements of a connection. * *(string) --* * **subnetId** *(string) --* The subnet ID of the physical connection requirements of a connection. * **subnetIdList** *(list) --* The subnet ID list of the physical connection requirements of a connection. * *(string) --* * **pythonProperties** *(dict) --* The Python properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **sparkProperties** *(dict) --* The Spark properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **status** *(string) --* The status of the Amazon Web Services Glue connection. * **statusReason** *(string) --* The status reason of the Amazon Web Services Glue connection. * **glueConnectionName** *(string) --* The Amazon Web Services Glue connection name. * **host** *(string) --* The host in the physical endpoints of a connection. * **port** *(integer) --* The port in the physical endpoints of a connection. * **protocol** *(string) --* The protocol in the physical endpoints of a connection. * **stage** *(string) --* The stage in the physical endpoints of a connection. * **projectId** *(string) --* The ID of the project where the connection is created. * **props** *(dict) --* The connection props. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "athenaProperties", "glueProperties", "hyperPodProperties", "iamProperties", "redshiftProperties", "s3Properties", "sparkEmrProperties", "sparkGlueProperties". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **athenaProperties** *(dict) --* The Amazon Athena properties of a connection. * **workgroupName** *(string) --* The Amazon Athena workgroup name of a connection. * **glueProperties** *(dict) --* The Amazon Web Services Glue properties of a connection. * **errorMessage** *(string) --* The error message generated if the action is not completed successfully. * **status** *(string) --* The status of a connection. * **hyperPodProperties** *(dict) --* The hyper pod properties of a connection. * **clusterArn** *(string) --* The cluster ARN of the hyper pod properties. * **clusterName** *(string) --* The cluster name the hyper pod properties. * **orchestrator** *(string) --* The orchestrator of the hyper pod properties. * **iamProperties** *(dict) --* The IAM properties of a connection. * **environmentId** *(string) --* The environment ID of the connection. * **glueLineageSyncEnabled** *(boolean) --* Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection. * **redshiftProperties** *(dict) --* The Amazon Redshift properties of a connection. * **credentials** *(dict) --* The Amazon Redshift credentials. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "secretArn", "usernamePassword". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **secretArn** *(string) --* The secret ARN of the Amazon Redshift credentials of a connection. * **usernamePassword** *(dict) --* The username and password of the Amazon Redshift credentials of a connection. * **password** *(string) --* The password of a connection. * **username** *(string) --* The username of a connection. * **databaseName** *(string) --* The Amazon Redshift database name. * **isProvisionedSecret** *(boolean) --* Specifies whether Amaon Redshift properties has a provisioned secret. * **jdbcIamUrl** *(string) --* The jdbcIam URL of the Amazon Redshift properties. * **jdbcUrl** *(string) --* The jdbcURL of the Amazon Redshift properties. * **lineageSync** *(dict) --* The lineage syn of the Amazon Redshift properties. * **enabled** *(boolean) --* Specifies whether the Amaon Redshift lineage sync configuration is enabled. * **lineageJobId** *(string) --* The lineage job ID of the Amaon Redshift lineage sync configuration. * **schedule** *(dict) --* The schedule of teh Amaon Redshift lineage sync configuration. * **schedule** *(string) --* The lineage sync schedule. * **redshiftTempDir** *(string) --* The redshiftTempDir of the Amazon Redshift properties. * **status** *(string) --* The status in the Amazon Redshift properties. * **storage** *(dict) --* The storage in the Amazon Redshift properties. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "clusterName", "workgroupName". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **clusterName** *(string) --* The cluster name in the Amazon Redshift storage properties. * **workgroupName** *(string) --* The workgroup name in the Amazon Redshift storage properties. * **s3Properties** *(dict) --* The Amazon S3 properties of a connection. * **errorMessage** *(string) --* The error message that gets displayed. * **s3AccessGrantLocationId** *(string) --* The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection. * **s3Uri** *(string) --* The Amazon S3 URI that's part of the Amazon S3 properties of a connection. * **status** *(string) --* The status of the Amazon S3 connection. * **sparkEmrProperties** *(dict) --* The Spark EMR properties of a connection. * **computeArn** *(string) --* The compute ARN of the Spark EMR. * **credentials** *(dict) --* The credentials of the Spark EMR. * **password** *(string) --* The password of a connection. * **username** *(string) --* The username of a connection. * **credentialsExpiration** *(datetime) --* The credential expiration of the Spark EMR. * **governanceType** *(string) --* The governance type of the Spark EMR. * **instanceProfileArn** *(string) --* The instance profile ARN of the Spark EMR. * **javaVirtualEnv** *(string) --* The Java virtual env of the Spark EMR. * **livyEndpoint** *(string) --* The livy endpoint of the Spark EMR. * **logUri** *(string) --* The log URI of the Spark EMR. * **pythonVirtualEnv** *(string) --* The Python virtual env of the Spark EMR. * **runtimeRole** *(string) --* The runtime role of the Spark EMR. * **trustedCertificatesS3Uri** *(string) --* The trusted certificate S3 URL of the Spark EMR. * **sparkGlueProperties** *(dict) --* The Spark Amazon Web Services Glue properties of a connection. * **additionalArgs** *(dict) --* The additional args in the Spark Amazon Web Services Glue properties. * **connection** *(string) --* The connection in the Spark Amazon Web Services Glue args. * **glueConnectionName** *(string) --* The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties. * **glueVersion** *(string) --* The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties. * **idleTimeout** *(integer) --* The idle timeout in the Spark Amazon Web Services Glue properties. * **javaVirtualEnv** *(string) --* The Java virtual env in the Spark Amazon Web Services Glue properties. * **numberOfWorkers** *(integer) --* The number of workers in the Spark Amazon Web Services Glue properties. * **pythonVirtualEnv** *(string) --* The Python virtual env in the Spark Amazon Web Services Glue properties. * **workerType** *(string) --* The worker type in the Spark Amazon Web Services Glue properties. * **type** *(string) --* The connection type. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / start_data_source_run start_data_source_run ********************* DataZone.Client.start_data_source_run(**kwargs) Start the run of the specified data source in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.start_data_source_run( clientToken='string', dataSourceIdentifier='string', domainIdentifier='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **dataSourceIdentifier** (*string*) -- **[REQUIRED]** The identifier of the data source. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to start a data source run. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'dataSourceConfigurationSnapshot': 'string', 'dataSourceId': 'string', 'domainId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'projectId': 'string', 'runStatisticsForAssets': { 'added': 123, 'failed': 123, 'skipped': 123, 'unchanged': 123, 'updated': 123 }, 'startedAt': datetime(2015, 1, 1), 'status': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'stoppedAt': datetime(2015, 1, 1), 'type': 'PRIORITIZED'|'SCHEDULED', 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when data source run was created. * **dataSourceConfigurationSnapshot** *(string) --* The configuration snapshot of the data source that is being run. * **dataSourceId** *(string) --* The identifier of the data source. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which to start a data source run. * **errorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The identifier of the data source run. * **projectId** *(string) --* The identifier of the project. * **runStatisticsForAssets** *(dict) --* Specifies run statistics for assets. * **added** *(integer) --* The "added" statistic for the data source run. * **failed** *(integer) --* The "failed" statistic for the data source run. * **skipped** *(integer) --* The "skipped" statistic for the data source run. * **unchanged** *(integer) --* The "unchanged" statistic for the data source run. * **updated** *(integer) --* The "updated" statistic for the data source run. * **startedAt** *(datetime) --* The timestamp of when the data source run was started. * **status** *(string) --* The status of the data source run. * **stoppedAt** *(datetime) --* The timestamp of when the data source run was stopped. * **type** *(string) --* The type of the data source run. * **updatedAt** *(datetime) --* The timestamp of when the data source run was updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_data_source delete_data_source ****************** DataZone.Client.delete_data_source(**kwargs) Deletes a data source in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_data_source( clientToken='string', domainIdentifier='string', identifier='string', retainPermissionsOnRevokeFailure=True|False ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the data source is deleted. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the data source that is deleted. * **retainPermissionsOnRevokeFailure** (*boolean*) -- Specifies that the granted permissions are retained in case of a self- subscribe functionality failure for a data source. Return type: dict Returns: **Response Syntax** { 'assetFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'configuration': { 'glueRunConfiguration': { 'accountId': 'string', 'autoImportDataQualityResult': True|False, 'catalogName': 'string', 'dataAccessRole': 'string', 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'redshiftRunConfiguration': { 'accountId': 'string', 'dataAccessRole': 'string', 'redshiftCredentialConfiguration': { 'secretManagerArn': 'string' }, 'redshiftStorage': { 'redshiftClusterSource': { 'clusterName': 'string' }, 'redshiftServerlessSource': { 'workgroupName': 'string' } }, 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'sageMakerRunConfiguration': { 'accountId': 'string', 'region': 'string', 'trackingAssets': { 'string': [ 'string', ] } } }, 'connectionId': 'string', 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'enableSetting': 'ENABLED'|'DISABLED', 'environmentId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'lastRunAt': datetime(2015, 1, 1), 'lastRunErrorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'name': 'string', 'projectId': 'string', 'publishOnImport': True|False, 'retainPermissionsOnRevokeFailure': True|False, 'schedule': { 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' }, 'selfGrantStatus': { 'glueSelfGrantStatus': { 'selfGrantStatusDetails': [ { 'databaseName': 'string', 'failureCause': 'string', 'schemaName': 'string', 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'GRANT_FAILED'|'REVOKE_FAILED' }, ] }, 'redshiftSelfGrantStatus': { 'selfGrantStatusDetails': [ { 'databaseName': 'string', 'failureCause': 'string', 'schemaName': 'string', 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'GRANT_FAILED'|'REVOKE_FAILED' }, ] } }, 'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', 'type': 'string', 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **assetFormsOutput** *(list) --* The asset data forms associated with this data source. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **configuration** *(dict) --* The configuration of the data source that is deleted. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "glueRunConfiguration", "redshiftRunConfiguration", "sageMakerRunConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **glueRunConfiguration** *(dict) --* The configuration of the Amazon Web Services Glue data source. * **accountId** *(string) --* The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source. * **autoImportDataQualityResult** *(boolean) --* Specifies whether to automatically import data quality metrics as part of the data source run. * **catalogName** *(string) --* The catalog name in the Amazon Web Services Glue run configuration. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Web Services Glue data source. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. * **relationalFilterConfigurations** *(list) --* The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **redshiftRunConfiguration** *(dict) --* The configuration of the Amazon Redshift data source. * **accountId** *(string) --* The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Redshift data source. * **redshiftCredentialConfiguration** *(dict) --* The details of the credentials required to access an Amazon Redshift cluster. * **secretManagerArn** *(string) --* The ARN of a secret manager for an Amazon Redshift cluster. * **redshiftStorage** *(dict) --* The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "redshiftClusterSource", "redshiftServerlessSource". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **redshiftClusterSource** *(dict) --* The details of the Amazon Redshift cluster source. * **clusterName** *(string) --* The name of an Amazon Redshift cluster. * **redshiftServerlessSource** *(dict) --* The details of the Amazon Redshift Serverless workgroup source. * **workgroupName** *(string) --* The name of the Amazon Redshift Serverless workgroup. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Redshift data source. * **relationalFilterConfigurations** *(list) --* The relational filger configurations included in the configuration details of the Amazon Redshift data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **sageMakerRunConfiguration** *(dict) --* The Amazon SageMaker run configuration. * **accountId** *(string) --* The Amazon SageMaker account ID. * **region** *(string) --* The Amazon SageMaker Region. * **trackingAssets** *(dict) --* The tracking assets of the Amazon SageMaker. * *(string) --* * *(list) --* * *(string) --* * **connectionId** *(string) --* The ID of the connection that is deleted. * **createdAt** *(datetime) --* The timestamp of when this data source was created. * **description** *(string) --* The description of the data source that is deleted. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the data source is deleted. * **enableSetting** *(string) --* The enable setting of the data source that specifies whether the data source is enabled or disabled. * **environmentId** *(string) --* The ID of the environemnt associated with this data source. * **errorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The ID of the data source that is deleted. * **lastRunAt** *(datetime) --* The timestamp of when the data source was last run. * **lastRunErrorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **lastRunStatus** *(string) --* The status of the last run of this data source. * **name** *(string) --* The name of the data source that is deleted. * **projectId** *(string) --* The ID of the project in which this data source exists and from which it's deleted. * **publishOnImport** *(boolean) --* Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. * **retainPermissionsOnRevokeFailure** *(boolean) --* Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source. * **schedule** *(dict) --* The schedule of runs for this data source. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. * **selfGrantStatus** *(dict) --* Specifies the status of the self-granting functionality. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "glueSelfGrantStatus", "redshiftSelfGrantStatus". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **glueSelfGrantStatus** *(dict) --* The details for the self granting status for a Glue data source. * **selfGrantStatusDetails** *(list) --* The details for the self granting status for a Glue data source. * *(dict) --* The details for the self granting status. * **databaseName** *(string) --* The name of the database used for the data source. * **failureCause** *(string) --* The reason for why the operation failed. * **schemaName** *(string) --* The name of the schema used in the data source. * **status** *(string) --* The self granting status of the data source. * **redshiftSelfGrantStatus** *(dict) --* The details for the self granting status for an Amazon Redshift data source. * **selfGrantStatusDetails** *(list) --* The details for the self granting status for an Amazon Redshift data source. * *(dict) --* The details for the self granting status. * **databaseName** *(string) --* The name of the database used for the data source. * **failureCause** *(string) --* The reason for why the operation failed. * **schemaName** *(string) --* The name of the schema used in the data source. * **status** *(string) --* The self granting status of the data source. * **status** *(string) --* The status of this data source. * **type** *(string) --* The type of this data source. * **updatedAt** *(datetime) --* The timestamp of when this data source was updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_data_source create_data_source ****************** DataZone.Client.create_data_source(**kwargs) Creates an Amazon DataZone data source. See also: AWS API Documentation **Request Syntax** response = client.create_data_source( assetFormsInput=[ { 'content': 'string', 'formName': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], clientToken='string', configuration={ 'glueRunConfiguration': { 'autoImportDataQualityResult': True|False, 'catalogName': 'string', 'dataAccessRole': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'redshiftRunConfiguration': { 'dataAccessRole': 'string', 'redshiftCredentialConfiguration': { 'secretManagerArn': 'string' }, 'redshiftStorage': { 'redshiftClusterSource': { 'clusterName': 'string' }, 'redshiftServerlessSource': { 'workgroupName': 'string' } }, 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'sageMakerRunConfiguration': { 'trackingAssets': { 'string': [ 'string', ] } } }, connectionIdentifier='string', description='string', domainIdentifier='string', enableSetting='ENABLED'|'DISABLED', environmentIdentifier='string', name='string', projectIdentifier='string', publishOnImport=True|False, recommendation={ 'enableBusinessNameGeneration': True|False }, schedule={ 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' }, type='string' ) Parameters: * **assetFormsInput** (*list*) -- The metadata forms that are to be attached to the assets that this data source works with. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* **[REQUIRED]** The name of the metadata form. * **typeIdentifier** *(string) --* The ID of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **configuration** (*dict*) -- Specifies the configuration of the data source. It can be set to either "glueRunConfiguration" or "redshiftRunConfiguration". Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "glueRunConfiguration", "redshiftRunConfiguration", "sageMakerRunConfiguration". * **glueRunConfiguration** *(dict) --* The configuration of the Amazon Web Services Glue data source. * **autoImportDataQualityResult** *(boolean) --* Specifies whether to automatically import data quality metrics as part of the data source run. * **catalogName** *(string) --* The catalog name in the Amazon Web Services Glue run configuration. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Web Services Glue data source. * **relationalFilterConfigurations** *(list) --* **[REQUIRED]** The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* **[REQUIRED]** The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* **[REQUIRED]** The search filter expression. * **type** *(string) --* **[REQUIRED]** The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **redshiftRunConfiguration** *(dict) --* The configuration of the Amazon Redshift data source. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Redshift data source. * **redshiftCredentialConfiguration** *(dict) --* The details of the credentials required to access an Amazon Redshift cluster. * **secretManagerArn** *(string) --* **[REQUIRED]** The ARN of a secret manager for an Amazon Redshift cluster. * **redshiftStorage** *(dict) --* The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "redshiftClusterSource", "redshiftServerlessSource". * **redshiftClusterSource** *(dict) --* The details of the Amazon Redshift cluster source. * **clusterName** *(string) --* **[REQUIRED]** The name of an Amazon Redshift cluster. * **redshiftServerlessSource** *(dict) --* The details of the Amazon Redshift Serverless workgroup source. * **workgroupName** *(string) --* **[REQUIRED]** The name of the Amazon Redshift Serverless workgroup. * **relationalFilterConfigurations** *(list) --* **[REQUIRED]** The relational filger configurations included in the configuration details of the Amazon Redshift data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* **[REQUIRED]** The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* **[REQUIRED]** The search filter expression. * **type** *(string) --* **[REQUIRED]** The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **sageMakerRunConfiguration** *(dict) --* The Amazon SageMaker run configuration. * **trackingAssets** *(dict) --* **[REQUIRED]** The tracking assets of the Amazon SageMaker run. * *(string) --* * *(list) --* * *(string) --* * **connectionIdentifier** (*string*) -- The ID of the connection. * **description** (*string*) -- The description of the data source. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where the data source is created. * **enableSetting** (*string*) -- Specifies whether the data source is enabled. * **environmentIdentifier** (*string*) -- The unique identifier of the Amazon DataZone environment to which the data source publishes assets. * **name** (*string*) -- **[REQUIRED]** The name of the data source. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone project in which you want to add this data source. * **publishOnImport** (*boolean*) -- Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. * **recommendation** (*dict*) -- Specifies whether the business name generation is to be enabled for this data source. * **enableBusinessNameGeneration** *(boolean) --* Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. * **schedule** (*dict*) -- The schedule of the data source runs. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. * **type** (*string*) -- **[REQUIRED]** The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift. Return type: dict Returns: **Response Syntax** { 'assetFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'configuration': { 'glueRunConfiguration': { 'accountId': 'string', 'autoImportDataQualityResult': True|False, 'catalogName': 'string', 'dataAccessRole': 'string', 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'redshiftRunConfiguration': { 'accountId': 'string', 'dataAccessRole': 'string', 'redshiftCredentialConfiguration': { 'secretManagerArn': 'string' }, 'redshiftStorage': { 'redshiftClusterSource': { 'clusterName': 'string' }, 'redshiftServerlessSource': { 'workgroupName': 'string' } }, 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'sageMakerRunConfiguration': { 'accountId': 'string', 'region': 'string', 'trackingAssets': { 'string': [ 'string', ] } } }, 'connectionId': 'string', 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'enableSetting': 'ENABLED'|'DISABLED', 'environmentId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'lastRunAt': datetime(2015, 1, 1), 'lastRunErrorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'name': 'string', 'projectId': 'string', 'publishOnImport': True|False, 'recommendation': { 'enableBusinessNameGeneration': True|False }, 'schedule': { 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' }, 'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', 'type': 'string', 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **assetFormsOutput** *(list) --* The metadata forms attached to the assets that this data source creates. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **configuration** *(dict) --* Specifies the configuration of the data source. It can be set to either "glueRunConfiguration" or "redshiftRunConfiguration". Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "glueRunConfiguration", "redshiftRunConfiguration", "sageMakerRunConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **glueRunConfiguration** *(dict) --* The configuration of the Amazon Web Services Glue data source. * **accountId** *(string) --* The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source. * **autoImportDataQualityResult** *(boolean) --* Specifies whether to automatically import data quality metrics as part of the data source run. * **catalogName** *(string) --* The catalog name in the Amazon Web Services Glue run configuration. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Web Services Glue data source. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. * **relationalFilterConfigurations** *(list) --* The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **redshiftRunConfiguration** *(dict) --* The configuration of the Amazon Redshift data source. * **accountId** *(string) --* The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Redshift data source. * **redshiftCredentialConfiguration** *(dict) --* The details of the credentials required to access an Amazon Redshift cluster. * **secretManagerArn** *(string) --* The ARN of a secret manager for an Amazon Redshift cluster. * **redshiftStorage** *(dict) --* The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "redshiftClusterSource", "redshiftServerlessSource". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **redshiftClusterSource** *(dict) --* The details of the Amazon Redshift cluster source. * **clusterName** *(string) --* The name of an Amazon Redshift cluster. * **redshiftServerlessSource** *(dict) --* The details of the Amazon Redshift Serverless workgroup source. * **workgroupName** *(string) --* The name of the Amazon Redshift Serverless workgroup. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Redshift data source. * **relationalFilterConfigurations** *(list) --* The relational filger configurations included in the configuration details of the Amazon Redshift data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **sageMakerRunConfiguration** *(dict) --* The Amazon SageMaker run configuration. * **accountId** *(string) --* The Amazon SageMaker account ID. * **region** *(string) --* The Amazon SageMaker Region. * **trackingAssets** *(dict) --* The tracking assets of the Amazon SageMaker. * *(string) --* * *(list) --* * *(string) --* * **connectionId** *(string) --* The ID of the connection. * **createdAt** *(datetime) --* The timestamp of when the data source was created. * **description** *(string) --* The description of the data source. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the data source is created. * **enableSetting** *(string) --* Specifies whether the data source is enabled. * **environmentId** *(string) --* The unique identifier of the Amazon DataZone environment to which the data source publishes assets. * **errorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The unique identifier of the data source. * **lastRunAt** *(datetime) --* The timestamp that specifies when the data source was last run. * **lastRunErrorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **lastRunStatus** *(string) --* The status of the last run of this data source. * **name** *(string) --* The name of the data source. * **projectId** *(string) --* The ID of the Amazon DataZone project to which the data source is added. * **publishOnImport** *(boolean) --* Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. * **recommendation** *(dict) --* Specifies whether the business name generation is to be enabled for this data source. * **enableBusinessNameGeneration** *(boolean) --* Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. * **schedule** *(dict) --* The schedule of the data source runs. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. * **status** *(string) --* The status of the data source. * **type** *(string) --* The type of the data source. * **updatedAt** *(datetime) --* The timestamp of when the data source was updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_data_source update_data_source ****************** DataZone.Client.update_data_source(**kwargs) Updates the specified data source in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_data_source( assetFormsInput=[ { 'content': 'string', 'formName': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], configuration={ 'glueRunConfiguration': { 'autoImportDataQualityResult': True|False, 'catalogName': 'string', 'dataAccessRole': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'redshiftRunConfiguration': { 'dataAccessRole': 'string', 'redshiftCredentialConfiguration': { 'secretManagerArn': 'string' }, 'redshiftStorage': { 'redshiftClusterSource': { 'clusterName': 'string' }, 'redshiftServerlessSource': { 'workgroupName': 'string' } }, 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'sageMakerRunConfiguration': { 'trackingAssets': { 'string': [ 'string', ] } } }, description='string', domainIdentifier='string', enableSetting='ENABLED'|'DISABLED', identifier='string', name='string', publishOnImport=True|False, recommendation={ 'enableBusinessNameGeneration': True|False }, retainPermissionsOnRevokeFailure=True|False, schedule={ 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' } ) Parameters: * **assetFormsInput** (*list*) -- The asset forms to be updated as part of the "UpdateDataSource" action. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* **[REQUIRED]** The name of the metadata form. * **typeIdentifier** *(string) --* The ID of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **configuration** (*dict*) -- The configuration to be updated as part of the "UpdateDataSource" action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "glueRunConfiguration", "redshiftRunConfiguration", "sageMakerRunConfiguration". * **glueRunConfiguration** *(dict) --* The configuration of the Amazon Web Services Glue data source. * **autoImportDataQualityResult** *(boolean) --* Specifies whether to automatically import data quality metrics as part of the data source run. * **catalogName** *(string) --* The catalog name in the Amazon Web Services Glue run configuration. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Web Services Glue data source. * **relationalFilterConfigurations** *(list) --* **[REQUIRED]** The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* **[REQUIRED]** The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* **[REQUIRED]** The search filter expression. * **type** *(string) --* **[REQUIRED]** The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **redshiftRunConfiguration** *(dict) --* The configuration of the Amazon Redshift data source. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Redshift data source. * **redshiftCredentialConfiguration** *(dict) --* The details of the credentials required to access an Amazon Redshift cluster. * **secretManagerArn** *(string) --* **[REQUIRED]** The ARN of a secret manager for an Amazon Redshift cluster. * **redshiftStorage** *(dict) --* The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "redshiftClusterSource", "redshiftServerlessSource". * **redshiftClusterSource** *(dict) --* The details of the Amazon Redshift cluster source. * **clusterName** *(string) --* **[REQUIRED]** The name of an Amazon Redshift cluster. * **redshiftServerlessSource** *(dict) --* The details of the Amazon Redshift Serverless workgroup source. * **workgroupName** *(string) --* **[REQUIRED]** The name of the Amazon Redshift Serverless workgroup. * **relationalFilterConfigurations** *(list) --* **[REQUIRED]** The relational filger configurations included in the configuration details of the Amazon Redshift data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* **[REQUIRED]** The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* **[REQUIRED]** The search filter expression. * **type** *(string) --* **[REQUIRED]** The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **sageMakerRunConfiguration** *(dict) --* The Amazon SageMaker run configuration. * **trackingAssets** *(dict) --* **[REQUIRED]** The tracking assets of the Amazon SageMaker run. * *(string) --* * *(list) --* * *(string) --* * **description** (*string*) -- The description to be updated as part of the "UpdateDataSource" action. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the domain in which to update a data source. * **enableSetting** (*string*) -- The enable setting to be updated as part of the "UpdateDataSource" action. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the data source to be updated. * **name** (*string*) -- The name to be updated as part of the "UpdateDataSource" action. * **publishOnImport** (*boolean*) -- The publish on import setting to be updated as part of the "UpdateDataSource" action. * **recommendation** (*dict*) -- The recommendation to be updated as part of the "UpdateDataSource" action. * **enableBusinessNameGeneration** *(boolean) --* Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. * **retainPermissionsOnRevokeFailure** (*boolean*) -- Specifies that the granted permissions are retained in case of a self- subscribe functionality failure for a data source. * **schedule** (*dict*) -- The schedule to be updated as part of the "UpdateDataSource" action. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. Return type: dict Returns: **Response Syntax** { 'assetFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'configuration': { 'glueRunConfiguration': { 'accountId': 'string', 'autoImportDataQualityResult': True|False, 'catalogName': 'string', 'dataAccessRole': 'string', 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'redshiftRunConfiguration': { 'accountId': 'string', 'dataAccessRole': 'string', 'redshiftCredentialConfiguration': { 'secretManagerArn': 'string' }, 'redshiftStorage': { 'redshiftClusterSource': { 'clusterName': 'string' }, 'redshiftServerlessSource': { 'workgroupName': 'string' } }, 'region': 'string', 'relationalFilterConfigurations': [ { 'databaseName': 'string', 'filterExpressions': [ { 'expression': 'string', 'type': 'INCLUDE'|'EXCLUDE' }, ], 'schemaName': 'string' }, ] }, 'sageMakerRunConfiguration': { 'accountId': 'string', 'region': 'string', 'trackingAssets': { 'string': [ 'string', ] } } }, 'connectionId': 'string', 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'enableSetting': 'ENABLED'|'DISABLED', 'environmentId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'lastRunAt': datetime(2015, 1, 1), 'lastRunErrorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'name': 'string', 'projectId': 'string', 'publishOnImport': True|False, 'recommendation': { 'enableBusinessNameGeneration': True|False }, 'retainPermissionsOnRevokeFailure': True|False, 'schedule': { 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' }, 'selfGrantStatus': { 'glueSelfGrantStatus': { 'selfGrantStatusDetails': [ { 'databaseName': 'string', 'failureCause': 'string', 'schemaName': 'string', 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'GRANT_FAILED'|'REVOKE_FAILED' }, ] }, 'redshiftSelfGrantStatus': { 'selfGrantStatusDetails': [ { 'databaseName': 'string', 'failureCause': 'string', 'schemaName': 'string', 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'GRANT_FAILED'|'REVOKE_FAILED' }, ] } }, 'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', 'type': 'string', 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **assetFormsOutput** *(list) --* The asset forms to be updated as part of the "UpdateDataSource" action. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **configuration** *(dict) --* The configuration to be updated as part of the "UpdateDataSource" action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "glueRunConfiguration", "redshiftRunConfiguration", "sageMakerRunConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **glueRunConfiguration** *(dict) --* The configuration of the Amazon Web Services Glue data source. * **accountId** *(string) --* The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source. * **autoImportDataQualityResult** *(boolean) --* Specifies whether to automatically import data quality metrics as part of the data source run. * **catalogName** *(string) --* The catalog name in the Amazon Web Services Glue run configuration. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Web Services Glue data source. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. * **relationalFilterConfigurations** *(list) --* The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **redshiftRunConfiguration** *(dict) --* The configuration of the Amazon Redshift data source. * **accountId** *(string) --* The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source. * **dataAccessRole** *(string) --* The data access role included in the configuration details of the Amazon Redshift data source. * **redshiftCredentialConfiguration** *(dict) --* The details of the credentials required to access an Amazon Redshift cluster. * **secretManagerArn** *(string) --* The ARN of a secret manager for an Amazon Redshift cluster. * **redshiftStorage** *(dict) --* The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "redshiftClusterSource", "redshiftServerlessSource". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **redshiftClusterSource** *(dict) --* The details of the Amazon Redshift cluster source. * **clusterName** *(string) --* The name of an Amazon Redshift cluster. * **redshiftServerlessSource** *(dict) --* The details of the Amazon Redshift Serverless workgroup source. * **workgroupName** *(string) --* The name of the Amazon Redshift Serverless workgroup. * **region** *(string) --* The Amazon Web Services region included in the configuration details of the Amazon Redshift data source. * **relationalFilterConfigurations** *(list) --* The relational filger configurations included in the configuration details of the Amazon Redshift data source. * *(dict) --* The relational filter configuration for the data source. * **databaseName** *(string) --* The database name specified in the relational filter configuration for the data source. * **filterExpressions** *(list) --* The filter expressions specified in the relational filter configuration for the data source. * *(dict) --* A filter expression in Amazon DataZone. * **expression** *(string) --* The search filter expression. * **type** *(string) --* The search filter explresison type. * **schemaName** *(string) --* The schema name specified in the relational filter configuration for the data source. * **sageMakerRunConfiguration** *(dict) --* The Amazon SageMaker run configuration. * **accountId** *(string) --* The Amazon SageMaker account ID. * **region** *(string) --* The Amazon SageMaker Region. * **trackingAssets** *(dict) --* The tracking assets of the Amazon SageMaker. * *(string) --* * *(list) --* * *(string) --* * **connectionId** *(string) --* The connection ID. * **createdAt** *(datetime) --* The timestamp of when the data source was updated. * **description** *(string) --* The description to be updated as part of the "UpdateDataSource" action. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a data source is to be updated. * **enableSetting** *(string) --* The enable setting to be updated as part of the "UpdateDataSource" action. * **environmentId** *(string) --* The identifier of the environment in which a data source is to be updated. * **errorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The identifier of the data source to be updated. * **lastRunAt** *(datetime) --* The timestamp of when the data source was last run. * **lastRunErrorMessage** *(dict) --* The last run error message of the data source. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **lastRunStatus** *(string) --* The last run status of the data source. * **name** *(string) --* The name to be updated as part of the "UpdateDataSource" action. * **projectId** *(string) --* The identifier of the project where data source is to be updated. * **publishOnImport** *(boolean) --* The publish on import setting to be updated as part of the "UpdateDataSource" action. * **recommendation** *(dict) --* The recommendation to be updated as part of the "UpdateDataSource" action. * **enableBusinessNameGeneration** *(boolean) --* Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. * **retainPermissionsOnRevokeFailure** *(boolean) --* Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source. * **schedule** *(dict) --* The schedule to be updated as part of the "UpdateDataSource" action. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. * **selfGrantStatus** *(dict) --* Specifies the status of the self-granting functionality. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "glueSelfGrantStatus", "redshiftSelfGrantStatus". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **glueSelfGrantStatus** *(dict) --* The details for the self granting status for a Glue data source. * **selfGrantStatusDetails** *(list) --* The details for the self granting status for a Glue data source. * *(dict) --* The details for the self granting status. * **databaseName** *(string) --* The name of the database used for the data source. * **failureCause** *(string) --* The reason for why the operation failed. * **schemaName** *(string) --* The name of the schema used in the data source. * **status** *(string) --* The self granting status of the data source. * **redshiftSelfGrantStatus** *(dict) --* The details for the self granting status for an Amazon Redshift data source. * **selfGrantStatusDetails** *(list) --* The details for the self granting status for an Amazon Redshift data source. * *(dict) --* The details for the self granting status. * **databaseName** *(string) --* The name of the database used for the data source. * **failureCause** *(string) --* The reason for why the operation failed. * **schemaName** *(string) --* The name of the schema used in the data source. * **status** *(string) --* The self granting status of the data source. * **status** *(string) --* The status to be updated as part of the "UpdateDataSource" action. * **type** *(string) --* The type to be updated as part of the "UpdateDataSource" action. * **updatedAt** *(datetime) --* The timestamp of when the data source was updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / remove_entity_owner remove_entity_owner ******************* DataZone.Client.remove_entity_owner(**kwargs) Removes an owner from an entity. See also: AWS API Documentation **Request Syntax** response = client.remove_entity_owner( clientToken='string', domainIdentifier='string', entityIdentifier='string', entityType='DOMAIN_UNIT', owner={ 'group': { 'groupIdentifier': 'string' }, 'user': { 'userIdentifier': 'string' } } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to remove an owner from an entity. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the entity from which you want to remove an owner. * **entityType** (*string*) -- **[REQUIRED]** The type of the entity from which you want to remove an owner. * **owner** (*dict*) -- **[REQUIRED]** The owner that you want to remove from an entity. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "group", "user". * **group** *(dict) --* Specifies that the domain unit owner is a group. * **groupIdentifier** *(string) --* **[REQUIRED]** The ID of the domain unit owners group. * **user** *(dict) --* Specifies that the domain unit owner is a user. * **userIdentifier** *(string) --* **[REQUIRED]** The ID of the owner user. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / search_listings search_listings *************** DataZone.Client.search_listings(**kwargs) Searches listings (records of an asset at a given time) in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.search_listings( additionalAttributes=[ 'FORMS'|'TIME_SERIES_DATA_POINT_FORMS'|'TEXT_MATCH_RATIONALE', ], aggregations=[ { 'attribute': 'string', 'displayValue': 'string' }, ], domainIdentifier='string', filters={ 'and': [ {'... recursive ...'}, ], 'filter': { 'attribute': 'string', 'value': 'string' }, 'or': [ {'... recursive ...'}, ] }, maxResults=123, nextToken='string', searchIn=[ { 'attribute': 'string' }, ], searchText='string', sort={ 'attribute': 'string', 'order': 'ASCENDING'|'DESCENDING' } ) Parameters: * **additionalAttributes** (*list*) -- Specifies additional attributes for the search. * *(string) --* * **aggregations** (*list*) -- Enables you to specify one or more attributes to compute and return counts grouped by field values. * *(dict) --* An aggregation list item. * **attribute** *(string) --* **[REQUIRED]** An attribute on which to compute aggregations. * **displayValue** *(string) --* The display value of the aggregation list item. Supported values include "value" and "glossaryTerm.name". * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the domain in which to search listings. * **filters** (*dict*) -- Specifies the filters for the search of listings. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **and** *(list) --* The 'and' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **filter** *(dict) --* A search filter in Amazon DataZone. * **attribute** *(string) --* **[REQUIRED]** A search filter attribute in Amazon DataZone. * **value** *(string) --* **[REQUIRED]** A search filter value in Amazon DataZone. * **or** *(list) --* The 'or' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **maxResults** (*integer*) -- The maximum number of results to return in a single call to "SearchListings". When the number of results to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "SearchListings" to list the next set of results. * **nextToken** (*string*) -- When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchListings" to list the next set of results. * **searchIn** (*list*) -- The details of the search. * *(dict) --* The details of the search. * **attribute** *(string) --* **[REQUIRED]** The search attribute. * **searchText** (*string*) -- Specifies the text for which to search. * **sort** (*dict*) -- Specifies the way for sorting the search results. * **attribute** *(string) --* **[REQUIRED]** The attribute detail of the way to sort search results. * **order** *(string) --* The order detail of the wya to sort search results. Return type: dict Returns: **Response Syntax** { 'aggregates': [ { 'attribute': 'string', 'displayValue': 'string', 'items': [ { 'count': 123, 'displayValue': 'string', 'value': 'string' }, ] }, ], 'items': [ { 'assetListing': { 'additionalAttributes': { 'forms': 'string', 'latestTimeSeriesDataPointForms': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'listingCreatedBy': 'string', 'listingId': 'string', 'listingRevision': 'string', 'listingUpdatedBy': 'string', 'name': 'string', 'owningProjectId': 'string' }, 'dataProductListing': { 'additionalAttributes': { 'forms': 'string', 'matchRationale': [ { 'textMatches': [ { 'attribute': 'string', 'matchOffsets': [ { 'endOffset': 123, 'startOffset': 123 }, ], 'text': 'string' }, ] }, ] }, 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'items': [ { 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'listingId': 'string', 'listingRevision': 'string' }, ], 'listingCreatedBy': 'string', 'listingId': 'string', 'listingRevision': 'string', 'listingUpdatedBy': 'string', 'name': 'string', 'owningProjectId': 'string' } }, ], 'nextToken': 'string', 'totalMatchCount': 123 } **Response Structure** * *(dict) --* * **aggregates** *(list) --* Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings. * *(dict) --* The aggregation for an attribute. * **attribute** *(string) --* The attribute for this aggregation. * **displayValue** *(string) --* The display value of the aggregation output item. * **items** *(list) --* A list of aggregation output items. * *(dict) --* An aggregation output item. * **count** *(integer) --* The count of the aggregation output item. * **displayValue** *(string) --* The display value of the aggregation. If the attribute being aggregated corresponds to the id of a public resource, the service automatically resolves the id to the provided display value. * **value** *(string) --* The attribute value of the aggregation output item. * **items** *(list) --* The results of the "SearchListings" action. * *(dict) --* The details of the results of the "SearchListings" action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "dataProductListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset listing included in the results of the "SearchListings" action. * **additionalAttributes** *(dict) --* The additional attributes of an asset published in an Amazon DataZone catalog. * **forms** *(string) --* The metadata forms that form additional attributes of the metadata asset. * **latestTimeSeriesDataPointForms** *(list) --* The latest time series data points forms included in the additional attributes of an asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp of when an asset published in an Amazon DataZone catalog was created. * **description** *(string) --* The description of an asset published in an Amazon DataZone catalog. * **entityId** *(string) --* The identifier of the inventory asset. * **entityRevision** *(string) --* The revision of the inventory asset. * **entityType** *(string) --* The type of the inventory asset. * **glossaryTerms** *(list) --* Glossary terms attached to the inventory asset. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **listingCreatedBy** *(string) --* The Amazon DataZone user who created the listing. * **listingId** *(string) --* The identifier of the listing (asset published in Amazon DataZone catalog). * **listingRevision** *(string) --* The revision of the listing (asset published in Amazon DataZone catalog). * **listingUpdatedBy** *(string) --* The Amazon DataZone user who updated the listing. * **name** *(string) --* The name of the inventory asset. * **owningProjectId** *(string) --* The identifier of the project that owns the inventory asset. * **dataProductListing** *(dict) --* The data product listing. * **additionalAttributes** *(dict) --* The additional attributes of the asset of the data product. * **forms** *(string) --* The metadata forms of the asset of the data product. * **matchRationale** *(list) --* List of rationales indicating why this item was matched by search. * *(dict) --* A rationale indicating why this item was matched by search. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textMatches". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textMatches** *(list) --* A list of TextMatchItems. * *(dict) --* A structure indicating matched terms for an attribute. * **attribute** *(string) --* The name of the attribute. * **matchOffsets** *(list) --* List of offsets indicating matching terms in the TextMatchItem text. * *(dict) --* The offset of a matched term. * **endOffset** *(integer) --* The 0-indexed number indicating the end position (exclusive) of a matched term. * **startOffset** *(integer) --* The 0-indexed number indicating the start position (inclusive) of a matched term. * **text** *(string) --* Snippet of attribute text containing highlighted content. * **createdAt** *(datetime) --* The timestamp at which the asset of the data product listing was created. * **description** *(string) --* The description of the asset of the asset of the data product. * **entityId** *(string) --* The entity ID of the asset of the asset of the data product. * **entityRevision** *(string) --* The revision of the asset of the asset of the data product. * **glossaryTerms** *(list) --* The glossary terms of the asset of the asset of the data product. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **items** *(list) --* The data of the asset of the data product. * *(dict) --* The results of the data product summary. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **listingId** *(string) --* The ID of the data product listing. * **listingRevision** *(string) --* The revision of the data product listing. * **listingCreatedBy** *(string) --* The timestamp at which the listing was created. * **listingId** *(string) --* The ID of the listing. * **listingRevision** *(string) --* The revision of the listing. * **listingUpdatedBy** *(string) --* The user who updated the listing. * **name** *(string) --* The name of the asset of the data product. * **owningProjectId** *(string) --* The ID of the owning project of the asset of the data product. * **nextToken** *(string) --* When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchListings" to list the next set of results. * **totalMatchCount** *(integer) --* Total number of search results. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_subscription_target delete_subscription_target ************************** DataZone.Client.delete_subscription_target(**kwargs) Deletes a subscription target in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_subscription_target( domainIdentifier='string', environmentIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the subscription target is deleted. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone environment in which the subscription target is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the subscription target that is deleted. Returns: None **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_domain_unit create_domain_unit ****************** DataZone.Client.create_domain_unit(**kwargs) Creates a domain unit in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.create_domain_unit( clientToken='string', description='string', domainIdentifier='string', name='string', parentDomainUnitIdentifier='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description of the domain unit. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to crate a domain unit. * **name** (*string*) -- **[REQUIRED]** The name of the domain unit. * **parentDomainUnitIdentifier** (*string*) -- **[REQUIRED]** The ID of the parent domain unit. Return type: dict Returns: **Response Syntax** { 'ancestorDomainUnitIds': [ 'string', ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'id': 'string', 'name': 'string', 'owners': [ { 'group': { 'groupId': 'string' }, 'user': { 'userId': 'string' } }, ], 'parentDomainUnitId': 'string' } **Response Structure** * *(dict) --* * **ancestorDomainUnitIds** *(list) --* The IDs of the ancestor domain units. * *(string) --* * **createdAt** *(datetime) --* The timestamp at which the domain unit was created. * **createdBy** *(string) --* The user who created the domain unit. * **description** *(string) --* The description of the domain unit. * **domainId** *(string) --* The ID of the domain where the domain unit was created. * **id** *(string) --* The ID of the domain unit. * **name** *(string) --* The name of the domain unit. * **owners** *(list) --* The owners of the domain unit. * *(dict) --* The properties of the domain unit owner. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "group", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **group** *(dict) --* Indicates that the domain unit owner is a group. * **groupId** *(string) --* The ID of the domain unit group. * **user** *(dict) --* Indicates that the domain unit owner is a user. * **userId** *(string) --* The ID of teh domain unit user. * **parentDomainUnitId** *(string) --* The ID of the parent domain unit. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_environment_action update_environment_action ************************* DataZone.Client.update_environment_action(**kwargs) Updates an environment action. See also: AWS API Documentation **Request Syntax** response = client.update_environment_action( description='string', domainIdentifier='string', environmentIdentifier='string', identifier='string', name='string', parameters={ 'awsConsoleLink': { 'uri': 'string' } } ) Parameters: * **description** (*string*) -- The description of the environment action. * **domainIdentifier** (*string*) -- **[REQUIRED]** The domain ID of the environment action. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The environment ID of the environment action. * **identifier** (*string*) -- **[REQUIRED]** The ID of the environment action. * **name** (*string*) -- The name of the environment action. * **parameters** (*dict*) -- The parameters of the environment action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "awsConsoleLink". * **awsConsoleLink** *(dict) --* The console link specified as part of the environment action. * **uri** *(string) --* The URI of the console link specified as part of the environment action. Return type: dict Returns: **Response Syntax** { 'description': 'string', 'domainId': 'string', 'environmentId': 'string', 'id': 'string', 'name': 'string', 'parameters': { 'awsConsoleLink': { 'uri': 'string' } } } **Response Structure** * *(dict) --* * **description** *(string) --* The description of the environment action. * **domainId** *(string) --* The domain ID of the environment action. * **environmentId** *(string) --* The environment ID of the environment action. * **id** *(string) --* The ID of the environment action. * **name** *(string) --* The name of the environment action. * **parameters** *(dict) --* The parameters of the environment action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "awsConsoleLink". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **awsConsoleLink** *(dict) --* The console link specified as part of the environment action. * **uri** *(string) --* The URI of the console link specified as part of the environment action. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_project_memberships list_project_memberships ************************ DataZone.Client.list_project_memberships(**kwargs) Lists all members of the specified project. See also: AWS API Documentation **Request Syntax** response = client.list_project_memberships( domainIdentifier='string', maxResults=123, nextToken='string', projectIdentifier='string', sortBy='NAME', sortOrder='ASCENDING'|'DESCENDING' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which you want to list project memberships. * **maxResults** (*integer*) -- The maximum number of memberships to return in a single call to "ListProjectMemberships". When the number of memberships to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListProjectMemberships" to list the next set of memberships. * **nextToken** (*string*) -- When the number of memberships is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of memberships, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListProjectMemberships" to list the next set of memberships. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the project whose memberships you want to list. * **sortBy** (*string*) -- The method by which you want to sort the project memberships. * **sortOrder** (*string*) -- The sort order of the project memberships. Return type: dict Returns: **Response Syntax** { 'members': [ { 'designation': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD', 'memberDetails': { 'group': { 'groupId': 'string' }, 'user': { 'userId': 'string' } } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **members** *(list) --* The members of the project. * *(dict) --* The details of a project member. * **designation** *(string) --* The designated role of a project member. * **memberDetails** *(dict) --* The membership details of a project member. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "group", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **group** *(dict) --* The group details of a project member. * **groupId** *(string) --* The identifier of the group in Amazon DataZone. * **user** *(dict) --* The user details of a project member. * **userId** *(string) --* The identifier of the Amazon DataZone user. * **nextToken** *(string) --* When the number of memberships is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of memberships, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListProjectMemberships" to list the next set of memberships. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_domain_unit delete_domain_unit ****************** DataZone.Client.delete_domain_unit(**kwargs) Deletes a domain unit. See also: AWS API Documentation **Request Syntax** response = client.delete_domain_unit( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to delete a domain unit. * **identifier** (*string*) -- **[REQUIRED]** The ID of the domain unit that you want to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_asset get_asset ********* DataZone.Client.get_asset(**kwargs) Gets an Amazon DataZone asset. See also: AWS API Documentation **Request Syntax** response = client.get_asset( domainIdentifier='string', identifier='string', revision='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain to which the asset belongs. * **identifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone asset. This parameter supports either the value of "assetId" or "externalIdentifier" as input. If you are passing the value of "externalIdentifier", you must prefix this value with "externalIdentifer%2F". * **revision** (*string*) -- The revision of the Amazon DataZone asset. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'externalIdentifier': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'latestTimeSeriesDataPointFormsOutput': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'listing': { 'listingId': 'string', 'listingStatus': 'CREATING'|'ACTIVE'|'INACTIVE' }, 'name': 'string', 'owningProjectId': 'string', 'readOnlyFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'revision': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the asset was created. * **createdBy** *(string) --* The Amazon DataZone user who created the asset. * **description** *(string) --* The description of the Amazon DataZone asset. * **domainId** *(string) --* The ID of the Amazon DataZone domain to which the asset belongs. * **externalIdentifier** *(string) --* The external ID of the asset. * **firstRevisionCreatedAt** *(datetime) --* The timestamp of when the first revision of the asset was created. * **firstRevisionCreatedBy** *(string) --* The Amazon DataZone user who created the first revision of the asset. * **formsOutput** *(list) --* The metadata forms attached to the asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** *(list) --* The business glossary terms attached to the asset. * *(string) --* * **id** *(string) --* The ID of the asset. * **latestTimeSeriesDataPointFormsOutput** *(list) --* The latest data point that was imported into the time series form for the asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **listing** *(dict) --* The listing of the asset. * **listingId** *(string) --* The identifier of an asset published in an Amazon DataZone catalog. * **listingStatus** *(string) --* The status of an asset published in an Amazon DataZone catalog. * **name** *(string) --* The name of the asset. * **owningProjectId** *(string) --* The ID of the project that owns the asset. * **readOnlyFormsOutput** *(list) --* The read-only metadata forms attached to the asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **revision** *(string) --* The revision of the asset. * **typeIdentifier** *(string) --* The ID of the asset type. * **typeRevision** *(string) --* The revision of the asset type. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / post_time_series_data_points post_time_series_data_points **************************** DataZone.Client.post_time_series_data_points(**kwargs) Posts time series data points to Amazon DataZone for the specified asset. See also: AWS API Documentation **Request Syntax** response = client.post_time_series_data_points( clientToken='string', domainIdentifier='string', entityIdentifier='string', entityType='ASSET'|'LISTING', forms=[ { 'content': 'string', 'formName': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ] ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which you want to post time series data points. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the asset for which you want to post time series data points. * **entityType** (*string*) -- **[REQUIRED]** The type of the asset for which you want to post data points. * **forms** (*list*) -- **[REQUIRED]** The forms that contain the data points that you want to post. * *(dict) --* The time series data points form. * **content** *(string) --* The content of the time series data points form. * **formName** *(string) --* **[REQUIRED]** The name of the time series data points form. * **timestamp** *(datetime) --* **[REQUIRED]** The timestamp of the time series data points form. * **typeIdentifier** *(string) --* **[REQUIRED]** The ID of the type of the time series data points form. * **typeRevision** *(string) --* The revision type of the time series data points form. Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'entityId': 'string', 'entityType': 'ASSET'|'LISTING', 'forms': [ { 'content': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ] } **Response Structure** * *(dict) --* * **domainId** *(string) --* The ID of the Amazon DataZone domain in which you want to post time series data points. * **entityId** *(string) --* The ID of the asset for which you want to post time series data points. * **entityType** *(string) --* The type of the asset for which you want to post data points. * **forms** *(list) --* The forms that contain the data points that you have posted. * *(dict) --* The time series data points form. * **content** *(string) --* The content of the time series data points form. * **formName** *(string) --* The name of the time series data points form. * **id** *(string) --* The ID of the time series data points form. * **timestamp** *(datetime) --* The timestamp of the time series data points form. * **typeIdentifier** *(string) --* The ID of the type of the time series data points form. * **typeRevision** *(string) --* The revision type of the time series data points form. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_asset_revisions list_asset_revisions ******************** DataZone.Client.list_asset_revisions(**kwargs) Lists the revisions for the asset. See also: AWS API Documentation **Request Syntax** response = client.list_asset_revisions( domainIdentifier='string', identifier='string', maxResults=123, nextToken='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the domain. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the asset. * **maxResults** (*integer*) -- The maximum number of revisions to return in a single call to "ListAssetRevisions". When the number of revisions to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListAssetRevisions" to list the next set of revisions. * **nextToken** (*string*) -- When the number of revisions is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of revisions, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListAssetRevisions" to list the next set of revisions. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'revision': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListAssetRevisions" action. * *(dict) --* The revision of an inventory asset. * **createdAt** *(datetime) --* The timestamp of when an inventory asset revison was created. * **createdBy** *(string) --* The Amazon DataZone user who created the asset revision. * **domainId** *(string) --* The Amazon DataZone user who created the inventory asset. * **id** *(string) --* The identifier of the inventory asset revision. * **revision** *(string) --* The revision details of the inventory asset. * **nextToken** *(string) --* When the number of revisions is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of revisions, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListAssetRevisions" to list the next set of revisions. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_environment_profiles list_environment_profiles ************************* DataZone.Client.list_environment_profiles(**kwargs) Lists Amazon DataZone environment profiles. See also: AWS API Documentation **Request Syntax** response = client.list_environment_profiles( awsAccountId='string', awsAccountRegion='string', domainIdentifier='string', environmentBlueprintIdentifier='string', maxResults=123, name='string', nextToken='string', projectIdentifier='string' ) Parameters: * **awsAccountId** (*string*) -- The identifier of the Amazon Web Services account where you want to list environment profiles. * **awsAccountRegion** (*string*) -- The Amazon Web Services region where you want to list environment profiles. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **environmentBlueprintIdentifier** (*string*) -- The identifier of the blueprint that was used to create the environment profiles that you want to list. * **maxResults** (*integer*) -- The maximum number of environment profiles to return in a single call to "ListEnvironmentProfiles". When the number of environment profiles to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListEnvironmentProfiles" to list the next set of environment profiles. * **name** (*string*) * **nextToken** (*string*) -- When the number of environment profiles is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of environment profiles, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEnvironmentProfiles" to list the next set of environment profiles. * **projectIdentifier** (*string*) -- The identifier of the Amazon DataZone project. Return type: dict Returns: **Response Syntax** { 'items': [ { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListEnvironmentProfiles" action. * *(dict) --* The details of an environment profile. * **awsAccountId** *(string) --* The identifier of an Amazon Web Services account in which an environment profile exists. * **awsAccountRegion** *(string) --* The Amazon Web Services Region in which an environment profile exists. * **createdAt** *(datetime) --* The timestamp of when an environment profile was created. * **createdBy** *(string) --* The Amazon DataZone user who created the environment profile. * **description** *(string) --* The description of the environment profile. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the environment profile exists. * **environmentBlueprintId** *(string) --* The identifier of a blueprint with which an environment profile is created. * **id** *(string) --* The identifier of the environment profile. * **name** *(string) --* The name of the environment profile. * **projectId** *(string) --* The identifier of a project in which an environment profile exists. * **updatedAt** *(datetime) --* The timestamp of when the environment profile was updated. * **nextToken** *(string) --* When the number of environment profiles is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of environment profiles, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEnvironmentProfiles" to list the next set of environment profiles. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_tags_for_resource list_tags_for_resource ********************** DataZone.Client.list_tags_for_resource(**kwargs) Lists tags for the specified resource in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource whose tags you want to list. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The tags of the specified resource. * *(string) --* * *(string) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_job_runs list_job_runs ************* DataZone.Client.list_job_runs(**kwargs) Lists job runs. See also: AWS API Documentation **Request Syntax** response = client.list_job_runs( domainIdentifier='string', jobIdentifier='string', maxResults=123, nextToken='string', sortOrder='ASCENDING'|'DESCENDING', status='SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list job runs. * **jobIdentifier** (*string*) -- **[REQUIRED]** The ID of the job run. * **maxResults** (*integer*) -- The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs. * **nextToken** (*string*) -- When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs. * **sortOrder** (*string*) -- Specifies the order in which job runs are to be sorted. * **status** (*string*) -- The status of a job run. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'endTime': datetime(2015, 1, 1), 'error': { 'message': 'string' }, 'jobId': 'string', 'jobType': 'LINEAGE', 'runId': 'string', 'runMode': 'SCHEDULED'|'ON_DEMAND', 'startTime': datetime(2015, 1, 1), 'status': 'SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListJobRuns action. * *(dict) --* The job run summary. * **createdAt** *(datetime) --* The timestamp at which job run was created. * **createdBy** *(string) --* The user who created the job run. * **domainId** *(string) --* The domain ID of the job run. * **endTime** *(datetime) --* The end time of a job run. * **error** *(dict) --* The error of a job run. * **message** *(string) --* The job run error message. * **jobId** *(string) --* The job ID of a job run. * **jobType** *(string) --* The job type of a job run. * **runId** *(string) --* The run ID of a job run. * **runMode** *(string) --* The run mode of a job run. * **startTime** *(datetime) --* The start time of a job run. * **status** *(string) --* The status of a job run. * **nextToken** *(string) --* When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / put_environment_blueprint_configuration put_environment_blueprint_configuration *************************************** DataZone.Client.put_environment_blueprint_configuration(**kwargs) Writes the configuration for the specified environment blueprint in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.put_environment_blueprint_configuration( domainIdentifier='string', enabledRegions=[ 'string', ], environmentBlueprintIdentifier='string', environmentRolePermissionBoundary='string', manageAccessRoleArn='string', provisioningConfigurations=[ { 'lakeFormationConfiguration': { 'locationRegistrationExcludeS3Locations': [ 'string', ], 'locationRegistrationRole': 'string' } }, ], provisioningRoleArn='string', regionalParameters={ 'string': { 'string': 'string' } } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **enabledRegions** (*list*) -- **[REQUIRED]** Specifies the enabled Amazon Web Services Regions. * *(string) --* * **environmentBlueprintIdentifier** (*string*) -- **[REQUIRED]** The identifier of the environment blueprint. * **environmentRolePermissionBoundary** (*string*) -- The environment role permissions boundary. * **manageAccessRoleArn** (*string*) -- The ARN of the manage access role. * **provisioningConfigurations** (*list*) -- The provisioning configuration of a blueprint. * *(dict) --* The provisioning configuration of the blueprint. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "lakeFormationConfiguration". * **lakeFormationConfiguration** *(dict) --* The Lake Formation configuration of the Data Lake blueprint. * **locationRegistrationExcludeS3Locations** *(list) --* Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode. * *(string) --* * **locationRegistrationRole** *(string) --* The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode. * **provisioningRoleArn** (*string*) -- The ARN of the provisioning role. * **regionalParameters** (*dict*) -- The regional parameters in the environment blueprint. * *(string) --* * *(dict) --* * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'domainId': 'string', 'enabledRegions': [ 'string', ], 'environmentBlueprintId': 'string', 'environmentRolePermissionBoundary': 'string', 'manageAccessRoleArn': 'string', 'provisioningConfigurations': [ { 'lakeFormationConfiguration': { 'locationRegistrationExcludeS3Locations': [ 'string', ], 'locationRegistrationRole': 'string' } }, ], 'provisioningRoleArn': 'string', 'regionalParameters': { 'string': { 'string': 'string' } }, 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the environment blueprint was created. * **domainId** *(string) --* The identifier of the Amazon DataZone domain. * **enabledRegions** *(list) --* Specifies the enabled Amazon Web Services Regions. * *(string) --* * **environmentBlueprintId** *(string) --* The identifier of the environment blueprint. * **environmentRolePermissionBoundary** *(string) --* The environment role permissions boundary. * **manageAccessRoleArn** *(string) --* The ARN of the manage access role. * **provisioningConfigurations** *(list) --* The provisioning configuration of a blueprint. * *(dict) --* The provisioning configuration of the blueprint. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "lakeFormationConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **lakeFormationConfiguration** *(dict) --* The Lake Formation configuration of the Data Lake blueprint. * **locationRegistrationExcludeS3Locations** *(list) --* Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode. * *(string) --* * **locationRegistrationRole** *(string) --* The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode. * **provisioningRoleArn** *(string) --* The ARN of the provisioning role. * **regionalParameters** *(dict) --* The regional parameters in the environment blueprint. * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **updatedAt** *(datetime) --* The timestamp of when the environment blueprint was updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_iam_portal_login_url get_iam_portal_login_url ************************ DataZone.Client.get_iam_portal_login_url(**kwargs) Gets the data portal URL for the specified Amazon DataZone domain. See also: AWS API Documentation **Request Syntax** response = client.get_iam_portal_login_url( domainIdentifier='string' ) Parameters: **domainIdentifier** (*string*) -- **[REQUIRED]** the ID of the Amazon DataZone domain the data portal of which you want to get. Return type: dict Returns: **Response Syntax** { 'authCodeUrl': 'string', 'userProfileId': 'string' } **Response Structure** * *(dict) --* * **authCodeUrl** *(string) --* The data portal URL of the specified Amazon DataZone domain. * **userProfileId** *(string) --* The ID of the user profile. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / add_policy_grant add_policy_grant **************** DataZone.Client.add_policy_grant(**kwargs) Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles. See also: AWS API Documentation **Request Syntax** response = client.add_policy_grant( clientToken='string', detail={ 'addToProjectMemberPool': { 'includeChildDomainUnits': True|False }, 'createAssetType': { 'includeChildDomainUnits': True|False }, 'createDomainUnit': { 'includeChildDomainUnits': True|False }, 'createEnvironment': {} , 'createEnvironmentFromBlueprint': {} , 'createEnvironmentProfile': { 'domainUnitId': 'string' }, 'createFormType': { 'includeChildDomainUnits': True|False }, 'createGlossary': { 'includeChildDomainUnits': True|False }, 'createProject': { 'includeChildDomainUnits': True|False }, 'createProjectFromProjectProfile': { 'includeChildDomainUnits': True|False, 'projectProfiles': [ 'string', ] }, 'delegateCreateEnvironmentProfile': {} , 'overrideDomainUnitOwners': { 'includeChildDomainUnits': True|False }, 'overrideProjectOwners': { 'includeChildDomainUnits': True|False }, 'useAssetType': { 'domainUnitId': 'string' } }, domainIdentifier='string', entityIdentifier='string', entityType='DOMAIN_UNIT'|'ENVIRONMENT_BLUEPRINT_CONFIGURATION'|'ENVIRONMENT_PROFILE'|'ASSET_TYPE', policyType='CREATE_DOMAIN_UNIT'|'OVERRIDE_DOMAIN_UNIT_OWNERS'|'ADD_TO_PROJECT_MEMBER_POOL'|'OVERRIDE_PROJECT_OWNERS'|'CREATE_GLOSSARY'|'CREATE_FORM_TYPE'|'CREATE_ASSET_TYPE'|'CREATE_PROJECT'|'CREATE_ENVIRONMENT_PROFILE'|'DELEGATE_CREATE_ENVIRONMENT_PROFILE'|'CREATE_ENVIRONMENT'|'CREATE_ENVIRONMENT_FROM_BLUEPRINT'|'CREATE_PROJECT_FROM_PROJECT_PROFILE'|'USE_ASSET_TYPE', principal={ 'domainUnit': { 'domainUnitDesignation': 'OWNER', 'domainUnitGrantFilter': { 'allDomainUnitsGrantFilter': {} }, 'domainUnitIdentifier': 'string' }, 'group': { 'groupIdentifier': 'string' }, 'project': { 'projectDesignation': 'OWNER'|'CONTRIBUTOR'|'PROJECT_CATALOG_STEWARD', 'projectGrantFilter': { 'domainUnitFilter': { 'domainUnit': 'string', 'includeChildDomainUnits': True|False } }, 'projectIdentifier': 'string' }, 'user': { 'allUsersGrantFilter': {} , 'userIdentifier': 'string' } } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **detail** (*dict*) -- **[REQUIRED]** The details of the policy grant. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "addToProjectMemberPool", "createAssetType", "createDomainUnit", "createEnvironment", "createEnvironmentFromBlueprint", "createEnvironmentProfile", "createFormType", "createGlossary", "createProject", "createProjectFromProjectProfile", "delegateCreateEnvironmentProfile", "overrideDomainUnitOwners", "overrideProjectOwners", "useAssetType". * **addToProjectMemberPool** *(dict) --* Specifies that the policy grant is to be added to the members of the project. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createAssetType** *(dict) --* Specifies that this is a create asset type policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createDomainUnit** *(dict) --* Specifies that this is a create domain unit policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createEnvironment** *(dict) --* Specifies that this is a create environment policy. * **createEnvironmentFromBlueprint** *(dict) --* The details of the policy of creating an environment. * **createEnvironmentProfile** *(dict) --* Specifies that this is a create environment profile policy. * **domainUnitId** *(string) --* The ID of the domain unit. * **createFormType** *(dict) --* Specifies that this is a create form type policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createGlossary** *(dict) --* Specifies that this is a create glossary policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createProject** *(dict) --* Specifies that this is a create project policy. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy grant is applied to child domain units. * **createProjectFromProjectProfile** *(dict) --* Specifies whether to create a project from project profile. * **includeChildDomainUnits** *(boolean) --* Specifies whether to include child domain units when creating a project from project profile policy grant details * **projectProfiles** *(list) --* Specifies project profiles when creating a project from project profile policy grant details * *(string) --* * **delegateCreateEnvironmentProfile** *(dict) --* Specifies that this is the delegation of the create environment profile policy. * **overrideDomainUnitOwners** *(dict) --* Specifies whether to override domain unit owners. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy is inherited by child domain units. * **overrideProjectOwners** *(dict) --* Specifies whether to override project owners. * **includeChildDomainUnits** *(boolean) --* Specifies whether the policy is inherited by child domain units. * **useAssetType** *(dict) --* Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions. * **domainUnitId** *(string) --* The ID of the domain unit. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to add a policy grant. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the entity (resource) to which you want to add a policy grant. * **entityType** (*string*) -- **[REQUIRED]** The type of entity (resource) to which the grant is added. * **policyType** (*string*) -- **[REQUIRED]** The type of policy that you want to grant. * **principal** (*dict*) -- **[REQUIRED]** The principal to whom the permissions are granted. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "domainUnit", "group", "project", "user". * **domainUnit** *(dict) --* The domain unit of the policy grant principal. * **domainUnitDesignation** *(string) --* **[REQUIRED]** Specifes the designation of the domain unit users. * **domainUnitGrantFilter** *(dict) --* The grant filter for the domain unit. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "allDomainUnitsGrantFilter". * **allDomainUnitsGrantFilter** *(dict) --* Specifies a grant filter containing all domain units. * **domainUnitIdentifier** *(string) --* The ID of the domain unit. * **group** *(dict) --* The group of the policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "groupIdentifier". * **groupIdentifier** *(string) --* The ID Of the group of the group principal. * **project** *(dict) --* The project of the policy grant principal. * **projectDesignation** *(string) --* **[REQUIRED]** The project designation of the project policy grant principal. * **projectGrantFilter** *(dict) --* The project grant filter of the project policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "domainUnitFilter". * **domainUnitFilter** *(dict) --* The domain unit filter of the project grant filter. * **domainUnit** *(string) --* **[REQUIRED]** The domain unit ID to use in the filter. * **includeChildDomainUnits** *(boolean) --* Specifies whether to include child domain units. * **projectIdentifier** *(string) --* The project ID of the project policy grant principal. * **user** *(dict) --* The user of the policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "allUsersGrantFilter", "userIdentifier". * **allUsersGrantFilter** *(dict) --* The all users grant filter of the user policy grant principal. * **userIdentifier** *(string) --* The user ID of the user policy grant principal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_project_membership delete_project_membership ************************* DataZone.Client.delete_project_membership(**kwargs) Deletes project membership in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_project_membership( domainIdentifier='string', member={ 'groupIdentifier': 'string', 'userIdentifier': 'string' }, projectIdentifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where project membership is deleted. * **member** (*dict*) -- **[REQUIRED]** The project member whose project membership is deleted. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "groupIdentifier", "userIdentifier". * **groupIdentifier** *(string) --* The ID of the group of a project member. * **userIdentifier** *(string) --* The user ID of a project member. * **projectIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone project the membership to which is deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_rule get_rule ******** DataZone.Client.get_rule(**kwargs) Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards. See also: AWS API Documentation **Request Syntax** response = client.get_rule( domainIdentifier='string', identifier='string', revision='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where the "GetRule" action is to be invoked. * **identifier** (*string*) -- **[REQUIRED]** The ID of the rule. * **revision** (*string*) -- The revision of the rule. Return type: dict Returns: **Response Syntax** { 'action': 'CREATE_LISTING_CHANGE_SET'|'CREATE_SUBSCRIPTION_REQUEST', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'detail': { 'metadataFormEnforcementDetail': { 'requiredMetadataForms': [ { 'typeIdentifier': 'string', 'typeRevision': 'string' }, ] } }, 'identifier': 'string', 'lastUpdatedBy': 'string', 'name': 'string', 'revision': 'string', 'ruleType': 'METADATA_FORM_ENFORCEMENT', 'scope': { 'assetType': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificAssetTypes': [ 'string', ] }, 'dataProduct': True|False, 'project': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificProjects': [ 'string', ] } }, 'target': { 'domainUnitTarget': { 'domainUnitId': 'string', 'includeChildDomainUnits': True|False } }, 'targetType': 'DOMAIN_UNIT', 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **action** *(string) --* The action of the rule. * **createdAt** *(datetime) --* The timestamp at which the rule was created. * **createdBy** *(string) --* The user who created the rule. * **description** *(string) --* The description of the rule. * **detail** *(dict) --* The detail of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "metadataFormEnforcementDetail". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **metadataFormEnforcementDetail** *(dict) --* The enforcement detail of the metadata form. * **requiredMetadataForms** *(list) --* The required metadata forms. * *(dict) --* The reference of a metadata form. * **typeIdentifier** *(string) --* The type ID of the metadata form reference. * **typeRevision** *(string) --* The type revision of the metadata form reference. * **identifier** *(string) --* The ID of the rule. * **lastUpdatedBy** *(string) --* The timestamp at which the rule was last updated. * **name** *(string) --* The name of the rule. * **revision** *(string) --* The revision of the rule. * **ruleType** *(string) --* The type of the rule. * **scope** *(dict) --* The scope of the rule. * **assetType** *(dict) --* The asset type included in the rule scope. * **selectionMode** *(string) --* The selection mode for the rule. * **specificAssetTypes** *(list) --* The specific asset types that are included in the rule. * *(string) --* * **dataProduct** *(boolean) --* The data product included in the rule scope. * **project** *(dict) --* The project included in the rule scope. * **selectionMode** *(string) --* The selection mode of the rule. * **specificProjects** *(list) --* The specific projects in which the rule is created. * *(string) --* * **target** *(dict) --* The target of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "domainUnitTarget". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **domainUnitTarget** *(dict) --* The ID of the domain unit. * **domainUnitId** *(string) --* The ID of the domain unit. * **includeChildDomainUnits** *(boolean) --* Specifies whether to apply a rule to the child domain units. * **targetType** *(string) --* The target type of the rule. * **updatedAt** *(datetime) --* The timestamp at which the rule was last updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_environment update_environment ****************** DataZone.Client.update_environment(**kwargs) Updates the specified environment in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_environment( blueprintVersion='string', description='string', domainIdentifier='string', glossaryTerms=[ 'string', ], identifier='string', name='string', userParameters=[ { 'name': 'string', 'value': 'string' }, ] ) Parameters: * **blueprintVersion** (*string*) -- The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: "latest". * **description** (*string*) -- The description to be updated as part of the "UpdateEnvironment" action. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the domain in which the environment is to be updated. * **glossaryTerms** (*list*) -- The glossary terms to be updated as part of the "UpdateEnvironment" action. * *(string) --* * **identifier** (*string*) -- **[REQUIRED]** The identifier of the environment that is to be updated. * **name** (*string*) -- The name to be updated as part of the "UpdateEnvironment" action. * **userParameters** (*list*) -- The user parameters of the environment. * *(dict) --* The parameter details of an evironment profile. * **name** *(string) --* The name of an environment profile parameter. * **value** *(string) --* The value of an environment profile parameter. Return type: dict Returns: **Response Syntax** { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'deploymentProperties': { 'endTimeoutMinutes': 123, 'startTimeoutMinutes': 123 }, 'description': 'string', 'domainId': 'string', 'environmentActions': [ { 'auth': 'IAM'|'HTTPS', 'parameters': [ { 'key': 'string', 'value': 'string' }, ], 'type': 'string' }, ], 'environmentBlueprintId': 'string', 'environmentConfigurationId': 'string', 'environmentProfileId': 'string', 'glossaryTerms': [ 'string', ], 'id': 'string', 'lastDeployment': { 'deploymentId': 'string', 'deploymentStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'PENDING_DEPLOYMENT', 'deploymentType': 'CREATE'|'UPDATE'|'DELETE', 'failureReason': { 'code': 'string', 'message': 'string' }, 'isDeploymentComplete': True|False, 'messages': [ 'string', ] }, 'name': 'string', 'projectId': 'string', 'provider': 'string', 'provisionedResources': [ { 'name': 'string', 'provider': 'string', 'type': 'string', 'value': 'string' }, ], 'provisioningProperties': { 'cloudFormation': { 'templateUrl': 'string' } }, 'status': 'ACTIVE'|'CREATING'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'VALIDATION_FAILED'|'SUSPENDED'|'DISABLED'|'EXPIRED'|'DELETED'|'INACCESSIBLE', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'keyName': 'string' }, ] } **Response Structure** * *(dict) --* * **awsAccountId** *(string) --* The identifier of the Amazon Web Services account in which the environment is to be updated. * **awsAccountRegion** *(string) --* The Amazon Web Services Region in which the environment is updated. * **createdAt** *(datetime) --* The timestamp of when the environment was created. * **createdBy** *(string) --* The Amazon DataZone user who created the environment. * **deploymentProperties** *(dict) --* The deployment properties to be updated as part of the "UpdateEnvironment" action. * **endTimeoutMinutes** *(integer) --* The end timeout of the environment blueprint deployment. * **startTimeoutMinutes** *(integer) --* The start timeout of the environment blueprint deployment. * **description** *(string) --* The description to be updated as part of the "UpdateEnvironment" action. * **domainId** *(string) --* The identifier of the domain in which the environment is to be updated. * **environmentActions** *(list) --* The environment actions to be updated as part of the "UpdateEnvironment" action. * *(dict) --* The configurable action of a Amazon DataZone environment. * **auth** *(string) --* The authentication type of a configurable action of a Amazon DataZone environment. * **parameters** *(list) --* The parameters of a configurable action in a Amazon DataZone environment. * *(dict) --* The details of the parameters for the configurable environment action. * **key** *(string) --* The key of the configurable action parameter. * **value** *(string) --* The value of the configurable action parameter. * **type** *(string) --* The type of a configurable action in a Amazon DataZone environment. * **environmentBlueprintId** *(string) --* The blueprint identifier of the environment. * **environmentConfigurationId** *(string) --* The configuration ID of the environment. * **environmentProfileId** *(string) --* The profile identifier of the environment. * **glossaryTerms** *(list) --* The glossary terms to be updated as part of the "UpdateEnvironment" action. * *(string) --* * **id** *(string) --* The identifier of the environment that is to be updated. * **lastDeployment** *(dict) --* The last deployment of the environment. * **deploymentId** *(string) --* The identifier of the last deployment of the environment. * **deploymentStatus** *(string) --* The status of the last deployment of the environment. * **deploymentType** *(string) --* The type of the last deployment of the environment. * **failureReason** *(dict) --* The failure reason of the last deployment of the environment. * **code** *(string) --* The error code for the failure reason for the environment deployment. * **message** *(string) --* The error message for the failure reason for the environment deployment. * **isDeploymentComplete** *(boolean) --* Specifies whether the last deployment of the environment is complete. * **messages** *(list) --* The messages of the last deployment of the environment. * *(string) --* * **name** *(string) --* The name to be updated as part of the "UpdateEnvironment" action. * **projectId** *(string) --* The project identifier of the environment. * **provider** *(string) --* The provider identifier of the environment. * **provisionedResources** *(list) --* The provisioned resources to be updated as part of the "UpdateEnvironment" action. * *(dict) --* The details of a provisioned resource of this Amazon DataZone environment. * **name** *(string) --* The name of a provisioned resource of this Amazon DataZone environment. * **provider** *(string) --* The provider of a provisioned resource of this Amazon DataZone environment. * **type** *(string) --* The type of a provisioned resource of this Amazon DataZone environment. * **value** *(string) --* The value of a provisioned resource of this Amazon DataZone environment. * **provisioningProperties** *(dict) --* The provisioning properties to be updated as part of the "UpdateEnvironment" action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "cloudFormation". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **cloudFormation** *(dict) --* The cloud formation properties included as part of the provisioning properties of an environment blueprint. * **templateUrl** *(string) --* The template URL of the cloud formation provisioning properties of the environment blueprint. * **status** *(string) --* The status to be updated as part of the "UpdateEnvironment" action. * **updatedAt** *(datetime) --* The timestamp of when the environment was updated. * **userParameters** *(list) --* The user parameters to be updated as part of the "UpdateEnvironment" action. * *(dict) --* The details of user parameters of an environment blueprint. * **defaultValue** *(string) --* The default value of the parameter. * **description** *(string) --* The description of the parameter. * **fieldType** *(string) --* The filed type of the parameter. * **isEditable** *(boolean) --* Specifies whether the parameter is editable. * **isOptional** *(boolean) --* Specifies whether the custom parameter is optional. * **keyName** *(string) --* The key name of the parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_project get_project *********** DataZone.Client.get_project(**kwargs) Gets a project in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_project( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the project exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the project. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentDeploymentDetails': { 'environmentFailureReasons': { 'string': [ { 'code': 'string', 'message': 'string' }, ] }, 'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT' }, 'failureReasons': [ { 'code': 'string', 'message': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'projectProfileId': 'string', 'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED', 'userParameters': [ { 'environmentConfigurationName': 'string', 'environmentId': 'string', 'environmentParameters': [ { 'name': 'string', 'value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the project was created. * **createdBy** *(string) --* The Amazon DataZone user who created the project. * **description** *(string) --* The description of the project. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the project exists. * **domainUnitId** *(string) --* The ID of the domain unit. * **environmentDeploymentDetails** *(dict) --* The environment deployment status of a project. * **environmentFailureReasons** *(dict) --* Environment failure reasons. * *(string) --* * *(list) --* * *(dict) --* The failure reasons for the environment deployment. * **code** *(string) --* The error code for the failure reason for the environment deployment. * **message** *(string) --* The error message for the failure reason for the environment deployment. * **overallDeploymentStatus** *(string) --* The overall deployment status of the environment. * **failureReasons** *(list) --* Specifies the error message that is returned if the operation cannot be successfully completed. * *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **code** *(string) --* The code of the project deletion error. * **message** *(string) --* The message of the project deletion error. * **glossaryTerms** *(list) --* The business glossary terms that can be used in the project. * *(string) --* * **id** *(string) --* >The ID of the project. * **lastUpdatedAt** *(datetime) --* The timestamp of when the project was last updated. * **name** *(string) --* The name of the project. * **projectProfileId** *(string) --* The ID of the project profile of a project. * **projectStatus** *(string) --* The status of the project. * **userParameters** *(list) --* The user parameters of a project. * *(dict) --* The environment configuration user parameters. * **environmentConfigurationName** *(string) --* The environment configuration name. * **environmentId** *(string) --* The ID of the environment. * **environmentParameters** *(list) --* The environment parameters. * *(dict) --* The parameter details of an evironment profile. * **name** *(string) --* The name of an environment profile parameter. * **value** *(string) --* The value of an environment profile parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_domain create_domain ************* DataZone.Client.create_domain(**kwargs) Creates an Amazon DataZone domain. See also: AWS API Documentation **Request Syntax** response = client.create_domain( clientToken='string', description='string', domainExecutionRole='string', domainVersion='V1'|'V2', kmsKeyIdentifier='string', name='string', serviceRole='string', singleSignOn={ 'idcInstanceArn': 'string', 'type': 'IAM_IDC'|'DISABLED', 'userAssignment': 'AUTOMATIC'|'MANUAL' }, tags={ 'string': 'string' } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description of the Amazon DataZone domain. * **domainExecutionRole** (*string*) -- **[REQUIRED]** The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain. * **domainVersion** (*string*) -- The version of the domain that is created. * **kmsKeyIdentifier** (*string*) -- The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. * **name** (*string*) -- **[REQUIRED]** The name of the Amazon DataZone domain. * **serviceRole** (*string*) -- The service role of the domain that is created. * **singleSignOn** (*dict*) -- The single-sign on configuration of the Amazon DataZone domain. * **idcInstanceArn** *(string) --* The ARN of the IDC instance. * **type** *(string) --* The type of single sign-on in Amazon DataZone. * **userAssignment** *(string) --* The single sign-on user assignment in Amazon DataZone. * **tags** (*dict*) -- The tags specified for the Amazon DataZone domain. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string', 'description': 'string', 'domainExecutionRole': 'string', 'domainVersion': 'V1'|'V2', 'id': 'string', 'kmsKeyIdentifier': 'string', 'name': 'string', 'portalUrl': 'string', 'rootDomainUnitId': 'string', 'serviceRole': 'string', 'singleSignOn': { 'idcInstanceArn': 'string', 'type': 'IAM_IDC'|'DISABLED', 'userAssignment': 'AUTOMATIC'|'MANUAL' }, 'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED', 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **arn** *(string) --* The ARN of the Amazon DataZone domain. * **description** *(string) --* The description of the Amazon DataZone domain. * **domainExecutionRole** *(string) --* The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain. * **domainVersion** *(string) --* The version of the domain that is created. * **id** *(string) --* The identifier of the Amazon DataZone domain. * **kmsKeyIdentifier** *(string) --* The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. * **name** *(string) --* The name of the Amazon DataZone domain. * **portalUrl** *(string) --* The URL of the data portal for this Amazon DataZone domain. * **rootDomainUnitId** *(string) --* The ID of the root domain unit. * **serviceRole** *(string) --* Te service role of the domain that is created. * **singleSignOn** *(dict) --* The single-sign on configuration of the Amazon DataZone domain. * **idcInstanceArn** *(string) --* The ARN of the IDC instance. * **type** *(string) --* The type of single sign-on in Amazon DataZone. * **userAssignment** *(string) --* The single sign-on user assignment in Amazon DataZone. * **status** *(string) --* The status of the Amazon DataZone domain. * **tags** *(dict) --* The tags specified for the Amazon DataZone domain. * *(string) --* * *(string) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_projects list_projects ************* DataZone.Client.list_projects(**kwargs) Lists Amazon DataZone projects. See also: AWS API Documentation **Request Syntax** response = client.list_projects( domainIdentifier='string', groupIdentifier='string', maxResults=123, name='string', nextToken='string', userIdentifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **groupIdentifier** (*string*) -- The identifier of a group. * **maxResults** (*integer*) -- The maximum number of projects to return in a single call to "ListProjects". When the number of projects to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListProjects" to list the next set of projects. * **name** (*string*) -- The name of the project. * **nextToken** (*string*) -- When the number of projects is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of projects, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListProjects" to list the next set of projects. * **userIdentifier** (*string*) -- The identifier of the Amazon DataZone user. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'failureReasons': [ { 'code': 'string', 'message': 'string' }, ], 'id': 'string', 'name': 'string', 'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListProjects" action. * *(dict) --* The details of a Amazon DataZone project. * **createdAt** *(datetime) --* The timestamp of when a project was created. * **createdBy** *(string) --* The Amazon DataZone user who created the project. * **description** *(string) --* The description of a project. * **domainId** *(string) --* The identifier of a Amazon DataZone domain where the project exists. * **domainUnitId** *(string) --* The ID of the domain unit. * **failureReasons** *(list) --* Specifies the error message that is returned if the operation cannot be successfully completed. * *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **code** *(string) --* The code of the project deletion error. * **message** *(string) --* The message of the project deletion error. * **id** *(string) --* The identifier of a project. * **name** *(string) --* The name of a project. * **projectStatus** *(string) --* The status of the project. * **updatedAt** *(datetime) --* The timestamp of when the project was updated. * **nextToken** *(string) --* When the number of projects is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of projects, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListProjects" to list the next set of projects. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / search_types search_types ************ DataZone.Client.search_types(**kwargs) Searches for types in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.search_types( domainIdentifier='string', filters={ 'and': [ {'... recursive ...'}, ], 'filter': { 'attribute': 'string', 'value': 'string' }, 'or': [ {'... recursive ...'}, ] }, managed=True|False, maxResults=123, nextToken='string', searchIn=[ { 'attribute': 'string' }, ], searchScope='ASSET_TYPE'|'FORM_TYPE'|'LINEAGE_NODE_TYPE', searchText='string', sort={ 'attribute': 'string', 'order': 'ASCENDING'|'DESCENDING' } ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to invoke the "SearchTypes" action. * **filters** (*dict*) -- The filters for the "SearchTypes" action. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **and** *(list) --* The 'and' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **filter** *(dict) --* A search filter in Amazon DataZone. * **attribute** *(string) --* **[REQUIRED]** A search filter attribute in Amazon DataZone. * **value** *(string) --* **[REQUIRED]** A search filter value in Amazon DataZone. * **or** *(list) --* The 'or' search filter clause in Amazon DataZone. * *(dict) --* A search filter clause in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "filter", "or". * **managed** (*boolean*) -- **[REQUIRED]** Specifies whether the search is managed. * **maxResults** (*integer*) -- The maximum number of results to return in a single call to "SearchTypes". When the number of results to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "SearchTypes" to list the next set of results. * **nextToken** (*string*) -- When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchTypes" to list the next set of results. * **searchIn** (*list*) -- The details of the search. * *(dict) --* The details of the search. * **attribute** *(string) --* **[REQUIRED]** The search attribute. * **searchScope** (*string*) -- **[REQUIRED]** Specifies the scope of the search for types. * **searchText** (*string*) -- Specifies the text for which to search. * **sort** (*dict*) -- The specifies the way to sort the "SearchTypes" results. * **attribute** *(string) --* **[REQUIRED]** The attribute detail of the way to sort search results. * **order** *(string) --* The order detail of the wya to sort search results. Return type: dict Returns: **Response Syntax** { 'items': [ { 'assetTypeItem': { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'formsOutput': { 'string': { 'required': True|False, 'typeName': 'string', 'typeRevision': 'string' } }, 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, 'formTypeItem': { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'imports': [ { 'name': 'string', 'revision': 'string' }, ], 'model': { 'smithy': 'string' }, 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string', 'status': 'ENABLED'|'DISABLED' }, 'lineageNodeTypeItem': { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'formsOutput': { 'string': { 'required': True|False, 'typeName': 'string', 'typeRevision': 'string' } }, 'name': 'string', 'revision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } }, ], 'nextToken': 'string', 'totalMatchCount': 123 } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "SearchTypes" action. * *(dict) --* The details of the results of the "SearchTypes" action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetTypeItem", "formTypeItem", "lineageNodeTypeItem". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetTypeItem** *(dict) --* The asset type included in the results of the "SearchTypes" action. * **createdAt** *(datetime) --* The timestamp of when the asset type was created. * **createdBy** *(string) --* The Amazon DataZone user who created the asset type. * **description** *(string) --* The description of the asset type. * **domainId** *(string) --* The identifier of the Amazon DataZone domain where the asset type exists. * **formsOutput** *(dict) --* The forms included in the details of the asset type. * *(string) --* * *(dict) --* The details of the form entry. * **required** *(boolean) --* Specifies whether a form entry is required. * **typeName** *(string) --* The name of the type of the form entry. * **typeRevision** *(string) --* The type revision of the form entry. * **name** *(string) --* The name of the asset type. * **originDomainId** *(string) --* The identifier of the Amazon DataZone domain where the asset type was originally created. * **originProjectId** *(string) --* The identifier of the Amazon DataZone project where the asset type exists. * **owningProjectId** *(string) --* The identifier of the Amazon DataZone project that owns the asset type. * **revision** *(string) --* The revision of the asset type. * **updatedAt** *(datetime) --* The timestamp of when the asset type was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the asset type. * **formTypeItem** *(dict) --* The form type included in the results of the "SearchTypes" action. * **createdAt** *(datetime) --* The timestamp of when the metadata form type was created. * **createdBy** *(string) --* The Amazon DataZone user who created teh metadata form type. * **description** *(string) --* The description of the metadata form type. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the form type exists. * **imports** *(list) --* The imports specified in the form type. * *(dict) --* The details of the import of the metadata form type. * **name** *(string) --* The name of the import. * **revision** *(string) --* The revision of the import. * **model** *(dict) --* The model of the form type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "smithy". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **smithy** *(string) --* Indicates the smithy model of the API. * **name** *(string) --* The name of the form type. * **originDomainId** *(string) --* The identifier of the Amazon DataZone domain in which the form type was originally created. * **originProjectId** *(string) --* The identifier of the project in which the form type was originally created. * **owningProjectId** *(string) --* The identifier of the project that owns the form type. * **revision** *(string) --* The revision of the form type. * **status** *(string) --* The status of the form type. * **lineageNodeTypeItem** *(dict) --* The details of a data lineage node type. * **createdAt** *(datetime) --* The timestamp at which the data lineage node type was created. * **createdBy** *(string) --* The user who created the data lineage node type. * **description** *(string) --* The description of the data lineage node type. * **domainId** *(string) --* The ID of the domain where the data lineage node type lives. * **formsOutput** *(dict) --* The forms output of the data lineage node type. * *(string) --* * *(dict) --* The details of the form entry. * **required** *(boolean) --* Specifies whether a form entry is required. * **typeName** *(string) --* The name of the type of the form entry. * **typeRevision** *(string) --* The type revision of the form entry. * **name** *(string) --* The name of the data lineage node type. * **revision** *(string) --* The revision of the data lineage node type. * **updatedAt** *(datetime) --* The timestamp at which the data lineage node type was updated. * **updatedBy** *(string) --* The user who updated the data lineage node type. * **nextToken** *(string) --* When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchTypes" to list the next set of results. * **totalMatchCount** *(integer) --* Total number of search results. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / untag_resource untag_resource ************** DataZone.Client.untag_resource(**kwargs) Untags a resource in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceArn='string', tagKeys=[ 'string', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource to be untagged in Amazon DataZone. * **tagKeys** (*list*) -- **[REQUIRED]** Specifies the tag keys for the "UntagResource" action. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_domain delete_domain ************* DataZone.Client.delete_domain(**kwargs) Deletes a Amazon DataZone domain. See also: AWS API Documentation **Request Syntax** response = client.delete_domain( clientToken='string', identifier='string', skipDeletionCheck=True|False ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon Web Services domain that is to be deleted. * **skipDeletionCheck** (*boolean*) -- Specifies the optional flag to delete all child entities within the domain. Return type: dict Returns: **Response Syntax** { 'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED' } **Response Structure** * *(dict) --* * **status** *(string) --* The status of the domain. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_domain update_domain ************* DataZone.Client.update_domain(**kwargs) Updates a Amazon DataZone domain. See also: AWS API Documentation **Request Syntax** response = client.update_domain( clientToken='string', description='string', domainExecutionRole='string', identifier='string', name='string', serviceRole='string', singleSignOn={ 'idcInstanceArn': 'string', 'type': 'IAM_IDC'|'DISABLED', 'userAssignment': 'AUTOMATIC'|'MANUAL' } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description to be updated as part of the "UpdateDomain" action. * **domainExecutionRole** (*string*) -- The domain execution role to be updated as part of the "UpdateDomain" action. * **identifier** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services domain that is to be updated. * **name** (*string*) -- The name to be updated as part of the "UpdateDomain" action. * **serviceRole** (*string*) -- The service role of the domain. * **singleSignOn** (*dict*) -- The single sign-on option to be updated as part of the "UpdateDomain" action. * **idcInstanceArn** *(string) --* The ARN of the IDC instance. * **type** *(string) --* The type of single sign-on in Amazon DataZone. * **userAssignment** *(string) --* The single sign-on user assignment in Amazon DataZone. Return type: dict Returns: **Response Syntax** { 'description': 'string', 'domainExecutionRole': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'rootDomainUnitId': 'string', 'serviceRole': 'string', 'singleSignOn': { 'idcInstanceArn': 'string', 'type': 'IAM_IDC'|'DISABLED', 'userAssignment': 'AUTOMATIC'|'MANUAL' } } **Response Structure** * *(dict) --* * **description** *(string) --* The description to be updated as part of the "UpdateDomain" action. * **domainExecutionRole** *(string) --* The domain execution role to be updated as part of the "UpdateDomain" action. * **id** *(string) --* The identifier of the Amazon DataZone domain. * **lastUpdatedAt** *(datetime) --* Specifies the timestamp of when the domain was last updated. * **name** *(string) --* The name to be updated as part of the "UpdateDomain" action. * **rootDomainUnitId** *(string) --* The ID of the root domain unit. * **serviceRole** *(string) --* The service role of the domain. * **singleSignOn** *(dict) --* The single sign-on option of the Amazon DataZone domain. * **idcInstanceArn** *(string) --* The ARN of the IDC instance. * **type** *(string) --* The type of single sign-on in Amazon DataZone. * **userAssignment** *(string) --* The single sign-on user assignment in Amazon DataZone. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_connection get_connection ************** DataZone.Client.get_connection(**kwargs) Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. See also: AWS API Documentation **Request Syntax** response = client.get_connection( domainIdentifier='string', identifier='string', withSecret=True|False ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where we get the connection. * **identifier** (*string*) -- **[REQUIRED]** The connection ID. * **withSecret** (*boolean*) -- Specifies whether a connection has a secret. Return type: dict Returns: **Response Syntax** { 'connectionCredentials': { 'accessKeyId': 'string', 'expiration': datetime(2015, 1, 1), 'secretAccessKey': 'string', 'sessionToken': 'string' }, 'connectionId': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentId': 'string', 'environmentUserRole': 'string', 'name': 'string', 'physicalEndpoints': [ { 'awsLocation': { 'accessRole': 'string', 'awsAccountId': 'string', 'awsRegion': 'string', 'iamConnectionId': 'string' }, 'glueConnection': { 'athenaProperties': { 'string': 'string' }, 'authenticationConfiguration': { 'authenticationType': 'BASIC'|'OAUTH2'|'CUSTOM', 'oAuth2Properties': { 'authorizationCodeProperties': { 'authorizationCode': 'string', 'redirectUri': 'string' }, 'oAuth2ClientApplication': { 'aWSManagedClientApplicationReference': 'string', 'userManagedClientApplicationClientId': 'string' }, 'oAuth2Credentials': { 'accessToken': 'string', 'jwtToken': 'string', 'refreshToken': 'string', 'userManagedClientApplicationClientSecret': 'string' }, 'oAuth2GrantType': 'AUTHORIZATION_CODE'|'CLIENT_CREDENTIALS'|'JWT_BEARER', 'tokenUrl': 'string', 'tokenUrlParametersMap': { 'string': 'string' } }, 'secretArn': 'string' }, 'compatibleComputeEnvironments': [ 'SPARK'|'ATHENA'|'PYTHON', ], 'connectionProperties': { 'string': 'string' }, 'connectionSchemaVersion': 123, 'connectionType': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'lastConnectionValidationTime': datetime(2015, 1, 1), 'lastUpdatedBy': 'string', 'lastUpdatedTime': datetime(2015, 1, 1), 'matchCriteria': [ 'string', ], 'name': 'string', 'physicalConnectionRequirements': { 'availabilityZone': 'string', 'securityGroupIdList': [ 'string', ], 'subnetId': 'string', 'subnetIdList': [ 'string', ] }, 'pythonProperties': { 'string': 'string' }, 'sparkProperties': { 'string': 'string' }, 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED', 'statusReason': 'string' }, 'glueConnectionName': 'string', 'host': 'string', 'port': 123, 'protocol': 'ATHENA'|'GLUE_INTERACTIVE_SESSION'|'HTTPS'|'JDBC'|'LIVY'|'ODBC'|'PRISM', 'stage': 'string' }, ], 'projectId': 'string', 'props': { 'athenaProperties': { 'workgroupName': 'string' }, 'glueProperties': { 'errorMessage': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED' }, 'hyperPodProperties': { 'clusterArn': 'string', 'clusterName': 'string', 'orchestrator': 'EKS'|'SLURM' }, 'iamProperties': { 'environmentId': 'string', 'glueLineageSyncEnabled': True|False }, 'redshiftProperties': { 'credentials': { 'secretArn': 'string', 'usernamePassword': { 'password': 'string', 'username': 'string' } }, 'databaseName': 'string', 'isProvisionedSecret': True|False, 'jdbcIamUrl': 'string', 'jdbcUrl': 'string', 'lineageSync': { 'enabled': True|False, 'lineageJobId': 'string', 'schedule': { 'schedule': 'string' } }, 'redshiftTempDir': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED', 'storage': { 'clusterName': 'string', 'workgroupName': 'string' } }, 's3Properties': { 'errorMessage': 'string', 's3AccessGrantLocationId': 'string', 's3Uri': 'string', 'status': 'CREATING'|'CREATE_FAILED'|'DELETING'|'DELETE_FAILED'|'READY'|'UPDATING'|'UPDATE_FAILED'|'DELETED' }, 'sparkEmrProperties': { 'computeArn': 'string', 'credentials': { 'password': 'string', 'username': 'string' }, 'credentialsExpiration': datetime(2015, 1, 1), 'governanceType': 'AWS_MANAGED'|'USER_MANAGED', 'instanceProfileArn': 'string', 'javaVirtualEnv': 'string', 'livyEndpoint': 'string', 'logUri': 'string', 'pythonVirtualEnv': 'string', 'runtimeRole': 'string', 'trustedCertificatesS3Uri': 'string' }, 'sparkGlueProperties': { 'additionalArgs': { 'connection': 'string' }, 'glueConnectionName': 'string', 'glueVersion': 'string', 'idleTimeout': 123, 'javaVirtualEnv': 'string', 'numberOfWorkers': 123, 'pythonVirtualEnv': 'string', 'workerType': 'string' } }, 'type': 'ATHENA'|'BIGQUERY'|'DATABRICKS'|'DOCUMENTDB'|'DYNAMODB'|'HYPERPOD'|'IAM'|'MYSQL'|'OPENSEARCH'|'ORACLE'|'POSTGRESQL'|'REDSHIFT'|'S3'|'SAPHANA'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'VERTICA'|'WORKFLOWS_MWAA' } **Response Structure** * *(dict) --* * **connectionCredentials** *(dict) --* Connection credentials. * **accessKeyId** *(string) --* The access key ID of a connection. * **expiration** *(datetime) --* The expiration of the connection credentials. * **secretAccessKey** *(string) --* The secret access key of a connection. * **sessionToken** *(string) --* The session token of a connection credentials. * **connectionId** *(string) --* The ID of the connection. * **description** *(string) --* Connection description. * **domainId** *(string) --* The domain ID of the connection. * **domainUnitId** *(string) --* The domain unit ID of the connection. * **environmentId** *(string) --* The ID of the environment. * **environmentUserRole** *(string) --* The environment user role. * **name** *(string) --* The name of the connection. * **physicalEndpoints** *(list) --* The physical endpoints of the connection. * *(dict) --* The physical endpoints of a connection. * **awsLocation** *(dict) --* The location of a connection. * **accessRole** *(string) --* The access role of a connection. * **awsAccountId** *(string) --* The account ID of a connection. * **awsRegion** *(string) --* The Region of a connection. * **iamConnectionId** *(string) --* The IAM connection ID of a connection. * **glueConnection** *(dict) --* The Amazon Web Services Glue connection. * **athenaProperties** *(dict) --* The Amazon Athena properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **authenticationConfiguration** *(dict) --* The authentication configuration of the Amazon Web Services Glue connection. * **authenticationType** *(string) --* The authentication type of a connection. * **oAuth2Properties** *(dict) --* The oAuth2 properties of a connection. * **authorizationCodeProperties** *(dict) --* The authorization code properties of the OAuth2 properties. * **authorizationCode** *(string) --* The authorization code of a connection. * **redirectUri** *(string) --* The redirect URI of a connection. * **oAuth2ClientApplication** *(dict) --* The OAuth2 client application of the OAuth2 properties. * **aWSManagedClientApplicationReference** *(string) --* The Amazon Web Services managed client application reference in the OAuth2Client application. * **userManagedClientApplicationClientId** *(string) --* The user managed client application client ID in the OAuth2Client application. * **oAuth2Credentials** *(dict) --* The OAuth2 credentials of the OAuth2 properties. * **accessToken** *(string) --* The access token of a connection. * **jwtToken** *(string) --* The jwt token of the connection. * **refreshToken** *(string) --* The refresh token of the connection. * **userManagedClientApplicationClientSecret** *(string) --* The user managed client application client secret of the connection. * **oAuth2GrantType** *(string) --* The OAuth2 grant type of the OAuth2 properties. * **tokenUrl** *(string) --* The OAuth2 token URL of the OAuth2 properties. * **tokenUrlParametersMap** *(dict) --* The OAuth2 token URL parameter map of the OAuth2 properties. * *(string) --* * *(string) --* * **secretArn** *(string) --* The secret ARN of a connection. * **compatibleComputeEnvironments** *(list) --* The compatible compute environments of the Amazon Web Services Glue connection. * *(string) --* * **connectionProperties** *(dict) --* The properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **connectionSchemaVersion** *(integer) --* The connection schema version of the Amazon Web Services Glue connection. * **connectionType** *(string) --* The type of the Amazon Web Services Glue connection. * **creationTime** *(datetime) --* The creation time of the Amazon Web Services Glue connection. * **description** *(string) --* The description of the Amazon Web Services Glue connection. * **lastConnectionValidationTime** *(datetime) --* The last validation time of the Amazon Web Services Glue connection. * **lastUpdatedBy** *(string) --* The user who last updated the Amazon Web Services Glue connection. * **lastUpdatedTime** *(datetime) --* The timestamp at which the Amazon Web Services Glue connection was last updated. * **matchCriteria** *(list) --* The match criteria of the Amazon Web Services Glue connection. * *(string) --* * **name** *(string) --* The name of the Amazon Web Services Glue connection. * **physicalConnectionRequirements** *(dict) --* The physical connection requirements of the Amazon Web Services Glue connection. * **availabilityZone** *(string) --* The availability zone of the physical connection requirements of a connection. * **securityGroupIdList** *(list) --* The group ID list of the physical connection requirements of a connection. * *(string) --* * **subnetId** *(string) --* The subnet ID of the physical connection requirements of a connection. * **subnetIdList** *(list) --* The subnet ID list of the physical connection requirements of a connection. * *(string) --* * **pythonProperties** *(dict) --* The Python properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **sparkProperties** *(dict) --* The Spark properties of the Amazon Web Services Glue connection. * *(string) --* * *(string) --* * **status** *(string) --* The status of the Amazon Web Services Glue connection. * **statusReason** *(string) --* The status reason of the Amazon Web Services Glue connection. * **glueConnectionName** *(string) --* The Amazon Web Services Glue connection name. * **host** *(string) --* The host in the physical endpoints of a connection. * **port** *(integer) --* The port in the physical endpoints of a connection. * **protocol** *(string) --* The protocol in the physical endpoints of a connection. * **stage** *(string) --* The stage in the physical endpoints of a connection. * **projectId** *(string) --* The ID of the project. * **props** *(dict) --* Connection props. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "athenaProperties", "glueProperties", "hyperPodProperties", "iamProperties", "redshiftProperties", "s3Properties", "sparkEmrProperties", "sparkGlueProperties". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **athenaProperties** *(dict) --* The Amazon Athena properties of a connection. * **workgroupName** *(string) --* The Amazon Athena workgroup name of a connection. * **glueProperties** *(dict) --* The Amazon Web Services Glue properties of a connection. * **errorMessage** *(string) --* The error message generated if the action is not completed successfully. * **status** *(string) --* The status of a connection. * **hyperPodProperties** *(dict) --* The hyper pod properties of a connection. * **clusterArn** *(string) --* The cluster ARN of the hyper pod properties. * **clusterName** *(string) --* The cluster name the hyper pod properties. * **orchestrator** *(string) --* The orchestrator of the hyper pod properties. * **iamProperties** *(dict) --* The IAM properties of a connection. * **environmentId** *(string) --* The environment ID of the connection. * **glueLineageSyncEnabled** *(boolean) --* Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection. * **redshiftProperties** *(dict) --* The Amazon Redshift properties of a connection. * **credentials** *(dict) --* The Amazon Redshift credentials. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "secretArn", "usernamePassword". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **secretArn** *(string) --* The secret ARN of the Amazon Redshift credentials of a connection. * **usernamePassword** *(dict) --* The username and password of the Amazon Redshift credentials of a connection. * **password** *(string) --* The password of a connection. * **username** *(string) --* The username of a connection. * **databaseName** *(string) --* The Amazon Redshift database name. * **isProvisionedSecret** *(boolean) --* Specifies whether Amaon Redshift properties has a provisioned secret. * **jdbcIamUrl** *(string) --* The jdbcIam URL of the Amazon Redshift properties. * **jdbcUrl** *(string) --* The jdbcURL of the Amazon Redshift properties. * **lineageSync** *(dict) --* The lineage syn of the Amazon Redshift properties. * **enabled** *(boolean) --* Specifies whether the Amaon Redshift lineage sync configuration is enabled. * **lineageJobId** *(string) --* The lineage job ID of the Amaon Redshift lineage sync configuration. * **schedule** *(dict) --* The schedule of teh Amaon Redshift lineage sync configuration. * **schedule** *(string) --* The lineage sync schedule. * **redshiftTempDir** *(string) --* The redshiftTempDir of the Amazon Redshift properties. * **status** *(string) --* The status in the Amazon Redshift properties. * **storage** *(dict) --* The storage in the Amazon Redshift properties. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "clusterName", "workgroupName". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **clusterName** *(string) --* The cluster name in the Amazon Redshift storage properties. * **workgroupName** *(string) --* The workgroup name in the Amazon Redshift storage properties. * **s3Properties** *(dict) --* The Amazon S3 properties of a connection. * **errorMessage** *(string) --* The error message that gets displayed. * **s3AccessGrantLocationId** *(string) --* The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection. * **s3Uri** *(string) --* The Amazon S3 URI that's part of the Amazon S3 properties of a connection. * **status** *(string) --* The status of the Amazon S3 connection. * **sparkEmrProperties** *(dict) --* The Spark EMR properties of a connection. * **computeArn** *(string) --* The compute ARN of the Spark EMR. * **credentials** *(dict) --* The credentials of the Spark EMR. * **password** *(string) --* The password of a connection. * **username** *(string) --* The username of a connection. * **credentialsExpiration** *(datetime) --* The credential expiration of the Spark EMR. * **governanceType** *(string) --* The governance type of the Spark EMR. * **instanceProfileArn** *(string) --* The instance profile ARN of the Spark EMR. * **javaVirtualEnv** *(string) --* The Java virtual env of the Spark EMR. * **livyEndpoint** *(string) --* The livy endpoint of the Spark EMR. * **logUri** *(string) --* The log URI of the Spark EMR. * **pythonVirtualEnv** *(string) --* The Python virtual env of the Spark EMR. * **runtimeRole** *(string) --* The runtime role of the Spark EMR. * **trustedCertificatesS3Uri** *(string) --* The trusted certificate S3 URL of the Spark EMR. * **sparkGlueProperties** *(dict) --* The Spark Amazon Web Services Glue properties of a connection. * **additionalArgs** *(dict) --* The additional args in the Spark Amazon Web Services Glue properties. * **connection** *(string) --* The connection in the Spark Amazon Web Services Glue args. * **glueConnectionName** *(string) --* The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties. * **glueVersion** *(string) --* The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties. * **idleTimeout** *(integer) --* The idle timeout in the Spark Amazon Web Services Glue properties. * **javaVirtualEnv** *(string) --* The Java virtual env in the Spark Amazon Web Services Glue properties. * **numberOfWorkers** *(integer) --* The number of workers in the Spark Amazon Web Services Glue properties. * **pythonVirtualEnv** *(string) --* The Python virtual env in the Spark Amazon Web Services Glue properties. * **workerType** *(string) --* The worker type in the Spark Amazon Web Services Glue properties. * **type** *(string) --* The type of the connection. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_data_sources list_data_sources ***************** DataZone.Client.list_data_sources(**kwargs) Lists data sources in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.list_data_sources( connectionIdentifier='string', domainIdentifier='string', environmentIdentifier='string', maxResults=123, name='string', nextToken='string', projectIdentifier='string', status='CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', type='string' ) Parameters: * **connectionIdentifier** (*string*) -- The ID of the connection. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to list the data sources. * **environmentIdentifier** (*string*) -- The identifier of the environment in which to list the data sources. * **maxResults** (*integer*) -- The maximum number of data sources to return in a single call to "ListDataSources". When the number of data sources to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListDataSources" to list the next set of data sources. * **name** (*string*) -- The name of the data source. * **nextToken** (*string*) -- When the number of data sources is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of data sources, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListDataSources" to list the next set of data sources. * **projectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the project in which to list data sources. * **status** (*string*) -- The status of the data source. * **type** (*string*) -- The type of the data source. Return type: dict Returns: **Response Syntax** { 'items': [ { 'connectionId': 'string', 'createdAt': datetime(2015, 1, 1), 'dataSourceId': 'string', 'description': 'string', 'domainId': 'string', 'enableSetting': 'ENABLED'|'DISABLED', 'environmentId': 'string', 'lastRunAssetCount': 123, 'lastRunAt': datetime(2015, 1, 1), 'lastRunErrorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'lastRunStatus': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'name': 'string', 'schedule': { 'schedule': 'string', 'timezone': 'UTC'|'AFRICA_JOHANNESBURG'|'AMERICA_MONTREAL'|'AMERICA_SAO_PAULO'|'ASIA_BAHRAIN'|'ASIA_BANGKOK'|'ASIA_CALCUTTA'|'ASIA_DUBAI'|'ASIA_HONG_KONG'|'ASIA_JAKARTA'|'ASIA_KUALA_LUMPUR'|'ASIA_SEOUL'|'ASIA_SHANGHAI'|'ASIA_SINGAPORE'|'ASIA_TAIPEI'|'ASIA_TOKYO'|'AUSTRALIA_MELBOURNE'|'AUSTRALIA_SYDNEY'|'CANADA_CENTRAL'|'CET'|'CST6CDT'|'ETC_GMT'|'ETC_GMT0'|'ETC_GMT_ADD_0'|'ETC_GMT_ADD_1'|'ETC_GMT_ADD_10'|'ETC_GMT_ADD_11'|'ETC_GMT_ADD_12'|'ETC_GMT_ADD_2'|'ETC_GMT_ADD_3'|'ETC_GMT_ADD_4'|'ETC_GMT_ADD_5'|'ETC_GMT_ADD_6'|'ETC_GMT_ADD_7'|'ETC_GMT_ADD_8'|'ETC_GMT_ADD_9'|'ETC_GMT_NEG_0'|'ETC_GMT_NEG_1'|'ETC_GMT_NEG_10'|'ETC_GMT_NEG_11'|'ETC_GMT_NEG_12'|'ETC_GMT_NEG_13'|'ETC_GMT_NEG_14'|'ETC_GMT_NEG_2'|'ETC_GMT_NEG_3'|'ETC_GMT_NEG_4'|'ETC_GMT_NEG_5'|'ETC_GMT_NEG_6'|'ETC_GMT_NEG_7'|'ETC_GMT_NEG_8'|'ETC_GMT_NEG_9'|'EUROPE_DUBLIN'|'EUROPE_LONDON'|'EUROPE_PARIS'|'EUROPE_STOCKHOLM'|'EUROPE_ZURICH'|'ISRAEL'|'MEXICO_GENERAL'|'MST7MDT'|'PACIFIC_AUCKLAND'|'US_CENTRAL'|'US_EASTERN'|'US_MOUNTAIN'|'US_PACIFIC' }, 'status': 'CREATING'|'FAILED_CREATION'|'READY'|'UPDATING'|'FAILED_UPDATE'|'RUNNING'|'DELETING'|'FAILED_DELETION', 'type': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDataSources" action. * *(dict) --* The details of the data source. * **connectionId** *(string) --* The connection ID that's part of the data source summary. * **createdAt** *(datetime) --* The timestamp of when the data source was created. * **dataSourceId** *(string) --* The ID of the data source. * **description** *(string) --* The data source description. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the data source exists. * **enableSetting** *(string) --* Specifies whether the data source is enabled. * **environmentId** *(string) --* The ID of the environment in which the data source exists. * **lastRunAssetCount** *(integer) --* The count of the assets created during the last data source run. * **lastRunAt** *(datetime) --* The timestamp of when the data source run was last performed. * **lastRunErrorMessage** *(dict) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **lastRunStatus** *(string) --* The status of the last data source run. * **name** *(string) --* The name of the data source. * **schedule** *(dict) --* The details of the schedule of the data source runs. * **schedule** *(string) --* The schedule of the data source runs. * **timezone** *(string) --* The timezone of the data source run. * **status** *(string) --* The status of the data source. * **type** *(string) --* The type of the data source. * **updatedAt** *(datetime) --* The timestamp of when the data source was updated. * **nextToken** *(string) --* When the number of data sources is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of data sources, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListDataSources" to list the next set of data sources. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_environment_action delete_environment_action ************************* DataZone.Client.delete_environment_action(**kwargs) Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment. See also: AWS API Documentation **Request Syntax** response = client.delete_environment_action( domainIdentifier='string', environmentIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which an environment action is deleted. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the environment where an environment action is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the environment action that is deleted. Returns: None **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_waiter get_waiter ********** DataZone.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" DataZone / Client / get_subscription_target get_subscription_target *********************** DataZone.Client.get_subscription_target(**kwargs) Gets the subscription target in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_subscription_target( domainIdentifier='string', environmentIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the subscription target exists. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the environment associated with the subscription target. * **identifier** (*string*) -- **[REQUIRED]** The ID of the subscription target. Return type: dict Returns: **Response Syntax** { 'applicableAssetTypes': [ 'string', ], 'authorizedPrincipals': [ 'string', ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'environmentId': 'string', 'id': 'string', 'manageAccessRole': 'string', 'name': 'string', 'projectId': 'string', 'provider': 'string', 'subscriptionTargetConfig': [ { 'content': 'string', 'formName': 'string' }, ], 'type': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **applicableAssetTypes** *(list) --* The asset types associated with the subscription target. * *(string) --* * **authorizedPrincipals** *(list) --* The authorized principals of the subscription target. * *(string) --* * **createdAt** *(datetime) --* The timestamp of when the subscription target was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription target. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the subscription target exists. * **environmentId** *(string) --* The ID of the environment associated with the subscription target. * **id** *(string) --* The ID of the subscription target. * **manageAccessRole** *(string) --* The manage access role with which the subscription target was created. * **name** *(string) --* The name of the subscription target. * **projectId** *(string) --* The ID of the project associated with the subscription target. * **provider** *(string) --* The provider of the subscription target. * **subscriptionTargetConfig** *(list) --* The configuration of teh subscription target. * *(dict) --* The details of the subscription target configuration. * **content** *(string) --* The content of the subscription target configuration. * **formName** *(string) --* The form name included in the subscription target configuration. * **type** *(string) --* The type of the subscription target. * **updatedAt** *(datetime) --* The timestamp of when the subscription target was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription target. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_rule update_rule *********** DataZone.Client.update_rule(**kwargs) Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards. See also: AWS API Documentation **Request Syntax** response = client.update_rule( description='string', detail={ 'metadataFormEnforcementDetail': { 'requiredMetadataForms': [ { 'typeIdentifier': 'string', 'typeRevision': 'string' }, ] } }, domainIdentifier='string', identifier='string', includeChildDomainUnits=True|False, name='string', scope={ 'assetType': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificAssetTypes': [ 'string', ] }, 'dataProduct': True|False, 'project': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificProjects': [ 'string', ] } } ) Parameters: * **description** (*string*) -- The description of the rule. * **detail** (*dict*) -- The detail of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "metadataFormEnforcementDetail". * **metadataFormEnforcementDetail** *(dict) --* The enforcement detail of the metadata form. * **requiredMetadataForms** *(list) --* The required metadata forms. * *(dict) --* The reference of a metadata form. * **typeIdentifier** *(string) --* **[REQUIRED]** The type ID of the metadata form reference. * **typeRevision** *(string) --* **[REQUIRED]** The type revision of the metadata form reference. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain in which a rule is to be updated. * **identifier** (*string*) -- **[REQUIRED]** The ID of the rule that is to be updated * **includeChildDomainUnits** (*boolean*) -- Specifies whether to update this rule in the child domain units. * **name** (*string*) -- The name of the rule. * **scope** (*dict*) -- The scrope of the rule. * **assetType** *(dict) --* The asset type included in the rule scope. * **selectionMode** *(string) --* **[REQUIRED]** The selection mode for the rule. * **specificAssetTypes** *(list) --* The specific asset types that are included in the rule. * *(string) --* * **dataProduct** *(boolean) --* The data product included in the rule scope. * **project** *(dict) --* The project included in the rule scope. * **selectionMode** *(string) --* **[REQUIRED]** The selection mode of the rule. * **specificProjects** *(list) --* The specific projects in which the rule is created. * *(string) --* Return type: dict Returns: **Response Syntax** { 'action': 'CREATE_LISTING_CHANGE_SET'|'CREATE_SUBSCRIPTION_REQUEST', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'detail': { 'metadataFormEnforcementDetail': { 'requiredMetadataForms': [ { 'typeIdentifier': 'string', 'typeRevision': 'string' }, ] } }, 'identifier': 'string', 'lastUpdatedBy': 'string', 'name': 'string', 'revision': 'string', 'ruleType': 'METADATA_FORM_ENFORCEMENT', 'scope': { 'assetType': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificAssetTypes': [ 'string', ] }, 'dataProduct': True|False, 'project': { 'selectionMode': 'ALL'|'SPECIFIC', 'specificProjects': [ 'string', ] } }, 'target': { 'domainUnitTarget': { 'domainUnitId': 'string', 'includeChildDomainUnits': True|False } }, 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **action** *(string) --* The action of the rule. * **createdAt** *(datetime) --* The timestamp at which the rule was created. * **createdBy** *(string) --* The user who created the rule. * **description** *(string) --* The description of the rule. * **detail** *(dict) --* The detail of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "metadataFormEnforcementDetail". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **metadataFormEnforcementDetail** *(dict) --* The enforcement detail of the metadata form. * **requiredMetadataForms** *(list) --* The required metadata forms. * *(dict) --* The reference of a metadata form. * **typeIdentifier** *(string) --* The type ID of the metadata form reference. * **typeRevision** *(string) --* The type revision of the metadata form reference. * **identifier** *(string) --* The ID of the rule. * **lastUpdatedBy** *(string) --* The timestamp at which the rule was last updated. * **name** *(string) --* The name of the rule. * **revision** *(string) --* The revision of the rule. * **ruleType** *(string) --* The type of the rule. * **scope** *(dict) --* The scope of the rule. * **assetType** *(dict) --* The asset type included in the rule scope. * **selectionMode** *(string) --* The selection mode for the rule. * **specificAssetTypes** *(list) --* The specific asset types that are included in the rule. * *(string) --* * **dataProduct** *(boolean) --* The data product included in the rule scope. * **project** *(dict) --* The project included in the rule scope. * **selectionMode** *(string) --* The selection mode of the rule. * **specificProjects** *(list) --* The specific projects in which the rule is created. * *(string) --* * **target** *(dict) --* The target of the rule. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "domainUnitTarget". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **domainUnitTarget** *(dict) --* The ID of the domain unit. * **domainUnitId** *(string) --* The ID of the domain unit. * **includeChildDomainUnits** *(boolean) --* Specifies whether to apply a rule to the child domain units. * **updatedAt** *(datetime) --* The timestamp at which the rule was last updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_domain_unit get_domain_unit *************** DataZone.Client.get_domain_unit(**kwargs) Gets the details of the specified domain unit. See also: AWS API Documentation **Request Syntax** response = client.get_domain_unit( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to get a domain unit. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the domain unit that you want to get. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'lastUpdatedBy': 'string', 'name': 'string', 'owners': [ { 'group': { 'groupId': 'string' }, 'user': { 'userId': 'string' } }, ], 'parentDomainUnitId': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The time stamp at which the domain unit was created. * **createdBy** *(string) --* The user who created the domain unit. * **description** *(string) --* The description of the domain unit. * **domainId** *(string) --* The ID of the domain in which the domain unit lives. * **id** *(string) --* The ID of the domain unit. * **lastUpdatedAt** *(datetime) --* The timestamp at which the domain unit was last updated. * **lastUpdatedBy** *(string) --* The user who last updated the domain unit. * **name** *(string) --* The name of the domain unit. * **owners** *(list) --* The owners of the domain unit. * *(dict) --* The properties of the domain unit owner. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "group", "user". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **group** *(dict) --* Indicates that the domain unit owner is a group. * **groupId** *(string) --* The ID of the domain unit group. * **user** *(dict) --* Indicates that the domain unit owner is a user. * **userId** *(string) --* The ID of teh domain unit user. * **parentDomainUnitId** *(string) --* The ID of the parent domain unit. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_subscription_request_details get_subscription_request_details ******************************** DataZone.Client.get_subscription_request_details(**kwargs) Gets the details of the specified subscription request. See also: AWS API Documentation **Request Syntax** response = client.get_subscription_request_details( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to get the subscription request details. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the subscription request the details of which to get. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'decisionComment': 'string', 'domainId': 'string', 'existingSubscriptionId': 'string', 'id': 'string', 'metadataForms': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'requestReason': 'string', 'reviewerId': 'string', 'status': 'PENDING'|'ACCEPTED'|'REJECTED', 'subscribedListings': [ { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, ], 'subscribedPrincipals': [ { 'project': { 'id': 'string', 'name': 'string' } }, ], 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the specified subscription request was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription request. * **decisionComment** *(string) --* The decision comment of the subscription request. * **domainId** *(string) --* The Amazon DataZone domain of the subscription request. * **existingSubscriptionId** *(string) --* The ID of the existing subscription. * **id** *(string) --* The identifier of the subscription request. * **metadataForms** *(list) --* The metadata forms included in the subscription request. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **requestReason** *(string) --* The reason for the subscription request. * **reviewerId** *(string) --* The identifier of the Amazon DataZone user who reviewed the subscription request. * **status** *(string) --* The status of the subscription request. * **subscribedListings** *(list) --* The subscribed listings in the subscription request. * *(dict) --* The details of the published asset for which the subscription grant is created. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipals** *(list) --* The subscribed principals in the subscription request. * *(dict) --* The principal that has the subscription grant for the asset. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **updatedAt** *(datetime) --* The timestamp of when the subscription request was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription request. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_asset create_asset ************ DataZone.Client.create_asset(**kwargs) Creates an asset in Amazon DataZone catalog. See also: AWS API Documentation **Request Syntax** response = client.create_asset( clientToken='string', description='string', domainIdentifier='string', externalIdentifier='string', formsInput=[ { 'content': 'string', 'formName': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], glossaryTerms=[ 'string', ], name='string', owningProjectIdentifier='string', predictionConfiguration={ 'businessNameGeneration': { 'enabled': True|False } }, typeIdentifier='string', typeRevision='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- Asset description. * **domainIdentifier** (*string*) -- **[REQUIRED]** Amazon DataZone domain where the asset is created. * **externalIdentifier** (*string*) -- The external identifier of the asset. If the value for the "externalIdentifier" parameter is specified, it must be a unique value. * **formsInput** (*list*) -- Metadata forms attached to the asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* **[REQUIRED]** The name of the metadata form. * **typeIdentifier** *(string) --* The ID of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** (*list*) -- Glossary terms attached to the asset. * *(string) --* * **name** (*string*) -- **[REQUIRED]** Asset name. * **owningProjectIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of the project that owns this asset. * **predictionConfiguration** (*dict*) -- The configuration of the automatically generated business- friendly metadata for the asset. * **businessNameGeneration** *(dict) --* The business name generation mechanism. * **enabled** *(boolean) --* Specifies whether the business name generation is enabled. * **typeIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of this asset's type. * **typeRevision** (*string*) -- The revision of this asset's type. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'externalIdentifier': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'latestTimeSeriesDataPointFormsOutput': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'listing': { 'listingId': 'string', 'listingStatus': 'CREATING'|'ACTIVE'|'INACTIVE' }, 'name': 'string', 'owningProjectId': 'string', 'predictionConfiguration': { 'businessNameGeneration': { 'enabled': True|False } }, 'readOnlyFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'revision': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the asset was created. * **createdBy** *(string) --* The Amazon DataZone user that created this asset in the catalog. * **description** *(string) --* The description of the created asset. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the asset was created. * **externalIdentifier** *(string) --* The external identifier of the asset. * **firstRevisionCreatedAt** *(datetime) --* The timestamp of when the first revision of the asset took place. * **firstRevisionCreatedBy** *(string) --* The Amazon DataZone user that made the first revision of the asset. * **formsOutput** *(list) --* The metadata forms that are attached to the created asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** *(list) --* The glossary terms that are attached to the created asset. * *(string) --* * **id** *(string) --* The unique identifier of the created asset. * **latestTimeSeriesDataPointFormsOutput** *(list) --* The latest data point that was imported into the time series form for the asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **listing** *(dict) --* The details of an asset published in an Amazon DataZone catalog. * **listingId** *(string) --* The identifier of an asset published in an Amazon DataZone catalog. * **listingStatus** *(string) --* The status of an asset published in an Amazon DataZone catalog. * **name** *(string) --* The name of the created asset. * **owningProjectId** *(string) --* The ID of the Amazon DataZone project that owns the created asset. * **predictionConfiguration** *(dict) --* The configuration of the automatically generated business- friendly metadata for the asset. * **businessNameGeneration** *(dict) --* The business name generation mechanism. * **enabled** *(boolean) --* Specifies whether the business name generation is enabled. * **readOnlyFormsOutput** *(list) --* The read-only metadata forms that are attached to the created asset. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **revision** *(string) --* The revision of the asset. * **typeIdentifier** *(string) --* The identifier of the created asset type. * **typeRevision** *(string) --* The revision type of the asset. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_form_type get_form_type ************* DataZone.Client.get_form_type(**kwargs) Gets a metadata form type in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_form_type( domainIdentifier='string', formTypeIdentifier='string', revision='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this metadata form type exists. * **formTypeIdentifier** (*string*) -- **[REQUIRED]** The ID of the metadata form type. * **revision** (*string*) -- The revision of this metadata form type. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'imports': [ { 'name': 'string', 'revision': 'string' }, ], 'model': { 'smithy': 'string' }, 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string', 'status': 'ENABLED'|'DISABLED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when this metadata form type was created. * **createdBy** *(string) --* The Amazon DataZone user who created this metadata form type. * **description** *(string) --* The description of the metadata form type. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which this metadata form type exists. * **imports** *(list) --* The imports of the metadata form type. * *(dict) --* The details of the import of the metadata form type. * **name** *(string) --* The name of the import. * **revision** *(string) --* The revision of the import. * **model** *(dict) --* The model of the metadata form type. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "smithy". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **smithy** *(string) --* Indicates the smithy model of the API. * **name** *(string) --* The name of the metadata form type. * **originDomainId** *(string) --* The ID of the Amazon DataZone domain in which the metadata form type was originally created. * **originProjectId** *(string) --* The ID of the project in which this metadata form type was originally created. * **owningProjectId** *(string) --* The ID of the project that owns this metadata form type. * **revision** *(string) --* The revision of the metadata form type. * **status** *(string) --* The status of the metadata form type. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_glossary get_glossary ************ DataZone.Client.get_glossary(**kwargs) Gets a business glossary in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_glossary( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this business glossary exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the business glossary. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'id': 'string', 'name': 'string', 'owningProjectId': 'string', 'status': 'DISABLED'|'ENABLED', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when this business glossary was created. * **createdBy** *(string) --* The Amazon DataZone user who created this business glossary. * **description** *(string) --* The description of the business glossary. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which this business glossary exists. * **id** *(string) --* The ID of the business glossary. * **name** *(string) --* The name of the business glossary. * **owningProjectId** *(string) --* The ID of the project that owns this business glossary. * **status** *(string) --* The status of the business glossary. * **updatedAt** *(datetime) --* The timestamp of when the business glossary was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the business glossary. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_metadata_generation_runs list_metadata_generation_runs ***************************** DataZone.Client.list_metadata_generation_runs(**kwargs) Lists all metadata generation runs. See also: AWS API Documentation **Request Syntax** response = client.list_metadata_generation_runs( domainIdentifier='string', maxResults=123, nextToken='string', status='SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED', type='BUSINESS_DESCRIPTIONS' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where you want to list metadata generation runs. * **maxResults** (*integer*) -- The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions. * **nextToken** (*string*) -- When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions. * **status** (*string*) -- The status of the metadata generation runs. * **type** (*string*) -- The type of the metadata generation runs. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'owningProjectId': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED', 'target': { 'identifier': 'string', 'revision': 'string', 'type': 'ASSET' }, 'type': 'BUSINESS_DESCRIPTIONS' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListMetadataGenerationRuns action. * *(dict) --* The metadata generation run. * **createdAt** *(datetime) --* The timestamp at which the metadata generation run was created. * **createdBy** *(string) --* The user who created the metadata generation run. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the metadata generation run was created. * **id** *(string) --* The ID of the metadata generation run. * **owningProjectId** *(string) --* The ID of the project that owns the asset for which the metadata generation was ran. * **status** *(string) --* The status of the metadata generation run. * **target** *(dict) --* The asset for which metadata was generated. * **identifier** *(string) --* The ID of the metadata generation run's target. * **revision** *(string) --* The revision of the asset for which metadata was generated. * **type** *(string) --* The type of the asset for which metadata was generated. * **type** *(string) --* The type of the metadata generation run. * **nextToken** *(string) --* When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_environment_blueprint_configuration get_environment_blueprint_configuration *************************************** DataZone.Client.get_environment_blueprint_configuration(**kwargs) Gets the blueprint configuration in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_environment_blueprint_configuration( domainIdentifier='string', environmentBlueprintIdentifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where this blueprint exists. * **environmentBlueprintIdentifier** (*string*) -- **[REQUIRED]** He ID of the blueprint. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'domainId': 'string', 'enabledRegions': [ 'string', ], 'environmentBlueprintId': 'string', 'environmentRolePermissionBoundary': 'string', 'manageAccessRoleArn': 'string', 'provisioningConfigurations': [ { 'lakeFormationConfiguration': { 'locationRegistrationExcludeS3Locations': [ 'string', ], 'locationRegistrationRole': 'string' } }, ], 'provisioningRoleArn': 'string', 'regionalParameters': { 'string': { 'string': 'string' } }, 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when this blueprint was created. * **domainId** *(string) --* The ID of the Amazon DataZone domain where this blueprint exists. * **enabledRegions** *(list) --* The Amazon Web Services regions in which this blueprint is enabled. * *(string) --* * **environmentBlueprintId** *(string) --* The ID of the blueprint. * **environmentRolePermissionBoundary** *(string) --* The environment role permissions boundary. * **manageAccessRoleArn** *(string) --* The ARN of the manage access role with which this blueprint is created. * **provisioningConfigurations** *(list) --* The provisioning configuration of a blueprint. * *(dict) --* The provisioning configuration of the blueprint. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "lakeFormationConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **lakeFormationConfiguration** *(dict) --* The Lake Formation configuration of the Data Lake blueprint. * **locationRegistrationExcludeS3Locations** *(list) --* Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode. * *(string) --* * **locationRegistrationRole** *(string) --* The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using Amazon Web Services Lake Formation hybrid access mode. * **provisioningRoleArn** *(string) --* The ARN of the provisioning role with which this blueprint is created. * **regionalParameters** *(dict) --* The regional parameters of the blueprint. * *(string) --* * *(dict) --* * *(string) --* * *(string) --* * **updatedAt** *(datetime) --* The timestamp of when this blueprint was upated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / revoke_subscription revoke_subscription ******************* DataZone.Client.revoke_subscription(**kwargs) Revokes a specified subscription in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.revoke_subscription( domainIdentifier='string', identifier='string', retainPermissions=True|False ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain where you want to revoke a subscription. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the revoked subscription. * **retainPermissions** (*boolean*) -- Specifies whether permissions are retained when the subscription is revoked. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'retainPermissions': True|False, 'status': 'APPROVED'|'REVOKED'|'CANCELLED', 'subscribedListing': { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, 'subscribedPrincipal': { 'project': { 'id': 'string', 'name': 'string' } }, 'subscriptionRequestId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the subscription was revoked. * **createdBy** *(string) --* The identifier of the user who revoked the subscription. * **domainId** *(string) --* The identifier of the Amazon DataZone domain where you want to revoke a subscription. * **id** *(string) --* The identifier of the revoked subscription. * **retainPermissions** *(boolean) --* Specifies whether permissions are retained when the subscription is revoked. * **status** *(string) --* The status of the revoked subscription. * **subscribedListing** *(dict) --* The subscribed listing of the revoked subscription. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipal** *(dict) --* The subscribed principal of the revoked subscription. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **subscriptionRequestId** *(string) --* The identifier of the subscription request for the revoked subscription. * **updatedAt** *(datetime) --* The timestamp of when the subscription was revoked. * **updatedBy** *(string) --* The Amazon DataZone user who revoked the subscription. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_environment_actions list_environment_actions ************************ DataZone.Client.list_environment_actions(**kwargs) Lists existing environment actions. See also: AWS API Documentation **Request Syntax** response = client.list_environment_actions( domainIdentifier='string', environmentIdentifier='string', maxResults=123, nextToken='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the environment actions are listed. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the envrironment whose environment actions are listed. * **maxResults** (*integer*) -- The maximum number of environment actions to return in a single call to "ListEnvironmentActions". When the number of environment actions to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListEnvironmentActions" to list the next set of environment actions. * **nextToken** (*string*) -- When the number of environment actions is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of environment actions, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEnvironmentActions" to list the next set of environment actions. Return type: dict Returns: **Response Syntax** { 'items': [ { 'description': 'string', 'domainId': 'string', 'environmentId': 'string', 'id': 'string', 'name': 'string', 'parameters': { 'awsConsoleLink': { 'uri': 'string' } } }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of "ListEnvironmentActions". * *(dict) --* The details about the specified action configured for an environment. For example, the details of the specified console links for an analytics tool that is available in this environment. * **description** *(string) --* The environment action description. * **domainId** *(string) --* The Amazon DataZone domain ID of the environment action. * **environmentId** *(string) --* The environment ID of the environment action. * **id** *(string) --* The ID of the environment action. * **name** *(string) --* The name of the environment action. * **parameters** *(dict) --* The parameters of the environment action. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "awsConsoleLink". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **awsConsoleLink** *(dict) --* The console link specified as part of the environment action. * **uri** *(string) --* The URI of the console link specified as part of the environment action. * **nextToken** *(string) --* When the number of environment actions is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of environment actions, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListEnvironmentActions" to list the next set of environment actions. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_asset_type create_asset_type ***************** DataZone.Client.create_asset_type(**kwargs) Creates a custom asset type. See also: AWS API Documentation **Request Syntax** response = client.create_asset_type( description='string', domainIdentifier='string', formsInput={ 'string': { 'required': True|False, 'typeIdentifier': 'string', 'typeRevision': 'string' } }, name='string', owningProjectIdentifier='string' ) Parameters: * **description** (*string*) -- The descripton of the custom asset type. * **domainIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon DataZone domain where the custom asset type is being created. * **formsInput** (*dict*) -- **[REQUIRED]** The metadata forms that are to be attached to the custom asset type. * *(string) --* * *(dict) --* The details of the form entry. * **required** *(boolean) --* Specifies whether a form entry is required. * **typeIdentifier** *(string) --* **[REQUIRED]** The type ID of the form entry. * **typeRevision** *(string) --* **[REQUIRED]** The type revision of the form entry. * **name** (*string*) -- **[REQUIRED]** The name of the custom asset type. * **owningProjectIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone project that is to own the custom asset type. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'formsOutput': { 'string': { 'required': True|False, 'typeName': 'string', 'typeRevision': 'string' } }, 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the asset type is to be created. * **createdBy** *(string) --* The Amazon DataZone user who creates this custom asset type. * **description** *(string) --* The description of the custom asset type. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the asset type was created. * **formsOutput** *(dict) --* The metadata forms that are attached to the asset type. * *(string) --* * *(dict) --* The details of the form entry. * **required** *(boolean) --* Specifies whether a form entry is required. * **typeName** *(string) --* The name of the type of the form entry. * **typeRevision** *(string) --* The type revision of the form entry. * **name** *(string) --* The name of the asset type. * **originDomainId** *(string) --* The ID of the Amazon DataZone domain where the asset type was originally created. * **originProjectId** *(string) --* The ID of the Amazon DataZone project where the asset type was originally created. * **owningProjectId** *(string) --* The ID of the Amazon DataZone project that currently owns this asset type. * **revision** *(string) --* The revision of the custom asset type. * **updatedAt** *(datetime) --* The timestamp of when the custom type was created. * **updatedBy** *(string) --* The Amazon DataZone user that created the custom asset type. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_glossary_term get_glossary_term ***************** DataZone.Client.get_glossary_term(**kwargs) Gets a business glossary term in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_glossary_term( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this business glossary term exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the business glossary term. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'glossaryId': 'string', 'id': 'string', 'longDescription': 'string', 'name': 'string', 'shortDescription': 'string', 'status': 'ENABLED'|'DISABLED', 'termRelations': { 'classifies': [ 'string', ], 'isA': [ 'string', ] }, 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the business glossary term was created. * **createdBy** *(string) --* The Amazon DataZone user who created the business glossary. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which this business glossary term exists. * **glossaryId** *(string) --* The ID of the business glossary to which this term belongs. * **id** *(string) --* The ID of the business glossary term. * **longDescription** *(string) --* The long description of the business glossary term. * **name** *(string) --* The name of the business glossary term. * **shortDescription** *(string) --* The short decription of the business glossary term. * **status** *(string) --* The status of the business glossary term. * **termRelations** *(dict) --* The relations of the business glossary term. * **classifies** *(list) --* The classifies of the term relations. * *(string) --* * **isA** *(list) --* The "isA" property of the term relations. * *(string) --* * **updatedAt** *(datetime) --* The timestamp of when the business glossary term was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the business glossary term. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_listing delete_listing ************** DataZone.Client.delete_listing(**kwargs) Deletes a listing (a record of an asset at a given time). See also: AWS API Documentation **Request Syntax** response = client.delete_listing( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain. * **identifier** (*string*) -- **[REQUIRED]** The ID of the listing to be deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_group_profile get_group_profile ***************** DataZone.Client.get_group_profile(**kwargs) Gets a group profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_group_profile( domainIdentifier='string', groupIdentifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which the group profile exists. * **groupIdentifier** (*string*) -- **[REQUIRED]** The identifier of the group profile. Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'groupName': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED' } **Response Structure** * *(dict) --* * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the group profile exists. * **groupName** *(string) --* The name of the group for which the specified group profile exists. * **id** *(string) --* The identifier of the group profile. * **status** *(string) --* The identifier of the group profile. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_asset_type delete_asset_type ***************** DataZone.Client.delete_asset_type(**kwargs) Deletes an asset type in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_asset_type( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the asset type is deleted. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the asset type that is deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_project_profiles list_project_profiles ********************* DataZone.Client.list_project_profiles(**kwargs) Lists project profiles. See also: AWS API Documentation **Request Syntax** response = client.list_project_profiles( domainIdentifier='string', maxResults=123, name='string', nextToken='string', sortBy='NAME', sortOrder='ASCENDING'|'DESCENDING' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list project profiles. * **maxResults** (*integer*) -- The maximum number of project profiles to return in a single call to ListProjectProfiles. When the number of project profiles to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectProfiles to list the next set of project profiles. * **name** (*string*) -- The name of a project profile. * **nextToken** (*string*) -- When the number of project profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles. * **sortBy** (*string*) -- Specifies by what to sort project profiles. * **sortOrder** (*string*) -- Specifies the sort order of the project profiles. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ENABLED'|'DISABLED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the ListProjectProfiles action. * *(dict) --* The summary of a project profile. * **createdAt** *(datetime) --* The timestamp of when the project profile was created. * **createdBy** *(string) --* The user who created the project profile. * **description** *(string) --* The description of the project profile. * **domainId** *(string) --* The domain ID of the project profile. * **domainUnitId** *(string) --* The domain unit ID of the project profile. * **id** *(string) --* The ID of the project profile. * **lastUpdatedAt** *(datetime) --* The timestamp at which a project profile was last updated. * **name** *(string) --* The name of a project profile. * **status** *(string) --* The status of a project profile. * **nextToken** *(string) --* When the number of project profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_project delete_project ************** DataZone.Client.delete_project(**kwargs) Deletes a project in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_project( domainIdentifier='string', identifier='string', skipDeletionCheck=True|False ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the project is deleted. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the project that is to be deleted. * **skipDeletionCheck** (*boolean*) -- Specifies the optional flag to delete all child entities within the project. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_notifications list_notifications ****************** DataZone.Client.list_notifications(**kwargs) Lists all Amazon DataZone notifications. See also: AWS API Documentation **Request Syntax** response = client.list_notifications( afterTimestamp=datetime(2015, 1, 1), beforeTimestamp=datetime(2015, 1, 1), domainIdentifier='string', maxResults=123, nextToken='string', subjects=[ 'string', ], taskStatus='ACTIVE'|'INACTIVE', type='TASK'|'EVENT' ) Parameters: * **afterTimestamp** (*datetime*) -- The time after which you want to list notifications. * **beforeTimestamp** (*datetime*) -- The time before which you want to list notifications. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **maxResults** (*integer*) -- The maximum number of notifications to return in a single call to "ListNotifications". When the number of notifications to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListNotifications" to list the next set of notifications. * **nextToken** (*string*) -- When the number of notifications is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of notifications, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListNotifications" to list the next set of notifications. * **subjects** (*list*) -- The subjects of notifications. * *(string) --* * **taskStatus** (*string*) -- The task status of notifications. * **type** (*string*) -- **[REQUIRED]** The type of notifications. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'notifications': [ { 'actionLink': 'string', 'creationTimestamp': datetime(2015, 1, 1), 'domainIdentifier': 'string', 'identifier': 'string', 'lastUpdatedTimestamp': datetime(2015, 1, 1), 'message': 'string', 'metadata': { 'string': 'string' }, 'status': 'ACTIVE'|'INACTIVE', 'title': 'string', 'topic': { 'resource': { 'id': 'string', 'name': 'string', 'type': 'PROJECT' }, 'role': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_VIEWER'|'DOMAIN_OWNER'|'PROJECT_SUBSCRIBER', 'subject': 'string' }, 'type': 'TASK'|'EVENT' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* When the number of notifications is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of notifications, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListNotifications" to list the next set of notifications. * **notifications** *(list) --* The results of the "ListNotifications" action. * *(dict) --* The details of a notification generated in Amazon DataZone. * **actionLink** *(string) --* The action link included in the notification. * **creationTimestamp** *(datetime) --* The timestamp of when a notification was created. * **domainIdentifier** *(string) --* The identifier of a Amazon DataZone domain in which the notification exists. * **identifier** *(string) --* The identifier of the notification. * **lastUpdatedTimestamp** *(datetime) --* The timestamp of when the notification was last updated. * **message** *(string) --* The message included in the notification. * **metadata** *(dict) --* The metadata included in the notification. * *(string) --* * *(string) --* * **status** *(string) --* The status included in the notification. * **title** *(string) --* The title of the notification. * **topic** *(dict) --* The topic of the notification. * **resource** *(dict) --* The details of the resource mentioned in a notification. * **id** *(string) --* The ID of the resource mentioned in a notification. * **name** *(string) --* The name of the resource mentioned in a notification. * **type** *(string) --* The type of the resource mentioned in a notification. * **role** *(string) --* The role of the resource mentioned in a notification. * **subject** *(string) --* The subject of the resource mentioned in a notification. * **type** *(string) --* The type of the notification. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_asset_filter update_asset_filter ******************* DataZone.Client.update_asset_filter(**kwargs) Updates an asset filter. See also: AWS API Documentation **Request Syntax** response = client.update_asset_filter( assetIdentifier='string', configuration={ 'columnConfiguration': { 'includedColumnNames': [ 'string', ] }, 'rowConfiguration': { 'rowFilter': { 'and': [ {'... recursive ...'}, ], 'expression': { 'equalTo': { 'columnName': 'string', 'value': 'string' }, 'greaterThan': { 'columnName': 'string', 'value': 'string' }, 'greaterThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'in': { 'columnName': 'string', 'values': [ 'string', ] }, 'isNotNull': { 'columnName': 'string' }, 'isNull': { 'columnName': 'string' }, 'lessThan': { 'columnName': 'string', 'value': 'string' }, 'lessThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'like': { 'columnName': 'string', 'value': 'string' }, 'notEqualTo': { 'columnName': 'string', 'value': 'string' }, 'notIn': { 'columnName': 'string', 'values': [ 'string', ] }, 'notLike': { 'columnName': 'string', 'value': 'string' } }, 'or': [ {'... recursive ...'}, ] }, 'sensitive': True|False } }, description='string', domainIdentifier='string', identifier='string', name='string' ) Parameters: * **assetIdentifier** (*string*) -- **[REQUIRED]** The ID of the data asset. * **configuration** (*dict*) -- The configuration of the asset filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "columnConfiguration", "rowConfiguration". * **columnConfiguration** *(dict) --* The column configuration of the asset filter. * **includedColumnNames** *(list) --* Specifies whether to include column names. * *(string) --* * **rowConfiguration** *(dict) --* The row configuration of the asset filter. * **rowFilter** *(dict) --* **[REQUIRED]** The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "expression", "or". * **and** *(list) --* The 'and' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "expression", "or". * **expression** *(dict) --* The expression of the row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "equalTo", "greaterThan", "greaterThanOrEqualTo", "in", "isNotNull", "isNull", "lessThan", "lessThanOrEqualTo", "like", "notEqualTo", "notIn", "notLike". * **equalTo** *(dict) --* The 'equal to' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be equal to an expression. * **greaterThan** *(dict) --* The 'greater than' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be greater than an expression. * **greaterThanOrEqualTo** *(dict) --* The 'greater than or equal to' clause of the filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be greater than or equal to an expression. * **in** *(dict) --* The 'in' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **values** *(list) --* **[REQUIRED]** The values that might be in the expression. * *(string) --* * **isNotNull** *(dict) --* The 'is not null' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **isNull** *(dict) --* The 'is null' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **lessThan** *(dict) --* The 'less than' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be less than the expression. * **lessThanOrEqualTo** *(dict) --* The 'less than or equal to' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be less than or equal to an expression. * **like** *(dict) --* The 'like' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be like the expression. * **notEqualTo** *(dict) --* The 'no equal to' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might not be equal to the expression. * **notIn** *(dict) --* The 'not in' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **values** *(list) --* **[REQUIRED]** The value that might not be in the expression. * *(string) --* * **notLike** *(dict) --* The 'not like' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might not be like the expression. * **or** *(list) --* The 'or' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "expression", "or". * **sensitive** *(boolean) --* Specifies whether the row filter is sensitive. * **description** (*string*) -- The description of the asset filter. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to update an asset filter. * **identifier** (*string*) -- **[REQUIRED]** The ID of the asset filter. * **name** (*string*) -- The name of the asset filter. Return type: dict Returns: **Response Syntax** { 'assetId': 'string', 'configuration': { 'columnConfiguration': { 'includedColumnNames': [ 'string', ] }, 'rowConfiguration': { 'rowFilter': { 'and': [ {'... recursive ...'}, ], 'expression': { 'equalTo': { 'columnName': 'string', 'value': 'string' }, 'greaterThan': { 'columnName': 'string', 'value': 'string' }, 'greaterThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'in': { 'columnName': 'string', 'values': [ 'string', ] }, 'isNotNull': { 'columnName': 'string' }, 'isNull': { 'columnName': 'string' }, 'lessThan': { 'columnName': 'string', 'value': 'string' }, 'lessThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'like': { 'columnName': 'string', 'value': 'string' }, 'notEqualTo': { 'columnName': 'string', 'value': 'string' }, 'notIn': { 'columnName': 'string', 'values': [ 'string', ] }, 'notLike': { 'columnName': 'string', 'value': 'string' } }, 'or': [ {'... recursive ...'}, ] }, 'sensitive': True|False } }, 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'effectiveColumnNames': [ 'string', ], 'effectiveRowFilter': 'string', 'errorMessage': 'string', 'id': 'string', 'name': 'string', 'status': 'VALID'|'INVALID' } **Response Structure** * *(dict) --* * **assetId** *(string) --* The ID of the data asset. * **configuration** *(dict) --* The configuration of the asset filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "columnConfiguration", "rowConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **columnConfiguration** *(dict) --* The column configuration of the asset filter. * **includedColumnNames** *(list) --* Specifies whether to include column names. * *(string) --* * **rowConfiguration** *(dict) --* The row configuration of the asset filter. * **rowFilter** *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **and** *(list) --* The 'and' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **expression** *(dict) --* The expression of the row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "equalTo", "greaterThan", "greaterThanOrEqualTo", "in", "isNotNull", "isNull", "lessThan", "lessThanOrEqualTo", "like", "notEqualTo", "notIn", "notLike". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **equalTo** *(dict) --* The 'equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be equal to an expression. * **greaterThan** *(dict) --* The 'greater than' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be greater than an expression. * **greaterThanOrEqualTo** *(dict) --* The 'greater than or equal to' clause of the filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be greater than or equal to an expression. * **in** *(dict) --* The 'in' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **values** *(list) --* The values that might be in the expression. * *(string) --* * **isNotNull** *(dict) --* The 'is not null' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **isNull** *(dict) --* The 'is null' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **lessThan** *(dict) --* The 'less than' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be less than the expression. * **lessThanOrEqualTo** *(dict) --* The 'less than or equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be less than or equal to an expression. * **like** *(dict) --* The 'like' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be like the expression. * **notEqualTo** *(dict) --* The 'no equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might not be equal to the expression. * **notIn** *(dict) --* The 'not in' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **values** *(list) --* The value that might not be in the expression. * *(string) --* * **notLike** *(dict) --* The 'not like' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might not be like the expression. * **or** *(list) --* The 'or' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **sensitive** *(boolean) --* Specifies whether the row filter is sensitive. * **createdAt** *(datetime) --* The timestamp at which the asset filter was created. * **description** *(string) --* The description of the asset filter. * **domainId** *(string) --* The ID of the domain where the asset filter was created. * **effectiveColumnNames** *(list) --* The column names of the asset filter. * *(string) --* * **effectiveRowFilter** *(string) --* The row filter of the asset filter. * **errorMessage** *(string) --* The error message that is displayed if the action is not completed successfully. * **id** *(string) --* The ID of the asset filter. * **name** *(string) --* The name of the asset filter. * **status** *(string) --* The status of the asset filter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_project_profile update_project_profile ********************** DataZone.Client.update_project_profile(**kwargs) Updates a project profile. See also: AWS API Documentation **Request Syntax** response = client.update_project_profile( description='string', domainIdentifier='string', domainUnitIdentifier='string', environmentConfigurations=[ { 'awsAccount': { 'awsAccountId': 'string', 'awsAccountIdPath': 'string' }, 'awsRegion': { 'regionName': 'string', 'regionNamePath': 'string' }, 'configurationParameters': { 'parameterOverrides': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'resolvedParameters': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'ssmPath': 'string' }, 'deploymentMode': 'ON_CREATE'|'ON_DEMAND', 'deploymentOrder': 123, 'description': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string' }, ], identifier='string', name='string', status='ENABLED'|'DISABLED' ) Parameters: * **description** (*string*) -- The description of a project profile. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where a project profile is to be updated. * **domainUnitIdentifier** (*string*) -- The ID of the domain unit where a project profile is to be updated. * **environmentConfigurations** (*list*) -- The environment configurations of a project profile. * *(dict) --* The configuration of an environment. * **awsAccount** *(dict) --* **[REQUIRED]** The Amazon Web Services account of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "awsAccountId", "awsAccountIdPath". * **awsAccountId** *(string) --* The account ID of a project. * **awsAccountIdPath** *(string) --* The account ID path of a project. * **awsRegion** *(dict) --* **[REQUIRED]** The Amazon Web Services Region of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "regionName", "regionNamePath". * **regionName** *(string) --* The Amazon Web Services Region name. * **regionNamePath** *(string) --* The region name path. * **configurationParameters** *(dict) --* The configuration parameters of the environment. * **parameterOverrides** *(list) --* The parameter overrides. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **resolvedParameters** *(list) --* The resolved environment configuration parameters. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **ssmPath** *(string) --* Ssm path environment configuration parameters. * **deploymentMode** *(string) --* The deployment mode of the environment. * **deploymentOrder** *(integer) --* The deployment order of the environment. * **description** *(string) --* The environment description. * **environmentBlueprintId** *(string) --* **[REQUIRED]** The environment blueprint ID. * **id** *(string) --* The environment ID. * **name** *(string) --* **[REQUIRED]** The environment name. * **identifier** (*string*) -- **[REQUIRED]** The ID of a project profile that is to be updated. * **name** (*string*) -- The name of a project profile. * **status** (*string*) -- The status of a project profile. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentConfigurations': [ { 'awsAccount': { 'awsAccountId': 'string', 'awsAccountIdPath': 'string' }, 'awsRegion': { 'regionName': 'string', 'regionNamePath': 'string' }, 'configurationParameters': { 'parameterOverrides': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'resolvedParameters': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'ssmPath': 'string' }, 'deploymentMode': 'ON_CREATE'|'ON_DEMAND', 'deploymentOrder': 123, 'description': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string' }, ], 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ENABLED'|'DISABLED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp at which a project profile is created. * **createdBy** *(string) --* The user who created a project profile. * **description** *(string) --* The description of a project profile. * **domainId** *(string) --* The ID of the domain where project profile is to be updated. * **domainUnitId** *(string) --* The domain unit ID of the project profile to be updated. * **environmentConfigurations** *(list) --* The environment configurations of a project profile. * *(dict) --* The configuration of an environment. * **awsAccount** *(dict) --* The Amazon Web Services account of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "awsAccountId", "awsAccountIdPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **awsAccountId** *(string) --* The account ID of a project. * **awsAccountIdPath** *(string) --* The account ID path of a project. * **awsRegion** *(dict) --* The Amazon Web Services Region of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "regionName", "regionNamePath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **regionName** *(string) --* The Amazon Web Services Region name. * **regionNamePath** *(string) --* The region name path. * **configurationParameters** *(dict) --* The configuration parameters of the environment. * **parameterOverrides** *(list) --* The parameter overrides. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **resolvedParameters** *(list) --* The resolved environment configuration parameters. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **ssmPath** *(string) --* Ssm path environment configuration parameters. * **deploymentMode** *(string) --* The deployment mode of the environment. * **deploymentOrder** *(integer) --* The deployment order of the environment. * **description** *(string) --* The environment description. * **environmentBlueprintId** *(string) --* The environment blueprint ID. * **id** *(string) --* The environment ID. * **name** *(string) --* The environment name. * **id** *(string) --* The ID of the project profile. * **lastUpdatedAt** *(datetime) --* The timestamp at which a project profile was last updated. * **name** *(string) --* The name of the project profile. * **status** *(string) --* The status of the project profile. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_job_run get_job_run *********** DataZone.Client.get_job_run(**kwargs) The details of the job run. See also: AWS API Documentation **Request Syntax** response = client.get_job_run( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain. * **identifier** (*string*) -- **[REQUIRED]** The ID of the job run. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'details': { 'lineageRunDetails': { 'sqlQueryRunDetails': { 'errorMessages': [ 'string', ], 'numQueriesFailed': 123, 'queryEndTime': datetime(2015, 1, 1), 'queryStartTime': datetime(2015, 1, 1), 'totalQueriesProcessed': 123 } } }, 'domainId': 'string', 'endTime': datetime(2015, 1, 1), 'error': { 'message': 'string' }, 'id': 'string', 'jobId': 'string', 'jobType': 'LINEAGE', 'runMode': 'SCHEDULED'|'ON_DEMAND', 'startTime': datetime(2015, 1, 1), 'status': 'SCHEDULED'|'IN_PROGRESS'|'SUCCESS'|'PARTIALLY_SUCCEEDED'|'FAILED'|'ABORTED'|'TIMED_OUT'|'CANCELED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the job run was created. * **createdBy** *(string) --* The user who created the job run. * **details** *(dict) --* The details of the job run. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "lineageRunDetails". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **lineageRunDetails** *(dict) --* The data lineage details of a job run. * **sqlQueryRunDetails** *(dict) --* The SQL query run details of a data lineage run. * **errorMessages** *(list) --* The error message of the SQL query run details of a data lineage run. * *(string) --* * **numQueriesFailed** *(integer) --* The number of queries that failed in the SQL query run details of a data lineage run. * **queryEndTime** *(datetime) --* The query end time in the SQL query run details of a data lineage run. * **queryStartTime** *(datetime) --* The query start time in the SQL query run details of a data lineage run. * **totalQueriesProcessed** *(integer) --* The total queries processed in the SQL query run details of a data lineage run. * **domainId** *(string) --* The ID of the domain. * **endTime** *(datetime) --* The timestamp of when the job run ended. * **error** *(dict) --* The error generated if the action is not completed successfully. * **message** *(string) --* The job run error message. * **id** *(string) --* The ID of the job run. * **jobId** *(string) --* The ID of the job run. * **jobType** *(string) --* The type of the job run. * **runMode** *(string) --* The mode of the job run. * **startTime** *(datetime) --* The timestamp of when the job run started. * **status** *(string) --* The status of the job run. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_environment_profile update_environment_profile ************************** DataZone.Client.update_environment_profile(**kwargs) Updates the specified environment profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_environment_profile( awsAccountId='string', awsAccountRegion='string', description='string', domainIdentifier='string', identifier='string', name='string', userParameters=[ { 'name': 'string', 'value': 'string' }, ] ) Parameters: * **awsAccountId** (*string*) -- The Amazon Web Services account in which a specified environment profile is to be udpated. * **awsAccountRegion** (*string*) -- The Amazon Web Services Region in which a specified environment profile is to be updated. * **description** (*string*) -- The description to be updated as part of the "UpdateEnvironmentProfile" action. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which an environment profile is to be updated. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the environment profile that is to be updated. * **name** (*string*) -- The name to be updated as part of the "UpdateEnvironmentProfile" action. * **userParameters** (*list*) -- The user parameters to be updated as part of the "UpdateEnvironmentProfile" action. * *(dict) --* The parameter details of an evironment profile. * **name** *(string) --* The name of an environment profile parameter. * **value** *(string) --* The value of an environment profile parameter. Return type: dict Returns: **Response Syntax** { 'awsAccountId': 'string', 'awsAccountRegion': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string', 'projectId': 'string', 'updatedAt': datetime(2015, 1, 1), 'userParameters': [ { 'defaultValue': 'string', 'description': 'string', 'fieldType': 'string', 'isEditable': True|False, 'isOptional': True|False, 'keyName': 'string' }, ] } **Response Structure** * *(dict) --* * **awsAccountId** *(string) --* The Amazon Web Services account in which a specified environment profile is to be udpated. * **awsAccountRegion** *(string) --* The Amazon Web Services Region in which a specified environment profile is to be updated. * **createdAt** *(datetime) --* The timestamp of when the environment profile was created. * **createdBy** *(string) --* The Amazon DataZone user who created the environment profile. * **description** *(string) --* The description to be updated as part of the "UpdateEnvironmentProfile" action. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the environment profile is to be updated. * **environmentBlueprintId** *(string) --* The identifier of the blueprint of the environment profile that is to be updated. * **id** *(string) --* The identifier of the environment profile that is to be udpated. * **name** *(string) --* The name to be updated as part of the "UpdateEnvironmentProfile" action. * **projectId** *(string) --* The identifier of the project of the environment profile that is to be updated. * **updatedAt** *(datetime) --* The timestamp of when the environment profile was updated. * **userParameters** *(list) --* The user parameters to be updated as part of the "UpdateEnvironmentProfile" action. * *(dict) --* The details of user parameters of an environment blueprint. * **defaultValue** *(string) --* The default value of the parameter. * **description** *(string) --* The description of the parameter. * **fieldType** *(string) --* The filed type of the parameter. * **isEditable** *(boolean) --* Specifies whether the parameter is editable. * **isOptional** *(boolean) --* Specifies whether the custom parameter is optional. * **keyName** *(string) --* The key name of the parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_data_source_runs list_data_source_runs ********************* DataZone.Client.list_data_source_runs(**kwargs) Lists data source runs in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.list_data_source_runs( dataSourceIdentifier='string', domainIdentifier='string', maxResults=123, nextToken='string', status='REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS' ) Parameters: * **dataSourceIdentifier** (*string*) -- **[REQUIRED]** The identifier of the data source. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which to invoke the "ListDataSourceRuns" action. * **maxResults** (*integer*) -- The maximum number of runs to return in a single call to "ListDataSourceRuns". When the number of runs to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListDataSourceRuns" to list the next set of runs. * **nextToken** (*string*) -- When the number of runs is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of runs, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListDataSourceRuns" to list the next set of runs. * **status** (*string*) -- The status of the data source. Return type: dict Returns: **Response Syntax** { 'items': [ { 'createdAt': datetime(2015, 1, 1), 'dataSourceId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'lineageSummary': { 'importStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'PARTIALLY_SUCCEEDED' }, 'projectId': 'string', 'runStatisticsForAssets': { 'added': 123, 'failed': 123, 'skipped': 123, 'unchanged': 123, 'updated': 123 }, 'startedAt': datetime(2015, 1, 1), 'status': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'stoppedAt': datetime(2015, 1, 1), 'type': 'PRIORITIZED'|'SCHEDULED', 'updatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListDataSourceRuns" action. * *(dict) --* The details of a data source run. * **createdAt** *(datetime) --* The timestamp of when a data source run was created. * **dataSourceId** *(string) --* The identifier of the data source of the data source run. * **errorMessage** *(dict) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The identifier of the data source run. * **lineageSummary** *(dict) --* The run lineage summary of a data source. * **importStatus** *(string) --* The import status that's part of the run lineage summary of a data source. * **projectId** *(string) --* The project ID of the data source run. * **runStatisticsForAssets** *(dict) --* The asset statistics from the data source run. * **added** *(integer) --* The "added" statistic for the data source run. * **failed** *(integer) --* The "failed" statistic for the data source run. * **skipped** *(integer) --* The "skipped" statistic for the data source run. * **unchanged** *(integer) --* The "unchanged" statistic for the data source run. * **updated** *(integer) --* The "updated" statistic for the data source run. * **startedAt** *(datetime) --* The timestamp of when a data source run was started. * **status** *(string) --* The status of the data source run. * **stoppedAt** *(datetime) --* The timestamp of when a data source run was stopped. * **type** *(string) --* The type of the data source run. * **updatedAt** *(datetime) --* The timestamp of when a data source run was updated. * **nextToken** *(string) --* When the number of runs is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of runs, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListDataSourceRuns" to list the next set of runs. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_glossary_term create_glossary_term ******************** DataZone.Client.create_glossary_term(**kwargs) Creates a business glossary term. See also: AWS API Documentation **Request Syntax** response = client.create_glossary_term( clientToken='string', domainIdentifier='string', glossaryIdentifier='string', longDescription='string', name='string', shortDescription='string', status='ENABLED'|'DISABLED', termRelations={ 'classifies': [ 'string', ], 'isA': [ 'string', ] } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this business glossary term is created. * **glossaryIdentifier** (*string*) -- **[REQUIRED]** The ID of the business glossary in which this term is created. * **longDescription** (*string*) -- The long description of this business glossary term. * **name** (*string*) -- **[REQUIRED]** The name of this business glossary term. * **shortDescription** (*string*) -- The short description of this business glossary term. * **status** (*string*) -- The status of this business glossary term. * **termRelations** (*dict*) -- The term relations of this business glossary term. * **classifies** *(list) --* The classifies of the term relations. * *(string) --* * **isA** *(list) --* The "isA" property of the term relations. * *(string) --* Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'glossaryId': 'string', 'id': 'string', 'longDescription': 'string', 'name': 'string', 'shortDescription': 'string', 'status': 'ENABLED'|'DISABLED', 'termRelations': { 'classifies': [ 'string', ], 'isA': [ 'string', ] } } **Response Structure** * *(dict) --* * **domainId** *(string) --* The ID of the Amazon DataZone domain in which this business glossary term is created. * **glossaryId** *(string) --* The ID of the business glossary in which this term is created. * **id** *(string) --* The ID of this business glossary term. * **longDescription** *(string) --* The long description of this business glossary term. * **name** *(string) --* The name of this business glossary term. * **shortDescription** *(string) --* The short description of this business glossary term. * **status** *(string) --* The status of this business glossary term. * **termRelations** *(dict) --* The term relations of this business glossary term. * **classifies** *(list) --* The classifies of the term relations. * *(string) --* * **isA** *(list) --* The "isA" property of the term relations. * *(string) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_project create_project ************** DataZone.Client.create_project(**kwargs) Creates an Amazon DataZone project. See also: AWS API Documentation **Request Syntax** response = client.create_project( description='string', domainIdentifier='string', domainUnitId='string', glossaryTerms=[ 'string', ], name='string', projectProfileId='string', userParameters=[ { 'environmentConfigurationName': 'string', 'environmentId': 'string', 'environmentParameters': [ { 'name': 'string', 'value': 'string' }, ] }, ] ) Parameters: * **description** (*string*) -- The description of the Amazon DataZone project. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this project is created. * **domainUnitId** (*string*) -- The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level. * **glossaryTerms** (*list*) -- The glossary terms that can be used in this Amazon DataZone project. * *(string) --* * **name** (*string*) -- **[REQUIRED]** The name of the Amazon DataZone project. * **projectProfileId** (*string*) -- The ID of the project profile. * **userParameters** (*list*) -- The user parameters of the project. * *(dict) --* The environment configuration user parameters. * **environmentConfigurationName** *(string) --* The environment configuration name. * **environmentId** *(string) --* The ID of the environment. * **environmentParameters** *(list) --* The environment parameters. * *(dict) --* The parameter details of an evironment profile. * **name** *(string) --* The name of an environment profile parameter. * **value** *(string) --* The value of an environment profile parameter. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentDeploymentDetails': { 'environmentFailureReasons': { 'string': [ { 'code': 'string', 'message': 'string' }, ] }, 'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT' }, 'failureReasons': [ { 'code': 'string', 'message': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'projectProfileId': 'string', 'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED', 'userParameters': [ { 'environmentConfigurationName': 'string', 'environmentId': 'string', 'environmentParameters': [ { 'name': 'string', 'value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the project was created. * **createdBy** *(string) --* The Amazon DataZone user who created the project. * **description** *(string) --* The description of the project. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the project was created. * **domainUnitId** *(string) --* The ID of the domain unit. * **environmentDeploymentDetails** *(dict) --* The environment deployment details. * **environmentFailureReasons** *(dict) --* Environment failure reasons. * *(string) --* * *(list) --* * *(dict) --* The failure reasons for the environment deployment. * **code** *(string) --* The error code for the failure reason for the environment deployment. * **message** *(string) --* The error message for the failure reason for the environment deployment. * **overallDeploymentStatus** *(string) --* The overall deployment status of the environment. * **failureReasons** *(list) --* Specifies the error message that is returned if the operation cannot be successfully completed. * *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **code** *(string) --* The code of the project deletion error. * **message** *(string) --* The message of the project deletion error. * **glossaryTerms** *(list) --* The glossary terms that can be used in the project. * *(string) --* * **id** *(string) --* The ID of the Amazon DataZone project. * **lastUpdatedAt** *(datetime) --* The timestamp of when the project was last updated. * **name** *(string) --* The name of the project. * **projectProfileId** *(string) --* The project profile ID. * **projectStatus** *(string) --* The status of the Amazon DataZone project that was created. * **userParameters** *(list) --* The user parameters of the project. * *(dict) --* The environment configuration user parameters. * **environmentConfigurationName** *(string) --* The environment configuration name. * **environmentId** *(string) --* The ID of the environment. * **environmentParameters** *(list) --* The environment parameters. * *(dict) --* The parameter details of an evironment profile. * **name** *(string) --* The name of an environment profile parameter. * **value** *(string) --* The value of an environment profile parameter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_group_profile create_group_profile ******************** DataZone.Client.create_group_profile(**kwargs) Creates a group profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.create_group_profile( clientToken='string', domainIdentifier='string', groupIdentifier='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which the group profile is created. * **groupIdentifier** (*string*) -- **[REQUIRED]** The identifier of the group for which the group profile is created. Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'groupName': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED' } **Response Structure** * *(dict) --* * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the group profile is created. * **groupName** *(string) --* The name of the group for which group profile is created. * **id** *(string) --* The identifier of the group profile. * **status** *(string) --* The status of the group profile. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_asset_revision create_asset_revision ********************* DataZone.Client.create_asset_revision(**kwargs) Creates a revision of the asset. See also: AWS API Documentation **Request Syntax** response = client.create_asset_revision( clientToken='string', description='string', domainIdentifier='string', formsInput=[ { 'content': 'string', 'formName': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], glossaryTerms=[ 'string', ], identifier='string', name='string', predictionConfiguration={ 'businessNameGeneration': { 'enabled': True|False } }, typeRevision='string' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The revised description of the asset. * **domainIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of the domain where the asset is being revised. * **formsInput** (*list*) -- The metadata forms to be attached to the asset as part of asset revision. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* **[REQUIRED]** The name of the metadata form. * **typeIdentifier** *(string) --* The ID of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** (*list*) -- The glossary terms to be attached to the asset as part of asset revision. * *(string) --* * **identifier** (*string*) -- **[REQUIRED]** The identifier of the asset. * **name** (*string*) -- **[REQUIRED]** Te revised name of the asset. * **predictionConfiguration** (*dict*) -- The configuration of the automatically generated business- friendly metadata for the asset. * **businessNameGeneration** *(dict) --* The business name generation mechanism. * **enabled** *(boolean) --* Specifies whether the business name generation is enabled. * **typeRevision** (*string*) -- The revision type of the asset. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'externalIdentifier': 'string', 'firstRevisionCreatedAt': datetime(2015, 1, 1), 'firstRevisionCreatedBy': 'string', 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'glossaryTerms': [ 'string', ], 'id': 'string', 'latestTimeSeriesDataPointFormsOutput': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'listing': { 'listingId': 'string', 'listingStatus': 'CREATING'|'ACTIVE'|'INACTIVE' }, 'name': 'string', 'owningProjectId': 'string', 'predictionConfiguration': { 'businessNameGeneration': { 'enabled': True|False } }, 'readOnlyFormsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'revision': 'string', 'typeIdentifier': 'string', 'typeRevision': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the asset revision occured. * **createdBy** *(string) --* The Amazon DataZone user who performed the asset revision. * **description** *(string) --* The revised asset description. * **domainId** *(string) --* The unique identifier of the Amazon DataZone domain where the asset was revised. * **externalIdentifier** *(string) --* The external identifier of the asset. * **firstRevisionCreatedAt** *(datetime) --* The timestamp of when the first asset revision occured. * **firstRevisionCreatedBy** *(string) --* The Amazon DataZone user who performed the first asset revision. * **formsOutput** *(list) --* The metadata forms that were attached to the asset as part of the asset revision. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **glossaryTerms** *(list) --* The glossary terms that were attached to the asset as part of asset revision. * *(string) --* * **id** *(string) --* The unique identifier of the asset revision. * **latestTimeSeriesDataPointFormsOutput** *(list) --* The latest data point that was imported into the time series form for the asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **listing** *(dict) --* The details of an asset published in an Amazon DataZone catalog. * **listingId** *(string) --* The identifier of an asset published in an Amazon DataZone catalog. * **listingStatus** *(string) --* The status of an asset published in an Amazon DataZone catalog. * **name** *(string) --* The revised name of the asset. * **owningProjectId** *(string) --* The unique identifier of the revised project that owns the asset. * **predictionConfiguration** *(dict) --* The configuration of the automatically generated business- friendly metadata for the asset. * **businessNameGeneration** *(dict) --* The business name generation mechanism. * **enabled** *(boolean) --* Specifies whether the business name generation is enabled. * **readOnlyFormsOutput** *(list) --* The read-only metadata forms that were attached to the asset as part of the asset revision. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **revision** *(string) --* The revision of the asset. * **typeIdentifier** *(string) --* The identifier of the revision type. * **typeRevision** *(string) --* The revision type of the asset. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_glossary create_glossary *************** DataZone.Client.create_glossary(**kwargs) Creates an Amazon DataZone business glossary. See also: AWS API Documentation **Request Syntax** response = client.create_glossary( clientToken='string', description='string', domainIdentifier='string', name='string', owningProjectIdentifier='string', status='DISABLED'|'ENABLED' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description of this business glossary. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this business glossary is created. * **name** (*string*) -- **[REQUIRED]** The name of this business glossary. * **owningProjectIdentifier** (*string*) -- **[REQUIRED]** The ID of the project that currently owns business glossary. * **status** (*string*) -- The status of this business glossary. Return type: dict Returns: **Response Syntax** { 'description': 'string', 'domainId': 'string', 'id': 'string', 'name': 'string', 'owningProjectId': 'string', 'status': 'DISABLED'|'ENABLED' } **Response Structure** * *(dict) --* * **description** *(string) --* The description of this business glossary. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which this business glossary is created. * **id** *(string) --* The ID of this business glossary. * **name** *(string) --* The name of this business glossary. * **owningProjectId** *(string) --* The ID of the project that currently owns this business glossary. * **status** *(string) --* The status of this business glossary. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_asset delete_asset ************ DataZone.Client.delete_asset(**kwargs) Deletes an asset in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_asset( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the asset is deleted. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the asset that is deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_subscription_grants list_subscription_grants ************************ DataZone.Client.list_subscription_grants(**kwargs) Lists subscription grants. See also: AWS API Documentation **Request Syntax** response = client.list_subscription_grants( domainIdentifier='string', environmentId='string', maxResults=123, nextToken='string', owningProjectId='string', sortBy='CREATED_AT'|'UPDATED_AT', sortOrder='ASCENDING'|'DESCENDING', subscribedListingId='string', subscriptionId='string', subscriptionTargetId='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **environmentId** (*string*) -- The identifier of the Amazon DataZone environment. * **maxResults** (*integer*) -- The maximum number of subscription grants to return in a single call to "ListSubscriptionGrants". When the number of subscription grants to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListSubscriptionGrants" to list the next set of subscription grants. * **nextToken** (*string*) -- When the number of subscription grants is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of subscription grants, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListSubscriptionGrants" to list the next set of subscription grants. * **owningProjectId** (*string*) -- The ID of the owning project of the subscription grants. * **sortBy** (*string*) -- Specifies the way of sorting the results of this action. * **sortOrder** (*string*) -- Specifies the sort order of this action. * **subscribedListingId** (*string*) -- The identifier of the subscribed listing. * **subscriptionId** (*string*) -- The identifier of the subscription. * **subscriptionTargetId** (*string*) -- The identifier of the subscription target. Return type: dict Returns: **Response Syntax** { 'items': [ { 'assets': [ { 'assetId': 'string', 'assetRevision': 'string', 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'failureCause': { 'message': 'string' }, 'failureTimestamp': datetime(2015, 1, 1), 'grantedTimestamp': datetime(2015, 1, 1), 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED', 'targetName': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'grantedEntity': { 'listing': { 'id': 'string', 'revision': 'string' } }, 'id': 'string', 'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE', 'subscriptionId': 'string', 'subscriptionTargetId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "ListSubscriptionGrants" action. * *(dict) --* The details of the subscription grant. * **assets** *(list) --* The assets included in the subscription grant. * *(dict) --* The details of the asset for which the subscription grant is created. * **assetId** *(string) --* The identifier of the asset for which the subscription grant is created. * **assetRevision** *(string) --* The revision of the asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **failureCause** *(dict) --* The failure cause included in the details of the asset for which the subscription grant is created. * **message** *(string) --* The description of the error message. * **failureTimestamp** *(datetime) --* The failure timestamp included in the details of the asset for which the subscription grant is created. * **grantedTimestamp** *(datetime) --* The timestamp of when the subscription grant to the asset is created. * **status** *(string) --* The status of the asset for which the subscription grant is created. * **targetName** *(string) --* The target name of the asset for which the subscription grant is created. * **createdAt** *(datetime) --* The timestamp of when a subscription grant was created. * **createdBy** *(string) --* The datazone user who created the subscription grant. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a subscription grant exists. * **grantedEntity** *(dict) --* The entity to which the subscription is granted. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "listing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **listing** *(dict) --* The listing for which a subscription is granted. * **id** *(string) --* An identifier of a revision of an asset published in a Amazon DataZone catalog. * **revision** *(string) --* The details of a revision of an asset published in a Amazon DataZone catalog. * **id** *(string) --* The identifier of the subscription grant. * **status** *(string) --* The status of the subscription grant. * **subscriptionId** *(string) --* The ID of the subscription. * **subscriptionTargetId** *(string) --* The identifier of the target of the subscription grant. * **updatedAt** *(datetime) --* The timestampf of when the subscription grant was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription grant. * **nextToken** *(string) --* When the number of subscription grants is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of subscription grants, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "ListSubscriptionGrants" to list the next set of subscription grants. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_subscription get_subscription **************** DataZone.Client.get_subscription(**kwargs) Gets a subscription in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_subscription( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the subscription exists. * **identifier** (*string*) -- **[REQUIRED]** The ID of the subscription. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'retainPermissions': True|False, 'status': 'APPROVED'|'REVOKED'|'CANCELLED', 'subscribedListing': { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, 'subscribedPrincipal': { 'project': { 'id': 'string', 'name': 'string' } }, 'subscriptionRequestId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the subscription was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the subscription exists. * **id** *(string) --* The ID of the subscription. * **retainPermissions** *(boolean) --* The retain permissions of the subscription. * **status** *(string) --* The status of the subscription. * **subscribedListing** *(dict) --* The details of the published asset for which the subscription grant is created. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipal** *(dict) --* The principal that owns the subscription. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **subscriptionRequestId** *(string) --* The ID of the subscription request. * **updatedAt** *(datetime) --* The timestamp of when the subscription was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_listing get_listing *********** DataZone.Client.get_listing(**kwargs) Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned. See also: AWS API Documentation **Request Syntax** response = client.get_listing( domainIdentifier='string', identifier='string', listingRevision='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain. * **identifier** (*string*) -- **[REQUIRED]** The ID of the listing. * **listingRevision** (*string*) -- The revision of the listing. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetId': 'string', 'assetRevision': 'string', 'assetType': 'string', 'createdAt': datetime(2015, 1, 1), 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'latestTimeSeriesDataPointForms': [ { 'contentSummary': 'string', 'formName': 'string', 'id': 'string', 'timestamp': datetime(2015, 1, 1), 'typeIdentifier': 'string', 'typeRevision': 'string' }, ], 'owningProjectId': 'string' }, 'dataProductListing': { 'createdAt': datetime(2015, 1, 1), 'dataProductId': 'string', 'dataProductRevision': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'items': [ { 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'listingId': 'string', 'listingRevision': 'string' }, ], 'owningProjectId': 'string' } }, 'listingRevision': 'string', 'name': 'string', 'status': 'CREATING'|'ACTIVE'|'INACTIVE', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the listing was created. * **createdBy** *(string) --* The Amazon DataZone user who created the listing. * **description** *(string) --* The description of the listing. * **domainId** *(string) --* The ID of the Amazon DataZone domain. * **id** *(string) --* The ID of the listing. * **item** *(dict) --* The details of a listing. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "dataProductListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* An asset published in an Amazon DataZone catalog. * **assetId** *(string) --* The identifier of an asset published in an Amazon DataZone catalog. * **assetRevision** *(string) --* The revision of an asset published in an Amazon DataZone catalog. * **assetType** *(string) --* The type of an asset published in an Amazon DataZone catalog. * **createdAt** *(datetime) --* The timestamp of when an asset published in an Amazon DataZone catalog was created. * **forms** *(string) --* The metadata forms attached to an asset published in an Amazon DataZone catalog. * **glossaryTerms** *(list) --* The glossary terms attached to an asset published in an Amazon DataZone catalog. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **latestTimeSeriesDataPointForms** *(list) --* The latest time series data points forms included in the additional attributes of an asset. * *(dict) --* The summary of the time series data points form. * **contentSummary** *(string) --* The content of the summary of the time series data points form. * **formName** *(string) --* The name of the time series data points summary form. * **id** *(string) --* The ID of the time series data points summary form. * **timestamp** *(datetime) --* The timestamp of the time series data points summary form. * **typeIdentifier** *(string) --* The type ID of the time series data points summary form. * **typeRevision** *(string) --* The type revision of the time series data points summary form. * **owningProjectId** *(string) --* The identifier of the project where an asset published in an Amazon DataZone catalog exists. * **dataProductListing** *(dict) --* The data product listing. * **createdAt** *(datetime) --* The timestamp at which the data product listing was created. * **dataProductId** *(string) --* The ID of the data product listing. * **dataProductRevision** *(string) --* The revision of the data product listing. * **forms** *(string) --* The metadata forms of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **items** *(list) --* The data assets of the data product listing. * *(dict) --* The summary of the listing of the data product. * **glossaryTerms** *(list) --* The glossary terms of the data product. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **listingId** *(string) --* The ID of the data product listing. * **listingRevision** *(string) --* The revision of the data product listing. * **owningProjectId** *(string) --* The ID of the owning project of the data product listing. * **listingRevision** *(string) --* The revision of a listing. * **name** *(string) --* The name of the listing. * **status** *(string) --* The status of the listing. * **updatedAt** *(datetime) --* The timestamp of when the listing was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the listing. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_project_profile get_project_profile ******************* DataZone.Client.get_project_profile(**kwargs) The details of the project profile. See also: AWS API Documentation **Request Syntax** response = client.get_project_profile( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain. * **identifier** (*string*) -- **[REQUIRED]** The ID of the project profile. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentConfigurations': [ { 'awsAccount': { 'awsAccountId': 'string', 'awsAccountIdPath': 'string' }, 'awsRegion': { 'regionName': 'string', 'regionNamePath': 'string' }, 'configurationParameters': { 'parameterOverrides': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'resolvedParameters': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'ssmPath': 'string' }, 'deploymentMode': 'ON_CREATE'|'ON_DEMAND', 'deploymentOrder': 123, 'description': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string' }, ], 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ENABLED'|'DISABLED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the project profile was created. * **createdBy** *(string) --* The user who created the project profile. * **description** *(string) --* The description of the project profile. * **domainId** *(string) --* The ID of the domain of the project profile. * **domainUnitId** *(string) --* The ID of the domain unit of the project profile. * **environmentConfigurations** *(list) --* The environment configurations of the project profile. * *(dict) --* The configuration of an environment. * **awsAccount** *(dict) --* The Amazon Web Services account of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "awsAccountId", "awsAccountIdPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **awsAccountId** *(string) --* The account ID of a project. * **awsAccountIdPath** *(string) --* The account ID path of a project. * **awsRegion** *(dict) --* The Amazon Web Services Region of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "regionName", "regionNamePath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **regionName** *(string) --* The Amazon Web Services Region name. * **regionNamePath** *(string) --* The region name path. * **configurationParameters** *(dict) --* The configuration parameters of the environment. * **parameterOverrides** *(list) --* The parameter overrides. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **resolvedParameters** *(list) --* The resolved environment configuration parameters. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **ssmPath** *(string) --* Ssm path environment configuration parameters. * **deploymentMode** *(string) --* The deployment mode of the environment. * **deploymentOrder** *(integer) --* The deployment order of the environment. * **description** *(string) --* The environment description. * **environmentBlueprintId** *(string) --* The environment blueprint ID. * **id** *(string) --* The environment ID. * **name** *(string) --* The environment name. * **id** *(string) --* The ID of the project profile. * **lastUpdatedAt** *(datetime) --* The timestamp of when project profile was last updated. * **name** *(string) --* The name of the project profile. * **status** *(string) --* The status of the project profile. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_user_profile get_user_profile **************** DataZone.Client.get_user_profile(**kwargs) Gets a user profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_user_profile( domainIdentifier='string', type='IAM'|'SSO', userIdentifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** the ID of the Amazon DataZone domain the data portal of which you want to get. * **type** (*string*) -- The type of the user profile. * **userIdentifier** (*string*) -- **[REQUIRED]** The identifier of the user for which you want to get the user profile. Return type: dict Returns: **Response Syntax** { 'details': { 'iam': { 'arn': 'string' }, 'sso': { 'firstName': 'string', 'lastName': 'string', 'username': 'string' } }, 'domainId': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED', 'type': 'IAM'|'SSO' } **Response Structure** * *(dict) --* * **details** *(dict) --* The details of the user profile in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "iam", "sso". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **iam** *(dict) --* The IAM details included in the user profile details. * **arn** *(string) --* The ARN of an IAM user profile in Amazon DataZone. * **sso** *(dict) --* The single sign-on details included in the user profile details. * **firstName** *(string) --* The first name included in the single sign-on details of the user profile. * **lastName** *(string) --* The last name included in the single sign-on details of the user profile. * **username** *(string) --* The username included in the single sign-on details of the user profile. * **domainId** *(string) --* the identifier of the Amazon DataZone domain of which you want to get the user profile. * **id** *(string) --* The identifier of the user profile. * **status** *(string) --* The status of the user profile. * **type** *(string) --* The type of the user profile. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_subscription_target create_subscription_target ************************** DataZone.Client.create_subscription_target(**kwargs) Creates a subscription target in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.create_subscription_target( applicableAssetTypes=[ 'string', ], authorizedPrincipals=[ 'string', ], clientToken='string', domainIdentifier='string', environmentIdentifier='string', manageAccessRole='string', name='string', provider='string', subscriptionTargetConfig=[ { 'content': 'string', 'formName': 'string' }, ], type='string' ) Parameters: * **applicableAssetTypes** (*list*) -- **[REQUIRED]** The asset types that can be included in the subscription target. * *(string) --* * **authorizedPrincipals** (*list*) -- **[REQUIRED]** The authorized principals of the subscription target. * *(string) --* * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which subscription target is created. * **environmentIdentifier** (*string*) -- **[REQUIRED]** The ID of the environment in which subscription target is created. * **manageAccessRole** (*string*) -- **[REQUIRED]** The manage access role that is used to create the subscription target. * **name** (*string*) -- **[REQUIRED]** The name of the subscription target. * **provider** (*string*) -- The provider of the subscription target. * **subscriptionTargetConfig** (*list*) -- **[REQUIRED]** The configuration of the subscription target. * *(dict) --* The details of the subscription target configuration. * **content** *(string) --* **[REQUIRED]** The content of the subscription target configuration. * **formName** *(string) --* **[REQUIRED]** The form name included in the subscription target configuration. * **type** (*string*) -- **[REQUIRED]** The type of the subscription target. Return type: dict Returns: **Response Syntax** { 'applicableAssetTypes': [ 'string', ], 'authorizedPrincipals': [ 'string', ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'environmentId': 'string', 'id': 'string', 'manageAccessRole': 'string', 'name': 'string', 'projectId': 'string', 'provider': 'string', 'subscriptionTargetConfig': [ { 'content': 'string', 'formName': 'string' }, ], 'type': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **applicableAssetTypes** *(list) --* The asset types that can be included in the subscription target. * *(string) --* * **authorizedPrincipals** *(list) --* The authorised principals of the subscription target. * *(string) --* * **createdAt** *(datetime) --* The timestamp of when the subscription target was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription target. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the subscription target was created. * **environmentId** *(string) --* The ID of the environment in which the subscription target was created. * **id** *(string) --* The ID of the subscription target. * **manageAccessRole** *(string) --* The manage access role with which the subscription target was created. * **name** *(string) --* The name of the subscription target. * **projectId** *(string) --* ??? * **provider** *(string) --* The provider of the subscription target. * **subscriptionTargetConfig** *(list) --* The configuration of the subscription target. * *(dict) --* The details of the subscription target configuration. * **content** *(string) --* The content of the subscription target configuration. * **formName** *(string) --* The form name included in the subscription target configuration. * **type** *(string) --* The type of the subscription target. * **updatedAt** *(datetime) --* The timestamp of when the subscription target was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription target. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / reject_subscription_request reject_subscription_request *************************** DataZone.Client.reject_subscription_request(**kwargs) Rejects the specified subscription request. See also: AWS API Documentation **Request Syntax** response = client.reject_subscription_request( decisionComment='string', domainIdentifier='string', identifier='string' ) Parameters: * **decisionComment** (*string*) -- The decision comment of the rejected subscription request. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which the subscription request was rejected. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the subscription request that was rejected. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'decisionComment': 'string', 'domainId': 'string', 'existingSubscriptionId': 'string', 'id': 'string', 'metadataForms': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'requestReason': 'string', 'reviewerId': 'string', 'status': 'PENDING'|'ACCEPTED'|'REJECTED', 'subscribedListings': [ { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, ], 'subscribedPrincipals': [ { 'project': { 'id': 'string', 'name': 'string' } }, ], 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the subscription request was rejected. * **createdBy** *(string) --* The timestamp of when the subscription request was rejected. * **decisionComment** *(string) --* The decision comment of the rejected subscription request. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which the subscription request was rejected. * **existingSubscriptionId** *(string) --* The ID of the existing subscription. * **id** *(string) --* The identifier of the subscription request that was rejected. * **metadataForms** *(list) --* Metadata forms included in the subscription request. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **requestReason** *(string) --* The reason for the subscription request. * **reviewerId** *(string) --* The identifier of the subscription request reviewer. * **status** *(string) --* The status of the subscription request. * **subscribedListings** *(list) --* The subscribed listings of the subscription request. * *(dict) --* The details of the published asset for which the subscription grant is created. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipals** *(list) --* The subscribed principals of the subscription request. * *(dict) --* The principal that has the subscription grant for the asset. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **updatedAt** *(datetime) --* The timestamp of when the subscription request was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription request. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_subscription_grant delete_subscription_grant ************************* DataZone.Client.delete_subscription_grant(**kwargs) Deletes and subscription grant in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_subscription_grant( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain where the subscription grant is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the subscription grant that is deleted. Return type: dict Returns: **Response Syntax** { 'assets': [ { 'assetId': 'string', 'assetRevision': 'string', 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'failureCause': { 'message': 'string' }, 'failureTimestamp': datetime(2015, 1, 1), 'grantedTimestamp': datetime(2015, 1, 1), 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED', 'targetName': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'grantedEntity': { 'listing': { 'id': 'string', 'revision': 'string' } }, 'id': 'string', 'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE', 'subscriptionId': 'string', 'subscriptionTargetId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **assets** *(list) --* The assets for which the subsctiption grant that is deleted gave access. * *(dict) --* The details of the asset for which the subscription grant is created. * **assetId** *(string) --* The identifier of the asset for which the subscription grant is created. * **assetRevision** *(string) --* The revision of the asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **failureCause** *(dict) --* The failure cause included in the details of the asset for which the subscription grant is created. * **message** *(string) --* The description of the error message. * **failureTimestamp** *(datetime) --* The failure timestamp included in the details of the asset for which the subscription grant is created. * **grantedTimestamp** *(datetime) --* The timestamp of when the subscription grant to the asset is created. * **status** *(string) --* The status of the asset for which the subscription grant is created. * **targetName** *(string) --* The target name of the asset for which the subscription grant is created. * **createdAt** *(datetime) --* The timestamp of when the subscription grant that is deleted was created. * **createdBy** *(string) --* The Amazon DataZone user who created the subscription grant that is deleted. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which the subscription grant is deleted. * **grantedEntity** *(dict) --* The entity to which the subscription is deleted. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "listing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **listing** *(dict) --* The listing for which a subscription is granted. * **id** *(string) --* An identifier of a revision of an asset published in a Amazon DataZone catalog. * **revision** *(string) --* The details of a revision of an asset published in a Amazon DataZone catalog. * **id** *(string) --* The ID of the subscription grant that is deleted. * **status** *(string) --* The status of the subscription grant that is deleted. * **subscriptionId** *(string) --* The identifier of the subsctiption whose subscription grant is to be deleted. * **subscriptionTargetId** *(string) --* The ID of the subscription target associated with the subscription grant that is deleted. * **updatedAt** *(datetime) --* The timestamp of when the subscription grant that is deleted was updated. * **updatedBy** *(string) --* The Amazon DataZone user who updated the subscription grant that is deleted. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_form_type create_form_type **************** DataZone.Client.create_form_type(**kwargs) Creates a metadata form type. See also: AWS API Documentation **Request Syntax** response = client.create_form_type( description='string', domainIdentifier='string', model={ 'smithy': 'string' }, name='string', owningProjectIdentifier='string', status='ENABLED'|'DISABLED' ) Parameters: * **description** (*string*) -- The description of this Amazon DataZone metadata form type. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which this metadata form type is created. * **model** (*dict*) -- **[REQUIRED]** The model of this Amazon DataZone metadata form type. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "smithy". * **smithy** *(string) --* Indicates the smithy model of the API. * **name** (*string*) -- **[REQUIRED]** The name of this Amazon DataZone metadata form type. * **owningProjectIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone project that owns this metadata form type. * **status** (*string*) -- The status of this Amazon DataZone metadata form type. Return type: dict Returns: **Response Syntax** { 'description': 'string', 'domainId': 'string', 'name': 'string', 'originDomainId': 'string', 'originProjectId': 'string', 'owningProjectId': 'string', 'revision': 'string' } **Response Structure** * *(dict) --* * **description** *(string) --* The description of this Amazon DataZone metadata form type. * **domainId** *(string) --* The ID of the Amazon DataZone domain in which this metadata form type is created. * **name** *(string) --* The name of this Amazon DataZone metadata form type. * **originDomainId** *(string) --* The ID of the Amazon DataZone domain in which this metadata form type was originally created. * **originProjectId** *(string) --* The ID of the project in which this Amazon DataZone metadata form type was originally created. * **owningProjectId** *(string) --* The ID of the project that owns this Amazon DataZone metadata form type. * **revision** *(string) --* The revision of this Amazon DataZone metadata form type. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_user_profile create_user_profile ******************* DataZone.Client.create_user_profile(**kwargs) Creates a user profile in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.create_user_profile( clientToken='string', domainIdentifier='string', userIdentifier='string', userType='IAM_USER'|'IAM_ROLE'|'SSO_USER' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which a user profile is created. * **userIdentifier** (*string*) -- **[REQUIRED]** The identifier of the user for which the user profile is created. * **userType** (*string*) -- The user type of the user for which the user profile is created. Return type: dict Returns: **Response Syntax** { 'details': { 'iam': { 'arn': 'string' }, 'sso': { 'firstName': 'string', 'lastName': 'string', 'username': 'string' } }, 'domainId': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED', 'type': 'IAM'|'SSO' } **Response Structure** * *(dict) --* * **details** *(dict) --* The details of the user profile in Amazon DataZone. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "iam", "sso". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **iam** *(dict) --* The IAM details included in the user profile details. * **arn** *(string) --* The ARN of an IAM user profile in Amazon DataZone. * **sso** *(dict) --* The single sign-on details included in the user profile details. * **firstName** *(string) --* The first name included in the single sign-on details of the user profile. * **lastName** *(string) --* The last name included in the single sign-on details of the user profile. * **username** *(string) --* The username included in the single sign-on details of the user profile. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a user profile is created. * **id** *(string) --* The identifier of the user profile. * **status** *(string) --* The status of the user profile. * **type** *(string) --* The type of the user profile. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / search_group_profiles search_group_profiles ********************* DataZone.Client.search_group_profiles(**kwargs) Searches group profiles in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.search_group_profiles( domainIdentifier='string', groupType='SSO_GROUP'|'DATAZONE_SSO_GROUP', maxResults=123, nextToken='string', searchText='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which you want to search group profiles. * **groupType** (*string*) -- **[REQUIRED]** The group type for which to search. * **maxResults** (*integer*) -- The maximum number of results to return in a single call to "SearchGroupProfiles". When the number of results to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "SearchGroupProfiles" to list the next set of results. * **nextToken** (*string*) -- When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchGroupProfiles" to list the next set of results. * **searchText** (*string*) -- Specifies the text for which to search. Return type: dict Returns: **Response Syntax** { 'items': [ { 'domainId': 'string', 'groupName': 'string', 'id': 'string', 'status': 'ASSIGNED'|'NOT_ASSIGNED' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **items** *(list) --* The results of the "SearchGroupProfiles" action. * *(dict) --* The details of a group profile. * **domainId** *(string) --* The ID of the Amazon DataZone domain of a group profile. * **groupName** *(string) --* The group name of a group profile. * **id** *(string) --* The ID of a group profile. * **status** *(string) --* The status of a group profile. * **nextToken** *(string) --* When the number of results is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of results, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to "SearchGroupProfiles" to list the next set of results. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / close close ***** DataZone.Client.close() Closes underlying endpoint connections. DataZone / Client / cancel_subscription cancel_subscription ******************* DataZone.Client.cancel_subscription(**kwargs) Cancels the subscription to the specified asset. See also: AWS API Documentation **Request Syntax** response = client.cancel_subscription( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled. * **identifier** (*string*) -- **[REQUIRED]** The unique identifier of the subscription that is being cancelled. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'retainPermissions': True|False, 'status': 'APPROVED'|'REVOKED'|'CANCELLED', 'subscribedListing': { 'description': 'string', 'id': 'string', 'item': { 'assetListing': { 'assetScope': { 'assetId': 'string', 'errorMessage': 'string', 'filterIds': [ 'string', ], 'status': 'string' }, 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string', 'forms': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ] }, 'productListing': { 'assetListings': [ { 'entityId': 'string', 'entityRevision': 'string', 'entityType': 'string' }, ], 'description': 'string', 'entityId': 'string', 'entityRevision': 'string', 'glossaryTerms': [ { 'name': 'string', 'shortDescription': 'string' }, ], 'name': 'string' } }, 'name': 'string', 'ownerProjectId': 'string', 'ownerProjectName': 'string', 'revision': 'string' }, 'subscribedPrincipal': { 'project': { 'id': 'string', 'name': 'string' } }, 'subscriptionRequestId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp that specifies when the request to cancel the subscription was created. * **createdBy** *(string) --* Specifies the Amazon DataZone user who is cancelling the subscription. * **domainId** *(string) --* The unique identifier of the Amazon DataZone domain where the subscription is being cancelled. * **id** *(string) --* The identifier of the subscription. * **retainPermissions** *(boolean) --* Specifies whether the permissions to the asset are retained after the subscription is cancelled. * **status** *(string) --* The status of the request to cancel the subscription. * **subscribedListing** *(dict) --* The asset to which a subscription is being cancelled. * **description** *(string) --* The description of the published asset for which the subscription grant is created. * **id** *(string) --* The identifier of the published asset for which the subscription grant is created. * **item** *(dict) --* The published asset for which the subscription grant is created. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "assetListing", "productListing". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **assetListing** *(dict) --* The asset for which the subscription grant is created. * **assetScope** *(dict) --* The asset scope of the subscribed asset listing. * **assetId** *(string) --* The asset ID of the asset scope. * **errorMessage** *(string) --* The error message of the asset scope. * **filterIds** *(list) --* The filter IDs of the asset scope. * *(string) --* * **status** *(string) --* The status of the asset scope. * **entityId** *(string) --* The identifier of the published asset for which the subscription grant is created. * **entityRevision** *(string) --* The revision of the published asset for which the subscription grant is created. * **entityType** *(string) --* The type of the published asset for which the subscription grant is created. * **forms** *(string) --* The forms attached to the published asset for which the subscription grant is created. * **glossaryTerms** *(list) --* The glossary terms attached to the published asset for which the subscription grant is created. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **productListing** *(dict) --* The data product listing. * **assetListings** *(list) --* The data assets of the data product listing. * *(dict) --* The listing of the asset in a data product. * **entityId** *(string) --* The entity ID of the listing of the asset in a data product. * **entityRevision** *(string) --* The entity revision of the listing of the asset in a data product. * **entityType** *(string) --* The entity type of the listing of the asset in a data product. * **description** *(string) --* The description of the data product listing. * **entityId** *(string) --* The ID of the data product listing. * **entityRevision** *(string) --* The revision of the data product listing. * **glossaryTerms** *(list) --* The glossary terms of the data product listing. * *(dict) --* Details of a glossary term attached to the inventory asset. * **name** *(string) --* The name of a glossary term attached to the inventory asset. * **shortDescription** *(string) --* The shoft description of a glossary term attached to the inventory asset. * **name** *(string) --* The name of the data product listing. * **name** *(string) --* The name of the published asset for which the subscription grant is created. * **ownerProjectId** *(string) --* The identifier of the project of the published asset for which the subscription grant is created. * **ownerProjectName** *(string) --* The name of the project that owns the published asset for which the subscription grant is created. * **revision** *(string) --* The revision of the published asset for which the subscription grant is created. * **subscribedPrincipal** *(dict) --* The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "project". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **project** *(dict) --* The project that has the subscription grant. * **id** *(string) --* The identifier of the project that has the subscription grant. * **name** *(string) --* The name of the project that has the subscription grant. * **subscriptionRequestId** *(string) --* The unique ID of the subscripton request for the subscription that is being cancelled. * **updatedAt** *(datetime) --* The timestamp that specifies when the subscription was cancelled. * **updatedBy** *(string) --* The Amazon DataZone user that cancelled the subscription. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / post_lineage_event post_lineage_event ****************** DataZone.Client.post_lineage_event(**kwargs) Posts a data lineage event. See also: AWS API Documentation **Request Syntax** response = client.post_lineage_event( clientToken='string', domainIdentifier='string', event=b'bytes'|file ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to post a data lineage event. * **event** (*bytes** or **seekable file-like object*) -- **[REQUIRED]** The data lineage event that you want to post. Only open- lineage run event are supported as events. Return type: dict Returns: **Response Syntax** { 'domainId': 'string', 'id': 'string' } **Response Structure** * *(dict) --* * **domainId** *(string) --* The ID of the domain. * **id** *(string) --* The ID of the lineage event. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / update_glossary update_glossary *************** DataZone.Client.update_glossary(**kwargs) Updates the business glossary in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.update_glossary( clientToken='string', description='string', domainIdentifier='string', identifier='string', name='string', status='DISABLED'|'ENABLED' ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **description** (*string*) -- The description to be updated as part of the "UpdateGlossary" action. * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain in which a business glossary is to be updated. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the business glossary to be updated. * **name** (*string*) -- The name to be updated as part of the "UpdateGlossary" action. * **status** (*string*) -- The status to be updated as part of the "UpdateGlossary" action. Return type: dict Returns: **Response Syntax** { 'description': 'string', 'domainId': 'string', 'id': 'string', 'name': 'string', 'owningProjectId': 'string', 'status': 'DISABLED'|'ENABLED' } **Response Structure** * *(dict) --* * **description** *(string) --* The description to be updated as part of the "UpdateGlossary" action. * **domainId** *(string) --* The identifier of the Amazon DataZone domain in which a business glossary is to be updated. * **id** *(string) --* The identifier of the business glossary that is to be updated. * **name** *(string) --* The name to be updated as part of the "UpdateGlossary" action. * **owningProjectId** *(string) --* The identifier of the project in which to update a business glossary. * **status** *(string) --* The status to be updated as part of the "UpdateGlossary" action. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_data_source_run get_data_source_run ******************* DataZone.Client.get_data_source_run(**kwargs) Gets an Amazon DataZone data source run. See also: AWS API Documentation **Request Syntax** response = client.get_data_source_run( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain in which this data source run was performed. * **identifier** (*string*) -- **[REQUIRED]** The ID of the data source run. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'dataSourceConfigurationSnapshot': 'string', 'dataSourceId': 'string', 'domainId': 'string', 'errorMessage': { 'errorDetail': 'string', 'errorType': 'ACCESS_DENIED_EXCEPTION'|'CONFLICT_EXCEPTION'|'INTERNAL_SERVER_EXCEPTION'|'RESOURCE_NOT_FOUND_EXCEPTION'|'SERVICE_QUOTA_EXCEEDED_EXCEPTION'|'THROTTLING_EXCEPTION'|'VALIDATION_EXCEPTION' }, 'id': 'string', 'lineageSummary': { 'importStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'PARTIALLY_SUCCEEDED' }, 'projectId': 'string', 'runStatisticsForAssets': { 'added': 123, 'failed': 123, 'skipped': 123, 'unchanged': 123, 'updated': 123 }, 'startedAt': datetime(2015, 1, 1), 'status': 'REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS', 'stoppedAt': datetime(2015, 1, 1), 'type': 'PRIORITIZED'|'SCHEDULED', 'updatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the data source run was created. * **dataSourceConfigurationSnapshot** *(string) --* The configuration snapshot of the data source run. * **dataSourceId** *(string) --* The ID of the data source for this data source run. * **domainId** *(string) --* The ID of the domain in which this data source run was performed. * **errorMessage** *(dict) --* Specifies the error message that is returned if the operation cannot be successfully completed. * **errorDetail** *(string) --* The details of the error message that is returned if the operation cannot be successfully completed. * **errorType** *(string) --* The type of the error message that is returned if the operation cannot be successfully completed. * **id** *(string) --* The ID of the data source run. * **lineageSummary** *(dict) --* The summary of the data lineage. * **importStatus** *(string) --* The import status that's part of the run lineage summary of a data source. * **projectId** *(string) --* The ID of the project in which this data source run occured. * **runStatisticsForAssets** *(dict) --* The asset statistics from this data source run. * **added** *(integer) --* The "added" statistic for the data source run. * **failed** *(integer) --* The "failed" statistic for the data source run. * **skipped** *(integer) --* The "skipped" statistic for the data source run. * **unchanged** *(integer) --* The "unchanged" statistic for the data source run. * **updated** *(integer) --* The "updated" statistic for the data source run. * **startedAt** *(datetime) --* The timestamp of when this data source run started. * **status** *(string) --* The status of this data source run. * **stoppedAt** *(datetime) --* The timestamp of when this data source run stopped. * **type** *(string) --* The type of this data source run. * **updatedAt** *(datetime) --* The timestamp of when this data source run was updated. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_connection delete_connection ***************** DataZone.Client.delete_connection(**kwargs) Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. See also: AWS API Documentation **Request Syntax** response = client.delete_connection( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where the connection is deleted. * **identifier** (*string*) -- **[REQUIRED]** The ID of the connection that is deleted. Return type: dict Returns: **Response Syntax** { 'status': 'string' } **Response Structure** * *(dict) --* * **status** *(string) --* The status of the action. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_lineage_node get_lineage_node **************** DataZone.Client.get_lineage_node(**kwargs) Gets the data lineage node. See also: AWS API Documentation **Request Syntax** response = client.get_lineage_node( domainIdentifier='string', eventTimestamp=datetime(2015, 1, 1), identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain in which you want to get the data lineage node. * **eventTimestamp** (*datetime*) -- The event time stamp for which you want to get the data lineage node. * **identifier** (*string*) -- **[REQUIRED]** The ID of the data lineage node that you want to get. Both, a lineage node identifier generated by Amazon DataZone and a "sourceIdentifier" of the lineage node are supported. If "sourceIdentifier" is greater than 1800 characters, you can use lineage node identifier generated by Amazon DataZone to get the node details. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'downstreamNodes': [ { 'eventTimestamp': datetime(2015, 1, 1), 'id': 'string' }, ], 'eventTimestamp': datetime(2015, 1, 1), 'formsOutput': [ { 'content': 'string', 'formName': 'string', 'typeName': 'string', 'typeRevision': 'string' }, ], 'id': 'string', 'name': 'string', 'sourceIdentifier': 'string', 'typeName': 'string', 'typeRevision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'upstreamNodes': [ { 'eventTimestamp': datetime(2015, 1, 1), 'id': 'string' }, ] } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp at which the data lineage node was created. * **createdBy** *(string) --* The user who created the data lineage node. * **description** *(string) --* The description of the data lineage node. * **domainId** *(string) --* The ID of the domain where you're getting the data lineage node. * **downstreamNodes** *(list) --* The downsteam nodes of the specified data lineage node. * *(dict) --* The reference details for the data lineage node. * **eventTimestamp** *(datetime) --* The event timestamp of the data lineage node. * **id** *(string) --* The ID of the data lineage node. * **eventTimestamp** *(datetime) --* The timestamp of the event described in the data lineage node. * **formsOutput** *(list) --* The metadata of the specified data lineage node. * *(dict) --* The details of a metadata form. * **content** *(string) --* The content of the metadata form. * **formName** *(string) --* The name of the metadata form. * **typeName** *(string) --* The name of the metadata form type. * **typeRevision** *(string) --* The revision of the metadata form type. * **id** *(string) --* The ID of the data lineage node. * **name** *(string) --* The name of the data lineage node. * **sourceIdentifier** *(string) --* The source identifier of the data lineage node. * **typeName** *(string) --* The name of the type of the specified data lineage node. * **typeRevision** *(string) --* The revision type of the specified data lineage node. * **updatedAt** *(datetime) --* The timestamp at which the data lineage node was updated. * **updatedBy** *(string) --* The user who updated the data lineage node. * **upstreamNodes** *(list) --* The upstream nodes of the specified data lineage node. * *(dict) --* The reference details for the data lineage node. * **eventTimestamp** *(datetime) --* The event timestamp of the data lineage node. * **id** *(string) --* The ID of the data lineage node. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / remove_policy_grant remove_policy_grant ******************* DataZone.Client.remove_policy_grant(**kwargs) Removes a policy grant. See also: AWS API Documentation **Request Syntax** response = client.remove_policy_grant( clientToken='string', domainIdentifier='string', entityIdentifier='string', entityType='DOMAIN_UNIT'|'ENVIRONMENT_BLUEPRINT_CONFIGURATION'|'ENVIRONMENT_PROFILE'|'ASSET_TYPE', policyType='CREATE_DOMAIN_UNIT'|'OVERRIDE_DOMAIN_UNIT_OWNERS'|'ADD_TO_PROJECT_MEMBER_POOL'|'OVERRIDE_PROJECT_OWNERS'|'CREATE_GLOSSARY'|'CREATE_FORM_TYPE'|'CREATE_ASSET_TYPE'|'CREATE_PROJECT'|'CREATE_ENVIRONMENT_PROFILE'|'DELEGATE_CREATE_ENVIRONMENT_PROFILE'|'CREATE_ENVIRONMENT'|'CREATE_ENVIRONMENT_FROM_BLUEPRINT'|'CREATE_PROJECT_FROM_PROJECT_PROFILE'|'USE_ASSET_TYPE', principal={ 'domainUnit': { 'domainUnitDesignation': 'OWNER', 'domainUnitGrantFilter': { 'allDomainUnitsGrantFilter': {} }, 'domainUnitIdentifier': 'string' }, 'group': { 'groupIdentifier': 'string' }, 'project': { 'projectDesignation': 'OWNER'|'CONTRIBUTOR'|'PROJECT_CATALOG_STEWARD', 'projectGrantFilter': { 'domainUnitFilter': { 'domainUnit': 'string', 'includeChildDomainUnits': True|False } }, 'projectIdentifier': 'string' }, 'user': { 'allUsersGrantFilter': {} , 'userIdentifier': 'string' } } ) Parameters: * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to remove a policy grant. * **entityIdentifier** (*string*) -- **[REQUIRED]** The ID of the entity from which you want to remove a policy grant. * **entityType** (*string*) -- **[REQUIRED]** The type of the entity from which you want to remove a policy grant. * **policyType** (*string*) -- **[REQUIRED]** The type of the policy that you want to remove. * **principal** (*dict*) -- **[REQUIRED]** The principal from which you want to remove a policy grant. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "domainUnit", "group", "project", "user". * **domainUnit** *(dict) --* The domain unit of the policy grant principal. * **domainUnitDesignation** *(string) --* **[REQUIRED]** Specifes the designation of the domain unit users. * **domainUnitGrantFilter** *(dict) --* The grant filter for the domain unit. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "allDomainUnitsGrantFilter". * **allDomainUnitsGrantFilter** *(dict) --* Specifies a grant filter containing all domain units. * **domainUnitIdentifier** *(string) --* The ID of the domain unit. * **group** *(dict) --* The group of the policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "groupIdentifier". * **groupIdentifier** *(string) --* The ID Of the group of the group principal. * **project** *(dict) --* The project of the policy grant principal. * **projectDesignation** *(string) --* **[REQUIRED]** The project designation of the project policy grant principal. * **projectGrantFilter** *(dict) --* The project grant filter of the project policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "domainUnitFilter". * **domainUnitFilter** *(dict) --* The domain unit filter of the project grant filter. * **domainUnit** *(string) --* **[REQUIRED]** The domain unit ID to use in the filter. * **includeChildDomainUnits** *(boolean) --* Specifies whether to include child domain units. * **projectIdentifier** *(string) --* The project ID of the project policy grant principal. * **user** *(dict) --* The user of the policy grant principal. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "allUsersGrantFilter", "userIdentifier". * **allUsersGrantFilter** *(dict) --* The all users grant filter of the user policy grant principal. * **userIdentifier** *(string) --* The user ID of the user policy grant principal. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_asset_filter create_asset_filter ******************* DataZone.Client.create_asset_filter(**kwargs) Creates a data asset filter. See also: AWS API Documentation **Request Syntax** response = client.create_asset_filter( assetIdentifier='string', clientToken='string', configuration={ 'columnConfiguration': { 'includedColumnNames': [ 'string', ] }, 'rowConfiguration': { 'rowFilter': { 'and': [ {'... recursive ...'}, ], 'expression': { 'equalTo': { 'columnName': 'string', 'value': 'string' }, 'greaterThan': { 'columnName': 'string', 'value': 'string' }, 'greaterThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'in': { 'columnName': 'string', 'values': [ 'string', ] }, 'isNotNull': { 'columnName': 'string' }, 'isNull': { 'columnName': 'string' }, 'lessThan': { 'columnName': 'string', 'value': 'string' }, 'lessThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'like': { 'columnName': 'string', 'value': 'string' }, 'notEqualTo': { 'columnName': 'string', 'value': 'string' }, 'notIn': { 'columnName': 'string', 'values': [ 'string', ] }, 'notLike': { 'columnName': 'string', 'value': 'string' } }, 'or': [ {'... recursive ...'}, ] }, 'sensitive': True|False } }, description='string', domainIdentifier='string', name='string' ) Parameters: * **assetIdentifier** (*string*) -- **[REQUIRED]** The ID of the data asset. * **clientToken** (*string*) -- A unique, case-sensitive identifier that is provided to ensure the idempotency of the request. This field is autopopulated if not provided. * **configuration** (*dict*) -- **[REQUIRED]** The configuration of the asset filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "columnConfiguration", "rowConfiguration". * **columnConfiguration** *(dict) --* The column configuration of the asset filter. * **includedColumnNames** *(list) --* Specifies whether to include column names. * *(string) --* * **rowConfiguration** *(dict) --* The row configuration of the asset filter. * **rowFilter** *(dict) --* **[REQUIRED]** The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "expression", "or". * **and** *(list) --* The 'and' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "expression", "or". * **expression** *(dict) --* The expression of the row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "equalTo", "greaterThan", "greaterThanOrEqualTo", "in", "isNotNull", "isNull", "lessThan", "lessThanOrEqualTo", "like", "notEqualTo", "notIn", "notLike". * **equalTo** *(dict) --* The 'equal to' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be equal to an expression. * **greaterThan** *(dict) --* The 'greater than' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be greater than an expression. * **greaterThanOrEqualTo** *(dict) --* The 'greater than or equal to' clause of the filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be greater than or equal to an expression. * **in** *(dict) --* The 'in' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **values** *(list) --* **[REQUIRED]** The values that might be in the expression. * *(string) --* * **isNotNull** *(dict) --* The 'is not null' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **isNull** *(dict) --* The 'is null' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **lessThan** *(dict) --* The 'less than' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be less than the expression. * **lessThanOrEqualTo** *(dict) --* The 'less than or equal to' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be less than or equal to an expression. * **like** *(dict) --* The 'like' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might be like the expression. * **notEqualTo** *(dict) --* The 'no equal to' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might not be equal to the expression. * **notIn** *(dict) --* The 'not in' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **values** *(list) --* **[REQUIRED]** The value that might not be in the expression. * *(string) --* * **notLike** *(dict) --* The 'not like' clause of the row filter expression. * **columnName** *(string) --* **[REQUIRED]** The name of the column. * **value** *(string) --* **[REQUIRED]** The value that might not be like the expression. * **or** *(list) --* The 'or' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "and", "expression", "or". * **sensitive** *(boolean) --* Specifies whether the row filter is sensitive. * **description** (*string*) -- The description of the asset filter. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain in which you want to create an asset filter. * **name** (*string*) -- **[REQUIRED]** The name of the asset filter. Return type: dict Returns: **Response Syntax** { 'assetId': 'string', 'configuration': { 'columnConfiguration': { 'includedColumnNames': [ 'string', ] }, 'rowConfiguration': { 'rowFilter': { 'and': [ {'... recursive ...'}, ], 'expression': { 'equalTo': { 'columnName': 'string', 'value': 'string' }, 'greaterThan': { 'columnName': 'string', 'value': 'string' }, 'greaterThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'in': { 'columnName': 'string', 'values': [ 'string', ] }, 'isNotNull': { 'columnName': 'string' }, 'isNull': { 'columnName': 'string' }, 'lessThan': { 'columnName': 'string', 'value': 'string' }, 'lessThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'like': { 'columnName': 'string', 'value': 'string' }, 'notEqualTo': { 'columnName': 'string', 'value': 'string' }, 'notIn': { 'columnName': 'string', 'values': [ 'string', ] }, 'notLike': { 'columnName': 'string', 'value': 'string' } }, 'or': [ {'... recursive ...'}, ] }, 'sensitive': True|False } }, 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'effectiveColumnNames': [ 'string', ], 'effectiveRowFilter': 'string', 'errorMessage': 'string', 'id': 'string', 'name': 'string', 'status': 'VALID'|'INVALID' } **Response Structure** * *(dict) --* * **assetId** *(string) --* The ID of the asset. * **configuration** *(dict) --* The configuration of the asset filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "columnConfiguration", "rowConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **columnConfiguration** *(dict) --* The column configuration of the asset filter. * **includedColumnNames** *(list) --* Specifies whether to include column names. * *(string) --* * **rowConfiguration** *(dict) --* The row configuration of the asset filter. * **rowFilter** *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **and** *(list) --* The 'and' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **expression** *(dict) --* The expression of the row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "equalTo", "greaterThan", "greaterThanOrEqualTo", "in", "isNotNull", "isNull", "lessThan", "lessThanOrEqualTo", "like", "notEqualTo", "notIn", "notLike". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **equalTo** *(dict) --* The 'equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be equal to an expression. * **greaterThan** *(dict) --* The 'greater than' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be greater than an expression. * **greaterThanOrEqualTo** *(dict) --* The 'greater than or equal to' clause of the filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be greater than or equal to an expression. * **in** *(dict) --* The 'in' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **values** *(list) --* The values that might be in the expression. * *(string) --* * **isNotNull** *(dict) --* The 'is not null' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **isNull** *(dict) --* The 'is null' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **lessThan** *(dict) --* The 'less than' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be less than the expression. * **lessThanOrEqualTo** *(dict) --* The 'less than or equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be less than or equal to an expression. * **like** *(dict) --* The 'like' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be like the expression. * **notEqualTo** *(dict) --* The 'no equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might not be equal to the expression. * **notIn** *(dict) --* The 'not in' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **values** *(list) --* The value that might not be in the expression. * *(string) --* * **notLike** *(dict) --* The 'not like' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might not be like the expression. * **or** *(list) --* The 'or' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **sensitive** *(boolean) --* Specifies whether the row filter is sensitive. * **createdAt** *(datetime) --* The timestamp at which the asset filter was created. * **description** *(string) --* The description of the asset filter. * **domainId** *(string) --* The ID of the domain where the asset filter is created. * **effectiveColumnNames** *(list) --* The column names in the asset filter. * *(string) --* * **effectiveRowFilter** *(string) --* The row filter in the asset filter. * **errorMessage** *(string) --* The error message that is displayed if the asset filter is not created successfully. * **id** *(string) --* The ID of the asset filter. * **name** *(string) --* The name of the asset filter. * **status** *(string) --* The status of the asset filter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / create_project_profile create_project_profile ********************** DataZone.Client.create_project_profile(**kwargs) Creates a project profile. See also: AWS API Documentation **Request Syntax** response = client.create_project_profile( description='string', domainIdentifier='string', domainUnitIdentifier='string', environmentConfigurations=[ { 'awsAccount': { 'awsAccountId': 'string', 'awsAccountIdPath': 'string' }, 'awsRegion': { 'regionName': 'string', 'regionNamePath': 'string' }, 'configurationParameters': { 'parameterOverrides': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'resolvedParameters': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'ssmPath': 'string' }, 'deploymentMode': 'ON_CREATE'|'ON_DEMAND', 'deploymentOrder': 123, 'description': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string' }, ], name='string', status='ENABLED'|'DISABLED' ) Parameters: * **description** (*string*) -- A description of a project profile. * **domainIdentifier** (*string*) -- **[REQUIRED]** A domain ID of the project profile. * **domainUnitIdentifier** (*string*) -- A domain unit ID of the project profile. * **environmentConfigurations** (*list*) -- Environment configurations of the project profile. * *(dict) --* The configuration of an environment. * **awsAccount** *(dict) --* **[REQUIRED]** The Amazon Web Services account of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "awsAccountId", "awsAccountIdPath". * **awsAccountId** *(string) --* The account ID of a project. * **awsAccountIdPath** *(string) --* The account ID path of a project. * **awsRegion** *(dict) --* **[REQUIRED]** The Amazon Web Services Region of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "regionName", "regionNamePath". * **regionName** *(string) --* The Amazon Web Services Region name. * **regionNamePath** *(string) --* The region name path. * **configurationParameters** *(dict) --* The configuration parameters of the environment. * **parameterOverrides** *(list) --* The parameter overrides. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **resolvedParameters** *(list) --* The resolved environment configuration parameters. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **ssmPath** *(string) --* Ssm path environment configuration parameters. * **deploymentMode** *(string) --* The deployment mode of the environment. * **deploymentOrder** *(integer) --* The deployment order of the environment. * **description** *(string) --* The environment description. * **environmentBlueprintId** *(string) --* **[REQUIRED]** The environment blueprint ID. * **id** *(string) --* The environment ID. * **name** *(string) --* **[REQUIRED]** The environment name. * **name** (*string*) -- **[REQUIRED]** Project profile name. * **status** (*string*) -- Project profile status. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'domainUnitId': 'string', 'environmentConfigurations': [ { 'awsAccount': { 'awsAccountId': 'string', 'awsAccountIdPath': 'string' }, 'awsRegion': { 'regionName': 'string', 'regionNamePath': 'string' }, 'configurationParameters': { 'parameterOverrides': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'resolvedParameters': [ { 'isEditable': True|False, 'name': 'string', 'value': 'string' }, ], 'ssmPath': 'string' }, 'deploymentMode': 'ON_CREATE'|'ON_DEMAND', 'deploymentOrder': 123, 'description': 'string', 'environmentBlueprintId': 'string', 'id': 'string', 'name': 'string' }, ], 'id': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'name': 'string', 'status': 'ENABLED'|'DISABLED' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* A timestamp at which a project profile is created. * **createdBy** *(string) --* A user who created a project profile. * **description** *(string) --* A project profile description. * **domainId** *(string) --* The ID of the domain where a project profile is created. * **domainUnitId** *(string) --* The ID of the domain unit where a project profile is created. * **environmentConfigurations** *(list) --* Environment configurations of a project profile. * *(dict) --* The configuration of an environment. * **awsAccount** *(dict) --* The Amazon Web Services account of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "awsAccountId", "awsAccountIdPath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **awsAccountId** *(string) --* The account ID of a project. * **awsAccountIdPath** *(string) --* The account ID path of a project. * **awsRegion** *(dict) --* The Amazon Web Services Region of the environment. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "regionName", "regionNamePath". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **regionName** *(string) --* The Amazon Web Services Region name. * **regionNamePath** *(string) --* The region name path. * **configurationParameters** *(dict) --* The configuration parameters of the environment. * **parameterOverrides** *(list) --* The parameter overrides. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **resolvedParameters** *(list) --* The resolved environment configuration parameters. * *(dict) --* The environment configuration parameter. * **isEditable** *(boolean) --* Specifies whether the environment parameter is editable. * **name** *(string) --* The name of the environment configuration parameter. * **value** *(string) --* The value of the environment configuration parameter. * **ssmPath** *(string) --* Ssm path environment configuration parameters. * **deploymentMode** *(string) --* The deployment mode of the environment. * **deploymentOrder** *(integer) --* The deployment order of the environment. * **description** *(string) --* The environment description. * **environmentBlueprintId** *(string) --* The environment blueprint ID. * **id** *(string) --* The environment ID. * **name** *(string) --* The environment name. * **id** *(string) --* Project profile ID. * **lastUpdatedAt** *(datetime) --* A timestamp when a project profile was last updated. * **name** *(string) --* Project profile name. * **status** *(string) --* Project profile status. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ServiceQuotaExceededException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_asset_filter get_asset_filter **************** DataZone.Client.get_asset_filter(**kwargs) Gets an asset filter. See also: AWS API Documentation **Request Syntax** response = client.get_asset_filter( assetIdentifier='string', domainIdentifier='string', identifier='string' ) Parameters: * **assetIdentifier** (*string*) -- **[REQUIRED]** The ID of the data asset. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to get an asset filter. * **identifier** (*string*) -- **[REQUIRED]** The ID of the asset filter. Return type: dict Returns: **Response Syntax** { 'assetId': 'string', 'configuration': { 'columnConfiguration': { 'includedColumnNames': [ 'string', ] }, 'rowConfiguration': { 'rowFilter': { 'and': [ {'... recursive ...'}, ], 'expression': { 'equalTo': { 'columnName': 'string', 'value': 'string' }, 'greaterThan': { 'columnName': 'string', 'value': 'string' }, 'greaterThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'in': { 'columnName': 'string', 'values': [ 'string', ] }, 'isNotNull': { 'columnName': 'string' }, 'isNull': { 'columnName': 'string' }, 'lessThan': { 'columnName': 'string', 'value': 'string' }, 'lessThanOrEqualTo': { 'columnName': 'string', 'value': 'string' }, 'like': { 'columnName': 'string', 'value': 'string' }, 'notEqualTo': { 'columnName': 'string', 'value': 'string' }, 'notIn': { 'columnName': 'string', 'values': [ 'string', ] }, 'notLike': { 'columnName': 'string', 'value': 'string' } }, 'or': [ {'... recursive ...'}, ] }, 'sensitive': True|False } }, 'createdAt': datetime(2015, 1, 1), 'description': 'string', 'domainId': 'string', 'effectiveColumnNames': [ 'string', ], 'effectiveRowFilter': 'string', 'errorMessage': 'string', 'id': 'string', 'name': 'string', 'status': 'VALID'|'INVALID' } **Response Structure** * *(dict) --* * **assetId** *(string) --* The ID of the data asset. * **configuration** *(dict) --* The configuration of the asset filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "columnConfiguration", "rowConfiguration". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **columnConfiguration** *(dict) --* The column configuration of the asset filter. * **includedColumnNames** *(list) --* Specifies whether to include column names. * *(string) --* * **rowConfiguration** *(dict) --* The row configuration of the asset filter. * **rowFilter** *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **and** *(list) --* The 'and' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **expression** *(dict) --* The expression of the row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "equalTo", "greaterThan", "greaterThanOrEqualTo", "in", "isNotNull", "isNull", "lessThan", "lessThanOrEqualTo", "like", "notEqualTo", "notIn", "notLike". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **equalTo** *(dict) --* The 'equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be equal to an expression. * **greaterThan** *(dict) --* The 'greater than' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be greater than an expression. * **greaterThanOrEqualTo** *(dict) --* The 'greater than or equal to' clause of the filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be greater than or equal to an expression. * **in** *(dict) --* The 'in' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **values** *(list) --* The values that might be in the expression. * *(string) --* * **isNotNull** *(dict) --* The 'is not null' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **isNull** *(dict) --* The 'is null' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **lessThan** *(dict) --* The 'less than' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be less than the expression. * **lessThanOrEqualTo** *(dict) --* The 'less than or equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be less than or equal to an expression. * **like** *(dict) --* The 'like' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might be like the expression. * **notEqualTo** *(dict) --* The 'no equal to' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might not be equal to the expression. * **notIn** *(dict) --* The 'not in' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **values** *(list) --* The value that might not be in the expression. * *(string) --* * **notLike** *(dict) --* The 'not like' clause of the row filter expression. * **columnName** *(string) --* The name of the column. * **value** *(string) --* The value that might not be like the expression. * **or** *(list) --* The 'or' clause of the row filter. * *(dict) --* The row filter. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "and", "expression", "or". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **sensitive** *(boolean) --* Specifies whether the row filter is sensitive. * **createdAt** *(datetime) --* The timestamp at which the asset filter was created. * **description** *(string) --* The description of the asset filter. * **domainId** *(string) --* The ID of the domain where you want to get an asset filter. * **effectiveColumnNames** *(list) --* The column names of the asset filter. * *(string) --* * **effectiveRowFilter** *(string) --* The row filter of the asset filter. * **errorMessage** *(string) --* The error message that is displayed if the action does not complete successfully. * **id** *(string) --* The ID of the asset filter. * **name** *(string) --* The name of the asset filter. * **status** *(string) --* The status of the asset filter. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_lineage_node_history list_lineage_node_history ************************* DataZone.Client.list_lineage_node_history(**kwargs) Lists the history of the specified data lineage node. See also: AWS API Documentation **Request Syntax** response = client.list_lineage_node_history( direction='UPSTREAM'|'DOWNSTREAM', domainIdentifier='string', eventTimestampGTE=datetime(2015, 1, 1), eventTimestampLTE=datetime(2015, 1, 1), identifier='string', maxResults=123, nextToken='string', sortOrder='ASCENDING'|'DESCENDING' ) Parameters: * **direction** (*string*) -- The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is "UPSTREAM", the "ListLineageNodeHistory" API responds with historical versions with upstream neighbors only. * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the domain where you want to list the history of the specified data lineage node. * **eventTimestampGTE** (*datetime*) -- Specifies whether the action is to return data lineage node history from the time after the event timestamp. * **eventTimestampLTE** (*datetime*) -- Specifies whether the action is to return data lineage node history from the time prior of the event timestamp. * **identifier** (*string*) -- **[REQUIRED]** The ID of the data lineage node whose history you want to list. * **maxResults** (*integer*) -- The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items. * **nextToken** (*string*) -- When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items. * **sortOrder** (*string*) -- The order by which you want data lineage node history to be sorted. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'nodes': [ { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'description': 'string', 'domainId': 'string', 'eventTimestamp': datetime(2015, 1, 1), 'id': 'string', 'name': 'string', 'sourceIdentifier': 'string', 'typeName': 'string', 'typeRevision': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items. * **nodes** *(list) --* The nodes returned by the ListLineageNodeHistory action. * *(dict) --* The summary of the data lineage node. * **createdAt** *(datetime) --* The timestamp at which the data lineage node was created. * **createdBy** *(string) --* The user who created the data lineage node. * **description** *(string) --* The description of the data lineage node. * **domainId** *(string) --* The ID of the domain of the data lineage node. * **eventTimestamp** *(datetime) --* The event timestamp of the data lineage node. * **id** *(string) --* The ID of the data lineage node. * **name** *(string) --* The name of the data lineage node. * **sourceIdentifier** *(string) --* The alternate ID of the data lineage node. * **typeName** *(string) --* The name of the type of the data lineage node. * **typeRevision** *(string) --* The type of the revision of the data lineage node. * **updatedAt** *(datetime) --* The timestamp at which the data lineage node was updated. * **updatedBy** *(string) --* The user who updated the data lineage node. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / delete_form_type delete_form_type **************** DataZone.Client.delete_form_type(**kwargs) Delets and metadata form type in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.delete_form_type( domainIdentifier='string', formTypeIdentifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain in which the metadata form type is deleted. * **formTypeIdentifier** (*string*) -- **[REQUIRED]** The ID of the metadata form type that is deleted. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ConflictException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / get_metadata_generation_run get_metadata_generation_run *************************** DataZone.Client.get_metadata_generation_run(**kwargs) Gets a metadata generation run in Amazon DataZone. See also: AWS API Documentation **Request Syntax** response = client.get_metadata_generation_run( domainIdentifier='string', identifier='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The ID of the Amazon DataZone domain the metadata generation run of which you want to get. * **identifier** (*string*) -- **[REQUIRED]** The identifier of the metadata generation run. Return type: dict Returns: **Response Syntax** { 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'id': 'string', 'owningProjectId': 'string', 'status': 'SUBMITTED'|'IN_PROGRESS'|'CANCELED'|'SUCCEEDED'|'FAILED', 'target': { 'identifier': 'string', 'revision': 'string', 'type': 'ASSET' }, 'type': 'BUSINESS_DESCRIPTIONS' } **Response Structure** * *(dict) --* * **createdAt** *(datetime) --* The timestamp of when the metadata generation run was start. * **createdBy** *(string) --* The Amazon DataZone user who started the metadata generation run. * **domainId** *(string) --* The ID of the Amazon DataZone domain the metadata generation run of which you want to get. * **id** *(string) --* The ID of the metadata generation run. * **owningProjectId** *(string) --* The ID of the project that owns the assets for which you're running metadata generation. * **status** *(string) --* The status of the metadata generation run. * **target** *(dict) --* The asset for which you're generating metadata. * **identifier** *(string) --* The ID of the metadata generation run's target. * **revision** *(string) --* The revision of the asset for which metadata was generated. * **type** *(string) --* The type of the asset for which metadata was generated. * **type** *(string) --* The type of metadata generation run. **Exceptions** * "DataZone.Client.exceptions.InternalServerException" * "DataZone.Client.exceptions.ResourceNotFoundException" * "DataZone.Client.exceptions.AccessDeniedException" * "DataZone.Client.exceptions.ThrottlingException" * "DataZone.Client.exceptions.ValidationException" * "DataZone.Client.exceptions.UnauthorizedException" DataZone / Client / list_environment_blueprints list_environment_blueprints *************************** DataZone.Client.list_environment_blueprints(**kwargs) Lists blueprints in an Amazon DataZone environment. See also: AWS API Documentation **Request Syntax** response = client.list_environment_blueprints( domainIdentifier='string', managed=True|False, maxResults=123, name='string', nextToken='string' ) Parameters: * **domainIdentifier** (*string*) -- **[REQUIRED]** The identifier of the Amazon DataZone domain. * **managed** (*boolean*) -- Specifies whether the environment blueprint is managed by Amazon DataZone. * **maxResults** (*integer*) -- The maximum number of blueprints to return in a single call to "ListEnvironmentBlueprints". When the number of blueprints to be listed is greater than the value of "MaxResults", the response contains a "NextToken" value that you can use in a subsequent call to "ListEnvironmentBlueprints" to list the next set of blueprints. * **name** (*string*) -- The name of the Amazon DataZone environment. * **nextToken** (*string*) -- When the number of blueprints in the environment is greater than the default value for the "MaxResults" parameter, or if you explicitly specify a value for "MaxResults" that is less than the number of blueprints in the environment, the response includes a pagination token named "NextToken". You can specify this "NextToken" value in a subsequent call to >>``<>``<