AcceptPredictions

$result = $client->acceptPredictions([/* ... */]);
$promise = $client->acceptPredictionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->acceptPredictions([
    'acceptChoices' => [
        [
            'editedValue' => '<string>',
            'predictionChoice' => <integer>,
            'predictionTarget' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'acceptRule' => [
        'rule' => 'ALL|NONE',
        'threshold' => <float>,
    ],
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
    'revision' => '<string>',
]);

Parameter Details

Result Syntax

[
    'assetId' => '<string>',
    'domainId' => '<string>',
    'revision' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

AcceptSubscriptionRequest

$result = $client->acceptSubscriptionRequest([/* ... */]);
$promise = $client->acceptSubscriptionRequestAsync([/* ... */]);

Accepts a subscription request to a specific asset.

Parameter Syntax

$result = $client->acceptSubscriptionRequest([
    'assetScopes' => [
        [
            'assetId' => '<string>', // REQUIRED
            'filterIds' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'decisionComment' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'decisionComment' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'requestReason' => '<string>',
    'reviewerId' => '<string>',
    'status' => 'PENDING|ACCEPTED|REJECTED',
    'subscribedListings' => [
        [
            'description' => '<string>',
            'id' => '<string>',
            'item' => [
                'assetListing' => [
                    'assetScope' => [
                        'assetId' => '<string>',
                        'errorMessage' => '<string>',
                        'filterIds' => ['<string>', ...],
                        'status' => '<string>',
                    ],
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'entityType' => '<string>',
                    'forms' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'productListing' => [
                    'assetListings' => [
                        [
                            'entityId' => '<string>',
                            'entityRevision' => '<string>',
                            'entityType' => '<string>',
                        ],
                        // ...
                    ],
                    'description' => '<string>',
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                    'name' => '<string>',
                ],
            ],
            'name' => '<string>',
            'ownerProjectId' => '<string>',
            'ownerProjectName' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'subscribedPrincipals' => [
        [
            'project' => [
                'id' => '<string>',
                'name' => '<string>',
            ],
        ],
        // ...
    ],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

AddEntityOwner

$result = $client->addEntityOwner([/* ... */]);
$promise = $client->addEntityOwnerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->addEntityOwner([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'entityIdentifier' => '<string>', // REQUIRED
    'entityType' => 'DOMAIN_UNIT', // REQUIRED
    'owner' => [ // REQUIRED
        'group' => [
            'groupIdentifier' => '<string>', // REQUIRED
        ],
        'user' => [
            'userIdentifier' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

AddPolicyGrant

$result = $client->addPolicyGrant([/* ... */]);
$promise = $client->addPolicyGrantAsync([/* ... */]);

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

Parameter Syntax

$result = $client->addPolicyGrant([
    'clientToken' => '<string>',
    'detail' => [ // REQUIRED
        'addToProjectMemberPool' => [
            'includeChildDomainUnits' => true || false,
        ],
        'createAssetType' => [
            'includeChildDomainUnits' => true || false,
        ],
        'createDomainUnit' => [
            'includeChildDomainUnits' => true || false,
        ],
        'createEnvironment' => [
        ],
        'createEnvironmentProfile' => [
            'domainUnitId' => '<string>',
        ],
        'createFormType' => [
            'includeChildDomainUnits' => true || false,
        ],
        'createGlossary' => [
            'includeChildDomainUnits' => true || false,
        ],
        'createProject' => [
            'includeChildDomainUnits' => true || false,
        ],
        'delegateCreateEnvironmentProfile' => [
        ],
        'overrideDomainUnitOwners' => [
            'includeChildDomainUnits' => true || false,
        ],
        'overrideProjectOwners' => [
            'includeChildDomainUnits' => true || false,
        ],
    ],
    'domainIdentifier' => '<string>', // REQUIRED
    'entityIdentifier' => '<string>', // REQUIRED
    'entityType' => 'DOMAIN_UNIT|ENVIRONMENT_BLUEPRINT_CONFIGURATION|ENVIRONMENT_PROFILE', // REQUIRED
    'policyType' => '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', // REQUIRED
    'principal' => [ // REQUIRED
        'domainUnit' => [
            'domainUnitDesignation' => 'OWNER', // REQUIRED
            'domainUnitGrantFilter' => [
                'allDomainUnitsGrantFilter' => [
                ],
            ],
            'domainUnitIdentifier' => '<string>',
        ],
        'group' => [
            'groupIdentifier' => '<string>',
        ],
        'project' => [
            'projectDesignation' => 'OWNER|CONTRIBUTOR', // REQUIRED
            'projectGrantFilter' => [
                'domainUnitFilter' => [
                    'domainUnit' => '<string>', // REQUIRED
                    'includeChildDomainUnits' => true || false,
                ],
            ],
            'projectIdentifier' => '<string>',
        ],
        'user' => [
            'allUsersGrantFilter' => [
            ],
            'userIdentifier' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

AssociateEnvironmentRole

$result = $client->associateEnvironmentRole([/* ... */]);
$promise = $client->associateEnvironmentRoleAsync([/* ... */]);

Associates the environment role in Amazon DataZone.

Parameter Syntax

$result = $client->associateEnvironmentRole([
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentIdentifier' => '<string>', // REQUIRED
    'environmentRoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CancelMetadataGenerationRun

$result = $client->cancelMetadataGenerationRun([/* ... */]);
$promise = $client->cancelMetadataGenerationRunAsync([/* ... */]);

Cancels the metadata generation run.

Parameter Syntax

$result = $client->cancelMetadataGenerationRun([
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CancelSubscription

$result = $client->cancelSubscription([/* ... */]);
$promise = $client->cancelSubscriptionAsync([/* ... */]);

Cancels the subscription to the specified asset.

Parameter Syntax

$result = $client->cancelSubscription([
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'retainPermissions' => true || false,
    'status' => 'APPROVED|REVOKED|CANCELLED',
    'subscribedListing' => [
        'description' => '<string>',
        'id' => '<string>',
        'item' => [
            'assetListing' => [
                'assetScope' => [
                    'assetId' => '<string>',
                    'errorMessage' => '<string>',
                    'filterIds' => ['<string>', ...],
                    'status' => '<string>',
                ],
                'entityId' => '<string>',
                'entityRevision' => '<string>',
                'entityType' => '<string>',
                'forms' => '<string>',
                'glossaryTerms' => [
                    [
                        'name' => '<string>',
                        'shortDescription' => '<string>',
                    ],
                    // ...
                ],
            ],
            'productListing' => [
                'assetListings' => [
                    [
                        'entityId' => '<string>',
                        'entityRevision' => '<string>',
                        'entityType' => '<string>',
                    ],
                    // ...
                ],
                'description' => '<string>',
                'entityId' => '<string>',
                'entityRevision' => '<string>',
                'glossaryTerms' => [
                    [
                        'name' => '<string>',
                        'shortDescription' => '<string>',
                    ],
                    // ...
                ],
                'name' => '<string>',
            ],
        ],
        'name' => '<string>',
        'ownerProjectId' => '<string>',
        'ownerProjectName' => '<string>',
        'revision' => '<string>',
    ],
    'subscribedPrincipal' => [
        'project' => [
            'id' => '<string>',
            'name' => '<string>',
        ],
    ],
    'subscriptionRequestId' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateAsset

$result = $client->createAsset([/* ... */]);
$promise = $client->createAssetAsync([/* ... */]);

Creates an asset in Amazon DataZone catalog.

Parameter Syntax

$result = $client->createAsset([
    'clientToken' => '<string>',
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'externalIdentifier' => '<string>',
    'formsInput' => [
        [
            'content' => '<string>',
            'formName' => '<string>', // REQUIRED
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'owningProjectIdentifier' => '<string>', // REQUIRED
    'predictionConfiguration' => [
        'businessNameGeneration' => [
            'enabled' => true || false,
        ],
    ],
    'typeIdentifier' => '<string>', // REQUIRED
    'typeRevision' => '<string>',
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'externalIdentifier' => '<string>',
    'firstRevisionCreatedAt' => <DateTime>,
    'firstRevisionCreatedBy' => '<string>',
    'formsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'id' => '<string>',
    'latestTimeSeriesDataPointFormsOutput' => [
        [
            'contentSummary' => '<string>',
            'formName' => '<string>',
            'id' => '<string>',
            'timestamp' => <DateTime>,
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'listing' => [
        'listingId' => '<string>',
        'listingStatus' => 'CREATING|ACTIVE|INACTIVE',
    ],
    'name' => '<string>',
    'owningProjectId' => '<string>',
    'predictionConfiguration' => [
        'businessNameGeneration' => [
            'enabled' => true || false,
        ],
    ],
    'readOnlyFormsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'revision' => '<string>',
    'typeIdentifier' => '<string>',
    'typeRevision' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateAssetFilter

$result = $client->createAssetFilter([/* ... */]);
$promise = $client->createAssetFilterAsync([/* ... */]);

Creates a data asset filter.

Parameter Syntax

$result = $client->createAssetFilter([
    'assetIdentifier' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'configuration' => [ // REQUIRED
        'columnConfiguration' => [
            'includedColumnNames' => ['<string>', ...],
        ],
        'rowConfiguration' => [
            'rowFilter' => [ // REQUIRED
                'and' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'expression' => [
                    'equalTo' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    'greaterThan' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    'greaterThanOrEqualTo' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    'in' => [
                        'columnName' => '<string>', // REQUIRED
                        'values' => ['<string>', ...], // REQUIRED
                    ],
                    'isNotNull' => [
                        'columnName' => '<string>', // REQUIRED
                    ],
                    'isNull' => [
                        'columnName' => '<string>', // REQUIRED
                    ],
                    'lessThan' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    'lessThanOrEqualTo' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    'like' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    'notEqualTo' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    'notIn' => [
                        'columnName' => '<string>', // REQUIRED
                        'values' => ['<string>', ...], // REQUIRED
                    ],
                    'notLike' => [
                        'columnName' => '<string>', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                ],
                'or' => [
                    [...], // RECURSIVE
                    // ...
                ],
            ],
            'sensitive' => true || false,
        ],
    ],
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assetId' => '<string>',
    'configuration' => [
        'columnConfiguration' => [
            'includedColumnNames' => ['<string>', ...],
        ],
        'rowConfiguration' => [
            'rowFilter' => [
                'and' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'expression' => [
                    'equalTo' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                    'greaterThan' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                    'greaterThanOrEqualTo' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                    'in' => [
                        'columnName' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    'isNotNull' => [
                        'columnName' => '<string>',
                    ],
                    'isNull' => [
                        'columnName' => '<string>',
                    ],
                    'lessThan' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                    'lessThanOrEqualTo' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                    'like' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                    'notEqualTo' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                    'notIn' => [
                        'columnName' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    'notLike' => [
                        'columnName' => '<string>',
                        'value' => '<string>',
                    ],
                ],
                'or' => [
                    [...], // RECURSIVE
                    // ...
                ],
            ],
            'sensitive' => true || false,
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'domainId' => '<string>',
    'effectiveColumnNames' => ['<string>', ...],
    'effectiveRowFilter' => '<string>',
    'errorMessage' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => 'VALID|INVALID',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateAssetRevision

$result = $client->createAssetRevision([/* ... */]);
$promise = $client->createAssetRevisionAsync([/* ... */]);

Creates a revision of the asset.

Parameter Syntax

$result = $client->createAssetRevision([
    'clientToken' => '<string>',
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'formsInput' => [
        [
            'content' => '<string>',
            'formName' => '<string>', // REQUIRED
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'identifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'predictionConfiguration' => [
        'businessNameGeneration' => [
            'enabled' => true || false,
        ],
    ],
    'typeRevision' => '<string>',
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'externalIdentifier' => '<string>',
    'firstRevisionCreatedAt' => <DateTime>,
    'firstRevisionCreatedBy' => '<string>',
    'formsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'id' => '<string>',
    'latestTimeSeriesDataPointFormsOutput' => [
        [
            'contentSummary' => '<string>',
            'formName' => '<string>',
            'id' => '<string>',
            'timestamp' => <DateTime>,
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'listing' => [
        'listingId' => '<string>',
        'listingStatus' => 'CREATING|ACTIVE|INACTIVE',
    ],
    'name' => '<string>',
    'owningProjectId' => '<string>',
    'predictionConfiguration' => [
        'businessNameGeneration' => [
            'enabled' => true || false,
        ],
    ],
    'readOnlyFormsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'revision' => '<string>',
    'typeIdentifier' => '<string>',
    'typeRevision' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateAssetType

$result = $client->createAssetType([/* ... */]);
$promise = $client->createAssetTypeAsync([/* ... */]);

Creates a custom asset type.

Parameter Syntax

$result = $client->createAssetType([
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'formsInput' => [ // REQUIRED
        '<FormName>' => [
            'required' => true || false,
            'typeIdentifier' => '<string>', // REQUIRED
            'typeRevision' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'owningProjectIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'formsOutput' => [
        '<FormName>' => [
            'required' => true || false,
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>',
    'originDomainId' => '<string>',
    'originProjectId' => '<string>',
    'owningProjectId' => '<string>',
    'revision' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateDataProduct

$result = $client->createDataProduct([/* ... */]);
$promise = $client->createDataProductAsync([/* ... */]);

Creates a data product.

Parameter Syntax

$result = $client->createDataProduct([
    'clientToken' => '<string>',
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'formsInput' => [
        [
            'content' => '<string>',
            'formName' => '<string>', // REQUIRED
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'items' => [
        [
            'glossaryTerms' => ['<string>', ...],
            'identifier' => '<string>', // REQUIRED
            'itemType' => 'ASSET', // REQUIRED
            'revision' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'owningProjectIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'firstRevisionCreatedAt' => <DateTime>,
    'firstRevisionCreatedBy' => '<string>',
    'formsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'id' => '<string>',
    'items' => [
        [
            'glossaryTerms' => ['<string>', ...],
            'identifier' => '<string>',
            'itemType' => 'ASSET',
            'revision' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>',
    'owningProjectId' => '<string>',
    'revision' => '<string>',
    'status' => 'CREATED|CREATING|CREATE_FAILED',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateDataProductRevision

$result = $client->createDataProductRevision([/* ... */]);
$promise = $client->createDataProductRevisionAsync([/* ... */]);

Creates a data product revision.

Parameter Syntax

$result = $client->createDataProductRevision([
    'clientToken' => '<string>',
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'formsInput' => [
        [
            'content' => '<string>',
            'formName' => '<string>', // REQUIRED
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'identifier' => '<string>', // REQUIRED
    'items' => [
        [
            'glossaryTerms' => ['<string>', ...],
            'identifier' => '<string>', // REQUIRED
            'itemType' => 'ASSET', // REQUIRED
            'revision' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'firstRevisionCreatedAt' => <DateTime>,
    'firstRevisionCreatedBy' => '<string>',
    'formsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'id' => '<string>',
    'items' => [
        [
            'glossaryTerms' => ['<string>', ...],
            'identifier' => '<string>',
            'itemType' => 'ASSET',
            'revision' => '<string>',
        ],
        // ...
    ],
    'name' => '<string>',
    'owningProjectId' => '<string>',
    'revision' => '<string>',
    'status' => 'CREATED|CREATING|CREATE_FAILED',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateDataSource

$result = $client->createDataSource([/* ... */]);
$promise = $client->createDataSourceAsync([/* ... */]);

Creates an Amazon DataZone data source.

Parameter Syntax

$result = $client->createDataSource([
    'assetFormsInput' => [
        [
            'content' => '<string>',
            'formName' => '<string>', // REQUIRED
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'configuration' => [
        'glueRunConfiguration' => [
            'autoImportDataQualityResult' => true || false,
            'dataAccessRole' => '<string>',
            'relationalFilterConfigurations' => [ // REQUIRED
                [
                    'databaseName' => '<string>', // REQUIRED
                    'filterExpressions' => [
                        [
                            'expression' => '<string>', // REQUIRED
                            'type' => 'INCLUDE|EXCLUDE', // REQUIRED
                        ],
                        // ...
                    ],
                    'schemaName' => '<string>',
                ],
                // ...
            ],
        ],
        'redshiftRunConfiguration' => [
            'dataAccessRole' => '<string>',
            'redshiftCredentialConfiguration' => [ // REQUIRED
                'secretManagerArn' => '<string>', // REQUIRED
            ],
            'redshiftStorage' => [ // REQUIRED
                'redshiftClusterSource' => [
                    'clusterName' => '<string>', // REQUIRED
                ],
                'redshiftServerlessSource' => [
                    'workgroupName' => '<string>', // REQUIRED
                ],
            ],
            'relationalFilterConfigurations' => [ // REQUIRED
                [
                    'databaseName' => '<string>', // REQUIRED
                    'filterExpressions' => [
                        [
                            'expression' => '<string>', // REQUIRED
                            'type' => 'INCLUDE|EXCLUDE', // REQUIRED
                        ],
                        // ...
                    ],
                    'schemaName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'enableSetting' => 'ENABLED|DISABLED',
    'environmentIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'projectIdentifier' => '<string>', // REQUIRED
    'publishOnImport' => true || false,
    'recommendation' => [
        'enableBusinessNameGeneration' => true || false,
    ],
    'schedule' => [
        'schedule' => '<string>',
        'timezone' => 'UTC|AFRICA_JOHANNESBURG|AMERICA_MONTREAL|AMERICA_SAO_PAULO|ASIA_BAHRAIN|ASIA_BANGKOK|ASIA_CALCUTTA|ASIA_DUBAI|ASIA_HONG_KONG|ASIA_JAKARTA|ASIA_KUALA_LUMPUR|ASIA_SEOUL|ASIA_SHANGHAI|ASIA_SINGAPORE|ASIA_TAIPEI|ASIA_TOKYO|AUSTRALIA_MELBOURNE|AUSTRALIA_SYDNEY|CANADA_CENTRAL|CET|CST6CDT|ETC_GMT|ETC_GMT0|ETC_GMT_ADD_0|ETC_GMT_ADD_1|ETC_GMT_ADD_10|ETC_GMT_ADD_11|ETC_GMT_ADD_12|ETC_GMT_ADD_2|ETC_GMT_ADD_3|ETC_GMT_ADD_4|ETC_GMT_ADD_5|ETC_GMT_ADD_6|ETC_GMT_ADD_7|ETC_GMT_ADD_8|ETC_GMT_ADD_9|ETC_GMT_NEG_0|ETC_GMT_NEG_1|ETC_GMT_NEG_10|ETC_GMT_NEG_11|ETC_GMT_NEG_12|ETC_GMT_NEG_13|ETC_GMT_NEG_14|ETC_GMT_NEG_2|ETC_GMT_NEG_3|ETC_GMT_NEG_4|ETC_GMT_NEG_5|ETC_GMT_NEG_6|ETC_GMT_NEG_7|ETC_GMT_NEG_8|ETC_GMT_NEG_9|EUROPE_DUBLIN|EUROPE_LONDON|EUROPE_PARIS|EUROPE_STOCKHOLM|EUROPE_ZURICH|ISRAEL|MEXICO_GENERAL|MST7MDT|PACIFIC_AUCKLAND|US_CENTRAL|US_EASTERN|US_MOUNTAIN|US_PACIFIC',
    ],
    'type' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assetFormsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'configuration' => [
        'glueRunConfiguration' => [
            'accountId' => '<string>',
            'autoImportDataQualityResult' => true || false,
            'dataAccessRole' => '<string>',
            'region' => '<string>',
            'relationalFilterConfigurations' => [
                [
                    'databaseName' => '<string>',
                    'filterExpressions' => [
                        [
                            'expression' => '<string>',
                            'type' => 'INCLUDE|EXCLUDE',
                        ],
                        // ...
                    ],
                    'schemaName' => '<string>',
                ],
                // ...
            ],
        ],
        'redshiftRunConfiguration' => [
            'accountId' => '<string>',
            'dataAccessRole' => '<string>',
            'redshiftCredentialConfiguration' => [
                'secretManagerArn' => '<string>',
            ],
            'redshiftStorage' => [
                'redshiftClusterSource' => [
                    'clusterName' => '<string>',
                ],
                'redshiftServerlessSource' => [
                    'workgroupName' => '<string>',
                ],
            ],
            'region' => '<string>',
            'relationalFilterConfigurations' => [
                [
                    'databaseName' => '<string>',
                    'filterExpressions' => [
                        [
                            'expression' => '<string>',
                            'type' => 'INCLUDE|EXCLUDE',
                        ],
                        // ...
                    ],
                    'schemaName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'domainId' => '<string>',
    'enableSetting' => 'ENABLED|DISABLED',
    'environmentId' => '<string>',
    'errorMessage' => [
        'errorDetail' => '<string>',
        'errorType' => 'ACCESS_DENIED_EXCEPTION|CONFLICT_EXCEPTION|INTERNAL_SERVER_EXCEPTION|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|THROTTLING_EXCEPTION|VALIDATION_EXCEPTION',
    ],
    'id' => '<string>',
    'lastRunAt' => <DateTime>,
    'lastRunErrorMessage' => [
        'errorDetail' => '<string>',
        'errorType' => 'ACCESS_DENIED_EXCEPTION|CONFLICT_EXCEPTION|INTERNAL_SERVER_EXCEPTION|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|THROTTLING_EXCEPTION|VALIDATION_EXCEPTION',
    ],
    'lastRunStatus' => 'REQUESTED|RUNNING|FAILED|PARTIALLY_SUCCEEDED|SUCCESS',
    'name' => '<string>',
    'projectId' => '<string>',
    'publishOnImport' => true || false,
    'recommendation' => [
        'enableBusinessNameGeneration' => true || false,
    ],
    'schedule' => [
        'schedule' => '<string>',
        'timezone' => 'UTC|AFRICA_JOHANNESBURG|AMERICA_MONTREAL|AMERICA_SAO_PAULO|ASIA_BAHRAIN|ASIA_BANGKOK|ASIA_CALCUTTA|ASIA_DUBAI|ASIA_HONG_KONG|ASIA_JAKARTA|ASIA_KUALA_LUMPUR|ASIA_SEOUL|ASIA_SHANGHAI|ASIA_SINGAPORE|ASIA_TAIPEI|ASIA_TOKYO|AUSTRALIA_MELBOURNE|AUSTRALIA_SYDNEY|CANADA_CENTRAL|CET|CST6CDT|ETC_GMT|ETC_GMT0|ETC_GMT_ADD_0|ETC_GMT_ADD_1|ETC_GMT_ADD_10|ETC_GMT_ADD_11|ETC_GMT_ADD_12|ETC_GMT_ADD_2|ETC_GMT_ADD_3|ETC_GMT_ADD_4|ETC_GMT_ADD_5|ETC_GMT_ADD_6|ETC_GMT_ADD_7|ETC_GMT_ADD_8|ETC_GMT_ADD_9|ETC_GMT_NEG_0|ETC_GMT_NEG_1|ETC_GMT_NEG_10|ETC_GMT_NEG_11|ETC_GMT_NEG_12|ETC_GMT_NEG_13|ETC_GMT_NEG_14|ETC_GMT_NEG_2|ETC_GMT_NEG_3|ETC_GMT_NEG_4|ETC_GMT_NEG_5|ETC_GMT_NEG_6|ETC_GMT_NEG_7|ETC_GMT_NEG_8|ETC_GMT_NEG_9|EUROPE_DUBLIN|EUROPE_LONDON|EUROPE_PARIS|EUROPE_STOCKHOLM|EUROPE_ZURICH|ISRAEL|MEXICO_GENERAL|MST7MDT|PACIFIC_AUCKLAND|US_CENTRAL|US_EASTERN|US_MOUNTAIN|US_PACIFIC',
    ],
    'status' => 'CREATING|FAILED_CREATION|READY|UPDATING|FAILED_UPDATE|RUNNING|DELETING|FAILED_DELETION',
    'type' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates an Amazon DataZone domain.

Parameter Syntax

$result = $client->createDomain([
    'clientToken' => '<string>',
    'description' => '<string>',
    'domainExecutionRole' => '<string>', // REQUIRED
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>', // REQUIRED
    'singleSignOn' => [
        'type' => 'IAM_IDC|DISABLED',
        'userAssignment' => 'AUTOMATIC|MANUAL',
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'description' => '<string>',
    'domainExecutionRole' => '<string>',
    'id' => '<string>',
    'kmsKeyIdentifier' => '<string>',
    'name' => '<string>',
    'portalUrl' => '<string>',
    'rootDomainUnitId' => '<string>',
    'singleSignOn' => [
        'type' => 'IAM_IDC|DISABLED',
        'userAssignment' => 'AUTOMATIC|MANUAL',
    ],
    'status' => 'CREATING|AVAILABLE|CREATION_FAILED|DELETING|DELETED|DELETION_FAILED',
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateDomainUnit

$result = $client->createDomainUnit([/* ... */]);
$promise = $client->createDomainUnitAsync([/* ... */]);

Creates a domain unit in Amazon DataZone.

Parameter Syntax

$result = $client->createDomainUnit([
    'clientToken' => '<string>',
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'parentDomainUnitIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ancestorDomainUnitIds' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'owners' => [
        [
            'group' => [
                'groupId' => '<string>',
            ],
            'user' => [
                'userId' => '<string>',
            ],
        ],
        // ...
    ],
    'parentDomainUnitId' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateEnvironment

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

Create an Amazon DataZone environment.

Parameter Syntax

$result = $client->createEnvironment([
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentAccountIdentifier' => '<string>',
    'environmentAccountRegion' => '<string>',
    'environmentBlueprintIdentifier' => '<string>',
    'environmentProfileIdentifier' => '<string>', // REQUIRED
    'glossaryTerms' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'projectIdentifier' => '<string>', // REQUIRED
    'userParameters' => [
        [
            'name' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'awsAccountId' => '<string>',
    'awsAccountRegion' => '<string>',
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'deploymentProperties' => [
        'endTimeoutMinutes' => <integer>,
        'startTimeoutMinutes' => <integer>,
    ],
    'description' => '<string>',
    'domainId' => '<string>',
    'environmentActions' => [
        [
            'auth' => 'IAM|HTTPS',
            'parameters' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'environmentBlueprintId' => '<string>',
    'environmentProfileId' => '<string>',
    'glossaryTerms' => ['<string>', ...],
    'id' => '<string>',
    'lastDeployment' => [
        'deploymentId' => '<string>',
        'deploymentStatus' => 'IN_PROGRESS|SUCCESSFUL|FAILED|PENDING_DEPLOYMENT',
        'deploymentType' => 'CREATE|UPDATE|DELETE',
        'failureReason' => [
            'code' => '<string>',
            'message' => '<string>',
        ],
        'isDeploymentComplete' => true || false,
        'messages' => ['<string>', ...],
    ],
    'name' => '<string>',
    'projectId' => '<string>',
    'provider' => '<string>',
    'provisionedResources' => [
        [
            'name' => '<string>',
            'provider' => '<string>',
            'type' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'provisioningProperties' => [
        'cloudFormation' => [
            'templateUrl' => '<string>',
        ],
    ],
    'status' => 'ACTIVE|CREATING|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED|VALIDATION_FAILED|SUSPENDED|DISABLED|EXPIRED|DELETED|INACCESSIBLE',
    'updatedAt' => <DateTime>,
    'userParameters' => [
        [
            'defaultValue' => '<string>',
            'description' => '<string>',
            'fieldType' => '<string>',
            'isEditable' => true || false,
            'isOptional' => true || false,
            'keyName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateEnvironmentAction

$result = $client->createEnvironmentAction([/* ... */]);
$promise = $client->createEnvironmentActionAsync([/* ... */]);

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

Parameter Syntax

$result = $client->createEnvironmentAction([
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'parameters' => [ // REQUIRED
        'awsConsoleLink' => [
            'uri' => '<string>',
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'domainId' => '<string>',
    'environmentId' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'parameters' => [
        'awsConsoleLink' => [
            'uri' => '<string>',
        ],
    ],
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateEnvironmentProfile

$result = $client->createEnvironmentProfile([/* ... */]);
$promise = $client->createEnvironmentProfileAsync([/* ... */]);

Creates an Amazon DataZone environment profile.

Parameter Syntax

$result = $client->createEnvironmentProfile([
    'awsAccountId' => '<string>',
    'awsAccountRegion' => '<string>',
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentBlueprintIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'projectIdentifier' => '<string>', // REQUIRED
    'userParameters' => [
        [
            'name' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'awsAccountId' => '<string>',
    'awsAccountRegion' => '<string>',
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'environmentBlueprintId' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'projectId' => '<string>',
    'updatedAt' => <DateTime>,
    'userParameters' => [
        [
            'defaultValue' => '<string>',
            'description' => '<string>',
            'fieldType' => '<string>',
            'isEditable' => true || false,
            'isOptional' => true || false,
            'keyName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateFormType

$result = $client->createFormType([/* ... */]);
$promise = $client->createFormTypeAsync([/* ... */]);

Creates a metadata form type.

Parameter Syntax

$result = $client->createFormType([
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'model' => [ // REQUIRED
        'smithy' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'owningProjectIdentifier' => '<string>', // REQUIRED
    'status' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'domainId' => '<string>',
    'name' => '<string>',
    'originDomainId' => '<string>',
    'originProjectId' => '<string>',
    'owningProjectId' => '<string>',
    'revision' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateGlossary

$result = $client->createGlossary([/* ... */]);
$promise = $client->createGlossaryAsync([/* ... */]);

Creates an Amazon DataZone business glossary.

Parameter Syntax

$result = $client->createGlossary([
    'clientToken' => '<string>',
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'owningProjectIdentifier' => '<string>', // REQUIRED
    'status' => 'DISABLED|ENABLED',
]);

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'owningProjectId' => '<string>',
    'status' => 'DISABLED|ENABLED',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateGlossaryTerm

$result = $client->createGlossaryTerm([/* ... */]);
$promise = $client->createGlossaryTermAsync([/* ... */]);

Creates a business glossary term.

Parameter Syntax

$result = $client->createGlossaryTerm([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'glossaryIdentifier' => '<string>', // REQUIRED
    'longDescription' => '<string>',
    'name' => '<string>', // REQUIRED
    'shortDescription' => '<string>',
    'status' => 'ENABLED|DISABLED',
    'termRelations' => [
        'classifies' => ['<string>', ...],
        'isA' => ['<string>', ...],
    ],
]);

Parameter Details

Result Syntax

[
    'domainId' => '<string>',
    'glossaryId' => '<string>',
    'id' => '<string>',
    'longDescription' => '<string>',
    'name' => '<string>',
    'shortDescription' => '<string>',
    'status' => 'ENABLED|DISABLED',
    'termRelations' => [
        'classifies' => ['<string>', ...],
        'isA' => ['<string>', ...],
    ],
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateGroupProfile

$result = $client->createGroupProfile([/* ... */]);
$promise = $client->createGroupProfileAsync([/* ... */]);

Creates a group profile in Amazon DataZone.

Parameter Syntax

$result = $client->createGroupProfile([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'groupIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'domainId' => '<string>',
    'groupName' => '<string>',
    'id' => '<string>',
    'status' => 'ASSIGNED|NOT_ASSIGNED',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateListingChangeSet

$result = $client->createListingChangeSet([/* ... */]);
$promise = $client->createListingChangeSetAsync([/* ... */]);

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

Parameter Syntax

$result = $client->createListingChangeSet([
    'action' => 'PUBLISH|UNPUBLISH', // REQUIRED
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'entityIdentifier' => '<string>', // REQUIRED
    'entityRevision' => '<string>',
    'entityType' => 'ASSET|DATA_PRODUCT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'listingId' => '<string>',
    'listingRevision' => '<string>',
    'status' => 'CREATING|ACTIVE|INACTIVE',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateProject

$result = $client->createProject([/* ... */]);
$promise = $client->createProjectAsync([/* ... */]);

Creates an Amazon DataZone project.

Parameter Syntax

$result = $client->createProject([
    'description' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'domainUnitId' => '<string>',
    'glossaryTerms' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'domainUnitId' => '<string>',
    'failureReasons' => [
        [
            'code' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'glossaryTerms' => ['<string>', ...],
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'projectStatus' => 'ACTIVE|DELETING|DELETE_FAILED',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

The request has exceeded the specified service quota.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateProjectMembership

$result = $client->createProjectMembership([/* ... */]);
$promise = $client->createProjectMembershipAsync([/* ... */]);

Creates a project membership in Amazon DataZone.

Parameter Syntax

$result = $client->createProjectMembership([
    'designation' => 'PROJECT_OWNER|PROJECT_CONTRIBUTOR', // REQUIRED
    'domainIdentifier' => '<string>', // REQUIRED
    'member' => [ // REQUIRED
        'groupIdentifier' => '<string>',
        'userIdentifier' => '<string>',
    ],
    'projectIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateSubscriptionGrant

$result = $client->createSubscriptionGrant([/* ... */]);
$promise = $client->createSubscriptionGrantAsync([/* ... */]);

Creates a subsscription grant in Amazon DataZone.

Parameter Syntax

$result = $client->createSubscriptionGrant([
    'assetTargetNames' => [
        [
            'assetId' => '<string>', // REQUIRED
            'targetName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentIdentifier' => '<string>', // REQUIRED
    'grantedEntity' => [ // REQUIRED
        'listing' => [
            'identifier' => '<string>', // REQUIRED
            'revision' => '<string>', // REQUIRED
        ],
    ],
    'subscriptionTargetIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assets' => [
        [
            'assetId' => '<string>',
            'assetRevision' => '<string>',
            'assetScope' => [
                'assetId' => '<string>',
                'errorMessage' => '<string>',
                'filterIds' => ['<string>', ...],
                'status' => '<string>',
            ],
            'failureCause' => [
                'message' => '<string>',
            ],
            'failureTimestamp' => <DateTime>,
            'grantedTimestamp' => <DateTime>,
            'status' => 'GRANT_PENDING|REVOKE_PENDING|GRANT_IN_PROGRESS|REVOKE_IN_PROGRESS|GRANTED|REVOKED|GRANT_FAILED|REVOKE_FAILED',
            'targetName' => '<string>',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'domainId' => '<string>',
    'grantedEntity' => [
        'listing' => [
            'id' => '<string>',
            'revision' => '<string>',
        ],
    ],
    'id' => '<string>',
    'status' => 'PENDING|IN_PROGRESS|GRANT_FAILED|REVOKE_FAILED|GRANT_AND_REVOKE_FAILED|COMPLETED|INACCESSIBLE',
    'subscriptionId' => '<string>',
    'subscriptionTargetId' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

InternalServerException:

The request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The specified resource cannot be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

ConflictException:

There is a conflict while performing this action.

ValidationException:

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException:

You do not have permission to perform this action.

CreateSubscriptionRequest

$result = $client->createSubscriptionRequest([/* ... */]);
$promise = $client->createSubscriptionRequestAsync([/* ... */]);

Creates a subscription request in Amazon DataZone.

Parameter Syntax

$result = $client->createSubscriptionRequest([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'requestReason' => '<string>', // REQUIRED
    'subscribedListings' => [ // REQUIRED
        [
            'identifier' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'subscribedPrincipals' => [ // REQUIRED
        [
            'project' => [
                'identifier' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'decisionComment' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'requestReason' => '<string>',
    'reviewerId' => '<string>',
    'status' => 'PENDING|ACCEPTED|REJECTED',
    'subscribedListings' => [
        [
            'description' => '<string>',
            'id' => '<string>',
            'item' => [
                'assetListing' => [
                    'assetScope' => [
                        'assetId' => '<string>',
                        'errorMessage' => '<string>',
                        'filterIds' => ['<string>', ...],
                        'status' => '<string>',
                    ],
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'entityType' => '<string>',
                    'forms' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'productListing' => [
                    'assetListings' => [
                        [
                            'entityId' => '<string>',
                            'entityRevision' => '<string>',
                            'entityType' => '<string>',
                        ],
                        // ...
                    ],
                    'description' => '<string>',
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                    'name' => '<string>',
                ],
            ],
            'name' => '<string>',
            'ownerProjectId' => '<string>',
            'ownerProjectName' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'subscribedPrincipals' => [
        [
            'project' => [
                'id' => '<string>',
                'name' => '<string>',
            ],
        ],
        // ...
    ],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details