# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AcceptPredictions](API_AcceptPredictions.md) 
+  [AcceptSubscriptionRequest](API_AcceptSubscriptionRequest.md) 
+  [AddEntityOwner](API_AddEntityOwner.md) 
+  [AddPolicyGrant](API_AddPolicyGrant.md) 
+  [AssociateEnvironmentRole](API_AssociateEnvironmentRole.md) 
+  [AssociateGovernedTerms](API_AssociateGovernedTerms.md) 
+  [BatchGetAttributesMetadata](API_BatchGetAttributesMetadata.md) 
+  [BatchPutAttributesMetadata](API_BatchPutAttributesMetadata.md) 
+  [CancelMetadataGenerationRun](API_CancelMetadataGenerationRun.md) 
+  [CancelSubscription](API_CancelSubscription.md) 
+  [CreateAccountPool](API_CreateAccountPool.md) 
+  [CreateAsset](API_CreateAsset.md) 
+  [CreateAssetFilter](API_CreateAssetFilter.md) 
+  [CreateAssetRevision](API_CreateAssetRevision.md) 
+  [CreateAssetType](API_CreateAssetType.md) 
+  [CreateConnection](API_CreateConnection.md) 
+  [CreateDataProduct](API_CreateDataProduct.md) 
+  [CreateDataProductRevision](API_CreateDataProductRevision.md) 
+  [CreateDataSource](API_CreateDataSource.md) 
+  [CreateDomain](API_CreateDomain.md) 
+  [CreateDomainUnit](API_CreateDomainUnit.md) 
+  [CreateEnvironment](API_CreateEnvironment.md) 
+  [CreateEnvironmentAction](API_CreateEnvironmentAction.md) 
+  [CreateEnvironmentBlueprint](API_CreateEnvironmentBlueprint.md) 
+  [CreateEnvironmentProfile](API_CreateEnvironmentProfile.md) 
+  [CreateFormType](API_CreateFormType.md) 
+  [CreateGlossary](API_CreateGlossary.md) 
+  [CreateGlossaryTerm](API_CreateGlossaryTerm.md) 
+  [CreateGroupProfile](API_CreateGroupProfile.md) 
+  [CreateListingChangeSet](API_CreateListingChangeSet.md) 
+  [CreateProject](API_CreateProject.md) 
+  [CreateProjectMembership](API_CreateProjectMembership.md) 
+  [CreateProjectProfile](API_CreateProjectProfile.md) 
+  [CreateRule](API_CreateRule.md) 
+  [CreateSubscriptionGrant](API_CreateSubscriptionGrant.md) 
+  [CreateSubscriptionRequest](API_CreateSubscriptionRequest.md) 
+  [CreateSubscriptionTarget](API_CreateSubscriptionTarget.md) 
+  [CreateUserProfile](API_CreateUserProfile.md) 
+  [DeleteAccountPool](API_DeleteAccountPool.md) 
+  [DeleteAsset](API_DeleteAsset.md) 
+  [DeleteAssetFilter](API_DeleteAssetFilter.md) 
+  [DeleteAssetType](API_DeleteAssetType.md) 
+  [DeleteConnection](API_DeleteConnection.md) 
+  [DeleteDataExportConfiguration](API_DeleteDataExportConfiguration.md) 
+  [DeleteDataProduct](API_DeleteDataProduct.md) 
+  [DeleteDataSource](API_DeleteDataSource.md) 
+  [DeleteDomain](API_DeleteDomain.md) 
+  [DeleteDomainUnit](API_DeleteDomainUnit.md) 
+  [DeleteEnvironment](API_DeleteEnvironment.md) 
+  [DeleteEnvironmentAction](API_DeleteEnvironmentAction.md) 
+  [DeleteEnvironmentBlueprint](API_DeleteEnvironmentBlueprint.md) 
+  [DeleteEnvironmentBlueprintConfiguration](API_DeleteEnvironmentBlueprintConfiguration.md) 
+  [DeleteEnvironmentProfile](API_DeleteEnvironmentProfile.md) 
+  [DeleteFormType](API_DeleteFormType.md) 
+  [DeleteGlossary](API_DeleteGlossary.md) 
+  [DeleteGlossaryTerm](API_DeleteGlossaryTerm.md) 
+  [DeleteListing](API_DeleteListing.md) 
+  [DeleteProject](API_DeleteProject.md) 
+  [DeleteProjectMembership](API_DeleteProjectMembership.md) 
+  [DeleteProjectProfile](API_DeleteProjectProfile.md) 
+  [DeleteRule](API_DeleteRule.md) 
+  [DeleteSubscriptionGrant](API_DeleteSubscriptionGrant.md) 
+  [DeleteSubscriptionRequest](API_DeleteSubscriptionRequest.md) 
+  [DeleteSubscriptionTarget](API_DeleteSubscriptionTarget.md) 
+  [DeleteTimeSeriesDataPoints](API_DeleteTimeSeriesDataPoints.md) 
+  [DisassociateEnvironmentRole](API_DisassociateEnvironmentRole.md) 
+  [DisassociateGovernedTerms](API_DisassociateGovernedTerms.md) 
+  [GetAccountPool](API_GetAccountPool.md) 
+  [GetAsset](API_GetAsset.md) 
+  [GetAssetFilter](API_GetAssetFilter.md) 
+  [GetAssetType](API_GetAssetType.md) 
+  [GetConnection](API_GetConnection.md) 
+  [GetDataExportConfiguration](API_GetDataExportConfiguration.md) 
+  [GetDataProduct](API_GetDataProduct.md) 
+  [GetDataSource](API_GetDataSource.md) 
+  [GetDataSourceRun](API_GetDataSourceRun.md) 
+  [GetDomain](API_GetDomain.md) 
+  [GetDomainUnit](API_GetDomainUnit.md) 
+  [GetEnvironment](API_GetEnvironment.md) 
+  [GetEnvironmentAction](API_GetEnvironmentAction.md) 
+  [GetEnvironmentBlueprint](API_GetEnvironmentBlueprint.md) 
+  [GetEnvironmentBlueprintConfiguration](API_GetEnvironmentBlueprintConfiguration.md) 
+  [GetEnvironmentCredentials](API_GetEnvironmentCredentials.md) 
+  [GetEnvironmentProfile](API_GetEnvironmentProfile.md) 
+  [GetFormType](API_GetFormType.md) 
+  [GetGlossary](API_GetGlossary.md) 
+  [GetGlossaryTerm](API_GetGlossaryTerm.md) 
+  [GetGroupProfile](API_GetGroupProfile.md) 
+  [GetIamPortalLoginUrl](API_GetIamPortalLoginUrl.md) 
+  [GetJobRun](API_GetJobRun.md) 
+  [GetLineageEvent](API_GetLineageEvent.md) 
+  [GetLineageNode](API_GetLineageNode.md) 
+  [GetListing](API_GetListing.md) 
+  [GetMetadataGenerationRun](API_GetMetadataGenerationRun.md) 
+  [GetProject](API_GetProject.md) 
+  [GetProjectProfile](API_GetProjectProfile.md) 
+  [GetRule](API_GetRule.md) 
+  [GetSubscription](API_GetSubscription.md) 
+  [GetSubscriptionGrant](API_GetSubscriptionGrant.md) 
+  [GetSubscriptionRequestDetails](API_GetSubscriptionRequestDetails.md) 
+  [GetSubscriptionTarget](API_GetSubscriptionTarget.md) 
+  [GetTimeSeriesDataPoint](API_GetTimeSeriesDataPoint.md) 
+  [GetUserProfile](API_GetUserProfile.md) 
+  [ListAccountPools](API_ListAccountPools.md) 
+  [ListAccountsInAccountPool](API_ListAccountsInAccountPool.md) 
+  [ListAssetFilters](API_ListAssetFilters.md) 
+  [ListAssetRevisions](API_ListAssetRevisions.md) 
+  [ListConnections](API_ListConnections.md) 
+  [ListDataProductRevisions](API_ListDataProductRevisions.md) 
+  [ListDataSourceRunActivities](API_ListDataSourceRunActivities.md) 
+  [ListDataSourceRuns](API_ListDataSourceRuns.md) 
+  [ListDataSources](API_ListDataSources.md) 
+  [ListDomains](API_ListDomains.md) 
+  [ListDomainUnitsForParent](API_ListDomainUnitsForParent.md) 
+  [ListEntityOwners](API_ListEntityOwners.md) 
+  [ListEnvironmentActions](API_ListEnvironmentActions.md) 
+  [ListEnvironmentBlueprintConfigurations](API_ListEnvironmentBlueprintConfigurations.md) 
+  [ListEnvironmentBlueprints](API_ListEnvironmentBlueprints.md) 
+  [ListEnvironmentProfiles](API_ListEnvironmentProfiles.md) 
+  [ListEnvironments](API_ListEnvironments.md) 
+  [ListJobRuns](API_ListJobRuns.md) 
+  [ListLineageEvents](API_ListLineageEvents.md) 
+  [ListLineageNodeHistory](API_ListLineageNodeHistory.md) 
+  [ListMetadataGenerationRuns](API_ListMetadataGenerationRuns.md) 
+  [ListNotifications](API_ListNotifications.md) 
+  [ListPolicyGrants](API_ListPolicyGrants.md) 
+  [ListProjectMemberships](API_ListProjectMemberships.md) 
+  [ListProjectProfiles](API_ListProjectProfiles.md) 
+  [ListProjects](API_ListProjects.md) 
+  [ListRules](API_ListRules.md) 
+  [ListSubscriptionGrants](API_ListSubscriptionGrants.md) 
+  [ListSubscriptionRequests](API_ListSubscriptionRequests.md) 
+  [ListSubscriptions](API_ListSubscriptions.md) 
+  [ListSubscriptionTargets](API_ListSubscriptionTargets.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTimeSeriesDataPoints](API_ListTimeSeriesDataPoints.md) 
+  [PostLineageEvent](API_PostLineageEvent.md) 
+  [PostTimeSeriesDataPoints](API_PostTimeSeriesDataPoints.md) 
+  [PutDataExportConfiguration](API_PutDataExportConfiguration.md) 
+  [PutEnvironmentBlueprintConfiguration](API_PutEnvironmentBlueprintConfiguration.md) 
+  [QueryGraph](API_QueryGraph.md) 
+  [RejectPredictions](API_RejectPredictions.md) 
+  [RejectSubscriptionRequest](API_RejectSubscriptionRequest.md) 
+  [RemoveEntityOwner](API_RemoveEntityOwner.md) 
+  [RemovePolicyGrant](API_RemovePolicyGrant.md) 
+  [RevokeSubscription](API_RevokeSubscription.md) 
+  [Search](API_Search.md) 
+  [SearchGroupProfiles](API_SearchGroupProfiles.md) 
+  [SearchListings](API_SearchListings.md) 
+  [SearchTypes](API_SearchTypes.md) 
+  [SearchUserProfiles](API_SearchUserProfiles.md) 
+  [StartDataSourceRun](API_StartDataSourceRun.md) 
+  [StartMetadataGenerationRun](API_StartMetadataGenerationRun.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAccountPool](API_UpdateAccountPool.md) 
+  [UpdateAssetFilter](API_UpdateAssetFilter.md) 
+  [UpdateConnection](API_UpdateConnection.md) 
+  [UpdateDataSource](API_UpdateDataSource.md) 
+  [UpdateDomain](API_UpdateDomain.md) 
+  [UpdateDomainUnit](API_UpdateDomainUnit.md) 
+  [UpdateEnvironment](API_UpdateEnvironment.md) 
+  [UpdateEnvironmentAction](API_UpdateEnvironmentAction.md) 
+  [UpdateEnvironmentBlueprint](API_UpdateEnvironmentBlueprint.md) 
+  [UpdateEnvironmentProfile](API_UpdateEnvironmentProfile.md) 
+  [UpdateGlossary](API_UpdateGlossary.md) 
+  [UpdateGlossaryTerm](API_UpdateGlossaryTerm.md) 
+  [UpdateGroupProfile](API_UpdateGroupProfile.md) 
+  [UpdateProject](API_UpdateProject.md) 
+  [UpdateProjectProfile](API_UpdateProjectProfile.md) 
+  [UpdateRootDomainUnitOwner](API_UpdateRootDomainUnitOwner.md) 
+  [UpdateRule](API_UpdateRule.md) 
+  [UpdateSubscriptionGrantStatus](API_UpdateSubscriptionGrantStatus.md) 
+  [UpdateSubscriptionRequest](API_UpdateSubscriptionRequest.md) 
+  [UpdateSubscriptionTarget](API_UpdateSubscriptionTarget.md) 
+  [UpdateUserProfile](API_UpdateUserProfile.md) 

# AcceptPredictions
<a name="API_AcceptPredictions"></a>

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

## Request Syntax
<a name="API_AcceptPredictions_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/assets/identifier/accept-predictions?revision=revision HTTP/1.1
Content-type: application/json

{
   "acceptChoices": [ 
      { 
         "editedValue": "string",
         "predictionChoice": number,
         "predictionTarget": "string"
      }
   ],
   "acceptRule": { 
      "rule": "string",
      "threshold": number
   },
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_AcceptPredictions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_AcceptPredictions_RequestSyntax) **   <a name="datazone-AcceptPredictions-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_AcceptPredictions_RequestSyntax) **   <a name="datazone-AcceptPredictions-request-uri-identifier"></a>
The identifier of the asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [revision](#API_AcceptPredictions_RequestSyntax) **   <a name="datazone-AcceptPredictions-request-uri-revision"></a>
The revision that is to be made to the asset.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_AcceptPredictions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [acceptChoices](#API_AcceptPredictions_RequestSyntax) **   <a name="datazone-AcceptPredictions-request-acceptChoices"></a>
Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.  
Type: Array of [AcceptChoice](API_AcceptChoice.md) objects  
Required: No

 ** [acceptRule](#API_AcceptPredictions_RequestSyntax) **   <a name="datazone-AcceptPredictions-request-acceptRule"></a>
Specifies the rule (or the conditions) under which a prediction can be accepted.  
Type: [AcceptRule](API_AcceptRule.md) object  
Required: No

 ** [clientToken](#API_AcceptPredictions_RequestSyntax) **   <a name="datazone-AcceptPredictions-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

## Response Syntax
<a name="API_AcceptPredictions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetId": "string",
   "domainId": "string",
   "revision": "string"
}
```

## Response Elements
<a name="API_AcceptPredictions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetId](#API_AcceptPredictions_ResponseSyntax) **   <a name="datazone-AcceptPredictions-response-assetId"></a>
The ID of the asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [domainId](#API_AcceptPredictions_ResponseSyntax) **   <a name="datazone-AcceptPredictions-response-domainId"></a>
The identifier of the Amazon DataZone domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_AcceptPredictions_ResponseSyntax) **   <a name="datazone-AcceptPredictions-response-revision"></a>
The revision that is to be made to the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_AcceptPredictions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AcceptPredictions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/AcceptPredictions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/AcceptPredictions) 

# AcceptSubscriptionRequest
<a name="API_AcceptSubscriptionRequest"></a>

Accepts a subscription request to a specific asset. 

## Request Syntax
<a name="API_AcceptSubscriptionRequest_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/subscription-requests/identifier/accept HTTP/1.1
Content-type: application/json

{
   "assetPermissions": [ 
      { 
         "assetId": "string",
         "permissions": { ... }
      }
   ],
   "assetScopes": [ 
      { 
         "assetId": "string",
         "filterIds": [ "string" ]
      }
   ],
   "decisionComment": "string"
}
```

## URI Request Parameters
<a name="API_AcceptSubscriptionRequest_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_AcceptSubscriptionRequest_RequestSyntax) **   <a name="datazone-AcceptSubscriptionRequest-request-uri-domainIdentifier"></a>
The Amazon DataZone domain where the specified subscription request is being accepted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_AcceptSubscriptionRequest_RequestSyntax) **   <a name="datazone-AcceptSubscriptionRequest-request-uri-identifier"></a>
The unique identifier of the subscription request that is to be accepted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_AcceptSubscriptionRequest_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetPermissions](#API_AcceptSubscriptionRequest_RequestSyntax) **   <a name="datazone-AcceptSubscriptionRequest-request-assetPermissions"></a>
The asset permissions of the accept subscription request.  
Type: Array of [AssetPermission](API_AssetPermission.md) objects  
Required: No

 ** [assetScopes](#API_AcceptSubscriptionRequest_RequestSyntax) **   <a name="datazone-AcceptSubscriptionRequest-request-assetScopes"></a>
The asset scopes of the accept subscription request.  
Type: Array of [AcceptedAssetScope](API_AcceptedAssetScope.md) objects  
Required: No

 ** [decisionComment](#API_AcceptSubscriptionRequest_RequestSyntax) **   <a name="datazone-AcceptSubscriptionRequest-request-decisionComment"></a>
A description that specifies the reason for accepting the specified subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## Response Syntax
<a name="API_AcceptSubscriptionRequest_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "decisionComment": "string",
   "domainId": "string",
   "existingSubscriptionId": "string",
   "id": "string",
   "metadataForms": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "requestReason": "string",
   "reviewerId": "string",
   "status": "string",
   "subscribedListings": [ 
      { 
         "description": "string",
         "id": "string",
         "item": { ... },
         "name": "string",
         "ownerProjectId": "string",
         "ownerProjectName": "string",
         "revision": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ],
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_AcceptSubscriptionRequest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-createdAt"></a>
The timestamp that specifies when the subscription request was accepted.  
Type: Timestamp

 ** [createdBy](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-createdBy"></a>
Specifies the Amazon DataZone user that accepted the specified subscription request.  
Type: String

 ** [decisionComment](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-decisionComment"></a>
Specifies the reason for accepting the subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-domainId"></a>
The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [existingSubscriptionId](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-existingSubscriptionId"></a>
The ID of the existing subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-id"></a>
The identifier of the subscription request.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [metadataForms](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-metadataForms"></a>
The metadata form in the subscription request.  
Type: Array of [FormOutput](API_FormOutput.md) objects

 ** [requestReason](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-requestReason"></a>
Specifies the reason for requesting a subscription to the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [reviewerId](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-reviewerId"></a>
Specifes the ID of the Amazon DataZone user who reviewed the subscription request.  
Type: String

 ** [status](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-status"></a>
Specifies the status of the subscription request.  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED` 

 ** [subscribedListings](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-subscribedListings"></a>
Specifies the asset for which the subscription request was created.  
Type: Array of [SubscribedListing](API_SubscribedListing.md) objects  
Array Members: Fixed number of 1 item.

 ** [subscribedPrincipals](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-subscribedPrincipals"></a>
Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request.  
Type: Array of [SubscribedPrincipal](API_SubscribedPrincipal.md) objects  
Array Members: Fixed number of 1 item.

 ** [updatedAt](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-updatedAt"></a>
Specifies the timestamp when subscription request was updated.  
Type: Timestamp

 ** [updatedBy](#API_AcceptSubscriptionRequest_ResponseSyntax) **   <a name="datazone-AcceptSubscriptionRequest-response-updatedBy"></a>
Specifies the Amazon DataZone user who updated the subscription request.  
Type: String

## Errors
<a name="API_AcceptSubscriptionRequest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AcceptSubscriptionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/AcceptSubscriptionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/AcceptSubscriptionRequest) 

# AddEntityOwner
<a name="API_AddEntityOwner"></a>

Adds the owner of an entity (a domain unit).

## Request Syntax
<a name="API_AddEntityOwner_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/addOwner HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "owner": { ... }
}
```

## URI Request Parameters
<a name="API_AddEntityOwner_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_AddEntityOwner_RequestSyntax) **   <a name="datazone-AddEntityOwner-request-uri-domainIdentifier"></a>
The ID of the domain in which you want to add the entity owner.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_AddEntityOwner_RequestSyntax) **   <a name="datazone-AddEntityOwner-request-uri-entityIdentifier"></a>
The ID of the entity to which you want to add an owner.  
Required: Yes

 ** [entityType](#API_AddEntityOwner_RequestSyntax) **   <a name="datazone-AddEntityOwner-request-uri-entityType"></a>
The type of an entity.  
Valid Values: `DOMAIN_UNIT`   
Required: Yes

## Request Body
<a name="API_AddEntityOwner_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_AddEntityOwner_RequestSyntax) **   <a name="datazone-AddEntityOwner-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [owner](#API_AddEntityOwner_RequestSyntax) **   <a name="datazone-AddEntityOwner-request-owner"></a>
The owner that you want to add to the entity.  
Type: [OwnerProperties](API_OwnerProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_AddEntityOwner_ResponseSyntax"></a>

```
HTTP/1.1 201
```

## Response Elements
<a name="API_AddEntityOwner_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response with an empty HTTP body.

## Errors
<a name="API_AddEntityOwner_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AddEntityOwner_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/AddEntityOwner) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/AddEntityOwner) 

# AddPolicyGrant
<a name="API_AddPolicyGrant"></a>

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

## Request Syntax
<a name="API_AddPolicyGrant_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/policies/managed/entityType/entityIdentifier/addGrant HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "detail": { ... },
   "policyType": "string",
   "principal": { ... }
}
```

## URI Request Parameters
<a name="API_AddPolicyGrant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_AddPolicyGrant_RequestSyntax) **   <a name="datazone-AddPolicyGrant-request-uri-domainIdentifier"></a>
The ID of the domain where you want to add a policy grant.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_AddPolicyGrant_RequestSyntax) **   <a name="datazone-AddPolicyGrant-request-uri-entityIdentifier"></a>
The ID of the entity (resource) to which you want to add a policy grant.  
Required: Yes

 ** [entityType](#API_AddPolicyGrant_RequestSyntax) **   <a name="datazone-AddPolicyGrant-request-uri-entityType"></a>
The type of entity (resource) to which the grant is added.  
Valid Values: `DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE | ASSET_TYPE`   
Required: Yes

## Request Body
<a name="API_AddPolicyGrant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_AddPolicyGrant_RequestSyntax) **   <a name="datazone-AddPolicyGrant-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [detail](#API_AddPolicyGrant_RequestSyntax) **   <a name="datazone-AddPolicyGrant-request-detail"></a>
The details of the policy grant.  
Type: [PolicyGrantDetail](API_PolicyGrantDetail.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [policyType](#API_AddPolicyGrant_RequestSyntax) **   <a name="datazone-AddPolicyGrant-request-policyType"></a>
The type of policy that you want to grant.  
Type: String  
Valid Values: `CREATE_DOMAIN_UNIT | OVERRIDE_DOMAIN_UNIT_OWNERS | ADD_TO_PROJECT_MEMBER_POOL | OVERRIDE_PROJECT_OWNERS | CREATE_GLOSSARY | CREATE_FORM_TYPE | CREATE_ASSET_TYPE | CREATE_PROJECT | CREATE_ENVIRONMENT_PROFILE | DELEGATE_CREATE_ENVIRONMENT_PROFILE | CREATE_ENVIRONMENT | CREATE_ENVIRONMENT_FROM_BLUEPRINT | CREATE_PROJECT_FROM_PROJECT_PROFILE | USE_ASSET_TYPE`   
Required: Yes

 ** [principal](#API_AddPolicyGrant_RequestSyntax) **   <a name="datazone-AddPolicyGrant-request-principal"></a>
The principal to whom the permissions are granted.  
Type: [PolicyGrantPrincipal](API_PolicyGrantPrincipal.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_AddPolicyGrant_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "grantId": "string"
}
```

## Response Elements
<a name="API_AddPolicyGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [grantId](#API_AddPolicyGrant_ResponseSyntax) **   <a name="datazone-AddPolicyGrant-response-grantId"></a>
The ID of the policy grant that was added to a specified entity.  
Type: String  
Pattern: `[A-Za-z0-9+/]{10}` 

## Errors
<a name="API_AddPolicyGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AddPolicyGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/AddPolicyGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/AddPolicyGrant) 

# AssociateEnvironmentRole
<a name="API_AssociateEnvironmentRole"></a>

Associates the environment role in Amazon DataZone.

## Request Syntax
<a name="API_AssociateEnvironmentRole_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/environments/environmentIdentifier/roles/environmentRoleArn HTTP/1.1
```

## URI Request Parameters
<a name="API_AssociateEnvironmentRole_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_AssociateEnvironmentRole_RequestSyntax) **   <a name="datazone-AssociateEnvironmentRole-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the environment role is associated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_AssociateEnvironmentRole_RequestSyntax) **   <a name="datazone-AssociateEnvironmentRole-request-uri-environmentIdentifier"></a>
The ID of the Amazon DataZone environment.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentRoleArn](#API_AssociateEnvironmentRole_RequestSyntax) **   <a name="datazone-AssociateEnvironmentRole-request-uri-environmentRoleArn"></a>
The ARN of the environment role.  
Required: Yes

## Request Body
<a name="API_AssociateEnvironmentRole_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_AssociateEnvironmentRole_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateEnvironmentRole_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateEnvironmentRole_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateEnvironmentRole_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/AssociateEnvironmentRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/AssociateEnvironmentRole) 

# AssociateGovernedTerms
<a name="API_AssociateGovernedTerms"></a>

Associates governed terms with an asset.

## Request Syntax
<a name="API_AssociateGovernedTerms_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/associate-governed-terms HTTP/1.1
Content-type: application/json

{
   "governedGlossaryTerms": [ "string" ]
}
```

## URI Request Parameters
<a name="API_AssociateGovernedTerms_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_AssociateGovernedTerms_RequestSyntax) **   <a name="datazone-AssociateGovernedTerms-request-uri-domainIdentifier"></a>
The ID of the domain where governed terms are to be associated with an asset.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_AssociateGovernedTerms_RequestSyntax) **   <a name="datazone-AssociateGovernedTerms-request-uri-entityIdentifier"></a>
The ID of the asset with which you want to associate a governed term.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityType](#API_AssociateGovernedTerms_RequestSyntax) **   <a name="datazone-AssociateGovernedTerms-request-uri-entityType"></a>
The type of the asset with which you want to associate a governed term.  
Valid Values: `ASSET`   
Required: Yes

## Request Body
<a name="API_AssociateGovernedTerms_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [governedGlossaryTerms](#API_AssociateGovernedTerms_RequestSyntax) **   <a name="datazone-AssociateGovernedTerms-request-governedGlossaryTerms"></a>
The glossary terms in a restricted glossary.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Response Syntax
<a name="API_AssociateGovernedTerms_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateGovernedTerms_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateGovernedTerms_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateGovernedTerms_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/AssociateGovernedTerms) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/AssociateGovernedTerms) 

# BatchGetAttributesMetadata
<a name="API_BatchGetAttributesMetadata"></a>

Gets the attribute metadata.

## Request Syntax
<a name="API_BatchGetAttributesMetadata_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/attributes-metadata?attributeIdentifier=attributeIdentifiers&entityRevision=entityRevision HTTP/1.1
```

## URI Request Parameters
<a name="API_BatchGetAttributesMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [attributeIdentifiers](#API_BatchGetAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchGetAttributesMetadata-request-uri-attributeIdentifiers"></a>
The attribute identifier.  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [domainIdentifier](#API_BatchGetAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchGetAttributesMetadata-request-uri-domainIdentifier"></a>
The domain ID where you want to get the attribute metadata.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_BatchGetAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchGetAttributesMetadata-request-uri-entityIdentifier"></a>
The entity ID for which you want to get attribute metadata.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityRevision](#API_BatchGetAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchGetAttributesMetadata-request-uri-entityRevision"></a>
The entity revision for which you want to get attribute metadata.  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [entityType](#API_BatchGetAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchGetAttributesMetadata-request-uri-entityType"></a>
The entity type for which you want to get attribute metadata.  
Valid Values: `ASSET | LISTING`   
Required: Yes

## Request Body
<a name="API_BatchGetAttributesMetadata_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_BatchGetAttributesMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attributes": [ 
      { 
         "attributeIdentifier": "string",
         "forms": [ 
            { 
               "content": "string",
               "formName": "string",
               "typeName": "string",
               "typeRevision": "string"
            }
         ]
      }
   ],
   "errors": [ 
      { 
         "attributeIdentifier": "string",
         "code": "string",
         "message": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchGetAttributesMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attributes](#API_BatchGetAttributesMetadata_ResponseSyntax) **   <a name="datazone-BatchGetAttributesMetadata-response-attributes"></a>
The results of the BatchGetAttributesMetadata action.  
Type: Array of [BatchGetAttributeOutput](API_BatchGetAttributeOutput.md) objects

 ** [errors](#API_BatchGetAttributesMetadata_ResponseSyntax) **   <a name="datazone-BatchGetAttributesMetadata-response-errors"></a>
The errors generated when the BatchGetAttributesMetadata action is invoked.  
Type: Array of [AttributeError](API_AttributeError.md) objects

## Errors
<a name="API_BatchGetAttributesMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_BatchGetAttributesMetadata_Examples"></a>

### Example
<a name="API_BatchGetAttributesMetadata_Example_1"></a>

This example illustrates how to get readme and metadata form for the attribute.

#### Sample Request
<a name="API_BatchGetAttributesMetadata_Example_1_Request"></a>

```
                   aws datazone batch-get-attributes-metadata \
                   --domain-identifier dzd-dn3htlki2g96xz \
                   --entity-identifier 4nzaanzjgwoisn \
                   --entity-type ASSET \
                   --attribute-identifiers "foodname" "attribute-id-2" \
                   --region us-east-1
```

#### Sample Response
<a name="API_BatchGetAttributesMetadata_Example_1_Response"></a>

```
                   {
      "attributes": [{
          "attributeIdentifier": "foodname",
          "forms": [{
                  "content": "{\"readMe\":\"readme testing\"}",
                  "formName": "AttributeCommonFormType",
                  "typeName": "AttributeCommonFormType",
                  "typeRevision": "2"
              },
              {
                  "content": "{\"testing_field\":\"name\"}",
                  "formName": "testing_form",
                  "typeName": "testing_form",
                  "typeRevision": "3"
              }
          ]
      }],
      "errors": [{
          "attributeIdentifier": "attribute-id-2",
          "code": "404",
          "message": "Attribute 'attribute-id-2' not found"
      }]
  }
```

## See Also
<a name="API_BatchGetAttributesMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/BatchGetAttributesMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/BatchGetAttributesMetadata) 

# BatchPutAttributesMetadata
<a name="API_BatchPutAttributesMetadata"></a>

Writes the attribute metadata.

## Request Syntax
<a name="API_BatchPutAttributesMetadata_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/attributes-metadata HTTP/1.1
Content-type: application/json

{
   "attributes": [ 
      { 
         "attributeIdentifier": "string",
         "forms": [ 
            { 
               "content": "string",
               "formName": "string",
               "typeIdentifier": "string",
               "typeRevision": "string"
            }
         ]
      }
   ],
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_BatchPutAttributesMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_BatchPutAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchPutAttributesMetadata-request-uri-domainIdentifier"></a>
The domain ID where you want to write the attribute metadata.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_BatchPutAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchPutAttributesMetadata-request-uri-entityIdentifier"></a>
The entity ID for which you want to write the attribute metadata.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityType](#API_BatchPutAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchPutAttributesMetadata-request-uri-entityType"></a>
The entity type for which you want to write the attribute metadata.  
Valid Values: `ASSET | LISTING`   
Required: Yes

## Request Body
<a name="API_BatchPutAttributesMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_BatchPutAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchPutAttributesMetadata-request-attributes"></a>
The attributes of the metadata.  
Type: Array of [AttributeInput](API_AttributeInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Required: Yes

 ** [clientToken](#API_BatchPutAttributesMetadata_RequestSyntax) **   <a name="datazone-BatchPutAttributesMetadata-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

## Response Syntax
<a name="API_BatchPutAttributesMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attributes": [ 
      { 
         "attributeIdentifier": "string"
      }
   ],
   "errors": [ 
      { 
         "attributeIdentifier": "string",
         "code": "string",
         "message": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchPutAttributesMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attributes](#API_BatchPutAttributesMetadata_ResponseSyntax) **   <a name="datazone-BatchPutAttributesMetadata-response-attributes"></a>
The results of the BatchPutAttributeMetadata action.  
Type: Array of [BatchPutAttributeOutput](API_BatchPutAttributeOutput.md) objects

 ** [errors](#API_BatchPutAttributesMetadata_ResponseSyntax) **   <a name="datazone-BatchPutAttributesMetadata-response-errors"></a>
The errors generated when the BatchPutAttributeMetadata action is invoked.  
Type: Array of [AttributeError](API_AttributeError.md) objects

## Errors
<a name="API_BatchPutAttributesMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_BatchPutAttributesMetadata_Examples"></a>

### Example
<a name="API_BatchPutAttributesMetadata_Example_1"></a>

This example illustrates how to update readme and metadata form for the attribute.

#### Sample Request
<a name="API_BatchPutAttributesMetadata_Example_1_Request"></a>

```
                     aws datazone batch-put-attributes-metadata \
                     --domain-identifier "dzd-dn3htlki2g96xz" \
                     --entity-identifier "4nzaanzjgwoisn" \
                     --entity-type "ASSET" \
                     --attributes '[
                        {
                           "attributeIdentifier": "foodname",
                           "forms": [
                           {
                              "formName": "AttributeCommonFormType",
                              "typeIdentifier": "amazon.datazone.AttributeCommonFormType",
                              "content": "{\"readMe\":\"readme testing\"}"
                           },
                           {
                              "formName": "testing_form",
                              "typeIdentifier": "testing_form",
                              "typeRevision": "3",
                              "content": "{\"testing_field\":\"name\"}"
                           }
                           ]
                        }
                     ]' \
                     --client-token "ahwgcuywagcuywgtuyqfctyfq" \
                     --region us-east-1
```

#### Sample Response
<a name="API_BatchPutAttributesMetadata_Example_1_Response"></a>

```
                   {
     "attributes": [{
         "attributeIdentifier": "foodname"
     }]
 }
```

## See Also
<a name="API_BatchPutAttributesMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/BatchPutAttributesMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/BatchPutAttributesMetadata) 

# CancelMetadataGenerationRun
<a name="API_CancelMetadataGenerationRun"></a>

Cancels the metadata generation run.

Prerequisites:
+ The run must exist and be in a cancelable status (e.g., SUBMITTED, IN\$1PROGRESS). 
+ Runs in SUCCEEDED status cannot be cancelled.
+ User must have access to the run and cancel permissions.

## Request Syntax
<a name="API_CancelMetadataGenerationRun_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/metadata-generation-runs/identifier/cancel HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelMetadataGenerationRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CancelMetadataGenerationRun_RequestSyntax) **   <a name="datazone-CancelMetadataGenerationRun-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_CancelMetadataGenerationRun_RequestSyntax) **   <a name="datazone-CancelMetadataGenerationRun-request-uri-identifier"></a>
The ID of the metadata generation run.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CancelMetadataGenerationRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelMetadataGenerationRun_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CancelMetadataGenerationRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CancelMetadataGenerationRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CancelMetadataGenerationRun_Examples"></a>

### Example
<a name="API_CancelMetadataGenerationRun_Example_1"></a>

This example illustrates one usage of CancelMetadataGenerationRun.

#### Sample Request
<a name="API_CancelMetadataGenerationRun_Example_1_Request"></a>

```
aws datazone cancel-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "mgr5g0fy285m1q"
```

### Example
<a name="API_CancelMetadataGenerationRun_Example_2"></a>

Failure case - validation error - succeeded cannot be cancelled:

#### Sample Request
<a name="API_CancelMetadataGenerationRun_Example_2_Request"></a>

```
aws datazone cancel-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "mgr3tlpxo4mg5q"
```

#### Sample Response
<a name="API_CancelMetadataGenerationRun_Example_2_Response"></a>

```
An error occurred (ValidationException) when calling the CancelMetadataGenerationRun operation: The MetadataGenerationRun in SUCCEEDED status cannot be canceled.
```

### Example
<a name="API_CancelMetadataGenerationRun_Example_3"></a>

Failure case - validation error - succeeded cannot be cancelled: 

#### Sample Request
<a name="API_CancelMetadataGenerationRun_Example_3_Request"></a>

```
aws datazone cancel-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "mgr_nonexistent"
```

#### Sample Response
<a name="API_CancelMetadataGenerationRun_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the CancelMetadataGenerationRun operation: Requested prediction cannot be found in domain
```

### Example
<a name="API_CancelMetadataGenerationRun_Example_4"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_CancelMetadataGenerationRun_Example_4_Request"></a>

```
aws datazone cancel-metadata-generation-run
```

#### Sample Response
<a name="API_CancelMetadataGenerationRun_Example_4_Response"></a>

```
aws: error: the following arguments are required: —domain-identifier, —identifier
```

## See Also
<a name="API_CancelMetadataGenerationRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CancelMetadataGenerationRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CancelMetadataGenerationRun) 

# CancelSubscription
<a name="API_CancelSubscription"></a>

Cancels the subscription to the specified asset.

## Request Syntax
<a name="API_CancelSubscription_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/subscriptions/identifier/cancel HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelSubscription_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CancelSubscription_RequestSyntax) **   <a name="datazone-CancelSubscription-request-uri-domainIdentifier"></a>
The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_CancelSubscription_RequestSyntax) **   <a name="datazone-CancelSubscription-request-uri-identifier"></a>
The unique identifier of the subscription that is being cancelled.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CancelSubscription_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelSubscription_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "id": "string",
   "retainPermissions": boolean,
   "status": "string",
   "subscribedListing": { 
      "description": "string",
      "id": "string",
      "item": { ... },
      "name": "string",
      "ownerProjectId": "string",
      "ownerProjectName": "string",
      "revision": "string"
   },
   "subscribedPrincipal": { ... },
   "subscriptionRequestId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_CancelSubscription_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-createdAt"></a>
The timestamp that specifies when the request to cancel the subscription was created.  
Type: Timestamp

 ** [createdBy](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-createdBy"></a>
Specifies the Amazon DataZone user who is cancelling the subscription.  
Type: String

 ** [domainId](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-domainId"></a>
The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-id"></a>
The identifier of the subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [retainPermissions](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-retainPermissions"></a>
Specifies whether the permissions to the asset are retained after the subscription is cancelled.  
Type: Boolean

 ** [status](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-status"></a>
The status of the request to cancel the subscription.  
Type: String  
Valid Values: `APPROVED | REVOKED | CANCELLED` 

 ** [subscribedListing](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-subscribedListing"></a>
The asset to which a subscription is being cancelled.  
Type: [SubscribedListing](API_SubscribedListing.md) object

 ** [subscribedPrincipal](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-subscribedPrincipal"></a>
The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.  
Type: [SubscribedPrincipal](API_SubscribedPrincipal.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [subscriptionRequestId](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-subscriptionRequestId"></a>
The unique ID of the subscripton request for the subscription that is being cancelled.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-updatedAt"></a>
The timestamp that specifies when the subscription was cancelled.  
Type: Timestamp

 ** [updatedBy](#API_CancelSubscription_ResponseSyntax) **   <a name="datazone-CancelSubscription-response-updatedBy"></a>
The Amazon DataZone user that cancelled the subscription.  
Type: String

## Errors
<a name="API_CancelSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CancelSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CancelSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CancelSubscription) 

# CreateAccountPool
<a name="API_CreateAccountPool"></a>

Creates an account pool. 

## Request Syntax
<a name="API_CreateAccountPool_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/account-pools HTTP/1.1
Content-type: application/json

{
   "accountSource": { ... },
   "description": "string",
   "name": "string",
   "resolutionStrategy": "string"
}
```

## URI Request Parameters
<a name="API_CreateAccountPool_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateAccountPool_RequestSyntax) **   <a name="datazone-CreateAccountPool-request-uri-domainIdentifier"></a>
The ID of the domain where the account pool is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateAccountPool_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [accountSource](#API_CreateAccountPool_RequestSyntax) **   <a name="datazone-CreateAccountPool-request-accountSource"></a>
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom AWS Lambda handler.   
Type: [AccountSource](API_AccountSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [description](#API_CreateAccountPool_RequestSyntax) **   <a name="datazone-CreateAccountPool-request-description"></a>
The description of the account pool.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [name](#API_CreateAccountPool_RequestSyntax) **   <a name="datazone-CreateAccountPool-request-name"></a>
The name of the account pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: Yes

 ** [resolutionStrategy](#API_CreateAccountPool_RequestSyntax) **   <a name="datazone-CreateAccountPool-request-resolutionStrategy"></a>
The mechanism used to resolve the account selection from the account pool.  
Type: String  
Valid Values: `MANUAL`   
Required: Yes

## Response Syntax
<a name="API_CreateAccountPool_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "accountSource": { ... },
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "resolutionStrategy": "string",
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_CreateAccountPool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [accountSource](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-accountSource"></a>
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom AWS Lambda handler.   
Type: [AccountSource](API_AccountSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdAt](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-createdAt"></a>
The timestamp at which the account pool was created.  
Type: Timestamp

 ** [createdBy](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-createdBy"></a>
The user who created the account pool.  
Type: String

 ** [description](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-description"></a>
The description of the account pool.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-domainId"></a>
The ID of the domain where the account pool is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-domainUnitId"></a>
The ID of the domain where the account pool is created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [id](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-id"></a>
The ID of the account pool.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-lastUpdatedAt"></a>
The timestamp at which the account pool was last updated.  
Type: Timestamp

 ** [name](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-name"></a>
The name of the account pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [resolutionStrategy](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-resolutionStrategy"></a>
The mechanism used to resolve the account selection from the account pool.  
Type: String  
Valid Values: `MANUAL` 

 ** [updatedBy](#API_CreateAccountPool_ResponseSyntax) **   <a name="datazone-CreateAccountPool-response-updatedBy"></a>
The user who last updated the account pool.  
Type: String

## Errors
<a name="API_CreateAccountPool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateAccountPool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateAccountPool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateAccountPool) 

# CreateAsset
<a name="API_CreateAsset"></a>

Creates an asset in Amazon DataZone catalog.

Before creating assets, make sure that the following requirements are met:
+  `--domain-identifier` must refer to an existing domain.
+  `--owning-project-identifier` must be a valid project within the domain.
+ Asset type must be created beforehand using `create-asset-type`, or be a supported system-defined type. For more information, see [create-asset-type](https://docs.aws.amazon.com/cli/latest/reference/datazone/create-asset-type.html).
+  `--type-revision` (if used) must match a valid revision of the asset type.
+  `formsInput` is required when it is associated as required in the `asset-type`. For more information, see [create-form-type](https://docs.aws.amazon.com/cli/latest/reference/datazone/create-form-type.html).
+ Form content must include all required fields as per the form schema (e.g., `bucketArn`).

You must invoke the following pre-requisite commands before invoking this API:
+  [CreateFormType](https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html) 
+  [CreateAssetType](https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateAssetType.html) 

## Request Syntax
<a name="API_CreateAsset_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/assets HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "externalIdentifier": "string",
   "formsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "name": "string",
   "owningProjectIdentifier": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "typeIdentifier": "string",
   "typeRevision": "string"
}
```

## URI Request Parameters
<a name="API_CreateAsset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-uri-domainIdentifier"></a>
Amazon DataZone domain where the asset is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateAsset_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-description"></a>
Asset description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [externalIdentifier](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-externalIdentifier"></a>
The external identifier of the asset.  
If the value for the `externalIdentifier` parameter is specified, it must be a unique value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 600.  
Required: No

 ** [formsInput](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-formsInput"></a>
Metadata forms attached to the asset.  
Type: Array of [FormInput](API_FormInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [glossaryTerms](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-glossaryTerms"></a>
Glossary terms attached to the asset.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [name](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-name"></a>
Asset name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [owningProjectIdentifier](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-owningProjectIdentifier"></a>
The unique identifier of the project that owns this asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [predictionConfiguration](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-predictionConfiguration"></a>
The configuration of the automatically generated business-friendly metadata for the asset.  
Type: [PredictionConfiguration](API_PredictionConfiguration.md) object  
Required: No

 ** [typeIdentifier](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-typeIdentifier"></a>
The unique identifier of this asset's type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 513.  
Pattern: `(?!\.)[\w\.]*\w`   
Required: Yes

 ** [typeRevision](#API_CreateAsset_RequestSyntax) **   <a name="datazone-CreateAsset-request-typeRevision"></a>
The revision of this asset's type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_CreateAsset_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "externalIdentifier": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "governedGlossaryTerms": [ "string" ],
   "id": "string",
   "latestTimeSeriesDataPointFormsOutput": [ 
      { 
         "contentSummary": "string",
         "formName": "string",
         "id": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "listing": { 
      "listingId": "string",
      "listingStatus": "string"
   },
   "name": "string",
   "owningProjectId": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "readOnlyFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "revision": "string",
   "typeIdentifier": "string",
   "typeRevision": "string"
}
```

## Response Elements
<a name="API_CreateAsset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-createdAt"></a>
The timestamp of when the asset was created.  
Type: Timestamp

 ** [createdBy](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-createdBy"></a>
The Amazon DataZone user that created this asset in the catalog.  
Type: String

 ** [description](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-description"></a>
The description of the created asset.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-domainId"></a>
The ID of the Amazon DataZone domain in which the asset was created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [externalIdentifier](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-externalIdentifier"></a>
The external identifier of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 600.

 ** [firstRevisionCreatedAt](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-firstRevisionCreatedAt"></a>
The timestamp of when the first revision of the asset took place.  
Type: Timestamp

 ** [firstRevisionCreatedBy](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-firstRevisionCreatedBy"></a>
The Amazon DataZone user that made the first revision of the asset.  
Type: String

 ** [formsOutput](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-formsOutput"></a>
The metadata forms that are attached to the created asset.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [glossaryTerms](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-glossaryTerms"></a>
The glossary terms that are attached to the created asset.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [governedGlossaryTerms](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-governedGlossaryTerms"></a>
The glossary terms in a restricted glossary.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-id"></a>
The unique identifier of the created asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [latestTimeSeriesDataPointFormsOutput](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-latestTimeSeriesDataPointFormsOutput"></a>
The latest data point that was imported into the time series form for the asset.   
Type: Array of [TimeSeriesDataPointSummaryFormOutput](API_TimeSeriesDataPointSummaryFormOutput.md) objects

 ** [listing](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-listing"></a>
The details of an asset published in an Amazon DataZone catalog.  
Type: [AssetListingDetails](API_AssetListingDetails.md) object

 ** [name](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-name"></a>
The name of the created asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [owningProjectId](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-owningProjectId"></a>
The ID of the Amazon DataZone project that owns the created asset.   
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [predictionConfiguration](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-predictionConfiguration"></a>
The configuration of the automatically generated business-friendly metadata for the asset.  
Type: [PredictionConfiguration](API_PredictionConfiguration.md) object

 ** [readOnlyFormsOutput](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-readOnlyFormsOutput"></a>
The read-only metadata forms that are attached to the created asset.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [revision](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-revision"></a>
The revision of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [typeIdentifier](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-typeIdentifier"></a>
The identifier of the created asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 513.  
Pattern: `(?!\.)[\w\.]*\w` 

 ** [typeRevision](#API_CreateAsset_ResponseSyntax) **   <a name="datazone-CreateAsset-response-typeRevision"></a>
The revision type of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_CreateAsset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateAsset_Examples"></a>

### Example
<a name="API_CreateAsset_Example_1"></a>

Basic asset creation:

#### Sample Request
<a name="API_CreateAsset_Example_1_Request"></a>

```
  aws datazone create-asset \
  --domain-identifier "dzd_53ielnpxktdilj" \
  --name "customeranalytics2023" \
  --owning-project-identifier "prj9vn4wxyz8k2m" \
  --type-identifier "amazon.datazone.S3ObjectCollectionAssetType" \
  --forms-input '[{
    "formName": "S3ObjectCollectionForm",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionFormType",
    "content": "{\"bucketArn\":\"arn:aws:s3:::analytics-data-bucket\"}"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_1_Response"></a>

```
{
    "createdAt": 1752566607.769,
    "createdBy": "usr26dad7d796cc",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752566607.769,
    "firstRevisionCreatedBy": "usr26dad7d796cc",
    "formsOutput": [{
        "content": "{\"bucketArn\":\"arn:aws:s3:::analytics-data-bucket\"}",
        "formName": "S3ObjectCollectionForm",
        "typeName": "amazon.datazone.S3ObjectCollectionFormType"
    }],
    "id": "ast7k9mpq2xvn4w",
    "name": "customeranalytics2023",
    "owningProjectId": "prj9vn4wxyz8k2m",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionAssetType",
    "typeRevision": "13"
}
```

### Example
<a name="API_CreateAsset_Example_2"></a>

Missing required parameter – `--domain-identifier` 

#### Sample Request
<a name="API_CreateAsset_Example_2_Request"></a>

```
  aws datazone create-asset \
  --name "analytics-missing-domain" \
  --owning-project-identifier "prj9vn4wxyz8k2m" \
  --type-identifier "amazon.datazone.S3ObjectCollectionAssetType" \
  --forms-input '[{...}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_2_Response"></a>

```
   aws: error: the following arguments are required: —domain-identifier
```

### Example
<a name="API_CreateAsset_Example_3"></a>

Invalid parameter:

#### Sample Request
<a name="API_CreateAsset_Example_3_Request"></a>

```
  aws datazone create-asset \
  --domain-identifier "invalid-domain" \
  --owning-project-identifier "prjabc123" \
  --name "Asset2" \
  --type-identifier "my.type"
```

#### Sample Response
<a name="API_CreateAsset_Example_3_Response"></a>

```
An error occurred (ValidationException) when calling the CreateAsset operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}
```

### Example
<a name="API_CreateAsset_Example_4"></a>

Non-existent asset type:

#### Sample Request
<a name="API_CreateAsset_Example_4_Request"></a>

```
  aws datazone create-asset \
  --domain-identifier "dzd_53ielnpxktdilj" \
  --name "analytics-invalid-type" \
  --owning-project-identifier "prj9vn4wxyz8k2m" \
  --type-identifier "non.existent.assetType" \
  --forms-input '[{
    "formName": "S3ObjectCollectionForm",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionFormType",
    "content": "{\"bucketArn\":\"arn:aws:s3:::analytics-data-bucket\"}"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_4_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the CreateAsset operation: The given Asset's input resource doesn't exist. Try creating Asset's input resource before accessing it.
```

### Example
<a name="API_CreateAsset_Example_5"></a>

Invalid Form JSON (`--forms-input`)

#### Sample Request
<a name="API_CreateAsset_Example_5_Request"></a>

```
  aws datazone create-asset \
  --domain-identifier "dzd_53ielnpxktdilj" \
  --name "analytics-invalid-json" \
  --owning-project-identifier "prj9vn4wxyz8k2m" \
  --type-identifier "amazon.datazone.S3ObjectCollectionAssetType" \
  --forms-input '[{formName: "S3ObjectCollectionForm", typeIdentifier: "amazon.datazone.S3ObjectCollectionFormType", content: {"bucketArn": "arn:aws:s3:::bucket"}}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_5_Response"></a>

```
Error parsing parameter '--forms-input': Invalid JSON: Expecting property name enclosed in double quotes: line 1 column 3 (char 2)

JSON received: [{formName: "S3ObjectCollectionForm", typeIdentifier: "amazon.datazone.S3ObjectCollectionFormType", content: {"bucketArn": "arn:aws:s3:::bucket"}}]
```

### Example
<a name="API_CreateAsset_Example_6"></a>

Create an asset - Amazon Bedrock chat app

#### Sample Request
<a name="API_CreateAsset_Example_6_Request"></a>

```
  aws datazone create-asset \
  --domain-identifier "dzd_53ielnpxktdilj" \
  --owning-project-identifier "prj7nx82mkl" \
  --name "CustomerSupportAIAssistant" \
  --type-identifier "dzd_53ielnpxktdilj.BedrockChatApp" \
  --type-revision "1" \
  --forms-input '[{
    "formName": "BedrockChatAppForm",
    "content": "{\"modelId\": \"anthropic.claude-v2\", \"temperature\": 0.7, \"maxTokens\": 500}",
    "typeIdentifier": "dzd_53ielnpxktdilj.BedrockChatAppForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_6_Response"></a>

```
{
    "createdAt": 1753270675.429,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753270675.429,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"modelId\": \"anthropic.claude-v2\", \"temperature\": 0.7, \"maxTokens\": 500}",
            "formName": "BedrockChatAppForm",
            "typeName": "BedrockChatAppForm",
            "typeRevision": "2"
        }
    ],
    "id": "ast4gxn2ffpxdm",
    "name": "CustomerSupportAIAssistant",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "BedrockChatApp",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_7"></a>

Create an asset - Amazon Bedrock flow app:

#### Sample Request
<a name="API_CreateAsset_Example_7_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "InvoiceProcessingWorkflow" \
--type-identifier "dzd_53ielnpxktdilj.BedrockWorkflow" \
--type-revision "1" \
--forms-input '[{
    "formName": "BedrockWorkflowForm",
    "content": "{\"steps\": [\"extract_text\", \"classify_document\", \"extract_entities\", \"validate_data\"]}",
    "typeIdentifier": "dzd_53ielnpxktdilj.BedrockWorkflowForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_7_Response"></a>

```
{
    "createdAt": 1753270689.776,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753270689.776,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"steps\": [\"extract_text\", \"classify_document\", \"extract_entities\", \"validate_data\"]}",
            "formName": "BedrockWorkflowForm",
            "typeName": "BedrockWorkflowForm",
            "typeRevision": "2"
        }
    ],
    "id": "ast44yf27731ur",
    "name": "InvoiceProcessingWorkflow",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "BedrockWorkflow",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_8"></a>

Create an asset - Amazon Bedrock inference only

#### Sample Request
<a name="API_CreateAsset_Example_8_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "TechnicalSupportKnowledgeBase" \
--type-identifier "dzd_53ielnpxktdilj.BedrockKnowledgeBase" \
--type-revision "1" \
--forms-input '[{
    "formName": "BedrockKnowledgeBaseForm",
    "content": "{\"dataSource\": \"s3://tech-support-docs/\", \"indexName\": \"tech_support_index\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.BedrockKnowledgeBaseForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_8_Response"></a>

```
{
    "createdAt": 1753270842.041,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753270842.041,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"dataSource\": \"s3://tech-support-docs/\", \"indexName\": \"tech_support_index\"}",
            "formName": "BedrockKnowledgeBaseForm",
            "typeName": "BedrockKnowledgeBaseForm",
            "typeRevision": "2"
        }
    ],
    "id": "ast5w2trvqopfk",
    "name": "TechnicalSupportKnowledgeBase",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "BedrockKnowledgeBase",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_9"></a>

Create an asset - Amazon Bedrock model

#### Sample Request
<a name="API_CreateAsset_Example_9_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "SentimentAnalysisModel" \
--type-identifier "dzd_53ielnpxktdilj.BedrockModel" \
--type-revision "1" \
--forms-input '[{
    "formName": "BedrockModelForm",
    "content": "{\"modelId\": \"amazon.titan-text-express-v1\", \"customizationType\": \"finetuning\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.BedrockModelForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_9_Response"></a>

```
{
    "createdAt": 1753270853.652,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753270853.652,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"modelId\": \"amazon.titan-text-express-v1\", \"customizationType\": \"finetuning\"}",
            "formName": "BedrockModelForm",
            "typeName": "BedrockModelForm",
            "typeRevision": "2"
        }
    ],
    "id": "astdk05pzppwhv",
    "name": "SentimentAnalysisModel",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "BedrockModel",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_10"></a>

Create an asset - Amazon Bedrock prompt

#### Sample Request
<a name="API_CreateAsset_Example_10_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "ProductDescriptionGenerator" \
--type-identifier "dzd_53ielnpxktdilj.BedrockPromptTemplate" \
--type-revision "1" \
--forms-input '[{
    "formName": "BedrockPromptTemplateForm",
    "content": "{\"template\": \"Generate a compelling product description for {product_name} with the following features: {features}\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.BedrockPromptTemplateForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_10_Response"></a>

```
{
    "createdAt": 1753270863.161,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753270863.161,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"template\": \"Generate a compelling product description for {product_name} with the following features: {features}\"}",
            "formName": "BedrockPromptTemplateForm",
            "typeName": "BedrockPromptTemplateForm",
            "typeRevision": "2"
        }
    ],
    "id": "astcry10k3efgf",
    "name": "ProductDescriptionGenerator",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "BedrockPromptTemplate",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_11"></a>

Create an asset - Databricks table

#### Sample Request
<a name="API_CreateAsset_Example_11_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerBehaviorAnalytics" \
--type-identifier "DatabricksTableAssetTypeV2" \
--type-revision "1" \
--forms-input '[{
    "formName": "DatabricksTableForm",
    "content": "{\"name\": \"customer_behavior_analysis\", \"test\": true, \"database\": \"retail_analytics\", \"schema\": \"customer_insights\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.DatabricksTableForm",
    "typeRevision": "4"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_11_Response"></a>

```
{
    "createdAt": 1753271593.735,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271593.735,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"name\":\"customer_behavior_analysis\",\"test\":true,\"database\":\"retail_analytics\",\"schema\":\"customer_insights\"}",
            "formName": "DatabricksTableForm",
            "typeName": "DatabricksTableForm",
            "typeRevision": "4"
        }
    ],
    "id": "ast412igce0pf5",
    "name": "CustomerBehaviorAnalytics",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "DatabricksTableAssetTypeV2",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_12"></a>

Create an asset - Databricks view

#### Sample Request
<a name="API_CreateAsset_Example_12_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerEngagementMetrics" \
--type-identifier "DatabricksViewAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "DatabricksViewForm",
    "content": "{\"viewName\": \"customer_engagement_metrics\", \"isMaterialized\": true, \"database\": \"retail_analytics\", \"refreshSchedule\": \"DAILY\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.DatabricksViewForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_12_Response"></a>

```
{
    "createdAt": 1753270961.273,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753270961.273,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"viewName\":\"customer_engagement_metrics\",\"isMaterialized\":true,\"database\":\"retail_analytics\",\"refreshSchedule\":\"DAILY\"}",
            "formName": "DatabricksViewForm",
            "typeName": "DatabricksViewForm",
            "typeRevision": "2"
        }
    ],
    "id": "astbtcn00ocng5",
    "name": "CustomerEngagementMetrics",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "DatabricksViewAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_13"></a>

Create an asset - AWS Glue table

#### Sample Request
<a name="API_CreateAsset_Example_13_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "RetailSalesTransactions" \
--type-identifier "amazon.datazone.GlueTableAssetType" \
--forms-input '[{
    "formName": "GlueTableForm",
    "typeIdentifier": "amazon.datazone.GlueTableFormType",
    "typeRevision": "13",
    "content": "{\"databaseName\":\"retail_analytics\",\"tableName\":\"sales_transactions\",\"catalogId\":\"123456789012\",\"region\":\"us-east-1\",\"tableArn\":\"arn:aws:glue:us-east-1:123456789012:table/retail_analytics/sales_transactions\",\"columns\":[{\"columnName\":\"transaction_date\",\"dataType\":\"timestamp\",\"description\":\"Date and time of sale\"},{\"columnName\":\"store_id\",\"dataType\":\"string\",\"description\":\"Unique store identifier\"},{\"columnName\":\"product_id\",\"dataType\":\"string\",\"description\":\"Product SKU\"},{\"columnName\":\"quantity_sold\",\"dataType\":\"int\",\"description\":\"Units sold\"},{\"columnName\":\"sale_amount\",\"dataType\":\"decimal\",\"description\":\"Total sale amount\"},{\"columnName\":\"payment_method\",\"dataType\":\"string\",\"description\":\"Payment type used\"}]}"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_13_Response"></a>

```
{
    "createdAt": 1753271465.56,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271465.56,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"databaseName\":\"retail_analytics\",\"tableName\":\"sales_transactions\",\"catalogId\":\"123456789012\",\"region\":\"us-east-1\",\"tableArn\":\"arn:aws:glue:us-east-1:123456789012:table/retail_analytics/sales_transactions\",\"columns\":[{\"columnName\":\"transaction_date\",\"dataType\":\"timestamp\",\"description\":\"Date and time of sale\"},{\"columnName\":\"store_id\",\"dataType\":\"string\",\"description\":\"Unique store identifier\"},{\"columnName\":\"product_id\",\"dataType\":\"string\",\"description\":\"Product SKU\"},{\"columnName\":\"quantity_sold\",\"dataType\":\"int\",\"description\":\"Units sold\"},{\"columnName\":\"sale_amount\",\"dataType\":\"decimal\",\"description\":\"Total sale amount\"},{\"columnName\":\"payment_method\",\"dataType\":\"string\",\"description\":\"Payment type used\"}]}",
            "formName": "GlueTableForm",
            "typeName": "amazon.datazone.GlueTableFormType",
            "typeRevision": "13"
        }
    ],
    "id": "ast5lm7ud5m6km",
    "name": "RetailSalesTransactions",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "amazon.datazone.GlueTableAssetType",
    "typeRevision": "19"
}
```

### Example
<a name="API_CreateAsset_Example_14"></a>

Create an asset - Amazon Redshift table

#### Sample Request
<a name="API_CreateAsset_Example_14_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerTransactionHistory" \
--type-identifier "RedshiftTableAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "RedshiftTableForm",
    "content": "{\"tableName\": \"customer_transactions\", \"isPartitioned\": true, \"partitionKey\": \"transaction_date\", \"schema\": \"retail\", \"database\": \"analytics_db\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.RedshiftTableForm",
    "typeRevision": "2"
}]'
```

```
{
    "createdAt": 1753271106.79,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271106.79,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"tableName\":\"customer_transactions\",\"isPartitioned\":true,\"partitionKey\":\"transaction_date\",\"schema\":\"retail\",\"database\":\"analytics_db\"}",
            "formName": "RedshiftTableForm",
            "typeName": "RedshiftTableForm",
            "typeRevision": "2"
        }
    ],
    "id": "ast3iwa3n9kwd6",
    "name": "CustomerTransactionHistory",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "RedshiftTableAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_15"></a>

Create an asset - Amazon Redshift view

#### Sample Request
<a name="API_CreateAsset_Example_15_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "MonthlyCustomerMetricsView" \
--type-identifier "RedshiftViewAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "RedshiftViewForm",
    "content": "{\"viewName\": \"monthly_customer_metrics\", \"isMaterialized\": true, \"schema\": \"analytics\", \"database\": \"retail_db\", \"refreshSchedule\": \"WEEKLY\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.RedshiftViewForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_15_Response"></a>

```
{
    "createdAt": 1753271116.838,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271116.838,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"viewName\":\"monthly_customer_metrics\",\"isMaterialized\":true,\"schema\":\"analytics\",\"database\":\"retail_db\",\"refreshSchedule\":\"WEEKLY\"}",
            "formName": "RedshiftViewForm",
            "typeName": "RedshiftViewForm",
            "typeRevision": "2"
        }
    ],
    "id": "ast6e7i1ieksu2",
    "name": "MonthlyCustomerMetricsView",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "RedshiftViewAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_16"></a>

Create an asset - Amazon S3 object collection

#### Sample Request
<a name="API_CreateAsset_Example_16_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "MarketingCampaignData" \
--owning-project-identifier "prj7nx82mkl" \
--type-identifier "amazon.datazone.S3ObjectCollectionAssetType" \
--forms-input '[{
    "formName": "S3ObjectCollectionForm",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionFormType",
    "content": "{\"bucketArn\":\"arn:aws:s3:::marketing-analytics-data\"}"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_16_Response"></a>

```
{
    "createdAt": 1752566607.769,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752566607.769,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [{
        "content": "{\"bucketArn\":\"arn:aws:s3:::marketing-analytics-data\"}",
        "formName": "S3ObjectCollectionForm",
        "typeName": "amazon.datazone.S3ObjectCollectionFormType"
    }],
    "id": "ast6js4t0dhjj",
    "name": "MarketingCampaignData",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionAssetType",
    "typeRevision": "13"
}
```

### Example
<a name="API_CreateAsset_Example_17"></a>

Create an asset - Snowflake table

#### Sample Request
<a name="API_CreateAsset_Example_17_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "ProductCatalogTable" \
--type-identifier "SnowflakeTableAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "SnowflakeTableForm",
    "content": "{\"tableName\": \"product_catalog\", \"isPartitioned\": false, \"schema\": \"inventory\", \"warehouse\": \"analytics_wh\", \"database\": \"retail_ops\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.SnowflakeTableForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_17_Response"></a>

```
{
    "createdAt": 1753271227.293,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271227.293,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"tableName\":\"product_catalog\",\"isPartitioned\":false,\"schema\":\"inventory\",\"warehouse\":\"analytics_wh\",\"database\":\"retail_ops\"}",
            "formName": "SnowflakeTableForm",
            "typeName": "SnowflakeTableForm",
            "typeRevision": "2"
        }
    ],
    "id": "astaq1726wu6o4",
    "name": "ProductCatalogTable",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "SnowflakeTableAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_18"></a>

Create an asset - Snowflake view

#### Sample Request
<a name="API_CreateAsset_Example_18_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "OrderSummaryView" \
--type-identifier "SnowflakeViewAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "SnowflakeViewForm",
    "content": "{\"viewName\": \"order_summary\", \"isMaterialized\": true, \"schema\": \"sales\", \"warehouse\": \"reporting_wh\", \"database\": \"retail_ops\", \"refreshSchedule\": \"DAILY\"}",
    "typeIdentifier": "dzd_53ielnpxktdilj.SnowflakeViewForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_18_Response"></a>

```
{
    "createdAt": 1753271243.513,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271243.513,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"viewName\":\"order_summary\",\"isMaterialized\":true,\"schema\":\"sales\",\"warehouse\":\"reporting_wh\",\"database\":\"retail_ops\",\"refreshSchedule\":\"DAILY\"}",
            "formName": "SnowflakeViewForm",
            "typeName": "SnowflakeViewForm",
            "typeRevision": "2"
        }
    ],
    "id": "ast6ip7bou5vkj",
    "name": "OrderSummaryView",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "SnowflakeViewAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_19"></a>

Create an asset Amazon SageMaker feature group

#### Sample Request
<a name="API_CreateAsset_Example_19_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerChurnPredictionFeatures" \
--type-identifier "SageMakerFeatureGroupAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "SageMakerFeatureGroupForm",
    "content": "{\"name\": \"customer_churn_features\", \"description\": \"Features for predicting customer churn\", \"recordIdentifierFeatureName\": \"customer_id\", \"eventTimeFeatureName\": \"last_interaction_date\", \"onlineStoreConfig\": {\"enableOnlineStore\": true}, \"offlineStoreConfig\": {\"s3StorageConfig\": {\"s3Uri\": \"s3://sagemaker-featurestore-123456789012/customer-churn/\"}, \"disableGlueTableCreation\": false}, \"tags\": [{\"Key\": \"Project\", \"Value\": \"ChurnPrediction\"}]}",
    "typeIdentifier": "dzd_53ielnpxktdilj.SageMakerFeatureGroupForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_19_Response"></a>

```
{
    "createdAt": 1753271260.976,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271260.976,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"name\":\"customer_churn_features\",\"description\":\"Features for predicting customer churn\",\"recordIdentifierFeatureName\":\"customer_id\",\"eventTimeFeatureName\":\"last_interaction_date\",\"onlineStoreConfig\":{\"enableOnlineStore\":true},\"offlineStoreConfig\":{\"s3StorageConfig\":{\"s3Uri\":\"s3://sagemaker-featurestore-123456789012/customer-churn/\"},\"disableGlueTableCreation\":false},\"tags\":[{\"Key\":\"Project\",\"Value\":\"ChurnPrediction\"}]}",
            "formName": "SageMakerFeatureGroupForm",
            "typeName": "SageMakerFeatureGroupForm",
            "typeRevision": "2"
        }
    ],
    "id": "astb4lyqqkwuto",
    "name": "CustomerChurnPredictionFeatures",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "SageMakerFeatureGroupAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_20"></a>

Create an asset - Amazon SageMaker model package group

#### Sample Request
<a name="API_CreateAsset_Example_20_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "ChurnPredictionModelPackages" \
--type-identifier "SageMakerModelPackageGroupAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "SageMakerModelPackageGroupForm",
    "content": "{\"modelPackageGroupName\": \"churn-prediction-models\", \"modelPackageGroupDescription\": \"Model packages for customer churn prediction\", \"tags\": [{\"Key\": \"Department\", \"Value\": \"CustomerRetention\"}]}",
    "typeIdentifier": "dzd_53ielnpxktdilj.SageMakerModelPackageGroupForm",
    "typeRevision": "2"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_20_Response"></a>

```
{
    "createdAt": 1753271283.422,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271283.422,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"modelPackageGroupName\":\"churn-prediction-models\",\"modelPackageGroupDescription\":\"Model packages for customer churn prediction\",\"tags\":[{\"Key\":\"Department\",\"Value\":\"CustomerRetention\"}]}",
            "formName": "SageMakerModelPackageGroupForm",
            "typeName": "SageMakerModelPackageGroupForm",
            "typeRevision": "2"
        }
    ],
    "id": "astcrohevshltl",
    "name": "ChurnPredictionModelPackages",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "SageMakerModelPackageGroupAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_21"></a>

Create an asset - data product

#### Sample Request
<a name="API_CreateAsset_Example_21_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "Customer360DataProduct" \
--description "Comprehensive 360-degree view of customer data for analytics and personalization" \
--type-identifier "DataProductAssetType" \
--type-revision "1" \
--forms-input '[{
    "formName": "DataProductMetadataForm",
    "content": "{\"name\": \"customer_360_view\", \"description\": \"Unified customer data across all touchpoints\", \"owner\": \"Customer Intelligence Team\", \"dataSources\": [\"CRM\", \"WebAnalytics\", \"TransactionHistory\", \"SupportTickets\"], \"updateFrequency\": \"Daily\", \"dataRetentionPeriod\": \"3 years\", \"accessControl\": \"Restricted\", \"dataQuality\": {\"completeness\": 98, \"accuracy\": 99, \"consistency\": 97}}",
    "typeIdentifier": "dzd_53ielnpxktdilj.DataProductMetadataForm",
    "typeRevision": "1"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_21_Response"></a>

```
{
    "createdAt": 1753271355.609,
    "createdBy": "usr7nx82mkl",
    "description": "Comprehensive 360-degree view of customer data for analytics and personalization",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271355.609,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"name\":\"customer_360_view\",\"description\":\"Unified customer data across all touchpoints\",\"owner\":\"Customer Intelligence Team\",\"dataSources\":[\"CRM\",\"WebAnalytics\",\"TransactionHistory\",\"SupportTickets\"],\"updateFrequency\":\"Daily\",\"dataRetentionPeriod\":\"3 years\",\"accessControl\":\"Restricted\",\"dataQuality\":{\"completeness\":98,\"accuracy\":99,\"consistency\":97}}",
            "formName": "DataProductMetadataForm",
            "typeName": "DataProductMetadataForm",
            "typeRevision": "1"
        }
    ],
    "id": "ast6ik301sa28t",
    "name": "Customer360DataProduct",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "DataProductAssetType",
    "typeRevision": "1"
}
```

### Example
<a name="API_CreateAsset_Example_22"></a>

Create an asset - AWS Glue view

#### Sample Request
<a name="API_CreateAsset_Example_22_Request"></a>

```
aws datazone create-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "DailyStoreSalesAnalysis" \
--type-identifier "amazon.datazone.GlueViewAssetType" \
--forms-input '[{
    "formName": "GlueViewForm",
    "content": "{\"databaseName\":\"retail_analytics\",\"tableName\":\"daily_store_sales\",\"catalogId\":\"123456789012\",\"region\":\"us-east-1\",\"tableArn\":\"arn:aws:glue:us-east-1:123456789012:table/retail_analytics/daily_store_sales\",\"columns\":[{\"columnName\":\"date\",\"dataType\":\"date\",\"description\":\"Sale date\"},{\"columnName\":\"store_id\",\"dataType\":\"string\",\"description\":\"Store identifier\"},{\"columnName\":\"total_sales\",\"dataType\":\"decimal\",\"description\":\"Total daily sales\"},{\"columnName\":\"transaction_count\",\"dataType\":\"int\",\"description\":\"Number of transactions\"}]}",
    "typeIdentifier": "amazon.datazone.GlueViewFormType",
    "typeRevision": "12"
}]'
```

#### Sample Response
<a name="API_CreateAsset_Example_22_Response"></a>

```
{
    "createdAt": 1753271539.275,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1753271539.275,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [
        {
            "content": "{\"databaseName\":\"retail_analytics\",\"tableName\":\"daily_store_sales\",\"catalogId\":\"123456789012\",\"region\":\"us-east-1\",\"tableArn\":\"arn:aws:glue:us-east-1:123456789012:table/retail_analytics/daily_store_sales\",\"columns\":[{\"columnName\":\"date\",\"dataType\":\"date\",\"description\":\"Sale date\"},{\"columnName\":\"store_id\",\"dataType\":\"string\",\"description\":\"Store identifier\"},{\"columnName\":\"total_sales\",\"dataType\":\"decimal\",\"description\":\"Total daily sales\"},{\"columnName\":\"transaction_count\",\"dataType\":\"int\",\"description\":\"Number of transactions\"}]}",
            "formName": "GlueViewForm",
            "typeName": "amazon.datazone.GlueViewFormType",
            "typeRevision": "12"
        }
    ],
    "id": "astd1bi0vd0mf0",
    "name": "DailyStoreSalesAnalysis",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "amazon.datazone.GlueViewAssetType",
    "typeRevision": "18"
}
```

## See Also
<a name="API_CreateAsset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateAsset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateAsset) 

# CreateAssetFilter
<a name="API_CreateAssetFilter"></a>

Creates a data asset filter.

Asset filters provide a sophisticated way to create controlled views of data assets by selecting specific columns or applying row-level filters. This capability is crucial for organizations that need to share data while maintaining security and privacy controls. For example, your database might be filtered to show only non-PII fields to certain users, or sales data might be filtered by region for different regional teams. Asset filters enable fine-grained access control while maintaining a single source of truth.

Prerequisites:
+ A valid domain (`--domain-identifier`) must exist. 
+ A data asset (`--asset-identifier`) must already be created under that domain.
+ The asset must have the referenced columns available in its schema for column-based filtering.
+ You cannot specify both (`columnConfiguration`, `rowConfiguration`)at the same time.

## Request Syntax
<a name="API_CreateAssetFilter_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/assets/assetIdentifier/filters HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": { ... },
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_CreateAssetFilter_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetIdentifier](#API_CreateAssetFilter_RequestSyntax) **   <a name="datazone-CreateAssetFilter-request-uri-assetIdentifier"></a>
The ID of the data asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_CreateAssetFilter_RequestSyntax) **   <a name="datazone-CreateAssetFilter-request-uri-domainIdentifier"></a>
The ID of the domain in which you want to create an asset filter.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateAssetFilter_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateAssetFilter_RequestSyntax) **   <a name="datazone-CreateAssetFilter-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [configuration](#API_CreateAssetFilter_RequestSyntax) **   <a name="datazone-CreateAssetFilter-request-configuration"></a>
The configuration of the asset filter.  
Type: [AssetFilterConfiguration](API_AssetFilterConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [description](#API_CreateAssetFilter_RequestSyntax) **   <a name="datazone-CreateAssetFilter-request-description"></a>
The description of the asset filter.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [name](#API_CreateAssetFilter_RequestSyntax) **   <a name="datazone-CreateAssetFilter-request-name"></a>
The name of the asset filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: Yes

## Response Syntax
<a name="API_CreateAssetFilter_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "assetId": "string",
   "configuration": { ... },
   "createdAt": number,
   "description": "string",
   "domainId": "string",
   "effectiveColumnNames": [ "string" ],
   "effectiveRowFilter": "string",
   "errorMessage": "string",
   "id": "string",
   "name": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateAssetFilter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [assetId](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-assetId"></a>
The ID of the asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [configuration](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-configuration"></a>
The configuration of the asset filter.  
Type: [AssetFilterConfiguration](API_AssetFilterConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdAt](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-createdAt"></a>
The timestamp at which the asset filter was created.  
Type: Timestamp

 ** [description](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-description"></a>
The description of the asset filter.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-domainId"></a>
The ID of the domain where the asset filter is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [effectiveColumnNames](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-effectiveColumnNames"></a>
The column names in the asset filter.  
Type: Array of strings

 ** [effectiveRowFilter](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-effectiveRowFilter"></a>
The row filter in the asset filter.  
Type: String

 ** [errorMessage](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-errorMessage"></a>
The error message that is displayed if the asset filter is not created successfully.  
Type: String

 ** [id](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-id"></a>
The ID of the asset filter.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-name"></a>
The name of the asset filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [status](#API_CreateAssetFilter_ResponseSyntax) **   <a name="datazone-CreateAssetFilter-response-status"></a>
The status of the asset filter.  
Type: String  
Valid Values: `VALID | INVALID` 

## Errors
<a name="API_CreateAssetFilter_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateAssetFilter_Examples"></a>

### Example
<a name="API_CreateAssetFilter_Example_1"></a>

This example illustrates one usage of CreateAssetFilter.

#### Sample Request
<a name="API_CreateAssetFilter_Example_1_Request"></a>

```
aws datazone create-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--name "customer-pii-filter" \
--configuration '{
    "columnConfiguration": {
        "includedColumnNames": [
            "customer_id",
            "email",
            "phone_number",
            "address"
        ]
    }
}'
```

#### Sample Request
<a name="API_CreateAssetFilter_Example_1_Request"></a>

```
{
    "assetId": "ast7k9mpq2xvn4",
    "configuration": {
        "columnConfiguration": {
            "includedColumnNames": [
                "customer_id",
                "email",
                "phone_number",
                "address"
            ]
        }
    },
    "domainId": "dzd_53ielnpxktdilj",
    "effectiveColumnNames": [
        "customer_id",
        "email",
        "phone_number",
        "address"
    ],
    "id": "flt8p2mq3xvn5",
    "name": "customer-pii-filter",
    "status": "VALID"
}
```

### Example
<a name="API_CreateAssetFilter_Example_2"></a>

Failure case - missing required field: `--configuration`:

#### Sample Request
<a name="API_CreateAssetFilter_Example_2_Request"></a>

```
aws datazone create-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--name "missing-config"
```

#### Sample Response
<a name="API_CreateAssetFilter_Example_2_Response"></a>

```
aws: error: the following arguments are required: —configuration
```

### Example
<a name="API_CreateAssetFilter_Example_3"></a>

Failure case - invalid JSON in `--configuration` 

#### Sample Request
<a name="API_CreateAssetFilter_Example_3_Request"></a>

```
aws datazone create-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--name "invalid-json" \
--configuration '{ "columnConfiguration": { "includedColumnNames": ["customer_id", "email" }'
```

#### Sample Response
<a name="API_CreateAssetFilter_Example_3_Response"></a>

```
Error parsing parameter '--configuration': Invalid JSON: Expecting ',' delimiter: line 1 column 65 (char 64)
JSON received: { "columnConfiguration": { "includedColumnNames": ["customer_id", "email" }
```

### Example
<a name="API_CreateAssetFilter_Example_4"></a>

Failure case - both `columnConfiguration` and `rowConfiguration` present

#### Sample Request
<a name="API_CreateAssetFilter_Example_4_Request"></a>

```
aws datazone create-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--name "dual-config" \
--configuration '{
    "columnConfiguration": {
        "includedColumnNames": ["customer_id"]
    },
    "rowConfiguration": {
        "rowFilter": {
            "expression": {
                "equalTo": {
                    "columnName": "customer_id",
                    "value": "CUST123"
                }
            }
        }
    }
}'
```

#### Sample Response
<a name="API_CreateAssetFilter_Example_4_Response"></a>

```
Parameter validation failed:
Invalid number of parameters set for tagged union structure configuration. Can only set one of the following keys: columnConfiguration, rowConfiguration.
```

### Example
<a name="API_CreateAssetFilter_Example_5"></a>

Failure case - empty `includedColumnNames`: 

#### Sample Request
<a name="API_CreateAssetFilter_Example_5_Request"></a>

```
aws datazone create-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--name "empty-columns" \
--configuration '{
    "columnConfiguration": {
        "includedColumnNames": []
    }
}'
```

#### Sample Response
<a name="API_CreateAssetFilter_Example_5_Response"></a>

```
An error occurred (ValidationException) when calling the CreateAssetFilter operation: Invalid column configuration. No valid columns found.
```

### Example
<a name="API_CreateAssetFilter_Example_6"></a>

Failure case - invalid key in `rowFilter` expression:

#### Sample Request
<a name="API_CreateAssetFilter_Example_6_Request"></a>

```
aws datazone create-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--name "invalid-row-key" \
--configuration '{
    "rowConfiguration": {
        "rowFilter": {
            "expression": {
                "invalidOperator": {
                    "columnName": "customer_id",
                    "value": "CUST123"
                }
            }
        }
    }
}'
```

#### Sample Response
<a name="API_CreateAssetFilter_Example_6_Response"></a>

```
Parameter validation failed:
Unknown parameter in configuration.rowConfiguration.rowFilter.expression: "invalidOperator", must be one of: equalTo, greaterThan, greaterThanOrEqualTo, in, isNotNull, isNull, lessThan, lessThanOrEqualTo, like, notEqualTo, notIn, notLike
```

### Example
<a name="API_CreateAssetFilter_Example_7"></a>

Failure case - missing `columnName` in row filter:

#### Sample Request
<a name="API_CreateAssetFilter_Example_7_Request"></a>

```
aws datazone create-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--name "missing-column-name" \
--configuration '{
    "rowConfiguration": {
        "rowFilter": {
            "expression": {
                "equalTo": {
                    "value": "CUST123"
                }
            }
        }
    }
}'
```

#### Sample Response
<a name="API_CreateAssetFilter_Example_7_Response"></a>

```
Parameter validation failed:
Missing required parameter in configuration.rowConfiguration.rowFilter.expression.equalTo: "columnName"
```

## See Also
<a name="API_CreateAssetFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateAssetFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateAssetFilter) 

# CreateAssetRevision
<a name="API_CreateAssetRevision"></a>

Creates a revision of the asset.

Asset revisions represent new versions of existing assets, capturing changes to either the underlying data or its metadata. They maintain a historical record of how assets evolve over time, who made changes, and when those changes occurred. This versioning capability is crucial for governance and compliance, allowing organizations to track changes, understand their impact, and roll back if necessary.

Prerequisites:
+ Asset must already exist in the domain with identifier. 
+  `formsInput` is required when asset has the form type. `typeRevision` should be the latest version of form type. 
+ The form content must include all required fields (e.g., `bucketArn` for `S3ObjectCollectionForm`).
+ The owning project of the original asset must still exist and be active.
+ User must have write access to the project and domain.

## Request Syntax
<a name="API_CreateAssetRevision_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/assets/identifier/revisions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "formsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "name": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "typeRevision": "string"
}
```

## URI Request Parameters
<a name="API_CreateAssetRevision_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-uri-domainIdentifier"></a>
The unique identifier of the domain where the asset is being revised.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-uri-identifier"></a>
The identifier of the asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateAssetRevision_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-description"></a>
The revised description of the asset.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [formsInput](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-formsInput"></a>
The metadata forms to be attached to the asset as part of asset revision.  
Type: Array of [FormInput](API_FormInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [glossaryTerms](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-glossaryTerms"></a>
The glossary terms to be attached to the asset as part of asset revision.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [name](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-name"></a>
Te revised name of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [predictionConfiguration](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-predictionConfiguration"></a>
The configuration of the automatically generated business-friendly metadata for the asset.  
Type: [PredictionConfiguration](API_PredictionConfiguration.md) object  
Required: No

 ** [typeRevision](#API_CreateAssetRevision_RequestSyntax) **   <a name="datazone-CreateAssetRevision-request-typeRevision"></a>
The revision type of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## Response Syntax
<a name="API_CreateAssetRevision_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "externalIdentifier": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "governedGlossaryTerms": [ "string" ],
   "id": "string",
   "latestTimeSeriesDataPointFormsOutput": [ 
      { 
         "contentSummary": "string",
         "formName": "string",
         "id": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "listing": { 
      "listingId": "string",
      "listingStatus": "string"
   },
   "name": "string",
   "owningProjectId": "string",
   "predictionConfiguration": { 
      "businessNameGeneration": { 
         "enabled": boolean
      }
   },
   "readOnlyFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "revision": "string",
   "typeIdentifier": "string",
   "typeRevision": "string"
}
```

## Response Elements
<a name="API_CreateAssetRevision_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-createdAt"></a>
The timestamp of when the asset revision occured.  
Type: Timestamp

 ** [createdBy](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-createdBy"></a>
The Amazon DataZone user who performed the asset revision.  
Type: String

 ** [description](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-description"></a>
The revised asset description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-domainId"></a>
The unique identifier of the Amazon DataZone domain where the asset was revised.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [externalIdentifier](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-externalIdentifier"></a>
The external identifier of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 600.

 ** [firstRevisionCreatedAt](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-firstRevisionCreatedAt"></a>
The timestamp of when the first asset revision occured.  
Type: Timestamp

 ** [firstRevisionCreatedBy](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-firstRevisionCreatedBy"></a>
The Amazon DataZone user who performed the first asset revision.  
Type: String

 ** [formsOutput](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-formsOutput"></a>
The metadata forms that were attached to the asset as part of the asset revision.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [glossaryTerms](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-glossaryTerms"></a>
The glossary terms that were attached to the asset as part of asset revision.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [governedGlossaryTerms](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-governedGlossaryTerms"></a>
The glossary terms in a restricted glossary.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-id"></a>
The unique identifier of the asset revision.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [latestTimeSeriesDataPointFormsOutput](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-latestTimeSeriesDataPointFormsOutput"></a>
The latest data point that was imported into the time series form for the asset.   
Type: Array of [TimeSeriesDataPointSummaryFormOutput](API_TimeSeriesDataPointSummaryFormOutput.md) objects

 ** [listing](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-listing"></a>
The details of an asset published in an Amazon DataZone catalog.   
Type: [AssetListingDetails](API_AssetListingDetails.md) object

 ** [name](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-name"></a>
The revised name of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [owningProjectId](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-owningProjectId"></a>
The unique identifier of the revised project that owns the asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [predictionConfiguration](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-predictionConfiguration"></a>
The configuration of the automatically generated business-friendly metadata for the asset.  
Type: [PredictionConfiguration](API_PredictionConfiguration.md) object

 ** [readOnlyFormsOutput](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-readOnlyFormsOutput"></a>
The read-only metadata forms that were attached to the asset as part of the asset revision.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [revision](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-revision"></a>
The revision of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [typeIdentifier](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-typeIdentifier"></a>
The identifier of the revision type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 513.  
Pattern: `(?!\.)[\w\.]*\w` 

 ** [typeRevision](#API_CreateAssetRevision_ResponseSyntax) **   <a name="datazone-CreateAssetRevision-response-typeRevision"></a>
The revision type of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_CreateAssetRevision_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateAssetRevision_Examples"></a>

### Example
<a name="API_CreateAssetRevision_Example_1"></a>

This example illustrates one usage of CreateAssetRevision.

#### Sample Request
<a name="API_CreateAssetRevision_Example_1_Request"></a>

```
aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[
    {
        "formName": "S3ObjectCollectionForm",
        "typeIdentifier": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7",
        "content": "{\"bucketArn\":\"arn:aws:s3:::customer-analytics-data\"}"
    }
]'
```

#### Sample Response
<a name="API_CreateAssetRevision_Example_1_Response"></a>

```
{
    "createdAt": 1752601021.227,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752554243.917,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [{
        "content": "{\"bucketArn\":\"arn:aws:s3:::customer-analytics-data\"}",
        "formName": "S3ObjectCollectionForm",
        "typeName": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7"
    }],
    "id": "ast7k9mpq2xvn4",
    "name": "CustomerDataset-v2",
    "owningProjectId": "prj7nx82mkl",
    "readOnlyFormsOutput": [],
    "revision": "2",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionAssetType",
    "typeRevision": "13"
}
```

### Example
<a name="API_CreateAssetRevision_Example_2"></a>

Failure case - invalid revision number for form input:

#### Sample Request
<a name="API_CreateAssetRevision_Example_2_Request"></a>

```
aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "SalesTransactionsMart" \
--forms-input '[{
    "formName": "GlueTableForm",
    "typeIdentifier": "amazon.datazone.GlueTableFormType",
    "typeRevision": "12",
    "content": "{\"databaseName\":\"retail_analytics\",\"tableName\":\"sales_transactions\",\"catalogId\":\"\",\"region\":\"us-east-1\",\"tableArn\":\"arn:aws:glue:us-east-1:*:table/retail_analytics/sales_transactions\",\"columns\":[{\"columnName\":\"transaction_id\",\"dataType\":\"string\"},{\"columnName\":\"transaction_date\",\"dataType\":\"timestamp\"},{\"columnName\":\"product_id\",\"dataType\":\"string\"},{\"columnName\":\"quantity\",\"dataType\":\"int\"},{\"columnName\":\"total_amount\",\"dataType\":\"decimal\"}]}"
}]‘
```

#### Sample Response
<a name="API_CreateAssetRevision_Example_2_Response"></a>

```
An error occurred (ValidationException) when calling the CreateAsset operation: Form GlueTableForm expected form amazon.datazone#GlueTableFormType@13 but was provided amazon.datazone#GlueTableFormType@12
```

### Example
<a name="API_CreateAssetRevision_Example_3"></a>

Failure case - invalid or missing `--domain-identifier`:

#### Sample Request
<a name="API_CreateAssetRevision_Example_3_Request"></a>

```
aws datazone create-asset-revision \
--domain-identifier "invalid_domain" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[]'
```

#### Sample Response
<a name="API_CreateAssetRevision_Example_3_Response"></a>

```
An error occurred (ValidationException) when calling the CreateAssetRevision operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}
```

### Example
<a name="API_CreateAssetRevision_Example_4"></a>

Failure case - unsupported form `typeIdentifier` or `typeRevision`:

#### Sample Request
<a name="API_CreateAssetRevision_Example_4_Request"></a>

```
aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input 'INVALID_JSON'
```

#### Sample Response
<a name="API_CreateAssetRevision_Example_4_Response"></a>

```
Error parsing parameter '—forms-input': Expected: '=', received: 'EOF' for input:
{self._error_location()}
```

### Example
<a name="API_CreateAssetRevision_Example_5"></a>

Failure case - response does not exist: 

#### Sample Request
<a name="API_CreateAssetRevision_Example_5_Request"></a>

```
aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[
    {
        "formName": "InvalidForm",
        "typeIdentifier": "invalid.type.identifier",
        "typeRevision": "99",
        "content": "{}"
    }
]'
```

#### Sample Response
<a name="API_CreateAssetRevision_Example_5_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the CreateAssetRevision operation: The given Asset doesn't exist. Try creating Asset before accessing it.
```

### Example
<a name="API_CreateAssetRevision_Example_6"></a>

Failure case - missing required `content` field:

#### Sample Request
<a name="API_CreateAssetRevision_Example_6_Request"></a>

```
aws datazone create-asset-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4" \
--name "CustomerDataset-v2" \
--forms-input '[
    {
        "formName": "S3ObjectCollectionForm",
        "typeIdentifier": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7"
    }
]'
```

#### Sample Response
<a name="API_CreateAssetRevision_Example_6_Response"></a>

```
An error occurred (ValidationException) when calling the CreateAssetRevision operation: $.S3ObjectCollectionForm.bucketArn: is missing but it is required
```

## See Also
<a name="API_CreateAssetRevision_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateAssetRevision) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateAssetRevision) 

# CreateAssetType
<a name="API_CreateAssetType"></a>

Creates a custom asset type.

Prerequisites:
+ The `formsInput` field is required, however, can be passed as empty (e.g. `-forms-input {})`. 
+ You must have `CreateAssetType` permissions.
+ The domain-identifier and owning-project-identifier must be valid and active.
+ The name of the asset type must be unique within the domain — duplicate names will cause failure.
+ JSON input must be valid — incorrect formatting causes Invalid JSON errors.

## Request Syntax
<a name="API_CreateAssetType_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/asset-types HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "formsInput": { 
      "string" : { 
         "required": boolean,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   },
   "name": "string",
   "owningProjectIdentifier": "string"
}
```

## URI Request Parameters
<a name="API_CreateAssetType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateAssetType_RequestSyntax) **   <a name="datazone-CreateAssetType-request-uri-domainIdentifier"></a>
The unique identifier of the Amazon DataZone domain where the custom asset type is being created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateAssetType_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateAssetType_RequestSyntax) **   <a name="datazone-CreateAssetType-request-description"></a>
The descripton of the custom asset type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [formsInput](#API_CreateAssetType_RequestSyntax) **   <a name="datazone-CreateAssetType-request-formsInput"></a>
The metadata forms that are to be attached to the custom asset type.  
Type: String to [FormEntryInput](API_FormEntryInput.md) object map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*`   
Required: Yes

 ** [name](#API_CreateAssetType_RequestSyntax) **   <a name="datazone-CreateAssetType-request-name"></a>
The name of the custom asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*`   
Required: Yes

 ** [owningProjectIdentifier](#API_CreateAssetType_RequestSyntax) **   <a name="datazone-CreateAssetType-request-owningProjectIdentifier"></a>
The identifier of the Amazon DataZone project that is to own the custom asset type.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Response Syntax
<a name="API_CreateAssetType_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "formsOutput": { 
      "string" : { 
         "required": boolean,
         "typeName": "string",
         "typeRevision": "string"
      }
   },
   "name": "string",
   "originDomainId": "string",
   "originProjectId": "string",
   "owningProjectId": "string",
   "revision": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_CreateAssetType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-createdAt"></a>
The timestamp of when the asset type is to be created.  
Type: Timestamp

 ** [createdBy](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-createdBy"></a>
The Amazon DataZone user who creates this custom asset type.  
Type: String

 ** [description](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-description"></a>
The description of the custom asset type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-domainId"></a>
The ID of the Amazon DataZone domain in which the asset type was created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [formsOutput](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-formsOutput"></a>
The metadata forms that are attached to the asset type.  
Type: String to [FormEntryOutput](API_FormEntryOutput.md) object map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*` 

 ** [name](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-name"></a>
The name of the asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*` 

 ** [originDomainId](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-originDomainId"></a>
The ID of the Amazon DataZone domain where the asset type was originally created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [originProjectId](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-originProjectId"></a>
The ID of the Amazon DataZone project where the asset type was originally created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningProjectId](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-owningProjectId"></a>
The ID of the Amazon DataZone project that currently owns this asset type.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-revision"></a>
The revision of the custom asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [updatedAt](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-updatedAt"></a>
The timestamp of when the custom type was created.  
Type: Timestamp

 ** [updatedBy](#API_CreateAssetType_ResponseSyntax) **   <a name="datazone-CreateAssetType-response-updatedBy"></a>
The Amazon DataZone user that created the custom asset type.  
Type: String

## Errors
<a name="API_CreateAssetType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateAssetType_Examples"></a>

### Example
<a name="API_CreateAssetType_Example_1"></a>

This example illustrates one usage of CreateAssetType.

#### Sample Request
<a name="API_CreateAssetType_Example_1_Request"></a>

```
aws datazone create-asset-type \ --domain-identifier "dzd_53ielnpxktdilj" \ --owning-project-identifier "prj9vn4wxyz8k2m" \ --name "DataProductAssetType" \ --forms-input '{ "DataProductMetadataForm": { "required": true, "typeIdentifier": "DataProductMetadataForm", "typeRevision": "1" } }' 
```

#### Sample Response
<a name="API_CreateAssetType_Example_1_Response"></a>

```
{
    "description": "Asset type for Data Product using DataProductMetadataForm",
    "domainId": "dzd_53ielnpxktdilj",
    "formsOutput": {
        "AssetCommonDetailsForm": {
            "required": false,
            "typeName": "amazon.datazone.AssetCommonDetailsFormType",
            "typeRevision": "6"
        },
        "DataProductMetadataForm": {
            "required": true,
            "typeName": "DataProductMetadataForm",
            "typeRevision": "1"
        }
    },
    "name": "DataProductAssetType",
    "revision": "1"
}
```

### Example
<a name="API_CreateAssetType_Example_2"></a>

Failure case - missing `--forms-input`:

#### Sample Request
<a name="API_CreateAssetType_Example_2_Request"></a>

```
aws datazone create-asset-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerDataAssetType"
```

#### Sample Response
<a name="API_CreateAssetType_Example_2_Response"></a>

```
aws: error: the following arguments are required: —forms-input
```

### Example
<a name="API_CreateAssetType_Example_3"></a>

Failure case - invalid `typeIdentifier`:

#### Sample Request
<a name="API_CreateAssetType_Example_3_Request"></a>

```
aws datazone create-asset-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerDataAssetType" \
--forms-input '{
    "CustomerProfileForm": {
        "required": true,
        "typeIdentifier": "NonExistentFormType",
        "typeRevision": "1"
    }
}'
```

#### Sample Response
<a name="API_CreateAssetType_Example_3_Response"></a>

```
An error occurred (ValidationException) when calling the CreateAssetType operation: {"message":"Object type Form#dzd_53ielnpxktdilj#NonExistentFormType with version 1 not found"}
```

### Example
<a name="API_CreateAssetType_Example_4"></a>

Failure case - invalid JSON:

#### Sample Request
<a name="API_CreateAssetType_Example_4_Request"></a>

```
aws datazone create-asset-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerDataAssetType" \
--forms-input '{"CustomerProfileForm": {"required": true, "typeIdentifier": "CustomerProfileFormType", "typeRevision": 1'
```

#### Sample Response
<a name="API_CreateAssetType_Example_4_Response"></a>

```
Error parsing parameter '--forms-input': Invalid JSON: Expecting ',' delimiter: line 1 column 77 (char 76)
JSON received: {"CustomerProfileForm": {"required": true, "typeIdentifier": "CustomerProfileFormType", "typeRevision": 1
```

## See Also
<a name="API_CreateAssetType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateAssetType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateAssetType) 

# CreateConnection
<a name="API_CreateConnection"></a>

Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

## Request Syntax
<a name="API_CreateConnection_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/connections HTTP/1.1
Content-type: application/json

{
   "awsLocation": { 
      "accessRole": "string",
      "awsAccountId": "string",
      "awsRegion": "string",
      "iamConnectionId": "string"
   },
   "clientToken": "string",
   "configurations": [ 
      { 
         "classification": "string",
         "properties": { 
            "string" : "string" 
         }
      }
   ],
   "description": "string",
   "enableTrustedIdentityPropagation": boolean,
   "environmentIdentifier": "string",
   "name": "string",
   "props": { ... },
   "scope": "string"
}
```

## URI Request Parameters
<a name="API_CreateConnection_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-uri-domainIdentifier"></a>
The ID of the domain where the connection is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateConnection_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [awsLocation](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-awsLocation"></a>
The location where the connection is created.  
Type: [AwsLocation](API_AwsLocation.md) object  
Required: No

 ** [clientToken](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [configurations](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-configurations"></a>
The configurations of the connection.  
Type: Array of [Configuration](API_Configuration.md) objects  
Required: No

 ** [description](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-description"></a>
A connection description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: No

 ** [enableTrustedIdentityPropagation](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-enableTrustedIdentityPropagation"></a>
Specifies whether the trusted identity propagation is enabled.  
Type: Boolean  
Required: No

 ** [environmentIdentifier](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-environmentIdentifier"></a>
The ID of the environment where the connection is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [name](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-name"></a>
The connection name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Required: Yes

 ** [props](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-props"></a>
The connection props.  
Type: [ConnectionPropertiesInput](API_ConnectionPropertiesInput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [scope](#API_CreateConnection_RequestSyntax) **   <a name="datazone-CreateConnection-request-scope"></a>
The scope of the connection.  
Type: String  
Valid Values: `DOMAIN | PROJECT`   
Required: No

## Response Syntax
<a name="API_CreateConnection_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "configurations": [ 
      { 
         "classification": "string",
         "properties": { 
            "string" : "string" 
         }
      }
   ],
   "connectionId": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentId": "string",
   "name": "string",
   "physicalEndpoints": [ 
      { 
         "awsLocation": { 
            "accessRole": "string",
            "awsAccountId": "string",
            "awsRegion": "string",
            "iamConnectionId": "string"
         },
         "enableTrustedIdentityPropagation": boolean,
         "glueConnection": { 
            "athenaProperties": { 
               "string" : "string" 
            },
            "authenticationConfiguration": { 
               "authenticationType": "string",
               "oAuth2Properties": { 
                  "authorizationCodeProperties": { 
                     "authorizationCode": "string",
                     "redirectUri": "string"
                  },
                  "oAuth2ClientApplication": { 
                     "aWSManagedClientApplicationReference": "string",
                     "userManagedClientApplicationClientId": "string"
                  },
                  "oAuth2Credentials": { 
                     "accessToken": "string",
                     "jwtToken": "string",
                     "refreshToken": "string",
                     "userManagedClientApplicationClientSecret": "string"
                  },
                  "oAuth2GrantType": "string",
                  "tokenUrl": "string",
                  "tokenUrlParametersMap": { 
                     "string" : "string" 
                  }
               },
               "secretArn": "string"
            },
            "compatibleComputeEnvironments": [ "string" ],
            "connectionProperties": { 
               "string" : "string" 
            },
            "connectionSchemaVersion": number,
            "connectionType": "string",
            "creationTime": number,
            "description": "string",
            "lastConnectionValidationTime": number,
            "lastUpdatedBy": "string",
            "lastUpdatedTime": number,
            "matchCriteria": [ "string" ],
            "name": "string",
            "physicalConnectionRequirements": { 
               "availabilityZone": "string",
               "securityGroupIdList": [ "string" ],
               "subnetId": "string",
               "subnetIdList": [ "string" ]
            },
            "pythonProperties": { 
               "string" : "string" 
            },
            "sparkProperties": { 
               "string" : "string" 
            },
            "status": "string",
            "statusReason": "string"
         },
         "glueConnectionName": "string",
         "glueConnectionNames": [ "string" ],
         "host": "string",
         "port": number,
         "protocol": "string",
         "stage": "string"
      }
   ],
   "projectId": "string",
   "props": { ... },
   "scope": "string",
   "type": "string"
}
```

## Response Elements
<a name="API_CreateConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [configurations](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-configurations"></a>
The configurations of the connection.  
Type: Array of [Configuration](API_Configuration.md) objects

 ** [connectionId](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-connectionId"></a>
The ID of the connection.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.

 ** [description](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-description"></a>
The connection description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-domainId"></a>
The ID of the domain where the connection is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-domainUnitId"></a>
The ID of the domain unit where the connection is created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentId](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-environmentId"></a>
The ID of the environment where the connection is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-name"></a>
The connection name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.

 ** [physicalEndpoints](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-physicalEndpoints"></a>
The physical endpoints of the connection.  
Type: Array of [PhysicalEndpoint](API_PhysicalEndpoint.md) objects

 ** [projectId](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-projectId"></a>
The ID of the project where the connection is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [props](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-props"></a>
The connection props.  
Type: [ConnectionPropertiesOutput](API_ConnectionPropertiesOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [scope](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-scope"></a>
The scope of the connection.  
Type: String  
Valid Values: `DOMAIN | PROJECT` 

 ** [type](#API_CreateConnection_ResponseSyntax) **   <a name="datazone-CreateConnection-response-type"></a>
The connection type.  
Type: String  
Valid Values: `ATHENA | BIGQUERY | DATABRICKS | DOCUMENTDB | DYNAMODB | HYPERPOD | IAM | MYSQL | OPENSEARCH | ORACLE | POSTGRESQL | REDSHIFT | S3 | SAPHANA | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | VERTICA | WORKFLOWS_MWAA | AMAZON_Q | MLFLOW` 

## Errors
<a name="API_CreateConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateConnection) 

# CreateDataProduct
<a name="API_CreateDataProduct"></a>

Creates a data product.

A data product is a comprehensive package that combines data assets with their associated metadata, documentation, and access controls. It's designed to serve specific business needs or use cases, making it easier for users to find and consume data appropriately. Data products include important information about data quality, freshness, and usage guidelines, effectively bridging the gap between data producers and consumers while ensuring proper governance.

Prerequisites:
+ The domain must exist and be accessible. 
+ The owning project must be valid and active.
+ The name must be unique within the domain (no existing data product with the same name).
+ User must have create permissions for data products in the project.

## Request Syntax
<a name="API_CreateDataProduct_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/data-products HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "formsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "items": [ 
      { 
         "glossaryTerms": [ "string" ],
         "identifier": "string",
         "itemType": "string",
         "revision": "string"
      }
   ],
   "name": "string",
   "owningProjectIdentifier": "string"
}
```

## URI Request Parameters
<a name="API_CreateDataProduct_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-uri-domainIdentifier"></a>
The ID of the domain where the data product is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateDataProduct_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-description"></a>
The description of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [formsInput](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-formsInput"></a>
The metadata forms of the data product.  
Type: Array of [FormInput](API_FormInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [glossaryTerms](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-glossaryTerms"></a>
The glossary terms of the data product.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [items](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-items"></a>
The data assets of the data product.  
Type: Array of [DataProductItem](API_DataProductItem.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [name](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-name"></a>
The name of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

 ** [owningProjectIdentifier](#API_CreateDataProduct_RequestSyntax) **   <a name="datazone-CreateDataProduct-request-owningProjectIdentifier"></a>
The ID of the owning project of the data product.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Response Syntax
<a name="API_CreateDataProduct_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "items": [ 
      { 
         "glossaryTerms": [ "string" ],
         "identifier": "string",
         "itemType": "string",
         "revision": "string"
      }
   ],
   "name": "string",
   "owningProjectId": "string",
   "revision": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateDataProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-createdAt"></a>
The timestamp at which the data product was created.  
Type: Timestamp

 ** [createdBy](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-createdBy"></a>
The user who created the data product.  
Type: String

 ** [description](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-description"></a>
The description of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-domainId"></a>
The ID of the domain where the data product lives.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [firstRevisionCreatedAt](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-firstRevisionCreatedAt"></a>
The timestamp at which the first revision of the data product was created.  
Type: Timestamp

 ** [firstRevisionCreatedBy](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-firstRevisionCreatedBy"></a>
The user who created the first revision of the data product.  
Type: String

 ** [formsOutput](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-formsOutput"></a>
The metadata forms of the data product.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [glossaryTerms](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-glossaryTerms"></a>
The glossary terms of the data product.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-id"></a>
The ID of the data product.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [items](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-items"></a>
The data assets of the data product.  
Type: Array of [DataProductItem](API_DataProductItem.md) objects  
Array Members: Minimum number of 1 item.

 ** [name](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-name"></a>
The name of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [owningProjectId](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-owningProjectId"></a>
The ID of the owning project of the data product.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-revision"></a>
The revision of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [status](#API_CreateDataProduct_ResponseSyntax) **   <a name="datazone-CreateDataProduct-response-status"></a>
The status of the data product.  
Type: String  
Valid Values: `CREATED | CREATING | CREATE_FAILED` 

## Errors
<a name="API_CreateDataProduct_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDataProduct_Examples"></a>

### Example
<a name="API_CreateDataProduct_Example_1"></a>

This example illustrates one usage of CreateDataProduct.

#### Sample Request
<a name="API_CreateDataProduct_Example_1_Request"></a>

```
aws datazone create-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerInsightsDataProduct" \
--owning-project-identifier "prj7nx82mkl"
```

#### Sample Response
<a name="API_CreateDataProduct_Example_1_Response"></a>

```
{
    "createdAt": 1752602810.307,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752602810.307,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [],
    "id": "dpd9m3nqx2wkfp",
    "name": "CustomerInsightsDataProduct",
    "owningProjectId": "prj7nx82mkl",
    "revision": "1",
    "status": "CREATED"
}
```

### Example
<a name="API_CreateDataProduct_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_CreateDataProduct_Example_2_Request"></a>

```
aws datazone create-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerInsightsDataProduct"
```

#### Sample Response
<a name="API_CreateDataProduct_Example_2_Response"></a>

```
aws: error: the following arguments are required: —owning-project-identifier
```

### Example
<a name="API_CreateDataProduct_Example_3"></a>

Failure case - duplicate term:

#### Sample Request
<a name="API_CreateDataProduct_Example_3_Request"></a>

```
aws datazone create-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerInsightsDataProduct" \
--owning-project-identifier "prj7nx82mkl"
```

#### Sample Response
<a name="API_CreateDataProduct_Example_3_Response"></a>

```
An error occurred (ConflictException) when calling the CreateDataProduct operation: Conflict with dataProduct c5rerxaqjys59j
```

## See Also
<a name="API_CreateDataProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateDataProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateDataProduct) 

# CreateDataProductRevision
<a name="API_CreateDataProductRevision"></a>

Creates a data product revision.

Prerequisites:
+ The original data product must exist in the given domain. 
+ User must have permissions on the data product.
+ The domain must be valid and accessible.
+ The new revision name must comply with naming constraints (if required).

## Request Syntax
<a name="API_CreateDataProductRevision_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/data-products/identifier/revisions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "formsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "items": [ 
      { 
         "glossaryTerms": [ "string" ],
         "identifier": "string",
         "itemType": "string",
         "revision": "string"
      }
   ],
   "name": "string"
}
```

## URI Request Parameters
<a name="API_CreateDataProductRevision_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-uri-domainIdentifier"></a>
The ID of the domain where the data product revision is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-uri-identifier"></a>
The ID of the data product revision.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateDataProductRevision_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-description"></a>
The description of the data product revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [formsInput](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-formsInput"></a>
The metadata forms of the data product revision.  
Type: Array of [FormInput](API_FormInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [glossaryTerms](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-glossaryTerms"></a>
The glossary terms of the data product revision.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [items](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-items"></a>
The data assets of the data product revision.  
Type: Array of [DataProductItem](API_DataProductItem.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** [name](#API_CreateDataProductRevision_RequestSyntax) **   <a name="datazone-CreateDataProductRevision-request-name"></a>
The name of the data product revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: Yes

## Response Syntax
<a name="API_CreateDataProductRevision_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "items": [ 
      { 
         "glossaryTerms": [ "string" ],
         "identifier": "string",
         "itemType": "string",
         "revision": "string"
      }
   ],
   "name": "string",
   "owningProjectId": "string",
   "revision": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateDataProductRevision_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-createdAt"></a>
The timestamp at which the data product revision is created.  
Type: Timestamp

 ** [createdBy](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-createdBy"></a>
The user who created the data product revision.  
Type: String

 ** [description](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-description"></a>
The description of the data product revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-domainId"></a>
The ID of the domain where data product revision is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [firstRevisionCreatedAt](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-firstRevisionCreatedAt"></a>
The timestamp at which the first revision of the data product is created.  
Type: Timestamp

 ** [firstRevisionCreatedBy](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-firstRevisionCreatedBy"></a>
The user who created the first revision of the data product.  
Type: String

 ** [formsOutput](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-formsOutput"></a>
The metadata forms of the data product revision.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [glossaryTerms](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-glossaryTerms"></a>
The glossary terms of the data product revision.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-id"></a>
The ID of the data product revision.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [items](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-items"></a>
The data assets of the data product revision.  
Type: Array of [DataProductItem](API_DataProductItem.md) objects  
Array Members: Minimum number of 1 item.

 ** [name](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-name"></a>
The name of the data product revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [owningProjectId](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-owningProjectId"></a>
The ID of the owning project of the data product revision.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-revision"></a>
The revision of the data product revision.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [status](#API_CreateDataProductRevision_ResponseSyntax) **   <a name="datazone-CreateDataProductRevision-response-status"></a>
The status of the data product revision.  
Type: String  
Valid Values: `CREATED | CREATING | CREATE_FAILED` 

## Errors
<a name="API_CreateDataProductRevision_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateDataProductRevision_Examples"></a>

### Example
<a name="API_CreateDataProductRevision_Example_1"></a>

This example illustrates one usage of CreateDataProductRevision.

#### Sample Request
<a name="API_CreateDataProductRevision_Example_1_Request"></a>

```
aws datazone create-data-product-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd9m3nqx2wkfp" \
--name "CustomerInsights-v2"
```

#### Sample Response
<a name="API_CreateDataProductRevision_Example_1_Response"></a>

```
{
    "createdAt": 1752602995.424,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752602810.307,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [],
    "id": "dpd9m3nqx2wkfp",
    "name": "CustomerInsights-v2",
    "owningProjectId": "prj7nx82mkl",
    "revision": "2",
    "status": "CREATED"
}
```

### Example
<a name="API_CreateDataProductRevision_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_CreateDataProductRevision_Example_2_Request"></a>

```
aws datazone create-data-product-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerInsights-v2"
```

#### Sample Response
<a name="API_CreateDataProductRevision_Example_2_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

### Example
<a name="API_CreateDataProductRevision_Example_3"></a>

Failure case - resource not found:

#### Sample Request
<a name="API_CreateDataProductRevision_Example_3_Request"></a>

```
aws datazone create-data-product-revision \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd_nonexistent" \
--name "CustomerInsights-v2"
```

#### Sample Response
<a name="API_CreateDataProductRevision_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the CreateDataProductRevision operation: Requested dataProduct cannot be found in domain
```

## See Also
<a name="API_CreateDataProductRevision_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateDataProductRevision) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateDataProductRevision) 

# CreateDataSource
<a name="API_CreateDataSource"></a>

Creates an Amazon DataZone data source.

## Request Syntax
<a name="API_CreateDataSource_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/data-sources HTTP/1.1
Content-type: application/json

{
   "assetFormsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "clientToken": "string",
   "configuration": { ... },
   "connectionIdentifier": "string",
   "description": "string",
   "enableSetting": "string",
   "environmentIdentifier": "string",
   "name": "string",
   "projectIdentifier": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "type": "string"
}
```

## URI Request Parameters
<a name="API_CreateDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where the data source is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateDataSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetFormsInput](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-assetFormsInput"></a>
The metadata forms that are to be attached to the assets that this data source works with.  
Type: Array of [FormInput](API_FormInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [clientToken](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [configuration](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-configuration"></a>
Specifies the configuration of the data source. It can be set to either `glueRunConfiguration` or `redshiftRunConfiguration`.  
Type: [DataSourceConfigurationInput](API_DataSourceConfigurationInput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [connectionIdentifier](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-connectionIdentifier"></a>
The ID of the connection.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [description](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-description"></a>
The description of the data source.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [enableSetting](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-enableSetting"></a>
Specifies whether the data source is enabled.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [environmentIdentifier](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-environmentIdentifier"></a>
The unique identifier of the Amazon DataZone environment to which the data source publishes assets.   
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [name](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-name"></a>
The name of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [projectIdentifier](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-projectIdentifier"></a>
The identifier of the Amazon DataZone project in which you want to add this data source.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [publishOnImport](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-publishOnImport"></a>
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.  
Type: Boolean  
Required: No

 ** [recommendation](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-recommendation"></a>
Specifies whether the business name generation is to be enabled for this data source.  
Type: [RecommendationConfiguration](API_RecommendationConfiguration.md) object  
Required: No

 ** [schedule](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-schedule"></a>
The schedule of the data source runs.  
Type: [ScheduleConfiguration](API_ScheduleConfiguration.md) object  
Required: No

 ** [type](#API_CreateDataSource_RequestSyntax) **   <a name="datazone-CreateDataSource-request-type"></a>
The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for AWS Glue and Amazon Redshift.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_CreateDataSource_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "assetFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "configuration": { ... },
   "connectionId": "string",
   "createdAt": "string",
   "description": "string",
   "domainId": "string",
   "enableSetting": "string",
   "environmentId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "lastRunAt": "string",
   "lastRunErrorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "lastRunStatus": "string",
   "name": "string",
   "projectId": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "status": "string",
   "type": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_CreateDataSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [assetFormsOutput](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-assetFormsOutput"></a>
The metadata forms attached to the assets that this data source creates.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [configuration](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-configuration"></a>
Specifies the configuration of the data source. It can be set to either `glueRunConfiguration` or `redshiftRunConfiguration`.  
Type: [DataSourceConfigurationOutput](API_DataSourceConfigurationOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [connectionId](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-connectionId"></a>
The ID of the connection.  
Type: String

 ** [createdAt](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-createdAt"></a>
The timestamp of when the data source was created.  
Type: Timestamp

 ** [description](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-description"></a>
The description of the data source.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-domainId"></a>
The ID of the Amazon DataZone domain in which the data source is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [enableSetting](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-enableSetting"></a>
Specifies whether the data source is enabled.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [environmentId](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-environmentId"></a>
The unique identifier of the Amazon DataZone environment to which the data source publishes assets.   
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [errorMessage](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-errorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [id](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-id"></a>
The unique identifier of the data source.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastRunAt](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-lastRunAt"></a>
The timestamp that specifies when the data source was last run.  
Type: Timestamp

 ** [lastRunErrorMessage](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-lastRunErrorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [lastRunStatus](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-lastRunStatus"></a>
The status of the last run of this data source.  
Type: String  
Valid Values: `REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS` 

 ** [name](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-name"></a>
The name of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [projectId](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-projectId"></a>
The ID of the Amazon DataZone project to which the data source is added.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [publishOnImport](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-publishOnImport"></a>
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.  
Type: Boolean

 ** [recommendation](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-recommendation"></a>
Specifies whether the business name generation is to be enabled for this data source.  
Type: [RecommendationConfiguration](API_RecommendationConfiguration.md) object

 ** [schedule](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-schedule"></a>
The schedule of the data source runs.  
Type: [ScheduleConfiguration](API_ScheduleConfiguration.md) object

 ** [status](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-status"></a>
The status of the data source.  
Type: String  
Valid Values: `CREATING | FAILED_CREATION | READY | UPDATING | FAILED_UPDATE | RUNNING | DELETING | FAILED_DELETION` 

 ** [type](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-type"></a>
The type of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [updatedAt](#API_CreateDataSource_ResponseSyntax) **   <a name="datazone-CreateDataSource-response-updatedAt"></a>
The timestamp of when the data source was updated.  
Type: Timestamp

## Errors
<a name="API_CreateDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateDataSource) 

# CreateDomain
<a name="API_CreateDomain"></a>

Creates an Amazon DataZone domain.

## Request Syntax
<a name="API_CreateDomain_RequestSyntax"></a>

```
POST /v2/domains HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "domainExecutionRole": "string",
   "domainVersion": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "idcInstanceArn": "string",
      "type": "string",
      "userAssignment": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateDomain_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [description](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-description"></a>
The description of the Amazon DataZone domain.  
Type: String  
Required: No

 ** [domainExecutionRole](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-domainExecutionRole"></a>
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+`   
Required: No

 ** [domainVersion](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-domainVersion"></a>
The version of the domain that is created.  
Type: String  
Valid Values: `V1 | V2`   
Required: No

 ** [kmsKeyIdentifier](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-kmsKeyIdentifier"></a>
The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`   
Required: No

 ** [name](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-name"></a>
The name of the Amazon DataZone domain.  
Type: String  
Required: Yes

 ** [serviceRole](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-serviceRole"></a>
The service role of the domain that is created.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+`   
Required: No

 ** [singleSignOn](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-singleSignOn"></a>
The single-sign on configuration of the Amazon DataZone domain.  
Type: [SingleSignOn](API_SingleSignOn.md) object  
Required: No

 ** [tags](#API_CreateDomain_RequestSyntax) **   <a name="datazone-CreateDomain-request-tags"></a>
The tags specified for the Amazon DataZone domain.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\w \.:/=+@-]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `[\w \.:/=+@-]*`   
Required: No

## Response Syntax
<a name="API_CreateDomain_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "description": "string",
   "domainExecutionRole": "string",
   "domainVersion": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "name": "string",
   "portalUrl": "string",
   "rootDomainUnitId": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "idcInstanceArn": "string",
      "type": "string",
      "userAssignment": "string"
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_CreateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-arn"></a>
The ARN of the Amazon DataZone domain.  
Type: String

 ** [description](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-description"></a>
The description of the Amazon DataZone domain.  
Type: String

 ** [domainExecutionRole](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-domainExecutionRole"></a>
The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the AWS account that houses the Amazon DataZone domain.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [domainVersion](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-domainVersion"></a>
The version of the domain that is created.  
Type: String  
Valid Values: `V1 | V2` 

 ** [id](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-id"></a>
The identifier of the Amazon DataZone domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [kmsKeyIdentifier](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-kmsKeyIdentifier"></a>
The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [name](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-name"></a>
The name of the Amazon DataZone domain.  
Type: String

 ** [portalUrl](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-portalUrl"></a>
The URL of the data portal for this Amazon DataZone domain.  
Type: String

 ** [rootDomainUnitId](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-rootDomainUnitId"></a>
The ID of the root domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [serviceRole](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-serviceRole"></a>
Te service role of the domain that is created.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [singleSignOn](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-singleSignOn"></a>
The single-sign on configuration of the Amazon DataZone domain.  
Type: [SingleSignOn](API_SingleSignOn.md) object

 ** [status](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-status"></a>
The status of the Amazon DataZone domain.  
Type: String  
Valid Values: `CREATING | AVAILABLE | CREATION_FAILED | DELETING | DELETED | DELETION_FAILED` 

 ** [tags](#API_CreateDomain_ResponseSyntax) **   <a name="datazone-CreateDomain-response-tags"></a>
The tags specified for the Amazon DataZone domain.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\w \.:/=+@-]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `[\w \.:/=+@-]*` 

## Errors
<a name="API_CreateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateDomain) 

# CreateDomainUnit
<a name="API_CreateDomainUnit"></a>

Creates a domain unit in Amazon DataZone.

## Request Syntax
<a name="API_CreateDomainUnit_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/domain-units HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "parentDomainUnitIdentifier": "string"
}
```

## URI Request Parameters
<a name="API_CreateDomainUnit_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateDomainUnit_RequestSyntax) **   <a name="datazone-CreateDomainUnit-request-uri-domainIdentifier"></a>
The ID of the domain where you want to crate a domain unit.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateDomainUnit_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateDomainUnit_RequestSyntax) **   <a name="datazone-CreateDomainUnit-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_CreateDomainUnit_RequestSyntax) **   <a name="datazone-CreateDomainUnit-request-description"></a>
The description of the domain unit.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [name](#API_CreateDomainUnit_RequestSyntax) **   <a name="datazone-CreateDomainUnit-request-name"></a>
The name of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w -]+`   
Required: Yes

 ** [parentDomainUnitIdentifier](#API_CreateDomainUnit_RequestSyntax) **   <a name="datazone-CreateDomainUnit-request-parentDomainUnitIdentifier"></a>
The ID of the parent domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: Yes

## Response Syntax
<a name="API_CreateDomainUnit_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "ancestorDomainUnitIds": [ "string" ],
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "id": "string",
   "name": "string",
   "owners": [ 
      { ... }
   ],
   "parentDomainUnitId": "string"
}
```

## Response Elements
<a name="API_CreateDomainUnit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [ancestorDomainUnitIds](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-ancestorDomainUnitIds"></a>
The IDs of the ancestor domain units.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [createdAt](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-createdAt"></a>
The timestamp at which the domain unit was created.  
Type: Timestamp

 ** [createdBy](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-createdBy"></a>
The user who created the domain unit.  
Type: String

 ** [description](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-description"></a>
The description of the domain unit.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-domainId"></a>
The ID of the domain where the domain unit was created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-id"></a>
The ID of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [name](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-name"></a>
The name of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w -]+` 

 ** [owners](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-owners"></a>
The owners of the domain unit.  
Type: Array of [DomainUnitOwnerProperties](API_DomainUnitOwnerProperties.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [parentDomainUnitId](#API_CreateDomainUnit_ResponseSyntax) **   <a name="datazone-CreateDomainUnit-response-parentDomainUnitId"></a>
The ID of the parent domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

## Errors
<a name="API_CreateDomainUnit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateDomainUnit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateDomainUnit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateDomainUnit) 

# CreateEnvironment
<a name="API_CreateEnvironment"></a>

Create an Amazon DataZone environment.

## Request Syntax
<a name="API_CreateEnvironment_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/environments HTTP/1.1
Content-type: application/json

{
   "deploymentOrder": number,
   "description": "string",
   "environmentAccountIdentifier": "string",
   "environmentAccountRegion": "string",
   "environmentBlueprintIdentifier": "string",
   "environmentConfigurationId": "string",
   "environmentConfigurationName": "string",
   "environmentProfileIdentifier": "string",
   "glossaryTerms": [ "string" ],
   "name": "string",
   "projectIdentifier": "string",
   "userParameters": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which the environment is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateEnvironment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [deploymentOrder](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-deploymentOrder"></a>
The deployment order of the environment.  
Type: Integer  
Required: No

 ** [description](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-description"></a>
The description of the Amazon DataZone environment.  
Type: String  
Required: No

 ** [environmentAccountIdentifier](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-environmentAccountIdentifier"></a>
The ID of the account in which the environment is being created.  
Type: String  
Required: No

 ** [environmentAccountRegion](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-environmentAccountRegion"></a>
The region of the account in which the environment is being created.  
Type: String  
Required: No

 ** [environmentBlueprintIdentifier](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-environmentBlueprintIdentifier"></a>
The ID of the blueprint with which the environment is being created.  
Type: String  
Required: No

 ** [environmentConfigurationId](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-environmentConfigurationId"></a>
The configuration ID of the environment.  
Type: String  
Required: No

 ** [environmentConfigurationName](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-environmentConfigurationName"></a>
The configuration name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: No

 ** [environmentProfileIdentifier](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-environmentProfileIdentifier"></a>
The identifier of the environment profile that is used to create this Amazon DataZone environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{0,36}`   
Required: No

 ** [glossaryTerms](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-glossaryTerms"></a>
The glossary terms that can be used in this Amazon DataZone environment.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [name](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-name"></a>
The name of the Amazon DataZone environment.  
Type: String  
Required: Yes

 ** [projectIdentifier](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-projectIdentifier"></a>
The identifier of the Amazon DataZone project in which this environment is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [userParameters](#API_CreateEnvironment_RequestSyntax) **   <a name="datazone-CreateEnvironment-request-userParameters"></a>
The user parameters of this Amazon DataZone environment.  
Type: Array of [EnvironmentParameter](API_EnvironmentParameter.md) objects  
Required: No

## Response Syntax
<a name="API_CreateEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "deploymentProperties": { 
      "endTimeoutMinutes": number,
      "startTimeoutMinutes": number
   },
   "description": "string",
   "domainId": "string",
   "environmentActions": [ 
      { 
         "auth": "string",
         "parameters": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "type": "string"
      }
   ],
   "environmentBlueprintId": "string",
   "environmentConfigurationId": "string",
   "environmentConfigurationName": "string",
   "environmentProfileId": "string",
   "glossaryTerms": [ "string" ],
   "id": "string",
   "lastDeployment": { 
      "deploymentId": "string",
      "deploymentStatus": "string",
      "deploymentType": "string",
      "failureReason": { 
         "code": "string",
         "message": "string"
      },
      "isDeploymentComplete": boolean,
      "messages": [ "string" ]
   },
   "name": "string",
   "projectId": "string",
   "provider": "string",
   "provisionedResources": [ 
      { 
         "name": "string",
         "provider": "string",
         "type": "string",
         "value": "string"
      }
   ],
   "provisioningProperties": { ... },
   "status": "string",
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreateEnvironment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [awsAccountId](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-awsAccountId"></a>
The AWS account in which the Amazon DataZone environment is created.  
Type: String  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-awsAccountRegion"></a>
The AWS region in which the Amazon DataZone environment is created.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [createdAt](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-createdAt"></a>
The timestamp of when the environment was created.  
Type: Timestamp

 ** [createdBy](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-createdBy"></a>
The Amazon DataZone user who created this environment.  
Type: String

 ** [deploymentProperties](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-deploymentProperties"></a>
The deployment properties of this Amazon DataZone environment.  
Type: [DeploymentProperties](API_DeploymentProperties.md) object

 ** [description](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-description"></a>
The description of this Amazon DataZone environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-domainId"></a>
The identifier of the Amazon DataZone domain in which the environment is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentActions](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-environmentActions"></a>
The configurable actions of this Amazon DataZone environment.  
Type: Array of [ConfigurableEnvironmentAction](API_ConfigurableEnvironmentAction.md) objects

 ** [environmentBlueprintId](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-environmentBlueprintId"></a>
The ID of the blueprint with which this Amazon DataZone environment was created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentConfigurationId](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-environmentConfigurationId"></a>
The configuration ID of the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentConfigurationName](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-environmentConfigurationName"></a>
The configuration name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [environmentProfileId](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-environmentProfileId"></a>
The ID of the environment profile with which this Amazon DataZone environment was created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{0,36}` 

 ** [glossaryTerms](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-glossaryTerms"></a>
The glossary terms that can be used in this Amazon DataZone environment.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-id"></a>
The ID of this Amazon DataZone environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastDeployment](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-lastDeployment"></a>
The details of the last deployment of this Amazon DataZone environment.  
Type: [Deployment](API_Deployment.md) object

 ** [name](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-name"></a>
The name of this environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectId](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-projectId"></a>
The ID of the Amazon DataZone project in which this environment is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [provider](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-provider"></a>
The provider of this Amazon DataZone environment.  
Type: String

 ** [provisionedResources](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-provisionedResources"></a>
The provisioned resources of this Amazon DataZone environment.  
Type: Array of [Resource](API_Resource.md) objects

 ** [provisioningProperties](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-provisioningProperties"></a>
The provisioning properties of this Amazon DataZone environment.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-status"></a>
The status of this Amazon DataZone environment.  
Type: String  
Valid Values: `ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | VALIDATION_FAILED | SUSPENDED | DISABLED | EXPIRED | DELETED | INACCESSIBLE` 

 ** [updatedAt](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-updatedAt"></a>
The timestamp of when this environment was updated.  
Type: Timestamp

 ** [userParameters](#API_CreateEnvironment_ResponseSyntax) **   <a name="datazone-CreateEnvironment-response-userParameters"></a>
The user parameters of this Amazon DataZone environment.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_CreateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateEnvironment) 

# CreateEnvironmentAction
<a name="API_CreateEnvironmentAction"></a>

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

## Request Syntax
<a name="API_CreateEnvironmentAction_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/environments/environmentIdentifier/actions HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "parameters": { ... }
}
```

## URI Request Parameters
<a name="API_CreateEnvironmentAction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateEnvironmentAction_RequestSyntax) **   <a name="datazone-CreateEnvironmentAction-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the environment action is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_CreateEnvironmentAction_RequestSyntax) **   <a name="datazone-CreateEnvironmentAction-request-uri-environmentIdentifier"></a>
The ID of the environment in which the environment action is created.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateEnvironmentAction_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateEnvironmentAction_RequestSyntax) **   <a name="datazone-CreateEnvironmentAction-request-description"></a>
The description of the environment action that is being created in the environment.  
Type: String  
Required: No

 ** [name](#API_CreateEnvironmentAction_RequestSyntax) **   <a name="datazone-CreateEnvironmentAction-request-name"></a>
The name of the environment action.  
Type: String  
Required: Yes

 ** [parameters](#API_CreateEnvironmentAction_RequestSyntax) **   <a name="datazone-CreateEnvironmentAction-request-parameters"></a>
The parameters of the environment action.  
Type: [ActionParameters](API_ActionParameters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_CreateEnvironmentAction_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "name": "string",
   "parameters": { ... }
}
```

## Response Elements
<a name="API_CreateEnvironmentAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [description](#API_CreateEnvironmentAction_ResponseSyntax) **   <a name="datazone-CreateEnvironmentAction-response-description"></a>
The description of the environment action.  
Type: String

 ** [domainId](#API_CreateEnvironmentAction_ResponseSyntax) **   <a name="datazone-CreateEnvironmentAction-response-domainId"></a>
The ID of the domain in which the environment action is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_CreateEnvironmentAction_ResponseSyntax) **   <a name="datazone-CreateEnvironmentAction-response-environmentId"></a>
The ID of the environment in which the environment is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateEnvironmentAction_ResponseSyntax) **   <a name="datazone-CreateEnvironmentAction-response-id"></a>
The ID of the environment action.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_CreateEnvironmentAction_ResponseSyntax) **   <a name="datazone-CreateEnvironmentAction-response-name"></a>
The name of the environment action.  
Type: String

 ** [parameters](#API_CreateEnvironmentAction_ResponseSyntax) **   <a name="datazone-CreateEnvironmentAction-response-parameters"></a>
The parameters of the environment action.  
Type: [ActionParameters](API_ActionParameters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

## Errors
<a name="API_CreateEnvironmentAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateEnvironmentAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateEnvironmentAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateEnvironmentAction) 

# CreateEnvironmentBlueprint
<a name="API_CreateEnvironmentBlueprint"></a>

Creates a Amazon DataZone blueprint.

## Request Syntax
<a name="API_CreateEnvironmentBlueprint_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/environment-blueprints HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "provisioningProperties": { ... },
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateEnvironmentBlueprint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-request-uri-domainIdentifier"></a>
The identifier of the domain in which this blueprint is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateEnvironmentBlueprint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-request-description"></a>
The description of the Amazon DataZone blueprint.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [name](#API_CreateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-request-name"></a>
The name of this Amazon DataZone blueprint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: Yes

 ** [provisioningProperties](#API_CreateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-request-provisioningProperties"></a>
The provisioning properties of this Amazon DataZone blueprint.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [userParameters](#API_CreateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-request-userParameters"></a>
The user parameters of this Amazon DataZone blueprint.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects  
Required: No

## Response Syntax
<a name="API_CreateEnvironmentBlueprint_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": "string",
   "deploymentProperties": { 
      "endTimeoutMinutes": number,
      "startTimeoutMinutes": number
   },
   "description": "string",
   "glossaryTerms": [ "string" ],
   "id": "string",
   "name": "string",
   "provider": "string",
   "provisioningProperties": { ... },
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreateEnvironmentBlueprint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-createdAt"></a>
The timestamp at which the environment blueprint was created.  
Type: Timestamp

 ** [deploymentProperties](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-deploymentProperties"></a>
The deployment properties of this Amazon DataZone blueprint.  
Type: [DeploymentProperties](API_DeploymentProperties.md) object

 ** [description](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-description"></a>
The description of this Amazon DataZone blueprint.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [glossaryTerms](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-glossaryTerms"></a>
The glossary terms attached to this Amazon DataZone blueprint.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-id"></a>
The ID of this Amazon DataZone blueprint.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-name"></a>
The name of this Amazon DataZone blueprint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [provider](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-provider"></a>
The provider of this Amazon DataZone blueprint.  
Type: String

 ** [provisioningProperties](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-provisioningProperties"></a>
The provisioning properties of this Amazon DataZone blueprint.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [updatedAt](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-updatedAt"></a>
The timestamp of when this blueprint was updated.  
Type: Timestamp

 ** [userParameters](#API_CreateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-CreateEnvironmentBlueprint-response-userParameters"></a>
The user parameters of this Amazon DataZone blueprint.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_CreateEnvironmentBlueprint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateEnvironmentBlueprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateEnvironmentBlueprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateEnvironmentBlueprint) 

# CreateEnvironmentProfile
<a name="API_CreateEnvironmentProfile"></a>

Creates an Amazon DataZone environment profile.

## Request Syntax
<a name="API_CreateEnvironmentProfile_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/environment-profiles HTTP/1.1
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "description": "string",
   "environmentBlueprintIdentifier": "string",
   "name": "string",
   "projectIdentifier": "string",
   "userParameters": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateEnvironmentProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this environment profile is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateEnvironmentProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [awsAccountId](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-awsAccountId"></a>
The AWS account in which the Amazon DataZone environment is created.  
Type: String  
Pattern: `\d{12}`   
Required: No

 ** [awsAccountRegion](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-awsAccountRegion"></a>
The AWS region in which this environment profile is created.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d`   
Required: No

 ** [description](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-description"></a>
The description of this Amazon DataZone environment profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [environmentBlueprintIdentifier](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-environmentBlueprintIdentifier"></a>
The ID of the blueprint with which this environment profile is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [name](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-name"></a>
The name of this Amazon DataZone environment profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: Yes

 ** [projectIdentifier](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-projectIdentifier"></a>
The identifier of the project in which to create the environment profile.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [userParameters](#API_CreateEnvironmentProfile_RequestSyntax) **   <a name="datazone-CreateEnvironmentProfile-request-userParameters"></a>
The user parameters of this Amazon DataZone environment profile.  
Type: Array of [EnvironmentParameter](API_EnvironmentParameter.md) objects  
Required: No

## Response Syntax
<a name="API_CreateEnvironmentProfile_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "environmentBlueprintId": "string",
   "id": "string",
   "name": "string",
   "projectId": "string",
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreateEnvironmentProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [awsAccountId](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-awsAccountId"></a>
The AWS account ID in which this Amazon DataZone environment profile is created.  
Type: String  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-awsAccountRegion"></a>
The AWS region in which this Amazon DataZone environment profile is created.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [createdAt](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-createdAt"></a>
The timestamp of when this environment profile was created.  
Type: Timestamp

 ** [createdBy](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-createdBy"></a>
The Amazon DataZone user who created this environment profile.  
Type: String

 ** [description](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-description"></a>
The description of this Amazon DataZone environment profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-domainId"></a>
The ID of the Amazon DataZone domain in which this environment profile is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentBlueprintId](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-environmentBlueprintId"></a>
The ID of the blueprint with which this environment profile is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-id"></a>
The ID of this Amazon DataZone environment profile.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{0,36}` 

 ** [name](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-name"></a>
The name of this Amazon DataZone environment profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectId](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-projectId"></a>
The ID of the Amazon DataZone project in which this environment profile is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-updatedAt"></a>
The timestamp of when this environment profile was updated.  
Type: Timestamp

 ** [userParameters](#API_CreateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-CreateEnvironmentProfile-response-userParameters"></a>
The user parameters of this Amazon DataZone environment profile.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_CreateEnvironmentProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateEnvironmentProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateEnvironmentProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateEnvironmentProfile) 

# CreateFormType
<a name="API_CreateFormType"></a>

Creates a metadata form type.

Prerequisites:
+ The domain must exist and be in an `ENABLED` state. 
+ The owning project must exist and be accessible.
+ The name must be unique within the domain.

For custom form types, to indicate that a field should be searchable, annotate it with `@amazon.datazone#searchable`. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. To indicate that a field should be indexed for lexical search (which disables semantic search but supports stemmed and partial matches), annotate it with `@amazon.datazone#searchable(modes:["LEXICAL"])`. To indicate that a field should be indexed for technical identifier search (for more information on technical identifier search, see: [https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/](https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/)), annotate it with `@amazon.datazone#searchable(modes:["TECHNICAL"])`.

To denote that a field will store glossary term ids (which are filterable via the Search/SearchListings APIs), annotate it with `@amazon.datazone#glossaryterm("${GLOSSARY_ID}")`, where `${GLOSSARY_ID}` is the id of the glossary that the glossary terms stored in the field belong to. 

## Request Syntax
<a name="API_CreateFormType_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/form-types HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "model": { ... },
   "name": "string",
   "owningProjectIdentifier": "string",
   "status": "string"
}
```

## URI Request Parameters
<a name="API_CreateFormType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateFormType_RequestSyntax) **   <a name="datazone-CreateFormType-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this metadata form type is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateFormType_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateFormType_RequestSyntax) **   <a name="datazone-CreateFormType-request-description"></a>
The description of this Amazon DataZone metadata form type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [model](#API_CreateFormType_RequestSyntax) **   <a name="datazone-CreateFormType-request-model"></a>
The model of this Amazon DataZone metadata form type.  
Type: [Model](API_Model.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [name](#API_CreateFormType_RequestSyntax) **   <a name="datazone-CreateFormType-request-name"></a>
The name of this Amazon DataZone metadata form type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*`   
Required: Yes

 ** [owningProjectIdentifier](#API_CreateFormType_RequestSyntax) **   <a name="datazone-CreateFormType-request-owningProjectIdentifier"></a>
The ID of the Amazon DataZone project that owns this metadata form type.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [status](#API_CreateFormType_RequestSyntax) **   <a name="datazone-CreateFormType-request-status"></a>
The status of this Amazon DataZone metadata form type.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Syntax
<a name="API_CreateFormType_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "name": "string",
   "originDomainId": "string",
   "originProjectId": "string",
   "owningProjectId": "string",
   "revision": "string"
}
```

## Response Elements
<a name="API_CreateFormType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [description](#API_CreateFormType_ResponseSyntax) **   <a name="datazone-CreateFormType-response-description"></a>
The description of this Amazon DataZone metadata form type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateFormType_ResponseSyntax) **   <a name="datazone-CreateFormType-response-domainId"></a>
The ID of the Amazon DataZone domain in which this metadata form type is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_CreateFormType_ResponseSyntax) **   <a name="datazone-CreateFormType-response-name"></a>
The name of this Amazon DataZone metadata form type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*` 

 ** [originDomainId](#API_CreateFormType_ResponseSyntax) **   <a name="datazone-CreateFormType-response-originDomainId"></a>
The ID of the Amazon DataZone domain in which this metadata form type was originally created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [originProjectId](#API_CreateFormType_ResponseSyntax) **   <a name="datazone-CreateFormType-response-originProjectId"></a>
The ID of the project in which this Amazon DataZone metadata form type was originally created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningProjectId](#API_CreateFormType_ResponseSyntax) **   <a name="datazone-CreateFormType-response-owningProjectId"></a>
The ID of the project that owns this Amazon DataZone metadata form type.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_CreateFormType_ResponseSyntax) **   <a name="datazone-CreateFormType-response-revision"></a>
The revision of this Amazon DataZone metadata form type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_CreateFormType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateFormType_Examples"></a>

### Example
<a name="API_CreateFormType_Example_1"></a>

This example illustrates one usage of CreateFormType.

#### Sample Request
<a name="API_CreateFormType_Example_1_Request"></a>

```
aws datazone create-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj9vn4wxyz8k2m" \
--name "DataProductMetadataForm" \
--status ENABLED \
--model '{ 
    "smithy": "namespace dzd_53ielnpxktdilj\n\nstructure DataProductMetadataForm {\n @required\n name: smithy.api#String,\n @required\n databaseName: smithy.api#String,\n @required\n catalog: smithy.api#String\n}" 
}'
```

#### Sample Response
<a name="API_CreateFormType_Example_1_Response"></a>

```
{
    "domainId": "dzd_53ielnpxktdilj",
    "name": "DataProductMetadataForm",
    "revision": "1"
}
```

### Example
<a name="API_CreateFormType_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_CreateFormType_Example_2_Request"></a>

```
aws datazone create-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerPreferencesFormType" \
--model '{"smithy": "structure CustomerPreferencesFormType { }"}'
```

#### Sample Response
<a name="API_CreateFormType_Example_2_Response"></a>

```
aws: error: the following arguments are required: —owning-project-identifier
```

### Example
<a name="API_CreateFormType_Example_3"></a>

Failure case - wrong Smithy:

#### Sample Request
<a name="API_CreateFormType_Example_3_Request"></a>

```
aws datazone create-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--name "CustomerPreferencesFormType" \
--model '{"smithy": "structure CustomerPreferencesFormType {"}'  # malformed closing brace
```

#### Sample Response
<a name="API_CreateFormType_Example_3_Response"></a>

```
Unknown options: malformed, closing, brace, #
```

### Example
<a name="API_CreateFormType_Example_4"></a>

This example illustrates a usage of CreateFormType, using Smithy traits to specify that attributes should be indexed for search. In this case, we will create a single required field name that will be indexed for technical identifier search.

#### Sample Request
<a name="API_CreateFormType_Example_4_Request"></a>

```
aws datazone create-form-type \
--domain-identifier "dzd_4q2el0k35ngqa8" \
--owning-project-identifier "4mo2oiauaqbrtc" \
--name "DataProductMetadataForm" \
--status ENABLED \
--model '{ "smithy": "namespace dzd_4q2el0k35ngqa8\n\nstructure DataProductMetadataForm {\n @required\n @amazon.datazone#searchable(modes:[\"TECHNICAL\"])\n name: smithy.api#String\n}" }'
```

#### Sample Response
<a name="API_CreateFormType_Example_4_Response"></a>

```
{
    "domainId": "dzd_4q2el0k35ngqa8",
    "name": "DataProductMetadataForm",
    "revision": "1"
}
```

## See Also
<a name="API_CreateFormType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateFormType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateFormType) 

# CreateGlossary
<a name="API_CreateGlossary"></a>

Creates an Amazon DataZone business glossary.

Specifies that this is a create glossary policy.

A glossary serves as the central repository for business terminology and definitions within an organization. It helps establish and maintain a common language across different departments and teams, reducing miscommunication and ensuring consistent interpretation of business concepts. Glossaries can include hierarchical relationships between terms, cross-references, and links to actual data assets, making them invaluable for both business users and technical teams trying to understand and use data correctly.

Prerequisites:
+ Domain must exist and be in an active state. 
+ Owning project must exist and be accessible by the caller.
+ The glossary name must be unique within the domain.

## Request Syntax
<a name="API_CreateGlossary_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/glossaries HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "owningProjectIdentifier": "string",
   "status": "string",
   "usageRestrictions": [ "string" ]
}
```

## URI Request Parameters
<a name="API_CreateGlossary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateGlossary_RequestSyntax) **   <a name="datazone-CreateGlossary-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this business glossary is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateGlossary_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateGlossary_RequestSyntax) **   <a name="datazone-CreateGlossary-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_CreateGlossary_RequestSyntax) **   <a name="datazone-CreateGlossary-request-description"></a>
The description of this business glossary.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [name](#API_CreateGlossary_RequestSyntax) **   <a name="datazone-CreateGlossary-request-name"></a>
The name of this business glossary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [owningProjectIdentifier](#API_CreateGlossary_RequestSyntax) **   <a name="datazone-CreateGlossary-request-owningProjectIdentifier"></a>
The ID of the project that currently owns business glossary.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [status](#API_CreateGlossary_RequestSyntax) **   <a name="datazone-CreateGlossary-request-status"></a>
The status of this business glossary.  
Type: String  
Valid Values: `DISABLED | ENABLED`   
Required: No

 ** [usageRestrictions](#API_CreateGlossary_RequestSyntax) **   <a name="datazone-CreateGlossary-request-usageRestrictions"></a>
The usage restriction of the restricted glossary.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `ASSET_GOVERNED_TERMS`   
Required: No

## Response Syntax
<a name="API_CreateGlossary_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "id": "string",
   "name": "string",
   "owningProjectId": "string",
   "status": "string",
   "usageRestrictions": [ "string" ]
}
```

## Response Elements
<a name="API_CreateGlossary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [description](#API_CreateGlossary_ResponseSyntax) **   <a name="datazone-CreateGlossary-response-description"></a>
The description of this business glossary.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [domainId](#API_CreateGlossary_ResponseSyntax) **   <a name="datazone-CreateGlossary-response-domainId"></a>
The ID of the Amazon DataZone domain in which this business glossary is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateGlossary_ResponseSyntax) **   <a name="datazone-CreateGlossary-response-id"></a>
The ID of this business glossary.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_CreateGlossary_ResponseSyntax) **   <a name="datazone-CreateGlossary-response-name"></a>
The name of this business glossary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [owningProjectId](#API_CreateGlossary_ResponseSyntax) **   <a name="datazone-CreateGlossary-response-owningProjectId"></a>
The ID of the project that currently owns this business glossary.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_CreateGlossary_ResponseSyntax) **   <a name="datazone-CreateGlossary-response-status"></a>
The status of this business glossary.  
Type: String  
Valid Values: `DISABLED | ENABLED` 

 ** [usageRestrictions](#API_CreateGlossary_ResponseSyntax) **   <a name="datazone-CreateGlossary-response-usageRestrictions"></a>
The usage restriction of the restricted glossary.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `ASSET_GOVERNED_TERMS` 

## Errors
<a name="API_CreateGlossary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateGlossary_Examples"></a>

### Example
<a name="API_CreateGlossary_Example_1"></a>

This example illustrates one usage of CreateGlossary.

#### Sample Request
<a name="API_CreateGlossary_Example_1_Request"></a>

```
aws datazone create-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerAnalyticsGlossary" \
--owning-project-identifier "prj7nx82mkl"
```

#### Sample Response
<a name="API_CreateGlossary_Example_1_Response"></a>

```
{
    "domainId": "dzd_53ielnpxktdilj",
    "id": "gls8m3nqx2wkfp",
    "name": "CustomerAnalyticsGlossary",
    "owningProjectId": "prj7nx82mkl",
    "status": "ENABLED"
}
```

### Example
<a name="API_CreateGlossary_Example_2"></a>

Failure case - duplicate term:

#### Sample Request
<a name="API_CreateGlossary_Example_2_Request"></a>

```
aws datazone create-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerAnalyticsGlossary" \
--owning-project-identifier "prj7nx82mkl"
```

#### Sample Response
<a name="API_CreateGlossary_Example_2_Response"></a>

```
An error occurred (ConflictException) when calling the CreateGlossary operation: Conflict with businessGlossary gls8m3nqx2wkfp
```

### Example
<a name="API_CreateGlossary_Example_3"></a>

Failure case - missing required parameter: 

#### Sample Request
<a name="API_CreateGlossary_Example_3_Request"></a>

```
aws datazone create-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl"
```

#### Sample Response
<a name="API_CreateGlossary_Example_3_Response"></a>

```
aws: error: the following arguments are required: --name
```

## See Also
<a name="API_CreateGlossary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateGlossary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateGlossary) 

# CreateGlossaryTerm
<a name="API_CreateGlossaryTerm"></a>

Creates a business glossary term.

A glossary term represents an individual entry within the Amazon DataZone glossary, serving as a standardized definition for a specific business concept or data element. Each term can include rich metadata such as detailed definitions, synonyms, related terms, and usage examples. Glossary terms can be linked directly to data assets, providing business context to technical data elements. This linking capability helps users understand the business meaning of data fields and ensures consistent interpretation across different systems and teams. Terms can also have relationships with other terms, creating a semantic network that reflects the complexity of business concepts.

Prerequisites:
+ Domain must exist. 
+ Glossary must exist.
+ The term name must be unique within the glossary.
+ Ensure term does not conflict with existing terms in hierarchy.

## Request Syntax
<a name="API_CreateGlossaryTerm_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/glossary-terms HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "glossaryIdentifier": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "string" ]
   }
}
```

## URI Request Parameters
<a name="API_CreateGlossaryTerm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this business glossary term is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateGlossaryTerm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [glossaryIdentifier](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-glossaryIdentifier"></a>
The ID of the business glossary in which this term is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [longDescription](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-longDescription"></a>
The long description of this business glossary term.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [name](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-name"></a>
The name of this business glossary term.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [shortDescription](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-shortDescription"></a>
The short description of this business glossary term.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [status](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-status"></a>
The status of this business glossary term.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [termRelations](#API_CreateGlossaryTerm_RequestSyntax) **   <a name="datazone-CreateGlossaryTerm-request-termRelations"></a>
The term relations of this business glossary term.  
Type: [TermRelations](API_TermRelations.md) object  
Required: No

## Response Syntax
<a name="API_CreateGlossaryTerm_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "domainId": "string",
   "glossaryId": "string",
   "id": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "string" ]
   },
   "usageRestrictions": [ "string" ]
}
```

## Response Elements
<a name="API_CreateGlossaryTerm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-domainId"></a>
The ID of the Amazon DataZone domain in which this business glossary term is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [glossaryId](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-glossaryId"></a>
The ID of the business glossary in which this term is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-id"></a>
The ID of this business glossary term.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [longDescription](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-longDescription"></a>
The long description of this business glossary term.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [name](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-name"></a>
The name of this business glossary term.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [shortDescription](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-shortDescription"></a>
The short description of this business glossary term.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [status](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-status"></a>
The status of this business glossary term.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [termRelations](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-termRelations"></a>
The term relations of this business glossary term.  
Type: [TermRelations](API_TermRelations.md) object

 ** [usageRestrictions](#API_CreateGlossaryTerm_ResponseSyntax) **   <a name="datazone-CreateGlossaryTerm-response-usageRestrictions"></a>
The usage restriction of the restricted glossary.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `ASSET_GOVERNED_TERMS` 

## Errors
<a name="API_CreateGlossaryTerm_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_CreateGlossaryTerm_Examples"></a>

### Example
<a name="API_CreateGlossaryTerm_Example_1"></a>

This example illustrates one usage of CreateGlossaryTerm.

#### Sample Request
<a name="API_CreateGlossaryTerm_Example_1_Request"></a>

```
aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls8m3nqx2wkfp" \
--name "CustomerLifetimeValue"
```

#### Sample Response
<a name="API_CreateGlossaryTerm_Example_1_Response"></a>

```
{
    "domainId": "dzd_53ielnpxktdilj",
    "glossaryId": "gls8m3nqx2wkfp",
    "id": "trm9k4pq7xwnmh",
    "name": "CustomerLifetimeValue",
    "status": "ENABLED"
}
```

### Example
<a name="API_CreateGlossaryTerm_Example_2"></a>

Failure case - missing required parameter:

#### Sample Request
<a name="API_CreateGlossaryTerm_Example_2_Request"></a>

```
aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--name "CustomerLifetimeValue"
```

#### Sample Response
<a name="API_CreateGlossaryTerm_Example_2_Response"></a>

```
aws: error: the following arguments are required: —glossary-identifier
```

### Example
<a name="API_CreateGlossaryTerm_Example_3"></a>

Failure case - glossary does not exist:

#### Sample Request
<a name="API_CreateGlossaryTerm_Example_3_Request"></a>

```
    aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls_nonexistent" \
--name "CustomerLifetimeValue"
```

#### Sample Response
<a name="API_CreateGlossaryTerm_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the CreateGlossaryTerm operation: The given Glossary doesn't exist. Try creating Glossary before accessing it.
```

### Example
<a name="API_CreateGlossaryTerm_Example_4"></a>

Failure case - duplicate term:

#### Sample Request
<a name="API_CreateGlossaryTerm_Example_4_Request"></a>

```
aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls8m3nqx2wkfp" \
--name "CustomerLifetimeValue"
```

#### Sample Response
<a name="API_CreateGlossaryTerm_Example_4_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the CreateGlossaryTerm operation: The given Glossary doesn't exist. Try creating Glossary before accessing it.
```

### Example
<a name="API_CreateGlossaryTerm_Example_5"></a>

Failure case - delete related resources

#### Sample Request
<a name="API_CreateGlossaryTerm_Example_5_Request"></a>

```
 aws datazone create-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--glossary-identifier "gls8m3nqx2wkfp" \
--name "CustomerLifetimeValue"
```

#### Sample Response
<a name="API_CreateGlossaryTerm_Example_5_Response"></a>

```
An error occurred (ConflictException) when calling the CreateGlossaryTerm operation: Conflict with glossaryTerm trm9k4pq7xwnmh
```

## See Also
<a name="API_CreateGlossaryTerm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateGlossaryTerm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateGlossaryTerm) 

# CreateGroupProfile
<a name="API_CreateGroupProfile"></a>

Creates a group profile in Amazon DataZone.

## Request Syntax
<a name="API_CreateGroupProfile_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/group-profiles HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "groupIdentifier": "string",
   "rolePrincipalArn": "string"
}
```

## URI Request Parameters
<a name="API_CreateGroupProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateGroupProfile_RequestSyntax) **   <a name="datazone-CreateGroupProfile-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which the group profile is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateGroupProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateGroupProfile_RequestSyntax) **   <a name="datazone-CreateGroupProfile-request-clientToken"></a>
 A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [groupIdentifier](#API_CreateGroupProfile_RequestSyntax) **   <a name="datazone-CreateGroupProfile-request-groupIdentifier"></a>
The identifier of the group for which the group profile is created.  
Type: String  
Pattern: `.*(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+).*`   
Required: No

 ** [rolePrincipalArn](#API_CreateGroupProfile_RequestSyntax) **   <a name="datazone-CreateGroupProfile-request-rolePrincipalArn"></a>
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.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateGroupProfile_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "domainId": "string",
   "groupName": "string",
   "id": "string",
   "rolePrincipalArn": "string",
   "rolePrincipalId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateGroupProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_CreateGroupProfile_ResponseSyntax) **   <a name="datazone-CreateGroupProfile-response-domainId"></a>
The identifier of the Amazon DataZone domain in which the group profile is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [groupName](#API_CreateGroupProfile_ResponseSyntax) **   <a name="datazone-CreateGroupProfile-response-groupName"></a>
The name of the group for which group profile is created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z_0-9+=,.@-]+` 

 ** [id](#API_CreateGroupProfile_ResponseSyntax) **   <a name="datazone-CreateGroupProfile-response-id"></a>
The identifier of the group profile.  
Type: String  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [rolePrincipalArn](#API_CreateGroupProfile_ResponseSyntax) **   <a name="datazone-CreateGroupProfile-response-rolePrincipalArn"></a>
The ARN of the IAM role principal. This role is associated with the group profile.  
Type: String

 ** [rolePrincipalId](#API_CreateGroupProfile_ResponseSyntax) **   <a name="datazone-CreateGroupProfile-response-rolePrincipalId"></a>
The unique identifier of the IAM role principal. This principal is associated with the group profile.  
Type: String

 ** [status](#API_CreateGroupProfile_ResponseSyntax) **   <a name="datazone-CreateGroupProfile-response-status"></a>
The status of the group profile.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED` 

## Errors
<a name="API_CreateGroupProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateGroupProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateGroupProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateGroupProfile) 

# CreateListingChangeSet
<a name="API_CreateListingChangeSet"></a>

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog. 

## Request Syntax
<a name="API_CreateListingChangeSet_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/listings/change-set HTTP/1.1
Content-type: application/json

{
   "action": "string",
   "clientToken": "string",
   "entityIdentifier": "string",
   "entityRevision": "string",
   "entityType": "string"
}
```

## URI Request Parameters
<a name="API_CreateListingChangeSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateListingChangeSet_RequestSyntax) **   <a name="datazone-CreateListingChangeSet-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateListingChangeSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [action](#API_CreateListingChangeSet_RequestSyntax) **   <a name="datazone-CreateListingChangeSet-request-action"></a>
Specifies whether to publish or unpublish a listing.  
Type: String  
Valid Values: `PUBLISH | UNPUBLISH`   
Required: Yes

 ** [clientToken](#API_CreateListingChangeSet_RequestSyntax) **   <a name="datazone-CreateListingChangeSet-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [entityIdentifier](#API_CreateListingChangeSet_RequestSyntax) **   <a name="datazone-CreateListingChangeSet-request-entityIdentifier"></a>
The ID of the asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityRevision](#API_CreateListingChangeSet_RequestSyntax) **   <a name="datazone-CreateListingChangeSet-request-entityRevision"></a>
The revision of an asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

 ** [entityType](#API_CreateListingChangeSet_RequestSyntax) **   <a name="datazone-CreateListingChangeSet-request-entityType"></a>
The type of an entity.  
Type: String  
Valid Values: `ASSET | DATA_PRODUCT`   
Required: Yes

## Response Syntax
<a name="API_CreateListingChangeSet_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "listingId": "string",
   "listingRevision": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateListingChangeSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [listingId](#API_CreateListingChangeSet_ResponseSyntax) **   <a name="datazone-CreateListingChangeSet-response-listingId"></a>
The ID of the listing (a record of an asset at a given time).  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [listingRevision](#API_CreateListingChangeSet_ResponseSyntax) **   <a name="datazone-CreateListingChangeSet-response-listingRevision"></a>
The revision of a listing.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [status](#API_CreateListingChangeSet_ResponseSyntax) **   <a name="datazone-CreateListingChangeSet-response-status"></a>
Specifies the status of the listing.  
Type: String  
Valid Values: `CREATING | ACTIVE | INACTIVE` 

## Errors
<a name="API_CreateListingChangeSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateListingChangeSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateListingChangeSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateListingChangeSet) 

# CreateProject
<a name="API_CreateProject"></a>

Creates an Amazon DataZone project.

## Request Syntax
<a name="API_CreateProject_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/projects HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "domainUnitId": "string",
   "glossaryTerms": [ "string" ],
   "membershipAssignments": [ 
      { 
         "designation": "string",
         "member": { ... }
      }
   ],
   "name": "string",
   "projectCategory": "string",
   "projectExecutionRole": "string",
   "projectProfileId": "string",
   "resourceTags": { 
      "string" : "string" 
   },
   "userParameters": [ 
      { 
         "environmentConfigurationName": "string",
         "environmentId": "string",
         "environmentParameters": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "environmentResolvedAccount": { 
            "awsAccountId": "string",
            "regionName": "string",
            "sourceAccountPoolId": "string"
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this project is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-description"></a>
The description of the Amazon DataZone project.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [domainUnitId](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-domainUnitId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: No

 ** [glossaryTerms](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-glossaryTerms"></a>
The glossary terms that can be used in this Amazon DataZone project.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [membershipAssignments](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-membershipAssignments"></a>
The members to be assigned to the project.  
Type: Array of [ProjectMembershipAssignment](API_ProjectMembershipAssignment.md) objects  
Required: No

 ** [name](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-name"></a>
The name of the Amazon DataZone project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: Yes

 ** [projectCategory](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-projectCategory"></a>
The category of the project. Set to 'ADMIN' designates this as an administrative project for the Amazon DataZone domain.  
Type: String  
Required: No

 ** [projectExecutionRole](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-projectExecutionRole"></a>
The default project IAM role that is used to access project resources and run computes such as Glue and Sagemaker.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+`   
Required: No

 ** [projectProfileId](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-projectProfileId"></a>
The ID of the project profile.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [resourceTags](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-resourceTags"></a>
The resource tags of the project.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 25 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\w \.:/=+@-]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `[\w \.:/=+@-]*`   
Required: No

 ** [userParameters](#API_CreateProject_RequestSyntax) **   <a name="datazone-CreateProject-request-userParameters"></a>
The user parameters of the project.  
Type: Array of [EnvironmentConfigurationUserParameter](API_EnvironmentConfigurationUserParameter.md) objects  
Required: No

## Response Syntax
<a name="API_CreateProject_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentDeploymentDetails": { 
      "environmentFailureReasons": { 
         "string" : [ 
            { 
               "code": "string",
               "message": "string"
            }
         ]
      },
      "overallDeploymentStatus": "string"
   },
   "failureReasons": [ 
      { 
         "code": "string",
         "message": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "projectCategory": "string",
   "projectProfileId": "string",
   "projectStatus": "string",
   "resourceTags": [ 
      { 
         "key": "string",
         "source": "string",
         "value": "string"
      }
   ],
   "userParameters": [ 
      { 
         "environmentConfigurationName": "string",
         "environmentId": "string",
         "environmentParameters": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "environmentResolvedAccount": { 
            "awsAccountId": "string",
            "regionName": "string",
            "sourceAccountPoolId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_CreateProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-createdAt"></a>
The timestamp of when the project was created.  
Type: Timestamp

 ** [createdBy](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-createdBy"></a>
The Amazon DataZone user who created the project.  
Type: String

 ** [description](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-description"></a>
The description of the project.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-domainId"></a>
The identifier of the Amazon DataZone domain in which the project was created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-domainUnitId"></a>
The ID of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentDeploymentDetails](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-environmentDeploymentDetails"></a>
The environment deployment details.  
Type: [EnvironmentDeploymentDetails](API_EnvironmentDeploymentDetails.md) object

 ** [failureReasons](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-failureReasons"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: Array of [ProjectDeletionError](API_ProjectDeletionError.md) objects

 ** [glossaryTerms](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-glossaryTerms"></a>
The glossary terms that can be used in the project.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-id"></a>
The ID of the Amazon DataZone project.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-lastUpdatedAt"></a>
The timestamp of when the project was last updated.  
Type: Timestamp

 ** [name](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-name"></a>
The name of the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectCategory](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-projectCategory"></a>
The category of the project.  
Type: String

 ** [projectProfileId](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-projectProfileId"></a>
The project profile ID.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [projectStatus](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-projectStatus"></a>
The status of the Amazon DataZone project that was created.  
Type: String  
Valid Values: `ACTIVE | DELETING | DELETE_FAILED | UPDATING | UPDATE_FAILED | MOVING` 

 ** [resourceTags](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-resourceTags"></a>
The resource tags of the project.  
Type: Array of [ResourceTag](API_ResourceTag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [userParameters](#API_CreateProject_ResponseSyntax) **   <a name="datazone-CreateProject-response-userParameters"></a>
The user parameters of the project.  
Type: Array of [EnvironmentConfigurationUserParameter](API_EnvironmentConfigurationUserParameter.md) objects

## Errors
<a name="API_CreateProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateProject) 

# CreateProjectMembership
<a name="API_CreateProjectMembership"></a>

Creates a project membership in Amazon DataZone.

## Request Syntax
<a name="API_CreateProjectMembership_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/projects/projectIdentifier/createMembership HTTP/1.1
Content-type: application/json

{
   "designation": "string",
   "member": { ... }
}
```

## URI Request Parameters
<a name="API_CreateProjectMembership_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateProjectMembership_RequestSyntax) **   <a name="datazone-CreateProjectMembership-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which project membership is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [projectIdentifier](#API_CreateProjectMembership_RequestSyntax) **   <a name="datazone-CreateProjectMembership-request-uri-projectIdentifier"></a>
The ID of the project for which this project membership was created.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateProjectMembership_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [designation](#API_CreateProjectMembership_RequestSyntax) **   <a name="datazone-CreateProjectMembership-request-designation"></a>
The designation of the project membership.  
Type: String  
Valid Values: `PROJECT_OWNER | PROJECT_CONTRIBUTOR | PROJECT_CATALOG_VIEWER | PROJECT_CATALOG_CONSUMER | PROJECT_CATALOG_STEWARD`   
Required: Yes

 ** [member](#API_CreateProjectMembership_RequestSyntax) **   <a name="datazone-CreateProjectMembership-request-member"></a>
The project member whose project membership was created.  
Type: [Member](API_Member.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_CreateProjectMembership_ResponseSyntax"></a>

```
HTTP/1.1 201
```

## Response Elements
<a name="API_CreateProjectMembership_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response with an empty HTTP body.

## Errors
<a name="API_CreateProjectMembership_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProjectMembership_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateProjectMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateProjectMembership) 

# CreateProjectProfile
<a name="API_CreateProjectProfile"></a>

Creates a project profile.

## Request Syntax
<a name="API_CreateProjectProfile_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/project-profiles HTTP/1.1
Content-type: application/json

{
   "allowCustomProjectResourceTags": boolean,
   "description": "string",
   "domainUnitIdentifier": "string",
   "environmentConfigurations": [ 
      { 
         "accountPools": [ "string" ],
         "awsAccount": { ... },
         "awsRegion": { ... },
         "configurationParameters": { 
            "parameterOverrides": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "resolvedParameters": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "ssmPath": "string"
         },
         "deploymentMode": "string",
         "deploymentOrder": number,
         "description": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "name": "string",
   "projectResourceTags": [ 
      { 
         "isValueEditable": boolean,
         "key": "string",
         "value": "string"
      }
   ],
   "projectResourceTagsDescription": "string",
   "status": "string"
}
```

## URI Request Parameters
<a name="API_CreateProjectProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-uri-domainIdentifier"></a>
A domain ID of the project profile.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateProjectProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [allowCustomProjectResourceTags](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-allowCustomProjectResourceTags"></a>
Specifies whether custom project resource tags are supported.  
Type: Boolean  
Required: No

 ** [description](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-description"></a>
A description of a project profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [domainUnitIdentifier](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-domainUnitIdentifier"></a>
A domain unit ID of the project profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: No

 ** [environmentConfigurations](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-environmentConfigurations"></a>
Environment configurations of the project profile.  
Type: Array of [EnvironmentConfiguration](API_EnvironmentConfiguration.md) objects  
Required: No

 ** [name](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-name"></a>
Project profile name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: Yes

 ** [projectResourceTags](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-projectResourceTags"></a>
The resource tags of the project profile.  
Type: Array of [ResourceTagParameter](API_ResourceTagParameter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Required: No

 ** [projectResourceTagsDescription](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-projectResourceTagsDescription"></a>
Field viewable through the UI that provides a project user with the allowed resource tag specifications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [status](#API_CreateProjectProfile_RequestSyntax) **   <a name="datazone-CreateProjectProfile-request-status"></a>
Project profile status.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Syntax
<a name="API_CreateProjectProfile_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "allowCustomProjectResourceTags": boolean,
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentConfigurations": [ 
      { 
         "accountPools": [ "string" ],
         "awsAccount": { ... },
         "awsRegion": { ... },
         "configurationParameters": { 
            "parameterOverrides": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "resolvedParameters": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "ssmPath": "string"
         },
         "deploymentMode": "string",
         "deploymentOrder": number,
         "description": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "projectResourceTags": [ 
      { 
         "isValueEditable": boolean,
         "key": "string",
         "value": "string"
      }
   ],
   "projectResourceTagsDescription": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateProjectProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [allowCustomProjectResourceTags](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-allowCustomProjectResourceTags"></a>
Specifies whether custom project resource tags are supported.  
Type: Boolean

 ** [createdAt](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-createdAt"></a>
A timestamp at which a project profile is created.  
Type: Timestamp

 ** [createdBy](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-createdBy"></a>
A user who created a project profile.  
Type: String

 ** [description](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-description"></a>
A project profile description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-domainId"></a>
The ID of the domain where a project profile is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-domainUnitId"></a>
The ID of the domain unit where a project profile is created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentConfigurations](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-environmentConfigurations"></a>
Environment configurations of a project profile.  
Type: Array of [EnvironmentConfiguration](API_EnvironmentConfiguration.md) objects

 ** [id](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-id"></a>
Project profile ID.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-lastUpdatedAt"></a>
A timestamp when a project profile was last updated.  
Type: Timestamp

 ** [name](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-name"></a>
Project profile name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectResourceTags](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-projectResourceTags"></a>
The resource tags of the project profile.  
Type: Array of [ResourceTagParameter](API_ResourceTagParameter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [projectResourceTagsDescription](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-projectResourceTagsDescription"></a>
Field viewable through the UI that provides a project user with the allowed resource tag specifications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [status](#API_CreateProjectProfile_ResponseSyntax) **   <a name="datazone-CreateProjectProfile-response-status"></a>
Project profile status.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

## Errors
<a name="API_CreateProjectProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProjectProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateProjectProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateProjectProfile) 

# CreateRule
<a name="API_CreateRule"></a>

Creates a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

## Request Syntax
<a name="API_CreateRule_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/rules HTTP/1.1
Content-type: application/json

{
   "action": "string",
   "clientToken": "string",
   "description": "string",
   "detail": { ... },
   "name": "string",
   "scope": { 
      "assetType": { 
         "selectionMode": "string",
         "specificAssetTypes": [ "string" ]
      },
      "dataProduct": boolean,
      "project": { 
         "selectionMode": "string",
         "specificProjects": [ "string" ]
      }
   },
   "target": { ... }
}
```

## URI Request Parameters
<a name="API_CreateRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-uri-domainIdentifier"></a>
The ID of the domain where the rule is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [action](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-action"></a>
The action of the rule.  
Type: String  
Valid Values: `CREATE_LISTING_CHANGE_SET | CREATE_SUBSCRIPTION_REQUEST`   
Required: Yes

 ** [clientToken](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-description"></a>
The description of the rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [detail](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-detail"></a>
The detail of the rule.  
Type: [RuleDetail](API_RuleDetail.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [name](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\w -]+`   
Required: Yes

 ** [scope](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-scope"></a>
The scope of the rule.  
Type: [RuleScope](API_RuleScope.md) object  
Required: Yes

 ** [target](#API_CreateRule_RequestSyntax) **   <a name="datazone-CreateRule-request-target"></a>
The target of the rule.  
Type: [RuleTarget](API_RuleTarget.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_CreateRule_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "action": "string",
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "detail": { ... },
   "identifier": "string",
   "name": "string",
   "ruleType": "string",
   "scope": { 
      "assetType": { 
         "selectionMode": "string",
         "specificAssetTypes": [ "string" ]
      },
      "dataProduct": boolean,
      "project": { 
         "selectionMode": "string",
         "specificProjects": [ "string" ]
      }
   },
   "target": { ... },
   "targetType": "string"
}
```

## Response Elements
<a name="API_CreateRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [action](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-action"></a>
The action of the rule.  
Type: String  
Valid Values: `CREATE_LISTING_CHANGE_SET | CREATE_SUBSCRIPTION_REQUEST` 

 ** [createdAt](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-createdAt"></a>
The timestamp at which the rule is created.  
Type: Timestamp

 ** [createdBy](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-createdBy"></a>
The user who creates the rule.  
Type: String

 ** [description](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-description"></a>
The description of the rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [detail](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-detail"></a>
The detail of the rule.  
Type: [RuleDetail](API_RuleDetail.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [identifier](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-identifier"></a>
The ID of the rule.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\w -]+` 

 ** [ruleType](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-ruleType"></a>
The type of the rule.  
Type: String  
Valid Values: `METADATA_FORM_ENFORCEMENT | GLOSSARY_TERM_ENFORCEMENT` 

 ** [scope](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-scope"></a>
The scope of the rule.  
Type: [RuleScope](API_RuleScope.md) object

 ** [target](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-target"></a>
The target of the rule.  
Type: [RuleTarget](API_RuleTarget.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [targetType](#API_CreateRule_ResponseSyntax) **   <a name="datazone-CreateRule-response-targetType"></a>
The target type of the rule.  
Type: String  
Valid Values: `DOMAIN_UNIT` 

## Errors
<a name="API_CreateRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateRule) 

# CreateSubscriptionGrant
<a name="API_CreateSubscriptionGrant"></a>

Creates a subsscription grant in Amazon DataZone.

## Request Syntax
<a name="API_CreateSubscriptionGrant_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/subscription-grants HTTP/1.1
Content-type: application/json

{
   "assetTargetNames": [ 
      { 
         "assetId": "string",
         "targetName": "string"
      }
   ],
   "clientToken": "string",
   "environmentIdentifier": "string",
   "grantedEntity": { ... },
   "subscriptionTargetIdentifier": "string"
}
```

## URI Request Parameters
<a name="API_CreateSubscriptionGrant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateSubscriptionGrant_RequestSyntax) **   <a name="datazone-CreateSubscriptionGrant-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the subscription grant is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateSubscriptionGrant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetTargetNames](#API_CreateSubscriptionGrant_RequestSyntax) **   <a name="datazone-CreateSubscriptionGrant-request-assetTargetNames"></a>
The names of the assets for which the subscription grant is created.  
Type: Array of [AssetTargetNameMap](API_AssetTargetNameMap.md) objects  
Required: No

 ** [clientToken](#API_CreateSubscriptionGrant_RequestSyntax) **   <a name="datazone-CreateSubscriptionGrant-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [environmentIdentifier](#API_CreateSubscriptionGrant_RequestSyntax) **   <a name="datazone-CreateSubscriptionGrant-request-environmentIdentifier"></a>
The ID of the environment in which the subscription grant is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [grantedEntity](#API_CreateSubscriptionGrant_RequestSyntax) **   <a name="datazone-CreateSubscriptionGrant-request-grantedEntity"></a>
The entity to which the subscription is to be granted.  
Type: [GrantedEntityInput](API_GrantedEntityInput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [subscriptionTargetIdentifier](#API_CreateSubscriptionGrant_RequestSyntax) **   <a name="datazone-CreateSubscriptionGrant-request-subscriptionTargetIdentifier"></a>
The ID of the subscription target for which the subscription grant is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

## Response Syntax
<a name="API_CreateSubscriptionGrant_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assets": [ 
      { 
         "assetId": "string",
         "assetRevision": "string",
         "assetScope": { 
            "assetId": "string",
            "errorMessage": "string",
            "filterIds": [ "string" ],
            "status": "string"
         },
         "failureCause": { 
            "message": "string"
         },
         "failureTimestamp": number,
         "grantedTimestamp": number,
         "permissions": { ... },
         "status": "string",
         "targetName": "string"
      }
   ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "grantedEntity": { ... },
   "id": "string",
   "status": "string",
   "subscriptionId": "string",
   "subscriptionTargetId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_CreateSubscriptionGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assets](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-assets"></a>
The assets for which the subscription grant is created.  
Type: Array of [SubscribedAsset](API_SubscribedAsset.md) objects

 ** [createdAt](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-createdAt"></a>
A timestamp of when the subscription grant is created.  
Type: Timestamp

 ** [createdBy](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-createdBy"></a>
The Amazon DataZone user who created the subscription grant.  
Type: String

 ** [domainId](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-domainId"></a>
The ID of the Amazon DataZone domain in which the subscription grant is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-environmentId"></a>
The environment ID for which subscription grant is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [grantedEntity](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-grantedEntity"></a>
The entity to which the subscription is granted.  
Type: [GrantedEntity](API_GrantedEntity.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [id](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-id"></a>
The ID of the subscription grant.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-status"></a>
The status of the subscription grant.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | GRANT_FAILED | REVOKE_FAILED | GRANT_AND_REVOKE_FAILED | COMPLETED | INACCESSIBLE` 

 ** [subscriptionId](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-subscriptionId"></a>
 *This parameter has been deprecated.*   
The identifier of the subscription grant.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [subscriptionTargetId](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-subscriptionTargetId"></a>
The ID of the subscription target for which the subscription grant is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-updatedAt"></a>
A timestamp of when the subscription grant was updated.  
Type: Timestamp

 ** [updatedBy](#API_CreateSubscriptionGrant_ResponseSyntax) **   <a name="datazone-CreateSubscriptionGrant-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription grant.  
Type: String

## Errors
<a name="API_CreateSubscriptionGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateSubscriptionGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateSubscriptionGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateSubscriptionGrant) 

# CreateSubscriptionRequest
<a name="API_CreateSubscriptionRequest"></a>

Creates a subscription request in Amazon DataZone.

## Request Syntax
<a name="API_CreateSubscriptionRequest_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/subscription-requests HTTP/1.1
Content-type: application/json

{
   "assetPermissions": [ 
      { 
         "assetId": "string",
         "permissions": { ... }
      }
   ],
   "assetScopes": [ 
      { 
         "assetId": "string",
         "filterIds": [ "string" ]
      }
   ],
   "clientToken": "string",
   "metadataForms": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "requestReason": "string",
   "subscribedListings": [ 
      { 
         "identifier": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ]
}
```

## URI Request Parameters
<a name="API_CreateSubscriptionRequest_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the subscription request is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateSubscriptionRequest_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetPermissions](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-assetPermissions"></a>
The asset permissions of the subscription request.  
Type: Array of [AssetPermission](API_AssetPermission.md) objects  
Required: No

 ** [assetScopes](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-assetScopes"></a>
The asset scopes of the subscription request.  
Type: Array of [AcceptedAssetScope](API_AcceptedAssetScope.md) objects  
Required: No

 ** [clientToken](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [metadataForms](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-metadataForms"></a>
The metadata form included in the subscription request.  
Type: Array of [FormInput](API_FormInput.md) objects  
Required: No

 ** [requestReason](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-requestReason"></a>
The reason for the subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** [subscribedListings](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-subscribedListings"></a>
The published asset for which the subscription grant is to be created.  
Type: Array of [SubscribedListingInput](API_SubscribedListingInput.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

 ** [subscribedPrincipals](#API_CreateSubscriptionRequest_RequestSyntax) **   <a name="datazone-CreateSubscriptionRequest-request-subscribedPrincipals"></a>
The Amazon DataZone principals for whom the subscription request is created.  
Type: Array of [SubscribedPrincipalInput](API_SubscribedPrincipalInput.md) objects  
Array Members: Fixed number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_CreateSubscriptionRequest_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "decisionComment": "string",
   "domainId": "string",
   "existingSubscriptionId": "string",
   "id": "string",
   "metadataForms": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "requestReason": "string",
   "reviewerId": "string",
   "status": "string",
   "subscribedListings": [ 
      { 
         "description": "string",
         "id": "string",
         "item": { ... },
         "name": "string",
         "ownerProjectId": "string",
         "ownerProjectName": "string",
         "revision": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ],
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_CreateSubscriptionRequest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-createdAt"></a>
A timestamp of when the subscription request is created.  
Type: Timestamp

 ** [createdBy](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-createdBy"></a>
The Amazon DataZone user who created the subscription request.  
Type: String

 ** [decisionComment](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-decisionComment"></a>
The decision comment of the subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-domainId"></a>
The ID of the Amazon DataZone domain in whcih the subscription request is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [existingSubscriptionId](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-existingSubscriptionId"></a>
The ID of the existing subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-id"></a>
The ID of the subscription request.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [metadataForms](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-metadataForms"></a>
The metadata form included in the subscription request.  
Type: Array of [FormOutput](API_FormOutput.md) objects

 ** [requestReason](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-requestReason"></a>
The reason for the subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [reviewerId](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-reviewerId"></a>
The ID of the reviewer of the subscription request.  
Type: String

 ** [status](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-status"></a>
The status of the subscription request.  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED` 

 ** [subscribedListings](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-subscribedListings"></a>
The published asset for which the subscription grant is to be created.  
Type: Array of [SubscribedListing](API_SubscribedListing.md) objects  
Array Members: Fixed number of 1 item.

 ** [subscribedPrincipals](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-subscribedPrincipals"></a>
The subscribed principals of the subscription request.  
Type: Array of [SubscribedPrincipal](API_SubscribedPrincipal.md) objects  
Array Members: Fixed number of 1 item.

 ** [updatedAt](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-updatedAt"></a>
The timestamp of when the subscription request was updated.  
Type: Timestamp

 ** [updatedBy](#API_CreateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-CreateSubscriptionRequest-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription request.  
Type: String

## Errors
<a name="API_CreateSubscriptionRequest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateSubscriptionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateSubscriptionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateSubscriptionRequest) 

# CreateSubscriptionTarget
<a name="API_CreateSubscriptionTarget"></a>

Creates a subscription target in Amazon DataZone.

## Request Syntax
<a name="API_CreateSubscriptionTarget_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/environments/environmentIdentifier/subscription-targets HTTP/1.1
Content-type: application/json

{
   "applicableAssetTypes": [ "string" ],
   "authorizedPrincipals": [ "string" ],
   "clientToken": "string",
   "manageAccessRole": "string",
   "name": "string",
   "provider": "string",
   "subscriptionGrantCreationMode": "string",
   "subscriptionTargetConfig": [ 
      { 
         "content": "string",
         "formName": "string"
      }
   ],
   "type": "string"
}
```

## URI Request Parameters
<a name="API_CreateSubscriptionTarget_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which subscription target is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-uri-environmentIdentifier"></a>
The ID of the environment in which subscription target is created.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateSubscriptionTarget_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [applicableAssetTypes](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-applicableAssetTypes"></a>
The asset types that can be included in the subscription target.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*`   
Required: Yes

 ** [authorizedPrincipals](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-authorizedPrincipals"></a>
The authorized principals of the subscription target.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9:/._-]*`   
Required: Yes

 ** [clientToken](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [manageAccessRole](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-manageAccessRole"></a>
The manage access role that is used to create the subscription target.  
Type: String  
Pattern: `arn:aws(|-cn|-us-gov):iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*`   
Required: Yes

 ** [name](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-name"></a>
The name of the subscription target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [provider](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-provider"></a>
The provider of the subscription target.  
Type: String  
Required: No

 ** [subscriptionGrantCreationMode](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-subscriptionGrantCreationMode"></a>
 Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.   
Type: String  
Valid Values: `AUTOMATIC | MANUAL`   
Required: No

 ** [subscriptionTargetConfig](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-subscriptionTargetConfig"></a>
The configuration of the subscription target.  
Type: Array of [SubscriptionTargetForm](API_SubscriptionTargetForm.md) objects  
Required: Yes

 ** [type](#API_CreateSubscriptionTarget_RequestSyntax) **   <a name="datazone-CreateSubscriptionTarget-request-type"></a>
The type of the subscription target.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreateSubscriptionTarget_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicableAssetTypes": [ "string" ],
   "authorizedPrincipals": [ "string" ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "manageAccessRole": "string",
   "name": "string",
   "projectId": "string",
   "provider": "string",
   "subscriptionGrantCreationMode": "string",
   "subscriptionTargetConfig": [ 
      { 
         "content": "string",
         "formName": "string"
      }
   ],
   "type": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_CreateSubscriptionTarget_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicableAssetTypes](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-applicableAssetTypes"></a>
The asset types that can be included in the subscription target.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*` 

 ** [authorizedPrincipals](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-authorizedPrincipals"></a>
The authorised principals of the subscription target.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9:/._-]*` 

 ** [createdAt](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-createdAt"></a>
The timestamp of when the subscription target was created.  
Type: Timestamp

 ** [createdBy](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-createdBy"></a>
The Amazon DataZone user who created the subscription target.  
Type: String

 ** [domainId](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-domainId"></a>
The ID of the Amazon DataZone domain in which the subscription target was created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-environmentId"></a>
The ID of the environment in which the subscription target was created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-id"></a>
The ID of the subscription target.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [manageAccessRole](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-manageAccessRole"></a>
The manage access role with which the subscription target was created.  
Type: String  
Pattern: `arn:aws(|-cn|-us-gov):iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*` 

 ** [name](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-name"></a>
The name of the subscription target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [projectId](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-projectId"></a>
???  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [provider](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-provider"></a>
The provider of the subscription target.  
Type: String

 ** [subscriptionGrantCreationMode](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-subscriptionGrantCreationMode"></a>
 Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.   
Type: String  
Valid Values: `AUTOMATIC | MANUAL` 

 ** [subscriptionTargetConfig](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-subscriptionTargetConfig"></a>
The configuration of the subscription target.  
Type: Array of [SubscriptionTargetForm](API_SubscriptionTargetForm.md) objects

 ** [type](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-type"></a>
The type of the subscription target.  
Type: String

 ** [updatedAt](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-updatedAt"></a>
The timestamp of when the subscription target was updated.  
Type: Timestamp

 ** [updatedBy](#API_CreateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-CreateSubscriptionTarget-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription target.  
Type: String

## Errors
<a name="API_CreateSubscriptionTarget_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateSubscriptionTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateSubscriptionTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateSubscriptionTarget) 

# CreateUserProfile
<a name="API_CreateUserProfile"></a>

Creates a user profile in Amazon DataZone.

## Request Syntax
<a name="API_CreateUserProfile_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/user-profiles HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "sessionName": "string",
   "userIdentifier": "string",
   "userType": "string"
}
```

## URI Request Parameters
<a name="API_CreateUserProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_CreateUserProfile_RequestSyntax) **   <a name="datazone-CreateUserProfile-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a user profile is created.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_CreateUserProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateUserProfile_RequestSyntax) **   <a name="datazone-CreateUserProfile-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

 ** [sessionName](#API_CreateUserProfile_RequestSyntax) **   <a name="datazone-CreateUserProfile-request-sessionName"></a>
The session name for IAM role sessions.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 64.  
Required: No

 ** [userIdentifier](#API_CreateUserProfile_RequestSyntax) **   <a name="datazone-CreateUserProfile-request-userIdentifier"></a>
The identifier of the user for which the user profile is created.  
Type: String  
Pattern: `.*(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$).*`   
Required: Yes

 ** [userType](#API_CreateUserProfile_RequestSyntax) **   <a name="datazone-CreateUserProfile-request-userType"></a>
The user type of the user for which the user profile is created.  
Type: String  
Valid Values: `IAM_USER | IAM_ROLE | SSO_USER | IAM_ROLE_SESSION`   
Required: No

## Response Syntax
<a name="API_CreateUserProfile_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "details": { ... },
   "domainId": "string",
   "id": "string",
   "status": "string",
   "type": "string"
}
```

## Response Elements
<a name="API_CreateUserProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [details](#API_CreateUserProfile_ResponseSyntax) **   <a name="datazone-CreateUserProfile-response-details"></a>
The user profile details.  
Type: [UserProfileDetails](API_UserProfileDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [domainId](#API_CreateUserProfile_ResponseSyntax) **   <a name="datazone-CreateUserProfile-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a user profile is created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_CreateUserProfile_ResponseSyntax) **   <a name="datazone-CreateUserProfile-response-id"></a>
The identifier of the user profile.  
Type: String  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [status](#API_CreateUserProfile_ResponseSyntax) **   <a name="datazone-CreateUserProfile-response-status"></a>
The status of the user profile.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED | ACTIVATED | DEACTIVATED` 

 ** [type](#API_CreateUserProfile_ResponseSyntax) **   <a name="datazone-CreateUserProfile-response-type"></a>
The type of the user profile.  
Type: String  
Valid Values: `IAM | SSO` 

## Errors
<a name="API_CreateUserProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_CreateUserProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/CreateUserProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/CreateUserProfile) 

# DeleteAccountPool
<a name="API_DeleteAccountPool"></a>

Deletes an account pool.

## Request Syntax
<a name="API_DeleteAccountPool_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/account-pools/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAccountPool_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteAccountPool_RequestSyntax) **   <a name="datazone-DeleteAccountPool-request-uri-domainIdentifier"></a>
The ID of the domain where the account pool is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteAccountPool_RequestSyntax) **   <a name="datazone-DeleteAccountPool-request-uri-identifier"></a>
The ID of the account pool to be deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteAccountPool_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAccountPool_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteAccountPool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteAccountPool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteAccountPool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteAccountPool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteAccountPool) 

# DeleteAsset
<a name="API_DeleteAsset"></a>

Deletes an asset in Amazon DataZone.
+ --domain-identifier must refer to a valid and existing domain. 
+ --identifier must refer to an existing asset in the specified domain.
+ Asset must not be referenced in any existing asset filters.
+ Asset must not be linked to any draft or published data product.
+ User must have delete permissions for the domain and project.

## Request Syntax
<a name="API_DeleteAsset_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/assets/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAsset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteAsset_RequestSyntax) **   <a name="datazone-DeleteAsset-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the asset is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteAsset_RequestSyntax) **   <a name="datazone-DeleteAsset-request-uri-identifier"></a>
The identifier of the asset that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteAsset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAsset_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteAsset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteAsset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteAsset_Examples"></a>

### Example
<a name="API_DeleteAsset_Example_1"></a>

This example illustrates one usage of DeleteAsset.

#### Sample Request
<a name="API_DeleteAsset_Example_1_Request"></a>

```
aws datazone delete-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4"
```

#### Sample Response
<a name="API_DeleteAsset_Example_1_Response"></a>

```
aws datazone delete-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4"
```

### Example
<a name="API_DeleteAsset_Example_2"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_DeleteAsset_Example_2_Request"></a>

```
aws datazone delete-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4"
```

#### Sample Response
<a name="API_DeleteAsset_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the DeleteAsset operation:
 The given Asset doesn't exist. Try creating Asset before accessing it.
```

### Example
<a name="API_DeleteAsset_Example_3"></a>

Failure case - a required parameter is missing: 

#### Sample Request
<a name="API_DeleteAsset_Example_3_Request"></a>

```
aws datazone delete-asset \
--domain-identifier "dzd_53ielnpxktdilj"
```

```
aws: error: the following arguments are required: —identifier
```

## See Also
<a name="API_DeleteAsset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteAsset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteAsset) 

# DeleteAssetFilter
<a name="API_DeleteAssetFilter"></a>

Deletes an asset filter.

Prerequisites:
+ The asset filter must exist. 
+ The domain and asset must not have been deleted.
+ Ensure the --identifier refers to a valid filter ID.

## Request Syntax
<a name="API_DeleteAssetFilter_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/assets/assetIdentifier/filters/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAssetFilter_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetIdentifier](#API_DeleteAssetFilter_RequestSyntax) **   <a name="datazone-DeleteAssetFilter-request-uri-assetIdentifier"></a>
The ID of the data asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_DeleteAssetFilter_RequestSyntax) **   <a name="datazone-DeleteAssetFilter-request-uri-domainIdentifier"></a>
The ID of the domain where you want to delete an asset filter.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteAssetFilter_RequestSyntax) **   <a name="datazone-DeleteAssetFilter-request-uri-identifier"></a>
The ID of the asset filter that you want to delete.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteAssetFilter_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAssetFilter_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteAssetFilter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteAssetFilter_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteAssetFilter_Examples"></a>

### Example
<a name="API_DeleteAssetFilter_Example_1"></a>

This example illustrates one usage of DeleteAssetFilter.

#### Sample Request
<a name="API_DeleteAssetFilter_Example_1_Request"></a>

```
aws datazone delete-asset-filter \
 --domain-identifier "dzd_cm9m1uc1hqf6uf" \
 --asset-identifier "6br2md6v9hqox3" \
 --identifier "c2fkteudhd2dgn"
```

### Example
<a name="API_DeleteAssetFilter_Example_2"></a>

Failure case - resource does not exist

#### Sample Request
<a name="API_DeleteAssetFilter_Example_2_Request"></a>

```
aws datazone delete-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5"
```

#### Sample Response
<a name="API_DeleteAssetFilter_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the DeleteAssetFilter operation:
 The given Asset doesn't exist. Try creating Asset before accessing it.
```

### Example
<a name="API_DeleteAssetFilter_Example_3"></a>

Failure case - a required parameter is missing:

#### Sample Request
<a name="API_DeleteAssetFilter_Example_3_Request"></a>

```
aws datazone delete-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4"
```

#### Sample Response
<a name="API_DeleteAssetFilter_Example_3_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

## See Also
<a name="API_DeleteAssetFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteAssetFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteAssetFilter) 

# DeleteAssetType
<a name="API_DeleteAssetType"></a>

Deletes an asset type in Amazon DataZone.

Prerequisites:
+ The asset type must exist in the domain. 
+ You must have DeleteAssetType permission.
+ The asset type must not be in use (e.g., assigned to any asset). If used, deletion will fail.
+ You should retrieve the asset type using get-asset-type to confirm its presence before deletion.

## Request Syntax
<a name="API_DeleteAssetType_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/asset-types/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAssetType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteAssetType_RequestSyntax) **   <a name="datazone-DeleteAssetType-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the asset type is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteAssetType_RequestSyntax) **   <a name="datazone-DeleteAssetType-request-uri-identifier"></a>
The identifier of the asset type that is deleted.  
Length Constraints: Minimum length of 1. Maximum length of 513.  
Pattern: `(?!\.)[\w\.]*\w`   
Required: Yes

## Request Body
<a name="API_DeleteAssetType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAssetType_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteAssetType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteAssetType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteAssetType_Examples"></a>

### Example
<a name="API_DeleteAssetType_Example_1"></a>

This example illustrates one usage of DeleteAssetType.

#### Sample Request
<a name="API_DeleteAssetType_Example_1_Request"></a>

```
aws datazone delete-asset-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "CustomerDataAssetType"
```

### Example
<a name="API_DeleteAssetType_Example_2"></a>

Failure case - already deleted or non-existent type:

#### Sample Request
<a name="API_DeleteAssetType_Example_2_Request"></a>

```
aws datazone get-asset-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "NonExistentAssetType"
```

#### Sample Response
<a name="API_DeleteAssetType_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the GetAssetType operation: The given AssetType doesn't exist. Try creating AssetType before accessing it.
```

### Example
<a name="API_DeleteAssetType_Example_3"></a>

Failure case - missing `--identifier` 

#### Sample Request
<a name="API_DeleteAssetType_Example_3_Request"></a>

```
aws datazone delete-asset-type \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_DeleteAssetType_Example_3_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

## See Also
<a name="API_DeleteAssetType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteAssetType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteAssetType) 

# DeleteConnection
<a name="API_DeleteConnection"></a>

Deletes and connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

## Request Syntax
<a name="API_DeleteConnection_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/connections/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteConnection_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteConnection_RequestSyntax) **   <a name="datazone-DeleteConnection-request-uri-domainIdentifier"></a>
The ID of the domain where the connection is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteConnection_RequestSyntax) **   <a name="datazone-DeleteConnection-request-uri-identifier"></a>
The ID of the connection that is deleted.  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: Yes

## Request Body
<a name="API_DeleteConnection_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteConnection_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_DeleteConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [status](#API_DeleteConnection_ResponseSyntax) **   <a name="datazone-DeleteConnection-response-status"></a>
The status of the action.  
Type: String

## Errors
<a name="API_DeleteConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteConnection) 

# DeleteDataExportConfiguration
<a name="API_DeleteDataExportConfiguration"></a>

Deletes data export configuration for a domain.

This operation does not delete the S3 table created by the PutDataExportConfiguration operation.

To temporarily disable export without deleting the configuration, use the PutDataExportConfiguration operation with the `--no-enable-export` flag instead. This allows you to re-enable export for the same domain using the `--enable-export` flag without deleting S3 table.

## Request Syntax
<a name="API_DeleteDataExportConfiguration_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/data-export-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataExportConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteDataExportConfiguration_RequestSyntax) **   <a name="datazone-DeleteDataExportConfiguration-request-uri-domainIdentifier"></a>
The domain ID for which you want to delete the data export configuration.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteDataExportConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataExportConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteDataExportConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteDataExportConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDataExportConfiguration_Examples"></a>

### Example
<a name="API_DeleteDataExportConfiguration_Example_1"></a>

Delete data export configuration:

#### Sample Request
<a name="API_DeleteDataExportConfiguration_Example_1_Request"></a>

```
aws datazone delete-data-export-configuration --domain-identifier dzd-440699i00ezy21 --region us-east-2
```

## See Also
<a name="API_DeleteDataExportConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteDataExportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteDataExportConfiguration) 

# DeleteDataProduct
<a name="API_DeleteDataProduct"></a>

Deletes a data product in Amazon DataZone.

Prerequisites:
+ The data product must exist and not be deleted or archived. 
+ The user must have delete permissions for the data product.
+ Domain and project must be active.

## Request Syntax
<a name="API_DeleteDataProduct_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/data-products/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataProduct_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteDataProduct_RequestSyntax) **   <a name="datazone-DeleteDataProduct-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the data product is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteDataProduct_RequestSyntax) **   <a name="datazone-DeleteDataProduct-request-uri-identifier"></a>
The identifier of the data product that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteDataProduct_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataProduct_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteDataProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteDataProduct_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteDataProduct_Examples"></a>

### Example
<a name="API_DeleteDataProduct_Example_1"></a>

This example illustrates one usage of DeleteDataProduct.

#### Sample Request
<a name="API_DeleteDataProduct_Example_1_Request"></a>

```
aws datazone delete-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd9m3nqx2wkfp"
```

### Example
<a name="API_DeleteDataProduct_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_DeleteDataProduct_Example_2_Request"></a>

```
aws datazone delete-data-product \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_DeleteDataProduct_Example_2_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

### Example
<a name="API_DeleteDataProduct_Example_3"></a>

Failure case - resource not found

#### Sample Request
<a name="API_DeleteDataProduct_Example_3_Request"></a>

```
aws datazone delete-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd_nonexistent"
```

#### Sample Response
<a name="API_DeleteDataProduct_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the DeleteDataProduct operation: Requested dataProduct cannot be found in domain
```

## See Also
<a name="API_DeleteDataProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteDataProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteDataProduct) 

# DeleteDataSource
<a name="API_DeleteDataSource"></a>

Deletes a data source in Amazon DataZone.

## Request Syntax
<a name="API_DeleteDataSource_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/data-sources/identifier?clientToken=clientToken&retainPermissionsOnRevokeFailure=retainPermissionsOnRevokeFailure HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeleteDataSource_RequestSyntax) **   <a name="datazone-DeleteDataSource-request-uri-clientToken"></a>
 *This parameter has been deprecated.*   
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

 ** [domainIdentifier](#API_DeleteDataSource_RequestSyntax) **   <a name="datazone-DeleteDataSource-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the data source is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteDataSource_RequestSyntax) **   <a name="datazone-DeleteDataSource-request-uri-identifier"></a>
The identifier of the data source that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [retainPermissionsOnRevokeFailure](#API_DeleteDataSource_RequestSyntax) **   <a name="datazone-DeleteDataSource-request-uri-retainPermissionsOnRevokeFailure"></a>
Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

## Request Body
<a name="API_DeleteDataSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "configuration": { ... },
   "connectionId": "string",
   "createdAt": "string",
   "description": "string",
   "domainId": "string",
   "enableSetting": "string",
   "environmentId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "lastRunAt": "string",
   "lastRunErrorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "lastRunStatus": "string",
   "name": "string",
   "projectId": "string",
   "publishOnImport": boolean,
   "retainPermissionsOnRevokeFailure": boolean,
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "selfGrantStatus": { ... },
   "status": "string",
   "type": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_DeleteDataSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetFormsOutput](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-assetFormsOutput"></a>
The asset data forms associated with this data source.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [configuration](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-configuration"></a>
The configuration of the data source that is deleted.  
Type: [DataSourceConfigurationOutput](API_DataSourceConfigurationOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [connectionId](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-connectionId"></a>
The ID of the connection that is deleted.  
Type: String

 ** [createdAt](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-createdAt"></a>
The timestamp of when this data source was created.  
Type: Timestamp

 ** [description](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-description"></a>
The description of the data source that is deleted.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-domainId"></a>
The ID of the Amazon DataZone domain in which the data source is deleted.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [enableSetting](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-enableSetting"></a>
The enable setting of the data source that specifies whether the data source is enabled or disabled.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [environmentId](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-environmentId"></a>
The ID of the environemnt associated with this data source.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [errorMessage](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-errorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [id](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-id"></a>
The ID of the data source that is deleted.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastRunAt](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-lastRunAt"></a>
The timestamp of when the data source was last run.  
Type: Timestamp

 ** [lastRunErrorMessage](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-lastRunErrorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [lastRunStatus](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-lastRunStatus"></a>
The status of the last run of this data source.  
Type: String  
Valid Values: `REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS` 

 ** [name](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-name"></a>
The name of the data source that is deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [projectId](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-projectId"></a>
The ID of the project in which this data source exists and from which it's deleted.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [publishOnImport](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-publishOnImport"></a>
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.  
Type: Boolean

 ** [retainPermissionsOnRevokeFailure](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-retainPermissionsOnRevokeFailure"></a>
Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.  
Type: Boolean

 ** [schedule](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-schedule"></a>
The schedule of runs for this data source.  
Type: [ScheduleConfiguration](API_ScheduleConfiguration.md) object

 ** [selfGrantStatus](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-selfGrantStatus"></a>
Specifies the status of the self-granting functionality.  
Type: [SelfGrantStatusOutput](API_SelfGrantStatusOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-status"></a>
The status of this data source.  
Type: String  
Valid Values: `CREATING | FAILED_CREATION | READY | UPDATING | FAILED_UPDATE | RUNNING | DELETING | FAILED_DELETION` 

 ** [type](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-type"></a>
The type of this data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [updatedAt](#API_DeleteDataSource_ResponseSyntax) **   <a name="datazone-DeleteDataSource-response-updatedAt"></a>
The timestamp of when this data source was updated.  
Type: Timestamp

## Errors
<a name="API_DeleteDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteDataSource) 

# DeleteDomain
<a name="API_DeleteDomain"></a>

Deletes a Amazon DataZone domain.

## Request Syntax
<a name="API_DeleteDomain_RequestSyntax"></a>

```
DELETE /v2/domains/identifier?clientToken=clientToken&skipDeletionCheck=skipDeletionCheck HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeleteDomain_RequestSyntax) **   <a name="datazone-DeleteDomain-request-uri-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

 ** [identifier](#API_DeleteDomain_RequestSyntax) **   <a name="datazone-DeleteDomain-request-uri-identifier"></a>
The identifier of the AWS domain that is to be deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [skipDeletionCheck](#API_DeleteDomain_RequestSyntax) **   <a name="datazone-DeleteDomain-request-uri-skipDeletionCheck"></a>
Specifies the optional flag to delete all child entities within the domain.

## Request Body
<a name="API_DeleteDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDomain_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "status": "string"
}
```

## Response Elements
<a name="API_DeleteDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

 ** [status](#API_DeleteDomain_ResponseSyntax) **   <a name="datazone-DeleteDomain-response-status"></a>
The status of the domain.  
Type: String  
Valid Values: `CREATING | AVAILABLE | CREATION_FAILED | DELETING | DELETED | DELETION_FAILED` 

## Errors
<a name="API_DeleteDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteDomain) 

# DeleteDomainUnit
<a name="API_DeleteDomainUnit"></a>

Deletes a domain unit.

## Request Syntax
<a name="API_DeleteDomainUnit_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/domain-units/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDomainUnit_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteDomainUnit_RequestSyntax) **   <a name="datazone-DeleteDomainUnit-request-uri-domainIdentifier"></a>
The ID of the domain where you want to delete a domain unit.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteDomainUnit_RequestSyntax) **   <a name="datazone-DeleteDomainUnit-request-uri-identifier"></a>
The ID of the domain unit that you want to delete.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: Yes

## Request Body
<a name="API_DeleteDomainUnit_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDomainUnit_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteDomainUnit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteDomainUnit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteDomainUnit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteDomainUnit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteDomainUnit) 

# DeleteEnvironment
<a name="API_DeleteEnvironment"></a>

Deletes an environment in Amazon DataZone.

## Request Syntax
<a name="API_DeleteEnvironment_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/environments/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteEnvironment_RequestSyntax) **   <a name="datazone-DeleteEnvironment-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the environment is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteEnvironment_RequestSyntax) **   <a name="datazone-DeleteEnvironment-request-uri-identifier"></a>
The identifier of the environment that is to be deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteEnvironment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteEnvironment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteEnvironment) 

# DeleteEnvironmentAction
<a name="API_DeleteEnvironmentAction"></a>

Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

## Request Syntax
<a name="API_DeleteEnvironmentAction_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/environments/environmentIdentifier/actions/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEnvironmentAction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteEnvironmentAction_RequestSyntax) **   <a name="datazone-DeleteEnvironmentAction-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which an environment action is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_DeleteEnvironmentAction_RequestSyntax) **   <a name="datazone-DeleteEnvironmentAction-request-uri-environmentIdentifier"></a>
The ID of the environment where an environment action is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteEnvironmentAction_RequestSyntax) **   <a name="datazone-DeleteEnvironmentAction-request-uri-identifier"></a>
The ID of the environment action that is deleted.  
Required: Yes

## Request Body
<a name="API_DeleteEnvironmentAction_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEnvironmentAction_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteEnvironmentAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteEnvironmentAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteEnvironmentAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteEnvironmentAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteEnvironmentAction) 

# DeleteEnvironmentBlueprint
<a name="API_DeleteEnvironmentBlueprint"></a>

Deletes a blueprint in Amazon DataZone.

## Request Syntax
<a name="API_DeleteEnvironmentBlueprint_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/environment-blueprints/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEnvironmentBlueprint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-DeleteEnvironmentBlueprint-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the blueprint is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-DeleteEnvironmentBlueprint-request-uri-identifier"></a>
The ID of the blueprint that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteEnvironmentBlueprint_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEnvironmentBlueprint_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteEnvironmentBlueprint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteEnvironmentBlueprint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteEnvironmentBlueprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteEnvironmentBlueprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteEnvironmentBlueprint) 

# DeleteEnvironmentBlueprintConfiguration
<a name="API_DeleteEnvironmentBlueprintConfiguration"></a>

Deletes the blueprint configuration in Amazon DataZone.

## Request Syntax
<a name="API_DeleteEnvironmentBlueprintConfiguration_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/environment-blueprint-configurations/environmentBlueprintIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEnvironmentBlueprintConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-DeleteEnvironmentBlueprintConfiguration-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentBlueprintIdentifier](#API_DeleteEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-DeleteEnvironmentBlueprintConfiguration-request-uri-environmentBlueprintIdentifier"></a>
The ID of the blueprint the configuration of which is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteEnvironmentBlueprintConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEnvironmentBlueprintConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteEnvironmentBlueprintConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteEnvironmentBlueprintConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteEnvironmentBlueprintConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteEnvironmentBlueprintConfiguration) 

# DeleteEnvironmentProfile
<a name="API_DeleteEnvironmentProfile"></a>

Deletes an environment profile in Amazon DataZone.

## Request Syntax
<a name="API_DeleteEnvironmentProfile_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/environment-profiles/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEnvironmentProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteEnvironmentProfile_RequestSyntax) **   <a name="datazone-DeleteEnvironmentProfile-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the environment profile is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteEnvironmentProfile_RequestSyntax) **   <a name="datazone-DeleteEnvironmentProfile-request-uri-identifier"></a>
The ID of the environment profile that is deleted.  
Pattern: `[a-zA-Z0-9_-]{0,36}`   
Required: Yes

## Request Body
<a name="API_DeleteEnvironmentProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEnvironmentProfile_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteEnvironmentProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteEnvironmentProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteEnvironmentProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteEnvironmentProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteEnvironmentProfile) 

# DeleteFormType
<a name="API_DeleteFormType"></a>

Deletes and metadata form type in Amazon DataZone.

Prerequisites:
+ The form type must exist in the domain. 
+ The form type must not be in use by any asset types or assets.
+ The domain must be valid and accessible.
+ User must have delete permissions on the form type.
+ Any dependencies (such as linked asset types) must be removed first.

## Request Syntax
<a name="API_DeleteFormType_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/form-types/formTypeIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteFormType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteFormType_RequestSyntax) **   <a name="datazone-DeleteFormType-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the metadata form type is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [formTypeIdentifier](#API_DeleteFormType_RequestSyntax) **   <a name="datazone-DeleteFormType-request-uri-formTypeIdentifier"></a>
The ID of the metadata form type that is deleted.  
Length Constraints: Minimum length of 1. Maximum length of 385.  
Pattern: `(?!\.)[\w\.]*\w`   
Required: Yes

## Request Body
<a name="API_DeleteFormType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteFormType_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteFormType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteFormType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteFormType_Examples"></a>

### Example
<a name="API_DeleteFormType_Example_1"></a>

This example illustrates one usage of DeleteFormType.

#### Sample Request
<a name="API_DeleteFormType_Example_1_Request"></a>

```
aws datazone delete-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "CustomerPreferencesFormType"
```

### Example
<a name="API_DeleteFormType_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_DeleteFormType_Example_2_Request"></a>

```
aws datazone delete-form-type \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_DeleteFormType_Example_2_Response"></a>

```
aws: error: the following arguments are required: —form-type-identifier
```

### Example
<a name="API_DeleteFormType_Example_3"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_DeleteFormType_Example_3_Request"></a>

```
aws datazone delete-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "NonExistentFormType"
```

#### Sample Response
<a name="API_DeleteFormType_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the DeleteFormType operation: Requested FormType cannot be found in domain
```

## See Also
<a name="API_DeleteFormType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteFormType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteFormType) 

# DeleteGlossary
<a name="API_DeleteGlossary"></a>

Deletes a business glossary in Amazon DataZone.

Prerequisites:
+ The glossary must be in DISABLED state. 
+ The glossary must not have any glossary terms associated with it.
+ The glossary must exist in the specified domain.
+ The caller must have the `datazone:DeleteGlossary` permission in the domain and glossary.
+ Glossary should not be linked to any active metadata forms.

## Request Syntax
<a name="API_DeleteGlossary_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/glossaries/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteGlossary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteGlossary_RequestSyntax) **   <a name="datazone-DeleteGlossary-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the business glossary is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteGlossary_RequestSyntax) **   <a name="datazone-DeleteGlossary-request-uri-identifier"></a>
The ID of the business glossary that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteGlossary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteGlossary_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteGlossary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteGlossary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteGlossary_Examples"></a>

### Example
<a name="API_DeleteGlossary_Example_1"></a>

This example illustrates one usage of DeleteGlossary.

#### Sample Request
<a name="API_DeleteGlossary_Example_1_Request"></a>

```
aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"
```

### Example
<a name="API_DeleteGlossary_Example_2"></a>

Failure case - glossary must be disabled:

#### Sample Request
<a name="API_DeleteGlossary_Example_2_Request"></a>

```
aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"
```

#### Sample Response
<a name="API_DeleteGlossary_Example_2_Response"></a>

```
An error occurred (ValidationException) when calling the DeleteGlossary operation: Glossary must be DISABLED for deletion
```

### Example
<a name="API_DeleteGlossary_Example_3"></a>

Failure case - conflict is data is associated with it:

#### Sample Request
<a name="API_DeleteGlossary_Example_3_Request"></a>

```
aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"
```

#### Sample Response
<a name="API_DeleteGlossary_Example_3_Response"></a>

```
An error occurred (ConflictException) when calling the DeleteGlossary operation: Glossary can't be deleted while having glossary terms attached
```

### Example
<a name="API_DeleteGlossary_Example_4"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_DeleteGlossary_Example_4_Request"></a>

```
aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls_nonexistent"
```

#### Sample Response
<a name="API_DeleteGlossary_Example_4_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the DeleteGlossary operation: Requested businessGlossary cannot be found in domain
```

### Example
<a name="API_DeleteGlossary_Example_5"></a>

Failure case - missing required parameter

#### Sample Request
<a name="API_DeleteGlossary_Example_5_Request"></a>

```
 aws datazone delete-glossary \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_DeleteGlossary_Example_5_Response"></a>

```
aws: error: the following arguments are required: --identifier
```

## See Also
<a name="API_DeleteGlossary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteGlossary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteGlossary) 

# DeleteGlossaryTerm
<a name="API_DeleteGlossaryTerm"></a>

Deletes a business glossary term in Amazon DataZone.

Prerequisites:
+ Glossary term must exist and be active. 
+ The term must not be linked to other assets or child terms.
+ Caller must have delete permissions in the domain/glossary.
+ Ensure all associations (such as to assets or parent terms) are removed before deletion.

## Request Syntax
<a name="API_DeleteGlossaryTerm_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/glossary-terms/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteGlossaryTerm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteGlossaryTerm_RequestSyntax) **   <a name="datazone-DeleteGlossaryTerm-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the business glossary term is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteGlossaryTerm_RequestSyntax) **   <a name="datazone-DeleteGlossaryTerm-request-uri-identifier"></a>
The ID of the business glossary term that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteGlossaryTerm_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteGlossaryTerm_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteGlossaryTerm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteGlossaryTerm_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteGlossaryTerm_Examples"></a>

### Example
<a name="API_DeleteGlossaryTerm_Example_1"></a>

This example illustrates one usage of DeleteGlossaryTerm.

#### Sample Request
<a name="API_DeleteGlossaryTerm_Example_1_Request"></a>

```
aws datazone delete-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm9k4pq7xwnmh"
```

### Example
<a name="API_DeleteGlossaryTerm_Example_2"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_DeleteGlossaryTerm_Example_2_Request"></a>

```
aws datazone delete-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm_nonexistent"
```

#### Sample Response
<a name="API_DeleteGlossaryTerm_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the DeleteGlossaryTerm operation: Requested glossaryTerm cannot be found in domain
```

### Example
<a name="API_DeleteGlossaryTerm_Example_3"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_DeleteGlossaryTerm_Example_3_Request"></a>

```
aws datazone delete-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_DeleteGlossaryTerm_Example_3_Response"></a>

```
aws: error: the following arguments are required: --identifier
```

## See Also
<a name="API_DeleteGlossaryTerm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteGlossaryTerm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteGlossaryTerm) 

# DeleteListing
<a name="API_DeleteListing"></a>

Deletes a listing (a record of an asset at a given time).

## Request Syntax
<a name="API_DeleteListing_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/listings/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteListing_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteListing_RequestSyntax) **   <a name="datazone-DeleteListing-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteListing_RequestSyntax) **   <a name="datazone-DeleteListing-request-uri-identifier"></a>
The ID of the listing to be deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteListing_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteListing_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteListing_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteListing_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteListing_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteListing) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteListing) 

# DeleteProject
<a name="API_DeleteProject"></a>

Deletes a project in Amazon DataZone. 

## Request Syntax
<a name="API_DeleteProject_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/projects/identifier?skipDeletionCheck=skipDeletionCheck HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteProject_RequestSyntax) **   <a name="datazone-DeleteProject-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the project is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteProject_RequestSyntax) **   <a name="datazone-DeleteProject-request-uri-identifier"></a>
The identifier of the project that is to be deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [skipDeletionCheck](#API_DeleteProject_RequestSyntax) **   <a name="datazone-DeleteProject-request-uri-skipDeletionCheck"></a>
Specifies the optional flag to delete all child entities within the project.

## Request Body
<a name="API_DeleteProject_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteProject_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteProject) 

# DeleteProjectMembership
<a name="API_DeleteProjectMembership"></a>

Deletes project membership in Amazon DataZone.

## Request Syntax
<a name="API_DeleteProjectMembership_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/projects/projectIdentifier/deleteMembership HTTP/1.1
Content-type: application/json

{
   "member": { ... }
}
```

## URI Request Parameters
<a name="API_DeleteProjectMembership_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteProjectMembership_RequestSyntax) **   <a name="datazone-DeleteProjectMembership-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where project membership is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [projectIdentifier](#API_DeleteProjectMembership_RequestSyntax) **   <a name="datazone-DeleteProjectMembership-request-uri-projectIdentifier"></a>
The ID of the Amazon DataZone project the membership to which is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteProjectMembership_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [member](#API_DeleteProjectMembership_RequestSyntax) **   <a name="datazone-DeleteProjectMembership-request-member"></a>
The project member whose project membership is deleted.  
Type: [Member](API_Member.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_DeleteProjectMembership_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteProjectMembership_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteProjectMembership_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProjectMembership_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteProjectMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteProjectMembership) 

# DeleteProjectProfile
<a name="API_DeleteProjectProfile"></a>

Deletes a project profile.

## Request Syntax
<a name="API_DeleteProjectProfile_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/project-profiles/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteProjectProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteProjectProfile_RequestSyntax) **   <a name="datazone-DeleteProjectProfile-request-uri-domainIdentifier"></a>
The ID of the domain where a project profile is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteProjectProfile_RequestSyntax) **   <a name="datazone-DeleteProjectProfile-request-uri-identifier"></a>
The ID of the project profile that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteProjectProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteProjectProfile_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteProjectProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteProjectProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProjectProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteProjectProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteProjectProfile) 

# DeleteRule
<a name="API_DeleteRule"></a>

Deletes a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

## Request Syntax
<a name="API_DeleteRule_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/rules/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteRule_RequestSyntax) **   <a name="datazone-DeleteRule-request-uri-domainIdentifier"></a>
The ID of the domain that where the rule is to be deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteRule_RequestSyntax) **   <a name="datazone-DeleteRule-request-uri-identifier"></a>
The ID of the rule that is to be deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRule_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteRule) 

# DeleteSubscriptionGrant
<a name="API_DeleteSubscriptionGrant"></a>

Deletes and subscription grant in Amazon DataZone.

## Request Syntax
<a name="API_DeleteSubscriptionGrant_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/subscription-grants/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSubscriptionGrant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteSubscriptionGrant_RequestSyntax) **   <a name="datazone-DeleteSubscriptionGrant-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where the subscription grant is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteSubscriptionGrant_RequestSyntax) **   <a name="datazone-DeleteSubscriptionGrant-request-uri-identifier"></a>
The ID of the subscription grant that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteSubscriptionGrant_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSubscriptionGrant_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assets": [ 
      { 
         "assetId": "string",
         "assetRevision": "string",
         "assetScope": { 
            "assetId": "string",
            "errorMessage": "string",
            "filterIds": [ "string" ],
            "status": "string"
         },
         "failureCause": { 
            "message": "string"
         },
         "failureTimestamp": number,
         "grantedTimestamp": number,
         "permissions": { ... },
         "status": "string",
         "targetName": "string"
      }
   ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "grantedEntity": { ... },
   "id": "string",
   "status": "string",
   "subscriptionId": "string",
   "subscriptionTargetId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_DeleteSubscriptionGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assets](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-assets"></a>
The assets for which the subsctiption grant that is deleted gave access.  
Type: Array of [SubscribedAsset](API_SubscribedAsset.md) objects

 ** [createdAt](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-createdAt"></a>
The timestamp of when the subscription grant that is deleted was created.  
Type: Timestamp

 ** [createdBy](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-createdBy"></a>
The Amazon DataZone user who created the subscription grant that is deleted.  
Type: String

 ** [domainId](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-domainId"></a>
The ID of the Amazon DataZone domain in which the subscription grant is deleted.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-environmentId"></a>
The ID of the environment in which the subscription grant is deleted.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [grantedEntity](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-grantedEntity"></a>
The entity to which the subscription is deleted.  
Type: [GrantedEntity](API_GrantedEntity.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [id](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-id"></a>
The ID of the subscription grant that is deleted.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-status"></a>
The status of the subscription grant that is deleted.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | GRANT_FAILED | REVOKE_FAILED | GRANT_AND_REVOKE_FAILED | COMPLETED | INACCESSIBLE` 

 ** [subscriptionId](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-subscriptionId"></a>
 *This parameter has been deprecated.*   
The identifier of the subsctiption whose subscription grant is to be deleted.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [subscriptionTargetId](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-subscriptionTargetId"></a>
The ID of the subscription target associated with the subscription grant that is deleted.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-updatedAt"></a>
The timestamp of when the subscription grant that is deleted was updated.  
Type: Timestamp

 ** [updatedBy](#API_DeleteSubscriptionGrant_ResponseSyntax) **   <a name="datazone-DeleteSubscriptionGrant-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription grant that is deleted.  
Type: String

## Errors
<a name="API_DeleteSubscriptionGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteSubscriptionGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteSubscriptionGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteSubscriptionGrant) 

# DeleteSubscriptionRequest
<a name="API_DeleteSubscriptionRequest"></a>

Deletes a subscription request in Amazon DataZone.

## Request Syntax
<a name="API_DeleteSubscriptionRequest_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/subscription-requests/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSubscriptionRequest_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteSubscriptionRequest_RequestSyntax) **   <a name="datazone-DeleteSubscriptionRequest-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the subscription request is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteSubscriptionRequest_RequestSyntax) **   <a name="datazone-DeleteSubscriptionRequest-request-uri-identifier"></a>
The ID of the subscription request that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteSubscriptionRequest_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSubscriptionRequest_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteSubscriptionRequest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteSubscriptionRequest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteSubscriptionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteSubscriptionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteSubscriptionRequest) 

# DeleteSubscriptionTarget
<a name="API_DeleteSubscriptionTarget"></a>

Deletes a subscription target in Amazon DataZone.

## Request Syntax
<a name="API_DeleteSubscriptionTarget_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/environments/environmentIdentifier/subscription-targets/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSubscriptionTarget_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DeleteSubscriptionTarget_RequestSyntax) **   <a name="datazone-DeleteSubscriptionTarget-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the subscription target is deleted.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_DeleteSubscriptionTarget_RequestSyntax) **   <a name="datazone-DeleteSubscriptionTarget-request-uri-environmentIdentifier"></a>
The ID of the Amazon DataZone environment in which the subscription target is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_DeleteSubscriptionTarget_RequestSyntax) **   <a name="datazone-DeleteSubscriptionTarget-request-uri-identifier"></a>
The ID of the subscription target that is deleted.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_DeleteSubscriptionTarget_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSubscriptionTarget_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteSubscriptionTarget_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteSubscriptionTarget_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteSubscriptionTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteSubscriptionTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteSubscriptionTarget) 

# DeleteTimeSeriesDataPoints
<a name="API_DeleteTimeSeriesDataPoints"></a>

Deletes the specified time series form for the specified asset. 

## Request Syntax
<a name="API_DeleteTimeSeriesDataPoints_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/time-series-data-points?clientToken=clientToken&formName=formName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteTimeSeriesDataPoints_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_DeleteTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-DeleteTimeSeriesDataPoints-request-uri-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+` 

 ** [domainIdentifier](#API_DeleteTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-DeleteTimeSeriesDataPoints-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_DeleteTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-DeleteTimeSeriesDataPoints-request-uri-entityIdentifier"></a>
The ID of the asset for which you want to delete a time series form.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityType](#API_DeleteTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-DeleteTimeSeriesDataPoints-request-uri-entityType"></a>
The type of the asset for which you want to delete a time series form.  
Valid Values: `ASSET | LISTING`   
Required: Yes

 ** [formName](#API_DeleteTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-DeleteTimeSeriesDataPoints-request-uri-formName"></a>
The name of the time series form that you want to delete.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Request Body
<a name="API_DeleteTimeSeriesDataPoints_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteTimeSeriesDataPoints_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_DeleteTimeSeriesDataPoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_DeleteTimeSeriesDataPoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteTimeSeriesDataPoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DeleteTimeSeriesDataPoints) 

# DisassociateEnvironmentRole
<a name="API_DisassociateEnvironmentRole"></a>

Disassociates the environment role in Amazon DataZone.

## Request Syntax
<a name="API_DisassociateEnvironmentRole_RequestSyntax"></a>

```
DELETE /v2/domains/domainIdentifier/environments/environmentIdentifier/roles/environmentRoleArn HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateEnvironmentRole_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DisassociateEnvironmentRole_RequestSyntax) **   <a name="datazone-DisassociateEnvironmentRole-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which an environment role is disassociated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_DisassociateEnvironmentRole_RequestSyntax) **   <a name="datazone-DisassociateEnvironmentRole-request-uri-environmentIdentifier"></a>
The ID of the environment.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentRoleArn](#API_DisassociateEnvironmentRole_RequestSyntax) **   <a name="datazone-DisassociateEnvironmentRole-request-uri-environmentRoleArn"></a>
The ARN of the environment role.  
Required: Yes

## Request Body
<a name="API_DisassociateEnvironmentRole_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateEnvironmentRole_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateEnvironmentRole_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateEnvironmentRole_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateEnvironmentRole_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DisassociateEnvironmentRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DisassociateEnvironmentRole) 

# DisassociateGovernedTerms
<a name="API_DisassociateGovernedTerms"></a>

Disassociates restricted terms from an asset.

## Request Syntax
<a name="API_DisassociateGovernedTerms_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/disassociate-governed-terms HTTP/1.1
Content-type: application/json

{
   "governedGlossaryTerms": [ "string" ]
}
```

## URI Request Parameters
<a name="API_DisassociateGovernedTerms_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_DisassociateGovernedTerms_RequestSyntax) **   <a name="datazone-DisassociateGovernedTerms-request-uri-domainIdentifier"></a>
The ID of the domain where you want to disassociate restricted terms from an asset.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_DisassociateGovernedTerms_RequestSyntax) **   <a name="datazone-DisassociateGovernedTerms-request-uri-entityIdentifier"></a>
The ID of an asset from which you want to disassociate restricted terms.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityType](#API_DisassociateGovernedTerms_RequestSyntax) **   <a name="datazone-DisassociateGovernedTerms-request-uri-entityType"></a>
The type of the asset from which you want to disassociate restricted terms.  
Valid Values: `ASSET`   
Required: Yes

## Request Body
<a name="API_DisassociateGovernedTerms_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [governedGlossaryTerms](#API_DisassociateGovernedTerms_RequestSyntax) **   <a name="datazone-DisassociateGovernedTerms-request-governedGlossaryTerms"></a>
The restricted glossary terms that you want to disassociate from an asset.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Response Syntax
<a name="API_DisassociateGovernedTerms_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateGovernedTerms_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateGovernedTerms_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateGovernedTerms_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/DisassociateGovernedTerms) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/DisassociateGovernedTerms) 

# GetAccountPool
<a name="API_GetAccountPool"></a>

Gets the details of the account pool.

## Request Syntax
<a name="API_GetAccountPool_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/account-pools/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAccountPool_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetAccountPool_RequestSyntax) **   <a name="datazone-GetAccountPool-request-uri-domainIdentifier"></a>
The ID of the domain in which the account pool lives whose details are to be displayed.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetAccountPool_RequestSyntax) **   <a name="datazone-GetAccountPool-request-uri-identifier"></a>
The ID of the account pool whose details are to be displayed.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetAccountPool_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAccountPool_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accountSource": { ... },
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "resolutionStrategy": "string",
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_GetAccountPool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountSource](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-accountSource"></a>
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom AWS Lambda handler.   
Type: [AccountSource](API_AccountSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdAt](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-createdAt"></a>
The timestamp at which the account pool was created.  
Type: Timestamp

 ** [createdBy](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-createdBy"></a>
The user who created the account pool.  
Type: String

 ** [description](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-description"></a>
The description of the account pool.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-domainId"></a>
The ID of the domain in which the account pool lives whose details are to be displayed.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-domainUnitId"></a>
The domain unit ID of the account pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [id](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-id"></a>
The ID of the account pool.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-lastUpdatedAt"></a>
The timestamp at which the account pool was last updated.  
Type: Timestamp

 ** [name](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-name"></a>
The name of the account pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [resolutionStrategy](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-resolutionStrategy"></a>
The mechanism used to resolve the account selection from the account pool.  
Type: String  
Valid Values: `MANUAL` 

 ** [updatedBy](#API_GetAccountPool_ResponseSyntax) **   <a name="datazone-GetAccountPool-response-updatedBy"></a>
The user who last updated the account pool.  
Type: String

## Errors
<a name="API_GetAccountPool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetAccountPool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetAccountPool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetAccountPool) 

# GetAsset
<a name="API_GetAsset"></a>

Gets an Amazon DataZone asset.

An asset is the fundamental building block in Amazon DataZone, representing any data resource that needs to be cataloged and managed. It can take many forms, from Amazon S3 buckets and database tables to dashboards and machine learning models. Each asset contains comprehensive metadata about the resource, including its location, schema, ownership, and lineage information. Assets are essential for organizing and managing data resources across an organization, making them discoverable and usable while maintaining proper governance.

Before using the Amazon DataZone GetAsset command, ensure the following prerequisites are met:
+ Domain identifier must exist and be valid
+ Asset identifier must exist
+ User must have the required permissions to perform the action

## Request Syntax
<a name="API_GetAsset_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/assets/identifier?revision=revision HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAsset_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetAsset_RequestSyntax) **   <a name="datazone-GetAsset-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain to which the asset belongs.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetAsset_RequestSyntax) **   <a name="datazone-GetAsset-request-uri-identifier"></a>
The ID of the Amazon DataZone asset.  
This parameter supports either the value of `assetId` or `externalIdentifier` as input. If you are passing the value of `externalIdentifier`, you must prefix this value with `externalIdentifer%2F`.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [revision](#API_GetAsset_RequestSyntax) **   <a name="datazone-GetAsset-request-uri-revision"></a>
The revision of the Amazon DataZone asset.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_GetAsset_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAsset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "externalIdentifier": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "governedGlossaryTerms": [ "string" ],
   "id": "string",
   "latestTimeSeriesDataPointFormsOutput": [ 
      { 
         "contentSummary": "string",
         "formName": "string",
         "id": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "listing": { 
      "listingId": "string",
      "listingStatus": "string"
   },
   "name": "string",
   "owningProjectId": "string",
   "readOnlyFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "revision": "string",
   "typeIdentifier": "string",
   "typeRevision": "string"
}
```

## Response Elements
<a name="API_GetAsset_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-createdAt"></a>
The timestamp of when the asset was created.  
Type: Timestamp

 ** [createdBy](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-createdBy"></a>
The Amazon DataZone user who created the asset.  
Type: String

 ** [description](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-description"></a>
The description of the Amazon DataZone asset.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-domainId"></a>
The ID of the Amazon DataZone domain to which the asset belongs.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [externalIdentifier](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-externalIdentifier"></a>
The external ID of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 600.

 ** [firstRevisionCreatedAt](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-firstRevisionCreatedAt"></a>
The timestamp of when the first revision of the asset was created.  
Type: Timestamp

 ** [firstRevisionCreatedBy](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-firstRevisionCreatedBy"></a>
The Amazon DataZone user who created the first revision of the asset.  
Type: String

 ** [formsOutput](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-formsOutput"></a>
The metadata forms attached to the asset.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [glossaryTerms](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-glossaryTerms"></a>
The business glossary terms attached to the asset.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [governedGlossaryTerms](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-governedGlossaryTerms"></a>
The restricted glossary terms attached to an asset.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-id"></a>
The ID of the asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [latestTimeSeriesDataPointFormsOutput](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-latestTimeSeriesDataPointFormsOutput"></a>
The latest data point that was imported into the time series form for the asset.   
Type: Array of [TimeSeriesDataPointSummaryFormOutput](API_TimeSeriesDataPointSummaryFormOutput.md) objects

 ** [listing](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-listing"></a>
The listing of the asset.  
Type: [AssetListingDetails](API_AssetListingDetails.md) object

 ** [name](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-name"></a>
The name of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [owningProjectId](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-owningProjectId"></a>
The ID of the project that owns the asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [readOnlyFormsOutput](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-readOnlyFormsOutput"></a>
The read-only metadata forms attached to the asset.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [revision](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-revision"></a>
The revision of the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [typeIdentifier](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-typeIdentifier"></a>
The ID of the asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 513.  
Pattern: `(?!\.)[\w\.]*\w` 

 ** [typeRevision](#API_GetAsset_ResponseSyntax) **   <a name="datazone-GetAsset-response-typeRevision"></a>
The revision of the asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Errors
<a name="API_GetAsset_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetAsset_Examples"></a>

### Example
<a name="API_GetAsset_Example_1"></a>

Use the following command to retrieve an asset from Amazon DataZone:

#### Sample Request
<a name="API_GetAsset_Example_1_Request"></a>

```
aws datazone get-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4w"
```

#### Sample Response
<a name="API_GetAsset_Example_1_Response"></a>

```
{
    "createdAt": 1752554243.917,
    "createdBy": "user_id_redacted",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752554243.917,
    "firstRevisionCreatedBy": "user_id_redacted",
    "formsOutput": [{
        "content": "{\"bucketArn\":\"arn:aws:s3:::analytics-data-bucket\"}",
        "formName": "CustomerAnalyticsForm",
        "typeName": "amazon.datazone.S3ObjectCollectionFormType",
        "typeRevision": "7"
    }],
    "id": "ast7k9mpq2xvn4w",
    "latestTimeSeriesDataPointFormsOutput": [],
    "name": "CustomerAnalytics2023",
    "owningProjectId": "prj9vn4wxyz8k2m",
    "readOnlyFormsOutput": [],
    "revision": "1",
    "typeIdentifier": "amazon.datazone.S3ObjectCollectionAssetType",
    "typeRevision": "13"
}
```

### Example
<a name="API_GetAsset_Example_2"></a>

When the specified asset does not exist, the command will fail:

#### Sample Request
<a name="API_GetAsset_Example_2_Request"></a>

```
aws datazone get-asset \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "astnonexistent2m4"
```

#### Sample Response
<a name="API_GetAsset_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the GetAsset operation: The given Asset doesn't exist. Try creating Asset before accessing it.
```

### Example
<a name="API_GetAsset_Example_3"></a>

When a required parameter is missing, the command will fail:

#### Sample Request
<a name="API_GetAsset_Example_3_Request"></a>

```
aws datazone get-asset \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_GetAsset_Example_3_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

## See Also
<a name="API_GetAsset_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetAsset) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetAsset) 

# GetAssetFilter
<a name="API_GetAssetFilter"></a>

Gets an asset filter.

Prerequisites:
+ Domain (`--domain-identifier`), asset (`--asset-identifier`), and filter (`--identifier`) must all exist. 
+ The asset filter should not have been deleted.
+ The asset must still exist (since the filter is linked to it).

## Request Syntax
<a name="API_GetAssetFilter_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/assets/assetIdentifier/filters/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAssetFilter_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetIdentifier](#API_GetAssetFilter_RequestSyntax) **   <a name="datazone-GetAssetFilter-request-uri-assetIdentifier"></a>
The ID of the data asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_GetAssetFilter_RequestSyntax) **   <a name="datazone-GetAssetFilter-request-uri-domainIdentifier"></a>
The ID of the domain where you want to get an asset filter.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetAssetFilter_RequestSyntax) **   <a name="datazone-GetAssetFilter-request-uri-identifier"></a>
The ID of the asset filter.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetAssetFilter_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAssetFilter_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetId": "string",
   "configuration": { ... },
   "createdAt": number,
   "description": "string",
   "domainId": "string",
   "effectiveColumnNames": [ "string" ],
   "effectiveRowFilter": "string",
   "errorMessage": "string",
   "id": "string",
   "name": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_GetAssetFilter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetId](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-assetId"></a>
The ID of the data asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [configuration](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-configuration"></a>
The configuration of the asset filter.  
Type: [AssetFilterConfiguration](API_AssetFilterConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdAt](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-createdAt"></a>
The timestamp at which the asset filter was created.  
Type: Timestamp

 ** [description](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-description"></a>
The description of the asset filter.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-domainId"></a>
The ID of the domain where you want to get an asset filter.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [effectiveColumnNames](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-effectiveColumnNames"></a>
The column names of the asset filter.  
Type: Array of strings

 ** [effectiveRowFilter](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-effectiveRowFilter"></a>
The row filter of the asset filter.  
Type: String

 ** [errorMessage](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-errorMessage"></a>
The error message that is displayed if the action does not complete successfully.  
Type: String

 ** [id](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-id"></a>
The ID of the asset filter.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-name"></a>
The name of the asset filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [status](#API_GetAssetFilter_ResponseSyntax) **   <a name="datazone-GetAssetFilter-response-status"></a>
The status of the asset filter.  
Type: String  
Valid Values: `VALID | INVALID` 

## Errors
<a name="API_GetAssetFilter_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetAssetFilter_Examples"></a>

### Example
<a name="API_GetAssetFilter_Example_1"></a>

This example illustrates one usage of GetAssetFilter.

#### Sample Request
<a name="API_GetAssetFilter_Example_1_Request"></a>

```
aws datazone get-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5"
```

#### Sample Response
<a name="API_GetAssetFilter_Example_1_Response"></a>

```
{
    "assetId": "ast7k9mpq2xvn4",
    "configuration": {
        "columnConfiguration": {
            "includedColumnNames": [
                "customer_id",
                "email",
                "phone_number",
                "address"
            ]
        }
    },
    "createdAt": 1752651315.63,
    "description": "Filter for customer PII data",
    "domainId": "dzd_53ielnpxktdilj",
    "effectiveColumnNames": [
        "customer_id",
        "email",
        "phone_number",
        "address"
    ],
    "id": "flt8p2mq3xvn5",
    "name": "customer-pii-filter",
    "status": "VALID"
}
```

### Example
<a name="API_GetAssetFilter_Example_2"></a>

Failure case - missing required option `--identifier`: 

#### Sample Request
<a name="API_GetAssetFilter_Example_2_Request"></a>

```
aws datazone get-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4"
```

#### Sample Response
<a name="API_GetAssetFilter_Example_2_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

## See Also
<a name="API_GetAssetFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetAssetFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetAssetFilter) 

# GetAssetType
<a name="API_GetAssetType"></a>

Gets an Amazon DataZone asset type.

Asset types define the categories and characteristics of different kinds of data assets within Amazon DataZone.. They determine what metadata fields are required, what operations are possible, and how the asset integrates with other AWS services. Asset types can range from built-in types like Amazon S3 buckets and AWS Glue tables to custom types defined for specific organizational needs. Understanding asset types is crucial for properly organizing and managing different kinds of data resources.

Prerequisites:
+ The asset type with identifier must exist in the domain. ResourceNotFoundException.
+ You must have the GetAssetType permission.
+ Ensure the domain-identifier value is correct and accessible.

## Request Syntax
<a name="API_GetAssetType_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/asset-types/identifier?revision=revision HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAssetType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetAssetType_RequestSyntax) **   <a name="datazone-GetAssetType-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the asset type exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetAssetType_RequestSyntax) **   <a name="datazone-GetAssetType-request-uri-identifier"></a>
The ID of the asset type.  
Length Constraints: Minimum length of 1. Maximum length of 513.  
Pattern: `(?!\.)[\w\.]*\w`   
Required: Yes

 ** [revision](#API_GetAssetType_RequestSyntax) **   <a name="datazone-GetAssetType-request-uri-revision"></a>
The revision of the asset type.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_GetAssetType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAssetType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "formsOutput": { 
      "string" : { 
         "required": boolean,
         "typeName": "string",
         "typeRevision": "string"
      }
   },
   "name": "string",
   "originDomainId": "string",
   "originProjectId": "string",
   "owningProjectId": "string",
   "revision": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_GetAssetType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-createdAt"></a>
The timestamp of when the asset type was created.  
Type: Timestamp

 ** [createdBy](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-createdBy"></a>
The Amazon DataZone user who created the asset type.  
Type: String

 ** [description](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-description"></a>
The description of the asset type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-domainId"></a>
The ID of the Amazon DataZone domain in which the asset type exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [formsOutput](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-formsOutput"></a>
The metadata forms attached to the asset type.  
Type: String to [FormEntryOutput](API_FormEntryOutput.md) object map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*` 

 ** [name](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-name"></a>
The name of the asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*` 

 ** [originDomainId](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-originDomainId"></a>
The ID of the Amazon DataZone domain in which the asset type was originally created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [originProjectId](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-originProjectId"></a>
The ID of the Amazon DataZone project in which the asset type was originally created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningProjectId](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-owningProjectId"></a>
The ID of the Amazon DataZone project that owns the asset type.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-revision"></a>
The revision of the asset type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [updatedAt](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-updatedAt"></a>
The timestamp of when the asset type was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetAssetType_ResponseSyntax) **   <a name="datazone-GetAssetType-response-updatedBy"></a>
The Amazon DataZone user that updated the asset type.  
Type: String

## Errors
<a name="API_GetAssetType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetAssetType_Examples"></a>

### Example
<a name="API_GetAssetType_Example_1"></a>

This example illustrates one usage of GetAssetType.

#### Sample Request
<a name="API_GetAssetType_Example_1_Request"></a>

```
aws datazone get-asset-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "customerAnalyticsType"
```

#### Sample Response
<a name="API_GetAssetType_Example_1_Response"></a>

```
{
    "createdAt": 1752576607.833,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "formsOutput": {
        "AssetCommonDetailsForm": {
            "required": false,
            "typeName": "amazon.datazone.AssetCommonDetailsFormType",
            "typeRevision": "6"
        }
    },
    "name": "customerAnalyticsType",
    "owningProjectId": "prj7nx82mkl",
    "revision": "1",
    "updatedAt": 1752576607.833,
    "updatedBy": "usr7nx82mkl"
}
```

### Example
<a name="API_GetAssetType_Example_2"></a>

Failure case - missing required parameter: `--identifier` 

#### Sample Request
<a name="API_GetAssetType_Example_2_Request"></a>

```
aws datazone get-asset-type \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_GetAssetType_Example_2_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

## See Also
<a name="API_GetAssetType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetAssetType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetAssetType) 

# GetConnection
<a name="API_GetConnection"></a>

Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

## Request Syntax
<a name="API_GetConnection_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/connections/identifier?withSecret=withSecret HTTP/1.1
```

## URI Request Parameters
<a name="API_GetConnection_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetConnection_RequestSyntax) **   <a name="datazone-GetConnection-request-uri-domainIdentifier"></a>
The ID of the domain where we get the connection.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetConnection_RequestSyntax) **   <a name="datazone-GetConnection-request-uri-identifier"></a>
The connection ID.  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: Yes

 ** [withSecret](#API_GetConnection_RequestSyntax) **   <a name="datazone-GetConnection-request-uri-withSecret"></a>
Specifies whether a connection has a secret.

## Request Body
<a name="API_GetConnection_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetConnection_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configurations": [ 
      { 
         "classification": "string",
         "properties": { 
            "string" : "string" 
         }
      }
   ],
   "connectionCredentials": { 
      "accessKeyId": "string",
      "expiration": "string",
      "secretAccessKey": "string",
      "sessionToken": "string"
   },
   "connectionId": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentId": "string",
   "environmentUserRole": "string",
   "name": "string",
   "physicalEndpoints": [ 
      { 
         "awsLocation": { 
            "accessRole": "string",
            "awsAccountId": "string",
            "awsRegion": "string",
            "iamConnectionId": "string"
         },
         "enableTrustedIdentityPropagation": boolean,
         "glueConnection": { 
            "athenaProperties": { 
               "string" : "string" 
            },
            "authenticationConfiguration": { 
               "authenticationType": "string",
               "oAuth2Properties": { 
                  "authorizationCodeProperties": { 
                     "authorizationCode": "string",
                     "redirectUri": "string"
                  },
                  "oAuth2ClientApplication": { 
                     "aWSManagedClientApplicationReference": "string",
                     "userManagedClientApplicationClientId": "string"
                  },
                  "oAuth2Credentials": { 
                     "accessToken": "string",
                     "jwtToken": "string",
                     "refreshToken": "string",
                     "userManagedClientApplicationClientSecret": "string"
                  },
                  "oAuth2GrantType": "string",
                  "tokenUrl": "string",
                  "tokenUrlParametersMap": { 
                     "string" : "string" 
                  }
               },
               "secretArn": "string"
            },
            "compatibleComputeEnvironments": [ "string" ],
            "connectionProperties": { 
               "string" : "string" 
            },
            "connectionSchemaVersion": number,
            "connectionType": "string",
            "creationTime": number,
            "description": "string",
            "lastConnectionValidationTime": number,
            "lastUpdatedBy": "string",
            "lastUpdatedTime": number,
            "matchCriteria": [ "string" ],
            "name": "string",
            "physicalConnectionRequirements": { 
               "availabilityZone": "string",
               "securityGroupIdList": [ "string" ],
               "subnetId": "string",
               "subnetIdList": [ "string" ]
            },
            "pythonProperties": { 
               "string" : "string" 
            },
            "sparkProperties": { 
               "string" : "string" 
            },
            "status": "string",
            "statusReason": "string"
         },
         "glueConnectionName": "string",
         "glueConnectionNames": [ "string" ],
         "host": "string",
         "port": number,
         "protocol": "string",
         "stage": "string"
      }
   ],
   "projectId": "string",
   "props": { ... },
   "scope": "string",
   "type": "string"
}
```

## Response Elements
<a name="API_GetConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurations](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-configurations"></a>
The configurations of the connection.  
Type: Array of [Configuration](API_Configuration.md) objects

 ** [connectionCredentials](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-connectionCredentials"></a>
Connection credentials.  
Type: [ConnectionCredentials](API_ConnectionCredentials.md) object

 ** [connectionId](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-connectionId"></a>
The ID of the connection.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.

 ** [description](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-description"></a>
Connection description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-domainId"></a>
The domain ID of the connection.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-domainUnitId"></a>
The domain unit ID of the connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentId](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-environmentId"></a>
The ID of the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentUserRole](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-environmentUserRole"></a>
The environment user role.  
Type: String

 ** [name](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-name"></a>
The name of the connection.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.

 ** [physicalEndpoints](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-physicalEndpoints"></a>
The physical endpoints of the connection.  
Type: Array of [PhysicalEndpoint](API_PhysicalEndpoint.md) objects

 ** [projectId](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-projectId"></a>
The ID of the project.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [props](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-props"></a>
Connection props.  
Type: [ConnectionPropertiesOutput](API_ConnectionPropertiesOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [scope](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-scope"></a>
The scope of the connection.  
Type: String  
Valid Values: `DOMAIN | PROJECT` 

 ** [type](#API_GetConnection_ResponseSyntax) **   <a name="datazone-GetConnection-response-type"></a>
The type of the connection.  
Type: String  
Valid Values: `ATHENA | BIGQUERY | DATABRICKS | DOCUMENTDB | DYNAMODB | HYPERPOD | IAM | MYSQL | OPENSEARCH | ORACLE | POSTGRESQL | REDSHIFT | S3 | SAPHANA | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | VERTICA | WORKFLOWS_MWAA | AMAZON_Q | MLFLOW` 

## Errors
<a name="API_GetConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetConnection) 

# GetDataExportConfiguration
<a name="API_GetDataExportConfiguration"></a>

Gets data export configuration details.

## Request Syntax
<a name="API_GetDataExportConfiguration_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-export-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDataExportConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetDataExportConfiguration_RequestSyntax) **   <a name="datazone-GetDataExportConfiguration-request-uri-domainIdentifier"></a>
The ID of the domain where you want to get the data export configuration details.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetDataExportConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDataExportConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "encryptionConfiguration": { 
      "kmsKeyArn": "string",
      "sseAlgorithm": "string"
   },
   "isExportEnabled": boolean,
   "s3TableBucketArn": "string",
   "status": "string",
   "updatedAt": number
}
```

## Response Elements
<a name="API_GetDataExportConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetDataExportConfiguration_ResponseSyntax) **   <a name="datazone-GetDataExportConfiguration-response-createdAt"></a>
The timestamp at which the data export configuration report was created.  
Type: Timestamp

 ** [encryptionConfiguration](#API_GetDataExportConfiguration_ResponseSyntax) **   <a name="datazone-GetDataExportConfiguration-response-encryptionConfiguration"></a>
The encryption configuration as part of the data export configuration details.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object

 ** [isExportEnabled](#API_GetDataExportConfiguration_ResponseSyntax) **   <a name="datazone-GetDataExportConfiguration-response-isExportEnabled"></a>
Specifies whether the export is enabled.  
Type: Boolean

 ** [s3TableBucketArn](#API_GetDataExportConfiguration_ResponseSyntax) **   <a name="datazone-GetDataExportConfiguration-response-s3TableBucketArn"></a>
The Amazon S3 table bucket ARN as part of the data export configuration details.  
Type: String

 ** [status](#API_GetDataExportConfiguration_ResponseSyntax) **   <a name="datazone-GetDataExportConfiguration-response-status"></a>
The status of the data export configuration.  
Type: String  
Valid Values: `COMPLETED | FAILED` 

 ** [updatedAt](#API_GetDataExportConfiguration_ResponseSyntax) **   <a name="datazone-GetDataExportConfiguration-response-updatedAt"></a>
The timestamp at which the data export configuration report was updated.  
Type: Timestamp

## Errors
<a name="API_GetDataExportConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetDataExportConfiguration_Examples"></a>

### Example
<a name="API_GetDataExportConfiguration_Example_1"></a>

Get data export configuration:

#### Sample Request
<a name="API_GetDataExportConfiguration_Example_1_Request"></a>

```
aws datazone get-data-export-configuration --domain-identifier dzd-440699i00ezy21 --region us-east-2
```

#### Sample Response
<a name="API_GetDataExportConfiguration_Example_1_Response"></a>

```
{
    "isExportEnabled": true,
    "status": "COMPLETED",
    "s3TableBucketArn": "arn:aws:s3tables:us-east-2:651393673886:bucket/aws-sagemaker-catalog",
    "createdAt": "2025-11-26T06:17:32.580000+05:30",
    "updatedAt": "2025-11-26T06:17:32.580000+05:30"
}
```

### Example
<a name="API_GetDataExportConfiguration_Example_2"></a>

When export is disabled:

#### Sample Response
<a name="API_GetDataExportConfiguration_Example_2_Response"></a>

```
{
    "isExportEnabled": false,
    "status": "COMPLETED",
    "createdAt": "2025-11-26T06:17:32.580000+05:30",
    "updatedAt": "2025-11-26T06:17:32.580000+05:30"
}
```

### Example
<a name="API_GetDataExportConfiguration_Example_3"></a>

When export is enabled with KMS key provided:

#### Sample Response
<a name="API_GetDataExportConfiguration_Example_3_Response"></a>

```
{
    "isExportEnabled": true,
    "status": "COMPLETED",
    "encryptionConfiguration": {
        "kmsKeyArn": "arn:aws:kms:us-east-2:651393343886:key/292fedfe-c4b6-40fa-961b-87393584195c",
        "sseAlgorithm": "aws:kms"
    },
    "s3TableBucketArn": "arn:aws:s3tables:us-east-2:651393343886:bucket/aws-sagemaker-catalog",
    "createdAt": "2025-11-26T06:17:32.580000+05:30",
    "updatedAt": "2025-11-26T06:17:32.580000+05:30"
}
```

## See Also
<a name="API_GetDataExportConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetDataExportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetDataExportConfiguration) 

# GetDataProduct
<a name="API_GetDataProduct"></a>

Gets the data product.

Prerequisites:
+ The data product ID must exist. 
+ The domain must be valid and accessible.
+ User must have read or discovery permissions for the data product.

## Request Syntax
<a name="API_GetDataProduct_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-products/identifier?revision=revision HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDataProduct_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetDataProduct_RequestSyntax) **   <a name="datazone-GetDataProduct-request-uri-domainIdentifier"></a>
The ID of the domain where the data product lives.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetDataProduct_RequestSyntax) **   <a name="datazone-GetDataProduct-request-uri-identifier"></a>
The ID of the data product.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [revision](#API_GetDataProduct_RequestSyntax) **   <a name="datazone-GetDataProduct-request-uri-revision"></a>
The revision of the data product.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_GetDataProduct_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDataProduct_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "firstRevisionCreatedAt": number,
   "firstRevisionCreatedBy": "string",
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "items": [ 
      { 
         "glossaryTerms": [ "string" ],
         "identifier": "string",
         "itemType": "string",
         "revision": "string"
      }
   ],
   "name": "string",
   "owningProjectId": "string",
   "revision": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_GetDataProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-createdAt"></a>
The timestamp at which the data product is created.  
Type: Timestamp

 ** [createdBy](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-createdBy"></a>
The user who created the data product.  
Type: String

 ** [description](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-description"></a>
The description of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-domainId"></a>
The ID of the domain where the data product lives.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [firstRevisionCreatedAt](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-firstRevisionCreatedAt"></a>
The timestamp at which the first revision of the data product is created.  
Type: Timestamp

 ** [firstRevisionCreatedBy](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-firstRevisionCreatedBy"></a>
The user who created the first revision of the data product.  
Type: String

 ** [formsOutput](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-formsOutput"></a>
The metadata forms of the data product.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [glossaryTerms](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-glossaryTerms"></a>
The glossary terms of the data product.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-id"></a>
The ID of the data product.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [items](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-items"></a>
The data assets of the data product.  
Type: Array of [DataProductItem](API_DataProductItem.md) objects  
Array Members: Minimum number of 1 item.

 ** [name](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-name"></a>
The name of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [owningProjectId](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-owningProjectId"></a>
The ID of the owning project of the data product.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-revision"></a>
The revision of the data product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [status](#API_GetDataProduct_ResponseSyntax) **   <a name="datazone-GetDataProduct-response-status"></a>
The status of the data product.  
Type: String  
Valid Values: `CREATED | CREATING | CREATE_FAILED` 

## Errors
<a name="API_GetDataProduct_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetDataProduct_Examples"></a>

### Example
<a name="API_GetDataProduct_Example_1"></a>

This example illustrates one usage of GetDataProduct.

#### Sample Request
<a name="API_GetDataProduct_Example_1_Request"></a>

```
aws datazone get-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd9m3nqx2wkfp"
```

#### Sample Response
<a name="API_GetDataProduct_Example_1_Response"></a>

```
{
    "createdAt": 1752602995.424,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "firstRevisionCreatedAt": 1752602810.307,
    "firstRevisionCreatedBy": "usr7nx82mkl",
    "formsOutput": [],
    "id": "dpd9m3nqx2wkfp",
    "name": "CustomerInsights-v2",
    "owningProjectId": "prj7nx82mkl",
    "revision": "2",
    "status": "CREATED"
}
```

### Example
<a name="API_GetDataProduct_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_GetDataProduct_Example_2_Request"></a>

```
aws datazone get-data-product \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_GetDataProduct_Example_2_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

### Example
<a name="API_GetDataProduct_Example_3"></a>

Failure case - resource not found:

#### Sample Request
<a name="API_GetDataProduct_Example_3_Request"></a>

```
aws datazone get-data-product \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd_nonexistent"
```

#### Sample Response
<a name="API_GetDataProduct_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the GetDataProduct operation: Requested dataProduct cannot be found in domain
```

## See Also
<a name="API_GetDataProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetDataProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetDataProduct) 

# GetDataSource
<a name="API_GetDataSource"></a>

Gets an Amazon DataZone data source.

## Request Syntax
<a name="API_GetDataSource_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-sources/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetDataSource_RequestSyntax) **   <a name="datazone-GetDataSource-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the data source exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetDataSource_RequestSyntax) **   <a name="datazone-GetDataSource-request-uri-identifier"></a>
The ID of the Amazon DataZone data source.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetDataSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "configuration": { ... },
   "connectionId": "string",
   "createdAt": "string",
   "description": "string",
   "domainId": "string",
   "enableSetting": "string",
   "environmentId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "lastRunAssetCount": number,
   "lastRunAt": "string",
   "lastRunErrorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "lastRunStatus": "string",
   "name": "string",
   "projectId": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "selfGrantStatus": { ... },
   "status": "string",
   "type": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_GetDataSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetFormsOutput](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-assetFormsOutput"></a>
The metadata forms attached to the assets created by this data source.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [configuration](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-configuration"></a>
The configuration of the data source.  
Type: [DataSourceConfigurationOutput](API_DataSourceConfigurationOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [connectionId](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-connectionId"></a>
The ID of the connection.  
Type: String

 ** [createdAt](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-createdAt"></a>
The timestamp of when the data source was created.  
Type: Timestamp

 ** [description](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-description"></a>
The description of the data source.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-domainId"></a>
The ID of the Amazon DataZone domain in which the data source exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [enableSetting](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-enableSetting"></a>
Specifies whether this data source is enabled or not.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [environmentId](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-environmentId"></a>
The ID of the environment where this data source creates and publishes assets,  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [errorMessage](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-errorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [id](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-id"></a>
The ID of the data source.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastRunAssetCount](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-lastRunAssetCount"></a>
The number of assets created by the data source during its last run.  
Type: Integer

 ** [lastRunAt](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-lastRunAt"></a>
The timestamp of the last run of the data source.  
Type: Timestamp

 ** [lastRunErrorMessage](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-lastRunErrorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [lastRunStatus](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-lastRunStatus"></a>
The status of the last run of the data source.  
Type: String  
Valid Values: `REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS` 

 ** [name](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-name"></a>
The name of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [projectId](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-projectId"></a>
The ID of the project where the data source creates and publishes assets.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [publishOnImport](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-publishOnImport"></a>
Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.  
Type: Boolean

 ** [recommendation](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-recommendation"></a>
The recommendation configuration of the data source.  
Type: [RecommendationConfiguration](API_RecommendationConfiguration.md) object

 ** [schedule](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-schedule"></a>
The schedule of the data source runs.  
Type: [ScheduleConfiguration](API_ScheduleConfiguration.md) object

 ** [selfGrantStatus](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-selfGrantStatus"></a>
Specifies the status of the self-granting functionality.  
Type: [SelfGrantStatusOutput](API_SelfGrantStatusOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-status"></a>
The status of the data source.  
Type: String  
Valid Values: `CREATING | FAILED_CREATION | READY | UPDATING | FAILED_UPDATE | RUNNING | DELETING | FAILED_DELETION` 

 ** [type](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-type"></a>
The type of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [updatedAt](#API_GetDataSource_ResponseSyntax) **   <a name="datazone-GetDataSource-response-updatedAt"></a>
The timestamp of when the data source was updated.  
Type: Timestamp

## Errors
<a name="API_GetDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetDataSource) 

# GetDataSourceRun
<a name="API_GetDataSourceRun"></a>

Gets an Amazon DataZone data source run.

## Request Syntax
<a name="API_GetDataSourceRun_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-source-runs/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDataSourceRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetDataSourceRun_RequestSyntax) **   <a name="datazone-GetDataSourceRun-request-uri-domainIdentifier"></a>
The ID of the domain in which this data source run was performed.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetDataSourceRun_RequestSyntax) **   <a name="datazone-GetDataSourceRun-request-uri-identifier"></a>
The ID of the data source run.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetDataSourceRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDataSourceRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "dataSourceConfigurationSnapshot": "string",
   "dataSourceId": "string",
   "domainId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "lineageSummary": { 
      "importStatus": "string"
   },
   "projectId": "string",
   "runStatisticsForAssets": { 
      "added": number,
      "failed": number,
      "skipped": number,
      "unchanged": number,
      "updated": number
   },
   "startedAt": "string",
   "status": "string",
   "stoppedAt": "string",
   "type": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_GetDataSourceRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-createdAt"></a>
The timestamp of when the data source run was created.  
Type: Timestamp

 ** [dataSourceConfigurationSnapshot](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-dataSourceConfigurationSnapshot"></a>
The configuration snapshot of the data source run.  
Type: String

 ** [dataSourceId](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-dataSourceId"></a>
The ID of the data source for this data source run.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [domainId](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-domainId"></a>
The ID of the domain in which this data source run was performed.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [errorMessage](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-errorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [id](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-id"></a>
The ID of the data source run.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lineageSummary](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-lineageSummary"></a>
The summary of the data lineage.  
Type: [DataSourceRunLineageSummary](API_DataSourceRunLineageSummary.md) object

 ** [projectId](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-projectId"></a>
The ID of the project in which this data source run occured.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [runStatisticsForAssets](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-runStatisticsForAssets"></a>
The asset statistics from this data source run.  
Type: [RunStatisticsForAssets](API_RunStatisticsForAssets.md) object

 ** [startedAt](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-startedAt"></a>
The timestamp of when this data source run started.  
Type: Timestamp

 ** [status](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-status"></a>
The status of this data source run.  
Type: String  
Valid Values: `REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS` 

 ** [stoppedAt](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-stoppedAt"></a>
The timestamp of when this data source run stopped.  
Type: Timestamp

 ** [type](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-type"></a>
The type of this data source run.  
Type: String  
Valid Values: `PRIORITIZED | SCHEDULED` 

 ** [updatedAt](#API_GetDataSourceRun_ResponseSyntax) **   <a name="datazone-GetDataSourceRun-response-updatedAt"></a>
The timestamp of when this data source run was updated.  
Type: Timestamp

## Errors
<a name="API_GetDataSourceRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetDataSourceRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetDataSourceRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetDataSourceRun) 

# GetDomain
<a name="API_GetDomain"></a>

Gets an Amazon DataZone domain.

## Request Syntax
<a name="API_GetDomain_RequestSyntax"></a>

```
GET /v2/domains/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [identifier](#API_GetDomain_RequestSyntax) **   <a name="datazone-GetDomain-request-uri-identifier"></a>
The identifier of the specified Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdAt": number,
   "description": "string",
   "domainExecutionRole": "string",
   "domainVersion": "string",
   "id": "string",
   "kmsKeyIdentifier": "string",
   "lastUpdatedAt": number,
   "name": "string",
   "portalUrl": "string",
   "rootDomainUnitId": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "idcInstanceArn": "string",
      "type": "string",
      "userAssignment": "string"
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-arn"></a>
The ARN of the specified Amazon DataZone domain.  
Type: String

 ** [createdAt](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-createdAt"></a>
The timestamp of when the Amazon DataZone domain was created.  
Type: Timestamp

 ** [description](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-description"></a>
The description of the Amazon DataZone domain.  
Type: String

 ** [domainExecutionRole](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-domainExecutionRole"></a>
The domain execution role with which the Amazon DataZone domain is created.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [domainVersion](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-domainVersion"></a>
The version of the domain.  
Type: String  
Valid Values: `V1 | V2` 

 ** [id](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-id"></a>
The identifier of the specified Amazon DataZone domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [kmsKeyIdentifier](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-kmsKeyIdentifier"></a>
The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` 

 ** [lastUpdatedAt](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-lastUpdatedAt"></a>
The timestamp of when the Amazon DataZone domain was last updated.  
Type: Timestamp

 ** [name](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-name"></a>
The name of the Amazon DataZone domain.  
Type: String

 ** [portalUrl](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-portalUrl"></a>
The URL of the data portal for this Amazon DataZone domain.  
Type: String

 ** [rootDomainUnitId](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-rootDomainUnitId"></a>
The ID of the root domain in Amazon Datazone.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [serviceRole](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-serviceRole"></a>
The service role of the domain.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [singleSignOn](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-singleSignOn"></a>
The single sing-on option of the specified Amazon DataZone domain.  
Type: [SingleSignOn](API_SingleSignOn.md) object

 ** [status](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-status"></a>
The status of the specified Amazon DataZone domain.  
Type: String  
Valid Values: `CREATING | AVAILABLE | CREATION_FAILED | DELETING | DELETED | DELETION_FAILED` 

 ** [tags](#API_GetDomain_ResponseSyntax) **   <a name="datazone-GetDomain-response-tags"></a>
The tags specified for the Amazon DataZone domain.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\w \.:/=+@-]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `[\w \.:/=+@-]*` 

## Errors
<a name="API_GetDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetDomain) 

# GetDomainUnit
<a name="API_GetDomainUnit"></a>

Gets the details of the specified domain unit.

## Request Syntax
<a name="API_GetDomainUnit_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/domain-units/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetDomainUnit_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetDomainUnit_RequestSyntax) **   <a name="datazone-GetDomainUnit-request-uri-domainIdentifier"></a>
The ID of the domain where you want to get a domain unit.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetDomainUnit_RequestSyntax) **   <a name="datazone-GetDomainUnit-request-uri-identifier"></a>
The identifier of the domain unit that you want to get.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: Yes

## Request Body
<a name="API_GetDomainUnit_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetDomainUnit_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "id": "string",
   "lastUpdatedAt": number,
   "lastUpdatedBy": "string",
   "name": "string",
   "owners": [ 
      { ... }
   ],
   "parentDomainUnitId": "string"
}
```

## Response Elements
<a name="API_GetDomainUnit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-createdAt"></a>
The time stamp at which the domain unit was created.  
Type: Timestamp

 ** [createdBy](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-createdBy"></a>
The user who created the domain unit.  
Type: String

 ** [description](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-description"></a>
The description of the domain unit.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-domainId"></a>
The ID of the domain in which the domain unit lives.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-id"></a>
The ID of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [lastUpdatedAt](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-lastUpdatedAt"></a>
The timestamp at which the domain unit was last updated.  
Type: Timestamp

 ** [lastUpdatedBy](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-lastUpdatedBy"></a>
The user who last updated the domain unit.  
Type: String

 ** [name](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-name"></a>
The name of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w -]+` 

 ** [owners](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-owners"></a>
The owners of the domain unit.  
Type: Array of [DomainUnitOwnerProperties](API_DomainUnitOwnerProperties.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [parentDomainUnitId](#API_GetDomainUnit_ResponseSyntax) **   <a name="datazone-GetDomainUnit-response-parentDomainUnitId"></a>
The ID of the parent domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

## Errors
<a name="API_GetDomainUnit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetDomainUnit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetDomainUnit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetDomainUnit) 

# GetEnvironment
<a name="API_GetEnvironment"></a>

Gets an Amazon DataZone environment.

## Request Syntax
<a name="API_GetEnvironment_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environments/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetEnvironment_RequestSyntax) **   <a name="datazone-GetEnvironment-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where the environment exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetEnvironment_RequestSyntax) **   <a name="datazone-GetEnvironment-request-uri-identifier"></a>
The ID of the Amazon DataZone environment.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetEnvironment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "deploymentProperties": { 
      "endTimeoutMinutes": number,
      "startTimeoutMinutes": number
   },
   "description": "string",
   "domainId": "string",
   "environmentActions": [ 
      { 
         "auth": "string",
         "parameters": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "type": "string"
      }
   ],
   "environmentBlueprintId": "string",
   "environmentConfigurationId": "string",
   "environmentConfigurationName": "string",
   "environmentProfileId": "string",
   "glossaryTerms": [ "string" ],
   "id": "string",
   "lastDeployment": { 
      "deploymentId": "string",
      "deploymentStatus": "string",
      "deploymentType": "string",
      "failureReason": { 
         "code": "string",
         "message": "string"
      },
      "isDeploymentComplete": boolean,
      "messages": [ "string" ]
   },
   "name": "string",
   "projectId": "string",
   "provider": "string",
   "provisionedResources": [ 
      { 
         "name": "string",
         "provider": "string",
         "type": "string",
         "value": "string"
      }
   ],
   "provisioningProperties": { ... },
   "status": "string",
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetEnvironment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [awsAccountId](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-awsAccountId"></a>
The ID of the AWS account where the environment exists.  
Type: String  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-awsAccountRegion"></a>
The AWS region where the environment exists.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [createdAt](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-createdAt"></a>
The timestamp of when the environment was created.  
Type: Timestamp

 ** [createdBy](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-createdBy"></a>
The Amazon DataZone user who created the environment.  
Type: String

 ** [deploymentProperties](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-deploymentProperties"></a>
The deployment properties of the environment.  
Type: [DeploymentProperties](API_DeploymentProperties.md) object

 ** [description](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-description"></a>
The description of the environment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-domainId"></a>
The ID of the Amazon DataZone domain where the environment exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentActions](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-environmentActions"></a>
The actions of the environment.  
Type: Array of [ConfigurableEnvironmentAction](API_ConfigurableEnvironmentAction.md) objects

 ** [environmentBlueprintId](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-environmentBlueprintId"></a>
The blueprint with which the environment is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentConfigurationId](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-environmentConfigurationId"></a>
The configuration ID that is used to create the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentConfigurationName](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-environmentConfigurationName"></a>
The configuration name that is used to create the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [environmentProfileId](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-environmentProfileId"></a>
The ID of the environment profile with which the environment is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{0,36}` 

 ** [glossaryTerms](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-glossaryTerms"></a>
The business glossary terms that can be used in this environment.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-id"></a>
The ID of the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastDeployment](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-lastDeployment"></a>
The details of the last deployment of the environment.  
Type: [Deployment](API_Deployment.md) object

 ** [name](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-name"></a>
The name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectId](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-projectId"></a>
The ID of the Amazon DataZone project in which this environment is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [provider](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-provider"></a>
The provider of this Amazon DataZone environment.  
Type: String

 ** [provisionedResources](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-provisionedResources"></a>
The provisioned resources of this Amazon DataZone environment.  
Type: Array of [Resource](API_Resource.md) objects

 ** [provisioningProperties](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-provisioningProperties"></a>
The provisioning properties of this Amazon DataZone environment.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-status"></a>
The status of this Amazon DataZone environment.  
Type: String  
Valid Values: `ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | VALIDATION_FAILED | SUSPENDED | DISABLED | EXPIRED | DELETED | INACCESSIBLE` 

 ** [updatedAt](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-updatedAt"></a>
The timestamp of when this environment was updated.  
Type: Timestamp

 ** [userParameters](#API_GetEnvironment_ResponseSyntax) **   <a name="datazone-GetEnvironment-response-userParameters"></a>
The user parameters of this Amazon DataZone environment.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_GetEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetEnvironment) 

# GetEnvironmentAction
<a name="API_GetEnvironmentAction"></a>

Gets the specified environment action.

## Request Syntax
<a name="API_GetEnvironmentAction_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environments/environmentIdentifier/actions/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEnvironmentAction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetEnvironmentAction_RequestSyntax) **   <a name="datazone-GetEnvironmentAction-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the `GetEnvironmentAction` API is invoked.   
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_GetEnvironmentAction_RequestSyntax) **   <a name="datazone-GetEnvironmentAction-request-uri-environmentIdentifier"></a>
The environment ID of the environment action.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetEnvironmentAction_RequestSyntax) **   <a name="datazone-GetEnvironmentAction-request-uri-identifier"></a>
The ID of the environment action  
Required: Yes

## Request Body
<a name="API_GetEnvironmentAction_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEnvironmentAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "name": "string",
   "parameters": { ... }
}
```

## Response Elements
<a name="API_GetEnvironmentAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [description](#API_GetEnvironmentAction_ResponseSyntax) **   <a name="datazone-GetEnvironmentAction-response-description"></a>
The description of the environment action.  
Type: String

 ** [domainId](#API_GetEnvironmentAction_ResponseSyntax) **   <a name="datazone-GetEnvironmentAction-response-domainId"></a>
The ID of the Amazon DataZone domain in which the environment action lives.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_GetEnvironmentAction_ResponseSyntax) **   <a name="datazone-GetEnvironmentAction-response-environmentId"></a>
The environment ID of the environment action.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetEnvironmentAction_ResponseSyntax) **   <a name="datazone-GetEnvironmentAction-response-id"></a>
The ID of the environment action.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_GetEnvironmentAction_ResponseSyntax) **   <a name="datazone-GetEnvironmentAction-response-name"></a>
The name of the environment action.  
Type: String

 ** [parameters](#API_GetEnvironmentAction_ResponseSyntax) **   <a name="datazone-GetEnvironmentAction-response-parameters"></a>
The parameters of the environment action.  
Type: [ActionParameters](API_ActionParameters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

## Errors
<a name="API_GetEnvironmentAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetEnvironmentAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetEnvironmentAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetEnvironmentAction) 

# GetEnvironmentBlueprint
<a name="API_GetEnvironmentBlueprint"></a>

Gets an Amazon DataZone blueprint.

## Request Syntax
<a name="API_GetEnvironmentBlueprint_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environment-blueprints/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEnvironmentBlueprint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-GetEnvironmentBlueprint-request-uri-domainIdentifier"></a>
The identifier of the domain in which this blueprint exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-GetEnvironmentBlueprint-request-uri-identifier"></a>
The ID of this Amazon DataZone blueprint.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetEnvironmentBlueprint_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEnvironmentBlueprint_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "deploymentProperties": { 
      "endTimeoutMinutes": number,
      "startTimeoutMinutes": number
   },
   "description": "string",
   "glossaryTerms": [ "string" ],
   "id": "string",
   "name": "string",
   "provider": "string",
   "provisioningProperties": { ... },
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetEnvironmentBlueprint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-createdAt"></a>
A timestamp of when this blueprint was created.  
Type: Timestamp

 ** [deploymentProperties](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-deploymentProperties"></a>
The deployment properties of this Amazon DataZone blueprint.  
Type: [DeploymentProperties](API_DeploymentProperties.md) object

 ** [description](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-description"></a>
The description of this Amazon DataZone blueprint.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [glossaryTerms](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-glossaryTerms"></a>
The glossary terms attached to this Amazon DataZone blueprint.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-id"></a>
The ID of this Amazon DataZone blueprint.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-name"></a>
The name of this Amazon DataZone blueprint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [provider](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-provider"></a>
The provider of this Amazon DataZone blueprint.  
Type: String

 ** [provisioningProperties](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-provisioningProperties"></a>
The provisioning properties of this Amazon DataZone blueprint.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [updatedAt](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-updatedAt"></a>
The timestamp of when this blueprint was updated.  
Type: Timestamp

 ** [userParameters](#API_GetEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprint-response-userParameters"></a>
The user parameters of this blueprint.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_GetEnvironmentBlueprint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetEnvironmentBlueprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetEnvironmentBlueprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetEnvironmentBlueprint) 

# GetEnvironmentBlueprintConfiguration
<a name="API_GetEnvironmentBlueprintConfiguration"></a>

Gets the blueprint configuration in Amazon DataZone.

## Request Syntax
<a name="API_GetEnvironmentBlueprintConfiguration_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environment-blueprint-configurations/environmentBlueprintIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEnvironmentBlueprintConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where this blueprint exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentBlueprintIdentifier](#API_GetEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-request-uri-environmentBlueprintIdentifier"></a>
He ID of the blueprint.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetEnvironmentBlueprintConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEnvironmentBlueprintConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "domainId": "string",
   "enabledRegions": [ "string" ],
   "environmentBlueprintId": "string",
   "environmentRolePermissionBoundary": "string",
   "manageAccessRoleArn": "string",
   "provisioningConfigurations": [ 
      { ... }
   ],
   "provisioningRoleArn": "string",
   "regionalParameters": { 
      "string" : { 
         "string" : "string" 
      }
   },
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_GetEnvironmentBlueprintConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-createdAt"></a>
The timestamp of when this blueprint was created.  
Type: Timestamp

 ** [domainId](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-domainId"></a>
The ID of the Amazon DataZone domain where this blueprint exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [enabledRegions](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-enabledRegions"></a>
The AWS regions in which this blueprint is enabled.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Minimum length of 4. Maximum length of 16.  
Pattern: `[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]` 

 ** [environmentBlueprintId](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-environmentBlueprintId"></a>
The ID of the blueprint.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentRolePermissionBoundary](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-environmentRolePermissionBoundary"></a>
The environment role permissions boundary.  
Type: String  
Pattern: `arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*` 

 ** [manageAccessRoleArn](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-manageAccessRoleArn"></a>
The ARN of the manage access role with which this blueprint is created.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [provisioningConfigurations](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-provisioningConfigurations"></a>
The provisioning configuration of a blueprint.  
Type: Array of [ProvisioningConfiguration](API_ProvisioningConfiguration.md) objects

 ** [provisioningRoleArn](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-provisioningRoleArn"></a>
The ARN of the provisioning role with which this blueprint is created.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [regionalParameters](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-regionalParameters"></a>
The regional parameters of the blueprint.  
Type: String to string to string map map  
Key Length Constraints: Minimum length of 4. Maximum length of 16.  
Key Pattern: `[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]` 

 ** [updatedAt](#API_GetEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-GetEnvironmentBlueprintConfiguration-response-updatedAt"></a>
The timestamp of when this blueprint was upated.  
Type: Timestamp

## Errors
<a name="API_GetEnvironmentBlueprintConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetEnvironmentBlueprintConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetEnvironmentBlueprintConfiguration) 

# GetEnvironmentCredentials
<a name="API_GetEnvironmentCredentials"></a>

Gets the credentials of an environment in Amazon DataZone.

## Request Syntax
<a name="API_GetEnvironmentCredentials_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environments/environmentIdentifier/credentials HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEnvironmentCredentials_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetEnvironmentCredentials_RequestSyntax) **   <a name="datazone-GetEnvironmentCredentials-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this environment and its credentials exist.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_GetEnvironmentCredentials_RequestSyntax) **   <a name="datazone-GetEnvironmentCredentials-request-uri-environmentIdentifier"></a>
The ID of the environment whose credentials this operation gets.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetEnvironmentCredentials_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEnvironmentCredentials_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accessKeyId": "string",
   "expiration": "string",
   "secretAccessKey": "string",
   "sessionToken": "string"
}
```

## Response Elements
<a name="API_GetEnvironmentCredentials_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accessKeyId](#API_GetEnvironmentCredentials_ResponseSyntax) **   <a name="datazone-GetEnvironmentCredentials-response-accessKeyId"></a>
The access key ID of the environment.  
Type: String

 ** [expiration](#API_GetEnvironmentCredentials_ResponseSyntax) **   <a name="datazone-GetEnvironmentCredentials-response-expiration"></a>
The expiration timestamp of the environment credentials.  
Type: Timestamp

 ** [secretAccessKey](#API_GetEnvironmentCredentials_ResponseSyntax) **   <a name="datazone-GetEnvironmentCredentials-response-secretAccessKey"></a>
The secret access key of the environment credentials.  
Type: String

 ** [sessionToken](#API_GetEnvironmentCredentials_ResponseSyntax) **   <a name="datazone-GetEnvironmentCredentials-response-sessionToken"></a>
The session token of the environment credentials.  
Type: String

## Errors
<a name="API_GetEnvironmentCredentials_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetEnvironmentCredentials_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetEnvironmentCredentials) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetEnvironmentCredentials) 

# GetEnvironmentProfile
<a name="API_GetEnvironmentProfile"></a>

Gets an evinronment profile in Amazon DataZone.

## Request Syntax
<a name="API_GetEnvironmentProfile_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environment-profiles/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEnvironmentProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetEnvironmentProfile_RequestSyntax) **   <a name="datazone-GetEnvironmentProfile-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this environment profile exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetEnvironmentProfile_RequestSyntax) **   <a name="datazone-GetEnvironmentProfile-request-uri-identifier"></a>
The ID of the environment profile.  
Pattern: `[a-zA-Z0-9_-]{0,36}`   
Required: Yes

## Request Body
<a name="API_GetEnvironmentProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEnvironmentProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "environmentBlueprintId": "string",
   "id": "string",
   "name": "string",
   "projectId": "string",
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetEnvironmentProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [awsAccountId](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-awsAccountId"></a>
The ID of the AWS account where this environment profile exists.  
Type: String  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-awsAccountRegion"></a>
The AWS region where this environment profile exists.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [createdAt](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-createdAt"></a>
The timestamp of when this environment profile was created.  
Type: Timestamp

 ** [createdBy](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-createdBy"></a>
The Amazon DataZone user who created this environment profile.  
Type: String

 ** [description](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-description"></a>
The description of the environment profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-domainId"></a>
The ID of the Amazon DataZone domain in which this environment profile exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentBlueprintId](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-environmentBlueprintId"></a>
The ID of the blueprint with which this environment profile is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-id"></a>
The ID of the environment profile.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{0,36}` 

 ** [name](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-name"></a>
The name of the environment profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectId](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-projectId"></a>
The ID of the Amazon DataZone project in which this environment profile is created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-updatedAt"></a>
The timestamp of when this environment profile was upated.  
Type: Timestamp

 ** [userParameters](#API_GetEnvironmentProfile_ResponseSyntax) **   <a name="datazone-GetEnvironmentProfile-response-userParameters"></a>
The user parameters of the environment profile.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_GetEnvironmentProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetEnvironmentProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetEnvironmentProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetEnvironmentProfile) 

# GetFormType
<a name="API_GetFormType"></a>

Gets a metadata form type in Amazon DataZone.

Form types define the structure and validation rules for collecting metadata about assets in Amazon DataZone. They act as templates that ensure consistent metadata capture across similar types of assets, while allowing for customization to meet specific organizational needs. Form types can include required fields, validation rules, and dependencies, helping maintain high-quality metadata that makes data assets more discoverable and usable.
+ The form type with the specified identifier must exist in the given domain. 
+ The domain must be valid and active.
+ User must have permission on the form type.
+ The form type should not be deleted or in an invalid state.

One use case for this API is to determine whether a form field is indexed for search. 

A searchable field will be annotated with `@amazon.datazone#searchable`. By default, searchable fields are indexed for semantic search, where related query terms will match the attribute value even if they are not stemmed or keyword matches. If a field is indexed technical identifier search, it will be annotated with `@amazon.datazone#searchable(modes:["TECHNICAL"])`. If a field is indexed for lexical search (supports stemmed and prefix matches but not semantic matches), it will be annotated with `@amazon.datazone#searchable(modes:["LEXICAL"])`.

A field storing glossary term IDs (which is filterable) will be annotated with `@amazon.datazone#glossaryterm("${glossaryId}")`. 

## Request Syntax
<a name="API_GetFormType_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/form-types/formTypeIdentifier?revision=revision HTTP/1.1
```

## URI Request Parameters
<a name="API_GetFormType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetFormType_RequestSyntax) **   <a name="datazone-GetFormType-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this metadata form type exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [formTypeIdentifier](#API_GetFormType_RequestSyntax) **   <a name="datazone-GetFormType-request-uri-formTypeIdentifier"></a>
The ID of the metadata form type.  
Length Constraints: Minimum length of 1. Maximum length of 385.  
Pattern: `(?!\.)[\w\.]*\w`   
Required: Yes

 ** [revision](#API_GetFormType_RequestSyntax) **   <a name="datazone-GetFormType-request-uri-revision"></a>
The revision of this metadata form type.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_GetFormType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetFormType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "imports": [ 
      { 
         "name": "string",
         "revision": "string"
      }
   ],
   "model": { ... },
   "name": "string",
   "originDomainId": "string",
   "originProjectId": "string",
   "owningProjectId": "string",
   "revision": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_GetFormType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-createdAt"></a>
The timestamp of when this metadata form type was created.  
Type: Timestamp

 ** [createdBy](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-createdBy"></a>
The Amazon DataZone user who created this metadata form type.  
Type: String

 ** [description](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-description"></a>
The description of the metadata form type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-domainId"></a>
The ID of the Amazon DataZone domain in which this metadata form type exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [imports](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-imports"></a>
The imports of the metadata form type.  
Type: Array of [Import](API_Import.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.

 ** [model](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-model"></a>
The model of the metadata form type.  
Type: [Model](API_Model.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [name](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-name"></a>
The name of the metadata form type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(amazon.datazone.)?(?![0-9_])\w+$|^_\w*[a-zA-Z0-9]\w*` 

 ** [originDomainId](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-originDomainId"></a>
The ID of the Amazon DataZone domain in which the metadata form type was originally created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [originProjectId](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-originProjectId"></a>
The ID of the project in which this metadata form type was originally created.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningProjectId](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-owningProjectId"></a>
The ID of the project that owns this metadata form type.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [revision](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-revision"></a>
The revision of the metadata form type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [status](#API_GetFormType_ResponseSyntax) **   <a name="datazone-GetFormType-response-status"></a>
The status of the metadata form type.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

## Errors
<a name="API_GetFormType_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetFormType_Examples"></a>

### Example
<a name="API_GetFormType_Example_1"></a>

This example illustrates one usage of GetFormType.

#### Sample Request
<a name="API_GetFormType_Example_1_Request"></a>

```
aws datazone get-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "CustomerProfileFormType"
```

#### Sample Response
<a name="API_GetFormType_Example_1_Response"></a>

```
{
    "createdAt": 1752600481.72,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "imports": [],
    "model": {
        "smithy": "structure CustomerProfileFormType {\n    @required\n    customerId: String,\n    firstName: String,\n    lastName: String,\n    email: String\n}"
    },
    "name": "CustomerProfileFormType",
    "owningProjectId": "prj7nx82mkl",
    "revision": "2",
    "status": "ENABLED"
}
```

### Example
<a name="API_GetFormType_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_GetFormType_Example_2_Request"></a>

```
aws datazone get-form-type \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_GetFormType_Example_2_Response"></a>

```
aws: error: the following arguments are required: —form-type-identifier
```

### Example
<a name="API_GetFormType_Example_3"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_GetFormType_Example_3_Request"></a>

```
aws datazone get-form-type \
--domain-identifier "dzd_53ielnpxktdilj" \
--form-type-identifier "NonExistentFormType"
```

#### Sample Response
<a name="API_GetFormType_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the GetFormType operation: The given FormType doesn't exist. Try creating FormType before accessing it.
```

### Example
<a name="API_GetFormType_Example_4"></a>

Failure case - invalid input:

#### Sample Request
<a name="API_GetFormType_Example_4_Request"></a>

```
aws datazone get-form-type \
--domain-identifier "invalid_domain" \
--form-type-identifier "CustomerProfileFormType"
```

#### Sample Response
<a name="API_GetFormType_Example_4_Response"></a>

```
An error occurred (ValidationException) when calling the GetFormType operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}
```

## See Also
<a name="API_GetFormType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetFormType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetFormType) 

# GetGlossary
<a name="API_GetGlossary"></a>

Gets a business glossary in Amazon DataZone.

Prerequisites:
+ The specified glossary ID must exist and be associated with the given domain. 
+ The caller must have the `datazone:GetGlossary` permission on the domain.

## Request Syntax
<a name="API_GetGlossary_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/glossaries/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetGlossary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetGlossary_RequestSyntax) **   <a name="datazone-GetGlossary-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this business glossary exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetGlossary_RequestSyntax) **   <a name="datazone-GetGlossary-request-uri-identifier"></a>
The ID of the business glossary.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetGlossary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetGlossary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "id": "string",
   "name": "string",
   "owningProjectId": "string",
   "status": "string",
   "updatedAt": number,
   "updatedBy": "string",
   "usageRestrictions": [ "string" ]
}
```

## Response Elements
<a name="API_GetGlossary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-createdAt"></a>
The timestamp of when this business glossary was created.  
Type: Timestamp

 ** [createdBy](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-createdBy"></a>
The Amazon DataZone user who created this business glossary.  
Type: String

 ** [description](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-description"></a>
The description of the business glossary.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [domainId](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-domainId"></a>
The ID of the Amazon DataZone domain in which this business glossary exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-id"></a>
The ID of the business glossary.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-name"></a>
The name of the business glossary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [owningProjectId](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-owningProjectId"></a>
The ID of the project that owns this business glossary.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-status"></a>
The status of the business glossary.  
Type: String  
Valid Values: `DISABLED | ENABLED` 

 ** [updatedAt](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-updatedAt"></a>
The timestamp of when the business glossary was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-updatedBy"></a>
The Amazon DataZone user who updated the business glossary.  
Type: String

 ** [usageRestrictions](#API_GetGlossary_ResponseSyntax) **   <a name="datazone-GetGlossary-response-usageRestrictions"></a>
The usage restriction of the restricted glossary.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `ASSET_GOVERNED_TERMS` 

## Errors
<a name="API_GetGlossary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetGlossary_Examples"></a>

### Example
<a name="API_GetGlossary_Example_1"></a>

This example illustrates one usage of GetGlossary.

#### Sample Request
<a name="API_GetGlossary_Example_1_Request"></a>

```
aws datazone get-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp"
```

#### Sample Response
<a name="API_GetGlossary_Example_1_Response"></a>

```
{
    "createdAt": 1752573775.274,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "id": "gls8m3nqx2wkfp",
    "name": "CustomerAnalyticsGlossary",
    "owningProjectId": "prj7nx82mkl",
    "status": "ENABLED",
    "updatedAt": 1752573775.274,
    "updatedBy": "usr7nx82mkl"
}
```

### Example
<a name="API_GetGlossary_Example_2"></a>

Failure case - missing required parameter:

#### Sample Request
<a name="API_GetGlossary_Example_2_Request"></a>

```
aws datazone get-glossary \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_GetGlossary_Example_2_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

### Example
<a name="API_GetGlossary_Example_3"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_GetGlossary_Example_3_Request"></a>

```
aws datazone get-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls_nonexistent"
```

#### Sample Response
<a name="API_GetGlossary_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the GetGlossary operation: The given Glossary doesn't exist. Try creating Glossary before accessing it.
```

## See Also
<a name="API_GetGlossary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetGlossary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetGlossary) 

# GetGlossaryTerm
<a name="API_GetGlossaryTerm"></a>

Gets a business glossary term in Amazon DataZone.

Prerequisites:
+ Glossary term with identifier must exist in the domain. 
+ User must have permission on the glossary term.
+ Domain must be accessible and active.

## Request Syntax
<a name="API_GetGlossaryTerm_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/glossary-terms/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetGlossaryTerm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetGlossaryTerm_RequestSyntax) **   <a name="datazone-GetGlossaryTerm-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which this business glossary term exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetGlossaryTerm_RequestSyntax) **   <a name="datazone-GetGlossaryTerm-request-uri-identifier"></a>
The ID of the business glossary term.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetGlossaryTerm_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetGlossaryTerm_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "glossaryId": "string",
   "id": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "string" ]
   },
   "updatedAt": number,
   "updatedBy": "string",
   "usageRestrictions": [ "string" ]
}
```

## Response Elements
<a name="API_GetGlossaryTerm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-createdAt"></a>
The timestamp of when the business glossary term was created.  
Type: Timestamp

 ** [createdBy](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-createdBy"></a>
The Amazon DataZone user who created the business glossary.  
Type: String

 ** [domainId](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-domainId"></a>
The ID of the Amazon DataZone domain in which this business glossary term exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [glossaryId](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-glossaryId"></a>
The ID of the business glossary to which this term belongs.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-id"></a>
The ID of the business glossary term.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [longDescription](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-longDescription"></a>
The long description of the business glossary term.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [name](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-name"></a>
The name of the business glossary term.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [shortDescription](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-shortDescription"></a>
The short decription of the business glossary term.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [status](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-status"></a>
The status of the business glossary term.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [termRelations](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-termRelations"></a>
The relations of the business glossary term.  
Type: [TermRelations](API_TermRelations.md) object

 ** [updatedAt](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-updatedAt"></a>
The timestamp of when the business glossary term was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-updatedBy"></a>
The Amazon DataZone user who updated the business glossary term.  
Type: String

 ** [usageRestrictions](#API_GetGlossaryTerm_ResponseSyntax) **   <a name="datazone-GetGlossaryTerm-response-usageRestrictions"></a>
The usage restriction of a term within a restricted glossary.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `ASSET_GOVERNED_TERMS` 

## Errors
<a name="API_GetGlossaryTerm_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetGlossaryTerm_Examples"></a>

### Example
<a name="API_GetGlossaryTerm_Example_1"></a>

This example illustrates one usage of GetGlossaryTerm.

#### Sample Request
<a name="API_GetGlossaryTerm_Example_1_Request"></a>

```
aws datazone get-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm9k4pq7xwnmh"
```

#### Sample Response
<a name="API_GetGlossaryTerm_Example_1_Response"></a>

```
{
    "createdAt": 1752575686.928,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "glossaryId": "gls8m3nqx2wkfp",
    "id": "trm9k4pq7xwnmh",
    "longDescription": "The total value a customer is expected to generate over their entire relationship with the business.",
    "name": "CustomerLifetimeValue",
    "shortDescription": "Predicted net profit from a customer relationship",
    "status": "ENABLED",
    "updatedAt": 1752575686.928,
    "updatedBy": "usr7nx82mkl"
}
```

### Example
<a name="API_GetGlossaryTerm_Example_2"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_GetGlossaryTerm_Example_2_Request"></a>

```
aws datazone get-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm_nonexistent"
```

#### Sample Response
<a name="API_GetGlossaryTerm_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the GetGlossaryTerm operation: The given GlossaryTerm doesn't exist. Try creating GlossaryTerm before accessing it.
```

### Example
<a name="API_GetGlossaryTerm_Example_3"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_GetGlossaryTerm_Example_3_Request"></a>

```
aws datazone get-glossary-term \
--identifier "trm9k4pq7xwnmh"
```

#### Sample Response
<a name="API_GetGlossaryTerm_Example_3_Response"></a>

```
aws: error: the following arguments are required: —domain-identifier
```

## See Also
<a name="API_GetGlossaryTerm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetGlossaryTerm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetGlossaryTerm) 

# GetGroupProfile
<a name="API_GetGroupProfile"></a>

Gets a group profile in Amazon DataZone.

## Request Syntax
<a name="API_GetGroupProfile_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/group-profiles/groupIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetGroupProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetGroupProfile_RequestSyntax) **   <a name="datazone-GetGroupProfile-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which the group profile exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [groupIdentifier](#API_GetGroupProfile_RequestSyntax) **   <a name="datazone-GetGroupProfile-request-uri-groupIdentifier"></a>
The identifier of the group profile.  
Pattern: `.*(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+).*`   
Required: Yes

## Request Body
<a name="API_GetGroupProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetGroupProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domainId": "string",
   "groupName": "string",
   "id": "string",
   "rolePrincipalArn": "string",
   "rolePrincipalId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_GetGroupProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_GetGroupProfile_ResponseSyntax) **   <a name="datazone-GetGroupProfile-response-domainId"></a>
The identifier of the Amazon DataZone domain in which the group profile exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [groupName](#API_GetGroupProfile_ResponseSyntax) **   <a name="datazone-GetGroupProfile-response-groupName"></a>
The name of the group for which the specified group profile exists.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z_0-9+=,.@-]+` 

 ** [id](#API_GetGroupProfile_ResponseSyntax) **   <a name="datazone-GetGroupProfile-response-id"></a>
The identifier of the group profile.  
Type: String  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [rolePrincipalArn](#API_GetGroupProfile_ResponseSyntax) **   <a name="datazone-GetGroupProfile-response-rolePrincipalArn"></a>
The ARN of the IAM role principal. This role is associated with the group profile.  
Type: String

 ** [rolePrincipalId](#API_GetGroupProfile_ResponseSyntax) **   <a name="datazone-GetGroupProfile-response-rolePrincipalId"></a>
The unique identifier of the IAM role principal. This principal is associated with the group profile.  
Type: String

 ** [status](#API_GetGroupProfile_ResponseSyntax) **   <a name="datazone-GetGroupProfile-response-status"></a>
The identifier of the group profile.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED` 

## Errors
<a name="API_GetGroupProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetGroupProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetGroupProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetGroupProfile) 

# GetIamPortalLoginUrl
<a name="API_GetIamPortalLoginUrl"></a>

Gets the data portal URL for the specified Amazon DataZone domain.

## Request Syntax
<a name="API_GetIamPortalLoginUrl_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/get-portal-login-url HTTP/1.1
```

## URI Request Parameters
<a name="API_GetIamPortalLoginUrl_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetIamPortalLoginUrl_RequestSyntax) **   <a name="datazone-GetIamPortalLoginUrl-request-uri-domainIdentifier"></a>
the ID of the Amazon DataZone domain the data portal of which you want to get.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetIamPortalLoginUrl_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetIamPortalLoginUrl_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "authCodeUrl": "string",
   "userProfileId": "string"
}
```

## Response Elements
<a name="API_GetIamPortalLoginUrl_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [authCodeUrl](#API_GetIamPortalLoginUrl_ResponseSyntax) **   <a name="datazone-GetIamPortalLoginUrl-response-authCodeUrl"></a>
The data portal URL of the specified Amazon DataZone domain.  
Type: String

 ** [userProfileId](#API_GetIamPortalLoginUrl_ResponseSyntax) **   <a name="datazone-GetIamPortalLoginUrl-response-userProfileId"></a>
The ID of the user profile.  
Type: String

## Errors
<a name="API_GetIamPortalLoginUrl_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetIamPortalLoginUrl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetIamPortalLoginUrl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetIamPortalLoginUrl) 

# GetJobRun
<a name="API_GetJobRun"></a>

The details of the job run.

## Request Syntax
<a name="API_GetJobRun_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/jobRuns/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetJobRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetJobRun_RequestSyntax) **   <a name="datazone-GetJobRun-request-uri-domainIdentifier"></a>
The ID of the domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetJobRun_RequestSyntax) **   <a name="datazone-GetJobRun-request-uri-identifier"></a>
The ID of the job run.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetJobRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetJobRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "details": { ... },
   "domainId": "string",
   "endTime": number,
   "error": { 
      "message": "string"
   },
   "id": "string",
   "jobId": "string",
   "jobType": "string",
   "runMode": "string",
   "startTime": number,
   "status": "string"
}
```

## Response Elements
<a name="API_GetJobRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-createdAt"></a>
The timestamp of when the job run was created.  
Type: Timestamp

 ** [createdBy](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-createdBy"></a>
The user who created the job run.  
Type: String

 ** [details](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-details"></a>
The details of the job run.  
Type: [JobRunDetails](API_JobRunDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [domainId](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-domainId"></a>
The ID of the domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [endTime](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-endTime"></a>
The timestamp of when the job run ended.  
Type: Timestamp

 ** [error](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-error"></a>
The error generated if the action is not completed successfully.  
Type: [JobRunError](API_JobRunError.md) object

 ** [id](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-id"></a>
The ID of the job run.  
Type: String

 ** [jobId](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-jobId"></a>
The ID of the job run.  
Type: String

 ** [jobType](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-jobType"></a>
The type of the job run.  
Type: String  
Valid Values: `LINEAGE` 

 ** [runMode](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-runMode"></a>
The mode of the job run.  
Type: String  
Valid Values: `SCHEDULED | ON_DEMAND` 

 ** [startTime](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-startTime"></a>
The timestamp of when the job run started.  
Type: Timestamp

 ** [status](#API_GetJobRun_ResponseSyntax) **   <a name="datazone-GetJobRun-response-status"></a>
The status of the job run.  
Type: String  
Valid Values: `SCHEDULED | IN_PROGRESS | SUCCESS | PARTIALLY_SUCCEEDED | FAILED | ABORTED | TIMED_OUT | CANCELED` 

## Errors
<a name="API_GetJobRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetJobRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetJobRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetJobRun) 

# GetLineageEvent
<a name="API_GetLineageEvent"></a>

Describes the lineage event.

## Request Syntax
<a name="API_GetLineageEvent_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/lineage/events/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetLineageEvent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetLineageEvent_RequestSyntax) **   <a name="datazone-GetLineageEvent-request-uri-domainIdentifier"></a>
The ID of the domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetLineageEvent_RequestSyntax) **   <a name="datazone-GetLineageEvent-request-uri-identifier"></a>
The ID of the lineage event.  
Pattern: `[a-z0-9]{14}`   
Required: Yes

## Request Body
<a name="API_GetLineageEvent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetLineageEvent_ResponseSyntax"></a>

```
HTTP/1.1 200
Domain-Id: domainId
Id: id
Created-By: createdBy
Processing-Status: processingStatus
Event-Time: eventTime
Created-At: createdAt

event
```

## Response Elements
<a name="API_GetLineageEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

 ** [createdAt](#API_GetLineageEvent_ResponseSyntax) **   <a name="datazone-GetLineageEvent-response-createdAt"></a>
The timestamp of when the lineage event was created.

 ** [createdBy](#API_GetLineageEvent_ResponseSyntax) **   <a name="datazone-GetLineageEvent-response-createdBy"></a>
The user who created the lineage event.

 ** [domainId](#API_GetLineageEvent_ResponseSyntax) **   <a name="datazone-GetLineageEvent-response-domainId"></a>
The ID of the domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [eventTime](#API_GetLineageEvent_ResponseSyntax) **   <a name="datazone-GetLineageEvent-response-eventTime"></a>
The time of the lineage event.

 ** [id](#API_GetLineageEvent_ResponseSyntax) **   <a name="datazone-GetLineageEvent-response-id"></a>
The ID of the lineage event.  
Pattern: `[a-z0-9]{14}` 

 ** [processingStatus](#API_GetLineageEvent_ResponseSyntax) **   <a name="datazone-GetLineageEvent-response-processingStatus"></a>
The progressing status of the lineage event.  
Valid Values: `REQUESTED | PROCESSING | SUCCESS | FAILED` 

The response returns the following as the HTTP body.

 ** [event](#API_GetLineageEvent_ResponseSyntax) **   <a name="datazone-GetLineageEvent-response-event"></a>
The lineage event details.  
Length Constraints: Minimum length of 0. Maximum length of 300000.

## Errors
<a name="API_GetLineageEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetLineageEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetLineageEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetLineageEvent) 

# GetLineageNode
<a name="API_GetLineageNode"></a>

Gets the data lineage node.

## Request Syntax
<a name="API_GetLineageNode_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/lineage/nodes/identifier?timestamp=eventTimestamp HTTP/1.1
```

## URI Request Parameters
<a name="API_GetLineageNode_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetLineageNode_RequestSyntax) **   <a name="datazone-GetLineageNode-request-uri-domainIdentifier"></a>
The ID of the domain in which you want to get the data lineage node.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [eventTimestamp](#API_GetLineageNode_RequestSyntax) **   <a name="datazone-GetLineageNode-request-uri-eventTimestamp"></a>
The event time stamp for which you want to get the data lineage node.

 ** [identifier](#API_GetLineageNode_RequestSyntax) **   <a name="datazone-GetLineageNode-request-uri-identifier"></a>
The ID of the data lineage node that you want to get.  
Both, a lineage node identifier generated by Amazon DataZone and a `sourceIdentifier` of the lineage node are supported. If `sourceIdentifier` is greater than 1800 characters, you can use lineage node identifier generated by Amazon DataZone to get the node details.  
Length Constraints: Minimum length of 1. Maximum length of 2086.  
Required: Yes

## Request Body
<a name="API_GetLineageNode_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetLineageNode_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "downstreamNodes": [ 
      { 
         "eventTimestamp": number,
         "id": "string"
      }
   ],
   "eventTimestamp": number,
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "id": "string",
   "name": "string",
   "sourceIdentifier": "string",
   "typeName": "string",
   "typeRevision": "string",
   "updatedAt": number,
   "updatedBy": "string",
   "upstreamNodes": [ 
      { 
         "eventTimestamp": number,
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetLineageNode_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-createdAt"></a>
The timestamp at which the data lineage node was created.  
Type: Timestamp

 ** [createdBy](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-createdBy"></a>
The user who created the data lineage node.  
Type: String

 ** [description](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-description"></a>
The description of the data lineage node.  
Type: String

 ** [domainId](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-domainId"></a>
The ID of the domain where you're getting the data lineage node.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [downstreamNodes](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-downstreamNodes"></a>
The downsteam nodes of the specified data lineage node.  
Type: Array of [LineageNodeReference](API_LineageNodeReference.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [eventTimestamp](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-eventTimestamp"></a>
The timestamp of the event described in the data lineage node.  
Type: Timestamp

 ** [formsOutput](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-formsOutput"></a>
The metadata of the specified data lineage node.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [id](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-id"></a>
The ID of the data lineage node.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-name"></a>
The name of the data lineage node.  
Type: String

 ** [sourceIdentifier](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-sourceIdentifier"></a>
The source identifier of the data lineage node.  
Type: String

 ** [typeName](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-typeName"></a>
The name of the type of the specified data lineage node.  
Type: String

 ** [typeRevision](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-typeRevision"></a>
The revision type of the specified data lineage node.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [updatedAt](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-updatedAt"></a>
The timestamp at which the data lineage node was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-updatedBy"></a>
The user who updated the data lineage node.  
Type: String

 ** [upstreamNodes](#API_GetLineageNode_ResponseSyntax) **   <a name="datazone-GetLineageNode-response-upstreamNodes"></a>
The upstream nodes of the specified data lineage node.  
Type: Array of [LineageNodeReference](API_LineageNodeReference.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_GetLineageNode_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetLineageNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetLineageNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetLineageNode) 

# GetListing
<a name="API_GetListing"></a>

Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

## Request Syntax
<a name="API_GetListing_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/listings/identifier?listingRevision=listingRevision HTTP/1.1
```

## URI Request Parameters
<a name="API_GetListing_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetListing_RequestSyntax) **   <a name="datazone-GetListing-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetListing_RequestSyntax) **   <a name="datazone-GetListing-request-uri-identifier"></a>
The ID of the listing.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [listingRevision](#API_GetListing_RequestSyntax) **   <a name="datazone-GetListing-request-uri-listingRevision"></a>
The revision of the listing.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_GetListing_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetListing_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "id": "string",
   "item": { ... },
   "listingRevision": "string",
   "name": "string",
   "status": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_GetListing_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-createdAt"></a>
The timestamp of when the listing was created.  
Type: Timestamp

 ** [createdBy](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-createdBy"></a>
The Amazon DataZone user who created the listing.  
Type: String

 ** [description](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-description"></a>
The description of the listing.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-domainId"></a>
The ID of the Amazon DataZone domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-id"></a>
The ID of the listing.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [item](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-item"></a>
The details of a listing.  
Type: [ListingItem](API_ListingItem.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [listingRevision](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-listingRevision"></a>
The revision of a listing.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [name](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-name"></a>
The name of the listing.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [status](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-status"></a>
The status of the listing.  
Type: String  
Valid Values: `CREATING | ACTIVE | INACTIVE` 

 ** [updatedAt](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-updatedAt"></a>
The timestamp of when the listing was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetListing_ResponseSyntax) **   <a name="datazone-GetListing-response-updatedBy"></a>
The Amazon DataZone user who updated the listing.  
Type: String

## Errors
<a name="API_GetListing_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetListing_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetListing) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetListing) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetListing) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetListing) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetListing) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetListing) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetListing) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetListing) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetListing) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetListing) 

# GetMetadataGenerationRun
<a name="API_GetMetadataGenerationRun"></a>

Gets a metadata generation run in Amazon DataZone.

Prerequisites:
+ Valid domain and run identifier. 
+ The metadata generation run must exist.
+ User must have read access to the metadata run.

## Request Syntax
<a name="API_GetMetadataGenerationRun_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/metadata-generation-runs/identifier?type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMetadataGenerationRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetMetadataGenerationRun_RequestSyntax) **   <a name="datazone-GetMetadataGenerationRun-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain the metadata generation run of which you want to get.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetMetadataGenerationRun_RequestSyntax) **   <a name="datazone-GetMetadataGenerationRun-request-uri-identifier"></a>
The identifier of the metadata generation run.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [type](#API_GetMetadataGenerationRun_RequestSyntax) **   <a name="datazone-GetMetadataGenerationRun-request-uri-type"></a>
The type of the metadata generation run.  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS` 

## Request Body
<a name="API_GetMetadataGenerationRun_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMetadataGenerationRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "id": "string",
   "owningProjectId": "string",
   "status": "string",
   "target": { 
      "identifier": "string",
      "revision": "string",
      "type": "string"
   },
   "type": "string",
   "types": [ "string" ],
   "typeStats": [ 
      { 
         "errorMessage": "string",
         "status": "string",
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetMetadataGenerationRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-createdAt"></a>
The timestamp of when the metadata generation run was start.  
Type: Timestamp

 ** [createdBy](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-createdBy"></a>
The Amazon DataZone user who started the metadata generation run.  
Type: String

 ** [domainId](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-domainId"></a>
The ID of the Amazon DataZone domain the metadata generation run of which you want to get.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-id"></a>
The ID of the metadata generation run.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningProjectId](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-owningProjectId"></a>
The ID of the project that owns the assets for which you're running metadata generation.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-status"></a>
The status of the metadata generation run.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELED | SUCCEEDED | FAILED | PARTIALLY_SUCCEEDED` 

 ** [target](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-target"></a>
The asset for which you're generating metadata.  
Type: [MetadataGenerationRunTarget](API_MetadataGenerationRunTarget.md) object

 ** [type](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-type"></a>
 *This parameter has been deprecated.*   
The type of metadata generation run.  
Type: String  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS` 

 ** [types](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-types"></a>
The types of the metadata generation run.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS` 

 ** [typeStats](#API_GetMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-GetMetadataGenerationRun-response-typeStats"></a>
The type stats included in the metadata generation run output details.  
Type: Array of [MetadataGenerationRunTypeStat](API_MetadataGenerationRunTypeStat.md) objects

## Errors
<a name="API_GetMetadataGenerationRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_GetMetadataGenerationRun_Examples"></a>

### Example
<a name="API_GetMetadataGenerationRun_Example_1"></a>

This example illustrates one usage of GetMetadataGenerationRun.

#### Sample Request
<a name="API_GetMetadataGenerationRun_Example_1_Request"></a>

```
aws datazone get-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "mgr5g0fy285m1q"
```

#### Sample Response
<a name="API_GetMetadataGenerationRun_Example_1_Response"></a>

```
{
    "createdAt": 1752644436.666,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "id": "mgr5g0fy285m1q",
    "owningProjectId": "prj7nx82mkl",
    "status": "CANCELED",
    "target": {
        "identifier": "ast6br2md6v9h",
        "revision": "1",
        "type": "ASSET"
    },
    "types": ["BUSINESS_DESCRIPTIONS"]
}
```

### Example
<a name="API_GetMetadataGenerationRun_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_GetMetadataGenerationRun_Example_2_Request"></a>

```
aws datazone get-metadata-generation-run
```

#### Sample Response
<a name="API_GetMetadataGenerationRun_Example_2_Response"></a>

```
aws: error: the following arguments are required: —domain-identifier, —identifier
```

### Example
<a name="API_GetMetadataGenerationRun_Example_3"></a>

Failure case - resource not found:

#### Sample Request
<a name="API_GetMetadataGenerationRun_Example_3_Request"></a>

```
aws datazone get-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "mgr_nonexistent"
```

#### Sample Response
<a name="API_GetMetadataGenerationRun_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the GetMetadataGenerationRun operation: Requested prediction cannot be found in domain
```

### Example
<a name="API_GetMetadataGenerationRun_Example_4"></a>

Failure case - validation error:

#### Sample Request
<a name="API_GetMetadataGenerationRun_Example_4_Request"></a>

```
aws datazone get-metadata-generation-run \
--domain-identifier "wrongdomain" \
--identifier "mgr5g0fy285m1q"
```

#### Sample Response
<a name="API_GetMetadataGenerationRun_Example_4_Response"></a>

```
An error occurred (ValidationException) when calling the GetMetadataGenerationRun operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}
```

### Example
<a name="API_GetMetadataGenerationRun_Example_5"></a>

Failure case - service quota exceeded:

#### Sample Request
<a name="API_GetMetadataGenerationRun_Example_5_Request"></a>

```
aws datazone get-metadata-generation-run \
--domain-identifier "wrongdomain" \
--identifier "mgr5g0fy285m1q"
```

#### Sample Response
<a name="API_GetMetadataGenerationRun_Example_5_Response"></a>

```
{
    "createdAt": 1.762972585509E9,
    "createdBy": "SYSTEM",
    "domainId": "dzd_6rexlvjnu84cbr",
    "id": "4sn866f04fzl47",
    "owningProjectId": "4dc7fa5wzsdup3",
    "status": "FAILED",
    "target": {
        "identifier": "duaeacyg76xovb",
        "revision": "23",
        "type": "ASSET"
    },
    "typeStats": [{
        "errorMessage": "business name generation has reached monthly quota",
        "status": "FAILED",
        "type": "BUSINESS_NAMES"
    }],
    "types": [
        "BUSINESS_NAMES"
    ]
}
```

### Example
<a name="API_GetMetadataGenerationRun_Example_6"></a>

GetMetadataGenerationRun with specific type:

#### Sample Request
<a name="API_GetMetadataGenerationRun_Example_6_Request"></a>

```
aws datazone get-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "mgr5g0fy285m1q"
--type "BUSINESS_NAMES"
```

#### Sample Response
<a name="API_GetMetadataGenerationRun_Example_6_Response"></a>

```
{
  "createdAt": 1.762021397763E9,
  "createdBy": "",
  "domainId": "dzd_53ielnpxktdilj",
  "id": "mgr5g0fy285m1q",
  "owningProjectId": "4dc7fa5wzsdup3",
  "status": "SUCCEEDED",
  "target": {
    "identifier": "cy61vbvez4nuw7",
    "revision": "12",
    "type": "ASSET"
  },
  "type": "BUSINESS_NAMES",
  "typeStats": [
    {
      "status": "SUCCEEDED",
      "type": "BUSINESS_NAMES"
    }
  ],
  "types": [
    "BUSINESS_NAMES"
  ]
}
```

## See Also
<a name="API_GetMetadataGenerationRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetMetadataGenerationRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetMetadataGenerationRun) 

# GetProject
<a name="API_GetProject"></a>

Gets a project in Amazon DataZone.

## Request Syntax
<a name="API_GetProject_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/projects/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetProject_RequestSyntax) **   <a name="datazone-GetProject-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the project exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetProject_RequestSyntax) **   <a name="datazone-GetProject-request-uri-identifier"></a>
The ID of the project.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetProject_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentDeploymentDetails": { 
      "environmentFailureReasons": { 
         "string" : [ 
            { 
               "code": "string",
               "message": "string"
            }
         ]
      },
      "overallDeploymentStatus": "string"
   },
   "failureReasons": [ 
      { 
         "code": "string",
         "message": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "projectCategory": "string",
   "projectProfileId": "string",
   "projectStatus": "string",
   "resourceTags": [ 
      { 
         "key": "string",
         "source": "string",
         "value": "string"
      }
   ],
   "userParameters": [ 
      { 
         "environmentConfigurationName": "string",
         "environmentId": "string",
         "environmentParameters": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "environmentResolvedAccount": { 
            "awsAccountId": "string",
            "regionName": "string",
            "sourceAccountPoolId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_GetProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-createdAt"></a>
The timestamp of when the project was created.  
Type: Timestamp

 ** [createdBy](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-createdBy"></a>
The Amazon DataZone user who created the project.  
Type: String

 ** [description](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-description"></a>
The description of the project.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-domainId"></a>
The ID of the Amazon DataZone domain in which the project exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-domainUnitId"></a>
The ID of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentDeploymentDetails](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-environmentDeploymentDetails"></a>
The environment deployment status of a project.  
Type: [EnvironmentDeploymentDetails](API_EnvironmentDeploymentDetails.md) object

 ** [failureReasons](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-failureReasons"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: Array of [ProjectDeletionError](API_ProjectDeletionError.md) objects

 ** [glossaryTerms](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-glossaryTerms"></a>
The business glossary terms that can be used in the project.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-id"></a>
>The ID of the project.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-lastUpdatedAt"></a>
The timestamp of when the project was last updated.  
Type: Timestamp

 ** [name](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-name"></a>
The name of the project.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectCategory](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-projectCategory"></a>
The category of the project.  
Type: String

 ** [projectProfileId](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-projectProfileId"></a>
The ID of the project profile of a project.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [projectStatus](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-projectStatus"></a>
The status of the project.  
Type: String  
Valid Values: `ACTIVE | DELETING | DELETE_FAILED | UPDATING | UPDATE_FAILED | MOVING` 

 ** [resourceTags](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-resourceTags"></a>
The resource tags of the project.  
Type: Array of [ResourceTag](API_ResourceTag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [userParameters](#API_GetProject_ResponseSyntax) **   <a name="datazone-GetProject-response-userParameters"></a>
The user parameters of a project.  
Type: Array of [EnvironmentConfigurationUserParameter](API_EnvironmentConfigurationUserParameter.md) objects

## Errors
<a name="API_GetProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetProject) 

# GetProjectProfile
<a name="API_GetProjectProfile"></a>

The details of the project profile.

## Request Syntax
<a name="API_GetProjectProfile_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/project-profiles/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetProjectProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetProjectProfile_RequestSyntax) **   <a name="datazone-GetProjectProfile-request-uri-domainIdentifier"></a>
The ID of the domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetProjectProfile_RequestSyntax) **   <a name="datazone-GetProjectProfile-request-uri-identifier"></a>
The ID of the project profile.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetProjectProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetProjectProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "allowCustomProjectResourceTags": boolean,
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentConfigurations": [ 
      { 
         "accountPools": [ "string" ],
         "awsAccount": { ... },
         "awsRegion": { ... },
         "configurationParameters": { 
            "parameterOverrides": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "resolvedParameters": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "ssmPath": "string"
         },
         "deploymentMode": "string",
         "deploymentOrder": number,
         "description": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "projectResourceTags": [ 
      { 
         "isValueEditable": boolean,
         "key": "string",
         "value": "string"
      }
   ],
   "projectResourceTagsDescription": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_GetProjectProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [allowCustomProjectResourceTags](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-allowCustomProjectResourceTags"></a>
Specifies whether custom project resource tags are supported.  
Type: Boolean

 ** [createdAt](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-createdAt"></a>
The timestamp of when the project profile was created.  
Type: Timestamp

 ** [createdBy](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-createdBy"></a>
The user who created the project profile.  
Type: String

 ** [description](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-description"></a>
The description of the project profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-domainId"></a>
The ID of the domain of the project profile.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-domainUnitId"></a>
The ID of the domain unit of the project profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentConfigurations](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-environmentConfigurations"></a>
The environment configurations of the project profile.  
Type: Array of [EnvironmentConfiguration](API_EnvironmentConfiguration.md) objects

 ** [id](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-id"></a>
The ID of the project profile.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-lastUpdatedAt"></a>
The timestamp of when project profile was last updated.  
Type: Timestamp

 ** [name](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-name"></a>
The name of the project profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectResourceTags](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-projectResourceTags"></a>
The resource tags of the project profile.  
Type: Array of [ResourceTagParameter](API_ResourceTagParameter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [projectResourceTagsDescription](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-projectResourceTagsDescription"></a>
Field viewable through the UI that provides a project user with the allowed resource tag specifications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [status](#API_GetProjectProfile_ResponseSyntax) **   <a name="datazone-GetProjectProfile-response-status"></a>
The status of the project profile.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

## Errors
<a name="API_GetProjectProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetProjectProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetProjectProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetProjectProfile) 

# GetRule
<a name="API_GetRule"></a>

Gets the details of a rule in Amazon DataZone. A rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

## Request Syntax
<a name="API_GetRule_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/rules/identifier?revision=revision HTTP/1.1
```

## URI Request Parameters
<a name="API_GetRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetRule_RequestSyntax) **   <a name="datazone-GetRule-request-uri-domainIdentifier"></a>
The ID of the domain where the `GetRule` action is to be invoked.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetRule_RequestSyntax) **   <a name="datazone-GetRule-request-uri-identifier"></a>
The ID of the rule.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [revision](#API_GetRule_RequestSyntax) **   <a name="datazone-GetRule-request-uri-revision"></a>
The revision of the rule.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_GetRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "action": "string",
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "detail": { ... },
   "identifier": "string",
   "lastUpdatedBy": "string",
   "name": "string",
   "revision": "string",
   "ruleType": "string",
   "scope": { 
      "assetType": { 
         "selectionMode": "string",
         "specificAssetTypes": [ "string" ]
      },
      "dataProduct": boolean,
      "project": { 
         "selectionMode": "string",
         "specificProjects": [ "string" ]
      }
   },
   "target": { ... },
   "targetType": "string",
   "updatedAt": number
}
```

## Response Elements
<a name="API_GetRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [action](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-action"></a>
The action of the rule.  
Type: String  
Valid Values: `CREATE_LISTING_CHANGE_SET | CREATE_SUBSCRIPTION_REQUEST` 

 ** [createdAt](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-createdAt"></a>
The timestamp at which the rule was created.  
Type: Timestamp

 ** [createdBy](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-createdBy"></a>
The user who created the rule.  
Type: String

 ** [description](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-description"></a>
The description of the rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [detail](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-detail"></a>
The detail of the rule.  
Type: [RuleDetail](API_RuleDetail.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [identifier](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-identifier"></a>
The ID of the rule.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedBy](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-lastUpdatedBy"></a>
The timestamp at which the rule was last updated.  
Type: String

 ** [name](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\w -]+` 

 ** [revision](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-revision"></a>
The revision of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ruleType](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-ruleType"></a>
The type of the rule.  
Type: String  
Valid Values: `METADATA_FORM_ENFORCEMENT | GLOSSARY_TERM_ENFORCEMENT` 

 ** [scope](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-scope"></a>
The scope of the rule.  
Type: [RuleScope](API_RuleScope.md) object

 ** [target](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-target"></a>
The target of the rule.  
Type: [RuleTarget](API_RuleTarget.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [targetType](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-targetType"></a>
The target type of the rule.  
Type: String  
Valid Values: `DOMAIN_UNIT` 

 ** [updatedAt](#API_GetRule_ResponseSyntax) **   <a name="datazone-GetRule-response-updatedAt"></a>
The timestamp at which the rule was last updated.  
Type: Timestamp

## Errors
<a name="API_GetRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetRule) 

# GetSubscription
<a name="API_GetSubscription"></a>

Gets a subscription in Amazon DataZone.

## Request Syntax
<a name="API_GetSubscription_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/subscriptions/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSubscription_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetSubscription_RequestSyntax) **   <a name="datazone-GetSubscription-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the subscription exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetSubscription_RequestSyntax) **   <a name="datazone-GetSubscription-request-uri-identifier"></a>
The ID of the subscription.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetSubscription_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSubscription_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "id": "string",
   "retainPermissions": boolean,
   "status": "string",
   "subscribedListing": { 
      "description": "string",
      "id": "string",
      "item": { ... },
      "name": "string",
      "ownerProjectId": "string",
      "ownerProjectName": "string",
      "revision": "string"
   },
   "subscribedPrincipal": { ... },
   "subscriptionRequestId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_GetSubscription_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-createdAt"></a>
The timestamp of when the subscription was created.  
Type: Timestamp

 ** [createdBy](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-createdBy"></a>
The Amazon DataZone user who created the subscription.  
Type: String

 ** [domainId](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-domainId"></a>
The ID of the Amazon DataZone domain in which the subscription exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-id"></a>
The ID of the subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [retainPermissions](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-retainPermissions"></a>
The retain permissions of the subscription.  
Type: Boolean

 ** [status](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-status"></a>
The status of the subscription.  
Type: String  
Valid Values: `APPROVED | REVOKED | CANCELLED` 

 ** [subscribedListing](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-subscribedListing"></a>
The details of the published asset for which the subscription grant is created.  
Type: [SubscribedListing](API_SubscribedListing.md) object

 ** [subscribedPrincipal](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-subscribedPrincipal"></a>
The principal that owns the subscription.  
Type: [SubscribedPrincipal](API_SubscribedPrincipal.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [subscriptionRequestId](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-subscriptionRequestId"></a>
The ID of the subscription request.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-updatedAt"></a>
The timestamp of when the subscription was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetSubscription_ResponseSyntax) **   <a name="datazone-GetSubscription-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription.  
Type: String

## Errors
<a name="API_GetSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetSubscription) 

# GetSubscriptionGrant
<a name="API_GetSubscriptionGrant"></a>

Gets the subscription grant in Amazon DataZone.

## Request Syntax
<a name="API_GetSubscriptionGrant_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/subscription-grants/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSubscriptionGrant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetSubscriptionGrant_RequestSyntax) **   <a name="datazone-GetSubscriptionGrant-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the subscription grant exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetSubscriptionGrant_RequestSyntax) **   <a name="datazone-GetSubscriptionGrant-request-uri-identifier"></a>
The ID of the subscription grant.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetSubscriptionGrant_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSubscriptionGrant_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assets": [ 
      { 
         "assetId": "string",
         "assetRevision": "string",
         "assetScope": { 
            "assetId": "string",
            "errorMessage": "string",
            "filterIds": [ "string" ],
            "status": "string"
         },
         "failureCause": { 
            "message": "string"
         },
         "failureTimestamp": number,
         "grantedTimestamp": number,
         "permissions": { ... },
         "status": "string",
         "targetName": "string"
      }
   ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "grantedEntity": { ... },
   "id": "string",
   "status": "string",
   "subscriptionId": "string",
   "subscriptionTargetId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_GetSubscriptionGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assets](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-assets"></a>
The assets for which the subscription grant is created.  
Type: Array of [SubscribedAsset](API_SubscribedAsset.md) objects

 ** [createdAt](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-createdAt"></a>
The timestamp of when the subscription grant is created.  
Type: Timestamp

 ** [createdBy](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-createdBy"></a>
The Amazon DataZone user who created the subscription grant.  
Type: String

 ** [domainId](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-domainId"></a>
The ID of the Amazon DataZone domain in which the subscription grant exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-environmentId"></a>
The environment ID of the subscription grant.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [grantedEntity](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-grantedEntity"></a>
The entity to which the subscription is granted.  
Type: [GrantedEntity](API_GrantedEntity.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [id](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-id"></a>
The ID of the subscription grant.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-status"></a>
The status of the subscription grant.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | GRANT_FAILED | REVOKE_FAILED | GRANT_AND_REVOKE_FAILED | COMPLETED | INACCESSIBLE` 

 ** [subscriptionId](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-subscriptionId"></a>
 *This parameter has been deprecated.*   
The identifier of the subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [subscriptionTargetId](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-subscriptionTargetId"></a>
The subscription target ID associated with the subscription grant.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-updatedAt"></a>
The timestamp of when the subscription grant was upated.  
Type: Timestamp

 ** [updatedBy](#API_GetSubscriptionGrant_ResponseSyntax) **   <a name="datazone-GetSubscriptionGrant-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription grant.  
Type: String

## Errors
<a name="API_GetSubscriptionGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetSubscriptionGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetSubscriptionGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetSubscriptionGrant) 

# GetSubscriptionRequestDetails
<a name="API_GetSubscriptionRequestDetails"></a>

Gets the details of the specified subscription request.

## Request Syntax
<a name="API_GetSubscriptionRequestDetails_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/subscription-requests/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSubscriptionRequestDetails_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetSubscriptionRequestDetails_RequestSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which to get the subscription request details.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetSubscriptionRequestDetails_RequestSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-request-uri-identifier"></a>
The identifier of the subscription request the details of which to get.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetSubscriptionRequestDetails_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSubscriptionRequestDetails_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "decisionComment": "string",
   "domainId": "string",
   "existingSubscriptionId": "string",
   "id": "string",
   "metadataForms": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "requestReason": "string",
   "reviewerId": "string",
   "status": "string",
   "subscribedListings": [ 
      { 
         "description": "string",
         "id": "string",
         "item": { ... },
         "name": "string",
         "ownerProjectId": "string",
         "ownerProjectName": "string",
         "revision": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ],
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_GetSubscriptionRequestDetails_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-createdAt"></a>
The timestamp of when the specified subscription request was created.  
Type: Timestamp

 ** [createdBy](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-createdBy"></a>
The Amazon DataZone user who created the subscription request.  
Type: String

 ** [decisionComment](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-decisionComment"></a>
The decision comment of the subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-domainId"></a>
The Amazon DataZone domain of the subscription request.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [existingSubscriptionId](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-existingSubscriptionId"></a>
The ID of the existing subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-id"></a>
The identifier of the subscription request.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [metadataForms](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-metadataForms"></a>
The metadata forms included in the subscription request.  
Type: Array of [FormOutput](API_FormOutput.md) objects

 ** [requestReason](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-requestReason"></a>
The reason for the subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [reviewerId](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-reviewerId"></a>
The identifier of the Amazon DataZone user who reviewed the subscription request.  
Type: String

 ** [status](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-status"></a>
The status of the subscription request.  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED` 

 ** [subscribedListings](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-subscribedListings"></a>
The subscribed listings in the subscription request.  
Type: Array of [SubscribedListing](API_SubscribedListing.md) objects  
Array Members: Fixed number of 1 item.

 ** [subscribedPrincipals](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-subscribedPrincipals"></a>
The subscribed principals in the subscription request.  
Type: Array of [SubscribedPrincipal](API_SubscribedPrincipal.md) objects  
Array Members: Fixed number of 1 item.

 ** [updatedAt](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-updatedAt"></a>
The timestamp of when the subscription request was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetSubscriptionRequestDetails_ResponseSyntax) **   <a name="datazone-GetSubscriptionRequestDetails-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription request.  
Type: String

## Errors
<a name="API_GetSubscriptionRequestDetails_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetSubscriptionRequestDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetSubscriptionRequestDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetSubscriptionRequestDetails) 

# GetSubscriptionTarget
<a name="API_GetSubscriptionTarget"></a>

Gets the subscription target in Amazon DataZone.

## Request Syntax
<a name="API_GetSubscriptionTarget_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environments/environmentIdentifier/subscription-targets/identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetSubscriptionTarget_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetSubscriptionTarget_RequestSyntax) **   <a name="datazone-GetSubscriptionTarget-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the subscription target exists.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_GetSubscriptionTarget_RequestSyntax) **   <a name="datazone-GetSubscriptionTarget-request-uri-environmentIdentifier"></a>
The ID of the environment associated with the subscription target.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_GetSubscriptionTarget_RequestSyntax) **   <a name="datazone-GetSubscriptionTarget-request-uri-identifier"></a>
The ID of the subscription target.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetSubscriptionTarget_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetSubscriptionTarget_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicableAssetTypes": [ "string" ],
   "authorizedPrincipals": [ "string" ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "manageAccessRole": "string",
   "name": "string",
   "projectId": "string",
   "provider": "string",
   "subscriptionGrantCreationMode": "string",
   "subscriptionTargetConfig": [ 
      { 
         "content": "string",
         "formName": "string"
      }
   ],
   "type": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_GetSubscriptionTarget_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicableAssetTypes](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-applicableAssetTypes"></a>
The asset types associated with the subscription target.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*` 

 ** [authorizedPrincipals](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-authorizedPrincipals"></a>
The authorized principals of the subscription target.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9:/._-]*` 

 ** [createdAt](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-createdAt"></a>
The timestamp of when the subscription target was created.  
Type: Timestamp

 ** [createdBy](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-createdBy"></a>
The Amazon DataZone user who created the subscription target.  
Type: String

 ** [domainId](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-domainId"></a>
The ID of the Amazon DataZone domain in which the subscription target exists.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-environmentId"></a>
The ID of the environment associated with the subscription target.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-id"></a>
The ID of the subscription target.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [manageAccessRole](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-manageAccessRole"></a>
The manage access role with which the subscription target was created.  
Type: String  
Pattern: `arn:aws(|-cn|-us-gov):iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*` 

 ** [name](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-name"></a>
The name of the subscription target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [projectId](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-projectId"></a>
The ID of the project associated with the subscription target.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [provider](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-provider"></a>
The provider of the subscription target.  
Type: String

 ** [subscriptionGrantCreationMode](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-subscriptionGrantCreationMode"></a>
 Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.   
Type: String  
Valid Values: `AUTOMATIC | MANUAL` 

 ** [subscriptionTargetConfig](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-subscriptionTargetConfig"></a>
The configuration of teh subscription target.  
Type: Array of [SubscriptionTargetForm](API_SubscriptionTargetForm.md) objects

 ** [type](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-type"></a>
The type of the subscription target.  
Type: String

 ** [updatedAt](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-updatedAt"></a>
The timestamp of when the subscription target was updated.  
Type: Timestamp

 ** [updatedBy](#API_GetSubscriptionTarget_ResponseSyntax) **   <a name="datazone-GetSubscriptionTarget-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription target.  
Type: String

## Errors
<a name="API_GetSubscriptionTarget_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetSubscriptionTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetSubscriptionTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetSubscriptionTarget) 

# GetTimeSeriesDataPoint
<a name="API_GetTimeSeriesDataPoint"></a>

Gets the existing data point for the asset.

## Request Syntax
<a name="API_GetTimeSeriesDataPoint_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/time-series-data-points/identifier?formName=formName HTTP/1.1
```

## URI Request Parameters
<a name="API_GetTimeSeriesDataPoint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetTimeSeriesDataPoint_RequestSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_GetTimeSeriesDataPoint_RequestSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-request-uri-entityIdentifier"></a>
The ID of the asset for which you want to get the data point.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityType](#API_GetTimeSeriesDataPoint_RequestSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-request-uri-entityType"></a>
The type of the asset for which you want to get the data point.  
Valid Values: `ASSET | LISTING`   
Required: Yes

 ** [formName](#API_GetTimeSeriesDataPoint_RequestSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-request-uri-formName"></a>
The name of the time series form that houses the data point that you want to get.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [identifier](#API_GetTimeSeriesDataPoint_RequestSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-request-uri-identifier"></a>
The ID of the data point that you want to get.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_GetTimeSeriesDataPoint_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetTimeSeriesDataPoint_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domainId": "string",
   "entityId": "string",
   "entityType": "string",
   "form": { 
      "content": "string",
      "formName": "string",
      "id": "string",
      "timestamp": number,
      "typeIdentifier": "string",
      "typeRevision": "string"
   },
   "formName": "string"
}
```

## Response Elements
<a name="API_GetTimeSeriesDataPoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_GetTimeSeriesDataPoint_ResponseSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-response-domainId"></a>
The ID of the Amazon DataZone domain that houses the asset data point that you want to get.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [entityId](#API_GetTimeSeriesDataPoint_ResponseSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-response-entityId"></a>
The ID of the asset for which you want to get the data point.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [entityType](#API_GetTimeSeriesDataPoint_ResponseSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-response-entityType"></a>
The type of the asset for which you want to get the data point.  
Type: String  
Valid Values: `ASSET | LISTING` 

 ** [form](#API_GetTimeSeriesDataPoint_ResponseSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-response-form"></a>
The time series form that houses the data point that you want to get.  
Type: [TimeSeriesDataPointFormOutput](API_TimeSeriesDataPointFormOutput.md) object

 ** [formName](#API_GetTimeSeriesDataPoint_ResponseSyntax) **   <a name="datazone-GetTimeSeriesDataPoint-response-formName"></a>
The name of the time series form that houses the data point that you want to get.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

## Errors
<a name="API_GetTimeSeriesDataPoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetTimeSeriesDataPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetTimeSeriesDataPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetTimeSeriesDataPoint) 

# GetUserProfile
<a name="API_GetUserProfile"></a>

Gets a user profile in Amazon DataZone.

## Request Syntax
<a name="API_GetUserProfile_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/user-profiles/userIdentifier?sessionName=sessionName&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUserProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_GetUserProfile_RequestSyntax) **   <a name="datazone-GetUserProfile-request-uri-domainIdentifier"></a>
the ID of the Amazon DataZone domain the data portal of which you want to get.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [sessionName](#API_GetUserProfile_RequestSyntax) **   <a name="datazone-GetUserProfile-request-uri-sessionName"></a>
The session name for IAM role sessions.  
Length Constraints: Minimum length of 2. Maximum length of 64.

 ** [type](#API_GetUserProfile_RequestSyntax) **   <a name="datazone-GetUserProfile-request-uri-type"></a>
The type of the user profile.  
Valid Values: `IAM | SSO` 

 ** [userIdentifier](#API_GetUserProfile_RequestSyntax) **   <a name="datazone-GetUserProfile-request-uri-userIdentifier"></a>
The identifier of the user for which you want to get the user profile.  
Pattern: `.*(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$).*`   
Required: Yes

## Request Body
<a name="API_GetUserProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUserProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "details": { ... },
   "domainId": "string",
   "id": "string",
   "status": "string",
   "type": "string"
}
```

## Response Elements
<a name="API_GetUserProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [details](#API_GetUserProfile_ResponseSyntax) **   <a name="datazone-GetUserProfile-response-details"></a>
The user profile details.  
Type: [UserProfileDetails](API_UserProfileDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [domainId](#API_GetUserProfile_ResponseSyntax) **   <a name="datazone-GetUserProfile-response-domainId"></a>
the identifier of the Amazon DataZone domain of which you want to get the user profile.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_GetUserProfile_ResponseSyntax) **   <a name="datazone-GetUserProfile-response-id"></a>
The identifier of the user profile.  
Type: String  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [status](#API_GetUserProfile_ResponseSyntax) **   <a name="datazone-GetUserProfile-response-status"></a>
The status of the user profile.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED | ACTIVATED | DEACTIVATED` 

 ** [type](#API_GetUserProfile_ResponseSyntax) **   <a name="datazone-GetUserProfile-response-type"></a>
The type of the user profile.  
Type: String  
Valid Values: `IAM | SSO` 

## Errors
<a name="API_GetUserProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_GetUserProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/GetUserProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/GetUserProfile) 

# ListAccountPools
<a name="API_ListAccountPools"></a>

Lists existing account pools.

## Request Syntax
<a name="API_ListAccountPools_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/account-pools?maxResults=maxResults&name=name&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAccountPools_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListAccountPools_RequestSyntax) **   <a name="datazone-ListAccountPools-request-uri-domainIdentifier"></a>
The ID of the domain where exsting account pools are to be listed.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListAccountPools_RequestSyntax) **   <a name="datazone-ListAccountPools-request-uri-maxResults"></a>
The maximum number of account pools to return in a single call to ListAccountPools. When the number of account pools 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 ListAccountPools to list the next set of account pools.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListAccountPools_RequestSyntax) **   <a name="datazone-ListAccountPools-request-uri-name"></a>
The name of the account pool to be listed.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [nextToken](#API_ListAccountPools_RequestSyntax) **   <a name="datazone-ListAccountPools-request-uri-nextToken"></a>
When the number of account pools 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 account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [sortBy](#API_ListAccountPools_RequestSyntax) **   <a name="datazone-ListAccountPools-request-uri-sortBy"></a>
The sort by mechanism in which the existing account pools are to be listed.  
Valid Values: `NAME` 

 ** [sortOrder](#API_ListAccountPools_RequestSyntax) **   <a name="datazone-ListAccountPools-request-uri-sortOrder"></a>
The sort order in which the existing account pools are to be listed.  
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_ListAccountPools_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAccountPools_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdBy": "string",
         "domainId": "string",
         "domainUnitId": "string",
         "id": "string",
         "name": "string",
         "resolutionStrategy": "string",
         "updatedBy": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAccountPools_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListAccountPools_ResponseSyntax) **   <a name="datazone-ListAccountPools-response-items"></a>
The results of the ListAccountPools operation.  
Type: Array of [AccountPoolSummary](API_AccountPoolSummary.md) objects

 ** [nextToken](#API_ListAccountPools_ResponseSyntax) **   <a name="datazone-ListAccountPools-response-nextToken"></a>
When the number of account pools 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 account pools, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountPools to list the next set of account pools.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListAccountPools_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListAccountPools_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListAccountPools) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListAccountPools) 

# ListAccountsInAccountPool
<a name="API_ListAccountsInAccountPool"></a>

Lists the accounts in the specified account pool.

## Request Syntax
<a name="API_ListAccountsInAccountPool_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/account-pools/identifier/accounts?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAccountsInAccountPool_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListAccountsInAccountPool_RequestSyntax) **   <a name="datazone-ListAccountsInAccountPool-request-uri-domainIdentifier"></a>
The ID of the domain in which the accounts in the specified account pool are to be listed.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_ListAccountsInAccountPool_RequestSyntax) **   <a name="datazone-ListAccountsInAccountPool-request-uri-identifier"></a>
The ID of the account pool whose accounts are to be listed.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListAccountsInAccountPool_RequestSyntax) **   <a name="datazone-ListAccountsInAccountPool-request-uri-maxResults"></a>
The maximum number of accounts to return in a single call to ListAccountsInAccountPool. When the number of accounts 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 ListAccountsInAccountPool to list the next set of accounts.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListAccountsInAccountPool_RequestSyntax) **   <a name="datazone-ListAccountsInAccountPool-request-uri-nextToken"></a>
When the number of accounts 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 accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_ListAccountsInAccountPool_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAccountsInAccountPool_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "awsAccountId": "string",
         "awsAccountName": "string",
         "supportedRegions": [ "string" ]
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAccountsInAccountPool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListAccountsInAccountPool_ResponseSyntax) **   <a name="datazone-ListAccountsInAccountPool-response-items"></a>
The results of the ListAccountsInAccountPool operation.  
Type: Array of [AccountInfo](API_AccountInfo.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 25 items.

 ** [nextToken](#API_ListAccountsInAccountPool_ResponseSyntax) **   <a name="datazone-ListAccountsInAccountPool-response-nextToken"></a>
When the number of accounts 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 accounts, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAccountsInAccountPool to list the next set of accounts.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListAccountsInAccountPool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListAccountsInAccountPool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListAccountsInAccountPool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListAccountsInAccountPool) 

# ListAssetFilters
<a name="API_ListAssetFilters"></a>

Lists asset filters.

Prerequisites:
+ A valid domain and asset must exist. 
+ The asset must have at least one filter created to return results. 

## Request Syntax
<a name="API_ListAssetFilters_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/assets/assetIdentifier/filters?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetFilters_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetIdentifier](#API_ListAssetFilters_RequestSyntax) **   <a name="datazone-ListAssetFilters-request-uri-assetIdentifier"></a>
The ID of the data asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_ListAssetFilters_RequestSyntax) **   <a name="datazone-ListAssetFilters-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list asset filters.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListAssetFilters_RequestSyntax) **   <a name="datazone-ListAssetFilters-request-uri-maxResults"></a>
The maximum number of asset filters to return in a single call to `ListAssetFilters`. When the number of asset filters 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 `ListAssetFilters` to list the next set of asset filters.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListAssetFilters_RequestSyntax) **   <a name="datazone-ListAssetFilters-request-uri-nextToken"></a>
When the number of asset filters 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 asset filters, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListAssetFilters` to list the next set of asset filters.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [status](#API_ListAssetFilters_RequestSyntax) **   <a name="datazone-ListAssetFilters-request-uri-status"></a>
The status of the asset filter.  
Valid Values: `VALID | INVALID` 

## Request Body
<a name="API_ListAssetFilters_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetFilters_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "assetId": "string",
         "createdAt": number,
         "description": "string",
         "domainId": "string",
         "effectiveColumnNames": [ "string" ],
         "effectiveRowFilter": "string",
         "errorMessage": "string",
         "id": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetFilters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListAssetFilters_ResponseSyntax) **   <a name="datazone-ListAssetFilters-response-items"></a>
The results of the `ListAssetFilters` action.  
Type: Array of [AssetFilterSummary](API_AssetFilterSummary.md) objects

 ** [nextToken](#API_ListAssetFilters_ResponseSyntax) **   <a name="datazone-ListAssetFilters-response-nextToken"></a>
When the number of asset filters 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 asset filters, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListAssetFilters` to list the next set of asset filters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListAssetFilters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_ListAssetFilters_Examples"></a>

### Example
<a name="API_ListAssetFilters_Example_1"></a>

This example illustrates one usage of ListAssetFilters.

#### Sample Request
<a name="API_ListAssetFilters_Example_1_Request"></a>

```
aws datazone list-asset-filters \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4"
```

#### Sample Response
<a name="API_ListAssetFilters_Example_1_Response"></a>

```
{
    "items": [{
        "assetId": "ast7k9mpq2xvn4",
        "createdAt": 1752651315.63,
        "description": "Filter for customer PII data",
        "domainId": "dzd_53ielnpxktdilj",
        "effectiveColumnNames": [
            "customer_id",
            "email",
            "phone_number",
            "address"
        ],
        "id": "flt8p2mq3xvn5",
        "name": "customer-pii-filter",
        "status": "VALID"
    }]
}
```

### Example
<a name="API_ListAssetFilters_Example_2"></a>

Failure case - missing required `--asset-identifier`: 

#### Sample Request
<a name="API_ListAssetFilters_Example_2_Request"></a>

```
aws datazone list-asset-filters \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_ListAssetFilters_Example_2_Response"></a>

```
aws: error: the following arguments are required: —asset-identifier
```

## See Also
<a name="API_ListAssetFilters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListAssetFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListAssetFilters) 

# ListAssetRevisions
<a name="API_ListAssetRevisions"></a>

Lists the revisions for the asset.

Prerequisites:
+ The asset must exist in the domain. 
+ There must be at least one revision of the asset (which happens automatically after creation).
+ The domain must be valid and active.
+ User must have permissions on the asset and domain.

## Request Syntax
<a name="API_ListAssetRevisions_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/assets/identifier/revisions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssetRevisions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListAssetRevisions_RequestSyntax) **   <a name="datazone-ListAssetRevisions-request-uri-domainIdentifier"></a>
The identifier of the domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_ListAssetRevisions_RequestSyntax) **   <a name="datazone-ListAssetRevisions-request-uri-identifier"></a>
The identifier of the asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListAssetRevisions_RequestSyntax) **   <a name="datazone-ListAssetRevisions-request-uri-maxResults"></a>
The maximum number of revisions to return in a single call to `ListAssetRevisions`. When the number of revisions to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListAssetRevisions` to list the next set of revisions.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListAssetRevisions_RequestSyntax) **   <a name="datazone-ListAssetRevisions-request-uri-nextToken"></a>
When the number of revisions is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of revisions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListAssetRevisions` to list the next set of revisions.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_ListAssetRevisions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssetRevisions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "id": "string",
         "revision": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAssetRevisions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListAssetRevisions_ResponseSyntax) **   <a name="datazone-ListAssetRevisions-response-items"></a>
The results of the `ListAssetRevisions` action.  
Type: Array of [AssetRevision](API_AssetRevision.md) objects

 ** [nextToken](#API_ListAssetRevisions_ResponseSyntax) **   <a name="datazone-ListAssetRevisions-response-nextToken"></a>
When the number of revisions is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of revisions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListAssetRevisions` to list the next set of revisions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListAssetRevisions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_ListAssetRevisions_Examples"></a>

### Example
<a name="API_ListAssetRevisions_Example_1"></a>

This example illustrates one usage of ListAssetRevisions.

#### Sample Request
<a name="API_ListAssetRevisions_Example_1_Request"></a>

```
aws datazone list-asset-revisions \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "ast7k9mpq2xvn4"
```

#### Sample Response
<a name="API_ListAssetRevisions_Example_1_Response"></a>

```
{
    "items": [
        {
            "createdAt": 1752601021.227,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "ast7k9mpq2xvn4",
            "revision": "2"
        },
        {
            "createdAt": 1752554243.917,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "ast7k9mpq2xvn4",
            "revision": "1"
        }
    ]
}
```

### Example
<a name="API_ListAssetRevisions_Example_2"></a>

Failure case - resource does not exist: 

#### Sample Request
<a name="API_ListAssetRevisions_Example_2_Request"></a>

```
aws datazone list-asset-revisions \ --domain-identifier "dzd_53ielnpxktdilj" \ --identifier "ast_nonexistent"
```

#### Sample Response
<a name="API_ListAssetRevisions_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the ListAssetRevisions operation: The given Asset doesn't exist. Try creating Asset before accessing it.
```

### Example
<a name="API_ListAssetRevisions_Example_3"></a>

Failure case - missing required parameter

#### Sample Request
<a name="API_ListAssetRevisions_Example_3_Request"></a>

```
aws datazone list-asset-revisions \
--identifier "ast7k9mpq2xvn4"
```

#### Sample Response
<a name="API_ListAssetRevisions_Example_3_Response"></a>

```
aws: error: the following arguments are required: —domain-identifier
```

## See Also
<a name="API_ListAssetRevisions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListAssetRevisions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListAssetRevisions) 

# ListConnections
<a name="API_ListConnections"></a>

Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

## Request Syntax
<a name="API_ListConnections_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/connections?environmentIdentifier=environmentIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier&scope=scope&sortBy=sortBy&sortOrder=sortOrder&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListConnections_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list connections.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-environmentIdentifier"></a>
The ID of the environment where you want to list connections.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [maxResults](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-maxResults"></a>
The maximum number of connections to return in a single call to ListConnections. When the number of connections 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 ListConnections to list the next set of connections.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-name"></a>
The name of the connection.  
Length Constraints: Minimum length of 0. Maximum length of 64.

 ** [nextToken](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-nextToken"></a>
When the number of connections 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 connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [projectIdentifier](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-projectIdentifier"></a>
The ID of the project where you want to list connections.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [scope](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-scope"></a>
The scope of the connection.  
Valid Values: `DOMAIN | PROJECT` 

 ** [sortBy](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-sortBy"></a>
Specifies how you want to sort the listed connections.  
Valid Values: `NAME` 

 ** [sortOrder](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-sortOrder"></a>
Specifies the sort order for the listed connections.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [type](#API_ListConnections_RequestSyntax) **   <a name="datazone-ListConnections-request-uri-type"></a>
The type of connection.  
Valid Values: `ATHENA | BIGQUERY | DATABRICKS | DOCUMENTDB | DYNAMODB | HYPERPOD | IAM | MYSQL | OPENSEARCH | ORACLE | POSTGRESQL | REDSHIFT | S3 | SAPHANA | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | VERTICA | WORKFLOWS_MWAA | AMAZON_Q | MLFLOW` 

## Request Body
<a name="API_ListConnections_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListConnections_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "configurations": [ 
            { 
               "classification": "string",
               "properties": { 
                  "string" : "string" 
               }
            }
         ],
         "connectionId": "string",
         "domainId": "string",
         "domainUnitId": "string",
         "environmentId": "string",
         "name": "string",
         "physicalEndpoints": [ 
            { 
               "awsLocation": { 
                  "accessRole": "string",
                  "awsAccountId": "string",
                  "awsRegion": "string",
                  "iamConnectionId": "string"
               },
               "enableTrustedIdentityPropagation": boolean,
               "glueConnection": { 
                  "athenaProperties": { 
                     "string" : "string" 
                  },
                  "authenticationConfiguration": { 
                     "authenticationType": "string",
                     "oAuth2Properties": { 
                        "authorizationCodeProperties": { 
                           "authorizationCode": "string",
                           "redirectUri": "string"
                        },
                        "oAuth2ClientApplication": { 
                           "aWSManagedClientApplicationReference": "string",
                           "userManagedClientApplicationClientId": "string"
                        },
                        "oAuth2Credentials": { 
                           "accessToken": "string",
                           "jwtToken": "string",
                           "refreshToken": "string",
                           "userManagedClientApplicationClientSecret": "string"
                        },
                        "oAuth2GrantType": "string",
                        "tokenUrl": "string",
                        "tokenUrlParametersMap": { 
                           "string" : "string" 
                        }
                     },
                     "secretArn": "string"
                  },
                  "compatibleComputeEnvironments": [ "string" ],
                  "connectionProperties": { 
                     "string" : "string" 
                  },
                  "connectionSchemaVersion": number,
                  "connectionType": "string",
                  "creationTime": number,
                  "description": "string",
                  "lastConnectionValidationTime": number,
                  "lastUpdatedBy": "string",
                  "lastUpdatedTime": number,
                  "matchCriteria": [ "string" ],
                  "name": "string",
                  "physicalConnectionRequirements": { 
                     "availabilityZone": "string",
                     "securityGroupIdList": [ "string" ],
                     "subnetId": "string",
                     "subnetIdList": [ "string" ]
                  },
                  "pythonProperties": { 
                     "string" : "string" 
                  },
                  "sparkProperties": { 
                     "string" : "string" 
                  },
                  "status": "string",
                  "statusReason": "string"
               },
               "glueConnectionName": "string",
               "glueConnectionNames": [ "string" ],
               "host": "string",
               "port": number,
               "protocol": "string",
               "stage": "string"
            }
         ],
         "projectId": "string",
         "props": { ... },
         "scope": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListConnections_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListConnections_ResponseSyntax) **   <a name="datazone-ListConnections-response-items"></a>
The results of the ListConnections action.  
Type: Array of [ConnectionSummary](API_ConnectionSummary.md) objects

 ** [nextToken](#API_ListConnections_ResponseSyntax) **   <a name="datazone-ListConnections-response-nextToken"></a>
When the number of connections 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 connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListConnections_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListConnections_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListConnections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListConnections) 

# ListDataProductRevisions
<a name="API_ListDataProductRevisions"></a>

Lists data product revisions.

Prerequisites:
+ The data product ID must exist within the domain. 
+ User must have view permissions on the data product.
+ The domain must be in a valid and accessible state.

## Request Syntax
<a name="API_ListDataProductRevisions_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-products/identifier/revisions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataProductRevisions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListDataProductRevisions_RequestSyntax) **   <a name="datazone-ListDataProductRevisions-request-uri-domainIdentifier"></a>
The ID of the domain of the data product revisions that you want to list.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_ListDataProductRevisions_RequestSyntax) **   <a name="datazone-ListDataProductRevisions-request-uri-identifier"></a>
The ID of the data product revision.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListDataProductRevisions_RequestSyntax) **   <a name="datazone-ListDataProductRevisions-request-uri-maxResults"></a>
The maximum number of asset filters to return in a single call to `ListDataProductRevisions`. When the number of data product revisions to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDataProductRevisions` to list the next set of data product revisions.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListDataProductRevisions_RequestSyntax) **   <a name="datazone-ListDataProductRevisions-request-uri-nextToken"></a>
When the number of data product revisions is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of data product revisions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataProductRevisions` to list the next set of data product revisions.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_ListDataProductRevisions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataProductRevisions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "id": "string",
         "revision": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataProductRevisions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListDataProductRevisions_ResponseSyntax) **   <a name="datazone-ListDataProductRevisions-response-items"></a>
The results of the `ListDataProductRevisions` action.  
Type: Array of [DataProductRevision](API_DataProductRevision.md) objects

 ** [nextToken](#API_ListDataProductRevisions_ResponseSyntax) **   <a name="datazone-ListDataProductRevisions-response-nextToken"></a>
When the number of data product revisions is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of data product revisions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataProductRevisions` to list the next set of data product revisions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListDataProductRevisions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_ListDataProductRevisions_Examples"></a>

### Example
<a name="API_ListDataProductRevisions_Example_1"></a>

This example illustrates one usage of ListDataProductRevisions.

#### Sample Request
<a name="API_ListDataProductRevisions_Example_1_Request"></a>

```
aws datazone list-data-product-revisions \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd9m3nqx2wkfp"
```

#### Sample Response
<a name="API_ListDataProductRevisions_Example_1_Response"></a>

```
{
    "items": [
        {
            "createdAt": 1752602995.424,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "dpd9m3nqx2wkfp",
            "revision": "2"
        },
        {
            "createdAt": 1752602810.307,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "dpd9m3nqx2wkfp",
            "revision": "1"
        }
    ]
}
```

### Example
<a name="API_ListDataProductRevisions_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_ListDataProductRevisions_Example_2_Request"></a>

```
aws datazone list-data-product-revisions \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_ListDataProductRevisions_Example_2_Response"></a>

```
aws: error: the following arguments are required: —identifier
```

### Example
<a name="API_ListDataProductRevisions_Example_3"></a>

Failure case - resource not found:

#### Sample Request
<a name="API_ListDataProductRevisions_Example_3_Request"></a>

```
aws datazone list-data-product-revisions \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "dpd_nonexistent"
```

#### Sample Response
<a name="API_ListDataProductRevisions_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the ListDataProductRevisions operation: Requested dataProduct cannot be found in domain
```

## See Also
<a name="API_ListDataProductRevisions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListDataProductRevisions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListDataProductRevisions) 

# ListDataSourceRunActivities
<a name="API_ListDataSourceRunActivities"></a>

Lists data source run activities.

## Request Syntax
<a name="API_ListDataSourceRunActivities_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-source-runs/identifier/activities?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataSourceRunActivities_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListDataSourceRunActivities_RequestSyntax) **   <a name="datazone-ListDataSourceRunActivities-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which to list data source run activities.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_ListDataSourceRunActivities_RequestSyntax) **   <a name="datazone-ListDataSourceRunActivities-request-uri-identifier"></a>
The identifier of the data source run.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListDataSourceRunActivities_RequestSyntax) **   <a name="datazone-ListDataSourceRunActivities-request-uri-maxResults"></a>
The maximum number of activities to return in a single call to `ListDataSourceRunActivities`. When the number of activities to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDataSourceRunActivities` to list the next set of activities.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListDataSourceRunActivities_RequestSyntax) **   <a name="datazone-ListDataSourceRunActivities-request-uri-nextToken"></a>
When the number of activities is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of activities, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSourceRunActivities` to list the next set of activities.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [status](#API_ListDataSourceRunActivities_RequestSyntax) **   <a name="datazone-ListDataSourceRunActivities-request-uri-status"></a>
The status of the data source run.  
Valid Values: `FAILED | PUBLISHING_FAILED | SUCCEEDED_CREATED | SUCCEEDED_UPDATED | SKIPPED_ALREADY_IMPORTED | SKIPPED_ARCHIVED | SKIPPED_NO_ACCESS | UNCHANGED` 

## Request Body
<a name="API_ListDataSourceRunActivities_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataSourceRunActivities_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "dataAssetId": "string",
         "dataAssetStatus": "string",
         "database": "string",
         "dataSourceRunId": "string",
         "errorMessage": { 
            "errorDetail": "string",
            "errorType": "string"
         },
         "lineageSummary": { 
            "errorMessage": "string",
            "eventId": "string",
            "eventStatus": "string"
         },
         "projectId": "string",
         "technicalDescription": "string",
         "technicalName": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataSourceRunActivities_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListDataSourceRunActivities_ResponseSyntax) **   <a name="datazone-ListDataSourceRunActivities-response-items"></a>
The results of the `ListDataSourceRunActivities` action.  
Type: Array of [DataSourceRunActivity](API_DataSourceRunActivity.md) objects

 ** [nextToken](#API_ListDataSourceRunActivities_ResponseSyntax) **   <a name="datazone-ListDataSourceRunActivities-response-nextToken"></a>
When the number of activities is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of activities, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSourceRunActivities` to list the next set of activities.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListDataSourceRunActivities_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListDataSourceRunActivities_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListDataSourceRunActivities) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListDataSourceRunActivities) 

# ListDataSourceRuns
<a name="API_ListDataSourceRuns"></a>

Lists data source runs in Amazon DataZone.

## Request Syntax
<a name="API_ListDataSourceRuns_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-sources/dataSourceIdentifier/runs?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataSourceRuns_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceIdentifier](#API_ListDataSourceRuns_RequestSyntax) **   <a name="datazone-ListDataSourceRuns-request-uri-dataSourceIdentifier"></a>
The identifier of the data source.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_ListDataSourceRuns_RequestSyntax) **   <a name="datazone-ListDataSourceRuns-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which to invoke the `ListDataSourceRuns` action.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListDataSourceRuns_RequestSyntax) **   <a name="datazone-ListDataSourceRuns-request-uri-maxResults"></a>
The maximum number of runs to return in a single call to `ListDataSourceRuns`. When the number of runs to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDataSourceRuns` to list the next set of runs.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListDataSourceRuns_RequestSyntax) **   <a name="datazone-ListDataSourceRuns-request-uri-nextToken"></a>
When the number of runs is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of runs, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSourceRuns` to list the next set of runs.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [status](#API_ListDataSourceRuns_RequestSyntax) **   <a name="datazone-ListDataSourceRuns-request-uri-status"></a>
The status of the data source.  
Valid Values: `REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS` 

## Request Body
<a name="API_ListDataSourceRuns_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataSourceRuns_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "dataSourceId": "string",
         "errorMessage": { 
            "errorDetail": "string",
            "errorType": "string"
         },
         "id": "string",
         "lineageSummary": { 
            "importStatus": "string"
         },
         "projectId": "string",
         "runStatisticsForAssets": { 
            "added": number,
            "failed": number,
            "skipped": number,
            "unchanged": number,
            "updated": number
         },
         "startedAt": "string",
         "status": "string",
         "stoppedAt": "string",
         "type": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataSourceRuns_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListDataSourceRuns_ResponseSyntax) **   <a name="datazone-ListDataSourceRuns-response-items"></a>
The results of the `ListDataSourceRuns` action.  
Type: Array of [DataSourceRunSummary](API_DataSourceRunSummary.md) objects

 ** [nextToken](#API_ListDataSourceRuns_ResponseSyntax) **   <a name="datazone-ListDataSourceRuns-response-nextToken"></a>
When the number of runs is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of runs, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSourceRuns` to list the next set of runs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListDataSourceRuns_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListDataSourceRuns_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListDataSourceRuns) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListDataSourceRuns) 

# ListDataSources
<a name="API_ListDataSources"></a>

Lists data sources in Amazon DataZone.

## Request Syntax
<a name="API_ListDataSources_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/data-sources?connectionIdentifier=connectionIdentifier&environmentIdentifier=environmentIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier&status=status&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataSources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectionIdentifier](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-connectionIdentifier"></a>
The ID of the connection.

 ** [domainIdentifier](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which to list the data sources.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-environmentIdentifier"></a>
The identifier of the environment in which to list the data sources.

 ** [maxResults](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-maxResults"></a>
The maximum number of data sources to return in a single call to `ListDataSources`. When the number of data sources to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDataSources` to list the next set of data sources.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-name"></a>
The name of the data source.  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [nextToken](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-nextToken"></a>
When the number of data sources is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of data sources, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSources` to list the next set of data sources.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [projectIdentifier](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-projectIdentifier"></a>
The identifier of the project in which to list data sources.  
Required: Yes

 ** [status](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-status"></a>
The status of the data source.  
Valid Values: `CREATING | FAILED_CREATION | READY | UPDATING | FAILED_UPDATE | RUNNING | DELETING | FAILED_DELETION` 

 ** [type](#API_ListDataSources_RequestSyntax) **   <a name="datazone-ListDataSources-request-uri-type"></a>
The type of the data source.  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Request Body
<a name="API_ListDataSources_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataSources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "connectionId": "string",
         "createdAt": "string",
         "dataSourceId": "string",
         "description": "string",
         "domainId": "string",
         "enableSetting": "string",
         "environmentId": "string",
         "lastRunAssetCount": number,
         "lastRunAt": "string",
         "lastRunErrorMessage": { 
            "errorDetail": "string",
            "errorType": "string"
         },
         "lastRunStatus": "string",
         "name": "string",
         "schedule": { 
            "schedule": "string",
            "timezone": "string"
         },
         "status": "string",
         "type": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDataSources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListDataSources_ResponseSyntax) **   <a name="datazone-ListDataSources-response-items"></a>
The results of the `ListDataSources` action.  
Type: Array of [DataSourceSummary](API_DataSourceSummary.md) objects

 ** [nextToken](#API_ListDataSources_ResponseSyntax) **   <a name="datazone-ListDataSources-response-nextToken"></a>
When the number of data sources is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of data sources, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDataSources` to list the next set of data sources.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListDataSources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListDataSources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListDataSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListDataSources) 

# ListDomains
<a name="API_ListDomains"></a>

Lists Amazon DataZone domains.

## Request Syntax
<a name="API_ListDomains_RequestSyntax"></a>

```
GET /v2/domains?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDomains_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListDomains_RequestSyntax) **   <a name="datazone-ListDomains-request-uri-maxResults"></a>
The maximum number of domains to return in a single call to `ListDomains`. When the number of domains to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListDomains` to list the next set of domains.  
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [nextToken](#API_ListDomains_RequestSyntax) **   <a name="datazone-ListDomains-request-uri-nextToken"></a>
When the number of domains is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of domains, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDomains` to list the next set of domains.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [status](#API_ListDomains_RequestSyntax) **   <a name="datazone-ListDomains-request-uri-status"></a>
The status of the data source.  
Valid Values: `CREATING | AVAILABLE | CREATION_FAILED | DELETING | DELETED | DELETION_FAILED` 

## Request Body
<a name="API_ListDomains_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDomains_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "createdAt": number,
         "description": "string",
         "domainVersion": "string",
         "id": "string",
         "lastUpdatedAt": number,
         "managedAccountId": "string",
         "name": "string",
         "portalUrl": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDomains_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListDomains_ResponseSyntax) **   <a name="datazone-ListDomains-response-items"></a>
The results of the `ListDomains` action.  
Type: Array of [DomainSummary](API_DomainSummary.md) objects

 ** [nextToken](#API_ListDomains_ResponseSyntax) **   <a name="datazone-ListDomains-response-nextToken"></a>
When the number of domains is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of domains, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListDomains` to list the next set of domains.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListDomains_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListDomains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListDomains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListDomains) 

# ListDomainUnitsForParent
<a name="API_ListDomainUnitsForParent"></a>

Lists child domain units for the specified parent domain unit.

## Request Syntax
<a name="API_ListDomainUnitsForParent_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/domain-units?maxResults=maxResults&nextToken=nextToken&parentDomainUnitIdentifier=parentDomainUnitIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDomainUnitsForParent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListDomainUnitsForParent_RequestSyntax) **   <a name="datazone-ListDomainUnitsForParent-request-uri-domainIdentifier"></a>
The ID of the domain in which you want to list domain units for a parent domain unit.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListDomainUnitsForParent_RequestSyntax) **   <a name="datazone-ListDomainUnitsForParent-request-uri-maxResults"></a>
The maximum number of domain units to return in a single call to ListDomainUnitsForParent. When the number of domain units 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 ListDomainUnitsForParent to list the next set of domain units.  
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [nextToken](#API_ListDomainUnitsForParent_RequestSyntax) **   <a name="datazone-ListDomainUnitsForParent-request-uri-nextToken"></a>
When the number of domain units 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 domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [parentDomainUnitIdentifier](#API_ListDomainUnitsForParent_RequestSyntax) **   <a name="datazone-ListDomainUnitsForParent-request-uri-parentDomainUnitIdentifier"></a>
The ID of the parent domain unit.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: Yes

## Request Body
<a name="API_ListDomainUnitsForParent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDomainUnitsForParent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "id": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDomainUnitsForParent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListDomainUnitsForParent_ResponseSyntax) **   <a name="datazone-ListDomainUnitsForParent-response-items"></a>
The results returned by this action.  
Type: Array of [DomainUnitSummary](API_DomainUnitSummary.md) objects

 ** [nextToken](#API_ListDomainUnitsForParent_ResponseSyntax) **   <a name="datazone-ListDomainUnitsForParent-response-nextToken"></a>
When the number of domain units 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 domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListDomainUnitsForParent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListDomainUnitsForParent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListDomainUnitsForParent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListDomainUnitsForParent) 

# ListEntityOwners
<a name="API_ListEntityOwners"></a>

Lists the entity (domain units) owners.

## Request Syntax
<a name="API_ListEntityOwners_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/owners?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEntityOwners_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListEntityOwners_RequestSyntax) **   <a name="datazone-ListEntityOwners-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list entity owners.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_ListEntityOwners_RequestSyntax) **   <a name="datazone-ListEntityOwners-request-uri-entityIdentifier"></a>
The ID of the entity that you want to list.  
Required: Yes

 ** [entityType](#API_ListEntityOwners_RequestSyntax) **   <a name="datazone-ListEntityOwners-request-uri-entityType"></a>
The type of the entity that you want to list.  
Valid Values: `DOMAIN_UNIT`   
Required: Yes

 ** [maxResults](#API_ListEntityOwners_RequestSyntax) **   <a name="datazone-ListEntityOwners-request-uri-maxResults"></a>
The maximum number of entities to return in a single call to `ListEntityOwners`. When the number of entities to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEntityOwners` to list the next set of entities.  
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [nextToken](#API_ListEntityOwners_RequestSyntax) **   <a name="datazone-ListEntityOwners-request-uri-nextToken"></a>
When the number of entities is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of entities, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEntityOwners` to list the next set of entities.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_ListEntityOwners_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEntityOwners_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "owners": [ 
      { ... }
   ]
}
```

## Response Elements
<a name="API_ListEntityOwners_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListEntityOwners_ResponseSyntax) **   <a name="datazone-ListEntityOwners-response-nextToken"></a>
When the number of entities is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of entities, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEntityOwners` to list the next set of entities.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [owners](#API_ListEntityOwners_ResponseSyntax) **   <a name="datazone-ListEntityOwners-response-owners"></a>
The owners of the entity.  
Type: Array of [OwnerPropertiesOutput](API_OwnerPropertiesOutput.md) objects

## Errors
<a name="API_ListEntityOwners_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListEntityOwners_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListEntityOwners) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListEntityOwners) 

# ListEnvironmentActions
<a name="API_ListEnvironmentActions"></a>

Lists existing environment actions.

## Request Syntax
<a name="API_ListEnvironmentActions_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environments/environmentIdentifier/actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEnvironmentActions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListEnvironmentActions_RequestSyntax) **   <a name="datazone-ListEnvironmentActions-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which the environment actions are listed.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_ListEnvironmentActions_RequestSyntax) **   <a name="datazone-ListEnvironmentActions-request-uri-environmentIdentifier"></a>
The ID of the envrironment whose environment actions are listed.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListEnvironmentActions_RequestSyntax) **   <a name="datazone-ListEnvironmentActions-request-uri-maxResults"></a>
The maximum number of environment actions to return in a single call to `ListEnvironmentActions`. When the number of environment actions to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironmentActions` to list the next set of environment actions.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListEnvironmentActions_RequestSyntax) **   <a name="datazone-ListEnvironmentActions-request-uri-nextToken"></a>
When the number of environment actions is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environment actions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentActions` to list the next set of environment actions.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_ListEnvironmentActions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEnvironmentActions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "description": "string",
         "domainId": "string",
         "environmentId": "string",
         "id": "string",
         "name": "string",
         "parameters": { ... }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironmentActions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListEnvironmentActions_ResponseSyntax) **   <a name="datazone-ListEnvironmentActions-response-items"></a>
The results of `ListEnvironmentActions`.  
Type: Array of [EnvironmentActionSummary](API_EnvironmentActionSummary.md) objects

 ** [nextToken](#API_ListEnvironmentActions_ResponseSyntax) **   <a name="datazone-ListEnvironmentActions-response-nextToken"></a>
When the number of environment actions is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environment actions, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentActions` to list the next set of environment actions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListEnvironmentActions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListEnvironmentActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListEnvironmentActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListEnvironmentActions) 

# ListEnvironmentBlueprintConfigurations
<a name="API_ListEnvironmentBlueprintConfigurations"></a>

Lists blueprint configurations for a Amazon DataZone environment.

## Request Syntax
<a name="API_ListEnvironmentBlueprintConfigurations_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environment-blueprint-configurations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEnvironmentBlueprintConfigurations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListEnvironmentBlueprintConfigurations_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprintConfigurations-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListEnvironmentBlueprintConfigurations_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprintConfigurations-request-uri-maxResults"></a>
The maximum number of blueprint configurations to return in a single call to `ListEnvironmentBlueprintConfigurations`. When the number of configurations to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironmentBlueprintConfigurations` to list the next set of configurations.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListEnvironmentBlueprintConfigurations_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprintConfigurations-request-uri-nextToken"></a>
When the number of blueprint configurations is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of configurations, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentBlueprintConfigurations` to list the next set of configurations.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_ListEnvironmentBlueprintConfigurations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEnvironmentBlueprintConfigurations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "domainId": "string",
         "enabledRegions": [ "string" ],
         "environmentBlueprintId": "string",
         "environmentRolePermissionBoundary": "string",
         "manageAccessRoleArn": "string",
         "provisioningConfigurations": [ 
            { ... }
         ],
         "provisioningRoleArn": "string",
         "regionalParameters": { 
            "string" : { 
               "string" : "string" 
            }
         },
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironmentBlueprintConfigurations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListEnvironmentBlueprintConfigurations_ResponseSyntax) **   <a name="datazone-ListEnvironmentBlueprintConfigurations-response-items"></a>
The results of the `ListEnvironmentBlueprintConfigurations` action.  
Type: Array of [EnvironmentBlueprintConfigurationItem](API_EnvironmentBlueprintConfigurationItem.md) objects

 ** [nextToken](#API_ListEnvironmentBlueprintConfigurations_ResponseSyntax) **   <a name="datazone-ListEnvironmentBlueprintConfigurations-response-nextToken"></a>
When the number of blueprint configurations is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of configurations, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentBlueprintConfigurations` to list the next set of configurations.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListEnvironmentBlueprintConfigurations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListEnvironmentBlueprintConfigurations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListEnvironmentBlueprintConfigurations) 

# ListEnvironmentBlueprints
<a name="API_ListEnvironmentBlueprints"></a>

Lists blueprints in an Amazon DataZone environment.

## Request Syntax
<a name="API_ListEnvironmentBlueprints_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environment-blueprints?managed=managed&maxResults=maxResults&name=name&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEnvironmentBlueprints_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListEnvironmentBlueprints_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprints-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [managed](#API_ListEnvironmentBlueprints_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprints-request-uri-managed"></a>
Specifies whether the environment blueprint is managed by Amazon DataZone.

 ** [maxResults](#API_ListEnvironmentBlueprints_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprints-request-uri-maxResults"></a>
The maximum number of blueprints to return in a single call to `ListEnvironmentBlueprints`. When the number of blueprints to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironmentBlueprints` to list the next set of blueprints.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListEnvironmentBlueprints_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprints-request-uri-name"></a>
The name of the Amazon DataZone environment.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [nextToken](#API_ListEnvironmentBlueprints_RequestSyntax) **   <a name="datazone-ListEnvironmentBlueprints-request-uri-nextToken"></a>
When the number of blueprints in the environment is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of blueprints in the environment, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentBlueprints`to list the next set of blueprints.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_ListEnvironmentBlueprints_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEnvironmentBlueprints_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "description": "string",
         "id": "string",
         "name": "string",
         "provider": "string",
         "provisioningProperties": { ... },
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironmentBlueprints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListEnvironmentBlueprints_ResponseSyntax) **   <a name="datazone-ListEnvironmentBlueprints-response-items"></a>
The results of the `ListEnvironmentBlueprints` action.  
Type: Array of [EnvironmentBlueprintSummary](API_EnvironmentBlueprintSummary.md) objects

 ** [nextToken](#API_ListEnvironmentBlueprints_ResponseSyntax) **   <a name="datazone-ListEnvironmentBlueprints-response-nextToken"></a>
When the number of blueprints in the environment is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of blueprints in the environment, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentBlueprints`to list the next set of blueprints.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListEnvironmentBlueprints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListEnvironmentBlueprints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListEnvironmentBlueprints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListEnvironmentBlueprints) 

# ListEnvironmentProfiles
<a name="API_ListEnvironmentProfiles"></a>

Lists Amazon DataZone environment profiles.

## Request Syntax
<a name="API_ListEnvironmentProfiles_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environment-profiles?awsAccountId=awsAccountId&awsAccountRegion=awsAccountRegion&environmentBlueprintIdentifier=environmentBlueprintIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEnvironmentProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [awsAccountId](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-awsAccountId"></a>
The identifier of the AWS account where you want to list environment profiles.  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-awsAccountRegion"></a>
The AWS region where you want to list environment profiles.  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [domainIdentifier](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentBlueprintIdentifier](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-environmentBlueprintIdentifier"></a>
The identifier of the blueprint that was used to create the environment profiles that you want to list.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [maxResults](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-maxResults"></a>
The maximum number of environment profiles to return in a single call to `ListEnvironmentProfiles`. When the number of environment profiles to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironmentProfiles` to list the next set of environment profiles.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-name"></a>
  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [nextToken](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-nextToken"></a>
When the number of environment profiles is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environment profiles, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentProfiles` to list the next set of environment profiles.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [projectIdentifier](#API_ListEnvironmentProfiles_RequestSyntax) **   <a name="datazone-ListEnvironmentProfiles-request-uri-projectIdentifier"></a>
The identifier of the Amazon DataZone project.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

## Request Body
<a name="API_ListEnvironmentProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEnvironmentProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "awsAccountId": "string",
         "awsAccountRegion": "string",
         "createdAt": "string",
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string",
         "projectId": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironmentProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListEnvironmentProfiles_ResponseSyntax) **   <a name="datazone-ListEnvironmentProfiles-response-items"></a>
The results of the `ListEnvironmentProfiles` action.   
Type: Array of [EnvironmentProfileSummary](API_EnvironmentProfileSummary.md) objects

 ** [nextToken](#API_ListEnvironmentProfiles_ResponseSyntax) **   <a name="datazone-ListEnvironmentProfiles-response-nextToken"></a>
When the number of environment profiles is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environment profiles, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironmentProfiles` to list the next set of environment profiles.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListEnvironmentProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListEnvironmentProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListEnvironmentProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListEnvironmentProfiles) 

# ListEnvironments
<a name="API_ListEnvironments"></a>

Lists Amazon DataZone environments.

## Request Syntax
<a name="API_ListEnvironments_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environments?awsAccountId=awsAccountId&awsAccountRegion=awsAccountRegion&environmentBlueprintIdentifier=environmentBlueprintIdentifier&environmentProfileIdentifier=environmentProfileIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier&provider=provider&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEnvironments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [awsAccountId](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-awsAccountId"></a>
The identifier of the AWS account where you want to list environments.  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-awsAccountRegion"></a>
The AWS region where you want to list environments.  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [domainIdentifier](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentBlueprintIdentifier](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-environmentBlueprintIdentifier"></a>
The identifier of the Amazon DataZone blueprint.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentProfileIdentifier](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-environmentProfileIdentifier"></a>
The identifier of the environment profile.  
Pattern: `[a-zA-Z0-9_-]{0,36}` 

 ** [maxResults](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-maxResults"></a>
The maximum number of environments to return in a single call to `ListEnvironments`. When the number of environments to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListEnvironments` to list the next set of environments.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-name"></a>
The name of the environment.

 ** [nextToken](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-nextToken"></a>
When the number of environments is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environments, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironments` to list the next set of environments.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [projectIdentifier](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-projectIdentifier"></a>
The identifier of the Amazon DataZone project.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [provider](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-provider"></a>
The provider of the environment.

 ** [status](#API_ListEnvironments_RequestSyntax) **   <a name="datazone-ListEnvironments-request-uri-status"></a>
The status of the environments that you want to list.  
Valid Values: `ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | VALIDATION_FAILED | SUSPENDED | DISABLED | EXPIRED | DELETED | INACCESSIBLE` 

## Request Body
<a name="API_ListEnvironments_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEnvironments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "awsAccountId": "string",
         "awsAccountRegion": "string",
         "createdAt": "string",
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "environmentConfigurationId": "string",
         "environmentConfigurationName": "string",
         "environmentProfileId": "string",
         "id": "string",
         "name": "string",
         "projectId": "string",
         "provider": "string",
         "status": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListEnvironments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListEnvironments_ResponseSyntax) **   <a name="datazone-ListEnvironments-response-items"></a>
The results of the `ListEnvironments` action.  
Type: Array of [EnvironmentSummary](API_EnvironmentSummary.md) objects

 ** [nextToken](#API_ListEnvironments_ResponseSyntax) **   <a name="datazone-ListEnvironments-response-nextToken"></a>
When the number of environments is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environments, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListEnvironments` to list the next set of environments.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListEnvironments_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListEnvironments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListEnvironments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListEnvironments) 

# ListJobRuns
<a name="API_ListJobRuns"></a>

Lists job runs.

## Request Syntax
<a name="API_ListJobRuns_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/jobs/jobIdentifier/runs?maxResults=maxResults&nextToken=nextToken&sortOrder=sortOrder&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListJobRuns_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListJobRuns_RequestSyntax) **   <a name="datazone-ListJobRuns-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list job runs.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [jobIdentifier](#API_ListJobRuns_RequestSyntax) **   <a name="datazone-ListJobRuns-request-uri-jobIdentifier"></a>
The ID of the job run.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListJobRuns_RequestSyntax) **   <a name="datazone-ListJobRuns-request-uri-maxResults"></a>
The maximum number of job runs to return in a single call to ListJobRuns. When the number of job runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListJobRuns to list the next set of job runs.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListJobRuns_RequestSyntax) **   <a name="datazone-ListJobRuns-request-uri-nextToken"></a>
When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [sortOrder](#API_ListJobRuns_RequestSyntax) **   <a name="datazone-ListJobRuns-request-uri-sortOrder"></a>
Specifies the order in which job runs are to be sorted.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [status](#API_ListJobRuns_RequestSyntax) **   <a name="datazone-ListJobRuns-request-uri-status"></a>
The status of a job run.  
Valid Values: `SCHEDULED | IN_PROGRESS | SUCCESS | PARTIALLY_SUCCEEDED | FAILED | ABORTED | TIMED_OUT | CANCELED` 

## Request Body
<a name="API_ListJobRuns_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListJobRuns_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "endTime": number,
         "error": { 
            "message": "string"
         },
         "jobId": "string",
         "jobType": "string",
         "runId": "string",
         "runMode": "string",
         "startTime": number,
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListJobRuns_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListJobRuns_ResponseSyntax) **   <a name="datazone-ListJobRuns-response-items"></a>
The results of the ListJobRuns action.  
Type: Array of [JobRunSummary](API_JobRunSummary.md) objects

 ** [nextToken](#API_ListJobRuns_ResponseSyntax) **   <a name="datazone-ListJobRuns-response-nextToken"></a>
When the number of job runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of job runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListJobRuns to list the next set of job runs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListJobRuns_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListJobRuns_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListJobRuns) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListJobRuns) 

# ListLineageEvents
<a name="API_ListLineageEvents"></a>

Lists lineage events.

## Request Syntax
<a name="API_ListLineageEvents_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/lineage/events?maxResults=maxResults&nextToken=nextToken&processingStatus=processingStatus&sortOrder=sortOrder&timestampAfter=timestampAfter&timestampBefore=timestampBefore HTTP/1.1
```

## URI Request Parameters
<a name="API_ListLineageEvents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListLineageEvents_RequestSyntax) **   <a name="datazone-ListLineageEvents-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list lineage events.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListLineageEvents_RequestSyntax) **   <a name="datazone-ListLineageEvents-request-uri-maxResults"></a>
The maximum number of lineage events to return in a single call to ListLineageEvents. When the number of lineage events 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 ListLineageEvents to list the next set of lineage events.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListLineageEvents_RequestSyntax) **   <a name="datazone-ListLineageEvents-request-uri-nextToken"></a>
When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [processingStatus](#API_ListLineageEvents_RequestSyntax) **   <a name="datazone-ListLineageEvents-request-uri-processingStatus"></a>
The processing status of a lineage event.  
Valid Values: `REQUESTED | PROCESSING | SUCCESS | FAILED` 

 ** [sortOrder](#API_ListLineageEvents_RequestSyntax) **   <a name="datazone-ListLineageEvents-request-uri-sortOrder"></a>
The sort order of the lineage events.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [timestampAfter](#API_ListLineageEvents_RequestSyntax) **   <a name="datazone-ListLineageEvents-request-uri-timestampAfter"></a>
The after timestamp of a lineage event.

 ** [timestampBefore](#API_ListLineageEvents_RequestSyntax) **   <a name="datazone-ListLineageEvents-request-uri-timestampBefore"></a>
The before timestamp of a lineage event.

## Request Body
<a name="API_ListLineageEvents_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListLineageEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "eventSummary": { ... },
         "eventTime": number,
         "id": "string",
         "processingStatus": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListLineageEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListLineageEvents_ResponseSyntax) **   <a name="datazone-ListLineageEvents-response-items"></a>
The results of the ListLineageEvents action.  
Type: Array of [LineageEventSummary](API_LineageEventSummary.md) objects

 ** [nextToken](#API_ListLineageEvents_ResponseSyntax) **   <a name="datazone-ListLineageEvents-response-nextToken"></a>
When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListLineageEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListLineageEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListLineageEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListLineageEvents) 

# ListLineageNodeHistory
<a name="API_ListLineageNodeHistory"></a>

Lists the history of the specified data lineage node.

## Request Syntax
<a name="API_ListLineageNodeHistory_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/lineage/nodes/identifier/history?direction=direction&maxResults=maxResults&nextToken=nextToken&sortOrder=sortOrder&timestampGTE=eventTimestampGTE&timestampLTE=eventTimestampLTE HTTP/1.1
```

## URI Request Parameters
<a name="API_ListLineageNodeHistory_RequestParameters"></a>

The request uses the following URI parameters.

 ** [direction](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-direction"></a>
The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is `UPSTREAM`, the `ListLineageNodeHistory` API responds with historical versions with upstream neighbors only.  
Valid Values: `UPSTREAM | DOWNSTREAM` 

 ** [domainIdentifier](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list the history of the specified data lineage node.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [eventTimestampGTE](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-eventTimestampGTE"></a>
Specifies whether the action is to return data lineage node history from the time after the event timestamp.

 ** [eventTimestampLTE](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-eventTimestampLTE"></a>
Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

 ** [identifier](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-identifier"></a>
The ID of the data lineage node whose history you want to list.  
Length Constraints: Minimum length of 1. Maximum length of 2086.  
Required: Yes

 ** [maxResults](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-maxResults"></a>
The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-nextToken"></a>
When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [sortOrder](#API_ListLineageNodeHistory_RequestSyntax) **   <a name="datazone-ListLineageNodeHistory-request-uri-sortOrder"></a>
The order by which you want data lineage node history to be sorted.  
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_ListLineageNodeHistory_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListLineageNodeHistory_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "nodes": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "eventTimestamp": number,
         "id": "string",
         "name": "string",
         "sourceIdentifier": "string",
         "typeName": "string",
         "typeRevision": "string",
         "updatedAt": number,
         "updatedBy": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListLineageNodeHistory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListLineageNodeHistory_ResponseSyntax) **   <a name="datazone-ListLineageNodeHistory-response-nextToken"></a>
When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [nodes](#API_ListLineageNodeHistory_ResponseSyntax) **   <a name="datazone-ListLineageNodeHistory-response-nodes"></a>
The nodes returned by the ListLineageNodeHistory action.  
Type: Array of [LineageNodeSummary](API_LineageNodeSummary.md) objects

## Errors
<a name="API_ListLineageNodeHistory_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListLineageNodeHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListLineageNodeHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListLineageNodeHistory) 

# ListMetadataGenerationRuns
<a name="API_ListMetadataGenerationRuns"></a>

Lists all metadata generation runs.

Metadata generation runs represent automated processes that leverage AI/ML capabilities to create or enhance asset metadata at scale. This feature helps organizations maintain comprehensive and consistent metadata across large numbers of assets without manual intervention. It can automatically generate business descriptions, tags, and other metadata elements, significantly reducing the time and effort required for metadata management while improving consistency and completeness.

Prerequisites:
+ Valid domain identifier. 
+ User must have access to metadata generation runs in the domain.

## Request Syntax
<a name="API_ListMetadataGenerationRuns_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/metadata-generation-runs?maxResults=maxResults&nextToken=nextToken&status=status&targetIdentifier=targetIdentifier&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListMetadataGenerationRuns_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListMetadataGenerationRuns_RequestSyntax) **   <a name="datazone-ListMetadataGenerationRuns-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where you want to list metadata generation runs.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListMetadataGenerationRuns_RequestSyntax) **   <a name="datazone-ListMetadataGenerationRuns-request-uri-maxResults"></a>
The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListMetadataGenerationRuns_RequestSyntax) **   <a name="datazone-ListMetadataGenerationRuns-request-uri-nextToken"></a>
When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [status](#API_ListMetadataGenerationRuns_RequestSyntax) **   <a name="datazone-ListMetadataGenerationRuns-request-uri-status"></a>
The status of the metadata generation runs.  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELED | SUCCEEDED | FAILED | PARTIALLY_SUCCEEDED` 

 ** [targetIdentifier](#API_ListMetadataGenerationRuns_RequestSyntax) **   <a name="datazone-ListMetadataGenerationRuns-request-uri-targetIdentifier"></a>
The target ID for which you want to list metadata generation runs.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [type](#API_ListMetadataGenerationRuns_RequestSyntax) **   <a name="datazone-ListMetadataGenerationRuns-request-uri-type"></a>
The type of the metadata generation runs.  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS` 

## Request Body
<a name="API_ListMetadataGenerationRuns_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListMetadataGenerationRuns_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "id": "string",
         "owningProjectId": "string",
         "status": "string",
         "target": { 
            "identifier": "string",
            "revision": "string",
            "type": "string"
         },
         "type": "string",
         "types": [ "string" ]
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListMetadataGenerationRuns_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListMetadataGenerationRuns_ResponseSyntax) **   <a name="datazone-ListMetadataGenerationRuns-response-items"></a>
The results of the ListMetadataGenerationRuns action.  
Type: Array of [MetadataGenerationRunItem](API_MetadataGenerationRunItem.md) objects

 ** [nextToken](#API_ListMetadataGenerationRuns_ResponseSyntax) **   <a name="datazone-ListMetadataGenerationRuns-response-nextToken"></a>
When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListMetadataGenerationRuns_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_ListMetadataGenerationRuns_Examples"></a>

### Example
<a name="API_ListMetadataGenerationRuns_Example_1"></a>

This example illustrates one usage of ListMetadataGenerationRuns.

#### Sample Request
<a name="API_ListMetadataGenerationRuns_Example_1_Request"></a>

```
aws datazone list-metadata-generation-runs --domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_ListMetadataGenerationRuns_Example_1_Response"></a>

```
{
    "items": [{
            "createdAt": 1752642939.631,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "mgr3tlpxo4mg5q",
            "owningProjectId": "prj7nx82mkl",
            "status": "SUCCEEDED",
            "target": {
                "identifier": "ast7k9mpq2xvn4",
                "revision": "1",
                "type": "ASSET"
            },
            "types": ["BUSINESS_DESCRIPTIONS"]
        },
        {
            "createdAt": 1752643907.566,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "mgr487vbdcqwn8",
            "owningProjectId": "prj7nx82mkl",
            "status": "SUCCEEDED",
            "target": {
                "identifier": "ast7k9mpq2xvn4",
                "revision": "4",
                "type": "ASSET"
            },
            "types": ["BUSINESS_DESCRIPTIONS"]
        },
        {
            "createdAt": 1752644436.666,
            "createdBy": "usr7nx82mkl",
            "domainId": "dzd_53ielnpxktdilj",
            "id": "mgr5g0fy285m1q",
            "owningProjectId": "prj7nx82mkl",
            "status": "CANCELED",
            "target": {
                "identifier": "ast6br2md6v9h",
                "revision": "1",
                "type": "ASSET"
            },
            "types": ["BUSINESS_DESCRIPTIONS"]
        }
    ]
}
```

### Example
<a name="API_ListMetadataGenerationRuns_Example_2"></a>

Failuse case - missing parameter:

#### Sample Request
<a name="API_ListMetadataGenerationRuns_Example_2_Request"></a>

```
aws datazone list-metadata-generation-runs
```

#### Sample Response
<a name="API_ListMetadataGenerationRuns_Example_2_Response"></a>

```
aws: error: the following arguments are required: —domain-identifier
```

### Example
<a name="API_ListMetadataGenerationRuns_Example_3"></a>

Failure case - invalid input:

#### Sample Request
<a name="API_ListMetadataGenerationRuns_Example_3_Request"></a>

```
aws datazone list-metadata-generation-runs --domain-identifier "invalid_domain"
```

#### Sample Response
<a name="API_ListMetadataGenerationRuns_Example_3_Response"></a>

```
An error occurred (ValidationException) when calling the ListMetadataGenerationRuns operation: 1 validation error detected: Value at 'domainIdentifier' failed to satisfy constraint: Member must satisfy regular expression pattern: dzd[-_][a-zA-Z0-9_-]{1,36}
```

### Example
<a name="API_ListMetadataGenerationRuns_Example_4"></a>

ListMetadataGenerationRuns with multiple filters:

#### Sample Request
<a name="API_ListMetadataGenerationRuns_Example_4_Request"></a>

```
aws datazone get-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--type "BUSINESS_NAMES"
--status "SUCCEEDED"
--target-identifier "cy61vbvez4nuw7"
```

#### Sample Response
<a name="API_ListMetadataGenerationRuns_Example_4_Response"></a>

```
{
  "items": [
    {
      "createdAt": 1.762021397763E9,
      "createdBy": "",
      "domainId": "dzd_53ielnpxktdilj",
      "id": "bcbuj2s3uooylj",
      "owningProjectId": "4dc7fa5wzsdup3",
      "status": "SUCCEEDED",
      "target": {
        "identifier": "cy61vbvez4nuw7",
        "revision": "12",
        "type": "ASSET"
      },
      "type": "BUSINESS_NAMES",
      "types": [
        "BUSINESS_NAMES"
      ]
    }
  ]
}
```

## See Also
<a name="API_ListMetadataGenerationRuns_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListMetadataGenerationRuns) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListMetadataGenerationRuns) 

# ListNotifications
<a name="API_ListNotifications"></a>

Lists all Amazon DataZone notifications.

## Request Syntax
<a name="API_ListNotifications_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/notifications?afterTimestamp=afterTimestamp&beforeTimestamp=beforeTimestamp&maxResults=maxResults&nextToken=nextToken&subjects=subjects&taskStatus=taskStatus&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListNotifications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [afterTimestamp](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-afterTimestamp"></a>
The time after which you want to list notifications.

 ** [beforeTimestamp](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-beforeTimestamp"></a>
The time before which you want to list notifications.

 ** [domainIdentifier](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-maxResults"></a>
The maximum number of notifications to return in a single call to `ListNotifications`. When the number of notifications to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListNotifications` to list the next set of notifications.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-nextToken"></a>
When the number of notifications is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of notifications, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListNotifications` to list the next set of notifications.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [subjects](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-subjects"></a>
The subjects of notifications.

 ** [taskStatus](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-taskStatus"></a>
The task status of notifications.  
Valid Values: `ACTIVE | INACTIVE` 

 ** [type](#API_ListNotifications_RequestSyntax) **   <a name="datazone-ListNotifications-request-uri-type"></a>
The type of notifications.  
Valid Values: `TASK | EVENT`   
Required: Yes

## Request Body
<a name="API_ListNotifications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "notifications": [ 
      { 
         "actionLink": "string",
         "creationTimestamp": number,
         "domainIdentifier": "string",
         "identifier": "string",
         "lastUpdatedTimestamp": number,
         "message": "string",
         "metadata": { 
            "string" : "string" 
         },
         "status": "string",
         "title": "string",
         "topic": { 
            "resource": { 
               "id": "string",
               "name": "string",
               "type": "string"
            },
            "role": "string",
            "subject": "string"
         },
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListNotifications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListNotifications_ResponseSyntax) **   <a name="datazone-ListNotifications-response-nextToken"></a>
When the number of notifications is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of notifications, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListNotifications` to list the next set of notifications.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [notifications](#API_ListNotifications_ResponseSyntax) **   <a name="datazone-ListNotifications-response-notifications"></a>
The results of the `ListNotifications` action.  
Type: Array of [NotificationOutput](API_NotificationOutput.md) objects

## Errors
<a name="API_ListNotifications_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListNotifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListNotifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListNotifications) 

# ListPolicyGrants
<a name="API_ListPolicyGrants"></a>

Lists policy grants.

## Request Syntax
<a name="API_ListPolicyGrants_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/policies/managed/entityType/entityIdentifier/grants?maxResults=maxResults&nextToken=nextToken&policyType=policyType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPolicyGrants_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListPolicyGrants_RequestSyntax) **   <a name="datazone-ListPolicyGrants-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list policy grants.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_ListPolicyGrants_RequestSyntax) **   <a name="datazone-ListPolicyGrants-request-uri-entityIdentifier"></a>
The ID of the entity for which you want to list policy grants.  
Required: Yes

 ** [entityType](#API_ListPolicyGrants_RequestSyntax) **   <a name="datazone-ListPolicyGrants-request-uri-entityType"></a>
The type of entity for which you want to list policy grants.  
Valid Values: `DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE | ASSET_TYPE`   
Required: Yes

 ** [maxResults](#API_ListPolicyGrants_RequestSyntax) **   <a name="datazone-ListPolicyGrants-request-uri-maxResults"></a>
The maximum number of grants to return in a single call to `ListPolicyGrants`. When the number of grants to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListPolicyGrants` to list the next set of grants.  
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [nextToken](#API_ListPolicyGrants_RequestSyntax) **   <a name="datazone-ListPolicyGrants-request-uri-nextToken"></a>
When the number of grants is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of grants, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListPolicyGrants` to list the next set of grants.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [policyType](#API_ListPolicyGrants_RequestSyntax) **   <a name="datazone-ListPolicyGrants-request-uri-policyType"></a>
The type of policy that you want to list.  
Valid Values: `CREATE_DOMAIN_UNIT | OVERRIDE_DOMAIN_UNIT_OWNERS | ADD_TO_PROJECT_MEMBER_POOL | OVERRIDE_PROJECT_OWNERS | CREATE_GLOSSARY | CREATE_FORM_TYPE | CREATE_ASSET_TYPE | CREATE_PROJECT | CREATE_ENVIRONMENT_PROFILE | DELEGATE_CREATE_ENVIRONMENT_PROFILE | CREATE_ENVIRONMENT | CREATE_ENVIRONMENT_FROM_BLUEPRINT | CREATE_PROJECT_FROM_PROJECT_PROFILE | USE_ASSET_TYPE`   
Required: Yes

## Request Body
<a name="API_ListPolicyGrants_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPolicyGrants_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "grantList": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "detail": { ... },
         "grantId": "string",
         "principal": { ... }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListPolicyGrants_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [grantList](#API_ListPolicyGrants_ResponseSyntax) **   <a name="datazone-ListPolicyGrants-response-grantList"></a>
The results of this action - the listed grants.  
Type: Array of [PolicyGrantMember](API_PolicyGrantMember.md) objects

 ** [nextToken](#API_ListPolicyGrants_ResponseSyntax) **   <a name="datazone-ListPolicyGrants-response-nextToken"></a>
When the number of grants is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of grants, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListPolicyGrants` to list the next set of grants.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListPolicyGrants_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListPolicyGrants_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListPolicyGrants) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListPolicyGrants) 

# ListProjectMemberships
<a name="API_ListProjectMemberships"></a>

Lists all members of the specified project.

## Request Syntax
<a name="API_ListProjectMemberships_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/projects/projectIdentifier/memberships?maxResults=maxResults&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1
```

## URI Request Parameters
<a name="API_ListProjectMemberships_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListProjectMemberships_RequestSyntax) **   <a name="datazone-ListProjectMemberships-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which you want to list project memberships.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListProjectMemberships_RequestSyntax) **   <a name="datazone-ListProjectMemberships-request-uri-maxResults"></a>
The maximum number of memberships to return in a single call to `ListProjectMemberships`. When the number of memberships to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListProjectMemberships` to list the next set of memberships.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListProjectMemberships_RequestSyntax) **   <a name="datazone-ListProjectMemberships-request-uri-nextToken"></a>
When the number of memberships is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of memberships, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListProjectMemberships` to list the next set of memberships.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [projectIdentifier](#API_ListProjectMemberships_RequestSyntax) **   <a name="datazone-ListProjectMemberships-request-uri-projectIdentifier"></a>
The identifier of the project whose memberships you want to list.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [sortBy](#API_ListProjectMemberships_RequestSyntax) **   <a name="datazone-ListProjectMemberships-request-uri-sortBy"></a>
The method by which you want to sort the project memberships.  
Valid Values: `NAME` 

 ** [sortOrder](#API_ListProjectMemberships_RequestSyntax) **   <a name="datazone-ListProjectMemberships-request-uri-sortOrder"></a>
The sort order of the project memberships.  
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_ListProjectMemberships_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProjectMemberships_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "members": [ 
      { 
         "designation": "string",
         "memberDetails": { ... }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListProjectMemberships_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [members](#API_ListProjectMemberships_ResponseSyntax) **   <a name="datazone-ListProjectMemberships-response-members"></a>
The members of the project.  
Type: Array of [ProjectMember](API_ProjectMember.md) objects

 ** [nextToken](#API_ListProjectMemberships_ResponseSyntax) **   <a name="datazone-ListProjectMemberships-response-nextToken"></a>
When the number of memberships is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of memberships, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListProjectMemberships` to list the next set of memberships.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListProjectMemberships_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListProjectMemberships_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListProjectMemberships) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListProjectMemberships) 

# ListProjectProfiles
<a name="API_ListProjectProfiles"></a>

Lists project profiles.

## Request Syntax
<a name="API_ListProjectProfiles_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/project-profiles?maxResults=maxResults&name=name&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1
```

## URI Request Parameters
<a name="API_ListProjectProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListProjectProfiles_RequestSyntax) **   <a name="datazone-ListProjectProfiles-request-uri-domainIdentifier"></a>
The ID of the domain where you want to list project profiles.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListProjectProfiles_RequestSyntax) **   <a name="datazone-ListProjectProfiles-request-uri-maxResults"></a>
The maximum number of project profiles to return in a single call to ListProjectProfiles. When the number of project profiles to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectProfiles to list the next set of project profiles.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListProjectProfiles_RequestSyntax) **   <a name="datazone-ListProjectProfiles-request-uri-name"></a>
The name of a project profile.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [nextToken](#API_ListProjectProfiles_RequestSyntax) **   <a name="datazone-ListProjectProfiles-request-uri-nextToken"></a>
When the number of project profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [sortBy](#API_ListProjectProfiles_RequestSyntax) **   <a name="datazone-ListProjectProfiles-request-uri-sortBy"></a>
Specifies by what to sort project profiles.  
Valid Values: `NAME` 

 ** [sortOrder](#API_ListProjectProfiles_RequestSyntax) **   <a name="datazone-ListProjectProfiles-request-uri-sortOrder"></a>
Specifies the sort order of the project profiles.  
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_ListProjectProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProjectProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "domainUnitId": "string",
         "id": "string",
         "lastUpdatedAt": "string",
         "name": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListProjectProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListProjectProfiles_ResponseSyntax) **   <a name="datazone-ListProjectProfiles-response-items"></a>
The results of the ListProjectProfiles action.  
Type: Array of [ProjectProfileSummary](API_ProjectProfileSummary.md) objects

 ** [nextToken](#API_ListProjectProfiles_ResponseSyntax) **   <a name="datazone-ListProjectProfiles-response-nextToken"></a>
When the number of project profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListProjectProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListProjectProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListProjectProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListProjectProfiles) 

# ListProjects
<a name="API_ListProjects"></a>

Lists Amazon DataZone projects.

## Request Syntax
<a name="API_ListProjects_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/projects?groupIdentifier=groupIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectCategory=projectCategory&userIdentifier=userIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_ListProjects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [groupIdentifier](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-groupIdentifier"></a>
The identifier of a group.

 ** [maxResults](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-maxResults"></a>
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.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [name](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-name"></a>
The name of the project.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [nextToken](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [projectCategory](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-projectCategory"></a>
A parameter to filter projects by their category.

 ** [userIdentifier](#API_ListProjects_RequestSyntax) **   <a name="datazone-ListProjects-request-uri-userIdentifier"></a>
The identifier of the Amazon DataZone user.

## Request Body
<a name="API_ListProjects_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProjects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": "string",
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "domainUnitId": "string",
         "failureReasons": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "id": "string",
         "name": "string",
         "projectCategory": "string",
         "projectStatus": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListProjects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListProjects_ResponseSyntax) **   <a name="datazone-ListProjects-response-items"></a>
The results of the `ListProjects` action.  
Type: Array of [ProjectSummary](API_ProjectSummary.md) objects

 ** [nextToken](#API_ListProjects_ResponseSyntax) **   <a name="datazone-ListProjects-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListProjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListProjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListProjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListProjects) 

# ListRules
<a name="API_ListRules"></a>

Lists existing rules. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

## Request Syntax
<a name="API_ListRules_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/list-rules/targetType/targetIdentifier?assetTypes=assetTypes&dataProduct=dataProduct&includeCascaded=includeCascaded&maxResults=maxResults&nextToken=nextToken&projectIds=projectIds&ruleAction=action&ruleType=ruleType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [action](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-action"></a>
The action of the rule.  
Valid Values: `CREATE_LISTING_CHANGE_SET | CREATE_SUBSCRIPTION_REQUEST` 

 ** [assetTypes](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-assetTypes"></a>
The asset types of the rule.  
Length Constraints: Minimum length of 1. Maximum length of 513.  
Pattern: `(?!\.)[\w\.]*\w` 

 ** [dataProduct](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-dataProduct"></a>
The data product of the rule.

 ** [domainIdentifier](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-domainIdentifier"></a>
The ID of the domain in which the rules are to be listed.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [includeCascaded](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-includeCascaded"></a>
Specifies whether to include cascading rules in the results.

 ** [maxResults](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-maxResults"></a>
The maximum number of rules to return in a single call to `ListRules`. When the number of rules to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListRules` to list the next set of rules.  
Valid Range: Minimum value of 25. Maximum value of 50.

 ** [nextToken](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-nextToken"></a>
When the number of rules is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of rules, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListRules` to list the next set of rules.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [projectIds](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-projectIds"></a>
The IDs of projects in which rules are to be listed.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [ruleType](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-ruleType"></a>
The type of the rule.  
Valid Values: `METADATA_FORM_ENFORCEMENT | GLOSSARY_TERM_ENFORCEMENT` 

 ** [targetIdentifier](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-targetIdentifier"></a>
The target ID of the rule.  
Required: Yes

 ** [targetType](#API_ListRules_RequestSyntax) **   <a name="datazone-ListRules-request-uri-targetType"></a>
The target type of the rule.  
Valid Values: `DOMAIN_UNIT`   
Required: Yes

## Request Body
<a name="API_ListRules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "action": "string",
         "identifier": "string",
         "lastUpdatedBy": "string",
         "name": "string",
         "revision": "string",
         "ruleType": "string",
         "scope": { 
            "assetType": { 
               "selectionMode": "string",
               "specificAssetTypes": [ "string" ]
            },
            "dataProduct": boolean,
            "project": { 
               "selectionMode": "string",
               "specificProjects": [ "string" ]
            }
         },
         "target": { ... },
         "targetType": "string",
         "updatedAt": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListRules_ResponseSyntax) **   <a name="datazone-ListRules-response-items"></a>
The results of the `ListRules` action.  
Type: Array of [RuleSummary](API_RuleSummary.md) objects

 ** [nextToken](#API_ListRules_ResponseSyntax) **   <a name="datazone-ListRules-response-nextToken"></a>
When the number of rules is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of rules, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListRules` to list the next set of rules.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListRules) 

# ListSubscriptionGrants
<a name="API_ListSubscriptionGrants"></a>

Lists subscription grants.

## Request Syntax
<a name="API_ListSubscriptionGrants_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/subscription-grants?environmentId=environmentId&maxResults=maxResults&nextToken=nextToken&owningGroupId=owningGroupId&owningIamPrincipalArn=owningIamPrincipalArn&owningProjectId=owningProjectId&owningUserId=owningUserId&sortBy=sortBy&sortOrder=sortOrder&subscribedListingId=subscribedListingId&subscriptionId=subscriptionId&subscriptionTargetId=subscriptionTargetId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSubscriptionGrants_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentId](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-environmentId"></a>
The identifier of the Amazon DataZone environment.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [maxResults](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-maxResults"></a>
The maximum number of subscription grants to return in a single call to `ListSubscriptionGrants`. When the number of subscription grants to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListSubscriptionGrants` to list the next set of subscription grants.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-nextToken"></a>
When the number of subscription grants is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscription grants, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptionGrants` to list the next set of subscription grants.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [owningGroupId](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-owningGroupId"></a>
The ID of the owning group.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [owningIamPrincipalArn](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-owningIamPrincipalArn"></a>
The ARN of the owning IAM principal.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|user)(/[\w+=,.@-]*)*/[\w+=,.@-]+` 

 ** [owningProjectId](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-owningProjectId"></a>
The ID of the owning project of the subscription grants.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningUserId](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-owningUserId"></a>
The ID of the owning user.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [sortBy](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-sortBy"></a>
 *This parameter has been deprecated.*   
Specifies the way of sorting the results of this action.  
Valid Values: `CREATED_AT | UPDATED_AT` 

 ** [sortOrder](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-sortOrder"></a>
Specifies the sort order of this action.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [subscribedListingId](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-subscribedListingId"></a>
The identifier of the subscribed listing.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [subscriptionId](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-subscriptionId"></a>
The identifier of the subscription.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [subscriptionTargetId](#API_ListSubscriptionGrants_RequestSyntax) **   <a name="datazone-ListSubscriptionGrants-request-uri-subscriptionTargetId"></a>
The identifier of the subscription target.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

## Request Body
<a name="API_ListSubscriptionGrants_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSubscriptionGrants_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "assets": [ 
            { 
               "assetId": "string",
               "assetRevision": "string",
               "assetScope": { 
                  "assetId": "string",
                  "errorMessage": "string",
                  "filterIds": [ "string" ],
                  "status": "string"
               },
               "failureCause": { 
                  "message": "string"
               },
               "failureTimestamp": number,
               "grantedTimestamp": number,
               "permissions": { ... },
               "status": "string",
               "targetName": "string"
            }
         ],
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "environmentId": "string",
         "grantedEntity": { ... },
         "id": "string",
         "status": "string",
         "subscriptionId": "string",
         "subscriptionTargetId": "string",
         "updatedAt": number,
         "updatedBy": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListSubscriptionGrants_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListSubscriptionGrants_ResponseSyntax) **   <a name="datazone-ListSubscriptionGrants-response-items"></a>
The results of the `ListSubscriptionGrants` action.   
Type: Array of [SubscriptionGrantSummary](API_SubscriptionGrantSummary.md) objects

 ** [nextToken](#API_ListSubscriptionGrants_ResponseSyntax) **   <a name="datazone-ListSubscriptionGrants-response-nextToken"></a>
When the number of subscription grants is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscription grants, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptionGrants` to list the next set of subscription grants.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListSubscriptionGrants_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListSubscriptionGrants_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListSubscriptionGrants) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListSubscriptionGrants) 

# ListSubscriptionRequests
<a name="API_ListSubscriptionRequests"></a>

Lists Amazon DataZone subscription requests.

## Request Syntax
<a name="API_ListSubscriptionRequests_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/subscription-requests?approverProjectId=approverProjectId&maxResults=maxResults&nextToken=nextToken&owningGroupId=owningGroupId&owningIamPrincipalArn=owningIamPrincipalArn&owningProjectId=owningProjectId&owningUserId=owningUserId&sortBy=sortBy&sortOrder=sortOrder&status=status&subscribedListingId=subscribedListingId HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSubscriptionRequests_RequestParameters"></a>

The request uses the following URI parameters.

 ** [approverProjectId](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-approverProjectId"></a>
The identifier of the subscription request approver's project.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [domainIdentifier](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-maxResults"></a>
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.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [owningGroupId](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-owningGroupId"></a>
The ID of the owning group.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [owningIamPrincipalArn](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-owningIamPrincipalArn"></a>
The ARN of the owning IAM principal.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|user)(/[\w+=,.@-]*)*/[\w+=,.@-]+` 

 ** [owningProjectId](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-owningProjectId"></a>
The identifier of the project for the subscription requests.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningUserId](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-owningUserId"></a>
The ID of the owning user.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [sortBy](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-sortBy"></a>
 *This parameter has been deprecated.*   
Specifies the way to sort the results of this action.  
Valid Values: `CREATED_AT | UPDATED_AT` 

 ** [sortOrder](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-sortOrder"></a>
Specifies the sort order for the results of this action.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [status](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-status"></a>
Specifies the status of the subscription requests.  
This is not a required parameter, but if not specified, by default, Amazon DataZone returns only `PENDING` subscription requests. 
Valid Values: `PENDING | ACCEPTED | REJECTED` 

 ** [subscribedListingId](#API_ListSubscriptionRequests_RequestSyntax) **   <a name="datazone-ListSubscriptionRequests-request-uri-subscribedListingId"></a>
The identifier of the subscribed listing.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

## Request Body
<a name="API_ListSubscriptionRequests_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSubscriptionRequests_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "decisionComment": "string",
         "domainId": "string",
         "existingSubscriptionId": "string",
         "id": "string",
         "metadataFormsSummary": [ 
            { 
               "formName": "string",
               "typeName": "string",
               "typeRevision": "string"
            }
         ],
         "requestReason": "string",
         "reviewerId": "string",
         "status": "string",
         "subscribedListings": [ 
            { 
               "description": "string",
               "id": "string",
               "item": { ... },
               "name": "string",
               "ownerProjectId": "string",
               "ownerProjectName": "string",
               "revision": "string"
            }
         ],
         "subscribedPrincipals": [ 
            { ... }
         ],
         "updatedAt": number,
         "updatedBy": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListSubscriptionRequests_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListSubscriptionRequests_ResponseSyntax) **   <a name="datazone-ListSubscriptionRequests-response-items"></a>
The results of the `ListSubscriptionRequests` action.   
Type: Array of [SubscriptionRequestSummary](API_SubscriptionRequestSummary.md) objects

 ** [nextToken](#API_ListSubscriptionRequests_ResponseSyntax) **   <a name="datazone-ListSubscriptionRequests-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListSubscriptionRequests_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListSubscriptionRequests_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListSubscriptionRequests) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListSubscriptionRequests) 

# ListSubscriptions
<a name="API_ListSubscriptions"></a>

Lists subscriptions in Amazon DataZone.

## Request Syntax
<a name="API_ListSubscriptions_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/subscriptions?approverProjectId=approverProjectId&maxResults=maxResults&nextToken=nextToken&owningGroupId=owningGroupId&owningIamPrincipalArn=owningIamPrincipalArn&owningProjectId=owningProjectId&owningUserId=owningUserId&sortBy=sortBy&sortOrder=sortOrder&status=status&subscribedListingId=subscribedListingId&subscriptionRequestIdentifier=subscriptionRequestIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSubscriptions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [approverProjectId](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-approverProjectId"></a>
The identifier of the project for the subscription's approver.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [domainIdentifier](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-maxResults"></a>
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.   
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-nextToken"></a>
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.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [owningGroupId](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-owningGroupId"></a>
The ID of the owning group.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [owningIamPrincipalArn](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-owningIamPrincipalArn"></a>
The ARN of the owning IAM principal.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `arn:aws[^:]*:iam::\d{12}:(role|user)(/[\w+=,.@-]*)*/[\w+=,.@-]+` 

 ** [owningProjectId](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-owningProjectId"></a>
The identifier of the owning project.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningUserId](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-owningUserId"></a>
The ID of the owning user.  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [sortBy](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-sortBy"></a>
 *This parameter has been deprecated.*   
Specifies the way in which the results of this action are to be sorted.  
Valid Values: `CREATED_AT | UPDATED_AT` 

 ** [sortOrder](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-sortOrder"></a>
Specifies the sort order for the results of this action.  
Valid Values: `ASCENDING | DESCENDING` 

 ** [status](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-status"></a>
The status of the subscriptions that you want to list.  
This is not a required parameter, but if not provided, by default, Amazon DataZone returns only `APPROVED` subscriptions. 
Valid Values: `APPROVED | REVOKED | CANCELLED` 

 ** [subscribedListingId](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-subscribedListingId"></a>
The identifier of the subscribed listing for the subscriptions that you want to list.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [subscriptionRequestIdentifier](#API_ListSubscriptions_RequestSyntax) **   <a name="datazone-ListSubscriptions-request-uri-subscriptionRequestIdentifier"></a>
The identifier of the subscription request for the subscriptions that you want to list.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

## Request Body
<a name="API_ListSubscriptions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSubscriptions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "id": "string",
         "retainPermissions": boolean,
         "status": "string",
         "subscribedListing": { 
            "description": "string",
            "id": "string",
            "item": { ... },
            "name": "string",
            "ownerProjectId": "string",
            "ownerProjectName": "string",
            "revision": "string"
         },
         "subscribedPrincipal": { ... },
         "subscriptionRequestId": "string",
         "updatedAt": number,
         "updatedBy": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListSubscriptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListSubscriptions_ResponseSyntax) **   <a name="datazone-ListSubscriptions-response-items"></a>
The results of the `ListSubscriptions` action.  
Type: Array of [SubscriptionSummary](API_SubscriptionSummary.md) objects

 ** [nextToken](#API_ListSubscriptions_ResponseSyntax) **   <a name="datazone-ListSubscriptions-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListSubscriptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListSubscriptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListSubscriptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListSubscriptions) 

# ListSubscriptionTargets
<a name="API_ListSubscriptionTargets"></a>

Lists subscription targets in Amazon DataZone.

## Request Syntax
<a name="API_ListSubscriptionTargets_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/environments/environmentIdentifier/subscription-targets?maxResults=maxResults&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSubscriptionTargets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListSubscriptionTargets_RequestSyntax) **   <a name="datazone-ListSubscriptionTargets-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain where you want to list subscription targets.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_ListSubscriptionTargets_RequestSyntax) **   <a name="datazone-ListSubscriptionTargets-request-uri-environmentIdentifier"></a>
The identifier of the environment where you want to list subscription targets.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_ListSubscriptionTargets_RequestSyntax) **   <a name="datazone-ListSubscriptionTargets-request-uri-maxResults"></a>
The maximum number of subscription targets to return in a single call to `ListSubscriptionTargets`. When the number of subscription targets to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `ListSubscriptionTargets` to list the next set of subscription targets.   
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListSubscriptionTargets_RequestSyntax) **   <a name="datazone-ListSubscriptionTargets-request-uri-nextToken"></a>
When the number of subscription targets is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscription targets, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptionTargets` to list the next set of subscription targets.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [sortBy](#API_ListSubscriptionTargets_RequestSyntax) **   <a name="datazone-ListSubscriptionTargets-request-uri-sortBy"></a>
Specifies the way in which the results of this action are to be sorted.  
Valid Values: `CREATED_AT | UPDATED_AT` 

 ** [sortOrder](#API_ListSubscriptionTargets_RequestSyntax) **   <a name="datazone-ListSubscriptionTargets-request-uri-sortOrder"></a>
Specifies the sort order for the results of this action.  
Valid Values: `ASCENDING | DESCENDING` 

## Request Body
<a name="API_ListSubscriptionTargets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSubscriptionTargets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "applicableAssetTypes": [ "string" ],
         "authorizedPrincipals": [ "string" ],
         "createdAt": number,
         "createdBy": "string",
         "domainId": "string",
         "environmentId": "string",
         "id": "string",
         "manageAccessRole": "string",
         "name": "string",
         "projectId": "string",
         "provider": "string",
         "subscriptionGrantCreationMode": "string",
         "subscriptionTargetConfig": [ 
            { 
               "content": "string",
               "formName": "string"
            }
         ],
         "type": "string",
         "updatedAt": number,
         "updatedBy": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListSubscriptionTargets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListSubscriptionTargets_ResponseSyntax) **   <a name="datazone-ListSubscriptionTargets-response-items"></a>
The results of the `ListSubscriptionTargets` action.  
Type: Array of [SubscriptionTargetSummary](API_SubscriptionTargetSummary.md) objects

 ** [nextToken](#API_ListSubscriptionTargets_ResponseSyntax) **   <a name="datazone-ListSubscriptionTargets-response-nextToken"></a>
When the number of subscription targets is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of subscription targets, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `ListSubscriptionTargets` to list the next set of subscription targets.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListSubscriptionTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListSubscriptionTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListSubscriptionTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListSubscriptionTargets) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists tags for the specified resource in Amazon DataZone.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="datazone-ListTagsForResource-request-uri-resourceArn"></a>
The ARN of the resource whose tags you want to list.  
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="datazone-ListTagsForResource-response-tags"></a>
The tags of the specified resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\w \.:/=+@-]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `[\w \.:/=+@-]*` 

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListTagsForResource) 

# ListTimeSeriesDataPoints
<a name="API_ListTimeSeriesDataPoints"></a>

Lists time series data points.

## Request Syntax
<a name="API_ListTimeSeriesDataPoints_RequestSyntax"></a>

```
GET /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/time-series-data-points?endedAt=endedAt&formName=formName&maxResults=maxResults&nextToken=nextToken&startedAt=startedAt HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTimeSeriesDataPoints_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [endedAt](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-endedAt"></a>
The timestamp at which the data points that you wanted to list ended.

 ** [entityIdentifier](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-entityIdentifier"></a>
The ID of the asset for which you want to list data points.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityType](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-entityType"></a>
The type of the asset for which you want to list data points.  
Valid Values: `ASSET | LISTING`   
Required: Yes

 ** [formName](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-formName"></a>
The name of the time series data points form.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [maxResults](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-maxResults"></a>
The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-nextToken"></a>
When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [startedAt](#API_ListTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-request-uri-startedAt"></a>
The timestamp at which the data points that you want to list started.

## Request Body
<a name="API_ListTimeSeriesDataPoints_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTimeSeriesDataPoints_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "contentSummary": "string",
         "formName": "string",
         "id": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListTimeSeriesDataPoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_ListTimeSeriesDataPoints_ResponseSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-response-items"></a>
The results of the ListTimeSeriesDataPoints action.   
Type: Array of [TimeSeriesDataPointSummaryFormOutput](API_TimeSeriesDataPointSummaryFormOutput.md) objects

 ** [nextToken](#API_ListTimeSeriesDataPoints_ResponseSyntax) **   <a name="datazone-ListTimeSeriesDataPoints-response-nextToken"></a>
When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_ListTimeSeriesDataPoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_ListTimeSeriesDataPoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/ListTimeSeriesDataPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/ListTimeSeriesDataPoints) 

# PostLineageEvent
<a name="API_PostLineageEvent"></a>

Posts a data lineage event.

## Request Syntax
<a name="API_PostLineageEvent_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/lineage/events HTTP/1.1
Client-Token: clientToken

event
```

## URI Request Parameters
<a name="API_PostLineageEvent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_PostLineageEvent_RequestSyntax) **   <a name="datazone-PostLineageEvent-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+` 

 ** [domainIdentifier](#API_PostLineageEvent_RequestSyntax) **   <a name="datazone-PostLineageEvent-request-uri-domainIdentifier"></a>
The ID of the domain where you want to post a data lineage event.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_PostLineageEvent_RequestBody"></a>

The request accepts the following binary data.

 ** [event](#API_PostLineageEvent_RequestSyntax) **   <a name="datazone-PostLineageEvent-request-event"></a>
The data lineage event that you want to post. Only open-lineage run event are supported as events.   
Length Constraints: Minimum length of 0. Maximum length of 300000.  
Required: Yes

## Response Syntax
<a name="API_PostLineageEvent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domainId": "string",
   "id": "string"
}
```

## Response Elements
<a name="API_PostLineageEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_PostLineageEvent_ResponseSyntax) **   <a name="datazone-PostLineageEvent-response-domainId"></a>
The ID of the domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_PostLineageEvent_ResponseSyntax) **   <a name="datazone-PostLineageEvent-response-id"></a>
The ID of the lineage event.  
Type: String  
Pattern: `[a-z0-9]{14}` 

## Errors
<a name="API_PostLineageEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_PostLineageEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/PostLineageEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/PostLineageEvent) 

# PostTimeSeriesDataPoints
<a name="API_PostTimeSeriesDataPoints"></a>

Posts time series data points to Amazon DataZone for the specified asset.

## Request Syntax
<a name="API_PostTimeSeriesDataPoints_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/time-series-data-points HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "forms": [ 
      { 
         "content": "string",
         "formName": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_PostTimeSeriesDataPoints_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_PostTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain in which you want to post time series data points.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_PostTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-request-uri-entityIdentifier"></a>
The ID of the asset for which you want to post time series data points.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityType](#API_PostTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-request-uri-entityType"></a>
The type of the asset for which you want to post data points.  
Valid Values: `ASSET | LISTING`   
Required: Yes

## Request Body
<a name="API_PostTimeSeriesDataPoints_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_PostTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [forms](#API_PostTimeSeriesDataPoints_RequestSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-request-forms"></a>
The forms that contain the data points that you want to post.  
Type: Array of [TimeSeriesDataPointFormInput](API_TimeSeriesDataPointFormInput.md) objects  
Required: Yes

## Response Syntax
<a name="API_PostTimeSeriesDataPoints_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "domainId": "string",
   "entityId": "string",
   "entityType": "string",
   "forms": [ 
      { 
         "content": "string",
         "formName": "string",
         "id": "string",
         "timestamp": number,
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ]
}
```

## Response Elements
<a name="API_PostTimeSeriesDataPoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_PostTimeSeriesDataPoints_ResponseSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-response-domainId"></a>
The ID of the Amazon DataZone domain in which you want to post time series data points.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [entityId](#API_PostTimeSeriesDataPoints_ResponseSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-response-entityId"></a>
The ID of the asset for which you want to post time series data points.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [entityType](#API_PostTimeSeriesDataPoints_ResponseSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-response-entityType"></a>
The type of the asset for which you want to post data points.  
Type: String  
Valid Values: `ASSET | LISTING` 

 ** [forms](#API_PostTimeSeriesDataPoints_ResponseSyntax) **   <a name="datazone-PostTimeSeriesDataPoints-response-forms"></a>
The forms that contain the data points that you have posted.  
Type: Array of [TimeSeriesDataPointFormOutput](API_TimeSeriesDataPointFormOutput.md) objects

## Errors
<a name="API_PostTimeSeriesDataPoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_PostTimeSeriesDataPoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/PostTimeSeriesDataPoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/PostTimeSeriesDataPoints) 

# PutDataExportConfiguration
<a name="API_PutDataExportConfiguration"></a>

Creates data export configuration details.

If you want to temporarily disable export and later re-enable it for the same domain, use the `--no-enable-export` flag to disable and the `--enable-export` flag to re-enable. This preserves the configuration and allows you to re-enable export without deleting S3 table.

**Note**  
You can enable asset metadata export for only one domain per account per Region. To enable export for a different domain, complete the following steps:  
Delete the export configuration for the currently enabled domain using the DeleteDataExportConfiguration operation.
Delete the asset S3 table under the aws-sagemaker-catalog S3 table bucket. We recommend backing up the S3 table before deletion.
Call the PutDataExportConfiguration API to enable export for the new domain.

## Request Syntax
<a name="API_PutDataExportConfiguration_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/data-export-configuration HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "enableExport": boolean,
   "encryptionConfiguration": { 
      "kmsKeyArn": "string",
      "sseAlgorithm": "string"
   }
}
```

## URI Request Parameters
<a name="API_PutDataExportConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_PutDataExportConfiguration_RequestSyntax) **   <a name="datazone-PutDataExportConfiguration-request-uri-domainIdentifier"></a>
The domain ID for which you want to create data export configuration details.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_PutDataExportConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_PutDataExportConfiguration_RequestSyntax) **   <a name="datazone-PutDataExportConfiguration-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [enableExport](#API_PutDataExportConfiguration_RequestSyntax) **   <a name="datazone-PutDataExportConfiguration-request-enableExport"></a>
Specifies that the export is to be enabled as part of creating data export configuration details.  
Type: Boolean  
Required: Yes

 ** [encryptionConfiguration](#API_PutDataExportConfiguration_RequestSyntax) **   <a name="datazone-PutDataExportConfiguration-request-encryptionConfiguration"></a>
The encryption configuration as part of creating data export configuration details.  
The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in [KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio](https://docs.aws.amazon.com/sagemaker-unified-studio/latest/adminguide/sagemaker-unified-studio-export-asset-metadata-kms-permissions.html).  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_PutDataExportConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutDataExportConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutDataExportConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_PutDataExportConfiguration_Examples"></a>

### Example
<a name="API_PutDataExportConfiguration_Example_1"></a>

Enable data export:

#### Sample Request
<a name="API_PutDataExportConfiguration_Example_1_Request"></a>

```
aws datazone put-data-export-configuration  --domain-identifier dzd-440699i00ezy21 --region us-east-2 --enable-export
```

### Example
<a name="API_PutDataExportConfiguration_Example_2"></a>

Disable data export:

#### Sample Request
<a name="API_PutDataExportConfiguration_Example_2_Request"></a>

```
aws datazone put-data-export-configuration --domain-identifier dzd-440699i00ezy21 --region us-east-2 --no-enable-export
```

### Example
<a name="API_PutDataExportConfiguration_Example_3"></a>

With KMS key encryption configuration:

#### Sample Request
<a name="API_PutDataExportConfiguration_Example_3_Request"></a>

```
aws datazone put-data-export-configuration --encryption-configuration kmsKeyArn=arn:aws:kms:us-east-2:651673343886:key/292fedfe-c9h6-40fa-961b-87393584195c,sseAlgorithm=aws:kms --enable-export --region us-east-2 --domain-identifier dzd-440699i00ezy21
```

### Example
<a name="API_PutDataExportConfiguration_Example_4"></a>

With KMS key encryption configuration when KMS key is disabled:

#### Sample Response
<a name="API_PutDataExportConfiguration_Example_4_Response"></a>

```
An error occurred (ValidationException) when calling the PutDataExportConfiguration operation: The specified KMS key ARN is disabled. (Service: S3Tables, Status Code: 400, Request ID: 07bdfab7-6336-4145-b5ec-277a6a77a4e0) (SDK Attempt Count: 1)
```

### Example
<a name="API_PutDataExportConfiguration_Example_5"></a>

With KMS key encryption configuration when KMS key is missing permission for systemtables.sagemaker-catalog.amazonaws.com service principal:

#### Sample Response
<a name="API_PutDataExportConfiguration_Example_5_Response"></a>

```
An error occurred (AccessDeniedException) when calling the PutDataExportConfiguration operation: User: arn:aws:sts::750784792897:assumed-role/SageMakerCatalogDataSetPublisherRole/AWSSageMakerCatalog-S3TablesRole-651393378886 is not authorized to perform: kms:DescribeKey on this resource because the resource does not exist in this Region, no resource-based policies allow access, or a resource-based policy explicitly denies access (Service: S3Tables, Status Code: 403, Request ID: 86f5d9f9-62a6-4af9-8177-69edbb2992f4) (SDK Attempt Count: 1)
```

### Example
<a name="API_PutDataExportConfiguration_Example_6"></a>

With KMS key encryption configuration when SSE algorithm is not provided along with KMS key:

#### Sample Response
<a name="API_PutDataExportConfiguration_Example_6_Response"></a>

```
An error occurred (ValidationException) when calling the PutDataExportConfiguration operation: The specified SSE algorithm is invalid. (Service: S3Tables, Status Code: 400, Request ID: 678df137-aa8e-47aa-b485-a8971a3f2f3c) (SDK Attempt Count: 1)
```

### Example
<a name="API_PutDataExportConfiguration_Example_7"></a>

Enable export failing with conflict exception. Provide --client-token parameter with a different client token to resolve this error.

#### Sample Response
<a name="API_PutDataExportConfiguration_Example_7_Response"></a>

```
An error occurred (ConflictException) when calling the PutDataExportConfiguration operation: Conflict exception occurred while putting data export configuration for domain:dzd-cslg7hs0m6k4fd
```

### Example
<a name="API_PutDataExportConfiguration_Example_8"></a>

When configuration already exists for another domain:

#### Sample Response
<a name="API_PutDataExportConfiguration_Example_8_Response"></a>

```
An error occurred (ConflictException) when calling the PutDataExportConfiguration operation: Data Export Configuration exists for another domain with id: dzd-cslg7hs0m6k4fd
```

## See Also
<a name="API_PutDataExportConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/PutDataExportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/PutDataExportConfiguration) 

# PutEnvironmentBlueprintConfiguration
<a name="API_PutEnvironmentBlueprintConfiguration"></a>

Writes the configuration for the specified environment blueprint in Amazon DataZone.

## Request Syntax
<a name="API_PutEnvironmentBlueprintConfiguration_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/environment-blueprint-configurations/environmentBlueprintIdentifier HTTP/1.1
Content-type: application/json

{
   "enabledRegions": [ "string" ],
   "environmentRolePermissionBoundary": "string",
   "globalParameters": { 
      "string" : "string" 
   },
   "manageAccessRoleArn": "string",
   "provisioningConfigurations": [ 
      { ... }
   ],
   "provisioningRoleArn": "string",
   "regionalParameters": { 
      "string" : { 
         "string" : "string" 
      }
   }
}
```

## URI Request Parameters
<a name="API_PutEnvironmentBlueprintConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentBlueprintIdentifier](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-uri-environmentBlueprintIdentifier"></a>
The identifier of the environment blueprint.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_PutEnvironmentBlueprintConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [enabledRegions](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-enabledRegions"></a>
Specifies the enabled AWS Regions.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Minimum length of 4. Maximum length of 16.  
Pattern: `[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]`   
Required: Yes

 ** [environmentRolePermissionBoundary](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-environmentRolePermissionBoundary"></a>
The environment role permissions boundary.  
Type: String  
Pattern: `arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*`   
Required: No

 ** [globalParameters](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-globalParameters"></a>
Region-agnostic environment blueprint parameters.   
Type: String to string map  
Required: No

 ** [manageAccessRoleArn](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-manageAccessRoleArn"></a>
The ARN of the manage access role.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+`   
Required: No

 ** [provisioningConfigurations](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-provisioningConfigurations"></a>
The provisioning configuration of a blueprint.  
Type: Array of [ProvisioningConfiguration](API_ProvisioningConfiguration.md) objects  
Required: No

 ** [provisioningRoleArn](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-provisioningRoleArn"></a>
The ARN of the provisioning role.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+`   
Required: No

 ** [regionalParameters](#API_PutEnvironmentBlueprintConfiguration_RequestSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-request-regionalParameters"></a>
The regional parameters in the environment blueprint.  
Type: String to string to string map map  
Key Length Constraints: Minimum length of 4. Maximum length of 16.  
Key Pattern: `[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]`   
Required: No

## Response Syntax
<a name="API_PutEnvironmentBlueprintConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "domainId": "string",
   "enabledRegions": [ "string" ],
   "environmentBlueprintId": "string",
   "environmentRolePermissionBoundary": "string",
   "manageAccessRoleArn": "string",
   "provisioningConfigurations": [ 
      { ... }
   ],
   "provisioningRoleArn": "string",
   "regionalParameters": { 
      "string" : { 
         "string" : "string" 
      }
   },
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_PutEnvironmentBlueprintConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-createdAt"></a>
The timestamp of when the environment blueprint was created.  
Type: Timestamp

 ** [domainId](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-domainId"></a>
The identifier of the Amazon DataZone domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [enabledRegions](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-enabledRegions"></a>
Specifies the enabled AWS Regions.  
Type: Array of strings  
Array Members: Minimum number of 0 items.  
Length Constraints: Minimum length of 4. Maximum length of 16.  
Pattern: `[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]` 

 ** [environmentBlueprintId](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-environmentBlueprintId"></a>
The identifier of the environment blueprint.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentRolePermissionBoundary](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-environmentRolePermissionBoundary"></a>
The environment role permissions boundary.  
Type: String  
Pattern: `arn:aws[^:]*:iam::(aws|\d{12}):policy/[\w+=,.@-]*` 

 ** [manageAccessRoleArn](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-manageAccessRoleArn"></a>
The ARN of the manage access role.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [provisioningConfigurations](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-provisioningConfigurations"></a>
The provisioning configuration of a blueprint.  
Type: Array of [ProvisioningConfiguration](API_ProvisioningConfiguration.md) objects

 ** [provisioningRoleArn](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-provisioningRoleArn"></a>
The ARN of the provisioning role.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [regionalParameters](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-regionalParameters"></a>
The regional parameters in the environment blueprint.  
Type: String to string to string map map  
Key Length Constraints: Minimum length of 4. Maximum length of 16.  
Key Pattern: `[a-z]{2}-?(iso|gov)?-{1}[a-z]*-{1}[0-9]` 

 ** [updatedAt](#API_PutEnvironmentBlueprintConfiguration_ResponseSyntax) **   <a name="datazone-PutEnvironmentBlueprintConfiguration-response-updatedAt"></a>
The timestamp of when the environment blueprint was updated.  
Type: Timestamp

## Errors
<a name="API_PutEnvironmentBlueprintConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_PutEnvironmentBlueprintConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/PutEnvironmentBlueprintConfiguration) 

# QueryGraph
<a name="API_QueryGraph"></a>

Queries entities in the graph store.

## Request Syntax
<a name="API_QueryGraph_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/graph/query?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "additionalAttributes": { 
      "formNames": [ "string" ]
   },
   "match": [ 
      { ... }
   ]
}
```

## URI Request Parameters
<a name="API_QueryGraph_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_QueryGraph_RequestSyntax) **   <a name="datazone-QueryGraph-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [maxResults](#API_QueryGraph_RequestSyntax) **   <a name="datazone-QueryGraph-request-uri-maxResults"></a>
The maximum number of entities to return in a single call to `QueryGraph`. When the number of entities to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `QueryGraph` to list the next set of entities.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_QueryGraph_RequestSyntax) **   <a name="datazone-QueryGraph-request-uri-nextToken"></a>
When the number of entities is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of entities, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `QueryGraph` to list the next set of entities.  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Request Body
<a name="API_QueryGraph_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [additionalAttributes](#API_QueryGraph_RequestSyntax) **   <a name="datazone-QueryGraph-request-additionalAttributes"></a>
Additional details on the queried entity that can be requested in the response.  
Type: [AdditionalAttributes](API_AdditionalAttributes.md) object  
Required: No

 ** [match](#API_QueryGraph_RequestSyntax) **   <a name="datazone-QueryGraph-request-match"></a>
List of query match clauses.  
Type: Array of [MatchClause](API_MatchClause.md) objects  
Array Members: Fixed number of 2 items.  
Required: Yes

## Response Syntax
<a name="API_QueryGraph_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { ... }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_QueryGraph_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_QueryGraph_ResponseSyntax) **   <a name="datazone-QueryGraph-response-items"></a>
The results of the `QueryGraph` action.  
Type: Array of [ResultItem](API_ResultItem.md) objects

 ** [nextToken](#API_QueryGraph_ResponseSyntax) **   <a name="datazone-QueryGraph-response-nextToken"></a>
When the number of entities is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of entities, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `QueryGraph` to list the next set of entities.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_QueryGraph_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_QueryGraph_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/QueryGraph) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/QueryGraph) 

# RejectPredictions
<a name="API_RejectPredictions"></a>

Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

## Request Syntax
<a name="API_RejectPredictions_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/assets/identifier/reject-predictions?revision=revision HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "rejectChoices": [ 
      { 
         "predictionChoices": [ number ],
         "predictionTarget": "string"
      }
   ],
   "rejectRule": { 
      "rule": "string",
      "threshold": number
   }
}
```

## URI Request Parameters
<a name="API_RejectPredictions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_RejectPredictions_RequestSyntax) **   <a name="datazone-RejectPredictions-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_RejectPredictions_RequestSyntax) **   <a name="datazone-RejectPredictions-request-uri-identifier"></a>
The identifier of the prediction.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [revision](#API_RejectPredictions_RequestSyntax) **   <a name="datazone-RejectPredictions-request-uri-revision"></a>
The revision that is to be made to the asset.  
Length Constraints: Minimum length of 1. Maximum length of 64.

## Request Body
<a name="API_RejectPredictions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_RejectPredictions_RequestSyntax) **   <a name="datazone-RejectPredictions-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [rejectChoices](#API_RejectPredictions_RequestSyntax) **   <a name="datazone-RejectPredictions-request-rejectChoices"></a>
Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.  
Type: Array of [RejectChoice](API_RejectChoice.md) objects  
Required: No

 ** [rejectRule](#API_RejectPredictions_RequestSyntax) **   <a name="datazone-RejectPredictions-request-rejectRule"></a>
Specifies the rule (or the conditions) under which a prediction can be rejected.  
Type: [RejectRule](API_RejectRule.md) object  
Required: No

## Response Syntax
<a name="API_RejectPredictions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetId": "string",
   "assetRevision": "string",
   "domainId": "string"
}
```

## Response Elements
<a name="API_RejectPredictions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetId](#API_RejectPredictions_ResponseSyntax) **   <a name="datazone-RejectPredictions-response-assetId"></a>
The ID of the asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [assetRevision](#API_RejectPredictions_ResponseSyntax) **   <a name="datazone-RejectPredictions-response-assetRevision"></a>
The revision that is to be made to the asset.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [domainId](#API_RejectPredictions_ResponseSyntax) **   <a name="datazone-RejectPredictions-response-domainId"></a>
The ID of the Amazon DataZone domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

## Errors
<a name="API_RejectPredictions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RejectPredictions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/RejectPredictions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/RejectPredictions) 

# RejectSubscriptionRequest
<a name="API_RejectSubscriptionRequest"></a>

Rejects the specified subscription request.

## Request Syntax
<a name="API_RejectSubscriptionRequest_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/subscription-requests/identifier/reject HTTP/1.1
Content-type: application/json

{
   "decisionComment": "string"
}
```

## URI Request Parameters
<a name="API_RejectSubscriptionRequest_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_RejectSubscriptionRequest_RequestSyntax) **   <a name="datazone-RejectSubscriptionRequest-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which the subscription request was rejected.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_RejectSubscriptionRequest_RequestSyntax) **   <a name="datazone-RejectSubscriptionRequest-request-uri-identifier"></a>
The identifier of the subscription request that was rejected.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_RejectSubscriptionRequest_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [decisionComment](#API_RejectSubscriptionRequest_RequestSyntax) **   <a name="datazone-RejectSubscriptionRequest-request-decisionComment"></a>
The decision comment of the rejected subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

## Response Syntax
<a name="API_RejectSubscriptionRequest_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "decisionComment": "string",
   "domainId": "string",
   "existingSubscriptionId": "string",
   "id": "string",
   "metadataForms": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "requestReason": "string",
   "reviewerId": "string",
   "status": "string",
   "subscribedListings": [ 
      { 
         "description": "string",
         "id": "string",
         "item": { ... },
         "name": "string",
         "ownerProjectId": "string",
         "ownerProjectName": "string",
         "revision": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ],
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_RejectSubscriptionRequest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-createdAt"></a>
The timestamp of when the subscription request was rejected.  
Type: Timestamp

 ** [createdBy](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-createdBy"></a>
The timestamp of when the subscription request was rejected.  
Type: String

 ** [decisionComment](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-decisionComment"></a>
The decision comment of the rejected subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-domainId"></a>
The identifier of the Amazon DataZone domain in which the subscription request was rejected.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [existingSubscriptionId](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-existingSubscriptionId"></a>
The ID of the existing subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-id"></a>
The identifier of the subscription request that was rejected.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [metadataForms](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-metadataForms"></a>
Metadata forms included in the subscription request.  
Type: Array of [FormOutput](API_FormOutput.md) objects

 ** [requestReason](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-requestReason"></a>
The reason for the subscription request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [reviewerId](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-reviewerId"></a>
The identifier of the subscription request reviewer.  
Type: String

 ** [status](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-status"></a>
The status of the subscription request.  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED` 

 ** [subscribedListings](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-subscribedListings"></a>
The subscribed listings of the subscription request.  
Type: Array of [SubscribedListing](API_SubscribedListing.md) objects  
Array Members: Fixed number of 1 item.

 ** [subscribedPrincipals](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-subscribedPrincipals"></a>
The subscribed principals of the subscription request.  
Type: Array of [SubscribedPrincipal](API_SubscribedPrincipal.md) objects  
Array Members: Fixed number of 1 item.

 ** [updatedAt](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-updatedAt"></a>
The timestamp of when the subscription request was updated.  
Type: Timestamp

 ** [updatedBy](#API_RejectSubscriptionRequest_ResponseSyntax) **   <a name="datazone-RejectSubscriptionRequest-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription request.  
Type: String

## Errors
<a name="API_RejectSubscriptionRequest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RejectSubscriptionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/RejectSubscriptionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/RejectSubscriptionRequest) 

# RemoveEntityOwner
<a name="API_RemoveEntityOwner"></a>

Removes an owner from an entity.

## Request Syntax
<a name="API_RemoveEntityOwner_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/removeOwner HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "owner": { ... }
}
```

## URI Request Parameters
<a name="API_RemoveEntityOwner_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_RemoveEntityOwner_RequestSyntax) **   <a name="datazone-RemoveEntityOwner-request-uri-domainIdentifier"></a>
The ID of the domain where you want to remove an owner from an entity.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_RemoveEntityOwner_RequestSyntax) **   <a name="datazone-RemoveEntityOwner-request-uri-entityIdentifier"></a>
The ID of the entity from which you want to remove an owner.  
Required: Yes

 ** [entityType](#API_RemoveEntityOwner_RequestSyntax) **   <a name="datazone-RemoveEntityOwner-request-uri-entityType"></a>
The type of the entity from which you want to remove an owner.  
Valid Values: `DOMAIN_UNIT`   
Required: Yes

## Request Body
<a name="API_RemoveEntityOwner_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_RemoveEntityOwner_RequestSyntax) **   <a name="datazone-RemoveEntityOwner-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [owner](#API_RemoveEntityOwner_RequestSyntax) **   <a name="datazone-RemoveEntityOwner-request-owner"></a>
The owner that you want to remove from an entity.  
Type: [OwnerProperties](API_OwnerProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_RemoveEntityOwner_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_RemoveEntityOwner_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_RemoveEntityOwner_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RemoveEntityOwner_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/RemoveEntityOwner) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/RemoveEntityOwner) 

# RemovePolicyGrant
<a name="API_RemovePolicyGrant"></a>

Removes a policy grant.

## Request Syntax
<a name="API_RemovePolicyGrant_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/policies/managed/entityType/entityIdentifier/removeGrant HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "grantIdentifier": "string",
   "policyType": "string",
   "principal": { ... }
}
```

## URI Request Parameters
<a name="API_RemovePolicyGrant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_RemovePolicyGrant_RequestSyntax) **   <a name="datazone-RemovePolicyGrant-request-uri-domainIdentifier"></a>
The ID of the domain where you want to remove a policy grant.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [entityIdentifier](#API_RemovePolicyGrant_RequestSyntax) **   <a name="datazone-RemovePolicyGrant-request-uri-entityIdentifier"></a>
The ID of the entity from which you want to remove a policy grant.  
Required: Yes

 ** [entityType](#API_RemovePolicyGrant_RequestSyntax) **   <a name="datazone-RemovePolicyGrant-request-uri-entityType"></a>
The type of the entity from which you want to remove a policy grant.  
Valid Values: `DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE | ASSET_TYPE`   
Required: Yes

## Request Body
<a name="API_RemovePolicyGrant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_RemovePolicyGrant_RequestSyntax) **   <a name="datazone-RemovePolicyGrant-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [grantIdentifier](#API_RemovePolicyGrant_RequestSyntax) **   <a name="datazone-RemovePolicyGrant-request-grantIdentifier"></a>
The ID of the policy grant that is to be removed from a specified entity.  
Type: String  
Pattern: `[A-Za-z0-9+/]{10}`   
Required: No

 ** [policyType](#API_RemovePolicyGrant_RequestSyntax) **   <a name="datazone-RemovePolicyGrant-request-policyType"></a>
The type of the policy that you want to remove.  
Type: String  
Valid Values: `CREATE_DOMAIN_UNIT | OVERRIDE_DOMAIN_UNIT_OWNERS | ADD_TO_PROJECT_MEMBER_POOL | OVERRIDE_PROJECT_OWNERS | CREATE_GLOSSARY | CREATE_FORM_TYPE | CREATE_ASSET_TYPE | CREATE_PROJECT | CREATE_ENVIRONMENT_PROFILE | DELEGATE_CREATE_ENVIRONMENT_PROFILE | CREATE_ENVIRONMENT | CREATE_ENVIRONMENT_FROM_BLUEPRINT | CREATE_PROJECT_FROM_PROJECT_PROFILE | USE_ASSET_TYPE`   
Required: Yes

 ** [principal](#API_RemovePolicyGrant_RequestSyntax) **   <a name="datazone-RemovePolicyGrant-request-principal"></a>
The principal from which you want to remove a policy grant.  
Type: [PolicyGrantPrincipal](API_PolicyGrantPrincipal.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_RemovePolicyGrant_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_RemovePolicyGrant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_RemovePolicyGrant_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RemovePolicyGrant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/RemovePolicyGrant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/RemovePolicyGrant) 

# RevokeSubscription
<a name="API_RevokeSubscription"></a>

Revokes a specified subscription in Amazon DataZone.

## Request Syntax
<a name="API_RevokeSubscription_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/subscriptions/identifier/revoke HTTP/1.1
Content-type: application/json

{
   "retainPermissions": boolean
}
```

## URI Request Parameters
<a name="API_RevokeSubscription_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_RevokeSubscription_RequestSyntax) **   <a name="datazone-RevokeSubscription-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain where you want to revoke a subscription.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_RevokeSubscription_RequestSyntax) **   <a name="datazone-RevokeSubscription-request-uri-identifier"></a>
The identifier of the revoked subscription.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_RevokeSubscription_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [retainPermissions](#API_RevokeSubscription_RequestSyntax) **   <a name="datazone-RevokeSubscription-request-retainPermissions"></a>
Specifies whether permissions are retained when the subscription is revoked.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_RevokeSubscription_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "id": "string",
   "retainPermissions": boolean,
   "status": "string",
   "subscribedListing": { 
      "description": "string",
      "id": "string",
      "item": { ... },
      "name": "string",
      "ownerProjectId": "string",
      "ownerProjectName": "string",
      "revision": "string"
   },
   "subscribedPrincipal": { ... },
   "subscriptionRequestId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_RevokeSubscription_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-createdAt"></a>
The timestamp of when the subscription was revoked.  
Type: Timestamp

 ** [createdBy](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-createdBy"></a>
The identifier of the user who revoked the subscription.  
Type: String

 ** [domainId](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-domainId"></a>
The identifier of the Amazon DataZone domain where you want to revoke a subscription.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-id"></a>
The identifier of the revoked subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [retainPermissions](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-retainPermissions"></a>
Specifies whether permissions are retained when the subscription is revoked.  
Type: Boolean

 ** [status](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-status"></a>
The status of the revoked subscription.  
Type: String  
Valid Values: `APPROVED | REVOKED | CANCELLED` 

 ** [subscribedListing](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-subscribedListing"></a>
The subscribed listing of the revoked subscription.  
Type: [SubscribedListing](API_SubscribedListing.md) object

 ** [subscribedPrincipal](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-subscribedPrincipal"></a>
The subscribed principal of the revoked subscription.  
Type: [SubscribedPrincipal](API_SubscribedPrincipal.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [subscriptionRequestId](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-subscriptionRequestId"></a>
The identifier of the subscription request for the revoked subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-updatedAt"></a>
The timestamp of when the subscription was revoked.  
Type: Timestamp

 ** [updatedBy](#API_RevokeSubscription_ResponseSyntax) **   <a name="datazone-RevokeSubscription-response-updatedBy"></a>
The Amazon DataZone user who revoked the subscription.  
Type: String

## Errors
<a name="API_RevokeSubscription_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_RevokeSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/RevokeSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/RevokeSubscription) 

# Search
<a name="API_Search"></a>

Searches for assets in Amazon DataZone.

Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.

Many search commands in Amazon DataZone are paginated, including `search` and `search-types`. When the result set is large, Amazon DataZone returns a `nextToken` in the response. This token can be used to retrieve the next page of results. 

Prerequisites:
+ The --domain-identifier must refer to an existing Amazon DataZone domain. 
+ --search-scope must be one of: ASSET, GLOSSARY\$1TERM, DATA\$1PRODUCT, or GLOSSARY.
+ The user must have search permissions in the specified domain.
+ If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys. 
+ For paginated results, be prepared to use --next-token to fetch additional pages.

To run a standard free-text search, the `searchText` parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the [CreateFormType API documentation](https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html). To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone\$1searchable.

To run a filtered search, provide filter clause using the `filters` parameter. To filter on glossary terms, use the special attribute `__DataZoneGlossaryTerms`. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with `@amazon.datazone#sortable`), provide a filter using the `intValue` parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with `@amazon.datazone#searchable` for free-text search). Create/update timestamp filtering is supported using the special `creationTime`/`lastUpdatedTime` attributes. Filter types can be mixed and matched to power complex queries.

 To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.

## Request Syntax
<a name="API_Search_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/search HTTP/1.1
Content-type: application/json

{
   "additionalAttributes": [ "string" ],
   "filters": { ... },
   "maxResults": number,
   "nextToken": "string",
   "owningProjectIdentifier": "string",
   "searchIn": [ 
      { 
         "attribute": "string"
      }
   ],
   "searchScope": "string",
   "searchText": "string",
   "sort": { 
      "attribute": "string",
      "order": "string"
   }
}
```

## URI Request Parameters
<a name="API_Search_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_Search_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [additionalAttributes](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-additionalAttributes"></a>
Specifies additional attributes for the `Search` action.  
Type: Array of strings  
Valid Values: `FORMS | TIME_SERIES_DATA_POINT_FORMS | TEXT_MATCH_RATIONALE`   
Required: No

 ** [filters](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-filters"></a>
Specifies the search filters.  
Type: [FilterClause](API_FilterClause.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [maxResults](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-maxResults"></a>
The maximum number of results to return in a single call to `Search`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `Search` to list the next set of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-nextToken"></a>
When the number of results is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `Search` to list the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [owningProjectIdentifier](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-owningProjectIdentifier"></a>
The identifier of the owning project specified for the search.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [searchIn](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-searchIn"></a>
The details of the search.  
Type: Array of [SearchInItem](API_SearchInItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [searchScope](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-searchScope"></a>
The scope of the search.  
Type: String  
Valid Values: `ASSET | GLOSSARY | GLOSSARY_TERM | DATA_PRODUCT`   
Required: Yes

 ** [searchText](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-searchText"></a>
Specifies the text for which to search.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** [sort](#API_Search_RequestSyntax) **   <a name="datazone-Search-request-sort"></a>
Specifies the way in which the search results are to be sorted.  
Type: [SearchSort](API_SearchSort.md) object  
Required: No

## Response Syntax
<a name="API_Search_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { ... }
   ],
   "nextToken": "string",
   "totalMatchCount": number
}
```

## Response Elements
<a name="API_Search_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_Search_ResponseSyntax) **   <a name="datazone-Search-response-items"></a>
The results of the `Search` action.  
Type: Array of [SearchInventoryResultItem](API_SearchInventoryResultItem.md) objects

 ** [nextToken](#API_Search_ResponseSyntax) **   <a name="datazone-Search-response-nextToken"></a>
When the number of results is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `Search` to list the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [totalMatchCount](#API_Search_ResponseSyntax) **   <a name="datazone-Search-response-totalMatchCount"></a>
Total number of search results.  
Type: Integer

## Errors
<a name="API_Search_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_Search_Examples"></a>

### Example
<a name="API_Search_Example_1"></a>

This example illustrates one usage of Search.

#### Sample Request
<a name="API_Search_Example_1_Request"></a>

```
 aws datazone search \
--domain-identifier "dzd_53ielnpxktdilj" \
--search-scope "GLOSSARY_TERM"
```

#### Sample Response
<a name="API_Search_Example_1_Response"></a>

```
{
    "items": [
        {
            "glossaryTermItem": {
                "createdAt": 1752766662.222,
                "createdBy": "usr7nx82mkl",
                "domainId": "dzd_53ielnpxktdilj",
                "glossaryId": "gls8m3nqx2wkfp",
                "id": "trm9k4pq7xwnmh",
                "name": "CustomerLifetimeValue",
                "status": "ENABLED",
                "updatedAt": 1752766662.222,
                "updatedBy": "usr7nx82mkl"
            }
        },
        {
            "glossaryTermItem": {
                "createdAt": 1752674736.91,
                "createdBy": "usr7nx82mkl",
                "domainId": "dzd_53ielnpxktdilj",
                "glossaryId": "gls8m3nqx2wkfp",
                "id": "trm8p2mq3xvn5",
                "name": "ChurnRisk",
                "status": "ENABLED",
                "updatedAt": 1752766697.481,
                "updatedBy": "usr7nx82mkl"
            }
        }
    ],
    "totalMatchCount": 2
}
```

### Example
<a name="API_Search_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_Search_Example_2_Request"></a>

```
aws datazone search \
--search-scope "GLOSSARY_TERM"
```

#### Sample Response
<a name="API_Search_Example_2_Response"></a>

```
aws: error: the following arguments are required: —domain-identifier
```

### Example
<a name="API_Search_Example_3"></a>

Failure case - invalid input:

#### Sample Request
<a name="API_Search_Example_3_Request"></a>

```
aws datazone search \
--domain-identifier "dzd_53ielnpxktdilj" \
--search-scope "INVALID_SCOPE"
```

#### Sample Response
<a name="API_Search_Example_3_Response"></a>

```
An error occurred (ValidationException) when calling the Search operation: 1 validation error detected: Value at 'searchScope' failed to satisfy constraint: Member must satisfy enum value set: [GLOSSARY_TERM, ASSET, DATA_PRODUCT, GLOSSARY]
```

### Example
<a name="API_Search_Example_4"></a>

Failure case - invalid JSON:

#### Sample Request
<a name="API_Search_Example_4_Request"></a>

```
aws datazone search \
--domain-identifier "dzd_53ielnpxktdilj" \
--search-scope "GLOSSARY_TERM" \
--filters '[{attribute:"NAME",value:"Term"}]'
```

#### Sample Response
<a name="API_Search_Example_4_Response"></a>

```
Error parsing parameter '--filters': Invalid JSON:
[{attribute:"NAME",value:"Term"}]
```

### Example
<a name="API_Search_Example_5"></a>

This example illustrates a technical identifier search (assuming the `technicalField` attribute is indexed for TECHNICAL search). For more information, see [https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/](https://aws.amazon.com/blogs/big-data/streamline-data-discovery-with-precise-technical-identifier-search-in-amazon-sagemaker-unified-studio/).

#### Sample Request
<a name="API_Search_Example_5_Request"></a>

```
aws datazone search \
--domain-identifier "dzd_4q2el0k35ngqa8" \
--search-in '[{"attribute":"name"}]' \
--search-text "\"blab\"" \
--search-scope "ASSET" \
--owning-project-identifier "4mo2oiauaqbrtc"
```

#### Sample Response
<a name="API_Search_Example_5_Response"></a>

```
{
    "items": [
        {
            "assetItem": {
                "createdAt": "2025-09-05T16:54:05.078000+00:00",
                "createdBy": "f697efa1-8b40-41c1-b1ef-977412f9d3d4",
                "firstRevisionCreatedAt": "2025-09-05T16:53:55.563000+00:00",
                "firstRevisionCreatedBy": "f697efa1-8b40-41c1-b1ef-977412f9d3d4",
                "glossaryTerms": [
                    "cxjyge917oaaa8"
                ],
                "identifier": "dgutcpgqbkbcsw",
                "name": "blab",
                "owningProjectId": "4mo2oiauaqbrtc",
                "typeIdentifier": "amazon.datazone.S3ObjectCollectionAssetType",
                "typeRevision": "14"
            }
        }
    ],
    "totalMatchCount": 1
}
```

### Example
<a name="API_Search_Example_6"></a>

This example illustrates the numeric filtering capabilities of the Search API. In this case only assets which have an attribute value between the specified filter values will be returned. Only numeric attributes annotated with `@amazon.datazone#sortable` may be used for numeric filtering.

#### Sample Request
<a name="API_Search_Example_6_Request"></a>

```
aws datazone search \
--domain-identifier "dzd_4q2el0k35ngqa8" \
--search-scope "ASSET" \
--owning-project-identifier "4mo2oiauaqbrtc" \
--filters '{ "and": [
        { "filter": { "attribute": "MyCustomForm.numericAttribute", "intValue": 5, "operator": "LT" } },
        { "filter": { "attribute": "MyCustomForm.numericAttribute", "intValue": 2, "operator": "GT" } }
    ] }'
```

### Example
<a name="API_Search_Example_7"></a>

This example illustrates the advanced free-text search capabilities of the Search API via filter clauses. In this example, only assets that match the respective search clauses in both attributes will be returned. Only string attributes annotated with `@amazon.datazone#searchable` may be used for free-text search.

#### Sample Request
<a name="API_Search_Example_7_Request"></a>

```
aws datazone search \
--domain-identifier "dzd_4q2el0k35ngqa8" \
--search-scope "ASSET" \
--owning-project-identifier "4mo2oiauaqbrtc" \
--filters '{ "and": [
        { "filter": { "attribute": "MyCustomForm.attr1", "value": "rat", "operator": "TEXT_SEARCH" } },
        { "filter": { "attribute": "MyCustomForm.attr2", "value": "reproductive study", "operator": "TEXT_SEARCH" } }
    ] }'
```

### Example
<a name="API_Search_Example_8"></a>

This example illustrates timestamp filtering using the Search API. In this example, only assets that have been updated since the provided epoch ms timestamp are returned. Currently, only `creationTime`/`lastUpdatedTime` attributes are supported for timestamp filtering.

#### Sample Request
<a name="API_Search_Example_8_Request"></a>

```
aws datazone search \
--domain-identifier "dzd_4q2el0k35ngqa8" \
--search-scope "ASSET" \
--owning-project-identifier "4mo2oiauaqbrtc" \
--filters '{ "filter": { "attribute": "lastUpdatedAt", "intValue": 1768437337867, "operator": "GE" } }'
```

## See Also
<a name="API_Search_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/Search) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/Search) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/Search) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/Search) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/Search) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/Search) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/Search) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/Search) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/Search) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/Search) 

# SearchGroupProfiles
<a name="API_SearchGroupProfiles"></a>

Searches group profiles in Amazon DataZone.

## Request Syntax
<a name="API_SearchGroupProfiles_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/search-group-profiles HTTP/1.1
Content-type: application/json

{
   "groupType": "string",
   "maxResults": number,
   "nextToken": "string",
   "searchText": "string"
}
```

## URI Request Parameters
<a name="API_SearchGroupProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_SearchGroupProfiles_RequestSyntax) **   <a name="datazone-SearchGroupProfiles-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which you want to search group profiles.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_SearchGroupProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [groupType](#API_SearchGroupProfiles_RequestSyntax) **   <a name="datazone-SearchGroupProfiles-request-groupType"></a>
The group type for which to search.  
Type: String  
Valid Values: `SSO_GROUP | DATAZONE_SSO_GROUP | IAM_ROLE_SESSION_GROUP`   
Required: Yes

 ** [maxResults](#API_SearchGroupProfiles_RequestSyntax) **   <a name="datazone-SearchGroupProfiles-request-maxResults"></a>
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.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_SearchGroupProfiles_RequestSyntax) **   <a name="datazone-SearchGroupProfiles-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [searchText](#API_SearchGroupProfiles_RequestSyntax) **   <a name="datazone-SearchGroupProfiles-request-searchText"></a>
Specifies the text for which to search.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

## Response Syntax
<a name="API_SearchGroupProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "domainId": "string",
         "groupName": "string",
         "id": "string",
         "rolePrincipalArn": "string",
         "rolePrincipalId": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_SearchGroupProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_SearchGroupProfiles_ResponseSyntax) **   <a name="datazone-SearchGroupProfiles-response-items"></a>
The results of the `SearchGroupProfiles` action.  
Type: Array of [GroupProfileSummary](API_GroupProfileSummary.md) objects

 ** [nextToken](#API_SearchGroupProfiles_ResponseSyntax) **   <a name="datazone-SearchGroupProfiles-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_SearchGroupProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SearchGroupProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/SearchGroupProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/SearchGroupProfiles) 

# SearchListings
<a name="API_SearchListings"></a>

Searches listings in Amazon DataZone.

SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.

SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results.

The SearchListings API gives users flexibility in specifying what kind of search is run.

To run a standard free-text search, the `searchText` parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the [CreateFormType API documentation](https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html). To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone\$1searchable.

To run a filtered search, provide filter clause using the `filters` parameter. To filter on glossary terms, use the special attribute `__DataZoneGlossaryTerms`. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with `@amazon.datazone#sortable`), provide a filter using the `intValue` parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with `@amazon.datazone#searchable` for free-text search). Create/update timestamp filtering is supported using the special `creationTime`/`lastUpdatedTime` attributes. Filter types can be mixed and matched to power complex queries.

 To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.

## Request Syntax
<a name="API_SearchListings_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/listings/search HTTP/1.1
Content-type: application/json

{
   "additionalAttributes": [ "string" ],
   "aggregations": [ 
      { 
         "attribute": "string",
         "displayValue": "string"
      }
   ],
   "filters": { ... },
   "maxResults": number,
   "nextToken": "string",
   "searchIn": [ 
      { 
         "attribute": "string"
      }
   ],
   "searchText": "string",
   "sort": { 
      "attribute": "string",
      "order": "string"
   }
}
```

## URI Request Parameters
<a name="API_SearchListings_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-uri-domainIdentifier"></a>
The identifier of the domain in which to search listings.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_SearchListings_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [additionalAttributes](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-additionalAttributes"></a>
Specifies additional attributes for the search.  
Type: Array of strings  
Valid Values: `FORMS | TIME_SERIES_DATA_POINT_FORMS | TEXT_MATCH_RATIONALE`   
Required: No

 ** [aggregations](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-aggregations"></a>
Enables you to specify one or more attributes to compute and return counts grouped by field values.  
Type: Array of [AggregationListItem](API_AggregationListItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [filters](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-filters"></a>
Specifies the filters for the search of listings.  
Type: [FilterClause](API_FilterClause.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [maxResults](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-maxResults"></a>
The maximum number of results to return in a single call to `SearchListings`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `SearchListings` to list the next set of results.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-nextToken"></a>
When the number of results is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchListings` to list the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [searchIn](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-searchIn"></a>
The details of the search.  
Type: Array of [SearchInItem](API_SearchInItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [searchText](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-searchText"></a>
Specifies the text for which to search.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Required: No

 ** [sort](#API_SearchListings_RequestSyntax) **   <a name="datazone-SearchListings-request-sort"></a>
Specifies the way for sorting the search results.  
Type: [SearchSort](API_SearchSort.md) object  
Required: No

## Response Syntax
<a name="API_SearchListings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aggregates": [ 
      { 
         "attribute": "string",
         "displayValue": "string",
         "items": [ 
            { 
               "count": number,
               "displayValue": "string",
               "value": "string"
            }
         ]
      }
   ],
   "items": [ 
      { ... }
   ],
   "nextToken": "string",
   "totalMatchCount": number
}
```

## Response Elements
<a name="API_SearchListings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aggregates](#API_SearchListings_ResponseSyntax) **   <a name="datazone-SearchListings-response-aggregates"></a>
Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.  
Type: Array of [AggregationOutput](API_AggregationOutput.md) objects

 ** [items](#API_SearchListings_ResponseSyntax) **   <a name="datazone-SearchListings-response-items"></a>
The results of the `SearchListings` action.  
Type: Array of [SearchResultItem](API_SearchResultItem.md) objects

 ** [nextToken](#API_SearchListings_ResponseSyntax) **   <a name="datazone-SearchListings-response-nextToken"></a>
When the number of results is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchListings` to list the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [totalMatchCount](#API_SearchListings_ResponseSyntax) **   <a name="datazone-SearchListings-response-totalMatchCount"></a>
Total number of search results.  
Type: Integer

## Errors
<a name="API_SearchListings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_SearchListings_Examples"></a>

### Example
<a name="API_SearchListings_Example_1"></a>

This example illustrates a lexical search. 

#### Sample Request
<a name="API_SearchListings_Example_1_Request"></a>

```
aws datazone search-listings \
--domain-identifier "dzd_4q2el0k35ngqa8" \
--search-in '[{"attribute":"DataProductMetadataForm.name"}]' \
--search-text "\"car\"" \
--additional-attributes '["FORMS"]'
```

#### Sample Response
<a name="API_SearchListings_Example_1_Response"></a>

```
{
    "items": [
        {
            "assetListing": {
                "additionalAttributes": {
                    "forms": "{\"S3ObjectCollectionForm\":{\"bucketArn\":\"arn:aws:s3:::bucket/prefix\"},\"DataProductMetadataForm\":{\"name\":\"car\"}}"
                },
                "createdAt": "2025-08-28T21:41:17.026000+00:00",
                "entityId": "asl5ff7g6psoi8",
                "entityRevision": "4",
                "entityType": "S3ObjectCollectionAssetType",
                "glossaryTerms": [],
                "listingCreatedBy": "f697efa1-8b40-41c1-b1ef-977412f9d3d4",
                "listingId": "3tgx25pz22pic0",
                "listingRevision": "6",
                "listingUpdatedBy": "f697efa1-8b40-41c1-b1ef-977412f9d3d4",
                "name": "test",
                "owningProjectId": "4mo2oiauaqbrtc"
            }
        }
    ],
    "totalMatchCount": 1
}
```

### Example
<a name="API_SearchListings_Example_2"></a>

This example illustrates the filtering capabilities of the SearchListings APIs. Note: `__DataZoneGlossaryTerms` is a special keyword for getting all aggregated glossary terms across assets, custom metadata forms and columns. 

#### Sample Request
<a name="API_SearchListings_Example_2_Request"></a>

```
aws datazone search-listings \
    --domain-identifier "dzd_4q2el0k35ngqa8" \
    --filters '{ "or": [
        { "filter": { "attribute": "__DataZoneGlossaryTerms", "value": "cxjyge917oaaa8" } },
        { "filter": { "attribute": "__DataZoneGlossaryTerms", "value": "46i8vpwe0s0t9j" } }
    ] }'
```

#### Sample Response
<a name="API_SearchListings_Example_2_Response"></a>

```
{
    "items": [
        {
            "assetListing": {
                "createdAt": "2025-09-05T16:53:55.563000+00:00",
                "entityId": "dgutcpgqbkbcsw",
                "entityRevision": "2",
                "entityType": "S3ObjectCollectionAssetType",
                "glossaryTerms": [
                    {
                        "name": "artist"
                    }
                ],
                "listingCreatedBy": "f697efa1-8b40-41c1-b1ef-977412f9d3d4",
                "listingId": "anj2uue0h4qd1s",
                "listingRevision": "2",
                "listingUpdatedBy": "f697efa1-8b40-41c1-b1ef-977412f9d3d4",
                "name": "blab",
                "owningProjectId": "4mo2oiauaqbrtc"
            }
        }
    ],
    "totalMatchCount": 1
}
```

### Example
<a name="API_SearchListings_Example_3"></a>

This example illustrates the numeric filtering capabilities of the SearchListing API. In this case, only listings which have an attribute value between the specified filter values will be returned. Only numeric attributes annotated with `@amazon.datazone#sortable` may be used for numeric filtering. 

#### Sample Request
<a name="API_SearchListings_Example_3_Request"></a>

```
aws datazone search-listings \
    --domain-identifier "dzd_4q2el0k35ngqa8" \
    --filters '{ "and": [
        { "filter": { "attribute": "MyCustomForm.numericAttribute", "intValue": 5, "operator": "LT" } },
        { "filter": { "attribute": "MyCustomForm.numericAttribute", "intValue": 2, "operator": "GT" } }
    ] }'
```

### Example
<a name="API_SearchListings_Example_4"></a>

This example illustrates the advanced free-text search capabilities of the SearchListing API via filter clauses. In this example, only listings that match the respective search clauses in both attributes will be returned. Only string attributes annotated with `@amazon.datazone#searchable` may be used for free-text search.

#### Sample Request
<a name="API_SearchListings_Example_4_Request"></a>

```
aws datazone search-listings \
    --domain-identifier "dzd_4q2el0k35ngqa8" \
    --filters '{ "and": [
        { "filter": { "attribute": "MyCustomForm.attr1", "value": "rat", "operator": "TEXT_SEARCH" } },
        { "filter": { "attribute": "MyCustomForm.attr2", "value": "reproductive study", "operator": "TEXT_SEARCH" } }
    ] }'
```

### Example
<a name="API_SearchListings_Example_5"></a>

This example illustrates timestamp filtering using the SearchListing API. In this example, only listings that have been updated since the provided epoch ms timestamp are returned. Currently, only `creationTime`/`lastUpdatedTime` attributes are supported for timestamp filtering.

#### Sample Request
<a name="API_SearchListings_Example_5_Request"></a>

```
aws datazone search-listings \
    --domain-identifier "dzd_4q2el0k35ngqa8" \
    --filters '{ "filter": { "attribute": "lastUpdatedAt", "intValue": 1768437337867, "operator": "GE" } }'
```

## See Also
<a name="API_SearchListings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/SearchListings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/SearchListings) 

# SearchTypes
<a name="API_SearchTypes"></a>

Searches for types in Amazon DataZone.

Prerequisites:
+ The --domain-identifier must refer to an existing Amazon DataZone domain. 
+ --search-scope must be one of the valid values including: ASSET\$1TYPE, GLOSSARY\$1TERM\$1TYPE, DATA\$1PRODUCT\$1TYPE.
+ The --managed flag must be present without a value.
+ The user must have permissions for form or asset types in the domain.
+ If using --filters, ensure that the JSON is valid.
+ Filters contain correct structure (attribute, value, operator).

## Request Syntax
<a name="API_SearchTypes_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/types-search HTTP/1.1
Content-type: application/json

{
   "filters": { ... },
   "managed": boolean,
   "maxResults": number,
   "nextToken": "string",
   "searchIn": [ 
      { 
         "attribute": "string"
      }
   ],
   "searchScope": "string",
   "searchText": "string",
   "sort": { 
      "attribute": "string",
      "order": "string"
   }
}
```

## URI Request Parameters
<a name="API_SearchTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which to invoke the `SearchTypes` action.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_SearchTypes_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-filters"></a>
The filters for the `SearchTypes` action.  
Type: [FilterClause](API_FilterClause.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [managed](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-managed"></a>
Specifies whether the search is managed.  
Type: Boolean  
Required: Yes

 ** [maxResults](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-maxResults"></a>
The maximum number of results to return in a single call to `SearchTypes`. When the number of results to be listed is greater than the value of `MaxResults`, the response contains a `NextToken` value that you can use in a subsequent call to `SearchTypes` to list the next set of results.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-nextToken"></a>
When the number of results is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchTypes` to list the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [searchIn](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-searchIn"></a>
The details of the search.  
Type: Array of [SearchInItem](API_SearchInItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [searchScope](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-searchScope"></a>
Specifies the scope of the search for types.  
Type: String  
Valid Values: `ASSET_TYPE | FORM_TYPE | LINEAGE_NODE_TYPE`   
Required: Yes

 ** [searchText](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-searchText"></a>
Specifies the text for which to search.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** [sort](#API_SearchTypes_RequestSyntax) **   <a name="datazone-SearchTypes-request-sort"></a>
The specifies the way to sort the `SearchTypes` results.  
Type: [SearchSort](API_SearchSort.md) object  
Required: No

## Response Syntax
<a name="API_SearchTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { ... }
   ],
   "nextToken": "string",
   "totalMatchCount": number
}
```

## Response Elements
<a name="API_SearchTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_SearchTypes_ResponseSyntax) **   <a name="datazone-SearchTypes-response-items"></a>
The results of the `SearchTypes` action.  
Type: Array of [SearchTypesResultItem](API_SearchTypesResultItem.md) objects

 ** [nextToken](#API_SearchTypes_ResponseSyntax) **   <a name="datazone-SearchTypes-response-nextToken"></a>
When the number of results is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of results, the response includes a pagination token named `NextToken`. You can specify this `NextToken` value in a subsequent call to `SearchTypes` to list the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

 ** [totalMatchCount](#API_SearchTypes_ResponseSyntax) **   <a name="datazone-SearchTypes-response-totalMatchCount"></a>
Total number of search results.  
Type: Integer

## Errors
<a name="API_SearchTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_SearchTypes_Examples"></a>

### Example
<a name="API_SearchTypes_Example_1"></a>

This example illustrates one usage of SearchTypes.

#### Sample Request
<a name="API_SearchTypes_Example_1_Request"></a>

```
aws datazone search-types \
--domain-identifier "dzd_53ielnpxktdilj" \
--search-scope "ASSET_TYPE" \
--managed
```

#### Sample Response
<a name="API_SearchTypes_Example_1_Response"></a>

```
{
    "items": [
        {
            "assetTypeItem": {
                "createdAt": 1752170908.272,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": true,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "SageMakerFeatureGroupForm": {
                        "required": true,
                        "typeName": "amazon.datazone.SageMakerFeatureGroupFormType",
                        "typeRevision": "1"
                    }
                },
                "name": "amazon.datazone.SageMakerFeatureGroupAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "1",
                "updatedAt": 1752170908.272,
                "updatedBy": "SYSTEM"
            }
        },
        {
            "assetTypeItem": {
                "createdAt": 1748436962.064,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "DataSourceReferenceForm": {
                        "required": false,
                        "typeName": "amazon.datazone.DataSourceReferenceFormType",
                        "typeRevision": "4"
                    },
                    "MskTopicForm": {
                        "required": true,
                        "typeName": "amazon.datazone.MskTopicFormType",
                        "typeRevision": "1"
                    },
                    "SchemaMetadataForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SchemaMetadataFormType",
                        "typeRevision": "1"
                    },
                    "SuggestionForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SuggestionFormType",
                        "typeRevision": "3"
                    }
                },
                "name": "amazon.datazone.MskTopicAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "3",
                "updatedAt": 1750698545.406,
                "updatedBy": "SYSTEM"
            }
        },
        {
            "assetTypeItem": {
                "createdAt": 1745604393.359,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "DataSourceReferenceForm": {
                        "required": false,
                        "typeName": "amazon.datazone.DataSourceReferenceFormType",
                        "typeRevision": "4"
                    },
                    "KinesisDataStreamForm": {
                        "required": true,
                        "typeName": "amazon.datazone.KinesisDataStreamFormType",
                        "typeRevision": "2"
                    },
                    "SchemaMetadataForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SchemaMetadataFormType",
                        "typeRevision": "1"
                    },
                    "SuggestionForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SuggestionFormType",
                        "typeRevision": "3"
                    }
                },
                "name": "amazon.datazone.KinesisDataStreamAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "5",
                "updatedAt": 1750698545.564,
                "updatedBy": "SYSTEM"
            }
        },
        {
            "assetTypeItem": {
                "createdAt": 1743523808.154,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "QuickSightDashboardForm": {
                        "required": true,
                        "typeName": "amazon.datazone.QuickSightDashboardFormType",
                        "typeRevision": "3"
                    },
                    "SubscriptionTermsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SubscriptionTermsFormType",
                        "typeRevision": "2"
                    }
                },
                "name": "amazon.datazone.QuickSightDashboardAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "3",
                "updatedAt": 1748436962.275,
                "updatedBy": "SYSTEM"
            }
        },
        {
            "assetTypeItem": {
                "createdAt": 1728920863.66,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "BedrockModelForm": {
                        "required": true,
                        "typeName": "amazon.datazone.BedrockModelFormType",
                        "typeRevision": "6"
                    },
                    "SubscriptionTermsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SubscriptionTermsFormType",
                        "typeRevision": "2"
                    }
                },
                "name": "amazon.datazone.BedrockModelAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "6",
                "updatedAt": 1746484563.478,
                "updatedBy": "SYSTEM"
            }
        },
        {
            "assetTypeItem": {
                "createdAt": 1728920864.133,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "BedrockAppCommonForm": {
                        "required": true,
                        "typeName": "amazon.datazone.BedrockAppCommonFormType",
                        "typeRevision": "2"
                    },
                    "SubscriptionTermsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SubscriptionTermsFormType",
                        "typeRevision": "2"
                    }
                },
                "name": "amazon.datazone.BedrockFlowAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "2",
                "updatedAt": 1730316044.425,
                "updatedBy": "SYSTEM"
            }
        },
        {
            "assetTypeItem": {
                "createdAt": 1728920864.056,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "BedrockAppCommonForm": {
                        "required": true,
                        "typeName": "amazon.datazone.BedrockAppCommonFormType",
                        "typeRevision": "2"
                    },
                    "SubscriptionTermsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SubscriptionTermsFormType",
                        "typeRevision": "2"
                    }
                },
                "name": "amazon.datazone.BedrockPromptAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "2",
                "updatedAt": 1730316044.385,
                "updatedBy": "SYSTEM"
            }
        },
        {
            "assetTypeItem": {
                "createdAt": 1728920864.194,
                "createdBy": "SYSTEM",
                "domainId": "dzd_53ielnpxktdilj",
                "formsOutput": {
                    "AssetCommonDetailsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.AssetCommonDetailsFormType",
                        "typeRevision": "6"
                    },
                    "BedrockAppCommonForm": {
                        "required": true,
                        "typeName": "amazon.datazone.BedrockAppCommonFormType",
                        "typeRevision": "2"
                    },
                    "SubscriptionTermsForm": {
                        "required": false,
                        "typeName": "amazon.datazone.SubscriptionTermsFormType",
                        "typeRevision": "2"
                    }
                },
                "name": "amazon.datazone.BedrockChatAssetType",
                "originDomainId": "dzd_amazon_datazone_domain",
                "originProjectId": "dzd_amazon_datazone_domain_project",
                "owningProjectId": "dzd_amazon_datazone_domain_project",
                "revision": "2",
                "updatedAt": 1730316044.502,
                "updatedBy": "SYSTEM"
            }
        }
    ],
    "totalMatchCount": 20
}
```

### Example
<a name="API_SearchTypes_Example_2"></a>

Failuse case - missing parameter:

#### Sample Request
<a name="API_SearchTypes_Example_2_Request"></a>

```
aws datazone search-types \
--domain-identifier "dzd_53ielnpxktdilj" \
--search-scope "ASSET_TYPE"
```

#### Sample Response
<a name="API_SearchTypes_Example_2_Response"></a>

```
Parameter validation failed:
Missing required parameter in input: "managed"
```

### Example
<a name="API_SearchTypes_Example_3"></a>

Failure case - invalid JSON:

#### Sample Request
<a name="API_SearchTypes_Example_3_Request"></a>

```
aws datazone search-types \
--domain-identifier "dzd_53ielnpxktdilj" \
--search-scope "ASSET_TYPE" \
--filters '[{attribute:"TYPE",value:"ASSET"}]'
```

#### Sample Response
<a name="API_SearchTypes_Example_3_Response"></a>

```
Error parsing parameter '—filters': Invalid JSON:
[{attribute:"TYPE",value:"ASSET"}]
```

### Example
<a name="API_SearchTypes_Example_4"></a>

Failure case - invalid input:

#### Sample Request
<a name="API_SearchTypes_Example_4_Request"></a>

```
aws datazone search-types \
--domain-identifier "dzd_53ielnpxktdilj" \
--search-scope "ASSET_TYPE" \
--managed true
```

#### Sample Response
<a name="API_SearchTypes_Example_4_Response"></a>

```
Unknown options: true
```

## See Also
<a name="API_SearchTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/SearchTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/SearchTypes) 

# SearchUserProfiles
<a name="API_SearchUserProfiles"></a>

Searches user profiles in Amazon DataZone.

## Request Syntax
<a name="API_SearchUserProfiles_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/search-user-profiles HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "searchText": "string",
   "userType": "string"
}
```

## URI Request Parameters
<a name="API_SearchUserProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_SearchUserProfiles_RequestSyntax) **   <a name="datazone-SearchUserProfiles-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which you want to search user profiles.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_SearchUserProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_SearchUserProfiles_RequestSyntax) **   <a name="datazone-SearchUserProfiles-request-maxResults"></a>
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.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_SearchUserProfiles_RequestSyntax) **   <a name="datazone-SearchUserProfiles-request-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [searchText](#API_SearchUserProfiles_RequestSyntax) **   <a name="datazone-SearchUserProfiles-request-searchText"></a>
Specifies the text for which to search.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [userType](#API_SearchUserProfiles_RequestSyntax) **   <a name="datazone-SearchUserProfiles-request-userType"></a>
Specifies the user type for the `SearchUserProfiles` action.  
Type: String  
Valid Values: `SSO_USER | DATAZONE_USER | DATAZONE_SSO_USER | DATAZONE_IAM_USER`   
Required: Yes

## Response Syntax
<a name="API_SearchUserProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "details": { ... },
         "domainId": "string",
         "id": "string",
         "status": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_SearchUserProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [items](#API_SearchUserProfiles_ResponseSyntax) **   <a name="datazone-SearchUserProfiles-response-items"></a>
The results of the `SearchUserProfiles` action.  
Type: Array of [UserProfileSummary](API_UserProfileSummary.md) objects

 ** [nextToken](#API_SearchUserProfiles_ResponseSyntax) **   <a name="datazone-SearchUserProfiles-response-nextToken"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.

## Errors
<a name="API_SearchUserProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_SearchUserProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/SearchUserProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/SearchUserProfiles) 

# StartDataSourceRun
<a name="API_StartDataSourceRun"></a>

Start the run of the specified data source in Amazon DataZone.

## Request Syntax
<a name="API_StartDataSourceRun_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/data-sources/dataSourceIdentifier/runs HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_StartDataSourceRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceIdentifier](#API_StartDataSourceRun_RequestSyntax) **   <a name="datazone-StartDataSourceRun-request-uri-dataSourceIdentifier"></a>
The identifier of the data source.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_StartDataSourceRun_RequestSyntax) **   <a name="datazone-StartDataSourceRun-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which to start a data source run.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_StartDataSourceRun_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartDataSourceRun_RequestSyntax) **   <a name="datazone-StartDataSourceRun-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Required: No

## Response Syntax
<a name="API_StartDataSourceRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "dataSourceConfigurationSnapshot": "string",
   "dataSourceId": "string",
   "domainId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "projectId": "string",
   "runStatisticsForAssets": { 
      "added": number,
      "failed": number,
      "skipped": number,
      "unchanged": number,
      "updated": number
   },
   "startedAt": "string",
   "status": "string",
   "stoppedAt": "string",
   "type": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_StartDataSourceRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-createdAt"></a>
The timestamp of when data source run was created.  
Type: Timestamp

 ** [dataSourceConfigurationSnapshot](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-dataSourceConfigurationSnapshot"></a>
The configuration snapshot of the data source that is being run.  
Type: String

 ** [dataSourceId](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-dataSourceId"></a>
The identifier of the data source.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [domainId](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-domainId"></a>
The identifier of the Amazon DataZone domain in which to start a data source run.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [errorMessage](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-errorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [id](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-id"></a>
The identifier of the data source run.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [projectId](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-projectId"></a>
The identifier of the project.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [runStatisticsForAssets](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-runStatisticsForAssets"></a>
Specifies run statistics for assets.  
Type: [RunStatisticsForAssets](API_RunStatisticsForAssets.md) object

 ** [startedAt](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-startedAt"></a>
The timestamp of when the data source run was started.  
Type: Timestamp

 ** [status](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-status"></a>
The status of the data source run.  
Type: String  
Valid Values: `REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS` 

 ** [stoppedAt](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-stoppedAt"></a>
The timestamp of when the data source run was stopped.  
Type: Timestamp

 ** [type](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-type"></a>
The type of the data source run.  
Type: String  
Valid Values: `PRIORITIZED | SCHEDULED` 

 ** [updatedAt](#API_StartDataSourceRun_ResponseSyntax) **   <a name="datazone-StartDataSourceRun-response-updatedAt"></a>
The timestamp of when the data source run was updated.  
Type: Timestamp

## Errors
<a name="API_StartDataSourceRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_StartDataSourceRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/StartDataSourceRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/StartDataSourceRun) 

# StartMetadataGenerationRun
<a name="API_StartMetadataGenerationRun"></a>

Starts the metadata generation run.

Prerequisites:
+ Asset must be created and belong to the specified domain and project. 
+ Asset type must be supported for metadata generation (e.g., AWS Glue table).
+ Asset must have a structured schema with valid rows and columns.
+ Valid values for --type: BUSINESS\$1DESCRIPTIONS, BUSINESS\$1NAMES, BUSINESS\$1GLOSSARY\$1ASSOCIATIONS.
+ The user must have permission to run metadata generation in the domain/project.

## Request Syntax
<a name="API_StartMetadataGenerationRun_RequestSyntax"></a>

```
POST /v2/domains/domainIdentifier/metadata-generation-runs HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "owningProjectIdentifier": "string",
   "target": { 
      "identifier": "string",
      "revision": "string",
      "type": "string"
   },
   "type": "string",
   "types": [ "string" ]
}
```

## URI Request Parameters
<a name="API_StartMetadataGenerationRun_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_StartMetadataGenerationRun_RequestSyntax) **   <a name="datazone-StartMetadataGenerationRun-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where you want to start a metadata generation run.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_StartMetadataGenerationRun_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_StartMetadataGenerationRun_RequestSyntax) **   <a name="datazone-StartMetadataGenerationRun-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [owningProjectIdentifier](#API_StartMetadataGenerationRun_RequestSyntax) **   <a name="datazone-StartMetadataGenerationRun-request-owningProjectIdentifier"></a>
The ID of the project that owns the asset for which you want to start a metadata generation run.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [target](#API_StartMetadataGenerationRun_RequestSyntax) **   <a name="datazone-StartMetadataGenerationRun-request-target"></a>
The asset for which you want to start a metadata generation run.  
Type: [MetadataGenerationRunTarget](API_MetadataGenerationRunTarget.md) object  
Required: Yes

 ** [type](#API_StartMetadataGenerationRun_RequestSyntax) **   <a name="datazone-StartMetadataGenerationRun-request-type"></a>
 *This parameter has been deprecated.*   
The type of the metadata generation run.  
Type: String  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS`   
Required: No

 ** [types](#API_StartMetadataGenerationRun_RequestSyntax) **   <a name="datazone-StartMetadataGenerationRun-request-types"></a>
The types of the metadata generation run.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS`   
Required: No

## Response Syntax
<a name="API_StartMetadataGenerationRun_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "id": "string",
   "owningProjectId": "string",
   "status": "string",
   "type": "string",
   "types": [ "string" ]
}
```

## Response Elements
<a name="API_StartMetadataGenerationRun_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-createdAt"></a>
The timestamp at which the metadata generation run was started.  
Type: Timestamp

 ** [createdBy](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-createdBy"></a>
The ID of the user who started the metadata generation run.  
Type: String

 ** [domainId](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-domainId"></a>
The ID of the Amazon DataZone domain in which the metadata generation run was started.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-id"></a>
The ID of the metadata generation run.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [owningProjectId](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-owningProjectId"></a>
The ID of the project that owns the asset for which the metadata generation run was started.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-status"></a>
The status of the metadata generation run.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | CANCELED | SUCCEEDED | FAILED | PARTIALLY_SUCCEEDED` 

 ** [type](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-type"></a>
 *This parameter has been deprecated.*   
The type of the metadata generation run.  
Type: String  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS` 

 ** [types](#API_StartMetadataGenerationRun_ResponseSyntax) **   <a name="datazone-StartMetadataGenerationRun-response-types"></a>
The types of the metadata generation run.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Valid Values: `BUSINESS_DESCRIPTIONS | BUSINESS_NAMES | BUSINESS_GLOSSARY_ASSOCIATIONS` 

## Errors
<a name="API_StartMetadataGenerationRun_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_StartMetadataGenerationRun_Examples"></a>

### Example
<a name="API_StartMetadataGenerationRun_Example_1"></a>

This example illustrates one usage of StartMetadataGenerationRun.

#### Sample Request
<a name="API_StartMetadataGenerationRun_Example_1_Request"></a>

```
aws datazone start-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--target '{
    "identifier": "ast6br2md6v9h",
    "revision": "1",
    "type": "ASSET"
}' \
--types ["BUSINESS_DESCRIPTIONS"]
```

#### Sample Response
<a name="API_StartMetadataGenerationRun_Example_1_Response"></a>

```
{
    "createdAt": 1752644436.666,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "id": "mgr5g0fy285m1q",
    "owningProjectId": "prj7nx82mkl",
    "status": "IN_PROGRESS",
    "types": ["BUSINESS_DESCRIPTIONS"]
}
```

### Example
<a name="API_StartMetadataGenerationRun_Example_2"></a>

Failure case - missing parameter:

#### Sample Request
<a name="API_StartMetadataGenerationRun_Example_2_Request"></a>

```
aws datazone start-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj"
```

#### Sample Response
<a name="API_StartMetadataGenerationRun_Example_2_Response"></a>

```
aws: error: the following arguments are required: —owning-project-identifier, —target
```

### Example
<a name="API_StartMetadataGenerationRun_Example_3"></a>

Failure case - invalid JSON:

#### Sample Request
<a name="API_StartMetadataGenerationRun_Example_3_Request"></a>

```
aws datazone start-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--target '{"identifier": "ast7k9mpq2xvn4", "revision": "1", "type": "ASSET"' \
--types ["BUSINESS_DESCRIPTIONS"]
```

#### Sample Response
<a name="API_StartMetadataGenerationRun_Example_3_Response"></a>

```
Error parsing parameter '--target': Invalid JSON: Expecting ',' delimiter: line 1 column 58 (char 57)
JSON received: {"identifier": "ast7k9mpq2xvn4", "revision": "1", "type": "ASSET"
```

### Example
<a name="API_StartMetadataGenerationRun_Example_4"></a>

Failuse case - invalid input:

#### Sample Request
<a name="API_StartMetadataGenerationRun_Example_4_Request"></a>

```
aws datazone start-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--target '{"identifier": "ast7k9mpq2xvn4", "revision": "1", "type": "ASSET"}' \
--type "INVALID_TYPE"
```

#### Sample Response
<a name="API_StartMetadataGenerationRun_Example_4_Response"></a>

```
An error occurred (ValidationException) when calling the StartMetadataGenerationRun operation: 1 validation error detected: Value at 'types' failed to satisfy constraint: Member must satisfy constraint: [Member must satisfy enum value set: [BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS, BUSINESS_DESCRIPTIONS]]
```

### Example
<a name="API_StartMetadataGenerationRun_Example_5"></a>

Failure case - resource not found:

#### Sample Request
<a name="API_StartMetadataGenerationRun_Example_5_Request"></a>

```
aws datazone start-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--target '{"identifier": "ast_nonexistent", "revision": "1", "type": "ASSET"}' \
--types ["BUSINESS_DESCRIPTIONS"]
```

#### Sample Response
<a name="API_StartMetadataGenerationRun_Example_5_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the StartMetadataGenerationRun operation: The given Asset doesn't exist. Try creating Asset before accessing it.
```

### Example
<a name="API_StartMetadataGenerationRun_Example_6"></a>

Failure case - not supported data type:

#### Sample Request
<a name="API_StartMetadataGenerationRun_Example_6_Request"></a>

```
aws datazone start-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--target '{
    "identifier": "ast7k9mpq2xvn4",
    "revision": "1",
    "type": "ASSET"
}' \
--types ["BUSINESS_DESCRIPTIONS"]
```

#### Sample Response
<a name="API_StartMetadataGenerationRun_Example_6_Response"></a>

```
An error occurred (ValidationException) when calling the StartMetadataGenerationRun operation: Metadata Descriptions Generation is not supported for input asset type
```

### Example
<a name="API_StartMetadataGenerationRun_Example_7"></a>

StartMetadataGenerationRun with multiple types:

#### Sample Request
<a name="API_StartMetadataGenerationRun_Example_7_Request"></a>

```
aws datazone start-metadata-generation-run \
--domain-identifier "dzd_53ielnpxktdilj" \
--owning-project-identifier "prj7nx82mkl" \
--target '{
    "identifier": "ast6br2md6v9h",
    "revision": "1",
    "type": "ASSET"
}' \
--types ["BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"]
```

#### Sample Response
<a name="API_StartMetadataGenerationRun_Example_7_Response"></a>

```
{
    "createdAt": 1752644436.666,
    "createdBy": "usr7nx82mkl",
    "domainId": "dzd_53ielnpxktdilj",
    "id": "mgr5g0fy285m1q",
    "owningProjectId": "prj7nx82mkl",
    "status": "IN_PROGRESS",
    "types": ["BUSINESS_DESCRIPTIONS", "BUSINESS_NAMES", "BUSINESS_GLOSSARY_ASSOCIATIONS"]
}
```

## See Also
<a name="API_StartMetadataGenerationRun_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/StartMetadataGenerationRun) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/StartMetadataGenerationRun) 

# TagResource
<a name="API_TagResource"></a>

Tags a resource in Amazon DataZone.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="datazone-TagResource-request-uri-resourceArn"></a>
The ARN of the resource to be tagged in Amazon DataZone.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="datazone-TagResource-request-tags"></a>
Specifies the tags for the `TagResource` action.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\w \.:/=+@-]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `[\w \.:/=+@-]*`   
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Untags a resource in Amazon DataZone.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="datazone-UntagResource-request-uri-resourceArn"></a>
The ARN of the resource to be untagged in Amazon DataZone.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="datazone-UntagResource-request-uri-tagKeys"></a>
Specifies the tag keys for the `UntagResource` action.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w \.:/=+@-]+`   
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UntagResource) 

# UpdateAccountPool
<a name="API_UpdateAccountPool"></a>

Updates the account pool.

## Request Syntax
<a name="API_UpdateAccountPool_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/account-pools/identifier HTTP/1.1
Content-type: application/json

{
   "accountSource": { ... },
   "description": "string",
   "name": "string",
   "resolutionStrategy": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAccountPool_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateAccountPool_RequestSyntax) **   <a name="datazone-UpdateAccountPool-request-uri-domainIdentifier"></a>
The domain ID where the account pool that is to be updated lives.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateAccountPool_RequestSyntax) **   <a name="datazone-UpdateAccountPool-request-uri-identifier"></a>
The ID of the account pool that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateAccountPool_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [accountSource](#API_UpdateAccountPool_RequestSyntax) **   <a name="datazone-UpdateAccountPool-request-accountSource"></a>
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom AWS Lambda handler.   
Type: [AccountSource](API_AccountSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_UpdateAccountPool_RequestSyntax) **   <a name="datazone-UpdateAccountPool-request-description"></a>
The description of the account pool that is to be udpated.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [name](#API_UpdateAccountPool_RequestSyntax) **   <a name="datazone-UpdateAccountPool-request-name"></a>
The name of the account pool that is to be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: No

 ** [resolutionStrategy](#API_UpdateAccountPool_RequestSyntax) **   <a name="datazone-UpdateAccountPool-request-resolutionStrategy"></a>
The mechanism used to resolve the account selection from the account pool.  
Type: String  
Valid Values: `MANUAL`   
Required: No

## Response Syntax
<a name="API_UpdateAccountPool_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accountSource": { ... },
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "resolutionStrategy": "string",
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_UpdateAccountPool_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [accountSource](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-accountSource"></a>
The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom AWS Lambda handler.   
Type: [AccountSource](API_AccountSource.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdAt](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-createdAt"></a>
The timestamp at which the account pool was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-createdBy"></a>
The user who created the account pool.  
Type: String

 ** [description](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-description"></a>
The description of the account pool that is to be udpated.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-domainId"></a>
The domain ID where the account pool that is to be updated lives.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-domainUnitId"></a>
The domain ID in which the account pool that is to be updated lives.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [id](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-id"></a>
The ID of the account pool that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-lastUpdatedAt"></a>
The timestamp at which the account pool was last updated.  
Type: Timestamp

 ** [name](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-name"></a>
The name of the account pool that is to be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [resolutionStrategy](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-resolutionStrategy"></a>
The mechanism used to resolve the account selection from the account pool.  
Type: String  
Valid Values: `MANUAL` 

 ** [updatedBy](#API_UpdateAccountPool_ResponseSyntax) **   <a name="datazone-UpdateAccountPool-response-updatedBy"></a>
The user who last updated the account pool.  
Type: String

## Errors
<a name="API_UpdateAccountPool_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateAccountPool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateAccountPool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateAccountPool) 

# UpdateAssetFilter
<a name="API_UpdateAssetFilter"></a>

Updates an asset filter.

Prerequisites:
+ The domain, asset, and asset filter identifier must all exist. 
+ The asset must contain the columns being referenced in the update.
+ If applying a row filter, ensure the column referenced in the expression exists in the asset schema.

## Request Syntax
<a name="API_UpdateAssetFilter_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/assets/assetIdentifier/filters/identifier HTTP/1.1
Content-type: application/json

{
   "configuration": { ... },
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAssetFilter_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetIdentifier](#API_UpdateAssetFilter_RequestSyntax) **   <a name="datazone-UpdateAssetFilter-request-uri-assetIdentifier"></a>
The ID of the data asset.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_UpdateAssetFilter_RequestSyntax) **   <a name="datazone-UpdateAssetFilter-request-uri-domainIdentifier"></a>
The ID of the domain where you want to update an asset filter.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateAssetFilter_RequestSyntax) **   <a name="datazone-UpdateAssetFilter-request-uri-identifier"></a>
The ID of the asset filter.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateAssetFilter_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configuration](#API_UpdateAssetFilter_RequestSyntax) **   <a name="datazone-UpdateAssetFilter-request-configuration"></a>
The configuration of the asset filter.  
Type: [AssetFilterConfiguration](API_AssetFilterConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_UpdateAssetFilter_RequestSyntax) **   <a name="datazone-UpdateAssetFilter-request-description"></a>
The description of the asset filter.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [name](#API_UpdateAssetFilter_RequestSyntax) **   <a name="datazone-UpdateAssetFilter-request-name"></a>
The name of the asset filter.  
Type: String  
Required: No

## Response Syntax
<a name="API_UpdateAssetFilter_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetId": "string",
   "configuration": { ... },
   "createdAt": number,
   "description": "string",
   "domainId": "string",
   "effectiveColumnNames": [ "string" ],
   "effectiveRowFilter": "string",
   "errorMessage": "string",
   "id": "string",
   "name": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_UpdateAssetFilter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetId](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-assetId"></a>
The ID of the data asset.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [configuration](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-configuration"></a>
The configuration of the asset filter.  
Type: [AssetFilterConfiguration](API_AssetFilterConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdAt](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-createdAt"></a>
The timestamp at which the asset filter was created.  
Type: Timestamp

 ** [description](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-description"></a>
The description of the asset filter.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-domainId"></a>
The ID of the domain where the asset filter was created.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [effectiveColumnNames](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-effectiveColumnNames"></a>
The column names of the asset filter.  
Type: Array of strings

 ** [effectiveRowFilter](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-effectiveRowFilter"></a>
The row filter of the asset filter.  
Type: String

 ** [errorMessage](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-errorMessage"></a>
The error message that is displayed if the action is not completed successfully.  
Type: String

 ** [id](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-id"></a>
The ID of the asset filter.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-name"></a>
The name of the asset filter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [status](#API_UpdateAssetFilter_ResponseSyntax) **   <a name="datazone-UpdateAssetFilter-response-status"></a>
The status of the asset filter.  
Type: String  
Valid Values: `VALID | INVALID` 

## Errors
<a name="API_UpdateAssetFilter_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateAssetFilter_Examples"></a>

### Example
<a name="API_UpdateAssetFilter_Example_1"></a>

This example illustrates one usage of UpdateAssetFilter.

#### Sample Request
<a name="API_UpdateAssetFilter_Example_1_Request"></a>

```
aws datazone update-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5" \
--configuration '{
    "columnConfiguration": {
        "includedColumnNames": [
            "customer_id",
            "email",
            "phone_number",
            "address",
            "registration_date",
            "last_login_date"
        ]
    }
}'
```

#### Sample Response
<a name="API_UpdateAssetFilter_Example_1_Response"></a>

```
{
    "assetId": "ast7k9mpq2xvn4",
    "configuration": {
        "columnConfiguration": {
            "includedColumnNames": [
                "customer_id",
                "email",
                "phone_number",
                "address",
                "registration_date",
                "last_login_date"
            ]
        }
    },
    "createdAt": 1752651315.63,
    "domainId": "dzd_53ielnpxktdilj",
    "effectiveColumnNames": [
        "customer_id",
        "email",
        "phone_number",
        "address",
        "registration_date",
        "last_login_date"
    ],
    "id": "flt8p2mq3xvn5",
    "name": "customer-pii-filter",
    "status": "VALID"
}
```

### Example
<a name="API_UpdateAssetFilter_Example_2"></a>

Failure case - missing required field `--configuration`:

#### Sample Request
<a name="API_UpdateAssetFilter_Example_2_Request"></a>

```
aws datazone update-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5"
```

#### Sample Response
<a name="API_UpdateAssetFilter_Example_2_Response"></a>

```
aws: error: the following arguments are required: --configuration
```

### Example
<a name="API_UpdateAssetFilter_Example_3"></a>

Failure case - invalid JSON in `--configuration`:

#### Sample Request
<a name="API_UpdateAssetFilter_Example_3_Request"></a>

```
aws datazone update-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5" \
--configuration '{ "columnConfiguration": { "includedColumnNames": ["customer_id", "email" }'
```

#### Sample Response
<a name="API_UpdateAssetFilter_Example_3_Response"></a>

```
Error parsing parameter '--configuration': Invalid JSON: Expecting ',' delimiter: line 1 column 65 (char 64)
```

### Example
<a name="API_UpdateAssetFilter_Example_4"></a>

Failure case - both `columnConfiguration` and `rowConfiguration` present:

#### Sample Request
<a name="API_UpdateAssetFilter_Example_4_Request"></a>

```
aws datazone update-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5" \
--configuration '{
    "columnConfiguration": {
        "includedColumnNames": ["customer_id"]
    },
    "rowConfiguration": {
        "rowFilter": {
            "expression": {
                "equalTo": {
                    "columnName": "customer_id",
                    "value": "CUST123"
                }
            }
        }
    }
}'
```

#### Sample Response
<a name="API_UpdateAssetFilter_Example_4_Response"></a>

```
Parameter validation failed:
Invalid number of parameters set for tagged union structure configuration. Can only set one of the following keys: columnConfiguration, rowConfiguration.
```

### Example
<a name="API_UpdateAssetFilter_Example_5"></a>

Failure case - empty `includedColumnNames`:

#### Sample Request
<a name="API_UpdateAssetFilter_Example_5_Request"></a>

```
aws datazone update-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5" \
--configuration '{
    "columnConfiguration": {
        "includedColumnNames": []
    }
}'
```

#### Sample Response
<a name="API_UpdateAssetFilter_Example_5_Response"></a>

```
An error occurred (ValidationException) when calling the UpdateAssetFilter operation: Invalid column configuration. No valid columns found.
```

### Example
<a name="API_UpdateAssetFilter_Example_6"></a>

Failure case - invalid key in `rowFilter` expression:

#### Sample Request
<a name="API_UpdateAssetFilter_Example_6_Request"></a>

```
aws datazone update-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5" \
--configuration '{
    "rowConfiguration": {
        "rowFilter": {
            "expression": {
                "invalidOperator": {
                    "columnName": "customer_id",
                    "value": "CUST123"
                }
            }
        }
    }
}'
```

#### Sample Response
<a name="API_UpdateAssetFilter_Example_6_Response"></a>

```
Parameter validation failed:
Unknown parameter in configuration.rowConfiguration.rowFilter.expression: "invalidOperator", must be one of: equalTo, greaterThan, greaterThanOrEqualTo, in, isNotNull, isNull, lessThan, lessThanOrEqualTo, like, notEqualTo, notIn, notLike
```

### Example
<a name="API_UpdateAssetFilter_Example_7"></a>

Failure case - missing `columnName` in row filter:

#### Sample Request
<a name="API_UpdateAssetFilter_Example_7_Request"></a>

```
aws datazone update-asset-filter \
--domain-identifier "dzd_53ielnpxktdilj" \
--asset-identifier "ast7k9mpq2xvn4" \
--identifier "flt8p2mq3xvn5" \
--configuration '{
    "rowConfiguration": {
        "rowFilter": {
            "expression": {
                "equalTo": {
                    "value": "CUST123"
                }
            }
        }
    }
}'
```

#### Sample Response
<a name="API_UpdateAssetFilter_Example_7_Response"></a>

```
Parameter validation failed:
Missing required parameter in configuration.rowConfiguration.rowFilter.expression.equalTo: "columnName"
```

## See Also
<a name="API_UpdateAssetFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateAssetFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateAssetFilter) 

# UpdateConnection
<a name="API_UpdateConnection"></a>

Updates a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

## Request Syntax
<a name="API_UpdateConnection_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/connections/identifier HTTP/1.1
Content-type: application/json

{
   "awsLocation": { 
      "accessRole": "string",
      "awsAccountId": "string",
      "awsRegion": "string",
      "iamConnectionId": "string"
   },
   "configurations": [ 
      { 
         "classification": "string",
         "properties": { 
            "string" : "string" 
         }
      }
   ],
   "description": "string",
   "props": { ... }
}
```

## URI Request Parameters
<a name="API_UpdateConnection_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateConnection_RequestSyntax) **   <a name="datazone-UpdateConnection-request-uri-domainIdentifier"></a>
The ID of the domain where a connection is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateConnection_RequestSyntax) **   <a name="datazone-UpdateConnection-request-uri-identifier"></a>
The ID of the connection to be updated.  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Required: Yes

## Request Body
<a name="API_UpdateConnection_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [awsLocation](#API_UpdateConnection_RequestSyntax) **   <a name="datazone-UpdateConnection-request-awsLocation"></a>
The location where a connection is to be updated.  
Type: [AwsLocation](API_AwsLocation.md) object  
Required: No

 ** [configurations](#API_UpdateConnection_RequestSyntax) **   <a name="datazone-UpdateConnection-request-configurations"></a>
The configurations of the connection.  
Type: Array of [Configuration](API_Configuration.md) objects  
Required: No

 ** [description](#API_UpdateConnection_RequestSyntax) **   <a name="datazone-UpdateConnection-request-description"></a>
The description of a connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [props](#API_UpdateConnection_RequestSyntax) **   <a name="datazone-UpdateConnection-request-props"></a>
The connection props.  
Type: [ConnectionPropertiesPatch](API_ConnectionPropertiesPatch.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_UpdateConnection_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configurations": [ 
      { 
         "classification": "string",
         "properties": { 
            "string" : "string" 
         }
      }
   ],
   "connectionId": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentId": "string",
   "name": "string",
   "physicalEndpoints": [ 
      { 
         "awsLocation": { 
            "accessRole": "string",
            "awsAccountId": "string",
            "awsRegion": "string",
            "iamConnectionId": "string"
         },
         "enableTrustedIdentityPropagation": boolean,
         "glueConnection": { 
            "athenaProperties": { 
               "string" : "string" 
            },
            "authenticationConfiguration": { 
               "authenticationType": "string",
               "oAuth2Properties": { 
                  "authorizationCodeProperties": { 
                     "authorizationCode": "string",
                     "redirectUri": "string"
                  },
                  "oAuth2ClientApplication": { 
                     "aWSManagedClientApplicationReference": "string",
                     "userManagedClientApplicationClientId": "string"
                  },
                  "oAuth2Credentials": { 
                     "accessToken": "string",
                     "jwtToken": "string",
                     "refreshToken": "string",
                     "userManagedClientApplicationClientSecret": "string"
                  },
                  "oAuth2GrantType": "string",
                  "tokenUrl": "string",
                  "tokenUrlParametersMap": { 
                     "string" : "string" 
                  }
               },
               "secretArn": "string"
            },
            "compatibleComputeEnvironments": [ "string" ],
            "connectionProperties": { 
               "string" : "string" 
            },
            "connectionSchemaVersion": number,
            "connectionType": "string",
            "creationTime": number,
            "description": "string",
            "lastConnectionValidationTime": number,
            "lastUpdatedBy": "string",
            "lastUpdatedTime": number,
            "matchCriteria": [ "string" ],
            "name": "string",
            "physicalConnectionRequirements": { 
               "availabilityZone": "string",
               "securityGroupIdList": [ "string" ],
               "subnetId": "string",
               "subnetIdList": [ "string" ]
            },
            "pythonProperties": { 
               "string" : "string" 
            },
            "sparkProperties": { 
               "string" : "string" 
            },
            "status": "string",
            "statusReason": "string"
         },
         "glueConnectionName": "string",
         "glueConnectionNames": [ "string" ],
         "host": "string",
         "port": number,
         "protocol": "string",
         "stage": "string"
      }
   ],
   "projectId": "string",
   "props": { ... },
   "scope": "string",
   "type": "string"
}
```

## Response Elements
<a name="API_UpdateConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configurations](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-configurations"></a>
The configurations of the connection.  
Type: Array of [Configuration](API_Configuration.md) objects

 ** [connectionId](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-connectionId"></a>
The ID of the connection.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.

 ** [description](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-description"></a>
The connection description.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-domainId"></a>
The ID of the domain where a connection is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-domainUnitId"></a>
The ID of the domain unit where a connection is to be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentId](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-environmentId"></a>
The ID of the environment where a connection is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-name"></a>
The name of the connection.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.

 ** [physicalEndpoints](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-physicalEndpoints"></a>
The physical endpoints of the connection.  
Type: Array of [PhysicalEndpoint](API_PhysicalEndpoint.md) objects

 ** [projectId](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-projectId"></a>
The project ID of the connection.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [props](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-props"></a>
The connection props.  
Type: [ConnectionPropertiesOutput](API_ConnectionPropertiesOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [scope](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-scope"></a>
The scope of the connection.  
Type: String  
Valid Values: `DOMAIN | PROJECT` 

 ** [type](#API_UpdateConnection_ResponseSyntax) **   <a name="datazone-UpdateConnection-response-type"></a>
The connection type.  
Type: String  
Valid Values: `ATHENA | BIGQUERY | DATABRICKS | DOCUMENTDB | DYNAMODB | HYPERPOD | IAM | MYSQL | OPENSEARCH | ORACLE | POSTGRESQL | REDSHIFT | S3 | SAPHANA | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | VERTICA | WORKFLOWS_MWAA | AMAZON_Q | MLFLOW` 

## Errors
<a name="API_UpdateConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateConnection) 

# UpdateDataSource
<a name="API_UpdateDataSource"></a>

Updates the specified data source in Amazon DataZone.

## Request Syntax
<a name="API_UpdateDataSource_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/data-sources/identifier HTTP/1.1
Content-type: application/json

{
   "assetFormsInput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeIdentifier": "string",
         "typeRevision": "string"
      }
   ],
   "configuration": { ... },
   "description": "string",
   "enableSetting": "string",
   "name": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "retainPermissionsOnRevokeFailure": boolean,
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-uri-domainIdentifier"></a>
The identifier of the domain in which to update a data source.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-uri-identifier"></a>
The identifier of the data source to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateDataSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [assetFormsInput](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-assetFormsInput"></a>
The asset forms to be updated as part of the `UpdateDataSource` action.  
Type: Array of [FormInput](API_FormInput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [configuration](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-configuration"></a>
The configuration to be updated as part of the `UpdateDataSource` action.  
Type: [DataSourceConfigurationInput](API_DataSourceConfigurationInput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-description"></a>
The description to be updated as part of the `UpdateDataSource` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [enableSetting](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-enableSetting"></a>
The enable setting to be updated as part of the `UpdateDataSource` action.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [name](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-name"></a>
The name to be updated as part of the `UpdateDataSource` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [publishOnImport](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-publishOnImport"></a>
The publish on import setting to be updated as part of the `UpdateDataSource` action.  
Type: Boolean  
Required: No

 ** [recommendation](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-recommendation"></a>
The recommendation to be updated as part of the `UpdateDataSource` action.  
Type: [RecommendationConfiguration](API_RecommendationConfiguration.md) object  
Required: No

 ** [retainPermissionsOnRevokeFailure](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-retainPermissionsOnRevokeFailure"></a>
Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.  
Type: Boolean  
Required: No

 ** [schedule](#API_UpdateDataSource_RequestSyntax) **   <a name="datazone-UpdateDataSource-request-schedule"></a>
The schedule to be updated as part of the `UpdateDataSource` action.  
Type: [ScheduleConfiguration](API_ScheduleConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_UpdateDataSource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assetFormsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "configuration": { ... },
   "connectionId": "string",
   "createdAt": "string",
   "description": "string",
   "domainId": "string",
   "enableSetting": "string",
   "environmentId": "string",
   "errorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "id": "string",
   "lastRunAt": "string",
   "lastRunErrorMessage": { 
      "errorDetail": "string",
      "errorType": "string"
   },
   "lastRunStatus": "string",
   "name": "string",
   "projectId": "string",
   "publishOnImport": boolean,
   "recommendation": { 
      "enableBusinessNameGeneration": boolean
   },
   "retainPermissionsOnRevokeFailure": boolean,
   "schedule": { 
      "schedule": "string",
      "timezone": "string"
   },
   "selfGrantStatus": { ... },
   "status": "string",
   "type": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_UpdateDataSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assetFormsOutput](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-assetFormsOutput"></a>
The asset forms to be updated as part of the `UpdateDataSource` action.  
Type: Array of [FormOutput](API_FormOutput.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [configuration](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-configuration"></a>
The configuration to be updated as part of the `UpdateDataSource` action.  
Type: [DataSourceConfigurationOutput](API_DataSourceConfigurationOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [connectionId](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-connectionId"></a>
The connection ID.  
Type: String

 ** [createdAt](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-createdAt"></a>
The timestamp of when the data source was updated.  
Type: Timestamp

 ** [description](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-description"></a>
The description to be updated as part of the `UpdateDataSource` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a data source is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [enableSetting](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-enableSetting"></a>
The enable setting to be updated as part of the `UpdateDataSource` action.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [environmentId](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-environmentId"></a>
The identifier of the environment in which a data source is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [errorMessage](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-errorMessage"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [id](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-id"></a>
The identifier of the data source to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastRunAt](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-lastRunAt"></a>
The timestamp of when the data source was last run.  
Type: Timestamp

 ** [lastRunErrorMessage](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-lastRunErrorMessage"></a>
The last run error message of the data source.  
Type: [DataSourceErrorMessage](API_DataSourceErrorMessage.md) object

 ** [lastRunStatus](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-lastRunStatus"></a>
The last run status of the data source.  
Type: String  
Valid Values: `REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS` 

 ** [name](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-name"></a>
The name to be updated as part of the `UpdateDataSource` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [projectId](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-projectId"></a>
The identifier of the project where data source is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [publishOnImport](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-publishOnImport"></a>
The publish on import setting to be updated as part of the `UpdateDataSource` action.  
Type: Boolean

 ** [recommendation](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-recommendation"></a>
The recommendation to be updated as part of the `UpdateDataSource` action.  
Type: [RecommendationConfiguration](API_RecommendationConfiguration.md) object

 ** [retainPermissionsOnRevokeFailure](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-retainPermissionsOnRevokeFailure"></a>
Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.  
Type: Boolean

 ** [schedule](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-schedule"></a>
The schedule to be updated as part of the `UpdateDataSource` action.  
Type: [ScheduleConfiguration](API_ScheduleConfiguration.md) object

 ** [selfGrantStatus](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-selfGrantStatus"></a>
Specifies the status of the self-granting functionality.  
Type: [SelfGrantStatusOutput](API_SelfGrantStatusOutput.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-status"></a>
The status to be updated as part of the `UpdateDataSource` action.  
Type: String  
Valid Values: `CREATING | FAILED_CREATION | READY | UPDATING | FAILED_UPDATE | RUNNING | DELETING | FAILED_DELETION` 

 ** [type](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-type"></a>
The type to be updated as part of the `UpdateDataSource` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [updatedAt](#API_UpdateDataSource_ResponseSyntax) **   <a name="datazone-UpdateDataSource-response-updatedAt"></a>
The timestamp of when the data source was updated.  
Type: Timestamp

## Errors
<a name="API_UpdateDataSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateDataSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateDataSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateDataSource) 

# UpdateDomain
<a name="API_UpdateDomain"></a>

Updates a Amazon DataZone domain.

## Request Syntax
<a name="API_UpdateDomain_RequestSyntax"></a>

```
PUT /v2/domains/identifier?clientToken=clientToken HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "domainExecutionRole": "string",
   "name": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "idcInstanceArn": "string",
      "type": "string",
      "userAssignment": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_UpdateDomain_RequestSyntax) **   <a name="datazone-UpdateDomain-request-uri-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

 ** [identifier](#API_UpdateDomain_RequestSyntax) **   <a name="datazone-UpdateDomain-request-uri-identifier"></a>
The ID of the AWS domain that is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateDomain_RequestSyntax) **   <a name="datazone-UpdateDomain-request-description"></a>
The description to be updated as part of the `UpdateDomain` action.  
Type: String  
Required: No

 ** [domainExecutionRole](#API_UpdateDomain_RequestSyntax) **   <a name="datazone-UpdateDomain-request-domainExecutionRole"></a>
The domain execution role to be updated as part of the `UpdateDomain` action.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+`   
Required: No

 ** [name](#API_UpdateDomain_RequestSyntax) **   <a name="datazone-UpdateDomain-request-name"></a>
The name to be updated as part of the `UpdateDomain` action.  
Type: String  
Required: No

 ** [serviceRole](#API_UpdateDomain_RequestSyntax) **   <a name="datazone-UpdateDomain-request-serviceRole"></a>
The service role of the domain.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+`   
Required: No

 ** [singleSignOn](#API_UpdateDomain_RequestSyntax) **   <a name="datazone-UpdateDomain-request-singleSignOn"></a>
The single sign-on option to be updated as part of the `UpdateDomain` action.  
Type: [SingleSignOn](API_SingleSignOn.md) object  
Required: No

## Response Syntax
<a name="API_UpdateDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "domainExecutionRole": "string",
   "id": "string",
   "lastUpdatedAt": number,
   "name": "string",
   "rootDomainUnitId": "string",
   "serviceRole": "string",
   "singleSignOn": { 
      "idcInstanceArn": "string",
      "type": "string",
      "userAssignment": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [description](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-description"></a>
The description to be updated as part of the `UpdateDomain` action.  
Type: String

 ** [domainExecutionRole](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-domainExecutionRole"></a>
The domain execution role to be updated as part of the `UpdateDomain` action.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [id](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-id"></a>
The identifier of the Amazon DataZone domain.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-lastUpdatedAt"></a>
Specifies the timestamp of when the domain was last updated.  
Type: Timestamp

 ** [name](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-name"></a>
The name to be updated as part of the `UpdateDomain` action.  
Type: String

 ** [rootDomainUnitId](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-rootDomainUnitId"></a>
The ID of the root domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [serviceRole](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-serviceRole"></a>
The service role of the domain.  
Type: String  
Pattern: `arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+` 

 ** [singleSignOn](#API_UpdateDomain_ResponseSyntax) **   <a name="datazone-UpdateDomain-response-singleSignOn"></a>
The single sign-on option of the Amazon DataZone domain.  
Type: [SingleSignOn](API_SingleSignOn.md) object

## Errors
<a name="API_UpdateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateDomain) 

# UpdateDomainUnit
<a name="API_UpdateDomainUnit"></a>

Updates the domain unit.

## Request Syntax
<a name="API_UpdateDomainUnit_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/domain-units/identifier HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDomainUnit_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateDomainUnit_RequestSyntax) **   <a name="datazone-UpdateDomainUnit-request-uri-domainIdentifier"></a>
The ID of the domain where you want to update a domain unit.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateDomainUnit_RequestSyntax) **   <a name="datazone-UpdateDomainUnit-request-uri-identifier"></a>
The ID of the domain unit that you want to update.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: Yes

## Request Body
<a name="API_UpdateDomainUnit_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateDomainUnit_RequestSyntax) **   <a name="datazone-UpdateDomainUnit-request-description"></a>
The description of the domain unit that you want to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [name](#API_UpdateDomainUnit_RequestSyntax) **   <a name="datazone-UpdateDomainUnit-request-name"></a>
The name of the domain unit that you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w -]+`   
Required: No

## Response Syntax
<a name="API_UpdateDomainUnit_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "id": "string",
   "lastUpdatedAt": number,
   "lastUpdatedBy": "string",
   "name": "string",
   "owners": [ 
      { ... }
   ],
   "parentDomainUnitId": "string"
}
```

## Response Elements
<a name="API_UpdateDomainUnit_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-createdAt"></a>
The time stamp at which the domain unit that you want to update was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-createdBy"></a>
The user who created the domain unit that you want to update.  
Type: String

 ** [description](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-description"></a>
The description of the domain unit that you want to update.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-domainId"></a>
The ID of the domain where you want to update the domain unit.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-id"></a>
The ID of the domain unit that you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [lastUpdatedAt](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-lastUpdatedAt"></a>
The timestamp at which the domain unit was last updated.  
Type: Timestamp

 ** [lastUpdatedBy](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-lastUpdatedBy"></a>
The user who last updated the domain unit.  
Type: String

 ** [name](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-name"></a>
The name of the domain unit that you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\w -]+` 

 ** [owners](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-owners"></a>
The owners of the domain unit that you want to update.  
Type: Array of [DomainUnitOwnerProperties](API_DomainUnitOwnerProperties.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [parentDomainUnitId](#API_UpdateDomainUnit_ResponseSyntax) **   <a name="datazone-UpdateDomainUnit-response-parentDomainUnitId"></a>
The ID of the parent domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

## Errors
<a name="API_UpdateDomainUnit_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateDomainUnit_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateDomainUnit) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateDomainUnit) 

# UpdateEnvironment
<a name="API_UpdateEnvironment"></a>

Updates the specified environment in Amazon DataZone.

## Request Syntax
<a name="API_UpdateEnvironment_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/environments/identifier HTTP/1.1
Content-type: application/json

{
   "blueprintVersion": "string",
   "description": "string",
   "environmentConfigurationName": "string",
   "glossaryTerms": [ "string" ],
   "name": "string",
   "userParameters": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateEnvironment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-uri-domainIdentifier"></a>
The identifier of the domain in which the environment is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-uri-identifier"></a>
The identifier of the environment that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateEnvironment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blueprintVersion](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-blueprintVersion"></a>
The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: `latest`.  
Type: String  
Required: No

 ** [description](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-description"></a>
The description to be updated as part of the `UpdateEnvironment` action.  
Type: String  
Required: No

 ** [environmentConfigurationName](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-environmentConfigurationName"></a>
The configuration name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: No

 ** [glossaryTerms](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-glossaryTerms"></a>
The glossary terms to be updated as part of the `UpdateEnvironment` action.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [name](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-name"></a>
The name to be updated as part of the `UpdateEnvironment` action.  
Type: String  
Required: No

 ** [userParameters](#API_UpdateEnvironment_RequestSyntax) **   <a name="datazone-UpdateEnvironment-request-userParameters"></a>
The user parameters of the environment.  
Type: Array of [EnvironmentParameter](API_EnvironmentParameter.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateEnvironment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "deploymentProperties": { 
      "endTimeoutMinutes": number,
      "startTimeoutMinutes": number
   },
   "description": "string",
   "domainId": "string",
   "environmentActions": [ 
      { 
         "auth": "string",
         "parameters": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ],
         "type": "string"
      }
   ],
   "environmentBlueprintId": "string",
   "environmentConfigurationId": "string",
   "environmentConfigurationName": "string",
   "environmentProfileId": "string",
   "glossaryTerms": [ "string" ],
   "id": "string",
   "lastDeployment": { 
      "deploymentId": "string",
      "deploymentStatus": "string",
      "deploymentType": "string",
      "failureReason": { 
         "code": "string",
         "message": "string"
      },
      "isDeploymentComplete": boolean,
      "messages": [ "string" ]
   },
   "name": "string",
   "projectId": "string",
   "provider": "string",
   "provisionedResources": [ 
      { 
         "name": "string",
         "provider": "string",
         "type": "string",
         "value": "string"
      }
   ],
   "provisioningProperties": { ... },
   "status": "string",
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdateEnvironment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [awsAccountId](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-awsAccountId"></a>
The identifier of the AWS account in which the environment is to be updated.  
Type: String  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-awsAccountRegion"></a>
The AWS Region in which the environment is updated.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [createdAt](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-createdAt"></a>
The timestamp of when the environment was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-createdBy"></a>
The Amazon DataZone user who created the environment.  
Type: String

 ** [deploymentProperties](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-deploymentProperties"></a>
The deployment properties to be updated as part of the `UpdateEnvironment` action.  
Type: [DeploymentProperties](API_DeploymentProperties.md) object

 ** [description](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-description"></a>
The description to be updated as part of the `UpdateEnvironment` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-domainId"></a>
The identifier of the domain in which the environment is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentActions](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-environmentActions"></a>
The environment actions to be updated as part of the `UpdateEnvironment` action.  
Type: Array of [ConfigurableEnvironmentAction](API_ConfigurableEnvironmentAction.md) objects

 ** [environmentBlueprintId](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-environmentBlueprintId"></a>
The blueprint identifier of the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentConfigurationId](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-environmentConfigurationId"></a>
The configuration ID of the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [environmentConfigurationName](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-environmentConfigurationName"></a>
The configuration name of the environment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [environmentProfileId](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-environmentProfileId"></a>
The profile identifier of the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{0,36}` 

 ** [glossaryTerms](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-glossaryTerms"></a>
The glossary terms to be updated as part of the `UpdateEnvironment` action.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-id"></a>
The identifier of the environment that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastDeployment](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-lastDeployment"></a>
The last deployment of the environment.  
Type: [Deployment](API_Deployment.md) object

 ** [name](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-name"></a>
The name to be updated as part of the `UpdateEnvironment` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectId](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-projectId"></a>
The project identifier of the environment.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [provider](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-provider"></a>
The provider identifier of the environment.  
Type: String

 ** [provisionedResources](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-provisionedResources"></a>
The provisioned resources to be updated as part of the `UpdateEnvironment` action.  
Type: Array of [Resource](API_Resource.md) objects

 ** [provisioningProperties](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-provisioningProperties"></a>
The provisioning properties to be updated as part of the `UpdateEnvironment` action.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [status](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-status"></a>
The status to be updated as part of the `UpdateEnvironment` action.  
Type: String  
Valid Values: `ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | VALIDATION_FAILED | SUSPENDED | DISABLED | EXPIRED | DELETED | INACCESSIBLE` 

 ** [updatedAt](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-updatedAt"></a>
The timestamp of when the environment was updated.  
Type: Timestamp

 ** [userParameters](#API_UpdateEnvironment_ResponseSyntax) **   <a name="datazone-UpdateEnvironment-response-userParameters"></a>
The user parameters to be updated as part of the `UpdateEnvironment` action.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_UpdateEnvironment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateEnvironment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateEnvironment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateEnvironment) 

# UpdateEnvironmentAction
<a name="API_UpdateEnvironmentAction"></a>

Updates an environment action.

## Request Syntax
<a name="API_UpdateEnvironmentAction_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/environments/environmentIdentifier/actions/identifier HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "parameters": { ... }
}
```

## URI Request Parameters
<a name="API_UpdateEnvironmentAction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateEnvironmentAction_RequestSyntax) **   <a name="datazone-UpdateEnvironmentAction-request-uri-domainIdentifier"></a>
The domain ID of the environment action.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_UpdateEnvironmentAction_RequestSyntax) **   <a name="datazone-UpdateEnvironmentAction-request-uri-environmentIdentifier"></a>
The environment ID of the environment action.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateEnvironmentAction_RequestSyntax) **   <a name="datazone-UpdateEnvironmentAction-request-uri-identifier"></a>
The ID of the environment action.  
Required: Yes

## Request Body
<a name="API_UpdateEnvironmentAction_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateEnvironmentAction_RequestSyntax) **   <a name="datazone-UpdateEnvironmentAction-request-description"></a>
The description of the environment action.  
Type: String  
Required: No

 ** [name](#API_UpdateEnvironmentAction_RequestSyntax) **   <a name="datazone-UpdateEnvironmentAction-request-name"></a>
The name of the environment action.  
Type: String  
Required: No

 ** [parameters](#API_UpdateEnvironmentAction_RequestSyntax) **   <a name="datazone-UpdateEnvironmentAction-request-parameters"></a>
The parameters of the environment action.  
Type: [ActionParameters](API_ActionParameters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_UpdateEnvironmentAction_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "name": "string",
   "parameters": { ... }
}
```

## Response Elements
<a name="API_UpdateEnvironmentAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [description](#API_UpdateEnvironmentAction_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentAction-response-description"></a>
The description of the environment action.  
Type: String

 ** [domainId](#API_UpdateEnvironmentAction_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentAction-response-domainId"></a>
The domain ID of the environment action.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_UpdateEnvironmentAction_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentAction-response-environmentId"></a>
The environment ID of the environment action.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateEnvironmentAction_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentAction-response-id"></a>
The ID of the environment action.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_UpdateEnvironmentAction_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentAction-response-name"></a>
The name of the environment action.  
Type: String

 ** [parameters](#API_UpdateEnvironmentAction_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentAction-response-parameters"></a>
The parameters of the environment action.  
Type: [ActionParameters](API_ActionParameters.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

## Errors
<a name="API_UpdateEnvironmentAction_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateEnvironmentAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateEnvironmentAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateEnvironmentAction) 

# UpdateEnvironmentBlueprint
<a name="API_UpdateEnvironmentBlueprint"></a>

Updates an environment blueprint in Amazon DataZone.

## Request Syntax
<a name="API_UpdateEnvironmentBlueprint_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/environment-blueprints/identifier HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "provisioningProperties": { ... },
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateEnvironmentBlueprint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-request-uri-identifier"></a>
The identifier of the environment blueprint to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateEnvironmentBlueprint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-request-description"></a>
The description to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: String  
Required: No

 ** [provisioningProperties](#API_UpdateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-request-provisioningProperties"></a>
The provisioning properties to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [userParameters](#API_UpdateEnvironmentBlueprint_RequestSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-request-userParameters"></a>
The user parameters to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateEnvironmentBlueprint_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "deploymentProperties": { 
      "endTimeoutMinutes": number,
      "startTimeoutMinutes": number
   },
   "description": "string",
   "glossaryTerms": [ "string" ],
   "id": "string",
   "name": "string",
   "provider": "string",
   "provisioningProperties": { ... },
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdateEnvironmentBlueprint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-createdAt"></a>
The timestamp of when the environment blueprint was created.  
Type: Timestamp

 ** [deploymentProperties](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-deploymentProperties"></a>
The deployment properties to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: [DeploymentProperties](API_DeploymentProperties.md) object

 ** [description](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-description"></a>
The description to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [glossaryTerms](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-glossaryTerms"></a>
The glossary terms to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-id"></a>
The identifier of the blueprint to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-name"></a>
The name to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [provider](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-provider"></a>
The provider of the blueprint to be udpated.  
Type: String

 ** [provisioningProperties](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-provisioningProperties"></a>
The provisioning properties to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: [ProvisioningProperties](API_ProvisioningProperties.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [updatedAt](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-updatedAt"></a>
The timestamp of when the blueprint was updated.  
Type: Timestamp

 ** [userParameters](#API_UpdateEnvironmentBlueprint_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentBlueprint-response-userParameters"></a>
The user parameters to be updated as part of the `UpdateEnvironmentBlueprint` action.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_UpdateEnvironmentBlueprint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateEnvironmentBlueprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateEnvironmentBlueprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateEnvironmentBlueprint) 

# UpdateEnvironmentProfile
<a name="API_UpdateEnvironmentProfile"></a>

Updates the specified environment profile in Amazon DataZone.

## Request Syntax
<a name="API_UpdateEnvironmentProfile_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/environment-profiles/identifier HTTP/1.1
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "description": "string",
   "name": "string",
   "userParameters": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateEnvironmentProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateEnvironmentProfile_RequestSyntax) **   <a name="datazone-UpdateEnvironmentProfile-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which an environment profile is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateEnvironmentProfile_RequestSyntax) **   <a name="datazone-UpdateEnvironmentProfile-request-uri-identifier"></a>
The identifier of the environment profile that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{0,36}`   
Required: Yes

## Request Body
<a name="API_UpdateEnvironmentProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [awsAccountId](#API_UpdateEnvironmentProfile_RequestSyntax) **   <a name="datazone-UpdateEnvironmentProfile-request-awsAccountId"></a>
The AWS account in which a specified environment profile is to be udpated.  
Type: String  
Pattern: `\d{12}`   
Required: No

 ** [awsAccountRegion](#API_UpdateEnvironmentProfile_RequestSyntax) **   <a name="datazone-UpdateEnvironmentProfile-request-awsAccountRegion"></a>
The AWS Region in which a specified environment profile is to be updated.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d`   
Required: No

 ** [description](#API_UpdateEnvironmentProfile_RequestSyntax) **   <a name="datazone-UpdateEnvironmentProfile-request-description"></a>
The description to be updated as part of the `UpdateEnvironmentProfile` action.  
Type: String  
Required: No

 ** [name](#API_UpdateEnvironmentProfile_RequestSyntax) **   <a name="datazone-UpdateEnvironmentProfile-request-name"></a>
The name to be updated as part of the `UpdateEnvironmentProfile` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: No

 ** [userParameters](#API_UpdateEnvironmentProfile_RequestSyntax) **   <a name="datazone-UpdateEnvironmentProfile-request-userParameters"></a>
The user parameters to be updated as part of the `UpdateEnvironmentProfile` action.  
Type: Array of [EnvironmentParameter](API_EnvironmentParameter.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateEnvironmentProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "environmentBlueprintId": "string",
   "id": "string",
   "name": "string",
   "projectId": "string",
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": boolean,
         "isUpdateSupported": boolean,
         "keyName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdateEnvironmentProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [awsAccountId](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-awsAccountId"></a>
The AWS account in which a specified environment profile is to be udpated.  
Type: String  
Pattern: `\d{12}` 

 ** [awsAccountRegion](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-awsAccountRegion"></a>
The AWS Region in which a specified environment profile is to be updated.  
Type: String  
Pattern: `[a-z]{2}-[a-z]{4,10}-\d` 

 ** [createdAt](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-createdAt"></a>
The timestamp of when the environment profile was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-createdBy"></a>
The Amazon DataZone user who created the environment profile.  
Type: String

 ** [description](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-description"></a>
The description to be updated as part of the `UpdateEnvironmentProfile` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-domainId"></a>
The identifier of the Amazon DataZone domain in which the environment profile is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentBlueprintId](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-environmentBlueprintId"></a>
The identifier of the blueprint of the environment profile that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-id"></a>
The identifier of the environment profile that is to be udpated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{0,36}` 

 ** [name](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-name"></a>
The name to be updated as part of the `UpdateEnvironmentProfile` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectId](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-projectId"></a>
The identifier of the project of the environment profile that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-updatedAt"></a>
The timestamp of when the environment profile was updated.  
Type: Timestamp

 ** [userParameters](#API_UpdateEnvironmentProfile_ResponseSyntax) **   <a name="datazone-UpdateEnvironmentProfile-response-userParameters"></a>
The user parameters to be updated as part of the `UpdateEnvironmentProfile` action.  
Type: Array of [CustomParameter](API_CustomParameter.md) objects

## Errors
<a name="API_UpdateEnvironmentProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateEnvironmentProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateEnvironmentProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateEnvironmentProfile) 

# UpdateGlossary
<a name="API_UpdateGlossary"></a>

Updates the business glossary in Amazon DataZone.

Prerequisites:
+ The glossary must exist in the given domain. 
+ The caller must have the `datazone:UpdateGlossary` permission to update it.
+ When updating the name, the new name must be unique within the domain.
+ The glossary must not be deleted or in a terminal state.

## Request Syntax
<a name="API_UpdateGlossary_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/glossaries/identifier HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateGlossary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateGlossary_RequestSyntax) **   <a name="datazone-UpdateGlossary-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a business glossary is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateGlossary_RequestSyntax) **   <a name="datazone-UpdateGlossary-request-uri-identifier"></a>
The identifier of the business glossary to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateGlossary_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateGlossary_RequestSyntax) **   <a name="datazone-UpdateGlossary-request-clientToken"></a>
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [description](#API_UpdateGlossary_RequestSyntax) **   <a name="datazone-UpdateGlossary-request-description"></a>
The description to be updated as part of the `UpdateGlossary` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [name](#API_UpdateGlossary_RequestSyntax) **   <a name="datazone-UpdateGlossary-request-name"></a>
The name to be updated as part of the `UpdateGlossary` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [status](#API_UpdateGlossary_RequestSyntax) **   <a name="datazone-UpdateGlossary-request-status"></a>
The status to be updated as part of the `UpdateGlossary` action.  
Type: String  
Valid Values: `DISABLED | ENABLED`   
Required: No

## Response Syntax
<a name="API_UpdateGlossary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "description": "string",
   "domainId": "string",
   "id": "string",
   "name": "string",
   "owningProjectId": "string",
   "status": "string",
   "usageRestrictions": [ "string" ]
}
```

## Response Elements
<a name="API_UpdateGlossary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [description](#API_UpdateGlossary_ResponseSyntax) **   <a name="datazone-UpdateGlossary-response-description"></a>
The description to be updated as part of the `UpdateGlossary` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [domainId](#API_UpdateGlossary_ResponseSyntax) **   <a name="datazone-UpdateGlossary-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a business glossary is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateGlossary_ResponseSyntax) **   <a name="datazone-UpdateGlossary-response-id"></a>
The identifier of the business glossary that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [name](#API_UpdateGlossary_ResponseSyntax) **   <a name="datazone-UpdateGlossary-response-name"></a>
The name to be updated as part of the `UpdateGlossary` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [owningProjectId](#API_UpdateGlossary_ResponseSyntax) **   <a name="datazone-UpdateGlossary-response-owningProjectId"></a>
The identifier of the project in which to update a business glossary.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_UpdateGlossary_ResponseSyntax) **   <a name="datazone-UpdateGlossary-response-status"></a>
The status to be updated as part of the `UpdateGlossary` action.  
Type: String  
Valid Values: `DISABLED | ENABLED` 

 ** [usageRestrictions](#API_UpdateGlossary_ResponseSyntax) **   <a name="datazone-UpdateGlossary-response-usageRestrictions"></a>
The usage restriction of the restricted glossary.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `ASSET_GOVERNED_TERMS` 

## Errors
<a name="API_UpdateGlossary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateGlossary_Examples"></a>

### Example
<a name="API_UpdateGlossary_Example_1"></a>

This example illustrates one usage of UpdateGlossary.

#### Sample Request
<a name="API_UpdateGlossary_Example_1_Request"></a>

```
aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp" \
--name "UpdatedCustomerAnalyticsGlossary"
```

#### Sample Response
<a name="API_UpdateGlossary_Example_1_Response"></a>

```
{
    "domainId": "dzd_53ielnpxktdilj",
    "id": "gls8m3nqx2wkfp",
    "name": "UpdatedCustomerAnalyticsGlossary",
    "owningProjectId": "prj7nx82mkl",
    "status": "ENABLED"
}
```

### Example
<a name="API_UpdateGlossary_Example_2"></a>

Failure case - invalid input:

#### Sample Request
<a name="API_UpdateGlossary_Example_2_Request"></a>

```
aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp" \
--name ""
```

#### Sample Response
<a name="API_UpdateGlossary_Example_2_Response"></a>

```
Parameter validation failed:
Invalid length for parameter name, value: 0, valid min length: 1
```

### Example
<a name="API_UpdateGlossary_Example_3"></a>

Failure case - resource not found:

#### Sample Request
<a name="API_UpdateGlossary_Example_3_Request"></a>

```
aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls_nonexistent" \
--name "NewGlossaryName"
```

#### Sample Response
<a name="API_UpdateGlossary_Example_3_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the UpdateGlossary operation: Requested businessGlossary cannot be found in domain
```

### Example
<a name="API_UpdateGlossary_Example_4"></a>

Failure case - duplicate terms:

#### Sample Request
<a name="API_UpdateGlossary_Example_4_Request"></a>

```
 aws datazone update-glossary \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "gls8m3nqx2wkfp" \
--name "ExistingGlossaryName"
```

#### Sample Response
<a name="API_UpdateGlossary_Example_4_Response"></a>

```
An error occurred (ConflictException) when calling the UpdateGlossary operation: Conflict with businessGlossary 41dkjgc9m5xj8n
```

## See Also
<a name="API_UpdateGlossary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateGlossary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateGlossary) 

# UpdateGlossaryTerm
<a name="API_UpdateGlossaryTerm"></a>

Updates a business glossary term in Amazon DataZone.

Prerequisites:
+ Glossary term must exist in the specified domain. 
+ New name must not conflict with existing terms in the same glossary.
+ User must have permissions on the term.
+ The term must not be in DELETED status.

## Request Syntax
<a name="API_UpdateGlossaryTerm_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/glossary-terms/identifier HTTP/1.1
Content-type: application/json

{
   "glossaryIdentifier": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "string" ]
   }
}
```

## URI Request Parameters
<a name="API_UpdateGlossaryTerm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-uri-identifier"></a>
The identifier of the business glossary term that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateGlossaryTerm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [glossaryIdentifier](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-glossaryIdentifier"></a>
The identifier of the business glossary in which a term is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [longDescription](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-longDescription"></a>
The long description to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [name](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-name"></a>
The name to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [shortDescription](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-shortDescription"></a>
The short description to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [status](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-status"></a>
The status to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [termRelations](#API_UpdateGlossaryTerm_RequestSyntax) **   <a name="datazone-UpdateGlossaryTerm-request-termRelations"></a>
The term relations to be updated as part of the `UpdateGlossaryTerm` action.  
Type: [TermRelations](API_TermRelations.md) object  
Required: No

## Response Syntax
<a name="API_UpdateGlossaryTerm_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domainId": "string",
   "glossaryId": "string",
   "id": "string",
   "longDescription": "string",
   "name": "string",
   "shortDescription": "string",
   "status": "string",
   "termRelations": { 
      "classifies": [ "string" ],
      "isA": [ "string" ]
   },
   "usageRestrictions": [ "string" ]
}
```

## Response Elements
<a name="API_UpdateGlossaryTerm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [glossaryId](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-glossaryId"></a>
The identifier of the business glossary in which a term is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-id"></a>
The identifier of the business glossary term that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [longDescription](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-longDescription"></a>
The long description to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [name](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-name"></a>
The name to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [shortDescription](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-shortDescription"></a>
The short description to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [status](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-status"></a>
The status to be updated as part of the `UpdateGlossaryTerm` action.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

 ** [termRelations](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-termRelations"></a>
The term relations to be updated as part of the `UpdateGlossaryTerm` action.  
Type: [TermRelations](API_TermRelations.md) object

 ** [usageRestrictions](#API_UpdateGlossaryTerm_ResponseSyntax) **   <a name="datazone-UpdateGlossaryTerm-response-usageRestrictions"></a>
The usage restriction of a term within a restricted glossary.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `ASSET_GOVERNED_TERMS` 

## Errors
<a name="API_UpdateGlossaryTerm_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_UpdateGlossaryTerm_Examples"></a>

### Example
<a name="API_UpdateGlossaryTerm_Example_1"></a>

This example illustrates one usage of UpdateGlossaryTerm.

#### Sample Request
<a name="API_UpdateGlossaryTerm_Example_1_Request"></a>

```
aws datazone update-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm9k4pq7xwnmh" \
--name "CustomerLifetimeValueMetric"
```

#### Sample Response
<a name="API_UpdateGlossaryTerm_Example_1_Response"></a>

```
{
    "domainId": "dzd_53ielnpxktdilj",
    "glossaryId": "gls8m3nqx2wkfp",
    "id": "trm9k4pq7xwnmh",
    "name": "CustomerLifetimeValueMetric",
    "status": "ENABLED"
}
```

### Example
<a name="API_UpdateGlossaryTerm_Example_2"></a>

Failure case - resource does not exist:

#### Sample Request
<a name="API_UpdateGlossaryTerm_Example_2_Request"></a>

```
aws datazone update-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm_nonexistent" \
--name "NewTermName"
```

#### Sample Response
<a name="API_UpdateGlossaryTerm_Example_2_Response"></a>

```
An error occurred (ResourceNotFoundException) when calling the UpdateGlossaryTerm operation: The given GlossaryTerm doesn't exist. Try creating GlossaryTerm before accessing it.
```

### Example
<a name="API_UpdateGlossaryTerm_Example_3"></a>

Failure case - invalid input:

#### Sample Request
<a name="API_UpdateGlossaryTerm_Example_3_Request"></a>

```
aws datazone update-glossary-term \
--domain-identifier "dzd_53ielnpxktdilj" \
--identifier "trm9k4pq7xwnmh" \
--name "$(head -c 300 </dev/zero | tr '\0' 'A')"
```

#### Sample Response
<a name="API_UpdateGlossaryTerm_Example_3_Response"></a>

```
An error occurred (ValidationException) when calling the UpdateGlossaryTerm operation: 1 validation error detected: Value at 'name' failed to satisfy constraint: Member must have length less than or equal to 256
```

## See Also
<a name="API_UpdateGlossaryTerm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateGlossaryTerm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateGlossaryTerm) 

# UpdateGroupProfile
<a name="API_UpdateGroupProfile"></a>

Updates the specified group profile in Amazon DataZone.

## Request Syntax
<a name="API_UpdateGroupProfile_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/group-profiles/groupIdentifier HTTP/1.1
Content-type: application/json

{
   "status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateGroupProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateGroupProfile_RequestSyntax) **   <a name="datazone-UpdateGroupProfile-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a group profile is updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [groupIdentifier](#API_UpdateGroupProfile_RequestSyntax) **   <a name="datazone-UpdateGroupProfile-request-uri-groupIdentifier"></a>
The identifier of the group profile that is updated.  
Pattern: `.*(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+).*`   
Required: Yes

## Request Body
<a name="API_UpdateGroupProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [status](#API_UpdateGroupProfile_RequestSyntax) **   <a name="datazone-UpdateGroupProfile-request-status"></a>
The status of the group profile that is updated.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED`   
Required: Yes

## Response Syntax
<a name="API_UpdateGroupProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domainId": "string",
   "groupName": "string",
   "id": "string",
   "rolePrincipalArn": "string",
   "rolePrincipalId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_UpdateGroupProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domainId](#API_UpdateGroupProfile_ResponseSyntax) **   <a name="datazone-UpdateGroupProfile-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a group profile is updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [groupName](#API_UpdateGroupProfile_ResponseSyntax) **   <a name="datazone-UpdateGroupProfile-response-groupName"></a>
The name of the group profile that is updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `[a-zA-Z_0-9+=,.@-]+` 

 ** [id](#API_UpdateGroupProfile_ResponseSyntax) **   <a name="datazone-UpdateGroupProfile-response-id"></a>
The identifier of the group profile that is updated.  
Type: String  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [rolePrincipalArn](#API_UpdateGroupProfile_ResponseSyntax) **   <a name="datazone-UpdateGroupProfile-response-rolePrincipalArn"></a>
The ARN of the IAM role principal. This role is associated with the updated group profile.  
Type: String

 ** [rolePrincipalId](#API_UpdateGroupProfile_ResponseSyntax) **   <a name="datazone-UpdateGroupProfile-response-rolePrincipalId"></a>
The unique identifier of the IAM role principal. This principal is associated with the updated group profile.  
Type: String

 ** [status](#API_UpdateGroupProfile_ResponseSyntax) **   <a name="datazone-UpdateGroupProfile-response-status"></a>
The status of the group profile that is updated.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED` 

## Errors
<a name="API_UpdateGroupProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateGroupProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateGroupProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateGroupProfile) 

# UpdateProject
<a name="API_UpdateProject"></a>

Updates the specified project in Amazon DataZone.

## Request Syntax
<a name="API_UpdateProject_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/projects/identifier HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "domainUnitId": "string",
   "environmentDeploymentDetails": { 
      "environmentFailureReasons": { 
         "string" : [ 
            { 
               "code": "string",
               "message": "string"
            }
         ]
      },
      "overallDeploymentStatus": "string"
   },
   "glossaryTerms": [ "string" ],
   "name": "string",
   "projectProfileVersion": "string",
   "resourceTags": { 
      "string" : "string" 
   },
   "userParameters": [ 
      { 
         "environmentConfigurationName": "string",
         "environmentId": "string",
         "environmentParameters": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "environmentResolvedAccount": { 
            "awsAccountId": "string",
            "regionName": "string",
            "sourceAccountPoolId": "string"
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-uri-domainIdentifier"></a>
The ID of the Amazon DataZone domain where a project is being updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-uri-identifier"></a>
The identifier of the project that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-description"></a>
The description to be updated as part of the `UpdateProject` action.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [domainUnitId](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-domainUnitId"></a>
The ID of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: No

 ** [environmentDeploymentDetails](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-environmentDeploymentDetails"></a>
The environment deployment details of the project.  
Type: [EnvironmentDeploymentDetails](API_EnvironmentDeploymentDetails.md) object  
Required: No

 ** [glossaryTerms](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-glossaryTerms"></a>
The glossary terms to be updated as part of the `UpdateProject` action.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: No

 ** [name](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-name"></a>
The name to be updated as part of the `UpdateProject` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: No

 ** [projectProfileVersion](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-projectProfileVersion"></a>
The project profile version to which the project should be updated. You can only specify the following string for this parameter: `latest`.  
Type: String  
Required: No

 ** [resourceTags](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-resourceTags"></a>
The resource tags of the project.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 25 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `[\w \.:/=+@-]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `[\w \.:/=+@-]*`   
Required: No

 ** [userParameters](#API_UpdateProject_RequestSyntax) **   <a name="datazone-UpdateProject-request-userParameters"></a>
The user parameters of the project.  
Type: Array of [EnvironmentConfigurationUserParameter](API_EnvironmentConfigurationUserParameter.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentDeploymentDetails": { 
      "environmentFailureReasons": { 
         "string" : [ 
            { 
               "code": "string",
               "message": "string"
            }
         ]
      },
      "overallDeploymentStatus": "string"
   },
   "failureReasons": [ 
      { 
         "code": "string",
         "message": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "projectCategory": "string",
   "projectProfileId": "string",
   "projectStatus": "string",
   "resourceTags": [ 
      { 
         "key": "string",
         "source": "string",
         "value": "string"
      }
   ],
   "userParameters": [ 
      { 
         "environmentConfigurationName": "string",
         "environmentId": "string",
         "environmentParameters": [ 
            { 
               "name": "string",
               "value": "string"
            }
         ],
         "environmentResolvedAccount": { 
            "awsAccountId": "string",
            "regionName": "string",
            "sourceAccountPoolId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_UpdateProject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-createdAt"></a>
The timestamp of when the project was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-createdBy"></a>
The Amazon DataZone user who created the project.  
Type: String

 ** [description](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-description"></a>
The description of the project that is to be updated.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a project is updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-domainUnitId"></a>
The ID of the domain unit.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentDeploymentDetails](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-environmentDeploymentDetails"></a>
The environment deployment details of the project.  
Type: [EnvironmentDeploymentDetails](API_EnvironmentDeploymentDetails.md) object

 ** [failureReasons](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-failureReasons"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: Array of [ProjectDeletionError](API_ProjectDeletionError.md) objects

 ** [glossaryTerms](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-glossaryTerms"></a>
The glossary terms of the project that are to be updated.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-id"></a>
The identifier of the project that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-lastUpdatedAt"></a>
The timestamp of when the project was last updated.  
Type: Timestamp

 ** [name](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-name"></a>
The name of the project that is to be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectCategory](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-projectCategory"></a>
The category of the project.  
Type: String

 ** [projectProfileId](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-projectProfileId"></a>
The ID of the project profile.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [projectStatus](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-projectStatus"></a>
The status of the project.  
Type: String  
Valid Values: `ACTIVE | DELETING | DELETE_FAILED | UPDATING | UPDATE_FAILED | MOVING` 

 ** [resourceTags](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-resourceTags"></a>
The resource tags of the project.  
Type: Array of [ResourceTag](API_ResourceTag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [userParameters](#API_UpdateProject_ResponseSyntax) **   <a name="datazone-UpdateProject-response-userParameters"></a>
The user parameters of the project.  
Type: Array of [EnvironmentConfigurationUserParameter](API_EnvironmentConfigurationUserParameter.md) objects

## Errors
<a name="API_UpdateProject_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateProject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateProject) 

# UpdateProjectProfile
<a name="API_UpdateProjectProfile"></a>

Updates a project profile.

## Request Syntax
<a name="API_UpdateProjectProfile_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/project-profiles/identifier HTTP/1.1
Content-type: application/json

{
   "allowCustomProjectResourceTags": boolean,
   "description": "string",
   "domainUnitIdentifier": "string",
   "environmentConfigurations": [ 
      { 
         "accountPools": [ "string" ],
         "awsAccount": { ... },
         "awsRegion": { ... },
         "configurationParameters": { 
            "parameterOverrides": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "resolvedParameters": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "ssmPath": "string"
         },
         "deploymentMode": "string",
         "deploymentOrder": number,
         "description": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "name": "string",
   "projectResourceTags": [ 
      { 
         "isValueEditable": boolean,
         "key": "string",
         "value": "string"
      }
   ],
   "projectResourceTagsDescription": "string",
   "status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateProjectProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-uri-domainIdentifier"></a>
The ID of the domain where a project profile is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-uri-identifier"></a>
The ID of a project profile that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateProjectProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [allowCustomProjectResourceTags](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-allowCustomProjectResourceTags"></a>
Specifies whether custom project resource tags are supported.  
Type: Boolean  
Required: No

 ** [description](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-description"></a>
The description of a project profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [domainUnitIdentifier](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-domainUnitIdentifier"></a>
The ID of the domain unit where a project profile is to be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+`   
Required: No

 ** [environmentConfigurations](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-environmentConfigurations"></a>
The environment configurations of a project profile.  
Type: Array of [EnvironmentConfiguration](API_EnvironmentConfiguration.md) objects  
Required: No

 ** [name](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-name"></a>
The name of a project profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+`   
Required: No

 ** [projectResourceTags](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-projectResourceTags"></a>
The resource tags of the project profile.  
Type: Array of [ResourceTagParameter](API_ResourceTagParameter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Required: No

 ** [projectResourceTagsDescription](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-projectResourceTagsDescription"></a>
Field viewable through the UI that provides a project user with the allowed resource tag specifications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [status](#API_UpdateProjectProfile_RequestSyntax) **   <a name="datazone-UpdateProjectProfile-request-status"></a>
The status of a project profile.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Syntax
<a name="API_UpdateProjectProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "allowCustomProjectResourceTags": boolean,
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentConfigurations": [ 
      { 
         "accountPools": [ "string" ],
         "awsAccount": { ... },
         "awsRegion": { ... },
         "configurationParameters": { 
            "parameterOverrides": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "resolvedParameters": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "ssmPath": "string"
         },
         "deploymentMode": "string",
         "deploymentOrder": number,
         "description": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "projectResourceTags": [ 
      { 
         "isValueEditable": boolean,
         "key": "string",
         "value": "string"
      }
   ],
   "projectResourceTagsDescription": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_UpdateProjectProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [allowCustomProjectResourceTags](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-allowCustomProjectResourceTags"></a>
Specifies whether custom project resource tags are supported.  
Type: Boolean

 ** [createdAt](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-createdAt"></a>
The timestamp at which a project profile is created.  
Type: Timestamp

 ** [createdBy](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-createdBy"></a>
The user who created a project profile.  
Type: String

 ** [description](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-description"></a>
The description of a project profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [domainId](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-domainId"></a>
The ID of the domain where project profile is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [domainUnitId](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-domainUnitId"></a>
The domain unit ID of the project profile to be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-z0-9_\-]+` 

 ** [environmentConfigurations](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-environmentConfigurations"></a>
The environment configurations of a project profile.  
Type: Array of [EnvironmentConfiguration](API_EnvironmentConfiguration.md) objects

 ** [id](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-id"></a>
The ID of the project profile.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedAt](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-lastUpdatedAt"></a>
The timestamp at which a project profile was last updated.  
Type: Timestamp

 ** [name](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-name"></a>
The name of the project profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\w -]+` 

 ** [projectResourceTags](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-projectResourceTags"></a>
The resource tags of the project profile.  
Type: Array of [ResourceTagParameter](API_ResourceTagParameter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [projectResourceTagsDescription](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-projectResourceTagsDescription"></a>
Field viewable through the UI that provides a project user with the allowed resource tag specifications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [status](#API_UpdateProjectProfile_ResponseSyntax) **   <a name="datazone-UpdateProjectProfile-response-status"></a>
The status of the project profile.  
Type: String  
Valid Values: `ENABLED | DISABLED` 

## Errors
<a name="API_UpdateProjectProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProjectProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateProjectProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateProjectProfile) 

# UpdateRootDomainUnitOwner
<a name="API_UpdateRootDomainUnitOwner"></a>

Updates the owner of the root domain unit.

## Request Syntax
<a name="API_UpdateRootDomainUnitOwner_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/root-domain-unit-owner HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "currentOwner": "string",
   "newOwner": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRootDomainUnitOwner_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateRootDomainUnitOwner_RequestSyntax) **   <a name="datazone-UpdateRootDomainUnitOwner-request-uri-domainIdentifier"></a>
The ID of the domain where the root domain unit owner is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateRootDomainUnitOwner_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_UpdateRootDomainUnitOwner_RequestSyntax) **   <a name="datazone-UpdateRootDomainUnitOwner-request-clientToken"></a>
A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[\x21-\x7E]+`   
Required: No

 ** [currentOwner](#API_UpdateRootDomainUnitOwner_RequestSyntax) **   <a name="datazone-UpdateRootDomainUnitOwner-request-currentOwner"></a>
The current owner of the root domain unit.  
Type: String  
Pattern: `.*(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$).*`   
Required: Yes

 ** [newOwner](#API_UpdateRootDomainUnitOwner_RequestSyntax) **   <a name="datazone-UpdateRootDomainUnitOwner-request-newOwner"></a>
The new owner of the root domain unit.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateRootDomainUnitOwner_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_UpdateRootDomainUnitOwner_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_UpdateRootDomainUnitOwner_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateRootDomainUnitOwner_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateRootDomainUnitOwner) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateRootDomainUnitOwner) 

# UpdateRule
<a name="API_UpdateRule"></a>

Updates a rule. In Amazon DataZone, a rule is a formal agreement that enforces specific requirements across user workflows (e.g., publishing assets to the catalog, requesting subscriptions, creating projects) within the Amazon DataZone data portal. These rules help maintain consistency, ensure compliance, and uphold governance standards in data management processes. For instance, a metadata enforcement rule can specify the required information for creating a subscription request or publishing a data asset to the catalog, ensuring alignment with organizational standards.

## Request Syntax
<a name="API_UpdateRule_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/rules/identifier HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "detail": { ... },
   "includeChildDomainUnits": boolean,
   "name": "string",
   "scope": { 
      "assetType": { 
         "selectionMode": "string",
         "specificAssetTypes": [ "string" ]
      },
      "dataProduct": boolean,
      "project": { 
         "selectionMode": "string",
         "specificProjects": [ "string" ]
      }
   }
}
```

## URI Request Parameters
<a name="API_UpdateRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateRule_RequestSyntax) **   <a name="datazone-UpdateRule-request-uri-domainIdentifier"></a>
The ID of the domain in which a rule is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateRule_RequestSyntax) **   <a name="datazone-UpdateRule-request-uri-identifier"></a>
The ID of the rule that is to be updated  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateRule_RequestSyntax) **   <a name="datazone-UpdateRule-request-description"></a>
The description of the rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Required: No

 ** [detail](#API_UpdateRule_RequestSyntax) **   <a name="datazone-UpdateRule-request-detail"></a>
The detail of the rule.  
Type: [RuleDetail](API_RuleDetail.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [includeChildDomainUnits](#API_UpdateRule_RequestSyntax) **   <a name="datazone-UpdateRule-request-includeChildDomainUnits"></a>
Specifies whether to update this rule in the child domain units.  
Type: Boolean  
Required: No

 ** [name](#API_UpdateRule_RequestSyntax) **   <a name="datazone-UpdateRule-request-name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\w -]+`   
Required: No

 ** [scope](#API_UpdateRule_RequestSyntax) **   <a name="datazone-UpdateRule-request-scope"></a>
The scrope of the rule.  
Type: [RuleScope](API_RuleScope.md) object  
Required: No

## Response Syntax
<a name="API_UpdateRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "action": "string",
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "detail": { ... },
   "identifier": "string",
   "lastUpdatedBy": "string",
   "name": "string",
   "revision": "string",
   "ruleType": "string",
   "scope": { 
      "assetType": { 
         "selectionMode": "string",
         "specificAssetTypes": [ "string" ]
      },
      "dataProduct": boolean,
      "project": { 
         "selectionMode": "string",
         "specificProjects": [ "string" ]
      }
   },
   "target": { ... },
   "updatedAt": number
}
```

## Response Elements
<a name="API_UpdateRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [action](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-action"></a>
The action of the rule.  
Type: String  
Valid Values: `CREATE_LISTING_CHANGE_SET | CREATE_SUBSCRIPTION_REQUEST` 

 ** [createdAt](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-createdAt"></a>
The timestamp at which the rule was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-createdBy"></a>
The user who created the rule.  
Type: String

 ** [description](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-description"></a>
The description of the rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [detail](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-detail"></a>
The detail of the rule.  
Type: [RuleDetail](API_RuleDetail.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [identifier](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-identifier"></a>
The ID of the rule.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [lastUpdatedBy](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-lastUpdatedBy"></a>
The timestamp at which the rule was last updated.  
Type: String

 ** [name](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\w -]+` 

 ** [revision](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-revision"></a>
The revision of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.

 ** [ruleType](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-ruleType"></a>
The type of the rule.  
Type: String  
Valid Values: `METADATA_FORM_ENFORCEMENT | GLOSSARY_TERM_ENFORCEMENT` 

 ** [scope](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-scope"></a>
The scope of the rule.  
Type: [RuleScope](API_RuleScope.md) object

 ** [target](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-target"></a>
The target of the rule.  
Type: [RuleTarget](API_RuleTarget.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [updatedAt](#API_UpdateRule_ResponseSyntax) **   <a name="datazone-UpdateRule-response-updatedAt"></a>
The timestamp at which the rule was last updated.  
Type: Timestamp

## Errors
<a name="API_UpdateRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The request has exceeded the specified service quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateRule) 

# UpdateSubscriptionGrantStatus
<a name="API_UpdateSubscriptionGrantStatus"></a>

Updates the status of the specified subscription grant status in Amazon DataZone.

## Request Syntax
<a name="API_UpdateSubscriptionGrantStatus_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/subscription-grants/identifier/status/assetIdentifier HTTP/1.1
Content-type: application/json

{
   "failureCause": { 
      "message": "string"
   },
   "status": "string",
   "targetName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateSubscriptionGrantStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetIdentifier](#API_UpdateSubscriptionGrantStatus_RequestSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-request-uri-assetIdentifier"></a>
The identifier of the asset the subscription grant status of which is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [domainIdentifier](#API_UpdateSubscriptionGrantStatus_RequestSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateSubscriptionGrantStatus_RequestSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-request-uri-identifier"></a>
The identifier of the subscription grant the status of which is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateSubscriptionGrantStatus_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [failureCause](#API_UpdateSubscriptionGrantStatus_RequestSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-request-failureCause"></a>
Specifies the error message that is returned if the operation cannot be successfully completed.  
Type: [FailureCause](API_FailureCause.md) object  
Required: No

 ** [status](#API_UpdateSubscriptionGrantStatus_RequestSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-request-status"></a>
The status to be updated as part of the `UpdateSubscriptionGrantStatus` action.  
Type: String  
Valid Values: `GRANT_PENDING | REVOKE_PENDING | GRANT_IN_PROGRESS | REVOKE_IN_PROGRESS | GRANTED | REVOKED | GRANT_FAILED | REVOKE_FAILED`   
Required: Yes

 ** [targetName](#API_UpdateSubscriptionGrantStatus_RequestSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-request-targetName"></a>
The target name to be updated as part of the `UpdateSubscriptionGrantStatus` action.  
Type: String  
Required: No

## Response Syntax
<a name="API_UpdateSubscriptionGrantStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assets": [ 
      { 
         "assetId": "string",
         "assetRevision": "string",
         "assetScope": { 
            "assetId": "string",
            "errorMessage": "string",
            "filterIds": [ "string" ],
            "status": "string"
         },
         "failureCause": { 
            "message": "string"
         },
         "failureTimestamp": number,
         "grantedTimestamp": number,
         "permissions": { ... },
         "status": "string",
         "targetName": "string"
      }
   ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "grantedEntity": { ... },
   "id": "string",
   "status": "string",
   "subscriptionId": "string",
   "subscriptionTargetId": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_UpdateSubscriptionGrantStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assets](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-assets"></a>
The details of the asset for which the subscription grant is created.  
Type: Array of [SubscribedAsset](API_SubscribedAsset.md) objects

 ** [createdAt](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-createdAt"></a>
The timestamp of when the subscription grant status was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-createdBy"></a>
The Amazon DataZone domain user who created the subscription grant status.  
Type: String

 ** [domainId](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-environmentId"></a>
The ID of the environment in which the subscription grant is updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [grantedEntity](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-grantedEntity"></a>
The granted entity to be updated as part of the `UpdateSubscriptionGrantStatus` action.  
Type: [GrantedEntity](API_GrantedEntity.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [id](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-id"></a>
The identifier of the subscription grant.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [status](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-status"></a>
The status to be updated as part of the `UpdateSubscriptionGrantStatus` action.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | GRANT_FAILED | REVOKE_FAILED | GRANT_AND_REVOKE_FAILED | COMPLETED | INACCESSIBLE` 

 ** [subscriptionId](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-subscriptionId"></a>
 *This parameter has been deprecated.*   
The identifier of the subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [subscriptionTargetId](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-subscriptionTargetId"></a>
The identifier of the subscription target whose subscription grant status is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [updatedAt](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-updatedAt"></a>
The timestamp of when the subscription grant status is to be updated.  
Type: Timestamp

 ** [updatedBy](#API_UpdateSubscriptionGrantStatus_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionGrantStatus-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription grant status.  
Type: String

## Errors
<a name="API_UpdateSubscriptionGrantStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSubscriptionGrantStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateSubscriptionGrantStatus) 

# UpdateSubscriptionRequest
<a name="API_UpdateSubscriptionRequest"></a>

Updates a specified subscription request in Amazon DataZone.

## Request Syntax
<a name="API_UpdateSubscriptionRequest_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/subscription-requests/identifier HTTP/1.1
Content-type: application/json

{
   "requestReason": "string"
}
```

## URI Request Parameters
<a name="API_UpdateSubscriptionRequest_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateSubscriptionRequest_RequestSyntax) **   <a name="datazone-UpdateSubscriptionRequest-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a subscription request is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateSubscriptionRequest_RequestSyntax) **   <a name="datazone-UpdateSubscriptionRequest-request-uri-identifier"></a>
The identifier of the subscription request that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateSubscriptionRequest_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [requestReason](#API_UpdateSubscriptionRequest_RequestSyntax) **   <a name="datazone-UpdateSubscriptionRequest-request-requestReason"></a>
The reason for the `UpdateSubscriptionRequest` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## Response Syntax
<a name="API_UpdateSubscriptionRequest_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "decisionComment": "string",
   "domainId": "string",
   "existingSubscriptionId": "string",
   "id": "string",
   "metadataForms": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "requestReason": "string",
   "reviewerId": "string",
   "status": "string",
   "subscribedListings": [ 
      { 
         "description": "string",
         "id": "string",
         "item": { ... },
         "name": "string",
         "ownerProjectId": "string",
         "ownerProjectName": "string",
         "revision": "string"
      }
   ],
   "subscribedPrincipals": [ 
      { ... }
   ],
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_UpdateSubscriptionRequest_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdAt](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-createdAt"></a>
The timestamp of when the subscription request was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-createdBy"></a>
The Amazon DataZone user who created the subscription request.  
Type: String

 ** [decisionComment](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-decisionComment"></a>
The decision comment of the `UpdateSubscriptionRequest` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [domainId](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a subscription request is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [existingSubscriptionId](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-existingSubscriptionId"></a>
The ID of the existing subscription.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-id"></a>
The identifier of the subscription request that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [metadataForms](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-metadataForms"></a>
Metadata forms included in the subscription request.  
Type: Array of [FormOutput](API_FormOutput.md) objects

 ** [requestReason](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-requestReason"></a>
The reason for the `UpdateSubscriptionRequest` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [reviewerId](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-reviewerId"></a>
The identifier of the Amazon DataZone user who reviews the subscription request.  
Type: String

 ** [status](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-status"></a>
The status of the subscription request.  
Type: String  
Valid Values: `PENDING | ACCEPTED | REJECTED` 

 ** [subscribedListings](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-subscribedListings"></a>
The subscribed listings of the subscription request.  
Type: Array of [SubscribedListing](API_SubscribedListing.md) objects  
Array Members: Fixed number of 1 item.

 ** [subscribedPrincipals](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-subscribedPrincipals"></a>
The subscribed principals of the subscription request.  
Type: Array of [SubscribedPrincipal](API_SubscribedPrincipal.md) objects  
Array Members: Fixed number of 1 item.

 ** [updatedAt](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-updatedAt"></a>
The timestamp of when the subscription request was updated.  
Type: Timestamp

 ** [updatedBy](#API_UpdateSubscriptionRequest_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionRequest-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription request.  
Type: String

## Errors
<a name="API_UpdateSubscriptionRequest_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSubscriptionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateSubscriptionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateSubscriptionRequest) 

# UpdateSubscriptionTarget
<a name="API_UpdateSubscriptionTarget"></a>

Updates the specified subscription target in Amazon DataZone.

## Request Syntax
<a name="API_UpdateSubscriptionTarget_RequestSyntax"></a>

```
PATCH /v2/domains/domainIdentifier/environments/environmentIdentifier/subscription-targets/identifier HTTP/1.1
Content-type: application/json

{
   "applicableAssetTypes": [ "string" ],
   "authorizedPrincipals": [ "string" ],
   "manageAccessRole": "string",
   "name": "string",
   "provider": "string",
   "subscriptionGrantCreationMode": "string",
   "subscriptionTargetConfig": [ 
      { 
         "content": "string",
         "formName": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateSubscriptionTarget_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a subscription target is to be updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [environmentIdentifier](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-uri-environmentIdentifier"></a>
The identifier of the environment in which a subscription target is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [identifier](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-uri-identifier"></a>
Identifier of the subscription target that is to be updated.  
Pattern: `[a-zA-Z0-9_-]{1,36}`   
Required: Yes

## Request Body
<a name="API_UpdateSubscriptionTarget_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [applicableAssetTypes](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-applicableAssetTypes"></a>
The applicable asset types to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*`   
Required: No

 ** [authorizedPrincipals](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-authorizedPrincipals"></a>
The authorized principals to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9:/._-]*`   
Required: No

 ** [manageAccessRole](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-manageAccessRole"></a>
The manage access role to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: String  
Pattern: `arn:aws(|-cn|-us-gov):iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*`   
Required: No

 ** [name](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-name"></a>
The name to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [provider](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-provider"></a>
The provider to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: String  
Required: No

 ** [subscriptionGrantCreationMode](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-subscriptionGrantCreationMode"></a>
 Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.   
Type: String  
Valid Values: `AUTOMATIC | MANUAL`   
Required: No

 ** [subscriptionTargetConfig](#API_UpdateSubscriptionTarget_RequestSyntax) **   <a name="datazone-UpdateSubscriptionTarget-request-subscriptionTargetConfig"></a>
The configuration to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: Array of [SubscriptionTargetForm](API_SubscriptionTargetForm.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateSubscriptionTarget_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicableAssetTypes": [ "string" ],
   "authorizedPrincipals": [ "string" ],
   "createdAt": number,
   "createdBy": "string",
   "domainId": "string",
   "environmentId": "string",
   "id": "string",
   "manageAccessRole": "string",
   "name": "string",
   "projectId": "string",
   "provider": "string",
   "subscriptionGrantCreationMode": "string",
   "subscriptionTargetConfig": [ 
      { 
         "content": "string",
         "formName": "string"
      }
   ],
   "type": "string",
   "updatedAt": number,
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_UpdateSubscriptionTarget_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicableAssetTypes](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-applicableAssetTypes"></a>
The applicable asset types to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[^\.]*.*` 

 ** [authorizedPrincipals](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-authorizedPrincipals"></a>
The authorized principals to be updated as part of the `UpdateSubscriptionTarget` action. Updates are supported in batches of 5 at a time.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-zA-Z0-9:/._-]*` 

 ** [createdAt](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-createdAt"></a>
The timestamp of when a subscription target was created.  
Type: Timestamp

 ** [createdBy](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-createdBy"></a>
The Amazon DataZone user who created the subscription target.  
Type: String

 ** [domainId](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a subscription target is to be updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [environmentId](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-environmentId"></a>
The identifier of the environment in which a subscription target is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-id"></a>
Identifier of the subscription target that is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [manageAccessRole](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-manageAccessRole"></a>
The manage access role to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: String  
Pattern: `arn:aws(|-cn|-us-gov):iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*` 

 ** [name](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-name"></a>
The name to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [projectId](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-projectId"></a>
The identifier of the project in which a subscription target is to be updated.  
Type: String  
Pattern: `[a-zA-Z0-9_-]{1,36}` 

 ** [provider](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-provider"></a>
The provider to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: String

 ** [subscriptionGrantCreationMode](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-subscriptionGrantCreationMode"></a>
 Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.   
Type: String  
Valid Values: `AUTOMATIC | MANUAL` 

 ** [subscriptionTargetConfig](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-subscriptionTargetConfig"></a>
The configuration to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: Array of [SubscriptionTargetForm](API_SubscriptionTargetForm.md) objects

 ** [type](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-type"></a>
The type to be updated as part of the `UpdateSubscriptionTarget` action.  
Type: String

 ** [updatedAt](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-updatedAt"></a>
The timestamp of when the subscription target was updated.  
Type: Timestamp

 ** [updatedBy](#API_UpdateSubscriptionTarget_ResponseSyntax) **   <a name="datazone-UpdateSubscriptionTarget-response-updatedBy"></a>
The Amazon DataZone user who updated the subscription target.  
Type: String

## Errors
<a name="API_UpdateSubscriptionTarget_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
There is a conflict while performing this action.  
HTTP Status Code: 409

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateSubscriptionTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateSubscriptionTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateSubscriptionTarget) 

# UpdateUserProfile
<a name="API_UpdateUserProfile"></a>

Updates the specified user profile in Amazon DataZone.

## Request Syntax
<a name="API_UpdateUserProfile_RequestSyntax"></a>

```
PUT /v2/domains/domainIdentifier/user-profiles/userIdentifier HTTP/1.1
Content-type: application/json

{
   "sessionName": "string",
   "status": "string",
   "type": "string"
}
```

## URI Request Parameters
<a name="API_UpdateUserProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainIdentifier](#API_UpdateUserProfile_RequestSyntax) **   <a name="datazone-UpdateUserProfile-request-uri-domainIdentifier"></a>
The identifier of the Amazon DataZone domain in which a user profile is updated.  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}`   
Required: Yes

 ** [userIdentifier](#API_UpdateUserProfile_RequestSyntax) **   <a name="datazone-UpdateUserProfile-request-uri-userIdentifier"></a>
The identifier of the user whose user profile is to be updated.  
Pattern: `.*(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$).*`   
Required: Yes

## Request Body
<a name="API_UpdateUserProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [sessionName](#API_UpdateUserProfile_RequestSyntax) **   <a name="datazone-UpdateUserProfile-request-sessionName"></a>
The session name for IAM role sessions.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 64.  
Required: No

 ** [status](#API_UpdateUserProfile_RequestSyntax) **   <a name="datazone-UpdateUserProfile-request-status"></a>
The status of the user profile that are to be updated.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED | ACTIVATED | DEACTIVATED`   
Required: Yes

 ** [type](#API_UpdateUserProfile_RequestSyntax) **   <a name="datazone-UpdateUserProfile-request-type"></a>
The type of the user profile that are to be updated.  
Type: String  
Valid Values: `IAM | SSO`   
Required: No

## Response Syntax
<a name="API_UpdateUserProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "details": { ... },
   "domainId": "string",
   "id": "string",
   "status": "string",
   "type": "string"
}
```

## Response Elements
<a name="API_UpdateUserProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [details](#API_UpdateUserProfile_ResponseSyntax) **   <a name="datazone-UpdateUserProfile-response-details"></a>
The results of the UpdateUserProfile action.  
Type: [UserProfileDetails](API_UserProfileDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [domainId](#API_UpdateUserProfile_ResponseSyntax) **   <a name="datazone-UpdateUserProfile-response-domainId"></a>
The identifier of the Amazon DataZone domain in which a user profile is updated.  
Type: String  
Pattern: `dzd[-_][a-zA-Z0-9_-]{1,36}` 

 ** [id](#API_UpdateUserProfile_ResponseSyntax) **   <a name="datazone-UpdateUserProfile-response-id"></a>
The identifier of the user profile.  
Type: String  
Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` 

 ** [status](#API_UpdateUserProfile_ResponseSyntax) **   <a name="datazone-UpdateUserProfile-response-status"></a>
The status of the user profile.  
Type: String  
Valid Values: `ASSIGNED | NOT_ASSIGNED | ACTIVATED | DEACTIVATED` 

 ** [type](#API_UpdateUserProfile_ResponseSyntax) **   <a name="datazone-UpdateUserProfile-response-type"></a>
The type of the user profile.  
Type: String  
Valid Values: `IAM | SSO` 

## Errors
<a name="API_UpdateUserProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed because of an unknown error, exception or failure.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by the AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateUserProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datazone-2018-05-10/UpdateUserProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datazone-2018-05-10/UpdateUserProfile)