AWS SDK for PHP 3.x

Service ID: datazone

Version: 2018-05-10

This page describes the parameters and results for the operations of the Amazon DataZone (2018-05-10), and shows how to use the Aws\DataZone\DataZoneClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptPredictions ( array $params = [] ): Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.
AcceptSubscriptionRequest ( array $params = [] ): Accepts a subscription request to a specific asset.
CancelMetadataGenerationRun ( array $params = [] ): Cancels the metadata generation run.
CancelSubscription ( array $params = [] ): Cancels the subscription to the specified asset.
CreateAsset ( array $params = [] ): Creates an asset in Amazon DataZone catalog.
CreateAssetRevision ( array $params = [] ): Creates a revision of the asset.
CreateAssetType ( array $params = [] ): Creates a custom asset type.
CreateDataSource ( array $params = [] ): Creates an Amazon DataZone data source.
CreateDomain ( array $params = [] ): Creates an Amazon DataZone domain.
CreateEnvironment ( array $params = [] ): Create an Amazon DataZone environment.
CreateEnvironmentProfile ( array $params = [] ): Creates an Amazon DataZone environment profile.
CreateFormType ( array $params = [] ): Creates a metadata form type.
CreateGlossary ( array $params = [] ): Creates an Amazon DataZone business glossary.
CreateGlossaryTerm ( array $params = [] ): Creates a business glossary term.
CreateGroupProfile ( array $params = [] ): Creates a group profile in Amazon DataZone.
CreateListingChangeSet ( array $params = [] ): Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.
CreateProject ( array $params = [] ): Creates an Amazon DataZone project.
CreateProjectMembership ( array $params = [] ): Creates a project membership in Amazon DataZone.
CreateSubscriptionGrant ( array $params = [] ): Creates a subsscription grant in Amazon DataZone.
CreateSubscriptionRequest ( array $params = [] ): Creates a subscription request in Amazon DataZone.
CreateSubscriptionTarget ( array $params = [] ): Creates a subscription target in Amazon DataZone.
CreateUserProfile ( array $params = [] ): Creates a user profile in Amazon DataZone.
DeleteAsset ( array $params = [] ): Delets an asset in Amazon DataZone.
DeleteAssetType ( array $params = [] ): Deletes an asset type in Amazon DataZone.
DeleteDataSource ( array $params = [] ): Deletes a data source in Amazon DataZone.
DeleteDomain ( array $params = [] ): Deletes a Amazon DataZone domain.
DeleteEnvironment ( array $params = [] ): Deletes an environment in Amazon DataZone.
DeleteEnvironmentBlueprintConfiguration ( array $params = [] ): Deletes the blueprint configuration in Amazon DataZone.
DeleteEnvironmentProfile ( array $params = [] ): Deletes an environment profile in Amazon DataZone.
DeleteFormType ( array $params = [] ): Delets and metadata form type in Amazon DataZone.
DeleteGlossary ( array $params = [] ): Deletes a business glossary in Amazon DataZone.
DeleteGlossaryTerm ( array $params = [] ): Deletes a business glossary term in Amazon DataZone.
DeleteListing ( array $params = [] ): Deletes a listing (a record of an asset at a given time).
DeleteProject ( array $params = [] ): Deletes a project in Amazon DataZone.
DeleteProjectMembership ( array $params = [] ): Deletes project membership in Amazon DataZone.
DeleteSubscriptionGrant ( array $params = [] ): Deletes and subscription grant in Amazon DataZone.
DeleteSubscriptionRequest ( array $params = [] ): Deletes a subscription request in Amazon DataZone.
DeleteSubscriptionTarget ( array $params = [] ): Deletes a subscription target in Amazon DataZone.
DeleteTimeSeriesDataPoints ( array $params = [] ): Deletes the specified time series form for the specified asset.
GetAsset ( array $params = [] ): Gets an Amazon DataZone asset.
GetAssetType ( array $params = [] ): Gets an Amazon DataZone asset type.
GetDataSource ( array $params = [] ): Gets an Amazon DataZone data source.
GetDataSourceRun ( array $params = [] ): Gets an Amazon DataZone data source run.
GetDomain ( array $params = [] ): Gets an Amazon DataZone domain.
GetEnvironment ( array $params = [] ): Gets an Amazon DataZone environment.
GetEnvironmentBlueprint ( array $params = [] ): Gets an Amazon DataZone blueprint.
GetEnvironmentBlueprintConfiguration ( array $params = [] ): Gets the blueprint configuration in Amazon DataZone.
GetEnvironmentProfile ( array $params = [] ): Gets an evinronment profile in Amazon DataZone.
GetFormType ( array $params = [] ): Gets a metadata form type in Amazon DataZone.
GetGlossary ( array $params = [] ): Gets a business glossary in Amazon DataZone.
GetGlossaryTerm ( array $params = [] ): Gets a business glossary term in Amazon DataZone.
GetGroupProfile ( array $params = [] ): Gets a group profile in Amazon DataZone.
GetIamPortalLoginUrl ( array $params = [] ): Gets the data portal URL for the specified Amazon DataZone domain.
GetListing ( array $params = [] ): Gets a listing (a record of an asset at a given time).
GetMetadataGenerationRun ( array $params = [] ): Gets a metadata generation run in Amazon DataZone.
GetProject ( array $params = [] ): Gets a project in Amazon DataZone.
GetSubscription ( array $params = [] ): Gets a subscription in Amazon DataZone.
GetSubscriptionGrant ( array $params = [] ): Gets the subscription grant in Amazon DataZone.
GetSubscriptionRequestDetails ( array $params = [] ): Gets the details of the specified subscription request.
GetSubscriptionTarget ( array $params = [] ): Gets the subscription target in Amazon DataZone.
GetTimeSeriesDataPoint ( array $params = [] ): Gets the existing data point for the asset.
GetUserProfile ( array $params = [] ): Gets a user profile in Amazon DataZone.
ListAssetRevisions ( array $params = [] ): Lists the revisions for the asset.
ListDataSourceRunActivities ( array $params = [] ): Lists data source run activities.
ListDataSourceRuns ( array $params = [] ): Lists data source runs in Amazon DataZone.
ListDataSources ( array $params = [] ): Lists data sources in Amazon DataZone.
ListDomains ( array $params = [] ): Lists Amazon DataZone domains.
ListEnvironmentBlueprintConfigurations ( array $params = [] ): Lists blueprint configurations for a Amazon DataZone environment.
ListEnvironmentBlueprints ( array $params = [] ): Lists blueprints in an Amazon DataZone environment.
ListEnvironmentProfiles ( array $params = [] ): Lists Amazon DataZone environment profiles.
ListEnvironments ( array $params = [] ): Lists Amazon DataZone environments.
ListMetadataGenerationRuns ( array $params = [] ): Lists all metadata generation runs.
ListNotifications ( array $params = [] ): Lists all Amazon DataZone notifications.
ListProjectMemberships ( array $params = [] ): Lists all members of the specified project.
ListProjects ( array $params = [] ): Lists Amazon DataZone projects.
ListSubscriptionGrants ( array $params = [] ): Lists subscription grants.
ListSubscriptionRequests ( array $params = [] ): Lists Amazon DataZone subscription requests.
ListSubscriptionTargets ( array $params = [] ): Lists subscription targets in Amazon DataZone.
ListSubscriptions ( array $params = [] ): Lists subscriptions in Amazon DataZone.
ListTagsForResource ( array $params = [] ): Lists tags for the specified resource in Amazon DataZone.
ListTimeSeriesDataPoints ( array $params = [] ): Lists time series data points.
PostTimeSeriesDataPoints ( array $params = [] ): Posts time series data points to Amazon DataZone for the specified asset.
PutEnvironmentBlueprintConfiguration ( array $params = [] ): Writes the configuration for the specified environment blueprint in Amazon DataZone.
RejectPredictions ( array $params = [] ): Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.
RejectSubscriptionRequest ( array $params = [] ): Rejects the specified subscription request.
RevokeSubscription ( array $params = [] ): Revokes a specified subscription in Amazon DataZone.
Search ( array $params = [] ): Searches for assets in Amazon DataZone.
SearchGroupProfiles ( array $params = [] ): Searches group profiles in Amazon DataZone.
SearchListings ( array $params = [] ): Searches listings (records of an asset at a given time) in Amazon DataZone.
SearchTypes ( array $params = [] ): Searches for types in Amazon DataZone.
SearchUserProfiles ( array $params = [] ): Searches user profiles in Amazon DataZone.
StartDataSourceRun ( array $params = [] ): Start the run of the specified data source in Amazon DataZone.
StartMetadataGenerationRun ( array $params = [] ): Starts the metadata generation run.
TagResource ( array $params = [] ): Tags a resource in Amazon DataZone.
UntagResource ( array $params = [] ): Untags a resource in Amazon DataZone.
UpdateDataSource ( array $params = [] ): Updates the specified data source in Amazon DataZone.
UpdateDomain ( array $params = [] ): Updates a Amazon DataZone domain.
UpdateEnvironment ( array $params = [] ): Updates the specified environment in Amazon DataZone.
UpdateEnvironmentProfile ( array $params = [] ): Updates the specified environment profile in Amazon DataZone.
UpdateGlossary ( array $params = [] ): Updates the business glossary in Amazon DataZone.
UpdateGlossaryTerm ( array $params = [] ): Updates a business glossary term in Amazon DataZone.
UpdateGroupProfile ( array $params = [] ): Updates the specified group profile in Amazon DataZone.
UpdateProject ( array $params = [] ): Updates the specified project in Amazon DataZone.
UpdateSubscriptionGrantStatus ( array $params = [] ): Updates the status of the specified subscription grant status in Amazon DataZone.
UpdateSubscriptionRequest ( array $params = [] ): Updates a specified subscription request in Amazon DataZone.
UpdateSubscriptionTarget ( array $params = [] ): Updates the specified subscription target in Amazon DataZone.
UpdateUserProfile ( array $params = [] ): Updates the specified user profile in Amazon DataZone.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAssetRevisions
ListDataSourceRunActivities
ListDataSourceRuns
ListDataSources
ListDomains
ListEnvironmentBlueprintConfigurations
ListEnvironmentBlueprints
ListEnvironmentProfiles
ListEnvironments
ListMetadataGenerationRuns
ListNotifications
ListProjectMemberships
ListProjects
ListSubscriptionGrants
ListSubscriptionRequests
ListSubscriptionTargets
ListSubscriptions
ListTimeSeriesDataPoints
Search
SearchGroupProfiles
SearchListings
SearchTypes
SearchUserProfiles

Operations

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

Members

acceptChoices

Type: Array of AcceptChoice structures

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

acceptRule

Type: AcceptRule structure

Specifies the rule (or the conditions) under which a prediction can be accepted.

clientToken

Type: string

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

identifier

Required: Yes
Type: string

The identifier of the asset.

revision

Type: string

The revision that is to be made to the asset.

Result Syntax

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

Result Details

Members

assetId

Required: Yes
Type: string

The ID of the asset.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

revision

Required: Yes
Type: string

The revision that is to be made to the asset.

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([
    'decisionComment' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

decisionComment

Type: string

A description that specifies the reason for accepting the specified subscription request.

domainIdentifier

Required: Yes
Type: string

The Amazon DataZone domain where the specified subscription request is being accepted.

identifier

Required: Yes
Type: string

The unique identifier of the subscription request that is to be accepted.

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' => [
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'entityType' => '<string>',
                    'forms' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'name' => '<string>',
            'ownerProjectId' => '<string>',
            'ownerProjectName' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'subscribedPrincipals' => [
        [
            'project' => [
                'id' => '<string>',
                'name' => '<string>',
            ],
        ],
        // ...
    ],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that specifies when the subscription request was accepted.

createdBy

Required: Yes
Type: string

Specifies the Amazon DataZone user that accepted the specified subscription request.

decisionComment

Type: string

Specifies the reason for accepting the subscription request.

domainId

Required: Yes
Type: string

The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.

id

Required: Yes
Type: string

The identifier of the subscription request.

requestReason

Required: Yes
Type: string

Specifies the reason for requesting a subscription to the asset.

reviewerId

Type: string

Specifes the ID of the Amazon DataZone user who reviewed the subscription request.

status

Required: Yes
Type: string

Specifies the status of the subscription request.

subscribedListings

Required: Yes
Type: Array of SubscribedListing structures

Specifies the asset for which the subscription request was created.

subscribedPrincipals

Required: Yes
Type: Array of SubscribedPrincipal structures

Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the timestamp when subscription request was updated.

updatedBy

Type: string

Specifies the Amazon DataZone user who updated the subscription request.

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

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.

identifier

Required: Yes
Type: string

The ID of the metadata generation run.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

domainIdentifier

Required: Yes
Type: string

The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

identifier

Required: Yes
Type: string

The unique identifier of the subscription that is being cancelled.

Result Syntax

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

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that specifies when the request to cancel the subscription was created.

createdBy

Required: Yes
Type: string

Specifies the Amazon DataZone user who is cancelling the subscription.

domainId

Required: Yes
Type: string

The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.

id

Required: Yes
Type: string

The identifier of the subscription.

retainPermissions

Type: boolean

Specifies whether the permissions to the asset are retained after the subscription is cancelled.

status

Required: Yes
Type: string

The status of the request to cancel the subscription.

subscribedListing

Required: Yes
Type: SubscribedListing structure

The asset to which a subscription is being cancelled.

subscribedPrincipal

Required: Yes
Type: SubscribedPrincipal structure

The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.

subscriptionRequestId

Type: string

The unique ID of the subscripton request for the subscription that is being cancelled.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that specifies when the subscription was cancelled.

updatedBy

Type: string

The Amazon DataZone user that cancelled the subscription.

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

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

description

Type: string

Asset description.

domainIdentifier

Required: Yes
Type: string

Amazon DataZone domain where the asset is created.

externalIdentifier

Type: string

The external identifier of the asset.

formsInput

Type: Array of FormInput structures

Metadata forms attached to the asset.

glossaryTerms

Type: Array of strings

Glossary terms attached to the asset.

name

Required: Yes
Type: string

Asset name.

owningProjectIdentifier

Required: Yes
Type: string

The unique identifier of the project that owns this asset.

predictionConfiguration

Type: PredictionConfiguration structure

The configuration of the automatically generated business-friendly metadata for the asset.

typeIdentifier

Required: Yes
Type: string

The unique identifier of this asset's type.

typeRevision

Type: string

The revision of this asset's type.

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

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset was created.

createdBy

Type: string

The Amazon DataZone user that created this asset in the catalog.

description

Type: string

The description of the created asset.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the asset was created.

externalIdentifier

Type: string

The external identifier of the asset.

firstRevisionCreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the first revision of the asset took place.

firstRevisionCreatedBy

Type: string

The Amazon DataZone user that made the first revision of the asset.

formsOutput

Required: Yes
Type: Array of FormOutput structures

The metadata forms that are attached to the created asset.

glossaryTerms

Type: Array of strings

The glossary terms that are attached to the created asset.

id

Required: Yes
Type: string

The unique identifier of the created asset.

latestTimeSeriesDataPointFormsOutput

Type: Array of TimeSeriesDataPointSummaryFormOutput structures

The latest data point that was imported into the time series form for the asset.

listing

Type: AssetListingDetails structure

The details of an asset published in an Amazon DataZone catalog.

name

Required: Yes
Type: string

The name of the created asset.

owningProjectId

Required: Yes
Type: string

The ID of the Amazon DataZone project that owns the created asset.

predictionConfiguration

Type: PredictionConfiguration structure

The configuration of the automatically generated business-friendly metadata for the asset.

readOnlyFormsOutput

Type: Array of FormOutput structures

The read-only metadata forms that are attached to the created asset.

revision

Required: Yes
Type: string

The revision of the asset.

typeIdentifier

Required: Yes
Type: string

The identifier of the created asset type.

typeRevision

Required: Yes
Type: string

The revision type of the asset.

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

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

description

Type: string

The revised description of the asset.

domainIdentifier

Required: Yes
Type: string

The unique identifier of the domain where the asset is being revised.

formsInput

Type: Array of FormInput structures

The metadata forms to be attached to the asset as part of asset revision.

glossaryTerms

Type: Array of strings

The glossary terms to be attached to the asset as part of asset revision.

identifier

Required: Yes
Type: string

The identifier of the asset.

name

Required: Yes
Type: string

Te revised name of the asset.

predictionConfiguration

Type: PredictionConfiguration structure

The configuration of the automatically generated business-friendly metadata for the asset.

typeRevision

Type: string

The revision type of the asset.

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

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset revision occured.

createdBy

Type: string

The Amazon DataZone user who performed the asset revision.

description

Type: string

The revised asset description.

domainId

Required: Yes
Type: string

The unique identifier of the Amazon DataZone domain where the asset was revised.

externalIdentifier

Type: string

The external identifier of the asset.

firstRevisionCreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the first asset revision occured.

firstRevisionCreatedBy

Type: string

The Amazon DataZone user who performed the first asset revision.

formsOutput

Required: Yes
Type: Array of FormOutput structures

The metadata forms that were attached to the asset as part of the asset revision.

glossaryTerms

Type: Array of strings

The glossary terms that were attached to the asset as part of asset revision.

id

Required: Yes
Type: string

The unique identifier of the asset revision.

latestTimeSeriesDataPointFormsOutput

Type: Array of TimeSeriesDataPointSummaryFormOutput structures

The latest data point that was imported into the time series form for the asset.

listing

Type: AssetListingDetails structure

The details of an asset published in an Amazon DataZone catalog.

name

Required: Yes
Type: string

The revised name of the asset.

owningProjectId

Required: Yes
Type: string

The unique identifier of the revised project that owns the asset.

predictionConfiguration

Type: PredictionConfiguration structure

The configuration of the automatically generated business-friendly metadata for the asset.

readOnlyFormsOutput

Type: Array of FormOutput structures

The read-only metadata forms that were attached to the asset as part of the asset revision.

revision

Required: Yes
Type: string

The revision of the asset.

typeIdentifier

Required: Yes
Type: string

The identifier of the revision type.

typeRevision

Required: Yes
Type: string

The revision type of the asset.

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

Members

description

Type: string

The descripton of the custom asset type.

domainIdentifier

Required: Yes
Type: string

The unique identifier of the Amazon DataZone domain where the custom asset type is being created.

formsInput

Required: Yes
Type: Associative array of custom strings keys (FormName) to FormEntryInput structures

The metadata forms that are to be attached to the custom asset type.

name

Required: Yes
Type: string

The name of the custom asset type.

owningProjectIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone project that is to own the custom asset type.

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

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset type is to be created.

createdBy

Type: string

The Amazon DataZone user who creates this custom asset type.

description

Type: string

The description of the custom asset type.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the asset type was created.

formsOutput

Required: Yes
Type: Associative array of custom strings keys (FormName) to FormEntryOutput structures

The metadata forms that are attached to the asset type.

name

Required: Yes
Type: string

The name of the asset type.

originDomainId

Type: string

The ID of the Amazon DataZone domain where the asset type was originally created.

originProjectId

Type: string

The ID of the Amazon DataZone project where the asset type was originally created.

owningProjectId

Type: string

The ID of the Amazon DataZone project that currently owns this asset type.

revision

Required: Yes
Type: string

The revision of the custom asset type.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the custom type was created.

updatedBy

Type: string

The Amazon DataZone user that created the custom asset type.

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.

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

Members

assetFormsInput

Type: Array of FormInput structures

The metadata forms that are to be attached to the assets that this data source works with.

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

configuration

Type: DataSourceConfigurationInput structure

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

description

Type: string

The description of the data source.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain where the data source is created.

enableSetting

Type: string

Specifies whether the data source is enabled.

environmentIdentifier

Required: Yes
Type: string

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

name

Required: Yes
Type: string

The name of the data source.

projectIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone project in which you want to add this data source.

publishOnImport

Type: boolean

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

recommendation

Type: RecommendationConfiguration structure

Specifies whether the business name generation is to be enabled for this data source.

schedule

Type: ScheduleConfiguration structure

The schedule of the data source runs.

type

Required: Yes
Type: string

The type of the data source.

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

Members

assetFormsOutput

Type: Array of FormOutput structures

The metadata forms attached to the assets that this data source creates.

configuration

Type: DataSourceConfigurationOutput structure

Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was created.

description

Type: string

The description of the data source.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the data source is created.

enableSetting

Type: string

Specifies whether the data source is enabled.

environmentId

Required: Yes
Type: string

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

errorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The unique identifier of the data source.

lastRunAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that specifies when the data source was last run.

lastRunErrorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

lastRunStatus

Type: string

The status of the last run of this data source.

name

Required: Yes
Type: string

The name of the data source.

projectId

Required: Yes
Type: string

The ID of the Amazon DataZone project to which the data source is added.

publishOnImport

Type: boolean

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

recommendation

Type: RecommendationConfiguration structure

Specifies whether the business name generation is to be enabled for this data source.

schedule

Type: ScheduleConfiguration structure

The schedule of the data source runs.

status

Type: string

The status of the data source.

type

Type: string

The type of the data source.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was updated.

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

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

description

Type: string

The description of the Amazon DataZone domain.

domainExecutionRole

Required: Yes
Type: string

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

kmsKeyIdentifier

Type: string

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

name

Required: Yes
Type: string

The name of the Amazon DataZone domain.

singleSignOn

Type: SingleSignOn structure

The single-sign on configuration of the Amazon DataZone domain.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags specified for the Amazon DataZone domain.

Result Syntax

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

Result Details

Members

arn

Type: string

The ARN of the Amazon DataZone domain.

description

Type: string

The description of the Amazon DataZone domain.

domainExecutionRole

Type: string

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

id

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

kmsKeyIdentifier

Type: string

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

name

Type: string

The name of the Amazon DataZone domain.

portalUrl

Type: string

The URL of the data portal for this Amazon DataZone domain.

singleSignOn

Type: SingleSignOn structure

The single-sign on configuration of the Amazon DataZone domain.

status

Type: string

The status of the Amazon DataZone domain.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags specified for the Amazon DataZone domain.

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.

CreateEnvironment

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

Create an Amazon DataZone environment.

Parameter Syntax

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

Parameter Details

Members

description

Type: string

The description of the Amazon DataZone environment.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the environment is created.

environmentProfileIdentifier

Required: Yes
Type: string

The identifier of the environment profile that is used to create this Amazon DataZone environment.

glossaryTerms

Type: Array of strings

The glossary terms that can be used in this Amazon DataZone environment.

name

Required: Yes
Type: string

The name of the Amazon DataZone environment.

projectIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone project in which this environment is created.

userParameters

Type: Array of EnvironmentParameter structures

The user parameters of this Amazon DataZone environment.

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

Members

awsAccountId

Type: string

The Amazon Web Services account in which the Amazon DataZone environment is created.

awsAccountRegion

Type: string

The Amazon Web Services region in which the Amazon DataZone environment is created.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created this environment.

deploymentProperties

Type: DeploymentProperties structure

The deployment properties of this Amazon DataZone environment.

description

Type: string

The description of this Amazon DataZone environment.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the environment is created.

environmentActions

Type: Array of ConfigurableEnvironmentAction structures

The configurable actions of this Amazon DataZone environment.

environmentBlueprintId

Type: string

The ID of the blueprint with which this Amazon DataZone environment was created.

environmentProfileId

Required: Yes
Type: string

The ID of the environment profile with which this Amazon DataZone environment was created.

glossaryTerms

Type: Array of strings

The glossary terms that can be used in this Amazon DataZone environment.

id

Type: string

The ID of this Amazon DataZone environment.

lastDeployment

Type: Deployment structure

The details of the last deployment of this Amazon DataZone environment.

name

Required: Yes
Type: string

The name of this environment.

projectId

Required: Yes
Type: string

The ID of the Amazon DataZone project in which this environment is created.

provider

Required: Yes
Type: string

The provider of this Amazon DataZone environment.

provisionedResources

Type: Array of Resource structures

The provisioned resources of this Amazon DataZone environment.

provisioningProperties

Type: ProvisioningProperties structure

The provisioning properties of this Amazon DataZone environment.

status

Type: string

The status of this Amazon DataZone environment.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this environment was updated.

userParameters

Type: Array of CustomParameter structures

The user parameters of this Amazon DataZone environment.

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

Members

awsAccountId

Type: string

The Amazon Web Services account in which the Amazon DataZone environment is created.

awsAccountRegion

Type: string

The Amazon Web Services region in which this environment profile is created.

description

Type: string

The description of this Amazon DataZone environment profile.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this environment profile is created.

environmentBlueprintIdentifier

Required: Yes
Type: string

The ID of the blueprint with which this environment profile is created.

name

Required: Yes
Type: string

The name of this Amazon DataZone environment profile.

projectIdentifier

Required: Yes
Type: string

The identifier of the project in which to create the environment profile.

userParameters

Type: Array of EnvironmentParameter structures

The user parameters of this Amazon DataZone environment profile.

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

Members

awsAccountId

Type: string

The Amazon Web Services account ID in which this Amazon DataZone environment profile is created.

awsAccountRegion

Type: string

The Amazon Web Services region in which this Amazon DataZone environment profile is created.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this environment profile was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created this environment profile.

description

Type: string

The description of this Amazon DataZone environment profile.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this environment profile is created.

environmentBlueprintId

Required: Yes
Type: string

The ID of the blueprint with which this environment profile is created.

id

Required: Yes
Type: string

The ID of this Amazon DataZone environment profile.

name

Required: Yes
Type: string

The name of this Amazon DataZone environment profile.

projectId

Type: string

The ID of the Amazon DataZone project in which this environment profile is created.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this environment profile was updated.

userParameters

Type: Array of CustomParameter structures

The user parameters of this Amazon DataZone environment profile.

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

Members

description

Type: string

The description of this Amazon DataZone metadata form type.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this metadata form type is created.

model

Required: Yes
Type: Model structure

The model of this Amazon DataZone metadata form type.

name

Required: Yes
Type: string

The name of this Amazon DataZone metadata form type.

owningProjectIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone project that owns this metadata form type.

status

Type: string

The status of this Amazon DataZone metadata form type.

Result Syntax

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

Result Details

Members

description

Type: string

The description of this Amazon DataZone metadata form type.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this metadata form type is created.

name

Required: Yes
Type: string

The name of this Amazon DataZone metadata form type.

originDomainId

Type: string

The ID of the Amazon DataZone domain in which this metadata form type was originally created.

originProjectId

Type: string

The ID of the project in which this Amazon DataZone metadata form type was originally created.

owningProjectId

Type: string

The ID of the project that owns this Amazon DataZone metadata form type.

revision

Required: Yes
Type: string

The revision of this Amazon DataZone metadata form type.

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

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

description

Type: string

The description of this business glossary.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary is created.

name

Required: Yes
Type: string

The name of this business glossary.

owningProjectIdentifier

Required: Yes
Type: string

The ID of the project that currently owns business glossary.

status

Type: string

The status of this business glossary.

Result Syntax

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

Result Details

Members

description

Type: string

The description of this business glossary.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary is created.

id

Required: Yes
Type: string

The ID of this business glossary.

name

Required: Yes
Type: string

The name of this business glossary.

owningProjectId

Required: Yes
Type: string

The ID of the project that currently owns this business glossary.

status

Type: string

The status of this business glossary.

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

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary term is created.

glossaryIdentifier

Required: Yes
Type: string

The ID of the business glossary in which this term is created.

longDescription

Type: string

The long description of this business glossary term.

name

Required: Yes
Type: string

The name of this business glossary term.

shortDescription

Type: string

The short description of this business glossary term.

status

Type: string

The status of this business glossary term.

termRelations

Type: TermRelations structure

The term relations of this business glossary term.

Result Syntax

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

Result Details

Members

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary term is created.

glossaryId

Required: Yes
Type: string

The ID of the business glossary in which this term is created.

id

Required: Yes
Type: string

The ID of this business glossary term.

longDescription

Type: string

The long description of this business glossary term.

name

Required: Yes
Type: string

The name of this business glossary term.

shortDescription

Type: string

The short description of this business glossary term.

status

Required: Yes
Type: string

The status of this business glossary term.

termRelations

Type: TermRelations structure

The term relations of this business glossary term.

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

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the group profile is created.

groupIdentifier

Required: Yes
Type: string

The identifier of the group for which the group profile is created.

Result Syntax

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

Result Details

Members

domainId

Type: string

The identifier of the Amazon DataZone domain in which the group profile is created.

groupName

Type: string

The name of the group for which group profile is created.

id

Type: string

The identifier of the group profile.

status

Type: string

The status of the group profile.

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', // REQUIRED
]);

