2026/01/13 - Amazon DataZone - 15 updated api methods
Changes Adds support for IAM role subscriptions to Glue table listings via CreateSubscriptionRequest API. Also adds owningIamPrincipalArn filter to List APIs and subscriptionGrantCreationMode parameter to subscription target APIs for controlling grant creation behavior.
{'subscribedPrincipals': {'iam': {'principalArn': 'string'}}}
Accepts a subscription request to a specific asset.
See also: AWS API Documentation
Request Syntax
client.accept_subscription_request(
domainIdentifier='string',
identifier='string',
decisionComment='string',
assetScopes=[
{
'assetId': 'string',
'filterIds': [
'string',
]
},
],
assetPermissions=[
{
'assetId': 'string',
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
]
)
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.
string
A description that specifies the reason for accepting the specified subscription request.
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) --
list
The asset permissions of the accept subscription request.
(dict) --
The asset permissions.
assetId (string) -- [REQUIRED]
The asset ID as part of the asset permissions.
permissions (dict) -- [REQUIRED]
The details as part of the asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
dict
Response Syntax
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'requestReason': 'string',
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
],
'subscribedListings': [
{
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
],
'reviewerId': 'string',
'decisionComment': 'string',
'existingSubscriptionId': 'string',
'metadataForms': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string',
'content': 'string'
},
]
}
Response Structure
(dict) --
id (string) --
The identifier of the subscription request.
createdBy (string) --
Specifies the Amazon DataZone user that accepted the specified subscription request.
updatedBy (string) --
Specifies the Amazon DataZone user who updated the subscription request.
domainId (string) --
The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.
status (string) --
Specifies the status of the subscription request.
createdAt (datetime) --
The timestamp that specifies when the subscription request was accepted.
updatedAt (datetime) --
Specifies the timestamp when subscription request was updated.
requestReason (string) --
Specifies the reason for requesting a subscription to the asset.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
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.
id (string) --
The identifier of 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.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
reviewerId (string) --
Specifes the ID of the Amazon DataZone user who reviewed the subscription request.
decisionComment (string) --
Specifies the reason for accepting the subscription request.
existingSubscriptionId (string) --
The ID of the existing subscription.
metadataForms (list) --
The metadata form in the subscription request.
(dict) --
The details of a 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.
content (string) --
The content of the metadata form.
{'subscribedPrincipal': {'iam': {'principalArn': 'string'}}}
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
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'APPROVED'|'REVOKED'|'CANCELLED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'subscribedPrincipal': {
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
'subscribedListing': {
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
'subscriptionRequestId': 'string',
'retainPermissions': True|False
}
Response Structure
(dict) --
id (string) --
The identifier of the subscription.
createdBy (string) --
Specifies the Amazon DataZone user who is cancelling the subscription.
updatedBy (string) --
The Amazon DataZone user that cancelled the subscription.
domainId (string) --
The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.
status (string) --
The status of the request to cancel the subscription.
createdAt (datetime) --
The timestamp that specifies when the request to cancel the subscription was created.
updatedAt (datetime) --
The timestamp that specifies when the subscription was cancelled.
subscribedPrincipal (dict) --
The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListing (dict) --
The asset to which a subscription is being cancelled.
id (string) --
The identifier of 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.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
subscriptionRequestId (string) --
The unique ID of the subscripton request for the subscription that is being cancelled.
retainPermissions (boolean) --
Specifies whether the permissions to the asset are retained after the subscription is cancelled.
{'subscribedPrincipals': {'iam': {'identifier': 'string'}}}
Response {'subscribedPrincipals': {'iam': {'principalArn': 'string'}}}
Creates a subscription request in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_subscription_request(
domainIdentifier='string',
subscribedPrincipals=[
{
'project': {
'identifier': 'string'
},
'user': {
'identifier': 'string'
},
'group': {
'identifier': 'string'
},
'iam': {
'identifier': 'string'
}
},
],
subscribedListings=[
{
'identifier': 'string'
},
],
requestReason='string',
clientToken='string',
metadataForms=[
{
'formName': 'string',
'typeIdentifier': 'string',
'typeRevision': 'string',
'content': 'string'
},
],
assetPermissions=[
{
'assetId': 'string',
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
],
assetScopes=[
{
'assetId': 'string',
'filterIds': [
'string',
]
},
]
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the subscription request is 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.
user (dict) --
The subscribed user.
identifier (string) --
The ID of the subscribed user.
group (dict) --
The subscribed group.
identifier (string) --
The ID of the subscribed group.
iam (dict) --
The subscribed IAM principal.
identifier (string) --
The ARN of the subscribed IAM principal.
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.
string
[REQUIRED]
The reason for the subscription request.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
list
The metadata form included in the subscription request.
(dict) --
The details of a 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.
content (string) --
The content of the metadata form.
list
The asset permissions of the subscription request.
(dict) --
The asset permissions.
assetId (string) -- [REQUIRED]
The asset ID as part of the asset permissions.
permissions (dict) -- [REQUIRED]
The details as part of the asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
list
The asset scopes of the 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) --
dict
Response Syntax
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'requestReason': 'string',
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
],
'subscribedListings': [
{
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
],
'reviewerId': 'string',
'decisionComment': 'string',
'existingSubscriptionId': 'string',
'metadataForms': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string',
'content': 'string'
},
]
}
Response Structure
(dict) --
id (string) --
The ID of the subscription request.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
updatedBy (string) --
The Amazon DataZone user who updated the subscription request.
domainId (string) --
The ID of the Amazon DataZone domain in whcih the subscription request is created.
status (string) --
The status of the subscription request.
createdAt (datetime) --
A timestamp of when the subscription request is created.
updatedAt (datetime) --
The timestamp of when the subscription request was updated.
requestReason (string) --
The reason for the subscription request.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
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.
id (string) --
The identifier of 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.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
reviewerId (string) --
The ID of the reviewer of the subscription request.
decisionComment (string) --
The decision comment of the subscription request.
existingSubscriptionId (string) --
The ID of the existing subscription.
metadataForms (list) --
The metadata form included in the subscription request.
(dict) --
The details of a 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.
content (string) --
The content of the metadata form.
{'subscriptionGrantCreationMode': 'AUTOMATIC | MANUAL'}
Creates a subscription target in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_subscription_target(
domainIdentifier='string',
environmentIdentifier='string',
name='string',
type='string',
subscriptionTargetConfig=[
{
'formName': 'string',
'content': 'string'
},
],
authorizedPrincipals=[
'string',
],
manageAccessRole='string',
applicableAssetTypes=[
'string',
],
provider='string',
clientToken='string',
subscriptionGrantCreationMode='AUTOMATIC'|'MANUAL'
)
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 name of the subscription target.
string
[REQUIRED]
The type of the subscription target.
list
[REQUIRED]
The configuration of the subscription target.
(dict) --
The details of the subscription target configuration.
formName (string) -- [REQUIRED]
The form name included in the subscription target configuration.
content (string) -- [REQUIRED]
The content of the subscription target configuration.
list
[REQUIRED]
The authorized principals of the subscription target.
(string) --
string
[REQUIRED]
The manage access role that is used to create the subscription target.
list
[REQUIRED]
The asset types that can be included in the subscription target.
(string) --
string
The provider of the subscription target.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
dict
Response Syntax
{
'id': 'string',
'authorizedPrincipals': [
'string',
],
'domainId': 'string',
'projectId': 'string',
'environmentId': 'string',
'name': 'string',
'type': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'manageAccessRole': 'string',
'applicableAssetTypes': [
'string',
],
'subscriptionTargetConfig': [
{
'formName': 'string',
'content': 'string'
},
],
'provider': 'string',
'subscriptionGrantCreationMode': 'AUTOMATIC'|'MANUAL'
}
Response Structure
(dict) --
id (string) --
The ID of the subscription target.
authorizedPrincipals (list) --
The authorised principals of the subscription target.
(string) --
domainId (string) --
The ID of the Amazon DataZone domain in which the subscription target was created.
projectId (string) --
???
environmentId (string) --
The ID of the environment in which the subscription target was created.
name (string) --
The name of the subscription target.
type (string) --
The type of the subscription target.
createdBy (string) --
The Amazon DataZone user who created the subscription target.
updatedBy (string) --
The Amazon DataZone user who updated the subscription target.
createdAt (datetime) --
The timestamp of when the subscription target was created.
updatedAt (datetime) --
The timestamp of when the subscription target was updated.
manageAccessRole (string) --
The manage access role with which the subscription target was created.
applicableAssetTypes (list) --
The asset types that can be included in the subscription target.
(string) --
subscriptionTargetConfig (list) --
The configuration of the subscription target.
(dict) --
The details of the subscription target configuration.
formName (string) --
The form name included in the subscription target configuration.
content (string) --
The content of the subscription target configuration.
provider (string) --
The provider of the subscription target.
subscriptionGrantCreationMode (string) --
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
{'subscribedPrincipal': {'iam': {'principalArn': 'string'}}}
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
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'APPROVED'|'REVOKED'|'CANCELLED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'subscribedPrincipal': {
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
'subscribedListing': {
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
'subscriptionRequestId': 'string',
'retainPermissions': True|False
}
Response Structure
(dict) --
id (string) --
The ID of the subscription.
createdBy (string) --
The Amazon DataZone user who created the subscription.
updatedBy (string) --
The Amazon DataZone user who updated the subscription.
domainId (string) --
The ID of the Amazon DataZone domain in which the subscription exists.
status (string) --
The status of the subscription.
createdAt (datetime) --
The timestamp of when the subscription was created.
updatedAt (datetime) --
The timestamp of when the subscription was updated.
subscribedPrincipal (dict) --
The principal that owns the subscription.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListing (dict) --
The details 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.
revision (string) --
The revision of the published asset for which the subscription grant is created.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
subscriptionRequestId (string) --
The ID of the subscription request.
retainPermissions (boolean) --
The retain permissions of the subscription.
{'subscribedPrincipals': {'iam': {'principalArn': '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
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'requestReason': 'string',
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
],
'subscribedListings': [
{
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
],
'reviewerId': 'string',
'decisionComment': 'string',
'existingSubscriptionId': 'string',
'metadataForms': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string',
'content': 'string'
},
]
}
Response Structure
(dict) --
id (string) --
The identifier of the subscription request.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
updatedBy (string) --
The Amazon DataZone user who updated the subscription request.
domainId (string) --
The Amazon DataZone domain of the subscription request.
status (string) --
The status of the subscription request.
createdAt (datetime) --
The timestamp of when the specified subscription request was created.
updatedAt (datetime) --
The timestamp of when the subscription request was updated.
requestReason (string) --
The reason for the subscription request.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListings (list) --
The subscribed listings in the subscription request.
(dict) --
The details 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.
revision (string) --
The revision of the published asset for which the subscription grant is created.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
reviewerId (string) --
The identifier of the Amazon DataZone user who reviewed the subscription request.
decisionComment (string) --
The decision comment of the subscription request.
existingSubscriptionId (string) --
The ID of the existing subscription.
metadataForms (list) --
The metadata forms included in the subscription request.
(dict) --
The details of a 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.
content (string) --
The content of the metadata form.
{'subscriptionGrantCreationMode': 'AUTOMATIC | MANUAL'}
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
{
'id': 'string',
'authorizedPrincipals': [
'string',
],
'domainId': 'string',
'projectId': 'string',
'environmentId': 'string',
'name': 'string',
'type': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'manageAccessRole': 'string',
'applicableAssetTypes': [
'string',
],
'subscriptionTargetConfig': [
{
'formName': 'string',
'content': 'string'
},
],
'provider': 'string',
'subscriptionGrantCreationMode': 'AUTOMATIC'|'MANUAL'
}
Response Structure
(dict) --
id (string) --
The ID of the subscription target.
authorizedPrincipals (list) --
The authorized principals of the subscription target.
(string) --
domainId (string) --
The ID of the Amazon DataZone domain in which the subscription target exists.
projectId (string) --
The ID of the project associated with the subscription target.
environmentId (string) --
The ID of the environment associated with the subscription target.
name (string) --
The name of the subscription target.
type (string) --
The type of the subscription target.
createdBy (string) --
The Amazon DataZone user who created the subscription target.
updatedBy (string) --
The Amazon DataZone user who updated the subscription target.
createdAt (datetime) --
The timestamp of when the subscription target was created.
updatedAt (datetime) --
The timestamp of when the subscription target was updated.
manageAccessRole (string) --
The manage access role with which the subscription target was created.
applicableAssetTypes (list) --
The asset types associated with the subscription target.
(string) --
subscriptionTargetConfig (list) --
The configuration of teh subscription target.
(dict) --
The details of the subscription target configuration.
formName (string) --
The form name included in the subscription target configuration.
content (string) --
The content of the subscription target configuration.
provider (string) --
The provider of the subscription target.
subscriptionGrantCreationMode (string) --
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
{'owningIamPrincipalArn': 'string'}
Lists subscription grants.
See also: AWS API Documentation
Request Syntax
client.list_subscription_grants(
domainIdentifier='string',
environmentId='string',
subscriptionTargetId='string',
subscribedListingId='string',
subscriptionId='string',
owningProjectId='string',
owningIamPrincipalArn='string',
owningUserId='string',
owningGroupId='string',
sortBy='CREATED_AT'|'UPDATED_AT',
sortOrder='ASCENDING'|'DESCENDING',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the Amazon DataZone environment.
string
The identifier of the subscription target.
string
The identifier of the subscribed listing.
string
The identifier of the subscription.
string
The ID of the owning project of the subscription grants.
string
The ARN of the owning IAM principal.
string
The ID of the owning user.
string
The ID of the owning group.
string
Specifies the way of sorting the results of this action.
string
Specifies the sort order of this action.
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.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'environmentId': 'string',
'subscriptionTargetId': 'string',
'grantedEntity': {
'listing': {
'id': 'string',
'revision': 'string'
}
},
'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE',
'assets': [
{
'assetId': 'string',
'assetRevision': 'string',
'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED',
'targetName': 'string',
'failureCause': {
'message': 'string'
},
'grantedTimestamp': datetime(2015, 1, 1),
'failureTimestamp': datetime(2015, 1, 1),
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
],
'subscriptionId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListSubscriptionGrants action.
(dict) --
The details of the subscription grant.
id (string) --
The identifier of the subscription grant.
createdBy (string) --
The datazone user who created the subscription grant.
updatedBy (string) --
The Amazon DataZone user who updated the subscription grant.
domainId (string) --
The identifier of the Amazon DataZone domain in which a subscription grant exists.
createdAt (datetime) --
The timestamp of when a subscription grant was created.
updatedAt (datetime) --
The timestamp of when the subscription grant was updated.
environmentId (string) --
The environment ID of the subscription grant.
subscriptionTargetId (string) --
The identifier of the target of the subscription grant.
grantedEntity (dict) --
The entity to which the subscription is granted.
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.
status (string) --
The status 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.
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.
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.
grantedTimestamp (datetime) --
The timestamp of when the subscription grant to the asset is created.
failureTimestamp (datetime) --
The failure timestamp included in the details of the asset for which the subscription grant is created.
assetScope (dict) --
The asset scope of the subscribed asset.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
subscriptionId (string) --
The ID of the subscription.
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.
{'owningIamPrincipalArn': 'string'}
Response {'items': {'subscribedPrincipals': {'iam': {'principalArn': 'string'}}}}
Lists Amazon DataZone subscription requests.
See also: AWS API Documentation
Request Syntax
client.list_subscription_requests(
domainIdentifier='string',
status='PENDING'|'ACCEPTED'|'REJECTED',
subscribedListingId='string',
owningProjectId='string',
owningIamPrincipalArn='string',
approverProjectId='string',
owningUserId='string',
owningGroupId='string',
sortBy='CREATED_AT'|'UPDATED_AT',
sortOrder='ASCENDING'|'DESCENDING',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
Specifies the status of the subscription requests.
string
The identifier of the subscribed listing.
string
The identifier of the project for the subscription requests.
string
The ARN of the owning IAM principal.
string
The identifier of the subscription request approver's project.
string
The ID of the owning user.
string
The ID of the owning group.
string
Specifies the way to sort the results of this action.
string
Specifies the sort order for the results of this action.
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.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'requestReason': 'string',
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
],
'subscribedListings': [
{
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
],
'reviewerId': 'string',
'decisionComment': 'string',
'existingSubscriptionId': 'string',
'metadataFormsSummary': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string'
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListSubscriptionRequests action.
(dict) --
The details of the subscription request.
id (string) --
The identifier of the subscription request.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
updatedBy (string) --
The identifier of the Amazon DataZone user who updated the subscription request.
domainId (string) --
The identifier of the Amazon DataZone domain in which a subscription request exists.
status (string) --
The status of the subscription request.
createdAt (datetime) --
The timestamp of when a subscription request was created.
updatedAt (datetime) --
The timestamp of when the subscription request was updated.
requestReason (string) --
The reason for the subscription request.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListings (list) --
The listings included in the subscription request.
(dict) --
The details 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.
revision (string) --
The revision of the published asset for which the subscription grant is created.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
reviewerId (string) --
The identifier of the subscription request reviewer.
decisionComment (string) --
The decision comment of the subscription request.
existingSubscriptionId (string) --
The ID of the existing subscription.
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.
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.
{'items': {'subscriptionGrantCreationMode': 'AUTOMATIC | MANUAL'}}
Lists subscription targets in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.list_subscription_targets(
domainIdentifier='string',
environmentIdentifier='string',
sortBy='CREATED_AT'|'UPDATED_AT',
sortOrder='ASCENDING'|'DESCENDING',
maxResults=123,
nextToken='string'
)
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.
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.
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.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'authorizedPrincipals': [
'string',
],
'domainId': 'string',
'projectId': 'string',
'environmentId': 'string',
'name': 'string',
'type': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'manageAccessRole': 'string',
'applicableAssetTypes': [
'string',
],
'subscriptionTargetConfig': [
{
'formName': 'string',
'content': 'string'
},
],
'provider': 'string',
'subscriptionGrantCreationMode': 'AUTOMATIC'|'MANUAL'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListSubscriptionTargets action.
(dict) --
The details of the subscription target.
id (string) --
The identifier of the subscription target.
authorizedPrincipals (list) --
The authorized principals included in the subscription target.
(string) --
domainId (string) --
The identifier of the Amazon DataZone domain in which the subscription target exists.
projectId (string) --
The identifier of the project specified in the subscription target.
environmentId (string) --
The identifier of the environment of the subscription target.
name (string) --
The name of the subscription target.
type (string) --
The type of the subscription target.
createdBy (string) --
The Amazon DataZone user who created the subscription target.
updatedBy (string) --
The Amazon DataZone user who updated the subscription target.
createdAt (datetime) --
The timestamp of when the subscription target was created.
updatedAt (datetime) --
The timestamp of when the subscription target was updated.
manageAccessRole (string) --
The manage access role specified in the subscription target.
applicableAssetTypes (list) --
The asset types included in the subscription target.
(string) --
subscriptionTargetConfig (list) --
The configuration of the subscription target.
(dict) --
The details of the subscription target configuration.
formName (string) --
The form name included in the subscription target configuration.
content (string) --
The content of the subscription target configuration.
provider (string) --
The provider of the subscription target.
subscriptionGrantCreationMode (string) --
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
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.
{'owningIamPrincipalArn': 'string'}
Response {'items': {'subscribedPrincipal': {'iam': {'principalArn': 'string'}}}}
Lists subscriptions in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.list_subscriptions(
domainIdentifier='string',
subscriptionRequestIdentifier='string',
status='APPROVED'|'REVOKED'|'CANCELLED',
subscribedListingId='string',
owningProjectId='string',
owningIamPrincipalArn='string',
owningUserId='string',
owningGroupId='string',
approverProjectId='string',
sortBy='CREATED_AT'|'UPDATED_AT',
sortOrder='ASCENDING'|'DESCENDING',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the subscription request for the subscriptions that you want to list.
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 owning project.
string
The ARN of the owning IAM principal.
string
The ID of the owning user.
string
The ID of the owning group.
string
The identifier of the project for the subscription's approver.
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.
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.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'APPROVED'|'REVOKED'|'CANCELLED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'subscribedPrincipal': {
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
'subscribedListing': {
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
'subscriptionRequestId': 'string',
'retainPermissions': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListSubscriptions action.
(dict) --
The details of the subscription.
id (string) --
The identifier of the subscription.
createdBy (string) --
The Amazon DataZone user who created the subscription.
updatedBy (string) --
The Amazon DataZone user who updated the subscription.
domainId (string) --
The identifier of the Amazon DataZone domain in which a subscription exists.
status (string) --
The status of the subscription.
createdAt (datetime) --
The timestamp of when the subscription was created.
updatedAt (datetime) --
The timestamp of when the subscription was updated.
subscribedPrincipal (dict) --
The principal included in the subscription.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListing (dict) --
The listing included in the subscription.
id (string) --
The identifier of 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.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
subscriptionRequestId (string) --
The identifier of the subscription request for the subscription.
retainPermissions (boolean) --
The retain permissions included in 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.
{'subscribedPrincipals': {'iam': {'principalArn': 'string'}}}
Rejects the specified subscription request.
See also: AWS API Documentation
Request Syntax
client.reject_subscription_request(
domainIdentifier='string',
identifier='string',
decisionComment='string'
)
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.
string
The decision comment of the rejected subscription request.
dict
Response Syntax
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'requestReason': 'string',
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
],
'subscribedListings': [
{
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
],
'reviewerId': 'string',
'decisionComment': 'string',
'existingSubscriptionId': 'string',
'metadataForms': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string',
'content': 'string'
},
]
}
Response Structure
(dict) --
id (string) --
The identifier of the subscription request that was rejected.
createdBy (string) --
The timestamp of when the subscription request was rejected.
updatedBy (string) --
The Amazon DataZone user who updated the subscription request.
domainId (string) --
The identifier of the Amazon DataZone domain in which the subscription request was rejected.
status (string) --
The status of the subscription request.
createdAt (datetime) --
The timestamp of when the subscription request was rejected.
updatedAt (datetime) --
The timestamp of when the subscription request was updated.
requestReason (string) --
The reason for the subscription request.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListings (list) --
The subscribed listings of the subscription request.
(dict) --
The details 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.
revision (string) --
The revision of the published asset for which the subscription grant is created.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
reviewerId (string) --
The identifier of the subscription request reviewer.
decisionComment (string) --
The decision comment of the rejected subscription request.
existingSubscriptionId (string) --
The ID of the existing subscription.
metadataForms (list) --
Metadata forms included in the subscription request.
(dict) --
The details of a 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.
content (string) --
The content of the metadata form.
{'subscribedPrincipal': {'iam': {'principalArn': 'string'}}}
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
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'APPROVED'|'REVOKED'|'CANCELLED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'subscribedPrincipal': {
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
'subscribedListing': {
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
'subscriptionRequestId': 'string',
'retainPermissions': True|False
}
Response Structure
(dict) --
id (string) --
The identifier of the revoked subscription.
createdBy (string) --
The identifier of the user who revoked the subscription.
updatedBy (string) --
The Amazon DataZone user who revoked the subscription.
domainId (string) --
The identifier of the Amazon DataZone domain where you want to revoke a subscription.
status (string) --
The status of the revoked subscription.
createdAt (datetime) --
The timestamp of when the subscription was revoked.
updatedAt (datetime) --
The timestamp of when the subscription was revoked.
subscribedPrincipal (dict) --
The subscribed principal of the revoked subscription.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListing (dict) --
The subscribed listing of the revoked subscription.
id (string) --
The identifier of 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.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
subscriptionRequestId (string) --
The identifier of the subscription request for the revoked subscription.
retainPermissions (boolean) --
Specifies whether permissions are retained when the subscription is revoked.
{'subscribedPrincipals': {'iam': {'principalArn': '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
{
'id': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'domainId': 'string',
'status': 'PENDING'|'ACCEPTED'|'REJECTED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'requestReason': 'string',
'subscribedPrincipals': [
{
'project': {
'id': 'string',
'name': 'string'
},
'user': {
'id': 'string',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
'group': {
'id': 'string',
'name': 'string'
},
'iam': {
'principalArn': 'string'
}
},
],
'subscribedListings': [
{
'id': 'string',
'revision': 'string',
'name': 'string',
'description': 'string',
'item': {
'assetListing': {
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string',
'forms': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'assetScope': {
'assetId': 'string',
'filterIds': [
'string',
],
'status': 'string',
'errorMessage': 'string'
},
'permissions': {
's3': [
'READ'|'WRITE',
]
}
},
'productListing': {
'entityId': 'string',
'entityRevision': 'string',
'glossaryTerms': [
{
'name': 'string',
'shortDescription': 'string'
},
],
'name': 'string',
'description': 'string',
'assetListings': [
{
'entityId': 'string',
'entityRevision': 'string',
'entityType': 'string'
},
]
}
},
'ownerProjectId': 'string',
'ownerProjectName': 'string'
},
],
'reviewerId': 'string',
'decisionComment': 'string',
'existingSubscriptionId': 'string',
'metadataForms': [
{
'formName': 'string',
'typeName': 'string',
'typeRevision': 'string',
'content': 'string'
},
]
}
Response Structure
(dict) --
id (string) --
The identifier of the subscription request that is to be updated.
createdBy (string) --
The Amazon DataZone user who created the subscription request.
updatedBy (string) --
The Amazon DataZone user who updated the subscription request.
domainId (string) --
The identifier of the Amazon DataZone domain in which a subscription request is to be updated.
status (string) --
The status of the subscription request.
createdAt (datetime) --
The timestamp of when the subscription request was created.
updatedAt (datetime) --
The timestamp of when the subscription request was updated.
requestReason (string) --
The reason for the UpdateSubscriptionRequest action.
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.
user (dict) --
The subscribed user.
id (string) --
The ID of the subscribed user.
details (dict) --
The subscribed user details.
iam (dict) --
The IAM details of the user profile.
arn (string) --
The ARN of the IAM user.
principalId (string) --
The principal ID as part of the IAM user profile details.
sso (dict) --
The SSO details of the user profile.
username (string) --
The username as part of the SSO user profile detail.
firstName (string) --
The first name as part of the SSO user profile detail.
lastName (string) --
The last name as part of the SSO user profile detail.
group (dict) --
The subscribed group.
id (string) --
The ID of the subscribed group.
name (string) --
The name of the subscribed group.
iam (dict) --
The subscribed IAM principal.
principalArn (string) --
The ARN of the subscribed IAM principal.
subscribedListings (list) --
The subscribed listings of the subscription request.
(dict) --
The details 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.
revision (string) --
The revision of the published asset for which the subscription grant is created.
name (string) --
The name 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.
item (dict) --
The published asset for which the subscription grant is created.
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.
assetScope (dict) --
The asset scope of the subscribed asset listing.
assetId (string) --
The asset ID of the asset scope.
filterIds (list) --
The filter IDs of the asset scope.
(string) --
status (string) --
The status of the asset scope.
errorMessage (string) --
The error message of the asset scope.
permissions (dict) --
The asset permissions.
s3 (list) --
The S3 details of the asset permissions.
(string) --
productListing (dict) --
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.
description (string) --
The description of 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.
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.
reviewerId (string) --
The identifier of the Amazon DataZone user who reviews the subscription request.
decisionComment (string) --
The decision comment of the UpdateSubscriptionRequest action.
existingSubscriptionId (string) --
The ID of the existing subscription.
metadataForms (list) --
Metadata forms included in the subscription request.
(dict) --
The details of a 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.
content (string) --
The content of the metadata form.
{'subscriptionGrantCreationMode': 'AUTOMATIC | MANUAL'}
Updates the specified subscription target in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_subscription_target(
domainIdentifier='string',
environmentIdentifier='string',
identifier='string',
name='string',
authorizedPrincipals=[
'string',
],
applicableAssetTypes=[
'string',
],
subscriptionTargetConfig=[
{
'formName': 'string',
'content': 'string'
},
],
manageAccessRole='string',
provider='string',
subscriptionGrantCreationMode='AUTOMATIC'|'MANUAL'
)
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 name to be updated as part of the UpdateSubscriptionTarget action.
list
The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
(string) --
list
The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
(string) --
list
The configuration to be updated as part of the UpdateSubscriptionTarget action.
(dict) --
The details of the subscription target configuration.
formName (string) -- [REQUIRED]
The form name included in the subscription target configuration.
content (string) -- [REQUIRED]
The content of the subscription target configuration.
string
The manage access role to be updated as part of the UpdateSubscriptionTarget action.
string
The provider to be updated as part of the UpdateSubscriptionTarget action.
string
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
dict
Response Syntax
{
'id': 'string',
'authorizedPrincipals': [
'string',
],
'domainId': 'string',
'projectId': 'string',
'environmentId': 'string',
'name': 'string',
'type': 'string',
'createdBy': 'string',
'updatedBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'manageAccessRole': 'string',
'applicableAssetTypes': [
'string',
],
'subscriptionTargetConfig': [
{
'formName': 'string',
'content': 'string'
},
],
'provider': 'string',
'subscriptionGrantCreationMode': 'AUTOMATIC'|'MANUAL'
}
Response Structure
(dict) --
id (string) --
Identifier of the subscription target that is to be updated.
authorizedPrincipals (list) --
The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.
(string) --
domainId (string) --
The identifier of the Amazon DataZone domain in which a subscription target is to be updated.
projectId (string) --
The identifier of the project 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.
name (string) --
The name to be updated as part of the UpdateSubscriptionTarget action.
type (string) --
The type to be updated as part of the UpdateSubscriptionTarget action.
createdBy (string) --
The Amazon DataZone user who created the subscription target.
updatedBy (string) --
The Amazon DataZone user who updated the subscription target.
createdAt (datetime) --
The timestamp of when a subscription target was created.
updatedAt (datetime) --
The timestamp of when the subscription target was updated.
manageAccessRole (string) --
The manage access role to be updated as part of the UpdateSubscriptionTarget action.
applicableAssetTypes (list) --
The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
(string) --
subscriptionTargetConfig (list) --
The configuration to be updated as part of the UpdateSubscriptionTarget action.
(dict) --
The details of the subscription target configuration.
formName (string) --
The form name included in the subscription target configuration.
content (string) --
The content of the subscription target configuration.
provider (string) --
The provider to be updated as part of the UpdateSubscriptionTarget action.
subscriptionGrantCreationMode (string) --
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.