2023/10/04 - Amazon DataZone - 99 new api methods
Changes Initial release of Amazon DataZone
Gets a project in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_project(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the project exists.
string
[REQUIRED]
The ID of the project.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'glossaryTerms': [
'string',
],
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': '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.
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.
Lists data sources in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
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'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which to list the data sources.
string
The identifier of the environment in which to list the data sources.
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.
string
The name of the data source.
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.
string
[REQUIRED]
The identifier of the project in which to list data sources.
string
The status of the data source.
string
The type of the data source.
dict
Response Syntax
{
'items': [
{
'createdAt': datetime(2015, 1, 1),
'dataSourceId': '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.
createdAt (datetime) --
The timestamp of when the data source was created.
dataSourceId (string) --
The ID of the data source.
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.
Searches group profiles in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search_group_profiles(
domainIdentifier='string',
groupType='SSO_GROUP'|'DATAZONE_SSO_GROUP',
maxResults=123,
nextToken='string',
searchText='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which you want to search group profiles.
string
[REQUIRED]
The group type for which to search.
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.
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.
string
Specifies the text for which to search.
dict
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.
Lists all members of the specified project.
See also: AWS API Documentation
Request Syntax
client.list_project_memberships(
domainIdentifier='string',
maxResults=123,
nextToken='string',
projectIdentifier='string',
sortBy='NAME',
sortOrder='ASCENDING'|'DESCENDING'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which you want to list project memberships.
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.
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.
string
[REQUIRED]
The identifier of the project whose memberships you want to list.
string
The method by which you want to sort the project memberships.
string
The sort order of the project memberships.
dict
Response Syntax
{
'members': [
{
'designation': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR',
'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.
Lists Amazon DataZone domains.
See also: AWS API Documentation
Request Syntax
client.list_domains(
maxResults=123,
nextToken='string',
status='CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'
)
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.
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.
string
The status of the data source.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'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.
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.
Updates the specified group profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_group_profile(
domainIdentifier='string',
groupIdentifier='string',
status='ASSIGNED'|'NOT_ASSIGNED'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a group profile is updated.
string
[REQUIRED]
The identifier of the group profile that is updated.
string
[REQUIRED]
The status of the group profile that is updated.
dict
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.
Updates the specified user profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_user_profile(
domainIdentifier='string',
status='ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
type='IAM'|'SSO',
userIdentifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a user profile is updated.
string
[REQUIRED]
The status of the user profile that are to be updated.
string
The type of the user profile that are to be updated.
string
[REQUIRED]
The identifier of the user whose user profile is to be updated.
dict
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 updated.
id (string) --
The identifier of the user profile.
status (string) --
The status of the user profile.
type (string) --
The type of the user profile.
Rejects the specified subscription request.
See also: AWS API Documentation
Request Syntax
client.reject_subscription_request(
decisionComment='string',
domainIdentifier='string',
identifier='string'
)
string
The decision comment of the rejected subscription request.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the subscription request was rejected.
string
[REQUIRED]
The identifier of the subscription request that was rejected.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'decisionComment': 'string',
'domainId': 'string',
'id': 'string',
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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.
id (string) --
The identifier of the subscription request that was rejected.
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. 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.
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.
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.
Updates a specified subscription request in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_subscription_request(
domainIdentifier='string',
identifier='string',
requestReason='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a subscription request is to be updated.
string
[REQUIRED]
The identifier of the subscription request that is to be updated.
string
[REQUIRED]
The reason for the UpdateSubscriptionRequest action.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'decisionComment': 'string',
'domainId': 'string',
'id': 'string',
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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.
id (string) --
The identifier of the subscription request that is to be updated.
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. 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.
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.
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.
Lists Amazon DataZone projects.
See also: AWS API Documentation
Request Syntax
client.list_projects(
domainIdentifier='string',
groupIdentifier='string',
maxResults=123,
name='string',
nextToken='string',
userIdentifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of a group.
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.
string
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.
string
The identifier of the Amazon DataZone user.
dict
Response Syntax
{
'items': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'id': 'string',
'name': 'string',
'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.
id (string) --
The identifier of a project.
name (string) --
The name of a 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.
Searches user profiles in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search_user_profiles(
domainIdentifier='string',
maxResults=123,
nextToken='string',
searchText='string',
userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which you want to search user profiles.
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.
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.
string
Specifies the text for which to search.
string
[REQUIRED]
Specifies the user type for the SearchUserProfiles action.
dict
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.
Start the run of the specified data source in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.start_data_source_run(
clientToken='string',
dataSourceIdentifier='string',
domainIdentifier='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the data source.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which to start a data source run.
dict
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.
Updates a business glossary term in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_glossary_term(
domainIdentifier='string',
glossaryIdentifier='string',
identifier='string',
longDescription='string',
name='string',
shortDescription='string',
status='ENABLED'|'DISABLED',
termRelations={
'classifies': [
'string',
],
'isA': [
'string',
]
}
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.
string
The identifier of the business glossary in which a term is to be updated.
string
[REQUIRED]
The identifier of the business glossary term that is to be updated.
string
The long description to be updated as part of the UpdateGlossaryTerm action.
string
The name to be updated as part of the UpdateGlossaryTerm action.
string
The short description to be updated as part of the UpdateGlossaryTerm action.
string
The status to be updated as part of the UpdateGlossaryTerm action.
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) --
dict
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) --
Gets an Amazon DataZone blueprint.
See also: AWS API Documentation
Request Syntax
client.get_environment_blueprint(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The identifier of the domain in which this blueprint exists.
string
[REQUIRED]
The ID of this Amazon DataZone blueprint.
dict
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.
Creates a business glossary term.
See also: AWS API Documentation
Request Syntax
client.create_glossary_term(
clientToken='string',
domainIdentifier='string',
glossaryIdentifier='string',
longDescription='string',
name='string',
shortDescription='string',
status='ENABLED'|'DISABLED',
termRelations={
'classifies': [
'string',
],
'isA': [
'string',
]
}
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this business glossary term is created.
string
[REQUIRED]
The ID of the business glossary in which this term is created.
string
The long description of this business glossary term.
string
[REQUIRED]
The name of this business glossary term.
string
The short description of this business glossary term.
string
The status of this business glossary term.
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) --
dict
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) --
Creates a metadata form type.
See also: AWS API Documentation
Request Syntax
client.create_form_type(
description='string',
domainIdentifier='string',
model={
'smithy': 'string'
},
name='string',
owningProjectIdentifier='string',
status='ENABLED'|'DISABLED'
)
string
The description of this Amazon DataZone metadata form type.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this metadata form type is created.
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) --
string
[REQUIRED]
The name of this Amazon DataZone metadata form type.
string
[REQUIRED]
The ID of the Amazon DataZone project that owns this metadata form type.
string
The status of this Amazon DataZone metadata form type.
dict
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.
Deletes a data source in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_data_source(
clientToken='string',
domainIdentifier='string',
identifier='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the data source is deleted.
string
[REQUIRED]
The identifier of the data source that is deleted.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': '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'
},
]
}
},
'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,
'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 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. 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.
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.
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.
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.
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.
Accepts a subscription request to a specific asset.
See also: AWS API Documentation
Request Syntax
client.accept_subscription_request(
decisionComment='string',
domainIdentifier='string',
identifier='string'
)
string
A description that specifies the reason for accepting the specified subscription request.
string
[REQUIRED]
The Amazon DataZone domain where the specified subscription request is being accepted.
string
[REQUIRED]
The unique identifier of the subscription request that is to be accepted.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'decisionComment': 'string',
'domainId': 'string',
'id': 'string',
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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.
id (string) --
The identifier of the subscription request.
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. 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.
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.
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.
Searches for assets in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search(
additionalAttributes=[
'FORMS',
],
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',
searchText='string',
sort={
'attribute': 'string',
'order': 'ASCENDING'|'DESCENDING'
}
)
list
Specifies additional attributes for the Search action.
(string) --
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
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.
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.
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.
string
The identifier of the owning project specified for the search.
list
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
string
[REQUIRED]
The scope of the search.
string
Specifies the text for which to search.
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.
dict
Response Syntax
{
'items': [
{
'assetItem': {
'additionalAttributes': {
'formsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': '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': {
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'dataProductItems': [
{
'domainId': 'string',
'itemId': 'string'
},
],
'description': 'string',
'domainId': 'string',
'glossaryTerms': [
'string',
],
'id': 'string',
'name': 'string',
'owningProjectId': 'string',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
'glossaryItem': {
'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': {
'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.
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 item included in the search results.
createdAt (datetime) --
createdBy (string) --
dataProductItems (list) --
(dict) --
domainId (string) --
itemId (string) --
description (string) --
domainId (string) --
glossaryTerms (list) --
(string) --
id (string) --
name (string) --
owningProjectId (string) --
updatedAt (datetime) --
updatedBy (string) --
glossaryItem (dict) --
The glossary item included in the search results.
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.
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.
Create an Amazon DataZone environment.
See also: AWS API Documentation
Request Syntax
client.create_environment(
description='string',
domainIdentifier='string',
environmentProfileIdentifier='string',
glossaryTerms=[
'string',
],
name='string',
projectIdentifier='string',
userParameters=[
{
'name': 'string',
'value': 'string'
},
]
)
string
The description of the Amazon DataZone environment.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the environment is created.
string
[REQUIRED]
The identifier of the environment profile that is used to create this Amazon DataZone environment.
list
The glossary terms that can be used in this Amazon DataZone environment.
(string) --
string
[REQUIRED]
The name of the Amazon DataZone environment.
string
[REQUIRED]
The identifier of the Amazon DataZone project in which this environment is created.
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.
dict
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',
'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.
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.
Updates a Amazon DataZone domain.
See also: AWS API Documentation
Request Syntax
client.update_domain(
clientToken='string',
description='string',
domainExecutionRole='string',
identifier='string',
name='string',
singleSignOn={
'type': 'IAM_IDC'|'DISABLED',
'userAssignment': 'AUTOMATIC'|'MANUAL'
}
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The description to be updated as part of the UpdateDomain action.
string
The domain execution role to be updated as part of the UpdateDomain action.
string
[REQUIRED]
The ID of the Amazon Web Services domain that is to be updated.
string
The name to be updated as part of the UpdateDomain action.
dict
The single sign-on option to be updated as part of the UpdateDomain action.
type (string) --
The type of single sign-on in Amazon DataZone.
userAssignment (string) --
The single sign-on user assignment in Amazon DataZone.
dict
Response Syntax
{
'description': 'string',
'domainExecutionRole': 'string',
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'singleSignOn': {
'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.
singleSignOn (dict) --
The single sign-on option of the Amazon DataZone domain.
type (string) --
The type of single sign-on in Amazon DataZone.
userAssignment (string) --
The single sign-on user assignment in Amazon DataZone.
Gets a group profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_group_profile(
domainIdentifier='string',
groupIdentifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the group profile exists.
string
[REQUIRED]
The identifier of the group profile.
dict
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.
Updates the specified environment in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_environment(
description='string',
domainIdentifier='string',
glossaryTerms=[
'string',
],
identifier='string',
name='string'
)
string
The description to be updated as part of the UpdateEnvironment action.
string
[REQUIRED]
The identifier of the domain in which the environment is to be updated.
list
The glossary terms to be updated as part of the UpdateEnvironment action.
(string) --
string
[REQUIRED]
The identifier of the environment that is to be updated.
string
The name to be updated as part of the UpdateEnvironment action.
dict
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',
'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.
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.
Lists Amazon DataZone subscription requests.
See also: AWS API Documentation
Request Syntax
client.list_subscription_requests(
approverProjectId='string',
domainIdentifier='string',
maxResults=123,
nextToken='string',
owningProjectId='string',
sortBy='CREATED_AT'|'UPDATED_AT',
sortOrder='ASCENDING'|'DESCENDING',
status='PENDING'|'ACCEPTED'|'REJECTED',
subscribedListingId='string'
)
string
The identifier of the subscription request approver's project.
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
integer
The maximum number of subscription requests to return in a single call to ListSubscriptionRequests . When the number of subscription requests 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 ListSubscriptionRequests to list the next set of subscription requests.
string
When the number of subscription requests 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 requests, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.
string
The identifier of the project for the subscription requests.
string
Specifies the way to sort the results of this action.
string
Specifies the sort order for the results of this action.
string
Specifies the status of the subscription requests.
string
The identifier of the subscribed listing.
dict
Response Syntax
{
'items': [
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'decisionComment': 'string',
'domainId': 'string',
'id': 'string',
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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.
id (string) --
The identifier of the subscription request.
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. 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.
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.
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) --
When the number of subscription requests 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 requests, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.
Gets the details of the specified subscription request.
See also: AWS API Documentation
Request Syntax
client.get_subscription_request_details(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which to get the subscription request details.
string
[REQUIRED]
The identifier of the subscription request the details of which to get.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'decisionComment': 'string',
'domainId': 'string',
'id': 'string',
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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.
id (string) --
The identifier of the subscription request.
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. 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.
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.
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.
Searches for types in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
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',
searchText='string',
sort={
'attribute': 'string',
'order': 'ASCENDING'|'DESCENDING'
}
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.
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.
boolean
[REQUIRED]
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.
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.
list
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
string
[REQUIRED]
Specifies the scope of the search for types.
string
Specifies the text for which to search.
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.
dict
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'
}
},
],
'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. 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) --
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.
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.
Gets an Amazon DataZone domain.
See also: AWS API Documentation
Request Syntax
client.get_domain(
identifier='string'
)
string
[REQUIRED]
The identifier of the specified Amazon DataZone domain.
dict
Response Syntax
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'domainExecutionRole': 'string',
'id': 'string',
'kmsKeyIdentifier': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'portalUrl': 'string',
'singleSignOn': {
'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 specified Amazon DataZone domain.
createdAt (datetime) --
The timestamp of when the Amazon DataZone domain was created.
description (string) --
The description of the Amazon DataZone domain.
domainExecutionRole (string) --
The domain execution role with which the Amazon DataZone domain is created.
id (string) --
The identifier of the specified 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.
lastUpdatedAt (datetime) --
The timestamp of when the Amazon DataZone domain was last updated.
name (string) --
The name of the Amazon DataZone domain.
portalUrl (string) --
The URL of the data portal for this Amazon DataZone domain.
singleSignOn (dict) --
The single sing-on option of the specified Amazon DataZone domain.
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 specified Amazon DataZone domain.
tags (dict) --
The tags specified for the Amazon DataZone domain.
(string) --
(string) --
Lists subscription targets in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.list_subscription_targets(
domainIdentifier='string',
environmentIdentifier='string',
maxResults=123,
nextToken='string',
sortBy='CREATED_AT'|'UPDATED_AT',
sortOrder='ASCENDING'|'DESCENDING'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain where you want to list subscription targets.
string
[REQUIRED]
The identifier of the environment where you want to list subscription targets.
integer
The maximum number of subscription targets to return in a single call to ListSubscriptionTargets . When the number of subscription targets 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 ListSubscriptionTargets to list the next set of subscription targets.
string
When the number of subscription targets 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 targets, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.
string
Specifies the way in which the results of this action are to be sorted.
string
Specifies the sort order for the results of this action.
dict
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) --
When the number of subscription targets 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 targets, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.
Searches listings in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search_listings(
additionalAttributes=[
'FORMS',
],
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'
}
)
list
Specifies additional attributes for the search.
(string) --
string
[REQUIRED]
The identifier of the domain in which to search listings.
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.
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.
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.
list
(dict) --
The details of the search.
attribute (string) -- [REQUIRED]
The search attribute.
string
Specifies the text for which to search.
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.
dict
Response Syntax
{
'items': [
{
'assetListing': {
'additionalAttributes': {
'forms': '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'
}
},
],
'nextToken': 'string',
'totalMatchCount': 123
}
Response Structure
(dict) --
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. 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.
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.
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.
Gets a subscription in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_subscription(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription exists.
string
[REQUIRED]
The ID of the subscription.
dict
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': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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) --
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. 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.
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.
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.
Lists data source run activities.
See also: AWS API Documentation
Request Syntax
client.list_data_source_run_activities(
domainIdentifier='string',
identifier='string',
maxResults=123,
nextToken='string',
status='FAILED'|'PUBLISHING_FAILED'|'SUCCEEDED_CREATED'|'SUCCEEDED_UPDATED'|'SKIPPED_ALREADY_IMPORTED'|'SKIPPED_ARCHIVED'|'SKIPPED_NO_ACCESS'|'UNCHANGED'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which to list data source run activities.
string
[REQUIRED]
The identifier of the data source run.
integer
The maximum number of activities to return in a single call to ListDataSourceRunActivities . When the number of activities 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 ListDataSourceRunActivities to list the next set of activities.
string
When the number of activities 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 activities, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListDataSourceRunActivities to list the next set of activities.
string
The status of the data source run.
dict
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'
},
'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.
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) --
When the number of activities 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 activities, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListDataSourceRunActivities to list the next set of activities.
Gets the subscription grant in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_subscription_grant(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription grant exists.
string
[REQUIRED]
The ID of the subscription grant.
dict
Response Syntax
{
'assets': [
{
'assetId': 'string',
'assetRevision': '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.
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.
Deletes the blueprint configuration in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_environment_blueprint_configuration(
domainIdentifier='string',
environmentBlueprintIdentifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
string
[REQUIRED]
The ID of the blueprint the configuration of which is deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a business glossary in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_glossary(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this business glossary exists.
string
[REQUIRED]
The ID of the business glossary.
dict
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.
Lists blueprints in an Amazon DataZone environment.
See also: AWS API Documentation
Request Syntax
client.list_environment_blueprints(
domainIdentifier='string',
managed=True|False,
maxResults=123,
name='string',
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
boolean
Specifies whether the environment blueprint is managed by Amazon DataZone.
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.
string
The name of the Amazon DataZone environment.
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 ListEnvironmentBlueprints to list the next set of blueprints.
dict
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) --
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 ListEnvironmentBlueprints to list the next set of blueprints.
Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.
See also: AWS API Documentation
Request Syntax
client.reject_predictions(
clientToken='string',
domainIdentifier='string',
identifier='string',
rejectChoices=[
{
'predictionChoices': [
123,
],
'predictionTarget': 'string'
},
],
rejectRule={
'rule': 'ALL'|'NONE',
'threshold': ...
},
revision='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
[REQUIRED]
The identifier of the prediction.
list
(dict) --
The details of the automatically generated business metadata that is rejected.
predictionChoices (list) --
Specifies the the automatically generated business metadata that can be rejected.
(integer) --
predictionTarget (string) --
Specifies the target (for example, a column name) where a prediction can be rejected.
dict
rule (string) --
Specifies whether you want to reject the top prediction for all targets or none.
threshold (float) --
The confidence score that specifies the condition at which a prediction can be rejected.
string
dict
Response Syntax
{
'assetId': 'string',
'assetRevision': 'string',
'domainId': 'string'
}
Response Structure
(dict) --
assetId (string) --
assetRevision (string) --
domainId (string) --
Creates a revision of the asset.
See also: AWS API Documentation
Request Syntax
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'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The revised description of the asset.
string
[REQUIRED]
The unique identifier of the domain where the asset is being revised.
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.
list
The glossary terms to be attached to the asset as part of asset revision.
(string) --
string
[REQUIRED]
The identifier of the asset.
string
[REQUIRED]
Te revised name of the asset.
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.
string
The revision type of the asset.
dict
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',
'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) --
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.
listing (dict) --
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.
Lists data source runs in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.list_data_source_runs(
dataSourceIdentifier='string',
domainIdentifier='string',
maxResults=123,
nextToken='string',
status='REQUESTED'|'RUNNING'|'FAILED'|'PARTIALLY_SUCCEEDED'|'SUCCESS'
)
string
[REQUIRED]
The identifier of the data source.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.
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.
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.
string
The status of the data source.
dict
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',
'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.
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.
Updates the specified project in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_project(
description='string',
domainIdentifier='string',
glossaryTerms=[
'string',
],
identifier='string',
name='string'
)
string
The description to be updated as part of the UpdateProject action.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a project is to be updated.
list
The glossary terms to be updated as part of the UpdateProject action.
(string) --
string
[REQUIRED]
The identifier of the project that is to be updated.
string
The name to be updated as part of the UpdateProject action.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'glossaryTerms': [
'string',
],
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': '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 that is to be updated.
domainId (string) --
The identifier of the Amazon DataZone domain in which a project is updated.
glossaryTerms (list) --
The glossary terms of the project that are to be updated.
(string) --
id (string) --
The identifier of the project that is to be updated.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
name (string) --
The name of the project that is to be updated.
Deletes an environment profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_environment_profile(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the environment profile is deleted.
string
[REQUIRED]
The ID of the environment profile that is deleted.
None
Updates the specified subscription target in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_subscription_target(
applicableAssetTypes=[
'string',
],
authorizedPrincipals=[
'string',
],
domainIdentifier='string',
environmentIdentifier='string',
identifier='string',
manageAccessRole='string',
name='string',
provider='string',
subscriptionTargetConfig=[
{
'content': 'string',
'formName': 'string'
},
]
)
list
The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
(string) --
list
The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
(string) --
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a subscription target is to be updated.
string
[REQUIRED]
The identifier of the environment in which a subscription target is to be updated.
string
[REQUIRED]
Identifier of the subscription target that is to be updated.
string
The manage access role to be updated as part of the UpdateSubscriptionTarget action.
string
The name to be updated as part of the UpdateSubscriptionTarget action.
string
The provider to be updated as part of the UpdateSubscriptionTarget action.
list
The configuration to be updated as part of the UpdateSubscriptionTarget action.
(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.
dict
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 applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
(string) --
authorizedPrincipals (list) --
The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
(string) --
createdAt (datetime) --
The timestamp of when a 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 a subscription target is to be updated.
environmentId (string) --
The identifier of the environment in which a subscription target is to be updated.
id (string) --
Identifier of the subscription target that is to be updated.
manageAccessRole (string) --
The manage access role to be updated as part of the UpdateSubscriptionTarget action.
name (string) --
The name to be updated as part of the UpdateSubscriptionTarget action.
projectId (string) --
The identifier of the project in which a subscription target is to be updated.
provider (string) --
The provider to be updated as part of the UpdateSubscriptionTarget action.
subscriptionTargetConfig (list) --
The configuration to be updated as part of the UpdateSubscriptionTarget action.
(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 to be updated as part of the UpdateSubscriptionTarget action.
updatedAt (datetime) --
The timestamp of when the subscription target was updated.
updatedBy (string) --
The Amazon DataZone user who updated the subscription target.
Creates a group profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_group_profile(
clientToken='string',
domainIdentifier='string',
groupIdentifier='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the group profile is created.
string
[REQUIRED]
The identifier of the group for which the group profile is created.
dict
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.
Gets an Amazon DataZone asset.
See also: AWS API Documentation
Request Syntax
client.get_asset(
domainIdentifier='string',
identifier='string',
revision='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain to which the asset belongs.
string
[REQUIRED]
The ID of the Amazon DataZone asset.
string
The revision of the Amazon DataZone asset.
dict
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',
'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) --
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.
listing (dict) --
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.
Gets an Amazon DataZone asset type.
See also: AWS API Documentation
Request Syntax
client.get_asset_type(
domainIdentifier='string',
identifier='string',
revision='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the asset type exists.
string
[REQUIRED]
The ID of the asset type.
string
The revision of the asset type.
dict
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.
Deletes project membership in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_project_membership(
domainIdentifier='string',
member={
'groupIdentifier': 'string',
'userIdentifier': 'string'
},
projectIdentifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain where project membership is deleted.
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.
string
[REQUIRED]
The ID of the Amazon DataZone project the membership to which is deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists subscriptions in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
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'
)
string
The identifier of the project for the subscription's approver.
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
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.
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.
string
The identifier of the owning project.
string
Specifies the way in which the results of this action are to be sorted.
string
Specifies the sort order for the results of this action.
string
The status of the subscriptions that you want to list.
string
The identifier of the subscribed listing for the subscriptions that you want to list.
string
The identifier of the subscription request for the subscriptions that you want to list.
dict
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': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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. 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.
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.
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.
Deletes a business glossary in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_glossary(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the business glossary is deleted.
string
[REQUIRED]
The ID of the business glossary that is deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists subscription grants.
See also: AWS API Documentation
Request Syntax
client.list_subscription_grants(
domainIdentifier='string',
environmentId='string',
maxResults=123,
nextToken='string',
sortBy='CREATED_AT'|'UPDATED_AT',
sortOrder='ASCENDING'|'DESCENDING',
subscribedListingId='string',
subscriptionId='string',
subscriptionTargetId='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the Amazon DataZone environment.
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.
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.
string
Specifies the way of sorting the results of this action.
string
Specifies the sort order of this action.
string
The identifier of the subscribed listing.
string
The identifier of the subscription.
string
The identifier of the subscription target.
dict
Response Syntax
{
'items': [
{
'assets': [
{
'assetId': 'string',
'assetRevision': '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.
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 grant.
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.
See also: AWS API Documentation
Request Syntax
client.get_listing(
domainIdentifier='string',
identifier='string',
listingRevision='string'
)
string
[REQUIRED]
string
[REQUIRED]
string
dict
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'
},
],
'owningProjectId': 'string'
}
},
'listingRevision': 'string',
'name': 'string',
'status': 'CREATING'|'ACTIVE'|'INACTIVE',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
createdBy (string) --
The Amazon DataZone user who created the listing.
description (string) --
domainId (string) --
id (string) --
item (dict) --
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing. 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.
owningProjectId (string) --
The identifier of the project where an asset published in an Amazon DataZone catalog exists.
listingRevision (string) --
name (string) --
status (string) --
updatedAt (datetime) --
The timestamp of when the listing was updated.
updatedBy (string) --
The Amazon DataZone user who updated the listing.
Deletes a project in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_project(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the project is deleted.
string
[REQUIRED]
The identifier of the project that is to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a custom asset type.
See also: AWS API Documentation
Request Syntax
client.create_asset_type(
description='string',
domainIdentifier='string',
formsInput={
'string': {
'required': True|False,
'typeIdentifier': 'string',
'typeRevision': 'string'
}
},
name='string',
owningProjectIdentifier='string'
)
string
The descripton of the custom asset type.
string
[REQUIRED]
The unique identifier of the Amazon DataZone domain where the custom asset type is being created.
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.
string
[REQUIRED]
The name of the custom asset type.
string
[REQUIRED]
The identifier of the Amazon DataZone project that is to own the custom asset type.
dict
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.
Tags a resource in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource to be tagged in Amazon DataZone.
dict
[REQUIRED]
Specifies the tags for the TagResource action.
(string) --
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Gets a metadata form type in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_form_type(
domainIdentifier='string',
formTypeIdentifier='string',
revision='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this metadata form type exists.
string
[REQUIRED]
The ID of the metadata form type.
string
The revision of this metadata form type.
dict
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) --
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.
Gets the subscription target in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_subscription_target(
domainIdentifier='string',
environmentIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription target exists.
string
[REQUIRED]
The ID of the environment associated with the subscription target.
string
[REQUIRED]
The ID of the subscription target.
dict
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.
Lists blueprint configurations for a Amazon DataZone environment.
See also: AWS API Documentation
Request Syntax
client.list_environment_blueprint_configurations(
domainIdentifier='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
integer
The maximum number of blueprint configurations to return in a single call to ListEnvironmentBlueprintConfigurations . When the number of configurations 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 ListEnvironmentBlueprintConfigurations to list the next set of configurations.
string
When the number of blueprint configurations 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 configurations, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.
dict
Response Syntax
{
'items': [
{
'createdAt': datetime(2015, 1, 1),
'domainId': 'string',
'enabledRegions': [
'string',
],
'environmentBlueprintId': 'string',
'manageAccessRoleArn': '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.
manageAccessRoleArn (string) --
The ARN of the manage access role specified in the environment blueprint configuration.
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) --
When the number of blueprint configurations 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 configurations, the response includes a pagination token named NextToken . You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.
Lists Amazon DataZone environment profiles.
See also: AWS API Documentation
Request Syntax
client.list_environment_profiles(
awsAccountId='string',
awsAccountRegion='string',
domainIdentifier='string',
environmentBlueprintIdentifier='string',
maxResults=123,
name='string',
nextToken='string',
projectIdentifier='string'
)
string
The identifier of the Amazon Web Services account where you want to list environment profiles.
string
The Amazon Web Services region where you want to list environment profiles.
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the blueprint that was used to create the environment profiles that you want to list.
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.
string
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.
string
The identifier of the Amazon DataZone project.
dict
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.
Writes the configuration for the specified environment blueprint in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.put_environment_blueprint_configuration(
domainIdentifier='string',
enabledRegions=[
'string',
],
environmentBlueprintIdentifier='string',
manageAccessRoleArn='string',
provisioningRoleArn='string',
regionalParameters={
'string': {
'string': 'string'
}
}
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
list
[REQUIRED]
Specifies the enabled Amazon Web Services Regions.
(string) --
string
[REQUIRED]
The identifier of the environment blueprint.
string
The ARN of the manage access role.
string
The ARN of the provisioning role.
dict
The regional parameters in the environment blueprint.
(string) --
(dict) --
(string) --
(string) --
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'domainId': 'string',
'enabledRegions': [
'string',
],
'environmentBlueprintId': 'string',
'manageAccessRoleArn': '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.
manageAccessRoleArn (string) --
The ARN of the manage access role.
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.
Creates a user profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_user_profile(
clientToken='string',
domainIdentifier='string',
userIdentifier='string',
userType='IAM_USER'|'IAM_ROLE'|'SSO_USER'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a user profile is created.
string
[REQUIRED]
The identifier of the user for which the user profile is created.
string
The user type of the user for which the user profile is created.
dict
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.
Gets the data portal URL for the specified Amazon DataZone domain.
See also: AWS API Documentation
Request Syntax
client.get_iam_portal_login_url(
domainIdentifier='string'
)
string
[REQUIRED]
the ID of the Amazon DataZone domain the data portal of which you want to get.
dict
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.
Deletes a subscription request in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_subscription_request(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription request is deleted.
string
[REQUIRED]
The ID of the subscription request that is deleted.
None
Untags a resource in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource to be untagged in Amazon DataZone.
list
[REQUIRED]
Specifies the tag keys for the UntagResource action.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all Amazon DataZone notifications.
See also: AWS API Documentation
Request Syntax
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'
)
datetime
The time after which you want to list notifications.
datetime
The time before which you want to list notifications.
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
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.
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.
list
The subjects of notifications.
(string) --
string
The task status of notifications.
string
[REQUIRED]
The type of notifications.
dict
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.
Deletes an asset type in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_asset_type(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the asset type is deleted.
string
[REQUIRED]
The identifier of the asset type that is deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Gets the blueprint configuration in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_environment_blueprint_configuration(
domainIdentifier='string',
environmentBlueprintIdentifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain where this blueprint exists.
string
[REQUIRED]
He ID of the blueprint.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'domainId': 'string',
'enabledRegions': [
'string',
],
'environmentBlueprintId': 'string',
'manageAccessRoleArn': '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.
manageAccessRoleArn (string) --
The ARN of the manage access role with which this blueprint is created.
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.
Gets an Amazon DataZone data source run.
See also: AWS API Documentation
Request Syntax
client.get_data_source_run(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the domain in which this data source run was performed.
string
[REQUIRED]
The ID of the data source run.
dict
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 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.
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.
Creates an Amazon DataZone business glossary.
See also: AWS API Documentation
Request Syntax
client.create_glossary(
clientToken='string',
description='string',
domainIdentifier='string',
name='string',
owningProjectIdentifier='string',
status='DISABLED'|'ENABLED'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The description of this business glossary.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this business glossary is created.
string
[REQUIRED]
The name of this business glossary.
string
[REQUIRED]
The ID of the project that currently owns business glossary.
string
The status of this business glossary.
dict
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.
Gets an Amazon DataZone environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain where the environment exists.
string
[REQUIRED]
The ID of the Amazon DataZone environment.
dict
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',
'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.
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.
See also: AWS API Documentation
Request Syntax
client.delete_listing(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the status of the specified subscription grant status in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
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'
)
string
[REQUIRED]
The identifier of the asset the subscription grant status of which is to be updated.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.
dict
Specifies the error message that is returned if the operation cannot be successfully completed.
message (string) --
The description of the error message.
string
[REQUIRED]
The identifier of the subscription grant the status of which is to be updated.
string
[REQUIRED]
The status to be updated as part of the UpdateSubscriptionGrantStatus action.
string
The target name to be updated as part of the UpdateSubscriptionGrantStatus action.
dict
Response Syntax
{
'assets': [
{
'assetId': 'string',
'assetRevision': '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) --
(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.
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.
Gets an evinronment profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_environment_profile(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this environment profile exists.
string
[REQUIRED]
The ID of the environment profile.
dict
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.
Creates an Amazon DataZone domain.
See also: AWS API Documentation
Request Syntax
client.create_domain(
clientToken='string',
description='string',
domainExecutionRole='string',
kmsKeyIdentifier='string',
name='string',
singleSignOn={
'type': 'IAM_IDC'|'DISABLED',
'userAssignment': 'AUTOMATIC'|'MANUAL'
},
tags={
'string': 'string'
}
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The description of the Amazon DataZone domain.
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.
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.
string
[REQUIRED]
The name of the Amazon DataZone domain.
dict
The single-sign on configuration of the Amazon DataZone domain.
type (string) --
The type of single sign-on in Amazon DataZone.
userAssignment (string) --
The single sign-on user assignment in Amazon DataZone.
dict
The tags specified for the Amazon DataZone domain.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'description': 'string',
'domainExecutionRole': 'string',
'id': 'string',
'kmsKeyIdentifier': 'string',
'name': 'string',
'portalUrl': 'string',
'singleSignOn': {
'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.
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.
singleSignOn (dict) --
The single-sign on configuration of the Amazon DataZone domain.
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) --
Gets a user profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_user_profile(
domainIdentifier='string',
type='IAM'|'SSO',
userIdentifier='string'
)
string
[REQUIRED]
the ID of the Amazon DataZone domain the data portal of which you want to get.
string
The type of the user profile.
string
[REQUIRED]
The identifier of the user for which you want to get the user profile.
dict
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.
Creates an Amazon DataZone environment profile.
See also: AWS API Documentation
Request Syntax
client.create_environment_profile(
awsAccountId='string',
awsAccountRegion='string',
description='string',
domainIdentifier='string',
environmentBlueprintIdentifier='string',
name='string',
projectIdentifier='string',
userParameters=[
{
'name': 'string',
'value': 'string'
},
]
)
string
The Amazon Web Services account in which the Amazon DataZone environment is created.
string
The Amazon Web Services region in which this environment profile is created.
string
The description of this Amazon DataZone environment profile.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this environment profile is created.
string
[REQUIRED]
The ID of the blueprint with which this environment profile is created.
string
[REQUIRED]
The name of this Amazon DataZone environment profile.
string
[REQUIRED]
The identifier of the project in which to create the environment profile.
list
The user parameters of this Amazon DataZone environment profile.
(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.
dict
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 ID in which this Amazon DataZone environment profile is created.
awsAccountRegion (string) --
The Amazon Web Services region in which this Amazon DataZone environment profile is created.
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 this Amazon DataZone environment profile.
domainId (string) --
The ID of the Amazon DataZone domain in which this environment profile is created.
environmentBlueprintId (string) --
The ID of the blueprint with which this environment profile is created.
id (string) --
The ID of this Amazon DataZone environment profile.
name (string) --
The name of this Amazon DataZone 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 updated.
userParameters (list) --
The user parameters of this Amazon DataZone 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.
Revokes a specified subscription in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.revoke_subscription(
domainIdentifier='string',
identifier='string',
retainPermissions=True|False
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain where you want to revoke a subscription.
string
[REQUIRED]
The identifier of the revoked subscription.
boolean
Specifies whether permissions are retained when the subscription is revoked.
dict
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': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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. 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.
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.
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.
See also: AWS API Documentation
Request Syntax
client.create_listing_change_set(
action='PUBLISH'|'UNPUBLISH',
clientToken='string',
domainIdentifier='string',
entityIdentifier='string',
entityRevision='string',
entityType='ASSET'
)
string
[REQUIRED]
string
This field is autopopulated if not provided.
string
[REQUIRED]
string
[REQUIRED]
string
string
[REQUIRED]
dict
Response Syntax
{
'listingId': 'string',
'listingRevision': 'string',
'status': 'CREATING'|'ACTIVE'|'INACTIVE'
}
Response Structure
(dict) --
listingId (string) --
listingRevision (string) --
status (string) --
Deletes and subscription grant in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_subscription_grant(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain where the subscription grant is deleted.
string
[REQUIRED]
The ID of the subscription grant that is deleted.
dict
Response Syntax
{
'assets': [
{
'assetId': 'string',
'assetRevision': '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.
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.
Updates the specified data source in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
assetFormsInput=[
{
'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
configuration={
'glueRunConfiguration': {
'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'
},
]
}
},
description='string',
domainIdentifier='string',
enableSetting='ENABLED'|'DISABLED',
identifier='string',
name='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'
}
)
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.
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.
glueRunConfiguration (dict) --
The configuration of the Amazon Web Services Glue data source.
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) -- [REQUIRED]
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) -- [REQUIRED]
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.
string
The description to be updated as part of the UpdateDataSource action.
string
[REQUIRED]
The identifier of the domain in which to update a data source.
string
The enable setting to be updated as part of the UpdateDataSource action.
string
[REQUIRED]
The identifier of the data source to be updated.
string
The name to be updated as part of the UpdateDataSource action.
boolean
The publish on import setting to be updated as part of the UpdateDataSource action.
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.
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.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': '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'
},
]
}
},
'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 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. 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.
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.
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.
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.
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.
Gets a business glossary term in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_glossary_term(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this business glossary term exists.
string
[REQUIRED]
The ID of the business glossary term.
dict
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.
Deletes a Amazon DataZone domain.
See also: AWS API Documentation
Request Syntax
client.delete_domain(
clientToken='string',
identifier='string'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Amazon Web Services domain that is to be deleted.
dict
Response Syntax
{
'status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'
}
Response Structure
(dict) --
status (string) --
The status of the domain.
Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.
See also: AWS API Documentation
Request Syntax
client.accept_predictions(
acceptChoices=[
{
'predictionChoice': 123,
'predictionTarget': 'string'
},
],
acceptRule={
'rule': 'ALL'|'NONE',
'threshold': ...
},
clientToken='string',
domainIdentifier='string',
identifier='string',
revision='string'
)
list
(dict) --
Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.
predictionChoice (integer) --
Specifies the prediction (aka, the automatically generated piece of metadata) that can be accepted.
predictionTarget (string) --
Specifies the target (for example, a column name) where a prediction can be accepted.
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.
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.
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
[REQUIRED]
string
dict
Response Syntax
{
'assetId': 'string',
'domainId': 'string',
'revision': 'string'
}
Response Structure
(dict) --
assetId (string) --
domainId (string) --
revision (string) --
Creates a subsscription grant in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_subscription_grant(
assetTargetNames=[
{
'assetId': 'string',
'targetName': 'string'
},
],
clientToken='string',
domainIdentifier='string',
environmentIdentifier='string',
grantedEntity={
'listing': {
'identifier': 'string',
'revision': 'string'
}
},
subscriptionTargetIdentifier='string'
)
list
The names of the assets for which the subscription grant is created.
(dict) --
assetId (string) -- [REQUIRED]
The identifier of the inventory asset.
targetName (string) -- [REQUIRED]
The target name in the asset target name map.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription grant is created.
string
[REQUIRED]
The ID of the environment in which the subscription grant is created.
dict
[REQUIRED]
The entity to which the subscription is to be granted.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: listing.
listing (dict) --
The listing for which a subscription is to be granted.
identifier (string) -- [REQUIRED]
An identifier of revision to be made to an asset published in a Amazon DataZone catalog.
revision (string) -- [REQUIRED]
The details of a revision to be made to an asset published in a Amazon DataZone catalog.
string
[REQUIRED]
The ID of the subscription target for which the subscription grant is created.
dict
Response Syntax
{
'assets': [
{
'assetId': 'string',
'assetRevision': '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.
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) --
A 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 is created.
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 grant.
subscriptionTargetId (string) --
The ID of the subscription target for which the subscription grant is created.
updatedAt (datetime) --
A timestamp of when the subscription grant was updated.
updatedBy (string) --
The Amazon DataZone user who updated the subscription grant.
Deletes a business glossary term in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_glossary_term(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the business glossary term is deleted.
string
[REQUIRED]
The ID of the business glossary term that is deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Delets an asset in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_asset(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the asset is deleted.
string
[REQUIRED]
The identifier of the asset that is deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a subscription request in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_subscription_request(
clientToken='string',
domainIdentifier='string',
requestReason='string',
subscribedListings=[
{
'identifier': 'string'
},
],
subscribedPrincipals=[
{
'project': {
'identifier': 'string'
}
},
]
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription request is created.
string
[REQUIRED]
The reason for the subscription request.
list
[REQUIRED]
(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.
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.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'decisionComment': 'string',
'domainId': 'string',
'id': 'string',
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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.
id (string) --
The ID of the subscription request.
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) --
(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. 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.
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.
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.
Creates a project membership in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_project_membership(
designation='PROJECT_OWNER'|'PROJECT_CONTRIBUTOR',
domainIdentifier='string',
member={
'groupIdentifier': 'string',
'userIdentifier': 'string'
},
projectIdentifier='string'
)
string
[REQUIRED]
The designation of the project membership.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which project membership is created.
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.
string
[REQUIRED]
The ID of the project for which this project membership was created.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists Amazon DataZone environments.
See also: AWS API Documentation
Request Syntax
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'
)
string
The identifier of the Amazon Web Services account where you want to list environments.
string
The Amazon Web Services region where you want to list environments.
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the Amazon DataZone blueprint.
string
The identifier of the environment profile.
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.
string
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.
string
[REQUIRED]
The identifier of the Amazon DataZone project.
string
The provider of the environment.
string
The status of the environments that you want to list.
dict
Response Syntax
{
'items': [
{
'awsAccountId': 'string',
'awsAccountRegion': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': '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.
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.
Cancels the subscription to the specified asset.
See also: AWS API Documentation
Request Syntax
client.cancel_subscription(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.
string
[REQUIRED]
The unique identifier of the subscription that is being cancelled.
dict
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': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': '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. 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.
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.
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.
Creates an Amazon DataZone data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
assetFormsInput=[
{
'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
clientToken='string',
configuration={
'glueRunConfiguration': {
'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'
},
]
}
},
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'
)
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.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
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.
glueRunConfiguration (dict) --
The configuration of the Amazon Web Services Glue data source.
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) -- [REQUIRED]
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) -- [REQUIRED]
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.
string
The description of the data source.
string
[REQUIRED]
The ID of the Amazon DataZone domain where the data source is created.
string
Specifies whether the data source is enabled.
string
[REQUIRED]
The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
string
[REQUIRED]
The name of the data source.
string
[REQUIRED]
The identifier of the Amazon DataZone project in which you want to add this data source.
boolean
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
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.
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.
string
[REQUIRED]
The type of the data source.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': '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'
},
]
}
},
'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. 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.
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.
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.
Gets an Amazon DataZone data source.
See also: AWS API Documentation
Request Syntax
client.get_data_source(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the data source exists.
string
[REQUIRED]
The ID of the Amazon DataZone data source.
dict
Response Syntax
{
'assetFormsOutput': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'configuration': {
'glueRunConfiguration': {
'accountId': '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'
},
]
}
},
'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'
},
'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. 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.
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.
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) --
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.
Updates the specified environment profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_environment_profile(
awsAccountId='string',
awsAccountRegion='string',
description='string',
domainIdentifier='string',
identifier='string',
name='string',
userParameters=[
{
'name': 'string',
'value': 'string'
},
]
)
string
The Amazon Web Services account in which a specified environment profile is to be udpated.
string
The Amazon Web Services Region in which a specified environment profile is to be updated.
string
The description to be updated as part of the UpdateEnvironmentProfile action.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which an environment profile is to be updated.
string
[REQUIRED]
The identifier of the environment profile that is to be updated.
string
The name to be updated as part of the UpdateEnvironmentProfile action.
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.
dict
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.
Updates the business glossary in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_glossary(
clientToken='string',
description='string',
domainIdentifier='string',
identifier='string',
name='string',
status='DISABLED'|'ENABLED'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
The description to be updated as part of the UpdateGlossary action.
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a business glossary is to be updated.
string
[REQUIRED]
The identifier of the business glossary to be updated.
string
The name to be updated as part of the UpdateGlossary action.
string
The status to be updated as part of the UpdateGlossary action.
dict
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.
Lists the revisions for the asset.
See also: AWS API Documentation
Request Syntax
client.list_asset_revisions(
domainIdentifier='string',
identifier='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the domain.
string
[REQUIRED]
The identifier of the asset.
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.
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.
dict
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.
Deletes a subscription target in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_subscription_target(
domainIdentifier='string',
environmentIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription target is deleted.
string
[REQUIRED]
The ID of the Amazon DataZone environment in which the subscription target is deleted.
string
[REQUIRED]
The ID of the subscription target that is deleted.
None
Creates an Amazon DataZone project.
See also: AWS API Documentation
Request Syntax
client.create_project(
description='string',
domainIdentifier='string',
glossaryTerms=[
'string',
],
name='string'
)
string
The description of the Amazon DataZone project.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this project is created.
list
The glossary terms that can be used in this Amazon DataZone project.
(string) --
string
[REQUIRED]
The name of the Amazon DataZone project.
dict
Response Syntax
{
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'domainId': 'string',
'glossaryTerms': [
'string',
],
'id': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': '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.
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.
Creates a subscription target in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
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'
)
list
[REQUIRED]
The asset types that can be included in the subscription target.
(string) --
list
[REQUIRED]
The authorized principals of the subscription target.
(string) --
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the Amazon DataZone domain in which subscription target is created.
string
[REQUIRED]
The ID of the environment in which subscription target is created.
string
[REQUIRED]
The manage access role that is used to create the subscription target.
string
[REQUIRED]
The name of the subscription target.
string
The provider of the subscription target.
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.
string
[REQUIRED]
The type of the subscription target.
dict
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.
Creates an asset in Amazon DataZone catalog.
See also: AWS API Documentation
Request Syntax
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'
)
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
Asset description.
string
[REQUIRED]
Amazon DataZone domain where the asset is created.
string
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.
list
Glossary terms attached to the asset.
(string) --
string
[REQUIRED]
Asset name.
string
[REQUIRED]
The unique identifier of the project that owns this asset.
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.
string
[REQUIRED]
The unique identifier of this asset's type.
string
The revision of this asset's type.
dict
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',
'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) --
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.
listing (dict) --
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.
Delets and metadata form type in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_form_type(
domainIdentifier='string',
formTypeIdentifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the metadata form type is deleted.
string
[REQUIRED]
The ID of the metadata form type that is deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists tags for the specified resource in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource whose tags you want to list.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The tags of the specified resource.
(string) --
(string) --
Deletes an environment in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.delete_environment(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the environment is deleted.
string
[REQUIRED]
The identifier of the environment that is to be deleted.
None