2026/04/16 - Amazon DataZone - 22 updated api methods
Changes Launching SMUS IAM domain SDK support
{'subscribedPrincipals': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
{'rolePrincipalArn': 'string'}
Response {'rolePrincipalArn': 'string', 'rolePrincipalId': 'string'}
Creates a group profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_group_profile(
domainIdentifier='string',
groupIdentifier='string',
rolePrincipalArn='string',
clientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the group profile is created.
string
The identifier of the group for which the group profile is created.
string
The ARN of the IAM role that will be associated with the group profile. This role defines the permissions that group members will assume when accessing Amazon DataZone resources.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'status': 'ASSIGNED'|'NOT_ASSIGNED',
'groupName': 'string',
'rolePrincipalArn': 'string',
'rolePrincipalId': 'string'
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which the group profile is created.
id (string) --
The identifier of the group profile.
status (string) --
The status of the group profile.
groupName (string) --
The name of the group for which group profile is created.
rolePrincipalArn (string) --
The ARN of the IAM role principal. This role is associated with the group profile.
rolePrincipalId (string) --
The unique identifier of the IAM role principal. This principal is associated with the group profile.
{'membershipAssignments': [{'designation': 'PROJECT_OWNER | '
'PROJECT_CONTRIBUTOR | '
'PROJECT_CATALOG_VIEWER | '
'PROJECT_CATALOG_CONSUMER | '
'PROJECT_CATALOG_STEWARD',
'member': {'groupIdentifier': 'string',
'userIdentifier': 'string'}}],
'projectCategory': 'string',
'projectExecutionRole': 'string'}
Response {'projectCategory': 'string'}
Creates an Amazon DataZone project.
See also: AWS API Documentation
Request Syntax
client.create_project(
domainIdentifier='string',
name='string',
description='string',
resourceTags={
'string': 'string'
},
glossaryTerms=[
'string',
],
domainUnitId='string',
projectProfileId='string',
userParameters=[
{
'environmentId': 'string',
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
},
'environmentConfigurationName': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
]
},
],
projectCategory='string',
projectExecutionRole='string',
membershipAssignments=[
{
'member': {
'userIdentifier': 'string',
'groupIdentifier': 'string'
},
'designation': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD'
},
]
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this project is created.
string
[REQUIRED]
The name of the Amazon DataZone project.
string
The description of the Amazon DataZone project.
dict
The resource tags of the project.
(string) --
(string) --
list
The glossary terms that can be used in this Amazon DataZone project.
(string) --
string
The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.
string
The ID of the project profile.
list
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentId (string) --
The ID of the environment.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) -- [REQUIRED]
The ID of the resolved account.
regionName (string) -- [REQUIRED]
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
environmentConfigurationName (string) --
The environment configuration name.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
string
The category of the project. Set to 'ADMIN' designates this as an administrative project for the Amazon DataZone domain.
string
The default project IAM role that is used to access project resources and run computes such as Glue and Sagemaker.
list
The members to be assigned to the project.
(dict) --
A map of user or group profiles to designations that need to be assigned in the project.
member (dict) -- [REQUIRED]
The details about a project member.
userIdentifier (string) --
The user ID of a project member.
groupIdentifier (string) --
The ID of the group of a project member.
designation (string) -- [REQUIRED]
The designation of the project membership.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'resourceTags': [
{
'key': 'string',
'value': 'string',
'source': 'PROJECT'|'PROJECT_PROFILE'
},
],
'glossaryTerms': [
'string',
],
'domainUnitId': 'string',
'projectProfileId': 'string',
'userParameters': [
{
'environmentId': 'string',
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
},
'environmentConfigurationName': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'environmentDeploymentDetails': {
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT',
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
}
},
'projectCategory': 'string'
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which the project was created.
id (string) --
The ID of the Amazon DataZone project.
name (string) --
The name of the project.
description (string) --
The description of the project.
projectStatus (string) --
The status of the Amazon DataZone project that was created.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
createdBy (string) --
The Amazon DataZone user who created the project.
createdAt (datetime) --
The timestamp of when the project was created.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
resourceTags (list) --
The resource tags of the project.
(dict) --
The resource tag of the project.
key (string) --
The key of the resource tag of the project.
value (string) --
The value of the resource tag of the project.
source (string) --
The source of the resource tag of the project.
glossaryTerms (list) --
The glossary terms that can be used in the project.
(string) --
domainUnitId (string) --
The ID of the domain unit.
projectProfileId (string) --
The project profile ID.
userParameters (list) --
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentId (string) --
The ID of the environment.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) --
The ID of the resolved account.
regionName (string) --
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
environmentConfigurationName (string) --
The environment configuration name.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentDeploymentDetails (dict) --
The environment deployment details.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) --
The error message for the failure reason for the environment deployment.
projectCategory (string) --
The category of the project.
{'subscribedPrincipals': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
{'sessionName': 'string', 'userType': {'IAM_ROLE_SESSION'}}
Response {'details': {'iam': {'groupProfileId': 'string', 'sessionName': 'string'}}}
Creates a user profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_user_profile(
domainIdentifier='string',
userIdentifier='string',
userType='IAM_USER'|'IAM_ROLE'|'SSO_USER'|'IAM_ROLE_SESSION',
sessionName='string',
clientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a user profile is created.
string
[REQUIRED]
The identifier of the user for which the user profile is created.
string
The user type of the user for which the user profile is created.
string
The session name for IAM role sessions.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'type': 'IAM'|'SSO',
'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string',
'sessionName': 'string',
'groupProfileId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which a user profile is created.
id (string) --
The identifier of the user profile.
type (string) --
The type of the user profile.
status (string) --
The status of the user profile.
details (dict) --
The user profile 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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
{'rolePrincipalArn': 'string', 'rolePrincipalId': 'string'}
Gets a group profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_group_profile(
domainIdentifier='string',
groupIdentifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the group profile exists.
string
[REQUIRED]
The identifier of the group profile.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'status': 'ASSIGNED'|'NOT_ASSIGNED',
'groupName': 'string',
'rolePrincipalArn': 'string',
'rolePrincipalId': 'string'
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which the group profile exists.
id (string) --
The identifier of the group profile.
status (string) --
The identifier of the group profile.
groupName (string) --
The name of the group for which the specified group profile exists.
rolePrincipalArn (string) --
The ARN of the IAM role principal. This role is associated with the group profile.
rolePrincipalId (string) --
The unique identifier of the IAM role principal. This principal is associated with the group profile.
{'projectCategory': 'string'}
Gets a project in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_project(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which the project exists.
string
[REQUIRED]
The ID of the project.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'resourceTags': [
{
'key': 'string',
'value': 'string',
'source': 'PROJECT'|'PROJECT_PROFILE'
},
],
'glossaryTerms': [
'string',
],
'domainUnitId': 'string',
'projectProfileId': 'string',
'userParameters': [
{
'environmentId': 'string',
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
},
'environmentConfigurationName': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'environmentDeploymentDetails': {
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT',
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
}
},
'projectCategory': 'string'
}
Response Structure
(dict) --
domainId (string) --
The ID of the Amazon DataZone domain in which the project exists.
id (string) --
>The ID of the project.
name (string) --
The name of the project.
description (string) --
The description of the project.
projectStatus (string) --
The status of the project.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
createdBy (string) --
The Amazon DataZone user who created the project.
createdAt (datetime) --
The timestamp of when the project was created.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
resourceTags (list) --
The resource tags of the project.
(dict) --
The resource tag of the project.
key (string) --
The key of the resource tag of the project.
value (string) --
The value of the resource tag of the project.
source (string) --
The source of the resource tag of the project.
glossaryTerms (list) --
The business glossary terms that can be used in the project.
(string) --
domainUnitId (string) --
The ID of the domain unit.
projectProfileId (string) --
The ID of the project profile of a project.
userParameters (list) --
The user parameters of a project.
(dict) --
The environment configuration user parameters.
environmentId (string) --
The ID of the environment.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) --
The ID of the resolved account.
regionName (string) --
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
environmentConfigurationName (string) --
The environment configuration name.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentDeploymentDetails (dict) --
The environment deployment status of a project.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) --
The error message for the failure reason for the environment deployment.
projectCategory (string) --
The category of the project.
{'subscribedPrincipal': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
{'sessionName': 'string'}
Response {'details': {'iam': {'groupProfileId': 'string', 'sessionName': 'string'}}}
Gets a user profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.get_user_profile(
domainIdentifier='string',
userIdentifier='string',
type='IAM'|'SSO',
sessionName='string'
)
string
[REQUIRED]
the ID of the Amazon DataZone domain the data portal of which you want to get.
string
[REQUIRED]
The identifier of the user for which you want to get the user profile.
string
The type of the user profile.
string
The session name for IAM role sessions.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'type': 'IAM'|'SSO',
'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string',
'sessionName': 'string',
'groupProfileId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
}
Response Structure
(dict) --
domainId (string) --
the identifier of the Amazon DataZone domain of which you want to get the user profile.
id (string) --
The identifier of the user profile.
type (string) --
The type of the user profile.
status (string) --
The status of the user profile.
details (dict) --
The user profile 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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
{'projectCategory': 'string'}
Response {'items': {'projectCategory': 'string'}}
Lists Amazon DataZone projects.
See also: AWS API Documentation
Request Syntax
client.list_projects(
domainIdentifier='string',
userIdentifier='string',
groupIdentifier='string',
name='string',
projectCategory='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain.
string
The identifier of the Amazon DataZone user.
string
The identifier of a group.
string
The name of the project.
string
A parameter to filter projects by their category.
string
When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.
integer
The maximum number of projects to return in a single call to ListProjects. When the number of projects to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjects to list the next set of projects.
dict
Response Syntax
{
'items': [
{
'domainId': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'domainUnitId': 'string',
'projectCategory': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the ListProjects action.
(dict) --
The details of a Amazon DataZone project.
domainId (string) --
The identifier of a Amazon DataZone domain where the project exists.
id (string) --
The identifier of a project.
name (string) --
The name of a project.
description (string) --
The description of a project.
projectStatus (string) --
The status of the project.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
createdBy (string) --
The Amazon DataZone user who created the project.
createdAt (datetime) --
The timestamp of when a project was created.
updatedAt (datetime) --
The timestamp of when the project was updated.
domainUnitId (string) --
The ID of the domain unit.
projectCategory (string) --
The category of the project.
nextToken (string) --
When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.
{'items': {'subscribedPrincipals': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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': {'subscribedPrincipal': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
{'groupType': {'IAM_ROLE_SESSION_GROUP'}}
Response {'items': {'rolePrincipalArn': 'string', 'rolePrincipalId': 'string'}}
Searches group profiles in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search_group_profiles(
domainIdentifier='string',
groupType='SSO_GROUP'|'DATAZONE_SSO_GROUP'|'IAM_ROLE_SESSION_GROUP',
searchText='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which you want to search group profiles.
string
[REQUIRED]
The group type for which to search.
string
Specifies the text for which to search.
integer
The maximum number of results to return in a single call to SearchGroupProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchGroupProfiles to list the next set of results.
string
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.
dict
Response Syntax
{
'items': [
{
'domainId': 'string',
'id': 'string',
'status': 'ASSIGNED'|'NOT_ASSIGNED',
'groupName': 'string',
'rolePrincipalArn': 'string',
'rolePrincipalId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the SearchGroupProfiles action.
(dict) --
The details of a group profile.
domainId (string) --
The ID of the Amazon DataZone domain of a group profile.
id (string) --
The ID of a group profile.
status (string) --
The status of a group profile.
groupName (string) --
The group name of a group profile.
rolePrincipalArn (string) --
The ARN of the IAM role principal. This role is associated with the group profile.
rolePrincipalId (string) --
The unique identifier of the IAM role principal. This principal is associated with the group profile.
nextToken (string) --
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.
{'items': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': 'string'}}}}
Searches user profiles in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.search_user_profiles(
domainIdentifier='string',
userType='SSO_USER'|'DATAZONE_USER'|'DATAZONE_SSO_USER'|'DATAZONE_IAM_USER',
searchText='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which you want to search user profiles.
string
[REQUIRED]
Specifies the user type for the SearchUserProfiles action.
string
Specifies the text for which to search.
integer
The maximum number of results to return in a single call to SearchUserProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchUserProfiles to list the next set of results.
string
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.
dict
Response Syntax
{
'items': [
{
'domainId': 'string',
'id': 'string',
'type': 'IAM'|'SSO',
'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string',
'sessionName': 'string',
'groupProfileId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
The results of the SearchUserProfiles action.
(dict) --
The details of the user profile.
domainId (string) --
The ID of the Amazon DataZone domain of the user profile.
id (string) --
The ID of the user profile.
type (string) --
The type of the user profile.
status (string) --
The status of the user profile.
details (dict) --
The details of the user profile.
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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
nextToken (string) --
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.
{'rolePrincipalArn': 'string', 'rolePrincipalId': 'string'}
Updates the specified group profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_group_profile(
domainIdentifier='string',
groupIdentifier='string',
status='ASSIGNED'|'NOT_ASSIGNED'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a group profile is updated.
string
[REQUIRED]
The identifier of the group profile that is updated.
string
[REQUIRED]
The status of the group profile that is updated.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'status': 'ASSIGNED'|'NOT_ASSIGNED',
'groupName': 'string',
'rolePrincipalArn': 'string',
'rolePrincipalId': 'string'
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which a group profile is updated.
id (string) --
The identifier of the group profile that is updated.
status (string) --
The status of the group profile that is updated.
groupName (string) --
The name of the group profile that is updated.
rolePrincipalArn (string) --
The ARN of the IAM role principal. This role is associated with the updated group profile.
rolePrincipalId (string) --
The unique identifier of the IAM role principal. This principal is associated with the updated group profile.
{'projectCategory': 'string'}
Updates the specified project in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_project(
domainIdentifier='string',
identifier='string',
name='string',
description='string',
resourceTags={
'string': 'string'
},
glossaryTerms=[
'string',
],
domainUnitId='string',
environmentDeploymentDetails={
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT',
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
}
},
userParameters=[
{
'environmentId': 'string',
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
},
'environmentConfigurationName': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
]
},
],
projectProfileVersion='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain where a project is being updated.
string
[REQUIRED]
The identifier of the project that is to be updated.
string
The name to be updated as part of the UpdateProject action.
string
The description to be updated as part of the UpdateProject action.
dict
The resource tags of the project.
(string) --
(string) --
list
The glossary terms to be updated as part of the UpdateProject action.
(string) --
string
The ID of the domain unit.
dict
The environment deployment details of the project.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) -- [REQUIRED]
The error message for the failure reason for the environment deployment.
list
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentId (string) --
The ID of the environment.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) -- [REQUIRED]
The ID of the resolved account.
regionName (string) -- [REQUIRED]
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
environmentConfigurationName (string) --
The environment configuration name.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
string
The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'resourceTags': [
{
'key': 'string',
'value': 'string',
'source': 'PROJECT'|'PROJECT_PROFILE'
},
],
'glossaryTerms': [
'string',
],
'domainUnitId': 'string',
'projectProfileId': 'string',
'userParameters': [
{
'environmentId': 'string',
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
},
'environmentConfigurationName': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'environmentDeploymentDetails': {
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT',
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
}
},
'projectCategory': 'string'
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which a project is updated.
id (string) --
The identifier of the project that is to be updated.
name (string) --
The name of the project that is to be updated.
description (string) --
The description of the project that is to be updated.
projectStatus (string) --
The status of the project.
failureReasons (list) --
Specifies the error message that is returned if the operation cannot be successfully completed.
(dict) --
Specifies the error message that is returned if the operation cannot be successfully completed.
code (string) --
The code of the project deletion error.
message (string) --
The message of the project deletion error.
createdBy (string) --
The Amazon DataZone user who created the project.
createdAt (datetime) --
The timestamp of when the project was created.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
resourceTags (list) --
The resource tags of the project.
(dict) --
The resource tag of the project.
key (string) --
The key of the resource tag of the project.
value (string) --
The value of the resource tag of the project.
source (string) --
The source of the resource tag of the project.
glossaryTerms (list) --
The glossary terms of the project that are to be updated.
(string) --
domainUnitId (string) --
The ID of the domain unit.
projectProfileId (string) --
The ID of the project profile.
userParameters (list) --
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentId (string) --
The ID of the environment.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) --
The ID of the resolved account.
regionName (string) --
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
environmentConfigurationName (string) --
The environment configuration name.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentDeploymentDetails (dict) --
The environment deployment details of the project.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) --
The error message for the failure reason for the environment deployment.
projectCategory (string) --
The category of the project.
{'subscribedPrincipals': {'user': {'details': {'iam': {'groupProfileId': 'string',
'sessionName': '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',
'sessionName': 'string',
'groupProfileId': '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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.
{'sessionName': 'string'}
Response {'details': {'iam': {'groupProfileId': 'string', 'sessionName': 'string'}}}
Updates the specified user profile in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.update_user_profile(
domainIdentifier='string',
userIdentifier='string',
type='IAM'|'SSO',
status='ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
sessionName='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which a user profile is updated.
string
[REQUIRED]
The identifier of the user whose user profile is to be updated.
string
The type of the user profile that are to be updated.
string
[REQUIRED]
The status of the user profile that are to be updated.
string
The session name for IAM role sessions.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'type': 'IAM'|'SSO',
'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
'details': {
'iam': {
'arn': 'string',
'principalId': 'string',
'sessionName': 'string',
'groupProfileId': 'string'
},
'sso': {
'username': 'string',
'firstName': 'string',
'lastName': 'string'
}
}
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which a user profile is updated.
id (string) --
The identifier of the user profile.
type (string) --
The type of the user profile.
status (string) --
The status of the user profile.
details (dict) --
The results of the UpdateUserProfile action.
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.
sessionName (string) --
The session name for IAM role sessions.
groupProfileId (string) --
The identifier of the group profile associated with the IAM user profile. This links the user to a specific group profile within the Amazon DataZone domain.
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.