Parameter Details

Members

action

Required: Yes
Type: string

Specifies whether to publish or unpublish a listing.

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain.

entityIdentifier

Required: Yes
Type: string

The ID of the asset.

entityRevision

Type: string

The revision of an asset.

entityType

Required: Yes
Type: string

The type of an entity.

Result Syntax

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

Result Details

Members

listingId

Required: Yes
Type: string

The ID of the listing (a record of an asset at a given time).

listingRevision

Required: Yes
Type: string

The revision of a listing.

status

Required: Yes
Type: string

Specifies the status of the listing.

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
    'glossaryTerms' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members

description

Type: string

The description of the Amazon DataZone project.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this project is created.

glossaryTerms

Type: Array of strings

The glossary terms that can be used in this Amazon DataZone project.

name

Required: Yes
Type: string

The name of the Amazon DataZone project.

Result Syntax

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

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the project was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the project.

description

Type: string

The description of the project.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the project was created.

failureReasons

Type: Array of ProjectDeletionError structures

Specifies the error message that is returned if the operation cannot be successfully completed.

glossaryTerms

Type: Array of strings

The glossary terms that can be used in the project.

id

Required: Yes
Type: string

The ID of the Amazon DataZone project.

lastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the project was last updated.

name

Required: Yes
Type: string

The name of the project.

projectStatus

Type: string

The status of the Amazon DataZone project that was created.

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

Members

designation

Required: Yes
Type: string

The designation of the project membership.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which project membership is created.

member

Required: Yes
Type: Member structure

The project member whose project membership was created.

projectIdentifier

Required: Yes
Type: string

The ID of the project for which this project membership was created.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members

assetTargetNames

Type: Array of AssetTargetNameMap structures

The names of the assets for which the subscription grant is created.

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription grant is created.

environmentIdentifier

Required: Yes
Type: string

The ID of the environment in which the subscription grant is created.

grantedEntity

Required: Yes
Type: GrantedEntityInput structure

The entity to which the subscription is to be granted.

subscriptionTargetIdentifier

Required: Yes
Type: string

The ID of the subscription target for which the subscription grant is created.

Result Syntax

