2024/11/20 - Amazon DataZone - 5 new6 updated api methods
Changes This release supports Metadata Enforcement Rule feature for Create Subscription Request action.
Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.
See also: AWS API Documentation
Request Syntax
client.get_rule(
domainIdentifier='string',
identifier='string',
revision='string'
)
string
[REQUIRED]
The ID of the domain where the GetRule action is to be invoked.
string
[REQUIRED]
The ID of the rule.
string
The revision of the rule.
dict
Response Syntax
{
'action': 'CREATE_SUBSCRIPTION_REQUEST',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'detail': {
'metadataFormEnforcementDetail': {
'requiredMetadataForms': [
{
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
}
},
'identifier': 'string',
'lastUpdatedBy': 'string',
'name': 'string',
'revision': 'string',
'ruleType': 'METADATA_FORM_ENFORCEMENT',
'scope': {
'assetType': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificAssetTypes': [
'string',
]
},
'dataProduct': True|False,
'project': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificProjects': [
'string',
]
}
},
'target': {
'domainUnitTarget': {
'domainUnitId': 'string',
'includeChildDomainUnits': True|False
}
},
'targetType': 'DOMAIN_UNIT',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
action (string) --
The action of the rule.
createdAt (datetime) --
The timestamp at which the rule was created.
createdBy (string) --
The user who created the rule.
description (string) --
The description of the rule.
detail (dict) --
The detail of the rule.
metadataFormEnforcementDetail (dict) --
The enforcement detail of the metadata form.
requiredMetadataForms (list) --
The required metadata forms.
(dict) --
The reference of a metadata form.
typeIdentifier (string) --
The type ID of the metadata form reference.
typeRevision (string) --
The type revision of the metadata form reference.
identifier (string) --
The ID of the rule.
lastUpdatedBy (string) --
The timestamp at which the rule was last updated.
name (string) --
The name of the rule.
revision (string) --
The revision of the rule.
ruleType (string) --
The type of the rule.
scope (dict) --
The scope of the rule.
assetType (dict) --
The asset type included in the rule scope.
selectionMode (string) --
The selection mode for the rule.
specificAssetTypes (list) --
The specific asset types that are included in the rule.
(string) --
dataProduct (boolean) --
The data product included in the rule scope.
project (dict) --
The project included in the rule scope.
selectionMode (string) --
The selection mode of the rule.
specificProjects (list) --
The specific projects in which the rule is created.
(string) --
target (dict) --
The target of the rule.
domainUnitTarget (dict) --
The ID of the domain unit.
domainUnitId (string) --
The ID of the domain unit.
includeChildDomainUnits (boolean) --
Specifies whether to apply a rule to the child domain units.
targetType (string) --
The target type of the rule.
updatedAt (datetime) --
The timestamp at which the rule was last updated.
Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.
See also: AWS API Documentation
Request Syntax
client.create_rule(
action='CREATE_SUBSCRIPTION_REQUEST',
clientToken='string',
description='string',
detail={
'metadataFormEnforcementDetail': {
'requiredMetadataForms': [
{
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
}
},
domainIdentifier='string',
name='string',
scope={
'assetType': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificAssetTypes': [
'string',
]
},
'dataProduct': True|False,
'project': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificProjects': [
'string',
]
}
},
target={
'domainUnitTarget': {
'domainUnitId': 'string',
'includeChildDomainUnits': True|False
}
}
)
string
[REQUIRED]
The action of the rule.
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 rule.
dict
[REQUIRED]
The detail of the rule.
metadataFormEnforcementDetail (dict) --
The enforcement detail of the metadata form.
requiredMetadataForms (list) --
The required metadata forms.
(dict) --
The reference of a metadata form.
typeIdentifier (string) -- [REQUIRED]
The type ID of the metadata form reference.
typeRevision (string) -- [REQUIRED]
The type revision of the metadata form reference.
string
[REQUIRED]
The ID of the domain where the rule is created.
string
[REQUIRED]
The name of the rule.
dict
[REQUIRED]
The scope of the rule.
assetType (dict) --
The asset type included in the rule scope.
selectionMode (string) -- [REQUIRED]
The selection mode for the rule.
specificAssetTypes (list) --
The specific asset types that are included in the rule.
(string) --
dataProduct (boolean) --
The data product included in the rule scope.
project (dict) --
The project included in the rule scope.
selectionMode (string) -- [REQUIRED]
The selection mode of the rule.
specificProjects (list) --
The specific projects in which the rule is created.
(string) --
dict
[REQUIRED]
The target of the rule.
domainUnitTarget (dict) --
The ID of the domain unit.
domainUnitId (string) -- [REQUIRED]
The ID of the domain unit.
includeChildDomainUnits (boolean) --
Specifies whether to apply a rule to the child domain units.
dict
Response Syntax
{
'action': 'CREATE_SUBSCRIPTION_REQUEST',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'detail': {
'metadataFormEnforcementDetail': {
'requiredMetadataForms': [
{
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
}
},
'identifier': 'string',
'name': 'string',
'ruleType': 'METADATA_FORM_ENFORCEMENT',
'scope': {
'assetType': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificAssetTypes': [
'string',
]
},
'dataProduct': True|False,
'project': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificProjects': [
'string',
]
}
},
'target': {
'domainUnitTarget': {
'domainUnitId': 'string',
'includeChildDomainUnits': True|False
}
},
'targetType': 'DOMAIN_UNIT'
}
Response Structure
(dict) --
action (string) --
The action of the rule.
createdAt (datetime) --
The timestamp at which the rule is created.
createdBy (string) --
The user who creates the rule.
description (string) --
The description of the rule.
detail (dict) --
The detail of the rule.
metadataFormEnforcementDetail (dict) --
The enforcement detail of the metadata form.
requiredMetadataForms (list) --
The required metadata forms.
(dict) --
The reference of a metadata form.
typeIdentifier (string) --
The type ID of the metadata form reference.
typeRevision (string) --
The type revision of the metadata form reference.
identifier (string) --
The ID of the rule.
name (string) --
The name of the rule.
ruleType (string) --
The type of the rule.
scope (dict) --
The scope of the rule.
assetType (dict) --
The asset type included in the rule scope.
selectionMode (string) --
The selection mode for the rule.
specificAssetTypes (list) --
The specific asset types that are included in the rule.
(string) --
dataProduct (boolean) --
The data product included in the rule scope.
project (dict) --
The project included in the rule scope.
selectionMode (string) --
The selection mode of the rule.
specificProjects (list) --
The specific projects in which the rule is created.
(string) --
target (dict) --
The target of the rule.
domainUnitTarget (dict) --
The ID of the domain unit.
domainUnitId (string) --
The ID of the domain unit.
includeChildDomainUnits (boolean) --
Specifies whether to apply a rule to the child domain units.
targetType (string) --
The target type of the rule.
Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.
See also: AWS API Documentation
Request Syntax
client.list_rules(
action='CREATE_SUBSCRIPTION_REQUEST',
assetTypes=[
'string',
],
dataProduct=True|False,
domainIdentifier='string',
includeCascaded=True|False,
maxResults=123,
nextToken='string',
projectIds=[
'string',
],
ruleType='METADATA_FORM_ENFORCEMENT',
targetIdentifier='string',
targetType='DOMAIN_UNIT'
)
string
The action of the rule.
list
The asset types of the rule.
(string) --
boolean
The data product of the rule.
string
[REQUIRED]
The ID of the domain in which the rules are to be listed.
boolean
Specifies whether to include cascading rules in the results.
integer
The maximum number of rules to return in a single call to ListRules. When the number of rules 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 ListRules to list the next set of rules.
string
When the number of rules 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 rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.
list
The IDs of projects in which rules are to be listed.
(string) --
string
The type of the rule.
string
[REQUIRED]
The target ID of the rule.
string
[REQUIRED]
The target type of the rule.
dict
Response Syntax
{
'items': [
{
'action': 'CREATE_SUBSCRIPTION_REQUEST',
'identifier': 'string',
'lastUpdatedBy': 'string',
'name': 'string',
'revision': 'string',
'ruleType': 'METADATA_FORM_ENFORCEMENT',
'scope': {
'assetType': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificAssetTypes': [
'string',
]
},
'dataProduct': True|False,
'project': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificProjects': [
'string',
]
}
},
'target': {
'domainUnitTarget': {
'domainUnitId': 'string',
'includeChildDomainUnits': True|False
}
},
'targetType': 'DOMAIN_UNIT',
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListRules action.
(dict) --
The summary of the rule.
action (string) --
The action of the rule.
identifier (string) --
The ID of the rule.
lastUpdatedBy (string) --
The timestamp at which the rule was last updated.
name (string) --
The name of the rule.
revision (string) --
The revision of the rule.
ruleType (string) --
The type of the rule.
scope (dict) --
The scope of the rule.
assetType (dict) --
The asset type included in the rule scope.
selectionMode (string) --
The selection mode for the rule.
specificAssetTypes (list) --
The specific asset types that are included in the rule.
(string) --
dataProduct (boolean) --
The data product included in the rule scope.
project (dict) --
The project included in the rule scope.
selectionMode (string) --
The selection mode of the rule.
specificProjects (list) --
The specific projects in which the rule is created.
(string) --
target (dict) --
The target of the rule.
domainUnitTarget (dict) --
The ID of the domain unit.
domainUnitId (string) --
The ID of the domain unit.
includeChildDomainUnits (boolean) --
Specifies whether to apply a rule to the child domain units.
targetType (string) --
The target type of the rule.
updatedAt (datetime) --
The timestamp at which the rule was last updated.
nextToken (string) --
When the number of rules 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 rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.
Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.
See also: AWS API Documentation
Request Syntax
client.update_rule(
description='string',
detail={
'metadataFormEnforcementDetail': {
'requiredMetadataForms': [
{
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
}
},
domainIdentifier='string',
identifier='string',
includeChildDomainUnits=True|False,
name='string',
scope={
'assetType': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificAssetTypes': [
'string',
]
},
'dataProduct': True|False,
'project': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificProjects': [
'string',
]
}
}
)
string
The description of the rule.
dict
The detail of the rule.
metadataFormEnforcementDetail (dict) --
The enforcement detail of the metadata form.
requiredMetadataForms (list) --
The required metadata forms.
(dict) --
The reference of a metadata form.
typeIdentifier (string) -- [REQUIRED]
The type ID of the metadata form reference.
typeRevision (string) -- [REQUIRED]
The type revision of the metadata form reference.
string
[REQUIRED]
The ID of the domain in which a rule is to be updated.
string
[REQUIRED]
The ID of the rule that is to be updated
boolean
Specifies whether to update this rule in the child domain units.
string
The name of the rule.
dict
The scrope of the rule.
assetType (dict) --
The asset type included in the rule scope.
selectionMode (string) -- [REQUIRED]
The selection mode for the rule.
specificAssetTypes (list) --
The specific asset types that are included in the rule.
(string) --
dataProduct (boolean) --
The data product included in the rule scope.
project (dict) --
The project included in the rule scope.
selectionMode (string) -- [REQUIRED]
The selection mode of the rule.
specificProjects (list) --
The specific projects in which the rule is created.
(string) --
dict
Response Syntax
{
'action': 'CREATE_SUBSCRIPTION_REQUEST',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'detail': {
'metadataFormEnforcementDetail': {
'requiredMetadataForms': [
{
'typeIdentifier': 'string',
'typeRevision': 'string'
},
]
}
},
'identifier': 'string',
'lastUpdatedBy': 'string',
'name': 'string',
'revision': 'string',
'ruleType': 'METADATA_FORM_ENFORCEMENT',
'scope': {
'assetType': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificAssetTypes': [
'string',
]
},
'dataProduct': True|False,
'project': {
'selectionMode': 'ALL'|'SPECIFIC',
'specificProjects': [
'string',
]
}
},
'target': {
'domainUnitTarget': {
'domainUnitId': 'string',
'includeChildDomainUnits': True|False
}
},
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
action (string) --
The action of the rule.
createdAt (datetime) --
The timestamp at which the rule was created.
createdBy (string) --
The user who created the rule.
description (string) --
The description of the rule.
detail (dict) --
The detail of the rule.
metadataFormEnforcementDetail (dict) --
The enforcement detail of the metadata form.
requiredMetadataForms (list) --
The required metadata forms.
(dict) --
The reference of a metadata form.
typeIdentifier (string) --
The type ID of the metadata form reference.
typeRevision (string) --
The type revision of the metadata form reference.
identifier (string) --
The ID of the rule.
lastUpdatedBy (string) --
The timestamp at which the rule was last updated.
name (string) --
The name of the rule.
revision (string) --
The revision of the rule.
ruleType (string) --
The type of the rule.
scope (dict) --
The scope of the rule.
assetType (dict) --
The asset type included in the rule scope.
selectionMode (string) --
The selection mode for the rule.
specificAssetTypes (list) --
The specific asset types that are included in the rule.
(string) --
dataProduct (boolean) --
The data product included in the rule scope.
project (dict) --
The project included in the rule scope.
selectionMode (string) --
The selection mode of the rule.
specificProjects (list) --
The specific projects in which the rule is created.
(string) --
target (dict) --
The target of the rule.
domainUnitTarget (dict) --
The ID of the domain unit.
domainUnitId (string) --
The ID of the domain unit.
includeChildDomainUnits (boolean) --
Specifies whether to apply a rule to the child domain units.
updatedAt (datetime) --
The timestamp at which the rule was last updated.
Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.
See also: AWS API Documentation
Request Syntax
client.delete_rule(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the domain that where the rule is to be deleted.
string
[REQUIRED]
The ID of the rule that is to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
{'existingSubscriptionId': 'string',
'metadataForms': [{'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'}]}
Accepts a subscription request to a specific asset.
See also: AWS API Documentation
Request Syntax
client.accept_subscription_request(
assetScopes=[
{
'assetId': 'string',
'filterIds': [
'string',
]
},
],
decisionComment='string',
domainIdentifier='string',
identifier='string'
)
list
The asset scopes of the accept subscription request.
(dict) --
The accepted asset scope.
assetId (string) -- [REQUIRED]
The asset ID of the accepted asset scope.
filterIds (list) -- [REQUIRED]
The filter IDs of the accepted asset scope.
(string) --
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',
'existingSubscriptionId': 'string',
'id': 'string',
'metadataForms': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'assetScope': {
'assetId': 'string',
'errorMessage': 'string',
'filterIds': [
'string',
],
'status': 'string'
},
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
]
},
'productListing': {
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
],
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string'
}
},
'name': 'string',
'ownerProjectId': 'string',
'ownerProjectName': 'string',
'revision': 'string'
},
],
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
}
},
],
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp that specifies when the subscription request was accepted.
createdBy (string) --
Specifies the Amazon DataZone user that accepted the specified subscription request.
decisionComment (string) --
Specifies the reason for accepting the subscription request.
domainId (string) --
The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.
existingSubscriptionId (string) --
The ID of the existing subscription.
id (string) --
The identifier of the subscription request.
metadataForms (list) --
The metadata form in the subscription request.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
formName (string) --
The name of the metadata form.
typeName (string) --
The name of the metadata form type.
typeRevision (string) --
The revision of the metadata form type.
requestReason (string) --
Specifies the reason for requesting a subscription to the asset.
reviewerId (string) --
Specifes the ID of the Amazon DataZone user who reviewed the subscription request.
status (string) --
Specifies the status of the subscription request.
subscribedListings (list) --
Specifies the asset for which the subscription request was created.
(dict) --
The details of the published asset for which the subscription grant is created.
description (string) --
The description of the published asset for which the subscription grant is created.
id (string) --
The identifier of the published asset for which the subscription grant is created.
item (dict) --
The published asset for which the subscription grant is created.
assetListing (dict) --
The asset for which the subscription grant is created.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
errorMessage (string) --
The error message of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
entityId (string) --
The identifier of the published asset for which the subscription grant is created.
entityRevision (string) --
The revision of the published asset for which the subscription grant is created.
entityType (string) --
The type of the published asset for which the subscription grant is created.
forms (string) --
The forms attached to the published asset for which the subscription grant is created.
glossaryTerms (list) --
The glossary terms attached to the published asset for which the subscription grant is created.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
productListing (dict) --
The data product listing.
assetListings (list) --
The data assets of the data product listing.
(dict) --
The listing of the asset in a data product.
entityId (string) --
The entity ID of the listing of the asset in a data product.
entityRevision (string) --
The entity revision of the listing of the asset in a data product.
entityType (string) --
The entity type of the listing of the asset in a data product.
description (string) --
The description of the data product listing.
entityId (string) --
The ID of the data product listing.
entityRevision (string) --
The revision of the data product listing.
glossaryTerms (list) --
The glossary terms of the data product listing.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
name (string) --
The name of the data product listing.
name (string) --
The name of the published asset for which the subscription grant is created.
ownerProjectId (string) --
The identifier of the project of the published asset for which the subscription grant is created.
ownerProjectName (string) --
The name of the project that owns the published asset for which the subscription grant is created.
revision (string) --
The revision of the published asset for which the subscription grant is created.
subscribedPrincipals (list) --
Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request.
(dict) --
The principal that has the subscription grant for the asset.
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.
{'metadataForms': [{'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'}]}
Response {'existingSubscriptionId': 'string',
'metadataForms': [{'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'}]}
Creates a subscription request in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_subscription_request(
clientToken='string',
domainIdentifier='string',
metadataForms=[
{
'content': 'string',
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string'
},
],
requestReason='string',
subscribedListings=[
{
'identifier': 'string'
},
],
subscribedPrincipals=[
{
'project': {
'identifier': 'string'
}
},
]
)
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.
list
The metadata form included in the subscription request.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
formName (string) -- [REQUIRED]
The name of the metadata form.
typeIdentifier (string) --
The ID of the metadata form type.
typeRevision (string) --
The revision of the metadata form type.
string
[REQUIRED]
The reason for the subscription request.
list
[REQUIRED]
The published asset for which the subscription grant is to be created.
(dict) --
The published asset for which the subscription grant is to be created.
identifier (string) -- [REQUIRED]
The identifier of the published asset for which the subscription grant is to be created.
list
[REQUIRED]
The Amazon DataZone principals for whom the subscription request is created.
(dict) --
The principal that is to be given a subscriptiong grant.
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',
'existingSubscriptionId': 'string',
'id': 'string',
'metadataForms': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'assetScope': {
'assetId': 'string',
'errorMessage': 'string',
'filterIds': [
'string',
],
'status': 'string'
},
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
]
},
'productListing': {
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
],
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string'
}
},
'name': 'string',
'ownerProjectId': 'string',
'ownerProjectName': 'string',
'revision': 'string'
},
],
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
}
},
],
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
A timestamp of when the subscription request is created.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
decisionComment (string) --
The decision comment of the subscription request.
domainId (string) --
The ID of the Amazon DataZone domain in whcih the subscription request is created.
existingSubscriptionId (string) --
The ID of the existing subscription.
id (string) --
The ID of the subscription request.
metadataForms (list) --
The metadata form included in the subscription request.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
formName (string) --
The name of the metadata form.
typeName (string) --
The name of the metadata form type.
typeRevision (string) --
The revision of the metadata form type.
requestReason (string) --
The reason for the subscription request.
reviewerId (string) --
The ID of the reviewer of the subscription request.
status (string) --
The status of the subscription request.
subscribedListings (list) --
The published asset for which the subscription grant is to be created.
(dict) --
The details of the published asset for which the subscription grant is created.
description (string) --
The description of the published asset for which the subscription grant is created.
id (string) --
The identifier of the published asset for which the subscription grant is created.
item (dict) --
The published asset for which the subscription grant is created.
assetListing (dict) --
The asset for which the subscription grant is created.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
errorMessage (string) --
The error message of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
entityId (string) --
The identifier of the published asset for which the subscription grant is created.
entityRevision (string) --
The revision of the published asset for which the subscription grant is created.
entityType (string) --
The type of the published asset for which the subscription grant is created.
forms (string) --
The forms attached to the published asset for which the subscription grant is created.
glossaryTerms (list) --
The glossary terms attached to the published asset for which the subscription grant is created.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
productListing (dict) --
The data product listing.
assetListings (list) --
The data assets of the data product listing.
(dict) --
The listing of the asset in a data product.
entityId (string) --
The entity ID of the listing of the asset in a data product.
entityRevision (string) --
The entity revision of the listing of the asset in a data product.
entityType (string) --
The entity type of the listing of the asset in a data product.
description (string) --
The description of the data product listing.
entityId (string) --
The ID of the data product listing.
entityRevision (string) --
The revision of the data product listing.
glossaryTerms (list) --
The glossary terms of the data product listing.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
name (string) --
The name of the data product listing.
name (string) --
The name of the published asset for which the subscription grant is created.
ownerProjectId (string) --
The identifier of the project of the published asset for which the subscription grant is created.
ownerProjectName (string) --
The name of the project that owns the published asset for which the subscription grant is created.
revision (string) --
The revision of the published asset for which the subscription grant is created.
subscribedPrincipals (list) --
The subscribed principals of the subscription request.
(dict) --
The principal that has the subscription grant for the asset.
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.
{'existingSubscriptionId': 'string',
'metadataForms': [{'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'}]}
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',
'existingSubscriptionId': 'string',
'id': 'string',
'metadataForms': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'assetScope': {
'assetId': 'string',
'errorMessage': 'string',
'filterIds': [
'string',
],
'status': 'string'
},
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
]
},
'productListing': {
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
],
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string'
}
},
'name': 'string',
'ownerProjectId': 'string',
'ownerProjectName': 'string',
'revision': 'string'
},
],
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
}
},
],
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the specified subscription request was created.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
decisionComment (string) --
The decision comment of the subscription request.
domainId (string) --
The Amazon DataZone domain of the subscription request.
existingSubscriptionId (string) --
The ID of the existing subscription.
id (string) --
The identifier of the subscription request.
metadataForms (list) --
The metadata forms included in the subscription request.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
formName (string) --
The name of the metadata form.
typeName (string) --
The name of the metadata form type.
typeRevision (string) --
The revision of the metadata form type.
requestReason (string) --
The reason for the subscription request.
reviewerId (string) --
The identifier of the Amazon DataZone user who reviewed the subscription request.
status (string) --
The status of the subscription request.
subscribedListings (list) --
The subscribed listings in the subscription request.
(dict) --
The details of the published asset for which the subscription grant is created.
description (string) --
The description of the published asset for which the subscription grant is created.
id (string) --
The identifier of the published asset for which the subscription grant is created.
item (dict) --
The published asset for which the subscription grant is created.
assetListing (dict) --
The asset for which the subscription grant is created.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
errorMessage (string) --
The error message of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
entityId (string) --
The identifier of the published asset for which the subscription grant is created.
entityRevision (string) --
The revision of the published asset for which the subscription grant is created.
entityType (string) --
The type of the published asset for which the subscription grant is created.
forms (string) --
The forms attached to the published asset for which the subscription grant is created.
glossaryTerms (list) --
The glossary terms attached to the published asset for which the subscription grant is created.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
productListing (dict) --
The data product listing.
assetListings (list) --
The data assets of the data product listing.
(dict) --
The listing of the asset in a data product.
entityId (string) --
The entity ID of the listing of the asset in a data product.
entityRevision (string) --
The entity revision of the listing of the asset in a data product.
entityType (string) --
The entity type of the listing of the asset in a data product.
description (string) --
The description of the data product listing.
entityId (string) --
The ID of the data product listing.
entityRevision (string) --
The revision of the data product listing.
glossaryTerms (list) --
The glossary terms of the data product listing.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
name (string) --
The name of the data product listing.
name (string) --
The name of the published asset for which the subscription grant is created.
ownerProjectId (string) --
The identifier of the project of the published asset for which the subscription grant is created.
ownerProjectName (string) --
The name of the project that owns the published asset for which the subscription grant is created.
revision (string) --
The revision of the published asset for which the subscription grant is created.
subscribedPrincipals (list) --
The subscribed principals in the subscription request.
(dict) --
The principal that has the subscription grant for the asset.
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.
{'items': {'existingSubscriptionId': 'string',
'metadataFormsSummary': [{'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'}]}}
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',
'existingSubscriptionId': 'string',
'id': 'string',
'metadataFormsSummary': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'assetScope': {
'assetId': 'string',
'errorMessage': 'string',
'filterIds': [
'string',
],
'status': 'string'
},
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
]
},
'productListing': {
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
],
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string'
}
},
'name': 'string',
'ownerProjectId': 'string',
'ownerProjectName': 'string',
'revision': 'string'
},
],
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
}
},
],
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListSubscriptionRequests action.
(dict) --
The details of the subscription request.
createdAt (datetime) --
The timestamp of when a subscription request was created.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
decisionComment (string) --
The decision comment of the subscription request.
domainId (string) --
The identifier of the Amazon DataZone domain in which a subscription request exists.
existingSubscriptionId (string) --
The ID of the existing subscription.
id (string) --
The identifier of the subscription request.
metadataFormsSummary (list) --
The summary of the metadata forms.
(dict) --
The summary of the metadata form.
formName (string) --
The form name of the metadata form.
typeName (string) --
The type name of the metadata form.
typeRevision (string) --
The type revision of the metadata form.
requestReason (string) --
The reason for the subscription request.
reviewerId (string) --
The identifier of the subscription request reviewer.
status (string) --
The status of the subscription request.
subscribedListings (list) --
The listings included in the subscription request.
(dict) --
The details of the published asset for which the subscription grant is created.
description (string) --
The description of the published asset for which the subscription grant is created.
id (string) --
The identifier of the published asset for which the subscription grant is created.
item (dict) --
The published asset for which the subscription grant is created.
assetListing (dict) --
The asset for which the subscription grant is created.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
errorMessage (string) --
The error message of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
entityId (string) --
The identifier of the published asset for which the subscription grant is created.
entityRevision (string) --
The revision of the published asset for which the subscription grant is created.
entityType (string) --
The type of the published asset for which the subscription grant is created.
forms (string) --
The forms attached to the published asset for which the subscription grant is created.
glossaryTerms (list) --
The glossary terms attached to the published asset for which the subscription grant is created.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
productListing (dict) --
The data product listing.
assetListings (list) --
The data assets of the data product listing.
(dict) --
The listing of the asset in a data product.
entityId (string) --
The entity ID of the listing of the asset in a data product.
entityRevision (string) --
The entity revision of the listing of the asset in a data product.
entityType (string) --
The entity type of the listing of the asset in a data product.
description (string) --
The description of the data product listing.
entityId (string) --
The ID of the data product listing.
entityRevision (string) --
The revision of the data product listing.
glossaryTerms (list) --
The glossary terms of the data product listing.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
name (string) --
The name of the data product listing.
name (string) --
The name of the published asset for which the subscription grant is created.
ownerProjectId (string) --
The identifier of the project of the published asset for which the subscription grant is created.
ownerProjectName (string) --
The name of the project that owns the published asset for which the subscription grant is created.
revision (string) --
The revision of the published asset for which the subscription grant is created.
subscribedPrincipals (list) --
The principals included in the subscription request.
(dict) --
The principal that has the subscription grant for the asset.
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.
{'existingSubscriptionId': 'string',
'metadataForms': [{'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'}]}
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',
'existingSubscriptionId': 'string',
'id': 'string',
'metadataForms': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'assetScope': {
'assetId': 'string',
'errorMessage': 'string',
'filterIds': [
'string',
],
'status': 'string'
},
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
]
},
'productListing': {
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
],
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string'
}
},
'name': 'string',
'ownerProjectId': 'string',
'ownerProjectName': 'string',
'revision': 'string'
},
],
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
}
},
],
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the subscription request was rejected.
createdBy (string) --
The timestamp of when the subscription request was rejected.
decisionComment (string) --
The decision comment of the rejected subscription request.
domainId (string) --
The identifier of the Amazon DataZone domain in which the subscription request was rejected.
existingSubscriptionId (string) --
The ID of the existing subscription.
id (string) --
The identifier of the subscription request that was rejected.
metadataForms (list) --
Metadata forms included in the subscription request.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
formName (string) --
The name of the metadata form.
typeName (string) --
The name of the metadata form type.
typeRevision (string) --
The revision of the metadata form type.
requestReason (string) --
The reason for the subscription request.
reviewerId (string) --
The identifier of the subscription request reviewer.
status (string) --
The status of the subscription request.
subscribedListings (list) --
The subscribed listings of the subscription request.
(dict) --
The details of the published asset for which the subscription grant is created.
description (string) --
The description of the published asset for which the subscription grant is created.
id (string) --
The identifier of the published asset for which the subscription grant is created.
item (dict) --
The published asset for which the subscription grant is created.
assetListing (dict) --
The asset for which the subscription grant is created.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
errorMessage (string) --
The error message of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
entityId (string) --
The identifier of the published asset for which the subscription grant is created.
entityRevision (string) --
The revision of the published asset for which the subscription grant is created.
entityType (string) --
The type of the published asset for which the subscription grant is created.
forms (string) --
The forms attached to the published asset for which the subscription grant is created.
glossaryTerms (list) --
The glossary terms attached to the published asset for which the subscription grant is created.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
productListing (dict) --
The data product listing.
assetListings (list) --
The data assets of the data product listing.
(dict) --
The listing of the asset in a data product.
entityId (string) --
The entity ID of the listing of the asset in a data product.
entityRevision (string) --
The entity revision of the listing of the asset in a data product.
entityType (string) --
The entity type of the listing of the asset in a data product.
description (string) --
The description of the data product listing.
entityId (string) --
The ID of the data product listing.
entityRevision (string) --
The revision of the data product listing.
glossaryTerms (list) --
The glossary terms of the data product listing.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
name (string) --
The name of the data product listing.
name (string) --
The name of the published asset for which the subscription grant is created.
ownerProjectId (string) --
The identifier of the project of the published asset for which the subscription grant is created.
ownerProjectName (string) --
The name of the project that owns the published asset for which the subscription grant is created.
revision (string) --
The revision of the published asset for which the subscription grant is created.
subscribedPrincipals (list) --
The subscribed principals of the subscription request.
(dict) --
The principal that has the subscription grant for the asset.
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.
{'existingSubscriptionId': 'string',
'metadataForms': [{'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'}]}
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',
'existingSubscriptionId': 'string',
'id': 'string',
'metadataForms': [
{
'content': 'string',
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
],
'requestReason': 'string',
'reviewerId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'subscribedListings': [
{
'description': 'string',
'id': 'string',
'item': {
'assetListing': {
'assetScope': {
'assetId': 'string',
'errorMessage': 'string',
'filterIds': [
'string',
],
'status': 'string'
},
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
]
},
'productListing': {
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
],
'description': 'string',
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string'
}
},
'name': 'string',
'ownerProjectId': 'string',
'ownerProjectName': 'string',
'revision': 'string'
},
],
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
}
},
],
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
Response Structure
(dict) --
createdAt (datetime) --
The timestamp of when the subscription request was created.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
decisionComment (string) --
The decision comment of the UpdateSubscriptionRequest action.
domainId (string) --
The identifier of the Amazon DataZone domain in which a subscription request is to be updated.
existingSubscriptionId (string) --
The ID of the existing subscription.
id (string) --
The identifier of the subscription request that is to be updated.
metadataForms (list) --
Metadata forms included in the subscription request.
(dict) --
The details of a metadata form.
content (string) --
The content of the metadata form.
formName (string) --
The name of the metadata form.
typeName (string) --
The name of the metadata form type.
typeRevision (string) --
The revision of the metadata form type.
requestReason (string) --
The reason for the UpdateSubscriptionRequest action.
reviewerId (string) --
The identifier of the Amazon DataZone user who reviews the subscription request.
status (string) --
The status of the subscription request.
subscribedListings (list) --
The subscribed listings of the subscription request.
(dict) --
The details of the published asset for which the subscription grant is created.
description (string) --
The description of the published asset for which the subscription grant is created.
id (string) --
The identifier of the published asset for which the subscription grant is created.
item (dict) --
The published asset for which the subscription grant is created.
assetListing (dict) --
The asset for which the subscription grant is created.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
errorMessage (string) --
The error message of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
entityId (string) --
The identifier of the published asset for which the subscription grant is created.
entityRevision (string) --
The revision of the published asset for which the subscription grant is created.
entityType (string) --
The type of the published asset for which the subscription grant is created.
forms (string) --
The forms attached to the published asset for which the subscription grant is created.
glossaryTerms (list) --
The glossary terms attached to the published asset for which the subscription grant is created.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
productListing (dict) --
The data product listing.
assetListings (list) --
The data assets of the data product listing.
(dict) --
The listing of the asset in a data product.
entityId (string) --
The entity ID of the listing of the asset in a data product.
entityRevision (string) --
The entity revision of the listing of the asset in a data product.
entityType (string) --
The entity type of the listing of the asset in a data product.
description (string) --
The description of the data product listing.
entityId (string) --
The ID of the data product listing.
entityRevision (string) --
The revision of the data product listing.
glossaryTerms (list) --
The glossary terms of the data product listing.
(dict) --
Details of a glossary term attached to the inventory asset.
name (string) --
The name of a glossary term attached to the inventory asset.
shortDescription (string) --
The shoft description of a glossary term attached to the inventory asset.
name (string) --
The name of the data product listing.
name (string) --
The name of the published asset for which the subscription grant is created.
ownerProjectId (string) --
The identifier of the project of the published asset for which the subscription grant is created.
ownerProjectName (string) --
The name of the project that owns the published asset for which the subscription grant is created.
revision (string) --
The revision of the published asset for which the subscription grant is created.
subscribedPrincipals (list) --
The subscribed principals of the subscription request.
(dict) --
The principal that has the subscription grant for the asset.
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.