[
    'assets' => [
        [
            'assetId' => '<string>',
            'assetRevision' => '<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

Members

assets

Type: Array of SubscribedAsset structures

The assets for which the subscription grant is created.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the subscription grant is created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription grant.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription grant is created.

grantedEntity

Required: Yes
Type: GrantedEntity structure

The entity to which the subscription is granted.

id

Required: Yes
Type: string

The ID of the subscription grant.

status

Required: Yes
Type: string

The status of the subscription grant.

subscriptionId

Type: string

The identifier of the subscription grant.

subscriptionTargetId

Required: Yes
Type: string

The ID of the subscription target for which the subscription grant is created.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the subscription grant was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription grant.

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

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription request is created.

requestReason

Required: Yes
Type: string

The reason for the subscription request.

subscribedListings

Required: Yes
Type: Array of SubscribedListingInput structures

The published asset for which the subscription grant is to be created.

subscribedPrincipals

Required: Yes
Type: Array of SubscribedPrincipalInput structures

The Amazon DataZone principals for whom the subscription request is created.

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' => [
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'entityType' => '<string>',
                    'forms' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'name' => '<string>',
            'ownerProjectId' => '<string>',
            'ownerProjectName' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'subscribedPrincipals' => [
        [
            'project' => [
                'id' => '<string>',
                'name' => '<string>',
            ],
        ],
        // ...
    ],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the subscription request is created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription request.

decisionComment

Type: string

The decision comment of the subscription request.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in whcih the subscription request is created.

id

Required: Yes
Type: string

The ID of the subscription request.

requestReason

Required: Yes
Type: string

The reason for the subscription request.

reviewerId

Type: string

The ID of the reviewer of the subscription request.

status

Required: Yes
Type: string

The status of the subscription request.

subscribedListings

Required: Yes
Type: Array of SubscribedListing structures

The published asset for which the subscription grant is to be created.

subscribedPrincipals

Required: Yes
Type: Array of SubscribedPrincipal structures

The subscribed principals of the subscription request.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription request was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription request.

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.

CreateSubscriptionTarget

$result = $client->createSubscriptionTarget([/* ... */]);
$promise = $client->createSubscriptionTargetAsync([/* ... */]);

Creates a subscription target in Amazon DataZone.

Parameter Syntax

$result = $client->createSubscriptionTarget([
    'applicableAssetTypes' => ['<string>', ...], // REQUIRED
    'authorizedPrincipals' => ['<string>', ...], // REQUIRED
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentIdentifier' => '<string>', // REQUIRED
    'manageAccessRole' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'provider' => '<string>',
    'subscriptionTargetConfig' => [ // REQUIRED
        [
            'content' => '<string>', // REQUIRED
            'formName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'type' => '<string>', // REQUIRED
]);

Parameter Details

Members

applicableAssetTypes

Required: Yes
Type: Array of strings

The asset types that can be included in the subscription target.

authorizedPrincipals

Required: Yes
Type: Array of strings

The authorized principals of the subscription target.

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which subscription target is created.

environmentIdentifier

Required: Yes
Type: string

The ID of the environment in which subscription target is created.

manageAccessRole

Required: Yes
Type: string

The manage access role that is used to create the subscription target.

name

Required: Yes
Type: string

The name of the subscription target.

provider

Type: string

The provider of the subscription target.

subscriptionTargetConfig

Required: Yes
Type: Array of SubscriptionTargetForm structures

The configuration of the subscription target.

type

Required: Yes
Type: string

The type of the subscription target.

Result Syntax

[
    'applicableAssetTypes' => ['<string>', ...],
    'authorizedPrincipals' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'domainId' => '<string>',
    'environmentId' => '<string>',
    'id' => '<string>',
    'manageAccessRole' => '<string>',
    'name' => '<string>',
    'projectId' => '<string>',
    'provider' => '<string>',
    'subscriptionTargetConfig' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
        ],
        // ...
    ],
    'type' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

applicableAssetTypes

Required: Yes
Type: Array of strings

The asset types that can be included in the subscription target.

authorizedPrincipals

Required: Yes
Type: Array of strings

The authorised principals of the subscription target.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription target was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription target.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription target was created.

environmentId

Required: Yes
Type: string

The ID of the environment in which the subscription target was created.

id

Required: Yes
Type: string

The ID of the subscription target.

manageAccessRole

Required: Yes
Type: string

The manage access role with which the subscription target was created.

name

Required: Yes
Type: string

The name of the subscription target.

projectId

Required: Yes
Type: string

???

provider

Required: Yes
Type: string

The provider of the subscription target.

subscriptionTargetConfig

Required: Yes
Type: Array of SubscriptionTargetForm structures

The configuration of the subscription target.

type

Required: Yes
Type: string

The type of the subscription target.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription target was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription target.

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.

CreateUserProfile

$result = $client->createUserProfile([/* ... */]);
$promise = $client->createUserProfileAsync([/* ... */]);

Creates a user profile in Amazon DataZone.

Parameter Syntax

$result = $client->createUserProfile([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'userIdentifier' => '<string>', // REQUIRED
    'userType' => 'IAM_USER|IAM_ROLE|SSO_USER',
]);

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a user profile is created.

userIdentifier

Required: Yes
Type: string

The identifier of the user for which the user profile is created.

userType

Type: string

The user type of the user for which the user profile is created.

Result Syntax

[
    'details' => [
        'iam' => [
            'arn' => '<string>',
        ],
        'sso' => [
            'firstName' => '<string>',
            'lastName' => '<string>',
            'username' => '<string>',
        ],
    ],
    'domainId' => '<string>',
    'id' => '<string>',
    'status' => 'ASSIGNED|NOT_ASSIGNED|ACTIVATED|DEACTIVATED',
    'type' => 'IAM|SSO',
]

Result Details

Members

details

Type: UserProfileDetails structure

The details of the user profile in Amazon DataZone.

domainId

Type: string

The identifier of the Amazon DataZone domain in which a user profile is created.

id

Type: string

The identifier of the user profile.

status

Type: string

The status of the user profile.

type

Type: string

The type of the user profile.

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.

DeleteAsset

$result = $client->deleteAsset([/* ... */]);
$promise = $client->deleteAssetAsync([/* ... */]);

Delets an asset in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the asset is deleted.

identifier

Required: Yes
Type: string

The identifier of the asset that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteAssetType

$result = $client->deleteAssetType([/* ... */]);
$promise = $client->deleteAssetTypeAsync([/* ... */]);

Deletes an asset type in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the asset type is deleted.

identifier

Required: Yes
Type: string

The identifier of the asset type that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteDataSource

$result = $client->deleteDataSource([/* ... */]);
$promise = $client->deleteDataSourceAsync([/* ... */]);

Deletes a data source in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the data source is deleted.

identifier

Required: Yes
Type: string

The identifier of the data source that is deleted.

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,
    '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

Members

assetFormsOutput

Type: Array of FormOutput structures

The asset data forms associated with this data source.

configuration

Type: DataSourceConfigurationOutput structure

The configuration of the data source that is deleted.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this data source was created.

description

Type: string

The description of the data source that is deleted.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the data source is deleted.

enableSetting

Type: string

The enable setting of the data source that specifies whether the data source is enabled or disabled.

environmentId

Required: Yes
Type: string

The ID of the environemnt associated with this data source.

errorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The ID of the data source that is deleted.

lastRunAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was last run.

lastRunErrorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

lastRunStatus

Type: string

The status of the last run of this data source.

name

Required: Yes
Type: string

The name of the data source that is deleted.

projectId

Required: Yes
Type: string

The ID of the project in which this data source exists and from which it's deleted.

publishOnImport

Type: boolean

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

schedule

Type: ScheduleConfiguration structure

The schedule of runs for this data source.

status

Type: string

The status of this data source.

type

Type: string

The type of this data source.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this data source was updated.

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.

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

Deletes a Amazon DataZone domain.

Parameter Syntax

$result = $client->deleteDomain([
    'clientToken' => '<string>',
    'identifier' => '<string>', // REQUIRED
    'skipDeletionCheck' => true || false,
]);

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

identifier

Required: Yes
Type: string

The identifier of the Amazon Web Services domain that is to be deleted.

skipDeletionCheck

Type: boolean

Specifies the optional flag to delete all child entities within the domain.

Result Syntax

[
    'status' => 'CREATING|AVAILABLE|CREATION_FAILED|DELETING|DELETED|DELETION_FAILED',
]

Result Details

Members

status

Required: Yes
Type: string

The status of the domain.

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.

DeleteEnvironment

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

Deletes an environment in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the environment is deleted.

identifier

Required: Yes
Type: string

The identifier of the environment that is to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteEnvironmentBlueprintConfiguration

$result = $client->deleteEnvironmentBlueprintConfiguration([/* ... */]);
$promise = $client->deleteEnvironmentBlueprintConfigurationAsync([/* ... */]);

Deletes the blueprint configuration in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.

environmentBlueprintIdentifier

Required: Yes
Type: string

The ID of the blueprint the configuration of which is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
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.

DeleteEnvironmentProfile

$result = $client->deleteEnvironmentProfile([/* ... */]);
$promise = $client->deleteEnvironmentProfileAsync([/* ... */]);

Deletes an environment profile in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the environment profile is deleted.

identifier

Required: Yes
Type: string

The ID of the environment profile that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteFormType

$result = $client->deleteFormType([/* ... */]);
$promise = $client->deleteFormTypeAsync([/* ... */]);

Delets and metadata form type in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the metadata form type is deleted.

formTypeIdentifier

Required: Yes
Type: string

The ID of the metadata form type that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteGlossary

$result = $client->deleteGlossary([/* ... */]);
$promise = $client->deleteGlossaryAsync([/* ... */]);

Deletes a business glossary in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the business glossary is deleted.

identifier

Required: Yes
Type: string

The ID of the business glossary that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteGlossaryTerm

$result = $client->deleteGlossaryTerm([/* ... */]);
$promise = $client->deleteGlossaryTermAsync([/* ... */]);

Deletes a business glossary term in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the business glossary term is deleted.

identifier

Required: Yes
Type: string

The ID of the business glossary term that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteListing

$result = $client->deleteListing([/* ... */]);
$promise = $client->deleteListingAsync([/* ... */]);

Deletes a listing (a record of an asset at a given time).

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain.

identifier

Required: Yes
Type: string

The ID of the listing to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteProject

$result = $client->deleteProject([/* ... */]);
$promise = $client->deleteProjectAsync([/* ... */]);

Deletes a project in Amazon DataZone.

Parameter Syntax

$result = $client->deleteProject([
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
    'skipDeletionCheck' => true || false,
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the project is deleted.

identifier

Required: Yes
Type: string

The identifier of the project that is to be deleted.

skipDeletionCheck

Type: boolean

Specifies the optional flag to delete all child entities within the project.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteProjectMembership

$result = $client->deleteProjectMembership([/* ... */]);
$promise = $client->deleteProjectMembershipAsync([/* ... */]);

Deletes project membership in Amazon DataZone.

Parameter Syntax

$result = $client->deleteProjectMembership([
    'domainIdentifier' => '<string>', // REQUIRED
    'member' => [ // REQUIRED
        'groupIdentifier' => '<string>',
        'userIdentifier' => '<string>',
    ],
    'projectIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain where project membership is deleted.

member

Required: Yes
Type: Member structure

The project member whose project membership is deleted.

projectIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone project the membership to which is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
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.

DeleteSubscriptionGrant

$result = $client->deleteSubscriptionGrant([/* ... */]);
$promise = $client->deleteSubscriptionGrantAsync([/* ... */]);

Deletes and subscription grant in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain where the subscription grant is deleted.

identifier

Required: Yes
Type: string

The ID of the subscription grant that is deleted.

Result Syntax

[
    'assets' => [
        [
            'assetId' => '<string>',
            'assetRevision' => '<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

Members

assets

Type: Array of SubscribedAsset structures

The assets for which the subsctiption grant that is deleted gave access.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription grant that is deleted was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription grant that is deleted.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription grant is deleted.

grantedEntity

Required: Yes
Type: GrantedEntity structure

The entity to which the subscription is deleted.

id

Required: Yes
Type: string

The ID of the subscription grant that is deleted.

status

Required: Yes
Type: string

The status of the subscription grant that is deleted.

subscriptionId

Type: string

The identifier of the subsctiption whose subscription grant is to be deleted.

subscriptionTargetId

Required: Yes
Type: string

The ID of the subscription target associated with the subscription grant that is deleted.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription grant that is deleted was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription grant that is deleted.

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.

DeleteSubscriptionRequest

$result = $client->deleteSubscriptionRequest([/* ... */]);
$promise = $client->deleteSubscriptionRequestAsync([/* ... */]);

Deletes a subscription request in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription request is deleted.

identifier

Required: Yes
Type: string

The ID of the subscription request that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteSubscriptionTarget

$result = $client->deleteSubscriptionTarget([/* ... */]);
$promise = $client->deleteSubscriptionTargetAsync([/* ... */]);

Deletes a subscription target in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription target is deleted.

environmentIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone environment in which the subscription target is deleted.

identifier

Required: Yes
Type: string

The ID of the subscription target that is deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

DeleteTimeSeriesDataPoints

$result = $client->deleteTimeSeriesDataPoints([/* ... */]);
$promise = $client->deleteTimeSeriesDataPointsAsync([/* ... */]);

Deletes the specified time series form for the specified asset.

Parameter Syntax

$result = $client->deleteTimeSeriesDataPoints([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'entityIdentifier' => '<string>', // REQUIRED
    'entityType' => 'ASSET|LISTING', // REQUIRED
    'formName' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form.

entityIdentifier

Required: Yes
Type: string

The ID of the asset for which you want to delete a time series form.

entityType

Required: Yes
Type: string

The type of the asset for which you want to delete a time series form.

formName

Required: Yes
Type: string

The name of the time series form that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

GetAsset

$result = $client->getAsset([/* ... */]);
$promise = $client->getAssetAsync([/* ... */]);

Gets an Amazon DataZone asset.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain to which the asset belongs.

identifier

Required: Yes
Type: string

The ID of the Amazon DataZone asset.

revision

Type: string

The revision of the Amazon DataZone asset.

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>',
    'readOnlyFormsOutput' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'typeName' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'revision' => '<string>',
    'typeIdentifier' => '<string>',
    'typeRevision' => '<string>',
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset was created.

createdBy

Type: string

The Amazon DataZone user who created the asset.

description

Type: string

The description of the Amazon DataZone asset.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain to which the asset belongs.

externalIdentifier

Type: string

The external ID of the asset.

firstRevisionCreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the first revision of the asset was created.

firstRevisionCreatedBy

Type: string

The Amazon DataZone user who created the first revision of the asset.

formsOutput

Required: Yes
Type: Array of FormOutput structures

The metadata forms attached to the asset.

glossaryTerms

Type: Array of strings

The business glossary terms attached to the asset.

id

Required: Yes
Type: string

The ID of the asset.

latestTimeSeriesDataPointFormsOutput

Type: Array of TimeSeriesDataPointSummaryFormOutput structures

The latest data point that was imported into the time series form for the asset.

listing

Type: AssetListingDetails structure

The listing of the asset.

name

Required: Yes
Type: string

The name of the asset.

owningProjectId

Required: Yes
Type: string

The ID of the project that owns the asset.

readOnlyFormsOutput

Type: Array of FormOutput structures

The read-only metadata forms attached to the asset.

revision

Required: Yes
Type: string

The revision of the asset.

typeIdentifier

Required: Yes
Type: string

The ID of the asset type.

typeRevision

Required: Yes
Type: string

The revision of the asset type.

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.

GetAssetType

$result = $client->getAssetType([/* ... */]);
$promise = $client->getAssetTypeAsync([/* ... */]);

Gets an Amazon DataZone asset type.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the asset type exists.

identifier

Required: Yes
Type: string

The ID of the asset type.

revision

Type: string

The revision of the asset type.

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

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset type was created.

createdBy

Type: string

The Amazon DataZone user who created the asset type.

description

Type: string

The description of the asset type.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the asset type exists.

formsOutput

Required: Yes
Type: Associative array of custom strings keys (FormName) to FormEntryOutput structures

The metadata forms attached to the asset type.

name

Required: Yes
Type: string

The name of the asset type.

originDomainId

Type: string

The ID of the Amazon DataZone domain in which the asset type was originally created.

originProjectId

Type: string

The ID of the Amazon DataZone project in which the asset type was originally created.

owningProjectId

Required: Yes
Type: string

The ID of the Amazon DataZone project that owns the asset type.

revision

Required: Yes
Type: string

The revision of the asset type.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset type was updated.

updatedBy

Type: string

The Amazon DataZone user that updated the asset type.

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.

GetDataSource

$result = $client->getDataSource([/* ... */]);
$promise = $client->getDataSourceAsync([/* ... */]);

Gets an Amazon DataZone data source.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the data source exists.

identifier

Required: Yes
Type: string

The ID of the Amazon DataZone data source.

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>',
    'lastRunAssetCount' => <integer>,
    '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

Members

assetFormsOutput

Type: Array of FormOutput structures

The metadata forms attached to the assets created by this data source.

configuration

Type: DataSourceConfigurationOutput structure

The configuration of the data source.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was created.

description

Type: string

The description of the data source.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the data source exists.

enableSetting

Type: string

Specifies whether this data source is enabled or not.

environmentId

Required: Yes
Type: string

The ID of the environment where this data source creates and publishes assets,

errorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The ID of the data source.

lastRunAssetCount

Type: int

The number of assets created by the data source during its last run.

lastRunAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the last run of the data source.

lastRunErrorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

lastRunStatus

Type: string

The status of the last run of the data source.

name

Required: Yes
Type: string

The name of the data source.

projectId

Required: Yes
Type: string

The ID of the project where the data source creates and publishes assets.

publishOnImport

Type: boolean

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

recommendation

Type: RecommendationConfiguration structure

The recommendation configuration of the data source.

schedule

Type: ScheduleConfiguration structure

The schedule of the data source runs.

status

Type: string

The status of the data source.

type

Type: string

The type of the data source.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was updated.

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.

GetDataSourceRun

$result = $client->getDataSourceRun([/* ... */]);
$promise = $client->getDataSourceRunAsync([/* ... */]);

Gets an Amazon DataZone data source run.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the domain in which this data source run was performed.

identifier

Required: Yes
Type: string

The ID of the data source run.

Result Syntax

[
    'createdAt' => <DateTime>,
    'dataSourceConfigurationSnapshot' => '<string>',
    'dataSourceId' => '<string>',
    'domainId' => '<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>',
    'projectId' => '<string>',
    'runStatisticsForAssets' => [
        'added' => <integer>,
        'failed' => <integer>,
        'skipped' => <integer>,
        'unchanged' => <integer>,
        'updated' => <integer>,
    ],
    'startedAt' => <DateTime>,
    'status' => 'REQUESTED|RUNNING|FAILED|PARTIALLY_SUCCEEDED|SUCCESS',
    'stoppedAt' => <DateTime>,
    'type' => 'PRIORITIZED|SCHEDULED',
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source run was created.

dataSourceConfigurationSnapshot

Type: string

The configuration snapshot of the data source run.

dataSourceId

Required: Yes
Type: string

The ID of the data source for this data source run.

domainId

Required: Yes
Type: string

The ID of the domain in which this data source run was performed.

errorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The ID of the data source run.

projectId

Required: Yes
Type: string

The ID of the project in which this data source run occured.

runStatisticsForAssets

Type: RunStatisticsForAssets structure

The asset statistics from this data source run.

startedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this data source run started.

status

Required: Yes
Type: string

The status of this data source run.

stoppedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this data source run stopped.

type

Required: Yes
Type: string

The type of this data source run.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this data source run was updated.

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.

GetDomain

$result = $client->getDomain([/* ... */]);
$promise = $client->getDomainAsync([/* ... */]);

Gets an Amazon DataZone domain.

Parameter Syntax

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

Parameter Details

Members

identifier

Required: Yes
Type: string

The identifier of the specified Amazon DataZone domain.

Result Syntax

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

Result Details

Members

arn

Type: string

The ARN of the specified Amazon DataZone domain.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the Amazon DataZone domain was created.

description

Type: string

The description of the Amazon DataZone domain.

domainExecutionRole

Required: Yes
Type: string

The domain execution role with which the Amazon DataZone domain is created.

id

Required: Yes
Type: string

The identifier of the specified Amazon DataZone domain.

kmsKeyIdentifier

Type: string

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

lastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the Amazon DataZone domain was last updated.

name

Type: string

The name of the Amazon DataZone domain.

portalUrl

Type: string

The URL of the data portal for this Amazon DataZone domain.

singleSignOn

Type: SingleSignOn structure

The single sing-on option of the specified Amazon DataZone domain.

status

Required: Yes
Type: string

The status of the specified Amazon DataZone domain.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags specified for the Amazon DataZone domain.

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.
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.

GetEnvironment

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

Gets an Amazon DataZone environment.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain where the environment exists.

identifier

Required: Yes
Type: string

The ID of the Amazon DataZone environment.

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

Members

awsAccountId

Type: string

The ID of the Amazon Web Services account where the environment exists.

awsAccountRegion

Type: string

The Amazon Web Services region where the environment exists.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the environment.

deploymentProperties

Type: DeploymentProperties structure

The deployment properties of the environment.

description

Type: string

The description of the environment.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain where the environment exists.

environmentActions

Type: Array of ConfigurableEnvironmentAction structures

The actions of the environment.

environmentBlueprintId

Type: string

The blueprint with which the environment is created.

environmentProfileId

Required: Yes
Type: string

The ID of the environment profile with which the environment is created.

glossaryTerms

Type: Array of strings

The business glossary terms that can be used in this environment.

id

Type: string

The ID of the environment.

lastDeployment

Type: Deployment structure

The details of the last deployment of the environment.

name

Required: Yes
Type: string

The name of the environment.

projectId

Required: Yes
Type: string

The ID of the Amazon DataZone project in which this environment is created.

provider

Required: Yes
Type: string

The provider of this Amazon DataZone environment.

provisionedResources

Type: Array of Resource structures

The provisioned resources of this Amazon DataZone environment.

provisioningProperties

Type: ProvisioningProperties structure

The provisioning properties of this Amazon DataZone environment.

status

Type: string

The status of this Amazon DataZone environment.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this environment was updated.

userParameters

Type: Array of CustomParameter structures

The user parameters of this Amazon DataZone environment.

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.

GetEnvironmentBlueprint

$result = $client->getEnvironmentBlueprint([/* ... */]);
$promise = $client->getEnvironmentBlueprintAsync([/* ... */]);

Gets an Amazon DataZone blueprint.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the domain in which this blueprint exists.

identifier

Required: Yes
Type: string

The ID of this Amazon DataZone blueprint.

Result Syntax

[
    'createdAt' => <DateTime>,
    'deploymentProperties' => [
        'endTimeoutMinutes' => <integer>,
        'startTimeoutMinutes' => <integer>,
    ],
    'description' => '<string>',
    'glossaryTerms' => ['<string>', ...],
    'id' => '<string>',
    'name' => '<string>',
    'provider' => '<string>',
    'provisioningProperties' => [
        'cloudFormation' => [
            'templateUrl' => '<string>',
        ],
    ],
    'updatedAt' => <DateTime>,
    'userParameters' => [
        [
            'defaultValue' => '<string>',
            'description' => '<string>',
            'fieldType' => '<string>',
            'isEditable' => true || false,
            'isOptional' => true || false,
            'keyName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when this blueprint was created.

deploymentProperties

Type: DeploymentProperties structure

The deployment properties of this Amazon DataZone blueprint.

description

Type: string

The description of this Amazon DataZone blueprint.

glossaryTerms

Type: Array of strings

The glossary terms attached to this Amazon DataZone blueprint.

id

Required: Yes
Type: string

The ID of this Amazon DataZone blueprint.

name

Required: Yes
Type: string

The name of this Amazon DataZone blueprint.

provider

Required: Yes
Type: string

The provider of this Amazon DataZone blueprint.

provisioningProperties

Required: Yes
Type: ProvisioningProperties structure

The provisioning properties of this Amazon DataZone blueprint.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this blueprint was updated.

userParameters

Type: Array of CustomParameter structures

The user parameters of this blueprint.

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.

GetEnvironmentBlueprintConfiguration

$result = $client->getEnvironmentBlueprintConfiguration([/* ... */]);
$promise = $client->getEnvironmentBlueprintConfigurationAsync([/* ... */]);

Gets the blueprint configuration in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain where this blueprint exists.

environmentBlueprintIdentifier

Required: Yes
Type: string

He ID of the blueprint.

Result Syntax

[
    'createdAt' => <DateTime>,
    'domainId' => '<string>',
    'enabledRegions' => ['<string>', ...],
    'environmentBlueprintId' => '<string>',
    'manageAccessRoleArn' => '<string>',
    'provisioningRoleArn' => '<string>',
    'regionalParameters' => [
        '<RegionName>' => ['<string>', ...],
        // ...
    ],
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this blueprint was created.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain where this blueprint exists.

enabledRegions

Type: Array of strings

The Amazon Web Services regions in which this blueprint is enabled.

environmentBlueprintId

Required: Yes
Type: string

The ID of the blueprint.

manageAccessRoleArn

Type: string

The ARN of the manage access role with which this blueprint is created.

provisioningRoleArn

Type: string

The ARN of the provisioning role with which this blueprint is created.

regionalParameters

Type: Associative array of custom strings keys (RegionName) to stringss

The regional parameters of the blueprint.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this blueprint was upated.

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.

GetEnvironmentProfile

$result = $client->getEnvironmentProfile([/* ... */]);
$promise = $client->getEnvironmentProfileAsync([/* ... */]);

Gets an evinronment profile in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this environment profile exists.

identifier

Required: Yes
Type: string

The ID of the environment profile.

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

Members

awsAccountId

Type: string

The ID of the Amazon Web Services account where this environment profile exists.

awsAccountRegion

Type: string

The Amazon Web Services region where this environment profile exists.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this environment profile was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created this environment profile.

description

Type: string

The description of the environment profile.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this environment profile exists.

environmentBlueprintId

Required: Yes
Type: string

The ID of the blueprint with which this environment profile is created.

id

Required: Yes
Type: string

The ID of the environment profile.

name

Required: Yes
Type: string

The name of the environment profile.

projectId

Type: string

The ID of the Amazon DataZone project in which this environment profile is created.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this environment profile was upated.

userParameters

Type: Array of CustomParameter structures

The user parameters of the environment profile.

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.

GetFormType

$result = $client->getFormType([/* ... */]);
$promise = $client->getFormTypeAsync([/* ... */]);

Gets a metadata form type in Amazon DataZone.

Parameter Syntax

$result = $client->getFormType([
    'domainIdentifier' => '<string>', // REQUIRED
    'formTypeIdentifier' => '<string>', // REQUIRED
    'revision' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this metadata form type exists.

formTypeIdentifier

Required: Yes
Type: string

The ID of the metadata form type.

revision

Type: string

The revision of this metadata form type.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'imports' => [
        [
            'name' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'model' => [
        'smithy' => '<string>',
    ],
    'name' => '<string>',
    'originDomainId' => '<string>',
    'originProjectId' => '<string>',
    'owningProjectId' => '<string>',
    'revision' => '<string>',
    'status' => 'ENABLED|DISABLED',
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this metadata form type was created.

createdBy

Type: string

The Amazon DataZone user who created this metadata form type.

description

Type: string

The description of the metadata form type.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this metadata form type exists.

imports

Type: Array of Import structures

The imports of the metadata form type.

model

Required: Yes
Type: Model structure

The model of the metadata form type.

name

Required: Yes
Type: string

The name of the metadata form type.

originDomainId

Type: string

The ID of the Amazon DataZone domain in which the metadata form type was originally created.

originProjectId

Type: string

The ID of the project in which this metadata form type was originally created.

owningProjectId

Type: string

The ID of the project that owns this metadata form type.

revision

Required: Yes
Type: string

The revision of the metadata form type.

status

Type: string

The status of the metadata form type.

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.

GetGlossary

$result = $client->getGlossary([/* ... */]);
$promise = $client->getGlossaryAsync([/* ... */]);

Gets a business glossary in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary exists.

identifier

Required: Yes
Type: string

The ID of the business glossary.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'owningProjectId' => '<string>',
    'status' => 'DISABLED|ENABLED',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when this business glossary was created.

createdBy

Type: string

The Amazon DataZone user who created this business glossary.

description

Type: string

The description of the business glossary.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary exists.

id

Required: Yes
Type: string

The ID of the business glossary.

name

Required: Yes
Type: string

The name of the business glossary.

owningProjectId

Required: Yes
Type: string

The ID of the project that owns this business glossary.

status

Required: Yes
Type: string

The status of the business glossary.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the business glossary was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the business glossary.

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.

GetGlossaryTerm

$result = $client->getGlossaryTerm([/* ... */]);
$promise = $client->getGlossaryTermAsync([/* ... */]);

Gets a business glossary term in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary term exists.

identifier

Required: Yes
Type: string

The ID of the business glossary term.

Result Syntax

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

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the business glossary term was created.

createdBy

Type: string

The Amazon DataZone user who created the business glossary.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which this business glossary term exists.

glossaryId

Required: Yes
Type: string

The ID of the business glossary to which this term belongs.

id

Required: Yes
Type: string

The ID of the business glossary term.

longDescription

Type: string

The long description of the business glossary term.

name

Required: Yes
Type: string

The name of the business glossary term.

shortDescription

Type: string

The short decription of the business glossary term.

status

Required: Yes
Type: string

The status of the business glossary term.

termRelations

Type: TermRelations structure

The relations of the business glossary term.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the business glossary term was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the business glossary term.

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.

GetGroupProfile

$result = $client->getGroupProfile([/* ... */]);
$promise = $client->getGroupProfileAsync([/* ... */]);

Gets a group profile in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the group profile exists.

groupIdentifier

Required: Yes
Type: string

The identifier of the group profile.

Result Syntax

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

Result Details

Members

domainId

Type: string

The identifier of the Amazon DataZone domain in which the group profile exists.

groupName

Type: string

The name of the group for which the specified group profile exists.

id

Type: string

The identifier of the group profile.

status

Type: string

The identifier of the group profile.

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.

GetIamPortalLoginUrl

$result = $client->getIamPortalLoginUrl([/* ... */]);
$promise = $client->getIamPortalLoginUrlAsync([/* ... */]);

Gets the data portal URL for the specified Amazon DataZone domain.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

the ID of the Amazon DataZone domain the data portal of which you want to get.

Result Syntax

[
    'authCodeUrl' => '<string>',
    'userProfileId' => '<string>',
]

Result Details

Members

authCodeUrl

Type: string

The data portal URL of the specified Amazon DataZone domain.

userProfileId

Required: Yes
Type: string

The ID of the user profile.

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.

GetListing

$result = $client->getListing([/* ... */]);
$promise = $client->getListingAsync([/* ... */]);

Gets a listing (a record of an asset at a given time).

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain.

identifier

Required: Yes
Type: string

The ID of the listing.

listingRevision

Type: string

The revision of the listing.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'item' => [
        'assetListing' => [
            'assetId' => '<string>',
            'assetRevision' => '<string>',
            'assetType' => '<string>',
            'createdAt' => <DateTime>,
            'forms' => '<string>',
            'glossaryTerms' => [
                [
                    'name' => '<string>',
                    'shortDescription' => '<string>',
                ],
                // ...
            ],
            'latestTimeSeriesDataPointForms' => [
                [
                    'contentSummary' => '<string>',
                    'formName' => '<string>',
                    'id' => '<string>',
                    'timestamp' => <DateTime>,
                    'typeIdentifier' => '<string>',
                    'typeRevision' => '<string>',
                ],
                // ...
            ],
            'owningProjectId' => '<string>',
        ],
    ],
    'listingRevision' => '<string>',
    'name' => '<string>',
    'status' => 'CREATING|ACTIVE|INACTIVE',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the listing was created.

createdBy

Type: string

The Amazon DataZone user who created the listing.

description

Type: string

The description of the listing.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain.

id

Required: Yes
Type: string

The ID of the listing.

item

Type: ListingItem structure

The details of a listing.

listingRevision

Required: Yes
Type: string

The revision of a listing.

name

Type: string

The name of the listing.

status

Type: string

The status of the listing.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the listing was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the listing.

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.

GetMetadataGenerationRun

$result = $client->getMetadataGenerationRun([/* ... */]);
$promise = $client->getMetadataGenerationRunAsync([/* ... */]);

Gets a metadata generation run in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

identifier

Required: Yes
Type: string

The identifier of the metadata generation run.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'owningProjectId' => '<string>',
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELED|SUCCEEDED|FAILED',
    'target' => [
        'identifier' => '<string>',
        'revision' => '<string>',
        'type' => 'ASSET',
    ],
    'type' => 'BUSINESS_DESCRIPTIONS',
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the metadata generation run was start.

createdBy

Type: string

The Amazon DataZone user who started the metadata generation run.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

id

Required: Yes
Type: string

The ID of the metadata generation run.

owningProjectId

Required: Yes
Type: string

The ID of the project that owns the assets for which you're running metadata generation.

status

Type: string

The status of the metadata generation run.

target

Type: MetadataGenerationRunTarget structure

The asset for which you're generating metadata.

type

Type: string

The type of metadata generation run.

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.

GetProject

$result = $client->getProject([/* ... */]);
$promise = $client->getProjectAsync([/* ... */]);

Gets a project in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the project exists.

identifier

Required: Yes
Type: string

The ID of the project.

Result Syntax

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

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the project was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the project.

description

Type: string

The description of the project.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the project exists.

failureReasons

Type: Array of ProjectDeletionError structures

Specifies the error message that is returned if the operation cannot be successfully completed.

glossaryTerms

Type: Array of strings

The business glossary terms that can be used in the project.

id

Required: Yes
Type: string

>The ID of the project.

lastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the project was last updated.

name

Required: Yes
Type: string

The name of the project.

projectStatus

Type: string

The status of the project.

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.

GetSubscription

$result = $client->getSubscription([/* ... */]);
$promise = $client->getSubscriptionAsync([/* ... */]);

Gets a subscription in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription exists.

identifier

Required: Yes
Type: string

The ID of the subscription.

Result Syntax

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

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription exists.

id

Required: Yes
Type: string

The ID of the subscription.

retainPermissions

Type: boolean

The retain permissions of the subscription.

status

Required: Yes
Type: string

The status of the subscription.

subscribedListing

Required: Yes
Type: SubscribedListing structure

The details of the published asset for which the subscription grant is created.

subscribedPrincipal

Required: Yes
Type: SubscribedPrincipal structure

The principal that owns the subscription.

subscriptionRequestId

Type: string

The ID of the subscription request.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription.

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.

GetSubscriptionGrant

$result = $client->getSubscriptionGrant([/* ... */]);
$promise = $client->getSubscriptionGrantAsync([/* ... */]);

Gets the subscription grant in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription grant exists.

identifier

Required: Yes
Type: string

The ID of the subscription grant.

Result Syntax

[
    'assets' => [
        [
            'assetId' => '<string>',
            'assetRevision' => '<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

Members

assets

Type: Array of SubscribedAsset structures

The assets for which the subscription grant is created.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription grant is created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription grant.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription grant exists.

grantedEntity

Required: Yes
Type: GrantedEntity structure

The entity to which the subscription is granted.

id

Required: Yes
Type: string

The ID of the subscription grant.

status

Required: Yes
Type: string

The status of the subscription grant.

subscriptionId

Type: string

The identifier of the subscription.

subscriptionTargetId

Required: Yes
Type: string

The subscription target ID associated with the subscription grant.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription grant was upated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription grant.

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.

GetSubscriptionRequestDetails

$result = $client->getSubscriptionRequestDetails([/* ... */]);
$promise = $client->getSubscriptionRequestDetailsAsync([/* ... */]);

Gets the details of the specified subscription request.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which to get the subscription request details.

identifier

Required: Yes
Type: string

The identifier of the subscription request the details of which to get.

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' => [
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'entityType' => '<string>',
                    'forms' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'name' => '<string>',
            'ownerProjectId' => '<string>',
            'ownerProjectName' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'subscribedPrincipals' => [
        [
            'project' => [
                'id' => '<string>',
                'name' => '<string>',
            ],
        ],
        // ...
    ],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the specified subscription request was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription request.

decisionComment

Type: string

The decision comment of the subscription request.

domainId

Required: Yes
Type: string

The Amazon DataZone domain of the subscription request.

id

Required: Yes
Type: string

The identifier of the subscription request.

requestReason

Required: Yes
Type: string

The reason for the subscription request.

reviewerId

Type: string

The identifier of the Amazon DataZone user who reviewed the subscription request.

status

Required: Yes
Type: string

The status of the subscription request.

subscribedListings

Required: Yes
Type: Array of SubscribedListing structures

The subscribed listings in the subscription request.

subscribedPrincipals

Required: Yes
Type: Array of SubscribedPrincipal structures

The subscribed principals in the subscription request.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription request was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription request.

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.

GetSubscriptionTarget

$result = $client->getSubscriptionTarget([/* ... */]);
$promise = $client->getSubscriptionTargetAsync([/* ... */]);

Gets the subscription target in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription target exists.

environmentIdentifier

Required: Yes
Type: string

The ID of the environment associated with the subscription target.

identifier

Required: Yes
Type: string

The ID of the subscription target.

Result Syntax

[
    'applicableAssetTypes' => ['<string>', ...],
    'authorizedPrincipals' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'domainId' => '<string>',
    'environmentId' => '<string>',
    'id' => '<string>',
    'manageAccessRole' => '<string>',
    'name' => '<string>',
    'projectId' => '<string>',
    'provider' => '<string>',
    'subscriptionTargetConfig' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
        ],
        // ...
    ],
    'type' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

applicableAssetTypes

Required: Yes
Type: Array of strings

The asset types associated with the subscription target.

authorizedPrincipals

Required: Yes
Type: Array of strings

The authorized principals of the subscription target.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription target was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription target.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the subscription target exists.

environmentId

Required: Yes
Type: string

The ID of the environment associated with the subscription target.

id

Required: Yes
Type: string

The ID of the subscription target.

manageAccessRole

Required: Yes
Type: string

The manage access role with which the subscription target was created.

name

Required: Yes
Type: string

The name of the subscription target.

projectId

Required: Yes
Type: string

The ID of the project associated with the subscription target.

provider

Required: Yes
Type: string

The provider of the subscription target.

subscriptionTargetConfig

Required: Yes
Type: Array of SubscriptionTargetForm structures

The configuration of teh subscription target.

type

Required: Yes
Type: string

The type of the subscription target.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription target was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription target.

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.

GetTimeSeriesDataPoint

$result = $client->getTimeSeriesDataPoint([/* ... */]);
$promise = $client->getTimeSeriesDataPointAsync([/* ... */]);

Gets the existing data point for the asset.

Parameter Syntax

$result = $client->getTimeSeriesDataPoint([
    'domainIdentifier' => '<string>', // REQUIRED
    'entityIdentifier' => '<string>', // REQUIRED
    'entityType' => 'ASSET|LISTING', // REQUIRED
    'formName' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain that houses the asset for which you want to get the data point.

entityIdentifier

Required: Yes
Type: string

The ID of the asset for which you want to get the data point.

entityType

Required: Yes
Type: string

The type of the asset for which you want to get the data point.

formName

Required: Yes
Type: string

The name of the time series form that houses the data point that you want to get.

identifier

Required: Yes
Type: string

The ID of the data point that you want to get.

Result Syntax

[
    'domainId' => '<string>',
    'entityId' => '<string>',
    'entityType' => 'ASSET|LISTING',
    'form' => [
        'content' => '<string>',
        'formName' => '<string>',
        'id' => '<string>',
        'timestamp' => <DateTime>,
        'typeIdentifier' => '<string>',
        'typeRevision' => '<string>',
    ],
    'formName' => '<string>',
]

Result Details

Members

domainId

Type: string

The ID of the Amazon DataZone domain that houses the asset data point that you want to get.

entityId

Type: string

The ID of the asset for which you want to get the data point.

entityType

Type: string

The type of the asset for which you want to get the data point.

form

Type: TimeSeriesDataPointFormOutput structure

The time series form that houses the data point that you want to get.

formName

Type: string

The name of the time series form that houses the data point that you want to get.

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.

GetUserProfile

$result = $client->getUserProfile([/* ... */]);
$promise = $client->getUserProfileAsync([/* ... */]);

Gets a user profile in Amazon DataZone.

Parameter Syntax

$result = $client->getUserProfile([
    'domainIdentifier' => '<string>', // REQUIRED
    'type' => 'IAM|SSO',
    'userIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

the ID of the Amazon DataZone domain the data portal of which you want to get.

type

Type: string

The type of the user profile.

userIdentifier

Required: Yes
Type: string

The identifier of the user for which you want to get the user profile.

Result Syntax

[
    'details' => [
        'iam' => [
            'arn' => '<string>',
        ],
        'sso' => [
            'firstName' => '<string>',
            'lastName' => '<string>',
            'username' => '<string>',
        ],
    ],
    'domainId' => '<string>',
    'id' => '<string>',
    'status' => 'ASSIGNED|NOT_ASSIGNED|ACTIVATED|DEACTIVATED',
    'type' => 'IAM|SSO',
]

Result Details

Members

details

Type: UserProfileDetails structure

The details of the user profile in Amazon DataZone.

domainId

Type: string

the identifier of the Amazon DataZone domain of which you want to get the user profile.

id

Type: string

The identifier of the user profile.

status

Type: string

The status of the user profile.

type

Type: string

The type of the user profile.

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.

ListAssetRevisions

$result = $client->listAssetRevisions([/* ... */]);
$promise = $client->listAssetRevisionsAsync([/* ... */]);

Lists the revisions for the asset.

Parameter Syntax

$result = $client->listAssetRevisions([
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the domain.

identifier

Required: Yes
Type: string

The identifier of the asset.

maxResults

Type: int

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.

nextToken

Type: string

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.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'domainId' => '<string>',
            'id' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Type: Array of AssetRevision structures

The results of the ListAssetRevisions action.

nextToken

Type: string

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.

ListDataSourceRunActivities

$result = $client->listDataSourceRunActivities([/* ... */]);
$promise = $client->listDataSourceRunActivitiesAsync([/* ... */]);

Lists data source run activities.

Parameter Syntax

$result = $client->listDataSourceRunActivities([
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'FAILED|PUBLISHING_FAILED|SUCCEEDED_CREATED|SUCCEEDED_UPDATED|SKIPPED_ALREADY_IMPORTED|SKIPPED_ARCHIVED|SKIPPED_NO_ACCESS|UNCHANGED',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which to list data source run activities.

identifier

Required: Yes
Type: string

The identifier of the data source run.

maxResults

Type: int

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.

nextToken

Type: string

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.

status

Type: string

The status of the data source run.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'dataAssetId' => '<string>',
            'dataAssetStatus' => 'FAILED|PUBLISHING_FAILED|SUCCEEDED_CREATED|SUCCEEDED_UPDATED|SKIPPED_ALREADY_IMPORTED|SKIPPED_ARCHIVED|SKIPPED_NO_ACCESS|UNCHANGED',
            'dataSourceRunId' => '<string>',
            'database' => '<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',
            ],
            'projectId' => '<string>',
            'technicalDescription' => '<string>',
            'technicalName' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of DataSourceRunActivity structures

The results of the ListDataSourceRunActivities action.

nextToken

Type: string

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.

ListDataSourceRuns

$result = $client->listDataSourceRuns([/* ... */]);
$promise = $client->listDataSourceRunsAsync([/* ... */]);

Lists data source runs in Amazon DataZone.

Parameter Syntax

$result = $client->listDataSourceRuns([
    'dataSourceIdentifier' => '<string>', // REQUIRED
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'REQUESTED|RUNNING|FAILED|PARTIALLY_SUCCEEDED|SUCCESS',
]);

Parameter Details

Members

dataSourceIdentifier

Required: Yes
Type: string

The identifier of the data source.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

maxResults

Type: int

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.

nextToken

Type: string

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.

status

Type: string

The status of the data source.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'dataSourceId' => '<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>',
            'projectId' => '<string>',
            'runStatisticsForAssets' => [
                'added' => <integer>,
                'failed' => <integer>,
                'skipped' => <integer>,
                'unchanged' => <integer>,
                'updated' => <integer>,
            ],
            'startedAt' => <DateTime>,
            'status' => 'REQUESTED|RUNNING|FAILED|PARTIALLY_SUCCEEDED|SUCCESS',
            'stoppedAt' => <DateTime>,
            'type' => 'PRIORITIZED|SCHEDULED',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of DataSourceRunSummary structures

The results of the ListDataSourceRuns action.

nextToken

Type: string

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.

ListDataSources

$result = $client->listDataSources([/* ... */]);
$promise = $client->listDataSourcesAsync([/* ... */]);

Lists data sources in Amazon DataZone.

Parameter Syntax

$result = $client->listDataSources([
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentIdentifier' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'projectIdentifier' => '<string>', // REQUIRED
    'status' => 'CREATING|FAILED_CREATION|READY|UPDATING|FAILED_UPDATE|RUNNING|DELETING|FAILED_DELETION',
    'type' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which to list the data sources.

environmentIdentifier

Type: string

The identifier of the environment in which to list the data sources.

maxResults

Type: int

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.

name

Type: string

The name of the data source.

nextToken

Type: string

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.

projectIdentifier

Required: Yes
Type: string

The identifier of the project in which to list data sources.

status

Type: string

The status of the data source.

type

Type: string

The type of the data source.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'dataSourceId' => '<string>',
            'domainId' => '<string>',
            'enableSetting' => 'ENABLED|DISABLED',
            'environmentId' => '<string>',
            'lastRunAssetCount' => <integer>,
            '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>',
            '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>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of DataSourceSummary structures

The results of the ListDataSources action.

nextToken

Type: string

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.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Lists Amazon DataZone domains.

Parameter Syntax

$result = $client->listDomains([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'CREATING|AVAILABLE|CREATION_FAILED|DELETING|DELETED|DELETION_FAILED',
]);

Parameter Details

Members

maxResults

Type: int

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.

nextToken

Type: string

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.

status

Type: string

The status of the data source.

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdatedAt' => <DateTime>,
            'managedAccountId' => '<string>',
            'name' => '<string>',
            'portalUrl' => '<string>',
            'status' => 'CREATING|AVAILABLE|CREATION_FAILED|DELETING|DELETED|DELETION_FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of DomainSummary structures

The results of the ListDomains action.

nextToken

Type: string

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.

ListEnvironmentBlueprintConfigurations

$result = $client->listEnvironmentBlueprintConfigurations([/* ... */]);
$promise = $client->listEnvironmentBlueprintConfigurationsAsync([/* ... */]);

Lists blueprint configurations for a Amazon DataZone environment.

Parameter Syntax

$result = $client->listEnvironmentBlueprintConfigurations([
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

maxResults

Type: int

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.

nextToken

Type: string

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.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'domainId' => '<string>',
            'enabledRegions' => ['<string>', ...],
            'environmentBlueprintId' => '<string>',
            'manageAccessRoleArn' => '<string>',
            'provisioningRoleArn' => '<string>',
            'regionalParameters' => [
                '<RegionName>' => ['<string>', ...],
                // ...
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Type: Array of EnvironmentBlueprintConfigurationItem structures

The results of the ListEnvironmentBlueprintConfigurations action.

nextToken

Type: string

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.

ListEnvironmentBlueprints

$result = $client->listEnvironmentBlueprints([/* ... */]);
$promise = $client->listEnvironmentBlueprintsAsync([/* ... */]);

Lists blueprints in an Amazon DataZone environment.

Parameter Syntax

$result = $client->listEnvironmentBlueprints([
    'domainIdentifier' => '<string>', // REQUIRED
    'managed' => true || false,
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

managed

Type: boolean

Specifies whether the environment blueprint is managed by Amazon DataZone.

maxResults

Type: int

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.

name

Type: string

The name of the Amazon DataZone environment.

nextToken

Type: string

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 ListEnvironmentBlueprintsto list the next set of blueprints.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'provider' => '<string>',
            'provisioningProperties' => [
                'cloudFormation' => [
                    'templateUrl' => '<string>',
                ],
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of EnvironmentBlueprintSummary structures

The results of the ListEnvironmentBlueprints action.

nextToken

Type: string

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.

ListEnvironmentProfiles

$result = $client->listEnvironmentProfiles([/* ... */]);
$promise = $client->listEnvironmentProfilesAsync([/* ... */]);

Lists Amazon DataZone environment profiles.

Parameter Syntax

$result = $client->listEnvironmentProfiles([
    'awsAccountId' => '<string>',
    'awsAccountRegion' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentBlueprintIdentifier' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'projectIdentifier' => '<string>',
]);

Parameter Details

Members

awsAccountId

Type: string

The identifier of the Amazon Web Services account where you want to list environment profiles.

awsAccountRegion

Type: string

The Amazon Web Services region where you want to list environment profiles.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

environmentBlueprintIdentifier

Type: string

The identifier of the blueprint that was used to create the environment profiles that you want to list.

maxResults

Type: int

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.

name

Type: string

nextToken

Type: string

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.

projectIdentifier

Type: string

The identifier of the Amazon DataZone project.

Result Syntax

[
    'items' => [
        [
            'awsAccountId' => '<string>',
            'awsAccountRegion' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'description' => '<string>',
            'domainId' => '<string>',
            'environmentBlueprintId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'projectId' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of EnvironmentProfileSummary structures

The results of the ListEnvironmentProfiles action.

nextToken

Type: string

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.
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.

ListEnvironments

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

Lists Amazon DataZone environments.

Parameter Syntax

$result = $client->listEnvironments([
    'awsAccountId' => '<string>',
    'awsAccountRegion' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentBlueprintIdentifier' => '<string>',
    'environmentProfileIdentifier' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'projectIdentifier' => '<string>', // REQUIRED
    'provider' => '<string>',
    'status' => 'ACTIVE|CREATING|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED|VALIDATION_FAILED|SUSPENDED|DISABLED|EXPIRED|DELETED|INACCESSIBLE',
]);

Parameter Details

Members

awsAccountId

Type: string

The identifier of the Amazon Web Services account where you want to list environments.

awsAccountRegion

Type: string

The Amazon Web Services region where you want to list environments.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

environmentBlueprintIdentifier

Type: string

The identifier of the Amazon DataZone blueprint.

environmentProfileIdentifier

Type: string

The identifier of the environment profile.

maxResults

Type: int

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.

name

Type: string

The name of the environment.

nextToken

Type: string

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.

projectIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone project.

provider

Type: string

The provider of the environment.

status

Type: string

The status of the environments that you want to list.

Result Syntax

[
    'items' => [
        [
            'awsAccountId' => '<string>',
            'awsAccountRegion' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'description' => '<string>',
            'domainId' => '<string>',
            'environmentProfileId' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'projectId' => '<string>',
            'provider' => '<string>',
            'status' => 'ACTIVE|CREATING|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|DELETE_FAILED|VALIDATION_FAILED|SUSPENDED|DISABLED|EXPIRED|DELETED|INACCESSIBLE',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of EnvironmentSummary structures

The results of the ListEnvironments action.

nextToken

Type: string

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.
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.

ListMetadataGenerationRuns

$result = $client->listMetadataGenerationRuns([/* ... */]);
$promise = $client->listMetadataGenerationRunsAsync([/* ... */]);

Lists all metadata generation runs.

Parameter Syntax

$result = $client->listMetadataGenerationRuns([
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELED|SUCCEEDED|FAILED',
    'type' => 'BUSINESS_DESCRIPTIONS',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain where you want to list metadata generation runs.

maxResults

Type: int

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.

nextToken

Type: string

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.

status

Type: string

The status of the metadata generation runs.

type

Type: string

The type of the metadata generation runs.

Result Syntax

[
    'items' => [
        [
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'domainId' => '<string>',
            'id' => '<string>',
            'owningProjectId' => '<string>',
            'status' => 'SUBMITTED|IN_PROGRESS|CANCELED|SUCCEEDED|FAILED',
            'target' => [
                'identifier' => '<string>',
                'revision' => '<string>',
                'type' => 'ASSET',
            ],
            'type' => 'BUSINESS_DESCRIPTIONS',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Type: Array of MetadataGenerationRunItem structures

The results of the ListMetadataGenerationRuns action.

nextToken

Type: string

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.

ListNotifications

$result = $client->listNotifications([/* ... */]);
$promise = $client->listNotificationsAsync([/* ... */]);

Lists all Amazon DataZone notifications.

Parameter Syntax

$result = $client->listNotifications([
    'afterTimestamp' => <integer || string || DateTime>,
    'beforeTimestamp' => <integer || string || DateTime>,
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'subjects' => ['<string>', ...],
    'taskStatus' => 'ACTIVE|INACTIVE',
    'type' => 'TASK|EVENT', // REQUIRED
]);

Parameter Details

Members

afterTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time after which you want to list notifications.

beforeTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time before which you want to list notifications.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

maxResults

Type: int

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.

nextToken

Type: string

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.

subjects

Type: Array of strings

The subjects of notifications.

taskStatus

Type: string

The task status of notifications.

type

Required: Yes
Type: string

The type of notifications.

Result Syntax

[
    'nextToken' => '<string>',
    'notifications' => [
        [
            'actionLink' => '<string>',
            'creationTimestamp' => <DateTime>,
            'domainIdentifier' => '<string>',
            'identifier' => '<string>',
            'lastUpdatedTimestamp' => <DateTime>,
            'message' => '<string>',
            'metadata' => ['<string>', ...],
            'status' => 'ACTIVE|INACTIVE',
            'title' => '<string>',
            'topic' => [
                'resource' => [
                    'id' => '<string>',
                    'name' => '<string>',
                    'type' => 'PROJECT',
                ],
                'role' => 'PROJECT_OWNER|PROJECT_CONTRIBUTOR|PROJECT_VIEWER|DOMAIN_OWNER|PROJECT_SUBSCRIBER',
                'subject' => '<string>',
            ],
            'type' => 'TASK|EVENT',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

notifications

Type: Array of NotificationOutput structures

The results of the ListNotifications action.

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.

ListProjectMemberships

$result = $client->listProjectMemberships([/* ... */]);
$promise = $client->listProjectMembershipsAsync([/* ... */]);

Lists all members of the specified project.

Parameter Syntax

$result = $client->listProjectMemberships([
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectIdentifier' => '<string>', // REQUIRED
    'sortBy' => 'NAME',
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which you want to list project memberships.

maxResults

Type: int

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.

nextToken

Type: string

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.

projectIdentifier

Required: Yes
Type: string

The identifier of the project whose memberships you want to list.

sortBy

Type: string

The method by which you want to sort the project memberships.

sortOrder

Type: string

The sort order of the project memberships.

Result Syntax

[
    'members' => [
        [
            'designation' => 'PROJECT_OWNER|PROJECT_CONTRIBUTOR',
            'memberDetails' => [
                'group' => [
                    'groupId' => '<string>',
                ],
                'user' => [
                    'userId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

members

Required: Yes
Type: Array of ProjectMember structures

The members of the project.

nextToken

Type: string

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.

ListProjects

$result = $client->listProjects([/* ... */]);
$promise = $client->listProjectsAsync([/* ... */]);

Lists Amazon DataZone projects.

Parameter Syntax

$result = $client->listProjects([
    'domainIdentifier' => '<string>', // REQUIRED
    'groupIdentifier' => '<string>',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'userIdentifier' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

groupIdentifier

Type: string

The identifier of a group.

maxResults

Type: int

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.

name

Type: string

The name of the project.

nextToken

Type: string

When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

userIdentifier

Type: string

The identifier of the Amazon DataZone user.

Result Syntax

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

Result Details

Members

items

Type: Array of ProjectSummary structures

The results of the ListProjects action.

nextToken

Type: string

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.
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.

ListSubscriptionGrants

$result = $client->listSubscriptionGrants([/* ... */]);
$promise = $client->listSubscriptionGrantsAsync([/* ... */]);

Lists subscription grants.

Parameter Syntax

$result = $client->listSubscriptionGrants([
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'CREATED_AT|UPDATED_AT',
    'sortOrder' => 'ASCENDING|DESCENDING',
    'subscribedListingId' => '<string>',
    'subscriptionId' => '<string>',
    'subscriptionTargetId' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

environmentId

Type: string

The identifier of the Amazon DataZone environment.

maxResults

Type: int

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.

nextToken

Type: string

When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

sortBy

Type: string

Specifies the way of sorting the results of this action.

sortOrder

Type: string

Specifies the sort order of this action.

subscribedListingId

Type: string

The identifier of the subscribed listing.

subscriptionId

Type: string

The identifier of the subscription.

subscriptionTargetId

Type: string

The identifier of the subscription target.

Result Syntax

[
    'items' => [
        [
            'assets' => [
                [
                    'assetId' => '<string>',
                    'assetRevision' => '<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>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of SubscriptionGrantSummary structures

The results of the ListSubscriptionGrants action.

nextToken

Type: string

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.

ListSubscriptionRequests

$result = $client->listSubscriptionRequests([/* ... */]);
$promise = $client->listSubscriptionRequestsAsync([/* ... */]);

Lists Amazon DataZone subscription requests.

Parameter Syntax

$result = $client->listSubscriptionRequests([
    'approverProjectId' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owningProjectId' => '<string>',
    'sortBy' => 'CREATED_AT|UPDATED_AT',
    'sortOrder' => 'ASCENDING|DESCENDING',
    'status' => 'PENDING|ACCEPTED|REJECTED',
    'subscribedListingId' => '<string>',
]);

Parameter Details

Members

approverProjectId

Type: string

The identifier of the subscription request approver's project.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

maxResults

Type: int

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.

nextToken

Type: string

When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

owningProjectId

Type: string

The identifier of the project for the subscription requests.

sortBy

Type: string

Specifies the way to sort the results of this action.

sortOrder

Type: string

Specifies the sort order for the results of this action.

status

Type: string

Specifies the status of the subscription requests.

subscribedListingId

Type: string

The identifier of the subscribed listing.

Result Syntax

[
    'items' => [
        [
            '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' => [
                            'entityId' => '<string>',
                            'entityRevision' => '<string>',
                            'entityType' => '<string>',
                            'forms' => '<string>',
                            'glossaryTerms' => [
                                [
                                    'name' => '<string>',
                                    'shortDescription' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'name' => '<string>',
                    'ownerProjectId' => '<string>',
                    'ownerProjectName' => '<string>',
                    'revision' => '<string>',
                ],
                // ...
            ],
            'subscribedPrincipals' => [
                [
                    'project' => [
                        'id' => '<string>',
                        'name' => '<string>',
                    ],
                ],
                // ...
            ],
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of SubscriptionRequestSummary structures

The results of the ListSubscriptionRequests action.

nextToken

Type: string

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.

ListSubscriptionTargets

$result = $client->listSubscriptionTargets([/* ... */]);
$promise = $client->listSubscriptionTargetsAsync([/* ... */]);

Lists subscription targets in Amazon DataZone.

Parameter Syntax

$result = $client->listSubscriptionTargets([
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => 'CREATED_AT|UPDATED_AT',
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain where you want to list subscription targets.

environmentIdentifier

Required: Yes
Type: string

The identifier of the environment where you want to list subscription targets.

maxResults

Type: int

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.

nextToken

Type: string

When the number of subscription targets is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

sortBy

Type: string

Specifies the way in which the results of this action are to be sorted.

sortOrder

Type: string

Specifies the sort order for the results of this action.

Result Syntax

[
    'items' => [
        [
            'applicableAssetTypes' => ['<string>', ...],
            'authorizedPrincipals' => ['<string>', ...],
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'domainId' => '<string>',
            'environmentId' => '<string>',
            'id' => '<string>',
            'manageAccessRole' => '<string>',
            'name' => '<string>',
            'projectId' => '<string>',
            'provider' => '<string>',
            'subscriptionTargetConfig' => [
                [
                    'content' => '<string>',
                    'formName' => '<string>',
                ],
                // ...
            ],
            'type' => '<string>',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Required: Yes
Type: Array of SubscriptionTargetSummary structures

The results of the ListSubscriptionTargets action.

nextToken

Type: string

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.

ListSubscriptions

$result = $client->listSubscriptions([/* ... */]);
$promise = $client->listSubscriptionsAsync([/* ... */]);

Lists subscriptions in Amazon DataZone.

Parameter Syntax

$result = $client->listSubscriptions([
    'approverProjectId' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owningProjectId' => '<string>',
    'sortBy' => 'CREATED_AT|UPDATED_AT',
    'sortOrder' => 'ASCENDING|DESCENDING',
    'status' => 'APPROVED|REVOKED|CANCELLED',
    'subscribedListingId' => '<string>',
    'subscriptionRequestIdentifier' => '<string>',
]);

Parameter Details

Members

approverProjectId

Type: string

The identifier of the project for the subscription's approver.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

maxResults

Type: int

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.

nextToken

Type: string

When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

owningProjectId

Type: string

The identifier of the owning project.

sortBy

Type: string

Specifies the way in which the results of this action are to be sorted.

sortOrder

Type: string

Specifies the sort order for the results of this action.

status

Type: string

The status of the subscriptions that you want to list.

subscribedListingId

Type: string

The identifier of the subscribed listing for the subscriptions that you want to list.

subscriptionRequestIdentifier

Type: string

The identifier of the subscription request for the subscriptions that you want to list.

Result Syntax

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

Result Details

Members

items

Required: Yes
Type: Array of SubscriptionSummary structures

The results of the ListSubscriptions action.

nextToken

Type: string

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for the specified resource in Amazon DataZone.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the resource whose tags you want to list.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the specified resource.

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.

ListTimeSeriesDataPoints

$result = $client->listTimeSeriesDataPoints([/* ... */]);
$promise = $client->listTimeSeriesDataPointsAsync([/* ... */]);

Lists time series data points.

Parameter Syntax

$result = $client->listTimeSeriesDataPoints([
    'domainIdentifier' => '<string>', // REQUIRED
    'endedAt' => <integer || string || DateTime>,
    'entityIdentifier' => '<string>', // REQUIRED
    'entityType' => 'ASSET|LISTING', // REQUIRED
    'formName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'startedAt' => <integer || string || DateTime>,
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.

endedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp at which the data points that you wanted to list ended.

entityIdentifier

Required: Yes
Type: string

The ID of the asset for which you want to list data points.

entityType

Required: Yes
Type: string

The type of the asset for which you want to list data points.

formName

Required: Yes
Type: string

The name of the time series data points form.

maxResults

Type: int

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.

nextToken

Type: string

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.

startedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp at which the data points that you want to list started.

Result Syntax

[
    'items' => [
        [
            'contentSummary' => '<string>',
            'formName' => '<string>',
            'id' => '<string>',
            'timestamp' => <DateTime>,
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Type: Array of TimeSeriesDataPointSummaryFormOutput structures

The results of the ListTimeSeriesDataPoints action.

nextToken

Type: string

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.

PostTimeSeriesDataPoints

$result = $client->postTimeSeriesDataPoints([/* ... */]);
$promise = $client->postTimeSeriesDataPointsAsync([/* ... */]);

Posts time series data points to Amazon DataZone for the specified asset.

Parameter Syntax

$result = $client->postTimeSeriesDataPoints([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'entityIdentifier' => '<string>', // REQUIRED
    'entityType' => 'ASSET|LISTING', // REQUIRED
    'forms' => [ // REQUIRED
        [
            'content' => '<string>',
            'formName' => '<string>', // REQUIRED
            'timestamp' => <integer || string || DateTime>, // REQUIRED
            'typeIdentifier' => '<string>', // REQUIRED
            'typeRevision' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which you want to post time series data points.

entityIdentifier

Required: Yes
Type: string

The ID of the asset for which you want to post time series data points.

entityType

Required: Yes
Type: string

The type of the asset for which you want to post data points.

forms

Required: Yes
Type: Array of TimeSeriesDataPointFormInput structures

The forms that contain the data points that you want to post.

Result Syntax

[
    'domainId' => '<string>',
    'entityId' => '<string>',
    'entityType' => 'ASSET|LISTING',
    'forms' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
            'id' => '<string>',
            'timestamp' => <DateTime>,
            'typeIdentifier' => '<string>',
            'typeRevision' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

domainId

Type: string

The ID of the Amazon DataZone domain in which you want to post time series data points.

entityId

Type: string

The ID of the asset for which you want to post time series data points.

entityType

Type: string

The type of the asset for which you want to post data points.

forms

Type: Array of TimeSeriesDataPointFormOutput structures

The forms that contain the data points that you have posted.

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.

PutEnvironmentBlueprintConfiguration

$result = $client->putEnvironmentBlueprintConfiguration([/* ... */]);
$promise = $client->putEnvironmentBlueprintConfigurationAsync([/* ... */]);

Writes the configuration for the specified environment blueprint in Amazon DataZone.

Parameter Syntax

$result = $client->putEnvironmentBlueprintConfiguration([
    'domainIdentifier' => '<string>', // REQUIRED
    'enabledRegions' => ['<string>', ...], // REQUIRED
    'environmentBlueprintIdentifier' => '<string>', // REQUIRED
    'manageAccessRoleArn' => '<string>',
    'provisioningRoleArn' => '<string>',
    'regionalParameters' => [
        '<RegionName>' => ['<string>', ...],
        // ...
    ],
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

enabledRegions

Required: Yes
Type: Array of strings

Specifies the enabled Amazon Web Services Regions.

environmentBlueprintIdentifier

Required: Yes
Type: string

The identifier of the environment blueprint.

manageAccessRoleArn

Type: string

The ARN of the manage access role.

provisioningRoleArn

Type: string

The ARN of the provisioning role.

regionalParameters

Type: Associative array of custom strings keys (RegionName) to stringss

The regional parameters in the environment blueprint.

Result Syntax

[
    'createdAt' => <DateTime>,
    'domainId' => '<string>',
    'enabledRegions' => ['<string>', ...],
    'environmentBlueprintId' => '<string>',
    'manageAccessRoleArn' => '<string>',
    'provisioningRoleArn' => '<string>',
    'regionalParameters' => [
        '<RegionName>' => ['<string>', ...],
        // ...
    ],
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment blueprint was created.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

enabledRegions

Type: Array of strings

Specifies the enabled Amazon Web Services Regions.

environmentBlueprintId

Required: Yes
Type: string

The identifier of the environment blueprint.

manageAccessRoleArn

Type: string

The ARN of the manage access role.

provisioningRoleArn

Type: string

The ARN of the provisioning role.

regionalParameters

Type: Associative array of custom strings keys (RegionName) to stringss

The regional parameters in the environment blueprint.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment blueprint was updated.

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.

RejectPredictions

$result = $client->rejectPredictions([/* ... */]);
$promise = $client->rejectPredictionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->rejectPredictions([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
    'rejectChoices' => [
        [
            'predictionChoices' => [<integer>, ...],
            'predictionTarget' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'rejectRule' => [
        'rule' => 'ALL|NONE',
        'threshold' => <float>,
    ],
    'revision' => '<string>',
]);

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

identifier

Required: Yes
Type: string

The identifier of the prediction.

rejectChoices

Type: Array of RejectChoice structures

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.

rejectRule

Type: RejectRule structure

Specifies the rule (or the conditions) under which a prediction can be rejected.

revision

Type: string

The revision that is to be made to the asset.

Result Syntax

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

Result Details

Members

assetId

Required: Yes
Type: string

The ID of the asset.

assetRevision

Required: Yes
Type: string

The revision that is to be made to the asset.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain.

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.

RejectSubscriptionRequest

$result = $client->rejectSubscriptionRequest([/* ... */]);
$promise = $client->rejectSubscriptionRequestAsync([/* ... */]);

Rejects the specified subscription request.

Parameter Syntax

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

Parameter Details

Members

decisionComment

Type: string

The decision comment of the rejected subscription request.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

identifier

Required: Yes
Type: string

The identifier of the subscription request that was rejected.

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' => [
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'entityType' => '<string>',
                    'forms' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'name' => '<string>',
            'ownerProjectId' => '<string>',
            'ownerProjectName' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'subscribedPrincipals' => [
        [
            'project' => [
                'id' => '<string>',
                'name' => '<string>',
            ],
        ],
        // ...
    ],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription request was rejected.

createdBy

Required: Yes
Type: string

The timestamp of when the subscription request was rejected.

decisionComment

Type: string

The decision comment of the rejected subscription request.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the subscription request was rejected.

id

Required: Yes
Type: string

The identifier of the subscription request that was rejected.

requestReason

Required: Yes
Type: string

The reason for the subscription request.

reviewerId

Type: string

The identifier of the subscription request reviewer.

status

Required: Yes
Type: string

The status of the subscription request.

subscribedListings

Required: Yes
Type: Array of SubscribedListing structures

The subscribed listings of the subscription request.

subscribedPrincipals

Required: Yes
Type: Array of SubscribedPrincipal structures

The subscribed principals of the subscription request.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription request was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription request.

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.

RevokeSubscription

$result = $client->revokeSubscription([/* ... */]);
$promise = $client->revokeSubscriptionAsync([/* ... */]);

Revokes a specified subscription in Amazon DataZone.

Parameter Syntax

$result = $client->revokeSubscription([
    'domainIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
    'retainPermissions' => true || false,
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

identifier

Required: Yes
Type: string

The identifier of the revoked subscription.

retainPermissions

Type: boolean

Specifies whether permissions are retained when the subscription is revoked.

Result Syntax

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

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription was revoked.

createdBy

Required: Yes
Type: string

The identifier of the user who revoked the subscription.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

id

Required: Yes
Type: string

The identifier of the revoked subscription.

retainPermissions

Type: boolean

Specifies whether permissions are retained when the subscription is revoked.

status

Required: Yes
Type: string

The status of the revoked subscription.

subscribedListing

Required: Yes
Type: SubscribedListing structure

The subscribed listing of the revoked subscription.

subscribedPrincipal

Required: Yes
Type: SubscribedPrincipal structure

The subscribed principal of the revoked subscription.

subscriptionRequestId

Type: string

The identifier of the subscription request for the revoked subscription.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription was revoked.

updatedBy

Type: string

The Amazon DataZone user who revoked the subscription.

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.

Search

$result = $client->search([/* ... */]);
$promise = $client->searchAsync([/* ... */]);

Searches for assets in Amazon DataZone.

Parameter Syntax

$result = $client->search([
    'additionalAttributes' => ['<string>', ...],
    'domainIdentifier' => '<string>', // REQUIRED
    'filters' => [
        'and' => [
            [...], // RECURSIVE
            // ...
        ],
        'filter' => [
            'attribute' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        'or' => [
            [...], // RECURSIVE
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owningProjectIdentifier' => '<string>',
    'searchIn' => [
        [
            'attribute' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'searchScope' => 'ASSET|GLOSSARY|GLOSSARY_TERM', // REQUIRED
    'searchText' => '<string>',
    'sort' => [
        'attribute' => '<string>', // REQUIRED
        'order' => 'ASCENDING|DESCENDING',
    ],
]);

Parameter Details

Members

additionalAttributes

Type: Array of strings

Specifies additional attributes for the Search action.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

filters

Type: FilterClause structure

Specifies the search filters.

maxResults

Type: int

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.

nextToken

Type: string

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

owningProjectIdentifier

Type: string

The identifier of the owning project specified for the search.

searchIn

Type: Array of SearchInItem structures

The details of the search.

searchScope

Required: Yes
Type: string

The scope of the search.

searchText

Type: string

Specifies the text for which to search.

sort

Type: SearchSort structure

Specifies the way in which the search results are to be sorted.

Result Syntax

[
    'items' => [
        [
            'assetItem' => [
                'additionalAttributes' => [
                    'formsOutput' => [
                        [
                            'content' => '<string>',
                            'formName' => '<string>',
                            'typeName' => '<string>',
                            'typeRevision' => '<string>',
                        ],
                        // ...
                    ],
                    'latestTimeSeriesDataPointFormsOutput' => [
                        [
                            'contentSummary' => '<string>',
                            'formName' => '<string>',
                            'id' => '<string>',
                            'timestamp' => <DateTime>,
                            'typeIdentifier' => '<string>',
                            'typeRevision' => '<string>',
                        ],
                        // ...
                    ],
                    'readOnlyFormsOutput' => [
                        [
                            'content' => '<string>',
                            'formName' => '<string>',
                            'typeName' => '<string>',
                            'typeRevision' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'createdAt' => <DateTime>,
                'createdBy' => '<string>',
                'description' => '<string>',
                'domainId' => '<string>',
                'externalIdentifier' => '<string>',
                'firstRevisionCreatedAt' => <DateTime>,
                'firstRevisionCreatedBy' => '<string>',
                'glossaryTerms' => ['<string>', ...],
                'identifier' => '<string>',
                'name' => '<string>',
                'owningProjectId' => '<string>',
                'typeIdentifier' => '<string>',
                'typeRevision' => '<string>',
            ],
            'dataProductItem' => [
                'createdAt' => <DateTime>,
                'createdBy' => '<string>',
                'dataProductItems' => [
                    [
                        'domainId' => '<string>',
                        'itemId' => '<string>',
                    ],
                    // ...
                ],
                'description' => '<string>',
                'domainId' => '<string>',
                'glossaryTerms' => ['<string>', ...],
                'id' => '<string>',
                'name' => '<string>',
                'owningProjectId' => '<string>',
                'updatedAt' => <DateTime>,
                'updatedBy' => '<string>',
            ],
            'glossaryItem' => [
                'createdAt' => <DateTime>,
                'createdBy' => '<string>',
                'description' => '<string>',
                'domainId' => '<string>',
                'id' => '<string>',
                'name' => '<string>',
                'owningProjectId' => '<string>',
                'status' => 'DISABLED|ENABLED',
                'updatedAt' => <DateTime>,
                'updatedBy' => '<string>',
            ],
            'glossaryTermItem' => [
                'createdAt' => <DateTime>,
                'createdBy' => '<string>',
                'domainId' => '<string>',
                'glossaryId' => '<string>',
                'id' => '<string>',
                'longDescription' => '<string>',
                'name' => '<string>',
                'shortDescription' => '<string>',
                'status' => 'ENABLED|DISABLED',
                'termRelations' => [
                    'classifies' => ['<string>', ...],
                    'isA' => ['<string>', ...],
                ],
                'updatedAt' => <DateTime>,
                'updatedBy' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'totalMatchCount' => <integer>,
]

Result Details

Members

items

Type: Array of SearchInventoryResultItem structures

The results of the Search action.

nextToken

Type: string

totalMatchCount

Type: int

Total number of search results.

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.
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.

SearchGroupProfiles

$result = $client->searchGroupProfiles([/* ... */]);
$promise = $client->searchGroupProfilesAsync([/* ... */]);

Searches group profiles in Amazon DataZone.

Parameter Syntax

$result = $client->searchGroupProfiles([
    'domainIdentifier' => '<string>', // REQUIRED
    'groupType' => 'SSO_GROUP|DATAZONE_SSO_GROUP', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchText' => '<string>',
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which you want to search group profiles.

groupType

Required: Yes
Type: string

The group type for which to search.

maxResults

Type: int

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.

nextToken

Type: string

searchText

Type: string

Specifies the text for which to search.

Result Syntax

[
    'items' => [
        [
            'domainId' => '<string>',
            'groupName' => '<string>',
            'id' => '<string>',
            'status' => 'ASSIGNED|NOT_ASSIGNED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Type: Array of GroupProfileSummary structures

The results of the SearchGroupProfiles action.

nextToken

Type: string

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.

SearchListings

$result = $client->searchListings([/* ... */]);
$promise = $client->searchListingsAsync([/* ... */]);

Searches listings (records of an asset at a given time) in Amazon DataZone.

Parameter Syntax

$result = $client->searchListings([
    'additionalAttributes' => ['<string>', ...],
    'domainIdentifier' => '<string>', // REQUIRED
    'filters' => [
        'and' => [
            [...], // RECURSIVE
            // ...
        ],
        'filter' => [
            'attribute' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        'or' => [
            [...], // RECURSIVE
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchIn' => [
        [
            'attribute' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'searchText' => '<string>',
    'sort' => [
        'attribute' => '<string>', // REQUIRED
        'order' => 'ASCENDING|DESCENDING',
    ],
]);

Parameter Details

Members

additionalAttributes

Type: Array of strings

Specifies additional attributes for the search.

domainIdentifier

Required: Yes
Type: string

The identifier of the domain in which to search listings.

filters

Type: FilterClause structure

Specifies the filters for the search of listings.

maxResults

Type: int

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.

nextToken

Type: string

searchIn

Type: Array of SearchInItem structures

The details of the search.

searchText

Type: string

Specifies the text for which to search.

sort

Type: SearchSort structure

Specifies the way for sorting the search results.

Result Syntax

[
    'items' => [
        [
            'assetListing' => [
                'additionalAttributes' => [
                    'forms' => '<string>',
                    'latestTimeSeriesDataPointForms' => [
                        [
                            'contentSummary' => '<string>',
                            'formName' => '<string>',
                            'id' => '<string>',
                            'timestamp' => <DateTime>,
                            'typeIdentifier' => '<string>',
                            'typeRevision' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'createdAt' => <DateTime>,
                'description' => '<string>',
                'entityId' => '<string>',
                'entityRevision' => '<string>',
                'entityType' => '<string>',
                'glossaryTerms' => [
                    [
                        'name' => '<string>',
                        'shortDescription' => '<string>',
                    ],
                    // ...
                ],
                'listingCreatedBy' => '<string>',
                'listingId' => '<string>',
                'listingRevision' => '<string>',
                'listingUpdatedBy' => '<string>',
                'name' => '<string>',
                'owningProjectId' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'totalMatchCount' => <integer>,
]

Result Details

Members

items

Type: Array of SearchResultItem structures

The results of the SearchListings action.

nextToken

Type: string

totalMatchCount

Type: int

Total number of search results.

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.
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.

SearchTypes

$result = $client->searchTypes([/* ... */]);
$promise = $client->searchTypesAsync([/* ... */]);

Searches for types in Amazon DataZone.

Parameter Syntax

$result = $client->searchTypes([
    'domainIdentifier' => '<string>', // REQUIRED
    'filters' => [
        'and' => [
            [...], // RECURSIVE
            // ...
        ],
        'filter' => [
            'attribute' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        'or' => [
            [...], // RECURSIVE
            // ...
        ],
    ],
    'managed' => true || false, // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchIn' => [
        [
            'attribute' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'searchScope' => 'ASSET_TYPE|FORM_TYPE', // REQUIRED
    'searchText' => '<string>',
    'sort' => [
        'attribute' => '<string>', // REQUIRED
        'order' => 'ASCENDING|DESCENDING',
    ],
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.

filters

Type: FilterClause structure

The filters for the SearchTypes action.

managed

Required: Yes
Type: boolean

Specifies whether the search is managed.

maxResults

Type: int

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.

nextToken

Type: string

searchIn

Type: Array of SearchInItem structures

The details of the search.

searchScope

Required: Yes
Type: string

Specifies the scope of the search for types.

searchText

Type: string

Specifies the text for which to search.

sort

Type: SearchSort structure

The specifies the way to sort the SearchTypes results.

Result Syntax

[
    'items' => [
        [
            'assetTypeItem' => [
                '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>',
            ],
            'formTypeItem' => [
                'createdAt' => <DateTime>,
                'createdBy' => '<string>',
                'description' => '<string>',
                'domainId' => '<string>',
                'imports' => [
                    [
                        'name' => '<string>',
                        'revision' => '<string>',
                    ],
                    // ...
                ],
                'model' => [
                    'smithy' => '<string>',
                ],
                'name' => '<string>',
                'originDomainId' => '<string>',
                'originProjectId' => '<string>',
                'owningProjectId' => '<string>',
                'revision' => '<string>',
                'status' => 'ENABLED|DISABLED',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'totalMatchCount' => <integer>,
]

Result Details

Members

items

Type: Array of SearchTypesResultItem structures

The results of the SearchTypes action.

nextToken

Type: string

totalMatchCount

Type: int

Total number of search results.

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.
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.

SearchUserProfiles

$result = $client->searchUserProfiles([/* ... */]);
$promise = $client->searchUserProfilesAsync([/* ... */]);

Searches user profiles in Amazon DataZone.

Parameter Syntax

$result = $client->searchUserProfiles([
    'domainIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchText' => '<string>',
    'userType' => 'SSO_USER|DATAZONE_USER|DATAZONE_SSO_USER|DATAZONE_IAM_USER', // REQUIRED
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which you want to search user profiles.

maxResults

Type: int

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.

nextToken

Type: string

searchText

Type: string

Specifies the text for which to search.

userType

Required: Yes
Type: string

Specifies the user type for the SearchUserProfiles action.

Result Syntax

[
    'items' => [
        [
            'details' => [
                'iam' => [
                    'arn' => '<string>',
                ],
                'sso' => [
                    'firstName' => '<string>',
                    'lastName' => '<string>',
                    'username' => '<string>',
                ],
            ],
            'domainId' => '<string>',
            'id' => '<string>',
            'status' => 'ASSIGNED|NOT_ASSIGNED|ACTIVATED|DEACTIVATED',
            'type' => 'IAM|SSO',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

items

Type: Array of UserProfileSummary structures

The results of the SearchUserProfiles action.

nextToken

Type: string

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.

StartDataSourceRun

$result = $client->startDataSourceRun([/* ... */]);
$promise = $client->startDataSourceRunAsync([/* ... */]);

Start the run of the specified data source in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

dataSourceIdentifier

Required: Yes
Type: string

The identifier of the data source.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which to start a data source run.

Result Syntax

[
    'createdAt' => <DateTime>,
    'dataSourceConfigurationSnapshot' => '<string>',
    'dataSourceId' => '<string>',
    'domainId' => '<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>',
    'projectId' => '<string>',
    'runStatisticsForAssets' => [
        'added' => <integer>,
        'failed' => <integer>,
        'skipped' => <integer>,
        'unchanged' => <integer>,
        'updated' => <integer>,
    ],
    'startedAt' => <DateTime>,
    'status' => 'REQUESTED|RUNNING|FAILED|PARTIALLY_SUCCEEDED|SUCCESS',
    'stoppedAt' => <DateTime>,
    'type' => 'PRIORITIZED|SCHEDULED',
    'updatedAt' => <DateTime>,
]

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when data source run was created.

dataSourceConfigurationSnapshot

Type: string

The configuration snapshot of the data source that is being run.

dataSourceId

Required: Yes
Type: string

The identifier of the data source.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which to start a data source run.

errorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The identifier of the data source run.

projectId

Required: Yes
Type: string

The identifier of the project.

runStatisticsForAssets

Type: RunStatisticsForAssets structure

Specifies run statistics for assets.

startedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source run was started.

status

Required: Yes
Type: string

The status of the data source run.

stoppedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source run was stopped.

type

Required: Yes
Type: string

The type of the data source run.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source run was updated.

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.

StartMetadataGenerationRun

$result = $client->startMetadataGenerationRun([/* ... */]);
$promise = $client->startMetadataGenerationRunAsync([/* ... */]);

Starts the metadata generation run.

Parameter Syntax

$result = $client->startMetadataGenerationRun([
    'clientToken' => '<string>',
    'domainIdentifier' => '<string>', // REQUIRED
    'owningProjectIdentifier' => '<string>', // REQUIRED
    'target' => [ // REQUIRED
        'identifier' => '<string>', // REQUIRED
        'revision' => '<string>',
        'type' => 'ASSET', // REQUIRED
    ],
    'type' => 'BUSINESS_DESCRIPTIONS', // REQUIRED
]);

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

domainIdentifier

Required: Yes
Type: string

The ID of the Amazon DataZone domain where you want to start a metadata generation run.

owningProjectIdentifier

Required: Yes
Type: string

The ID of the project that owns the asset for which you want to start a metadata generation run.

target

Required: Yes
Type: MetadataGenerationRunTarget structure

The asset for which you want to start a metadata generation run.

type

Required: Yes
Type: string

The type of the metadata generation run.

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'domainId' => '<string>',
    'id' => '<string>',
    'owningProjectId' => '<string>',
    'status' => 'SUBMITTED|IN_PROGRESS|CANCELED|SUCCEEDED|FAILED',
    'type' => 'BUSINESS_DESCRIPTIONS',
]

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp at which the metadata generation run was started.

createdBy

Type: string

The ID of the user who started the metadata generation run.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the metadata generation run was started.

id

Required: Yes
Type: string

The ID of the metadata generation run.

owningProjectId

Type: string

The ID of the project that owns the asset for which the metadata generation run was started.

status

Type: string

The status of the metadata generation run.

type

Type: string

The type of the metadata generation run.

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.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags a resource in Amazon DataZone.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the resource to be tagged in Amazon DataZone.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

Specifies the tags for the TagResource action.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Untags a resource in Amazon DataZone.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the resource to be untagged in Amazon DataZone.

tagKeys

Required: Yes
Type: Array of strings

Specifies the tag keys for the UntagResource action.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.
UnauthorizedException:
You do not have permission to perform this action.

UpdateDataSource

$result = $client->updateDataSource([/* ... */]);
$promise = $client->updateDataSourceAsync([/* ... */]);

Updates the specified data source in Amazon DataZone.

Parameter Syntax

$result = $client->updateDataSource([
    'assetFormsInput' => [
        [
            'content' => '<string>',
            'formName' => '<string>', // REQUIRED
            'typeIdentifier' => '<string>',
            'typeRevision' => '<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',
    'identifier' => '<string>', // REQUIRED
    'name' => '<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',
    ],
]);

Parameter Details

Members

assetFormsInput

Type: Array of FormInput structures

The asset forms to be updated as part of the UpdateDataSource action.

configuration

Type: DataSourceConfigurationInput structure

The configuration to be updated as part of the UpdateDataSource action.

description

Type: string

The description to be updated as part of the UpdateDataSource action.

domainIdentifier

Required: Yes
Type: string

The identifier of the domain in which to update a data source.

enableSetting

Type: string

The enable setting to be updated as part of the UpdateDataSource action.

identifier

Required: Yes
Type: string

The identifier of the data source to be updated.

name

Type: string

The name to be updated as part of the UpdateDataSource action.

publishOnImport

Type: boolean

The publish on import setting to be updated as part of the UpdateDataSource action.

recommendation

Type: RecommendationConfiguration structure

The recommendation to be updated as part of the UpdateDataSource action.

schedule

Type: ScheduleConfiguration structure

The schedule to be updated as part of the UpdateDataSource action.

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

Members

assetFormsOutput

Type: Array of FormOutput structures

The asset forms to be updated as part of the UpdateDataSource action.

configuration

Type: DataSourceConfigurationOutput structure

The configuration to be updated as part of the UpdateDataSource action.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was updated.

description

Type: string

The description to be updated as part of the UpdateDataSource action.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a data source is to be updated.

enableSetting

Type: string

The enable setting to be updated as part of the UpdateDataSource action.

environmentId

Required: Yes
Type: string

The identifier of the environment in which a data source is to be updated.

errorMessage

Type: DataSourceErrorMessage structure

Specifies the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The identifier of the data source to be updated.

lastRunAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was last run.

lastRunErrorMessage

Type: DataSourceErrorMessage structure

The last run error message of the data source.

lastRunStatus

Type: string

The last run status of the data source.

name

Required: Yes
Type: string

The name to be updated as part of the UpdateDataSource action.

projectId

Required: Yes
Type: string

The identifier of the project where data source is to be updated.

publishOnImport

Type: boolean

The publish on import setting to be updated as part of the UpdateDataSource action.

recommendation

Type: RecommendationConfiguration structure

The recommendation to be updated as part of the UpdateDataSource action.

schedule

Type: ScheduleConfiguration structure

The schedule to be updated as part of the UpdateDataSource action.

status

Type: string

The status to be updated as part of the UpdateDataSource action.

type

Type: string

The type to be updated as part of the UpdateDataSource action.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was updated.

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.

UpdateDomain

$result = $client->updateDomain([/* ... */]);
$promise = $client->updateDomainAsync([/* ... */]);

Updates a Amazon DataZone domain.

Parameter Syntax

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

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

description

Type: string

The description to be updated as part of the UpdateDomain action.

domainExecutionRole

Type: string

The domain execution role to be updated as part of the UpdateDomain action.

identifier

Required: Yes
Type: string

The ID of the Amazon Web Services domain that is to be updated.

name

Type: string

The name to be updated as part of the UpdateDomain action.

singleSignOn

Type: SingleSignOn structure

The single sign-on option to be updated as part of the UpdateDomain action.

Result Syntax

[
    'description' => '<string>',
    'domainExecutionRole' => '<string>',
    'id' => '<string>',
    'lastUpdatedAt' => <DateTime>,
    'name' => '<string>',
    'singleSignOn' => [
        'type' => 'IAM_IDC|DISABLED',
        'userAssignment' => 'AUTOMATIC|MANUAL',
    ],
]

Result Details

Members

description

Type: string

The description to be updated as part of the UpdateDomain action.

domainExecutionRole

Type: string

The domain execution role to be updated as part of the UpdateDomain action.

id

Required: Yes
Type: string

The identifier of the Amazon DataZone domain.

lastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the timestamp of when the domain was last updated.

name

Type: string

The name to be updated as part of the UpdateDomain action.

singleSignOn

Type: SingleSignOn structure

The single sign-on option of the Amazon DataZone domain.

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.

UpdateEnvironment

$result = $client->updateEnvironment([/* ... */]);
$promise = $client->updateEnvironmentAsync([/* ... */]);

Updates the specified environment in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

description

Type: string

The description to be updated as part of the UpdateEnvironment action.

domainIdentifier

Required: Yes
Type: string

The identifier of the domain in which the environment is to be updated.

glossaryTerms

Type: Array of strings

The glossary terms to be updated as part of the UpdateEnvironment action.

identifier

Required: Yes
Type: string

The identifier of the environment that is to be updated.

name

Type: string

The name to be updated as part of the UpdateEnvironment action.

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

Members

awsAccountId

Type: string

The identifier of the Amazon Web Services account in which the environment is to be updated.

awsAccountRegion

Type: string

The Amazon Web Services Region in which the environment is updated.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the environment.

deploymentProperties

Type: DeploymentProperties structure

The deployment properties to be updated as part of the UpdateEnvironment action.

description

Type: string

The description to be updated as part of the UpdateEnvironment action.

domainId

Required: Yes
Type: string

The identifier of the domain in which the environment is to be updated.

environmentActions

Type: Array of ConfigurableEnvironmentAction structures

The environment actions to be updated as part of the UpdateEnvironment action.

environmentBlueprintId

Type: string

The blueprint identifier of the environment.

environmentProfileId

Required: Yes
Type: string

The profile identifier of the environment.

glossaryTerms

Type: Array of strings

The glossary terms to be updated as part of the UpdateEnvironment action.

id

Type: string

The identifier of the environment that is to be updated.

lastDeployment

Type: Deployment structure

The last deployment of the environment.

name

Required: Yes
Type: string

The name to be updated as part of the UpdateEnvironment action.

projectId

Required: Yes
Type: string

The project identifier of the environment.

provider

Required: Yes
Type: string

The provider identifier of the environment.

provisionedResources

Type: Array of Resource structures

The provisioned resources to be updated as part of the UpdateEnvironment action.

provisioningProperties

Type: ProvisioningProperties structure

The provisioning properties to be updated as part of the UpdateEnvironment action.

status

Type: string

The status to be updated as part of the UpdateEnvironment action.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was updated.

userParameters

Type: Array of CustomParameter structures

The user parameters to be updated as part of the UpdateEnvironment action.

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.

UpdateEnvironmentProfile

$result = $client->updateEnvironmentProfile([/* ... */]);
$promise = $client->updateEnvironmentProfileAsync([/* ... */]);

Updates the specified environment profile in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

awsAccountId

Type: string

The Amazon Web Services account in which a specified environment profile is to be udpated.

awsAccountRegion

Type: string

The Amazon Web Services Region in which a specified environment profile is to be updated.

description

Type: string

The description to be updated as part of the UpdateEnvironmentProfile action.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

identifier

Required: Yes
Type: string

The identifier of the environment profile that is to be updated.

name

Type: string

The name to be updated as part of the UpdateEnvironmentProfile action.

userParameters

Type: Array of EnvironmentParameter structures

The user parameters to be updated as part of the UpdateEnvironmentProfile action.

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

Members

awsAccountId

Type: string

The Amazon Web Services account in which a specified environment profile is to be udpated.

awsAccountRegion

Type: string

The Amazon Web Services Region in which a specified environment profile is to be updated.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment profile was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the environment profile.

description

Type: string

The description to be updated as part of the UpdateEnvironmentProfile action.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the environment profile is to be updated.

environmentBlueprintId

Required: Yes
Type: string

The identifier of the blueprint of the environment profile that is to be updated.

id

Required: Yes
Type: string

The identifier of the environment profile that is to be udpated.

name

Required: Yes
Type: string

The name to be updated as part of the UpdateEnvironmentProfile action.

projectId

Type: string

The identifier of the project of the environment profile that is to be updated.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment profile was updated.

userParameters

Type: Array of CustomParameter structures

The user parameters to be updated as part of the UpdateEnvironmentProfile action.

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.

UpdateGlossary

$result = $client->updateGlossary([/* ... */]);
$promise = $client->updateGlossaryAsync([/* ... */]);

Updates the business glossary in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

clientToken

Type: string

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

description

Type: string

The description to be updated as part of the UpdateGlossary action.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

identifier

Required: Yes
Type: string

The identifier of the business glossary to be updated.

name

Type: string

The name to be updated as part of the UpdateGlossary action.

status

Type: string

The status to be updated as part of the UpdateGlossary action.

Result Syntax

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

Result Details

Members

description

Type: string

The description to be updated as part of the UpdateGlossary action.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a business glossary is to be updated.

id

Required: Yes
Type: string

The identifier of the business glossary that is to be updated.

name

Required: Yes
Type: string

The name to be updated as part of the UpdateGlossary action.

owningProjectId

Required: Yes
Type: string

The identifier of the project in which to update a business glossary.

status

Type: string

The status to be updated as part of the UpdateGlossary action.

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.

UpdateGlossaryTerm

$result = $client->updateGlossaryTerm([/* ... */]);
$promise = $client->updateGlossaryTermAsync([/* ... */]);

Updates a business glossary term in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

glossaryIdentifier

Type: string

The identifier of the business glossary in which a term is to be updated.

identifier

Required: Yes
Type: string

The identifier of the business glossary term that is to be updated.

longDescription

Type: string

The long description to be updated as part of the UpdateGlossaryTerm action.

name

Type: string

The name to be updated as part of the UpdateGlossaryTerm action.

shortDescription

Type: string

The short description to be updated as part of the UpdateGlossaryTerm action.

status

Type: string

The status to be updated as part of the UpdateGlossaryTerm action.

termRelations

Type: TermRelations structure

The term relations to be updated as part of the UpdateGlossaryTerm action.

Result Syntax

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

Result Details

Members

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a business glossary term is to be updated.

glossaryId

Required: Yes
Type: string

The identifier of the business glossary in which a term is to be updated.

id

Required: Yes
Type: string

The identifier of the business glossary term that is to be updated.

longDescription

Type: string

The long description to be updated as part of the UpdateGlossaryTerm action.

name

Required: Yes
Type: string

The name to be updated as part of the UpdateGlossaryTerm action.

shortDescription

Type: string

The short description to be updated as part of the UpdateGlossaryTerm action.

status

Required: Yes
Type: string

The status to be updated as part of the UpdateGlossaryTerm action.

termRelations

Type: TermRelations structure

The term relations to be updated as part of the UpdateGlossaryTerm action.

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.

UpdateGroupProfile

$result = $client->updateGroupProfile([/* ... */]);
$promise = $client->updateGroupProfileAsync([/* ... */]);

Updates the specified group profile in Amazon DataZone.

Parameter Syntax

$result = $client->updateGroupProfile([
    'domainIdentifier' => '<string>', // REQUIRED
    'groupIdentifier' => '<string>', // REQUIRED
    'status' => 'ASSIGNED|NOT_ASSIGNED', // REQUIRED
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a group profile is updated.

groupIdentifier

Required: Yes
Type: string

The identifier of the group profile that is updated.

status

Required: Yes
Type: string

The status of the group profile that is updated.

Result Syntax

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

Result Details

Members

domainId

Type: string

The identifier of the Amazon DataZone domain in which a group profile is updated.

groupName

Type: string

The name of the group profile that is updated.

id

Type: string

The identifier of the group profile that is updated.

status

Type: string

The status of the group profile that is updated.

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.

UpdateProject

$result = $client->updateProject([/* ... */]);
$promise = $client->updateProjectAsync([/* ... */]);

Updates the specified project in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

description

Type: string

The description to be updated as part of the UpdateProject action.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a project is to be updated.

glossaryTerms

Type: Array of strings

The glossary terms to be updated as part of the UpdateProject action.

identifier

Required: Yes
Type: string

The identifier of the project that is to be updated.

name

Type: string

The name to be updated as part of the UpdateProject action.

Result Syntax

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

Result Details

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the project was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the project.

description

Type: string

The description of the project that is to be updated.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a project is updated.

failureReasons

Type: Array of ProjectDeletionError structures

Specifies the error message that is returned if the operation cannot be successfully completed.

glossaryTerms

Type: Array of strings

The glossary terms of the project that are to be updated.

id

Required: Yes
Type: string

The identifier of the project that is to be updated.

lastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the project was last updated.

name

Required: Yes
Type: string

The name of the project that is to be updated.

projectStatus

Type: string

The status of the project.

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.

UpdateSubscriptionGrantStatus

$result = $client->updateSubscriptionGrantStatus([/* ... */]);
$promise = $client->updateSubscriptionGrantStatusAsync([/* ... */]);

Updates the status of the specified subscription grant status in Amazon DataZone.

Parameter Syntax

$result = $client->updateSubscriptionGrantStatus([
    'assetIdentifier' => '<string>', // REQUIRED
    'domainIdentifier' => '<string>', // REQUIRED
    'failureCause' => [
        'message' => '<string>',
    ],
    'identifier' => '<string>', // REQUIRED
    'status' => 'GRANT_PENDING|REVOKE_PENDING|GRANT_IN_PROGRESS|REVOKE_IN_PROGRESS|GRANTED|REVOKED|GRANT_FAILED|REVOKE_FAILED', // REQUIRED
    'targetName' => '<string>',
]);

Parameter Details

Members

assetIdentifier

Required: Yes
Type: string

The identifier of the asset the subscription grant status of which is to be updated.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

failureCause

Type: FailureCause structure

Specifies the error message that is returned if the operation cannot be successfully completed.

identifier

Required: Yes
Type: string

The identifier of the subscription grant the status of which is to be updated.

status

Required: Yes
Type: string

The status to be updated as part of the UpdateSubscriptionGrantStatus action.

targetName

Type: string

The target name to be updated as part of the UpdateSubscriptionGrantStatus action.

Result Syntax

[
    'assets' => [
        [
            'assetId' => '<string>',
            'assetRevision' => '<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

Members

assets

Type: Array of SubscribedAsset structures

The details of the asset for which the subscription grant is created.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription grant status was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone domain user who created the subscription grant status.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.

grantedEntity

Required: Yes
Type: GrantedEntity structure

The granted entity to be updated as part of the UpdateSubscriptionGrantStatus action.

id

Required: Yes
Type: string

The identifier of the subscription grant.

status

Required: Yes
Type: string

The status to be updated as part of the UpdateSubscriptionGrantStatus action.

subscriptionId

Type: string

The identifier of the subscription.

subscriptionTargetId

Required: Yes
Type: string

The identifier of the subscription target whose subscription grant status is to be updated.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription grant status is to be updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription grant status.

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.

UpdateSubscriptionRequest

$result = $client->updateSubscriptionRequest([/* ... */]);
$promise = $client->updateSubscriptionRequestAsync([/* ... */]);

Updates a specified subscription request in Amazon DataZone.

Parameter Syntax

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

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription request is to be updated.

identifier

Required: Yes
Type: string

The identifier of the subscription request that is to be updated.

requestReason

Required: Yes
Type: string

The reason for the UpdateSubscriptionRequest action.

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' => [
                    'entityId' => '<string>',
                    'entityRevision' => '<string>',
                    'entityType' => '<string>',
                    'forms' => '<string>',
                    'glossaryTerms' => [
                        [
                            'name' => '<string>',
                            'shortDescription' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'name' => '<string>',
            'ownerProjectId' => '<string>',
            'ownerProjectName' => '<string>',
            'revision' => '<string>',
        ],
        // ...
    ],
    'subscribedPrincipals' => [
        [
            'project' => [
                'id' => '<string>',
                'name' => '<string>',
            ],
        ],
        // ...
    ],
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription request was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription request.

decisionComment

Type: string

The decision comment of the UpdateSubscriptionRequest action.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription request is to be updated.

id

Required: Yes
Type: string

The identifier of the subscription request that is to be updated.

requestReason

Required: Yes
Type: string

The reason for the UpdateSubscriptionRequest action.

reviewerId

Type: string

The identifier of the Amazon DataZone user who reviews the subscription request.

status

Required: Yes
Type: string

The status of the subscription request.

subscribedListings

Required: Yes
Type: Array of SubscribedListing structures

The subscribed listings of the subscription request.

subscribedPrincipals

Required: Yes
Type: Array of SubscribedPrincipal structures

The subscribed principals of the subscription request.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription request was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription request.

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.

UpdateSubscriptionTarget

$result = $client->updateSubscriptionTarget([/* ... */]);
$promise = $client->updateSubscriptionTargetAsync([/* ... */]);

Updates the specified subscription target in Amazon DataZone.

Parameter Syntax

$result = $client->updateSubscriptionTarget([
    'applicableAssetTypes' => ['<string>', ...],
    'authorizedPrincipals' => ['<string>', ...],
    'domainIdentifier' => '<string>', // REQUIRED
    'environmentIdentifier' => '<string>', // REQUIRED
    'identifier' => '<string>', // REQUIRED
    'manageAccessRole' => '<string>',
    'name' => '<string>',
    'provider' => '<string>',
    'subscriptionTargetConfig' => [
        [
            'content' => '<string>', // REQUIRED
            'formName' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

applicableAssetTypes

Type: Array of strings

The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

authorizedPrincipals

Type: Array of strings

The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

environmentIdentifier

Required: Yes
Type: string

The identifier of the environment in which a subscription target is to be updated.

identifier

Required: Yes
Type: string

Identifier of the subscription target that is to be updated.

manageAccessRole

Type: string

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

name

Type: string

The name to be updated as part of the UpdateSubscriptionTarget action.

provider

Type: string

The provider to be updated as part of the UpdateSubscriptionTarget action.

subscriptionTargetConfig

Type: Array of SubscriptionTargetForm structures

The configuration to be updated as part of the UpdateSubscriptionTarget action.

Result Syntax

[
    'applicableAssetTypes' => ['<string>', ...],
    'authorizedPrincipals' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'domainId' => '<string>',
    'environmentId' => '<string>',
    'id' => '<string>',
    'manageAccessRole' => '<string>',
    'name' => '<string>',
    'projectId' => '<string>',
    'provider' => '<string>',
    'subscriptionTargetConfig' => [
        [
            'content' => '<string>',
            'formName' => '<string>',
        ],
        // ...
    ],
    'type' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Members

applicableAssetTypes

Required: Yes
Type: Array of strings

The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.

authorizedPrincipals

Required: Yes
Type: Array of strings

The authorized principals to be updated as part of the UpdateSubscriptionTarget action.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a subscription target was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription target.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription target is to be updated.

environmentId

Required: Yes
Type: string

The identifier of the environment in which a subscription target is to be updated.

id

Required: Yes
Type: string

Identifier of the subscription target that is to be updated.

manageAccessRole

Required: Yes
Type: string

The manage access role to be updated as part of the UpdateSubscriptionTarget action.

name

Required: Yes
Type: string

The name to be updated as part of the UpdateSubscriptionTarget action.

projectId

Required: Yes
Type: string

The identifier of the project in which a subscription target is to be updated.

provider

Required: Yes
Type: string

The provider to be updated as part of the UpdateSubscriptionTarget action.

subscriptionTargetConfig

Required: Yes
Type: Array of SubscriptionTargetForm structures

The configuration to be updated as part of the UpdateSubscriptionTarget action.

type

Required: Yes
Type: string

The type to be updated as part of the UpdateSubscriptionTarget action.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription target was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription target.

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.

UpdateUserProfile

$result = $client->updateUserProfile([/* ... */]);
$promise = $client->updateUserProfileAsync([/* ... */]);

Updates the specified user profile in Amazon DataZone.

Parameter Syntax

$result = $client->updateUserProfile([
    'domainIdentifier' => '<string>', // REQUIRED
    'status' => 'ASSIGNED|NOT_ASSIGNED|ACTIVATED|DEACTIVATED', // REQUIRED
    'type' => 'IAM|SSO',
    'userIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

domainIdentifier

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a user profile is updated.

status

Required: Yes
Type: string

The status of the user profile that are to be updated.

type

Type: string

The type of the user profile that are to be updated.

userIdentifier

Required: Yes
Type: string

The identifier of the user whose user profile is to be updated.

Result Syntax

[
    'details' => [
        'iam' => [
            'arn' => '<string>',
        ],
        'sso' => [
            'firstName' => '<string>',
            'lastName' => '<string>',
            'username' => '<string>',
        ],
    ],
    'domainId' => '<string>',
    'id' => '<string>',
    'status' => 'ASSIGNED|NOT_ASSIGNED|ACTIVATED|DEACTIVATED',
    'type' => 'IAM|SSO',
]

Result Details

Members

details

Type: UserProfileDetails structure

The details of the user profile in Amazon DataZone.

domainId

Type: string

The identifier of the Amazon DataZone domain in which a user profile is updated.

id

Type: string

The identifier of the user profile.

status

Type: string

The status of the user profile.

type

Type: string

The type of the user profile.

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.

Shapes

AcceptChoice

Description

Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

Members

editedValue

Type: string

The edit of the prediction.

predictionChoice

Type: int

Specifies the prediction (aka, the automatically generated piece of metadata) that can be accepted.

predictionTarget

Required: Yes
Type: string

Specifies the target (for example, a column name) where a prediction can be accepted.

AcceptRule

Description

Specifies the rule and the threshold under which a prediction can be accepted.

Members

rule

Type: string

Specifies whether you want to accept the top prediction for all targets or none.

threshold

Type: float

The confidence score that specifies the condition at which a prediction can be accepted.

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

message

Required: Yes
Type: string

AssetItem

Description

A Amazon DataZone inventory asset.

Members

additionalAttributes

Type: AssetItemAdditionalAttributes structure

The additional attributes of a Amazon DataZone inventory asset.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the Amazon DataZone inventory asset was created.

createdBy

Type: string

The Amazon DataZone user who created the inventory asset.

description

Type: string

The description of an Amazon DataZone inventory asset.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the inventory asset exists.

externalIdentifier

Type: string

The external identifier of the Amazon DataZone inventory asset.

firstRevisionCreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the first revision of the inventory asset was created.

firstRevisionCreatedBy

Type: string

The Amazon DataZone user who created the first revision of the inventory asset.

glossaryTerms

Type: Array of strings

The glossary terms attached to the Amazon DataZone inventory asset.

identifier

Required: Yes
Type: string

the identifier of the Amazon DataZone inventory asset.

name

Required: Yes
Type: string

The name of the Amazon DataZone inventory asset.

owningProjectId

Required: Yes
Type: string

The identifier of the Amazon DataZone project that owns the inventory asset.

typeIdentifier

Required: Yes
Type: string

The identifier of the asset type of the specified Amazon DataZone inventory asset.

typeRevision

Required: Yes
Type: string

The revision of the inventory asset type.

AssetItemAdditionalAttributes

Description

The additional attributes of an inventory asset.

Members

formsOutput

Type: Array of FormOutput structures

The forms included in the additional attributes of an inventory asset.

latestTimeSeriesDataPointFormsOutput

Type: Array of TimeSeriesDataPointSummaryFormOutput structures

The latest time series data points forms included in the additional attributes of an asset.

readOnlyFormsOutput

Type: Array of FormOutput structures

The read-only forms included in the additional attributes of an inventory asset.

AssetListing

Description

An asset published in an Amazon DataZone catalog.

Members

assetId

Type: string

The identifier of an asset published in an Amazon DataZone catalog.

assetRevision

Type: string

The revision of an asset published in an Amazon DataZone catalog.

assetType

Type: string

The type of an asset published in an Amazon DataZone catalog.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when an asset published in an Amazon DataZone catalog was created.

forms

Type: string

The metadata forms attached to an asset published in an Amazon DataZone catalog.

glossaryTerms

Type: Array of DetailedGlossaryTerm structures

The glossary terms attached to an asset published in an Amazon DataZone catalog.

latestTimeSeriesDataPointForms

Type: Array of TimeSeriesDataPointSummaryFormOutput structures

The latest time series data points forms included in the additional attributes of an asset.

owningProjectId

Type: string

The identifier of the project where an asset published in an Amazon DataZone catalog exists.

AssetListingDetails

Description

The details of an asset published in an Amazon DataZone catalog.

Members

listingId

Required: Yes
Type: string

The identifier of an asset published in an Amazon DataZone catalog.

listingStatus

Required: Yes
Type: string

The status of an asset published in an Amazon DataZone catalog.

AssetListingItem

Description

The details of an asset published in an Amazon DataZone catalog.

Members

additionalAttributes

Type: AssetListingItemAdditionalAttributes structure

The additional attributes of an asset published in an Amazon DataZone catalog.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when an asset published in an Amazon DataZone catalog was created.

description

Type: string

The description of an asset published in an Amazon DataZone catalog.

entityId

Type: string

The identifier of the inventory asset.

entityRevision

Type: string

The revision of the inventory asset.

entityType

Type: string

The type of the inventory asset.

glossaryTerms

Type: Array of DetailedGlossaryTerm structures

Glossary terms attached to the inventory asset.

listingCreatedBy

Type: string

The Amazon DataZone user who created the listing.

listingId

Type: string

The identifier of the listing (asset published in Amazon DataZone catalog).

listingRevision

Type: string

The revision of the listing (asset published in Amazon DataZone catalog).

listingUpdatedBy

Type: string

The Amazon DataZone user who updated the listing.

name

Type: string

The name of the inventory asset.

owningProjectId

Type: string

The identifier of the project that owns the inventory asset.

AssetListingItemAdditionalAttributes

Description

Additional attributes of an inventory asset.

Members

forms

Type: string

The metadata forms that form additional attributes of the metadata asset.

latestTimeSeriesDataPointForms

Type: Array of TimeSeriesDataPointSummaryFormOutput structures

The latest time series data points forms included in the additional attributes of an asset.

AssetRevision

Description

The revision of an inventory asset.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when an inventory asset revison was created.

createdBy

Type: string

The Amazon DataZone user who created the asset revision.

domainId

Type: string

The Amazon DataZone user who created the inventory asset.

id

Type: string

The identifier of the inventory asset revision.

revision

Type: string

The revision details of the inventory asset.

AssetTargetNameMap

Description

The name map for assets.

Members

assetId

Required: Yes
Type: string

The identifier of the inventory asset.

targetName

Required: Yes
Type: string

The target name in the asset target name map.

AssetTypeItem

Description

The details of the asset type.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset type was created.

createdBy

Type: string

The Amazon DataZone user who created the asset type.

description

Type: string

The description of the asset type.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain where the asset type exists.

formsOutput

Required: Yes
Type: Associative array of custom strings keys (FormName) to FormEntryOutput structures

The forms included in the details of the asset type.

name

Required: Yes
Type: string

The name of the asset type.

originDomainId

Type: string

The identifier of the Amazon DataZone domain where the asset type was originally created.

originProjectId

Type: string

The identifier of the Amazon DataZone project where the asset type exists.

owningProjectId

Required: Yes
Type: string

The identifier of the Amazon DataZone project that owns the asset type.

revision

Required: Yes
Type: string

The revision of the asset type.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the asset type was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the asset type.

BusinessNameGenerationConfiguration

Description

The configuration of the business name generation.

Members

enabled

Type: boolean

Specifies whether the business name generation is enabled.

CloudFormationProperties

Description

Part of the provisioning properties of the environment blueprint.

Members

templateUrl

Required: Yes
Type: string

The template URL of the cloud formation provisioning properties of the environment blueprint.

ConfigurableActionParameter

Description

The details of the parameters for the configurable environment action.

Members

key

Type: string

The key of the configurable action parameter.

value

Type: string

The value of the configurable action parameter.

ConfigurableEnvironmentAction

Description

The configurable action of a Amazon DataZone environment.

Members

auth

Type: string

The authentication type of a configurable action of a Amazon DataZone environment.

parameters

Required: Yes
Type: Array of ConfigurableActionParameter structures

The parameters of a configurable action in a Amazon DataZone environment.

type

Required: Yes
Type: string

The type of a configurable action in a Amazon DataZone environment.

ConflictException

Description

There is a conflict while performing this action.

Members

message

Required: Yes
Type: string

CustomParameter

Description

The details of user parameters of an environment blueprint.

Members

defaultValue

Type: string

The default value of the parameter.

description

Type: string

The description of the parameter.

fieldType

Required: Yes
Type: string

The filed type of the parameter.

isEditable

Type: boolean

Specifies whether the parameter is editable.

isOptional

Type: boolean

Specifies whether the custom parameter is optional.

keyName

Required: Yes
Type: string

The key name of the parameter.

DataProductItem

Description

Members

domainId

Type: string

itemId

Type: string

DataProductSummary

Description

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

createdBy

Type: string

dataProductItems

Type: Array of DataProductItem structures

description

Type: string

domainId

Required: Yes
Type: string

glossaryTerms

Type: Array of strings

id

Required: Yes
Type: string

name

Required: Yes
Type: string

owningProjectId

Required: Yes
Type: string

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

updatedBy

Type: string

DataSourceConfigurationInput

Description

The configuration of the data source.

Members

glueRunConfiguration

Type: GlueRunConfigurationInput structure

The configuration of the Amazon Web Services Glue data source.

redshiftRunConfiguration

Type: RedshiftRunConfigurationInput structure

The configuration of the Amazon Redshift data source.

DataSourceConfigurationOutput

Description

The configuration of the data source.

Members

glueRunConfiguration

Type: GlueRunConfigurationOutput structure

The configuration of the Amazon Web Services Glue data source.

redshiftRunConfiguration

Type: RedshiftRunConfigurationOutput structure

The configuration of the Amazon Redshift data source.

DataSourceErrorMessage

Description

The details of the error message that is returned if the operation cannot be successfully completed.

Members

errorDetail

Type: string

The details of the error message that is returned if the operation cannot be successfully completed.

errorType

Required: Yes
Type: string

The type of the error message that is returned if the operation cannot be successfully completed.

DataSourceRunActivity

Description

The activity details of the data source run.

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when data source run activity was created.

dataAssetId

Type: string

The identifier of the asset included in the data source run activity.

dataAssetStatus

Required: Yes
Type: string

The status of the asset included in the data source run activity.

dataSourceRunId

Required: Yes
Type: string

The identifier of the data source for the data source run activity.

database

Required: Yes
Type: string

The database included in the data source run activity.

errorMessage

Type: DataSourceErrorMessage structure

The details of the error message that is returned if the operation cannot be successfully completed.

projectId

Required: Yes
Type: string

The project ID included in the data source run activity.

technicalDescription

Type: string

The technical description included in the data source run activity.

technicalName

Required: Yes
Type: string

The technical name included in the data source run activity.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when data source run activity was updated.

DataSourceRunSummary

Description

The details of a data source run.

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a data source run was created.

dataSourceId

Required: Yes
Type: string

The identifier of the data source of the data source run.

errorMessage

Type: DataSourceErrorMessage structure

The details of the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The identifier of the data source run.

projectId

Required: Yes
Type: string

The project ID of the data source run.

runStatisticsForAssets

Type: RunStatisticsForAssets structure

The asset statistics from the data source run.

startedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a data source run was started.

status

Required: Yes
Type: string

The status of the data source run.

stoppedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a data source run was stopped.

type

Required: Yes
Type: string

The type of the data source run.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a data source run was updated.

DataSourceSummary

Description

The details of the data source.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was created.

dataSourceId

Required: Yes
Type: string

The ID of the data source.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the data source exists.

enableSetting

Type: string

Specifies whether the data source is enabled.

environmentId

Required: Yes
Type: string

The ID of the environment in which the data source exists.

lastRunAssetCount

Type: int

The count of the assets created during the last data source run.

lastRunAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source run was last performed.

lastRunErrorMessage

Type: DataSourceErrorMessage structure

The details of the error message that is returned if the operation cannot be successfully completed.

lastRunStatus

Type: string

The status of the last data source run.

name

Required: Yes
Type: string

The name of the data source.

schedule

Type: ScheduleConfiguration structure

The details of the schedule of the data source runs.

status

Required: Yes
Type: string

The status of the data source.

type

Required: Yes
Type: string

The type of the data source.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the data source was updated.

Deployment

Description

The details of the last deployment of the environment.

Members

deploymentId

Type: string

The identifier of the last deployment of the environment.

deploymentStatus

Type: string

The status of the last deployment of the environment.

deploymentType

Type: string

The type of the last deployment of the environment.

failureReason

Type: EnvironmentError structure

The failure reason of the last deployment of the environment.

isDeploymentComplete

Type: boolean

Specifies whether the last deployment of the environment is complete.

messages

Type: Array of strings

The messages of the last deployment of the environment.

DeploymentProperties

Description

The deployment properties of the Amazon DataZone blueprint.

Members

endTimeoutMinutes

Type: int

The end timeout of the environment blueprint deployment.

startTimeoutMinutes

Type: int

The start timeout of the environment blueprint deployment.

DetailedGlossaryTerm

Description

Details of a glossary term attached to the inventory asset.

Members

name

Type: string

The name of a glossary term attached to the inventory asset.

shortDescription

Type: string

The shoft description of a glossary term attached to the inventory asset.

DomainSummary

Description

A summary of a Amazon DataZone domain.

Members

arn

Required: Yes
Type: string

The ARN of the Amazon DataZone domain.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when a Amazon DataZone domain was created.

description

Type: string

A description of an Amazon DataZone domain.

id

Required: Yes
Type: string

The ID of the Amazon DataZone domain.

lastUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when a Amazon DataZone domain was last updated.

managedAccountId

Required: Yes
Type: string

The identifier of the Amazon Web Services account that manages the domain.

name

Required: Yes
Type: string

A name of an Amazon DataZone domain.

portalUrl

Type: string

The data portal URL for the Amazon DataZone domain.

status

Required: Yes
Type: string

The status of the Amazon DataZone domain.

EnvironmentBlueprintConfigurationItem

Description

The configuration details of an environment blueprint.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when an environment blueprint was created.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which an environment blueprint exists.

enabledRegions

Type: Array of strings

The enabled Amazon Web Services Regions specified in a blueprint configuration.

environmentBlueprintId

Required: Yes
Type: string

The identifier of the environment blueprint.

manageAccessRoleArn

Type: string

The ARN of the manage access role specified in the environment blueprint configuration.

provisioningRoleArn

Type: string

The ARN of the provisioning role specified in the environment blueprint configuration.

regionalParameters

Type: Associative array of custom strings keys (RegionName) to stringss

The regional parameters of the environment blueprint.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment blueprint was updated.

EnvironmentBlueprintSummary

Description

The details of an environment blueprint summary.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when an environment blueprint was created.

description

Type: string

The description of a blueprint.

id

Required: Yes
Type: string

The identifier of the blueprint.

name

Required: Yes
Type: string

The name of the blueprint.

provider

Required: Yes
Type: string

The provider of the blueprint.

provisioningProperties

Required: Yes
Type: ProvisioningProperties structure

The provisioning properties of the blueprint.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the blueprint was enabled.

EnvironmentError

Description

The failure reasons for the environment deployment.

Members

code

Type: string

The error code for the failure reason for the environment deployment.

message

Required: Yes
Type: string

The error message for the failure reason for the environment deployment.

EnvironmentParameter

Description

The parameter details of an evironment profile.

Members

name

Type: string

The name of an environment profile parameter.

value

Type: string

The value of an environment profile parameter.

EnvironmentProfileSummary

Description

The details of an environment profile.

Members

awsAccountId

Type: string

The identifier of an Amazon Web Services account in which an environment profile exists.

awsAccountRegion

Type: string

The Amazon Web Services Region in which an environment profile exists.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when an environment profile was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the environment profile.

description

Type: string

The description of the environment profile.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the environment profile exists.

environmentBlueprintId

Required: Yes
Type: string

The identifier of a blueprint with which an environment profile is created.

id

Required: Yes
Type: string

The identifier of the environment profile.

name

Required: Yes
Type: string

The name of the environment profile.

projectId

Type: string

The identifier of a project in which an environment profile exists.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment profile was updated.

EnvironmentSummary

Description

The details of an environment.

Members

awsAccountId

Type: string

The identifier of the Amazon Web Services account in which an environment exists.

awsAccountRegion

Type: string

The Amazon Web Services Region in which an environment exists.

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the environment.

description

Type: string

The description of the environment.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the environment exists.

environmentProfileId

Required: Yes
Type: string

The identifier of the environment profile with which the environment was created.

id

Type: string

The identifier of the environment.

name

Required: Yes
Type: string

The name of the environment.

projectId

Required: Yes
Type: string

The identifier of the project in which the environment exists.

provider

Required: Yes
Type: string

The provider of the environment.

status

Type: string

The status of the environment.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the environment was updated.

FailureCause

Description

Specifies the error message that is returned if the operation cannot be successfully completed.

Members

message

Type: string

The description of the error message.

Filter

Description

A search filter in Amazon DataZone.

Members

attribute

Required: Yes
Type: string

A search filter attribute in Amazon DataZone.

value

Required: Yes
Type: string

A search filter value in Amazon DataZone.

FilterClause

Description

A search filter clause in Amazon DataZone.

Members

and

Type: Array of FilterClause structures

The 'and' search filter clause in Amazon DataZone.

filter

Type: Filter structure

A search filter in Amazon DataZone.

or

Type: Array of FilterClause structures

The 'or' search filter clause in Amazon DataZone.

FilterExpression

Description

A filter expression in Amazon DataZone.

Members

expression

Required: Yes
Type: string

The search filter expression.

type

Required: Yes
Type: string

The search filter explresison type.

FormEntryInput

Description

The details of the form entry.

Members

required

Type: boolean

Specifies whether a form entry is required.

typeIdentifier

Required: Yes
Type: string

The type ID of the form entry.

typeRevision

Required: Yes
Type: string

The type revision of the form entry.

FormEntryOutput

Description

The details of the form entry.

Members

required

Type: boolean

Specifies whether a form entry is required.

typeName

Required: Yes
Type: string

The name of the type of the form entry.

typeRevision

Required: Yes
Type: string

The type revision of the form entry.

FormInput

Description

The details of a metadata form.

Members

content

Type: string

The content of the metadata form.

formName

Required: Yes
Type: string

The name of the metadata form.

typeIdentifier

Type: string

The ID of the metadata form type.

typeRevision

Type: string

The revision of the metadata form type.

FormOutput

Description

The details of a metadata form.

Members

content

Type: string

The content of the metadata form.

formName

Required: Yes
Type: string

The name of the metadata form.

typeName

Type: string

The name of the metadata form type.

typeRevision

Type: string

The revision of the metadata form type.

FormTypeData

Description

The details of the metadata form type.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the metadata form type was created.

createdBy

Type: string

The Amazon DataZone user who created teh metadata form type.

description

Type: string

The description of the metadata form type.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the form type exists.

imports

Type: Array of Import structures

The imports specified in the form type.

model

Type: Model structure

The model of the form type.

name

Required: Yes
Type: string

The name of the form type.

originDomainId

Type: string

The identifier of the Amazon DataZone domain in which the form type was originally created.

originProjectId

Type: string

The identifier of the project in which the form type was originally created.

owningProjectId

Type: string

The identifier of the project that owns the form type.

revision

Required: Yes
Type: string

The revision of the form type.

status

Type: string

The status of the form type.

GlossaryItem

Description

The details of a business glossary.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the glossary was created.

createdBy

Type: string

The Amazon DataZone user who created the glossary.

description

Type: string

The business glossary description.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the business glossary exists.

id

Required: Yes
Type: string

The identifier of the glossary.

name

Required: Yes
Type: string

The name of the glossary.

owningProjectId

Required: Yes
Type: string

The identifier of the project that owns the business glosary.

status

Required: Yes
Type: string

The business glossary status.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the business glossary was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the business glossary.

GlossaryTermItem

Description

The details of a business glossary term.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a business glossary term was created.

createdBy

Type: string

The Amazon DataZone user who created the business glossary.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the business glossary exists.

glossaryId

Required: Yes
Type: string

The identifier of the business glossary to which the term belongs.

id

Required: Yes
Type: string

The identifier of the business glossary term.

longDescription

Type: string

The long description of the business glossary term.

name

Required: Yes
Type: string

The name of the business glossary term.

shortDescription

Type: string

The short description of the business glossary term.

status

Required: Yes
Type: string

The status of the business glossary term.

termRelations

Type: TermRelations structure

The relations of the business glossary term.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a business glossary term was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the business glossary term.

GlueRunConfigurationInput

Description

The configuration details of the Amazon Web Services Glue data source.

Members

autoImportDataQualityResult

Type: boolean

Specifies whether to automatically import data quality metrics as part of the data source run.

dataAccessRole

Type: string

The data access role included in the configuration details of the Amazon Web Services Glue data source.

relationalFilterConfigurations

Required: Yes
Type: Array of RelationalFilterConfiguration structures

The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

GlueRunConfigurationOutput

Description

The configuration details of the Amazon Web Services Glue data source.

Members

accountId

Type: string

The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source.

autoImportDataQualityResult

Type: boolean

Specifies whether to automatically import data quality metrics as part of the data source run.

dataAccessRole

Type: string

The data access role included in the configuration details of the Amazon Web Services Glue data source.

region

Type: string

The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.

relationalFilterConfigurations

Required: Yes
Type: Array of RelationalFilterConfiguration structures

The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

GrantedEntity

Description

The details of a listing for which a subscription is granted.

Members

listing

Type: ListingRevision structure

The listing for which a subscription is granted.

GrantedEntityInput

Description

The details of a listing for which a subscription is to be granted.

Members

listing

Type: ListingRevisionInput structure

The listing for which a subscription is to be granted.

GroupDetails

Description

The details of a group in Amazon DataZone.

Members

groupId

Required: Yes
Type: string

The identifier of the group in Amazon DataZone.

GroupProfileSummary

Description

The details of a group profile.

Members

domainId

Type: string

The ID of the Amazon DataZone domain of a group profile.

groupName

Type: string

The group name of a group profile.

id

Type: string

The ID of a group profile.

status

Type: string

The status of a group profile.

IamUserProfileDetails

Description

The details of an IAM user profile in Amazon DataZone.

Members

arn

Type: string

The ARN of an IAM user profile in Amazon DataZone.

Import

Description

The details of the import of the metadata form type.

Members

name

Required: Yes
Type: string

The name of the import.

revision

Required: Yes
Type: string

The revision of the import.

InternalServerException

Description

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

Members

message

Required: Yes
Type: string

ListingItem

Description

The details of a listing (aka asset published in a Amazon DataZone catalog).

Members

assetListing

Type: AssetListing structure

An asset published in an Amazon DataZone catalog.

ListingRevision

Description

A revision of an asset published in a Amazon DataZone catalog.

Members

id

Required: Yes
Type: string

An identifier of a revision of an asset published in a Amazon DataZone catalog.

revision

Required: Yes
Type: string

The details of a revision of an asset published in a Amazon DataZone catalog.

ListingRevisionInput

Description

A revision to be made to an asset published in a Amazon DataZone catalog.

Members

identifier

Required: Yes
Type: string

An identifier of revision to be made to an asset published in a Amazon DataZone catalog.

revision

Required: Yes
Type: string

The details of a revision to be made to an asset published in a Amazon DataZone catalog.

Member

Description

The details about a project member.

Members

groupIdentifier

Type: string

The ID of the group of a project member.

userIdentifier

Type: string

The user ID of a project member.

MemberDetails

Description

The details about a project member.

Members

group

Type: GroupDetails structure

The group details of a project member.

user

Type: UserDetails structure

The user details of a project member.

MetadataGenerationRunItem

Description

The metadata generation run.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp at which the metadata generation run was created.

createdBy

Type: string

The user who created the metadata generation run.

domainId

Required: Yes
Type: string

The ID of the Amazon DataZone domain in which the metadata generation run was created.

id

Required: Yes
Type: string

The ID of the metadata generation run.

owningProjectId

Required: Yes
Type: string

The ID of the project that owns the asset for which the metadata generation was ran.

status

Type: string

The status of the metadata generation run.

target

Type: MetadataGenerationRunTarget structure

The asset for which metadata was generated.

type

Type: string

The type of the metadata generation run.

MetadataGenerationRunTarget

Description

The asset for which metadata was generated.

Members

identifier

Required: Yes
Type: string

The ID of the metadata generation run's target.

revision

Type: string

The revision of the asset for which metadata was generated.

type

Required: Yes
Type: string

The type of the asset for which metadata was generated.

Model

Description

The model of the API.

Members

smithy

Type: string

Indicates the smithy model of the API.

NotificationOutput

Description

The details of a notification generated in Amazon DataZone.

Members

actionLink

Required: Yes
Type: string

The action link included in the notification.

creationTimestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a notification was created.

domainIdentifier

Required: Yes
Type: string

The identifier of a Amazon DataZone domain in which the notification exists.

identifier

Required: Yes
Type: string

The identifier of the notification.

lastUpdatedTimestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the notification was last updated.

message

Required: Yes
Type: string

The message included in the notification.

metadata

Type: Associative array of custom strings keys (String) to strings

The metadata included in the notification.

status

Type: string

The status included in the notification.

title

Required: Yes
Type: string

The title of the notification.

topic

Required: Yes
Type: Topic structure

The topic of the notification.

type

Required: Yes
Type: string

The type of the notification.

NotificationResource

Description

The details of the resource mentioned in a notification.

Members

id

Required: Yes
Type: string

The ID of the resource mentioned in a notification.

name

Type: string

The name of the resource mentioned in a notification.

type

Required: Yes
Type: string

The type of the resource mentioned in a notification.

PredictionConfiguration

Description

The configuration of the prediction.

Members

businessNameGeneration

Type: BusinessNameGenerationConfiguration structure

The business name generation mechanism.

ProjectDeletionError

Description

Specifies the error message that is returned if the operation cannot be successfully completed.

Members

code

Type: string

The code of the project deletion error.

message

Type: string

The message of the project deletion error.

ProjectMember

Description

The details of a project member.

Members

designation

Required: Yes
Type: string

The designated role of a project member.

memberDetails

Required: Yes
Type: MemberDetails structure

The membership details of a project member.

ProjectSummary

Description

The details of a Amazon DataZone project.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a project was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the project.

description

Type: string

The description of a project.

domainId

Required: Yes
Type: string

The identifier of a Amazon DataZone domain where the project exists.

failureReasons

Type: Array of ProjectDeletionError structures

Specifies the error message that is returned if the operation cannot be successfully completed.

id

Required: Yes
Type: string

The identifier of a project.

name

Required: Yes
Type: string

The name of a project.

projectStatus

Type: string

The status of the project.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the project was updated.

ProvisioningProperties

Description

The provisioning properties of an environment blueprint.

Members

cloudFormation

Type: CloudFormationProperties structure

The cloud formation properties included as part of the provisioning properties of an environment blueprint.

RecommendationConfiguration

Description

The recommendation to be updated as part of the UpdateDataSource action.

Members

enableBusinessNameGeneration

Type: boolean

Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

RedshiftClusterStorage

Description

The details of the Amazon Redshift cluster storage.

Members

clusterName

Required: Yes
Type: string

The name of an Amazon Redshift cluster.

RedshiftCredentialConfiguration

Description

The details of the credentials required to access an Amazon Redshift cluster.

Members

secretManagerArn

Required: Yes
Type: string

The ARN of a secret manager for an Amazon Redshift cluster.

RedshiftRunConfigurationInput

Description

The configuration details of the Amazon Redshift data source.

Members

dataAccessRole

Type: string

The data access role included in the configuration details of the Amazon Redshift data source.

redshiftCredentialConfiguration

Required: Yes
Type: RedshiftCredentialConfiguration structure

The details of the credentials required to access an Amazon Redshift cluster.

redshiftStorage

Required: Yes
Type: RedshiftStorage structure

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

relationalFilterConfigurations

Required: Yes
Type: Array of RelationalFilterConfiguration structures

The relational filger configurations included in the configuration details of the Amazon Redshift data source.

RedshiftRunConfigurationOutput

Description

The configuration details of the Amazon Redshift data source.

Members

accountId

Type: string

The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source.

dataAccessRole

Type: string

The data access role included in the configuration details of the Amazon Redshift data source.

redshiftCredentialConfiguration

Required: Yes
Type: RedshiftCredentialConfiguration structure

The details of the credentials required to access an Amazon Redshift cluster.

redshiftStorage

Required: Yes
Type: RedshiftStorage structure

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

region

Type: string

The Amazon Web Services region included in the configuration details of the Amazon Redshift data source.

relationalFilterConfigurations

Required: Yes
Type: Array of RelationalFilterConfiguration structures

The relational filger configurations included in the configuration details of the Amazon Redshift data source.

RedshiftServerlessStorage

Description

The details of the Amazon Redshift Serverless workgroup storage.

Members

workgroupName

Required: Yes
Type: string

The name of the Amazon Redshift Serverless workgroup.

RedshiftStorage

Description

The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

Members

redshiftClusterSource

Type: RedshiftClusterStorage structure

The details of the Amazon Redshift cluster source.

redshiftServerlessSource

Type: RedshiftServerlessStorage structure

The details of the Amazon Redshift Serverless workgroup source.

RejectChoice

Description

The details of the automatically generated business metadata that is rejected.

Members

predictionChoices

Type: Array of ints

Specifies the the automatically generated business metadata that can be rejected.

predictionTarget

Required: Yes
Type: string

Specifies the target (for example, a column name) where a prediction can be rejected.

RejectRule

Description

Specifies the rule and the threshold under which a prediction can be rejected.

Members

rule

Type: string

Specifies whether you want to reject the top prediction for all targets or none.

threshold

Type: float

The confidence score that specifies the condition at which a prediction can be rejected.

RelationalFilterConfiguration

Description

The relational filter configuration for the data source.

Members

databaseName

Required: Yes
Type: string

The database name specified in the relational filter configuration for the data source.

filterExpressions

Type: Array of FilterExpression structures

The filter expressions specified in the relational filter configuration for the data source.

schemaName

Type: string

The schema name specified in the relational filter configuration for the data source.

Resource

Description

The details of a provisioned resource of this Amazon DataZone environment.

Members

name

Type: string

The name of a provisioned resource of this Amazon DataZone environment.

provider

Type: string

The provider of a provisioned resource of this Amazon DataZone environment.

type

Required: Yes
Type: string

The type of a provisioned resource of this Amazon DataZone environment.

value

Required: Yes
Type: string

The value of a provisioned resource of this Amazon DataZone environment.

ResourceNotFoundException

Description

The specified resource cannot be found.

Members

message

Required: Yes
Type: string

RunStatisticsForAssets

Description

The asset statistics from the data source run.

Members

added

Type: int

The added statistic for the data source run.

failed

Type: int

The failed statistic for the data source run.

skipped

Type: int

The skipped statistic for the data source run.

unchanged

Type: int

The unchanged statistic for the data source run.

updated

Type: int

The updated statistic for the data source run.

ScheduleConfiguration

Description

The details of the schedule of the data source runs.

Members

schedule

Type: string

The schedule of the data source runs.

timezone

Type: string

The timezone of the data source run.

SearchInItem

Description

The details of the search.

Members

attribute

Required: Yes
Type: string

The search attribute.

SearchInventoryResultItem

Description

The details of the search results.

Members

assetItem

Type: AssetItem structure

The asset item included in the search results.

dataProductItem

Type: DataProductSummary structure

The data product item included in the search results.

glossaryItem

Type: GlossaryItem structure

The glossary item included in the search results.

glossaryTermItem

Type: GlossaryTermItem structure

The glossary term item included in the search results.

SearchResultItem

Description

The details of the results of the SearchListings action.

Members

assetListing

Type: AssetListingItem structure

The asset listing included in the results of the SearchListings action.

SearchSort

Description

The details of the way to sort search results.

Members

attribute

Required: Yes
Type: string

The attribute detail of the way to sort search results.

order

Type: string

The order detail of the wya to sort search results.

SearchTypesResultItem

Description

The details of the results of the SearchTypes action.

Members

assetTypeItem

Type: AssetTypeItem structure

The asset type included in the results of the SearchTypes action.

formTypeItem

Type: FormTypeData structure

The form type included in the results of the SearchTypes action.

ServiceQuotaExceededException

Description

The request has exceeded the specified service quota.

Members

message

Required: Yes
Type: string

SingleSignOn

Description

The single sign-on details in Amazon DataZone.

Members

type

Type: string

The type of single sign-on in Amazon DataZone.

userAssignment

Type: string

The single sign-on user assignment in Amazon DataZone.

SsoUserProfileDetails

Description

The single sign-on details of the user profile.

Members

firstName

Type: string

The first name included in the single sign-on details of the user profile.

lastName

Type: string

The last name included in the single sign-on details of the user profile.

username

Type: string

The username included in the single sign-on details of the user profile.

SubscribedAsset

Description

The details of the asset for which the subscription grant is created.

Members

assetId

Required: Yes
Type: string

The identifier of the asset for which the subscription grant is created.

assetRevision

Required: Yes
Type: string

The revision of the asset for which the subscription grant is created.

failureCause

Type: FailureCause structure

The failure cause included in the details of the asset for which the subscription grant is created.

failureTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The failure timestamp included in the details of the asset for which the subscription grant is created.

grantedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription grant to the asset is created.

status

Required: Yes
Type: string

The status of the asset for which the subscription grant is created.

targetName

Type: string

The target name of the asset for which the subscription grant is created.

SubscribedAssetListing

Description

The details of the published asset for which the subscription grant is created.

Members

entityId

Type: string

The identifier of the published asset for which the subscription grant is created.

entityRevision

Type: string

The revision of the published asset for which the subscription grant is created.

entityType

Type: string

The type of the published asset for which the subscription grant is created.

forms

Type: string

The forms attached to the published asset for which the subscription grant is created.

glossaryTerms

Type: Array of DetailedGlossaryTerm structures

The glossary terms attached to the published asset for which the subscription grant is created.

SubscribedListing

Description

The details of the published asset for which the subscription grant is created.

Members

description

Required: Yes
Type: string

The description of the published asset for which the subscription grant is created.

id

Required: Yes
Type: string

The identifier of the published asset for which the subscription grant is created.

item

Required: Yes
Type: SubscribedListingItem structure

The published asset for which the subscription grant is created.

name

Required: Yes
Type: string

The name of the published asset for which the subscription grant is created.

ownerProjectId

Required: Yes
Type: string

The identifier of the project of the published asset for which the subscription grant is created.

ownerProjectName

Type: string

The name of the project that owns the published asset for which the subscription grant is created.

revision

Type: string

The revision of the published asset for which the subscription grant is created.

SubscribedListingInput

Description

The published asset for which the subscription grant is to be created.

Members

identifier

Required: Yes
Type: string

The identifier of the published asset for which the subscription grant is to be created.

SubscribedListingItem

Description

The published asset for which the subscription grant is created.

Members

assetListing

Type: SubscribedAssetListing structure

The asset for which the subscription grant is created.

SubscribedPrincipal

Description

The principal that has the subscription grant for the asset.

Members

project

Type: SubscribedProject structure

The project that has the subscription grant.

SubscribedPrincipalInput

Description

The principal that is to be given a subscriptiong grant.

Members

project

Type: SubscribedProjectInput structure

The project that is to be given a subscription grant.

SubscribedProject

Description

The project that has the subscription grant.

Members

id

Type: string

The identifier of the project that has the subscription grant.

name

Type: string

The name of the project that has the subscription grant.

SubscribedProjectInput

Description

The project that is to be given a subscription grant.

Members

identifier

Type: string

The identifier of the project that is to be given a subscription grant.

SubscriptionGrantSummary

Description

The details of the subscription grant.

Members

assets

Type: Array of SubscribedAsset structures

The assets included in the subscription grant.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a subscription grant was created.

createdBy

Required: Yes
Type: string

The datazone user who created the subscription grant.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription grant exists.

grantedEntity

Required: Yes
Type: GrantedEntity structure

The entity to which the subscription is granted.

id

Required: Yes
Type: string

The identifier of the subscription grant.

status

Required: Yes
Type: string

The status of the subscription grant.

subscriptionId

Type: string

The ID of the subscription grant.

subscriptionTargetId

Required: Yes
Type: string

The identifier of the target of the subscription grant.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestampf of when the subscription grant was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription grant.

SubscriptionRequestSummary

Description

The details of the subscription request.

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when a subscription request was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription request.

decisionComment

Type: string

The decision comment of the subscription request.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription request exists.

id

Required: Yes
Type: string

The identifier of the subscription request.

requestReason

Required: Yes
Type: string

The reason for the subscription request.

reviewerId

Type: string

The identifier of the subscription request reviewer.

status

Required: Yes
Type: string

The status of the subscription request.

subscribedListings

Required: Yes
Type: Array of SubscribedListing structures

The listings included in the subscription request.

subscribedPrincipals

Required: Yes
Type: Array of SubscribedPrincipal structures

The principals included in the subscription request.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription request was updated.

updatedBy

Type: string

The identifier of the Amazon DataZone user who updated the subscription request.

SubscriptionSummary

Description

The details of the subscription.

Members

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which a subscription exists.

id

Required: Yes
Type: string

The identifier of the subscription.

retainPermissions

Type: boolean

The retain permissions included in the subscription.

status

Required: Yes
Type: string

The status of the subscription.

subscribedListing

Required: Yes
Type: SubscribedListing structure

The listing included in the subscription.

subscribedPrincipal

Required: Yes
Type: SubscribedPrincipal structure

The principal included in the subscription.

subscriptionRequestId

Type: string

The identifier of the subscription request for the subscription.

updatedAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription.

SubscriptionTargetForm

Description

The details of the subscription target configuration.

Members

content

Required: Yes
Type: string

The content of the subscription target configuration.

formName

Required: Yes
Type: string

The form name included in the subscription target configuration.

SubscriptionTargetSummary

Description

The details of the subscription target.

Members

applicableAssetTypes

Required: Yes
Type: Array of strings

The asset types included in the subscription target.

authorizedPrincipals

Required: Yes
Type: Array of strings

The authorized principals included in the subscription target.

createdAt

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription target was created.

createdBy

Required: Yes
Type: string

The Amazon DataZone user who created the subscription target.

domainId

Required: Yes
Type: string

The identifier of the Amazon DataZone domain in which the subscription target exists.

environmentId

Required: Yes
Type: string

The identifier of the environment of the subscription target.

id

Required: Yes
Type: string

The identifier of the subscription target.

manageAccessRole

Required: Yes
Type: string

The manage access role specified in the subscription target.

name

Required: Yes
Type: string

The name of the subscription target.

projectId

Required: Yes
Type: string

The identifier of the project specified in the subscription target.

provider

Required: Yes
Type: string

The provider of the subscription target.

subscriptionTargetConfig

Required: Yes
Type: Array of SubscriptionTargetForm structures

The configuration of the subscription target.

type

Required: Yes
Type: string

The type of the subscription target.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the subscription target was updated.

updatedBy

Type: string

The Amazon DataZone user who updated the subscription target.

TermRelations

Description

The details of the term relations.

Members

classifies

Type: Array of strings

The classifies of the term relations.

isA

Type: Array of strings

The isA property of the term relations.

ThrottlingException

Description

The request was denied due to request throttling.

Members

message

Required: Yes
Type: string

TimeSeriesDataPointFormInput

Description

The time series data points form.

Members

content

Type: string

The content of the time series data points form.

formName

Required: Yes
Type: string

The name of the time series data points form.

timestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the time series data points form.

typeIdentifier

Required: Yes
Type: string

The ID of the type of the time series data points form.

typeRevision

Type: string

The revision type of the time series data points form.

TimeSeriesDataPointFormOutput

Description

The time series data points form.

Members

content

Type: string

The content of the time series data points form.

formName

Required: Yes
Type: string

The name of the time series data points form.

id

Type: string

The ID of the time series data points form.

timestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the time series data points form.

typeIdentifier

Required: Yes
Type: string

The ID of the type of the time series data points form.

typeRevision

Type: string

The revision type of the time series data points form.

TimeSeriesDataPointSummaryFormOutput

Description

The summary of the time series data points form.

Members

contentSummary

Type: string

The content of the summary of the time series data points form.

formName

Required: Yes
Type: string

The name of the time series data points summary form.

id

Type: string

The ID of the time series data points summary form.

timestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the time series data points summary form.

typeIdentifier

Required: Yes
Type: string

The type ID of the time series data points summary form.

typeRevision

Type: string

The type revision of the time series data points summary form.

Topic

Description

The topic of the notification.

Members

resource

Required: Yes
Type: NotificationResource structure

The details of the resource mentioned in a notification.

role

Required: Yes
Type: string

The role of the resource mentioned in a notification.

subject

Required: Yes
Type: string

The subject of the resource mentioned in a notification.

UnauthorizedException

Description

You do not have permission to perform this action.

Members

message

Required: Yes
Type: string

UserDetails

Description

The user details of a project member.

Members

userId

Required: Yes
Type: string

The identifier of the Amazon DataZone user.

UserProfileDetails

Description

The details of the user profile in Amazon DataZone.

Members

iam

Type: IamUserProfileDetails structure

The IAM details included in the user profile details.

sso

Type: SsoUserProfileDetails structure

The single sign-on details included in the user profile details.

UserProfileSummary

Description

The details of the user profile.

Members

details

Type: UserProfileDetails structure

The details of the user profile.

domainId

Type: string

The ID of the Amazon DataZone domain of the user profile.

id

Type: string

The ID of the user profile.

status

Type: string

The status of the user profile.

type

Type: string

The type of the user profile.

ValidationException

Description

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

Members

message

Required: Yes
Type: string

Amazon DataZone 2018-05-10

Operation Summary

Paginators

Operations

AcceptPredictions

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AcceptSubscriptionRequest

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CancelMetadataGenerationRun

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CancelSubscription

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAsset

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAssetRevision

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateAssetType

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDataSource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax