The identifier of the notebook run.
* @public */ id: string | undefined; /** *The identifier of the Amazon SageMaker Unified Studio domain.
* @public */ domainId: string | undefined; /** *The identifier of the project that owns the notebook run.
* @public */ owningProjectId: string | undefined; /** *The status of the notebook run.
* @public */ status: NotebookRunStatus | undefined; } /** * @public */ export interface PostLineageEventInput { /** *The ID of the domain where you want to post a data lineage event.
* @public */ domainIdentifier: string | undefined; /** *The data lineage event that you want to post. Only open-lineage run event are supported as events.
* @public */ event: Uint8Array | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface PostLineageEventOutput { /** *The ID of the lineage event.
* @public */ id?: string | undefined; /** *The ID of the domain.
* @public */ domainId?: string | undefined; } /** *The time series data points form.
* @public */ export interface TimeSeriesDataPointFormInput { /** *The name of the time series data points form.
* @public */ formName: string | undefined; /** *The ID of the type of the time series data points form.
* @public */ typeIdentifier: string | undefined; /** *The revision type of the time series data points form.
* @public */ typeRevision?: string | undefined; /** *The timestamp of the time series data points form.
* @public */ timestamp: Date | undefined; /** *The content of the time series data points form.
* @public */ content?: string | undefined; } /** * @public */ export interface PostTimeSeriesDataPointsInput { /** *The ID of the Amazon DataZone domain in which you want to post time series data points.
* @public */ domainIdentifier: string | undefined; /** *The ID of the asset for which you want to post time series data points.
* @public */ entityIdentifier: string | undefined; /** *The type of the asset for which you want to post data points.
* @public */ entityType: TimeSeriesEntityType | undefined; /** *The forms that contain the data points that you want to post.
* @public */ forms: TimeSeriesDataPointFormInput[] | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface PostTimeSeriesDataPointsOutput { /** *The ID of the Amazon DataZone domain in which you want to post time series data points.
* @public */ domainId?: string | undefined; /** *The ID of the asset for which you want to post time series data points.
* @public */ entityId?: string | undefined; /** *The type of the asset for which you want to post data points.
* @public */ entityType?: TimeSeriesEntityType | undefined; /** *The forms that contain the data points that you have posted.
* @public */ forms?: TimeSeriesDataPointFormOutput[] | undefined; } /** * @public */ export interface PutDataExportConfigurationInput { /** *The domain ID for which you want to create data export configuration details.
* @public */ domainIdentifier: string | undefined; /** *Specifies that the export is to be enabled as part of creating data export configuration details.
* @public */ enableExport: boolean | undefined; /** *The encryption configuration as part of creating data export configuration details.
The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio.
* @public */ encryptionConfiguration?: EncryptionConfiguration | undefined; /** *A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface PutDataExportConfigurationOutput { } /** *A search filter in Amazon DataZone.
* @public */ export interface Filter { /** *A search filter attribute in Amazon DataZone.
* @public */ attribute: string | undefined; /** *A search filter string value in Amazon DataZone.
* @public */ value?: string | undefined; /** *A search filter integer value in Amazon DataZone.
* @public */ intValue?: number | undefined; /** *Specifies the search filter operator.
* @public */ operator?: FilterOperator | undefined; } /** *The pattern describing the query's relational traversal.
* @public */ export interface RelationPattern { /** *The type of relation to query.
* @public */ relationType: RelationType | undefined; /** *The direction to query.
* @public */ relationDirection: RelationDirection | undefined; /** *The number of hops to query.
* @public */ maxPathLength?: number | undefined; } /** *The summary and output forms of a LineageNode
* @public */ export interface LineageNodeItem { /** *The ID of the domain of the data lineage node.
* @public */ domainId: string | undefined; /** *The name of the data lineage node.
* @public */ name?: string | undefined; /** *The description of the data lineage node.
* @public */ description?: string | undefined; /** *The timestamp at which the data lineage node was created.
* @public */ createdAt?: Date | undefined; /** *The user who created the data lineage node.
* @public */ createdBy?: string | undefined; /** *The timestamp at which the data lineage node was updated.
* @public */ updatedAt?: Date | undefined; /** *The user who updated the data lineage node.
* @public */ updatedBy?: string | undefined; /** *The ID of the data lineage node.
* @public */ id: string | undefined; /** *The name of the type of the data lineage node.
* @public */ typeName: string | undefined; /** *The type of the revision of the data lineage node.
* @public */ typeRevision?: string | undefined; /** *The alternate ID of the data lineage node.
* @public */ sourceIdentifier?: string | undefined; /** *The event timestamp of the data lineage node.
* @public */ eventTimestamp?: Date | undefined; /** *The forms included in the additional attributes of a data lineage node.
* @public */ formsOutput?: FormOutput[] | undefined; /** *The IDs of the upstream data lineage nodes.
* @public */ upstreamLineageNodeIds?: string[] | undefined; /** *The IDs of the downstream data lineage nodes.
* @public */ downstreamLineageNodeIds?: string[] | undefined; } /** *Resulting entity from the query.
* @public */ export type ResultItem = ResultItem.LineageNodeMember | ResultItem.$UnknownMember; /** * @public */ export declare namespace ResultItem { /** *Resulting data lineage node from the query.
* @public */ interface LineageNodeMember { lineageNode: LineageNodeItem; $unknown?: never; } /** * @public */ interface $UnknownMember { lineageNode?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe results of the QueryGraph action.
When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to QueryGraph to list the next set of entities.
The details of the automatically generated business metadata that is rejected.
* @public */ export interface RejectChoice { /** *Specifies the target (for example, a column name) where a prediction can be rejected.
* @public */ predictionTarget: string | undefined; /** *Specifies the the automatically generated business metadata that can be rejected.
* @public */ predictionChoices?: number[] | undefined; } /** *Specifies the rule and the threshold under which a prediction can be rejected.
* @public */ export interface RejectRule { /** *Specifies whether you want to reject the top prediction for all targets or none.
* @public */ rule?: RejectRuleBehavior | undefined; /** *The confidence score that specifies the condition at which a prediction can be rejected.
* @public */ threshold?: number | undefined; } /** * @public */ export interface RejectPredictionsInput { /** *The identifier of the Amazon DataZone domain.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the prediction.
* @public */ identifier: string | undefined; /** *The revision that is to be made to the asset.
* @public */ revision?: string | undefined; /** *Specifies the rule (or the conditions) under which a prediction can be rejected.
* @public */ rejectRule?: RejectRule | undefined; /** *Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.
* @public */ rejectChoices?: RejectChoice[] | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface RejectPredictionsOutput { /** *The ID of the Amazon DataZone domain.
* @public */ domainId: string | undefined; /** *The ID of the asset.
* @public */ assetId: string | undefined; /** *The revision that is to be made to the asset.
* @public */ assetRevision: string | undefined; } /** * @public */ export interface RejectSubscriptionRequestInput { /** *The identifier of the Amazon DataZone domain in which the subscription request was rejected.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the subscription request that was rejected.
* @public */ identifier: string | undefined; /** *The decision comment of the rejected subscription request.
* @public */ decisionComment?: string | undefined; } /** * @public */ export interface RejectSubscriptionRequestOutput { /** *The identifier of the subscription request that was rejected.
* @public */ id: string | undefined; /** *The timestamp of when the subscription request was rejected.
* @public */ createdBy: string | undefined; /** *The Amazon DataZone user who updated the subscription request.
* @public */ updatedBy?: string | undefined; /** *The identifier of the Amazon DataZone domain in which the subscription request was rejected.
* @public */ domainId: string | undefined; /** *The status of the subscription request.
* @public */ status: SubscriptionRequestStatus | undefined; /** *The timestamp of when the subscription request was rejected.
* @public */ createdAt: Date | undefined; /** *The timestamp of when the subscription request was updated.
* @public */ updatedAt: Date | undefined; /** *The reason for the subscription request.
* @public */ requestReason: string | undefined; /** *The subscribed principals of the subscription request.
* @public */ subscribedPrincipals: SubscribedPrincipal[] | undefined; /** *The subscribed listings of the subscription request.
* @public */ subscribedListings: SubscribedListing[] | undefined; /** *The identifier of the subscription request reviewer.
* @public */ reviewerId?: string | undefined; /** *The decision comment of the rejected subscription request.
* @public */ decisionComment?: string | undefined; /** *The ID of the existing subscription.
* @public */ existingSubscriptionId?: string | undefined; /** *Metadata forms included in the subscription request.
* @public */ metadataForms?: FormOutput[] | undefined; } /** * @public */ export interface RemoveEntityOwnerInput { /** *The ID of the domain where you want to remove an owner from an entity.
* @public */ domainIdentifier: string | undefined; /** *The type of the entity from which you want to remove an owner.
* @public */ entityType: DataZoneEntityType | undefined; /** *The ID of the entity from which you want to remove an owner.
* @public */ entityIdentifier: string | undefined; /** *The owner that you want to remove from an entity.
* @public */ owner: OwnerProperties | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface RemoveEntityOwnerOutput { } /** * @public */ export interface RemovePolicyGrantInput { /** *The ID of the domain where you want to remove a policy grant.
* @public */ domainIdentifier: string | undefined; /** *The type of the entity from which you want to remove a policy grant.
* @public */ entityType: TargetEntityType | undefined; /** *The ID of the entity from which you want to remove a policy grant.
* @public */ entityIdentifier: string | undefined; /** *The type of the policy that you want to remove.
* @public */ policyType: ManagedPolicyType | undefined; /** *The principal from which you want to remove a policy grant.
* @public */ principal: PolicyGrantPrincipal | undefined; /** *The ID of the policy grant that is to be removed from a specified entity.
* @public */ grantIdentifier?: string | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface RemovePolicyGrantOutput { } /** * @public */ export interface RevokeSubscriptionInput { /** *The identifier of the Amazon DataZone domain where you want to revoke a subscription.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the revoked subscription.
* @public */ identifier: string | undefined; /** *Specifies whether permissions are retained when the subscription is revoked.
* @public */ retainPermissions?: boolean | undefined; } /** * @public */ export interface RevokeSubscriptionOutput { /** *The identifier of the revoked subscription.
* @public */ id: string | undefined; /** *The identifier of the user who revoked the subscription.
* @public */ createdBy: string | undefined; /** *The Amazon DataZone user who revoked the subscription.
* @public */ updatedBy?: string | undefined; /** *The identifier of the Amazon DataZone domain where you want to revoke a subscription.
* @public */ domainId: string | undefined; /** *The status of the revoked subscription.
* @public */ status: SubscriptionStatus | undefined; /** *The timestamp of when the subscription was revoked.
* @public */ createdAt: Date | undefined; /** *The timestamp of when the subscription was revoked.
* @public */ updatedAt: Date | undefined; /** *The subscribed principal of the revoked subscription.
* @public */ subscribedPrincipal: SubscribedPrincipal | undefined; /** *The subscribed listing of the revoked subscription.
* @public */ subscribedListing: SubscribedListing | undefined; /** *The identifier of the subscription request for the revoked subscription.
* @public */ subscriptionRequestId?: string | undefined; /** *Specifies whether permissions are retained when the subscription is revoked.
* @public */ retainPermissions?: boolean | undefined; } /** * @public */ export interface DeleteRuleInput { /** *The ID of the domain that where the rule is to be deleted.
* @public */ domainIdentifier: string | undefined; /** *The ID of the rule that is to be deleted.
* @public */ identifier: string | undefined; } /** * @public */ export interface DeleteRuleOutput { } /** * @public */ export interface GetRuleInput { /** *The ID of the domain where the GetRule action is to be invoked.
The ID of the rule.
* @public */ identifier: string | undefined; /** *The revision of the rule.
* @public */ revision?: string | undefined; } /** * @public */ export interface GetRuleOutput { /** *The ID of the rule.
* @public */ identifier: string | undefined; /** *The revision of the rule.
* @public */ revision: string | undefined; /** *The name of the rule.
* @public */ name: string | undefined; /** *The type of the rule.
* @public */ ruleType: RuleType | undefined; /** *The target of the rule.
* @public */ target: RuleTarget | undefined; /** *The action of the rule.
* @public */ action: RuleAction | undefined; /** *The scope of the rule.
* @public */ scope: RuleScope | undefined; /** *The detail of the rule.
* @public */ detail: RuleDetail | undefined; /** *The target type of the rule.
* @public */ targetType?: RuleTargetType | undefined; /** *The description of the rule.
* @public */ description?: string | undefined; /** *The timestamp at which the rule was created.
* @public */ createdAt: Date | undefined; /** *The timestamp at which the rule was last updated.
* @public */ updatedAt: Date | undefined; /** *The user who created the rule.
* @public */ createdBy: string | undefined; /** *The timestamp at which the rule was last updated.
* @public */ lastUpdatedBy: string | undefined; } /** * @public */ export interface ListRulesInput { /** *The ID of the domain in which the rules are to be listed.
* @public */ domainIdentifier: string | undefined; /** *The target type of the rule.
* @public */ targetType: RuleTargetType | undefined; /** *The target ID of the rule.
* @public */ targetIdentifier: string | undefined; /** *The type of the rule.
* @public */ ruleType?: RuleType | undefined; /** *The action of the rule.
* @public */ action?: RuleAction | undefined; /** *The IDs of projects in which rules are to be listed.
* @public */ projectIds?: string[] | undefined; /** *The asset types of the rule.
* @public */ assetTypes?: string[] | undefined; /** *The data product of the rule.
* @public */ dataProduct?: boolean | undefined; /** *Specifies whether to include cascading rules in the results.
* @public */ includeCascaded?: boolean | undefined; /** *The maximum number of rules to return in a single call to ListRules. When the number of rules to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListRules to list the next set of rules.
When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.
The summary of the rule.
* @public */ export interface RuleSummary { /** *The ID of the rule.
* @public */ identifier?: string | undefined; /** *The revision of the rule.
* @public */ revision?: string | undefined; /** *The type of the rule.
* @public */ ruleType?: RuleType | undefined; /** *The name of the rule.
* @public */ name?: string | undefined; /** *The target type of the rule.
* @public */ targetType?: RuleTargetType | undefined; /** *The target of the rule.
* @public */ target?: RuleTarget | undefined; /** *The action of the rule.
* @public */ action?: RuleAction | undefined; /** *The scope of the rule.
* @public */ scope?: RuleScope | undefined; /** *The timestamp at which the rule was last updated.
* @public */ updatedAt?: Date | undefined; /** *The timestamp at which the rule was last updated.
* @public */ lastUpdatedBy?: string | undefined; } /** * @public */ export interface ListRulesOutput { /** *The results of the ListRules action.
When the number of rules is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of rules, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListRules to list the next set of rules.
The ID of the domain in which a rule is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The ID of the rule that is to be updated
* @public */ identifier: string | undefined; /** *The name of the rule.
* @public */ name?: string | undefined; /** *The description of the rule.
* @public */ description?: string | undefined; /** *The scrope of the rule.
* @public */ scope?: RuleScope | undefined; /** *The detail of the rule.
* @public */ detail?: RuleDetail | undefined; /** *Specifies whether to update this rule in the child domain units.
* @public */ includeChildDomainUnits?: boolean | undefined; } /** * @public */ export interface UpdateRuleOutput { /** *The ID of the rule.
* @public */ identifier: string | undefined; /** *The revision of the rule.
* @public */ revision: string | undefined; /** *The name of the rule.
* @public */ name: string | undefined; /** *The type of the rule.
* @public */ ruleType: RuleType | undefined; /** *The target of the rule.
* @public */ target: RuleTarget | undefined; /** *The action of the rule.
* @public */ action: RuleAction | undefined; /** *The scope of the rule.
* @public */ scope: RuleScope | undefined; /** *The detail of the rule.
* @public */ detail: RuleDetail | undefined; /** *The description of the rule.
* @public */ description?: string | undefined; /** *The timestamp at which the rule was created.
* @public */ createdAt: Date | undefined; /** *The timestamp at which the rule was last updated.
* @public */ updatedAt: Date | undefined; /** *The user who created the rule.
* @public */ createdBy: string | undefined; /** *The timestamp at which the rule was last updated.
* @public */ lastUpdatedBy: string | undefined; } /** *The details of the search.
* @public */ export interface SearchInItem { /** *The search attribute.
* @public */ attribute: string | undefined; } /** *The details of the way to sort search results.
* @public */ export interface SearchSort { /** *The attribute detail of the way to sort search results.
* @public */ attribute: string | undefined; /** *The order detail of the wya to sort search results.
* @public */ order?: SortOrder | undefined; } /** *The additional attributes of an Amazon DataZone glossary.
* @public */ export interface GlossaryItemAdditionalAttributes { /** *List of rationales indicating why this item was matched by search.
* @public */ matchRationale?: MatchRationaleItem[] | undefined; } /** *The details of a business glossary.
* @public */ export interface GlossaryItem { /** *The identifier of the Amazon DataZone domain in which the business glossary exists.
* @public */ domainId: string | undefined; /** *The identifier of the glossary.
* @public */ id: string | undefined; /** *The name of the glossary.
* @public */ name: string | undefined; /** *The identifier of the project that owns the business glosary.
* @public */ owningProjectId: string | undefined; /** *The business glossary description.
* @public */ description?: string | undefined; /** *The business glossary status.
* @public */ status: GlossaryStatus | undefined; /** *The usage restrictions associated with a goverened glossary term.
* @public */ usageRestrictions?: GlossaryUsageRestriction[] | undefined; /** *The timestamp of when the glossary was created.
* @public */ createdAt?: Date | undefined; /** *The Amazon DataZone user who created the glossary.
* @public */ createdBy?: string | undefined; /** *The timestamp of when the business glossary was updated.
* @public */ updatedAt?: Date | undefined; /** *The Amazon DataZone user who updated the business glossary.
* @public */ updatedBy?: string | undefined; /** *The additional attributes of an Amazon DataZone glossary.
* @public */ additionalAttributes?: GlossaryItemAdditionalAttributes | undefined; } /** *The additional attributes of an Amazon DataZone glossary term.
* @public */ export interface GlossaryTermItemAdditionalAttributes { /** *List of rationales indicating why this item was matched by search.
* @public */ matchRationale?: MatchRationaleItem[] | undefined; } /** *The details of a business glossary term.
* @public */ export interface GlossaryTermItem { /** *The identifier of the Amazon DataZone domain in which the business glossary exists.
* @public */ domainId: string | undefined; /** *The identifier of the business glossary to which the term belongs.
* @public */ glossaryId: string | undefined; /** *The identifier of the business glossary term.
* @public */ id: string | undefined; /** *The name of the business glossary term.
* @public */ name: string | undefined; /** *The short description of the business glossary term.
* @public */ shortDescription?: string | undefined; /** *The usage restrictions associated with a goverened glossary term.
* @public */ usageRestrictions?: GlossaryUsageRestriction[] | undefined; /** *The long description of the business glossary term.
* @public */ longDescription?: string | undefined; /** *The relations of the business glossary term.
* @public */ termRelations?: TermRelations | undefined; /** *The status of the business glossary term.
* @public */ status: GlossaryTermStatus | undefined; /** *The timestamp of when a business glossary term was created.
* @public */ createdAt?: Date | undefined; /** *The Amazon DataZone user who created the business glossary.
* @public */ createdBy?: string | undefined; /** *The timestamp of when a business glossary term was updated.
* @public */ updatedAt?: Date | undefined; /** *The Amazon DataZone user who updated the business glossary term.
* @public */ updatedBy?: string | undefined; /** *The additional attributes of an Amazon DataZone glossary term.
* @public */ additionalAttributes?: GlossaryTermItemAdditionalAttributes | undefined; } /** *The details of the search results.
* @public */ export type SearchInventoryResultItem = SearchInventoryResultItem.AssetItemMember | SearchInventoryResultItem.DataProductItemMember | SearchInventoryResultItem.GlossaryItemMember | SearchInventoryResultItem.GlossaryTermItemMember | SearchInventoryResultItem.$UnknownMember; /** * @public */ export declare namespace SearchInventoryResultItem { /** *The glossary item included in the search results.
* @public */ interface GlossaryItemMember { glossaryItem: GlossaryItem; glossaryTermItem?: never; assetItem?: never; dataProductItem?: never; $unknown?: never; } /** *The glossary term item included in the search results.
* @public */ interface GlossaryTermItemMember { glossaryItem?: never; glossaryTermItem: GlossaryTermItem; assetItem?: never; dataProductItem?: never; $unknown?: never; } /** *The asset item included in the search results.
* @public */ interface AssetItemMember { glossaryItem?: never; glossaryTermItem?: never; assetItem: AssetItem; dataProductItem?: never; $unknown?: never; } /** *The data product.
* @public */ interface DataProductItemMember { glossaryItem?: never; glossaryTermItem?: never; assetItem?: never; dataProductItem: DataProductResultItem; $unknown?: never; } /** * @public */ interface $UnknownMember { glossaryItem?: never; glossaryTermItem?: never; assetItem?: never; dataProductItem?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe results of the Search action.
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.
Total number of search results.
* @public */ totalMatchCount?: number | undefined; } /** * @public */ export interface SearchGroupProfilesInput { /** *The identifier of the Amazon DataZone domain in which you want to search group profiles.
* @public */ domainIdentifier: string | undefined; /** *The group type for which to search.
* @public */ groupType: GroupSearchType | undefined; /** *Specifies the text for which to search.
* @public */ searchText?: string | undefined; /** *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.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.
The details of a group profile.
* @public */ export interface GroupProfileSummary { /** *The ID of the Amazon DataZone domain of a group profile.
* @public */ domainId?: string | undefined; /** *The ID of a group profile.
* @public */ id?: string | undefined; /** *The status of a group profile.
* @public */ status?: GroupProfileStatus | undefined; /** *The group name of a group profile.
* @public */ groupName?: string | undefined; /** *The ARN of the IAM role principal. This role is associated with the group profile.
* @public */ rolePrincipalArn?: string | undefined; /** *The unique identifier of the IAM role principal. This principal is associated with the group profile.
* @public */ rolePrincipalId?: string | undefined; } /** * @public */ export interface SearchGroupProfilesOutput { /** *The results of the SearchGroupProfiles action.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.
The details of the results of the SearchListings action.
The asset listing included in the results of the SearchListings action.
The data product listing.
* @public */ interface DataProductListingMember { assetListing?: never; dataProductListing: DataProductListingItem; $unknown?: never; } /** * @public */ interface $UnknownMember { assetListing?: never; dataProductListing?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe results of the SearchListings action.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.
Total number of search results.
* @public */ totalMatchCount?: number | undefined; /** *Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.
* @public */ aggregates?: AggregationOutput[] | undefined; } /** *The details of the metadata form type.
* @public */ export interface FormTypeData { /** *The identifier of the Amazon DataZone domain in which the form type exists.
* @public */ domainId: string | undefined; /** *The name of the form type.
* @public */ name: string | undefined; /** *The revision of the form type.
* @public */ revision: string | undefined; /** *The model of the form type.
* @public */ model?: Model | undefined; /** *The status of the form type.
* @public */ status?: FormTypeStatus | undefined; /** *The identifier of the project that owns the form type.
* @public */ owningProjectId?: string | undefined; /** *The identifier of the Amazon DataZone domain in which the form type was originally created.
* @public */ originDomainId?: string | undefined; /** *The identifier of the project in which the form type was originally created.
* @public */ originProjectId?: string | undefined; /** *The timestamp of when the metadata form type was created.
* @public */ createdAt?: Date | undefined; /** *The Amazon DataZone user who created teh metadata form type.
* @public */ createdBy?: string | undefined; /** *The description of the metadata form type.
* @public */ description?: string | undefined; /** *The imports specified in the form type.
* @public */ imports?: Import[] | undefined; } /** *The details of a data lineage node type.
* @public */ export interface LineageNodeTypeItem { /** *The ID of the domain where the data lineage node type lives.
* @public */ domainId: string | undefined; /** *The name of the data lineage node type.
* @public */ name?: string | undefined; /** *The description of the data lineage node type.
* @public */ description?: string | undefined; /** *The timestamp at which the data lineage node type was created.
* @public */ createdAt?: Date | undefined; /** *The user who created the data lineage node type.
* @public */ createdBy?: string | undefined; /** *The timestamp at which the data lineage node type was updated.
* @public */ updatedAt?: Date | undefined; /** *The user who updated the data lineage node type.
* @public */ updatedBy?: string | undefined; /** *The revision of the data lineage node type.
* @public */ revision: string | undefined; /** *The forms output of the data lineage node type.
* @public */ formsOutput: RecordThe details of the results of the SearchTypes action.
The asset type included in the results of the SearchTypes action.
The form type included in the results of the SearchTypes action.
The details of a data lineage node type.
* @public */ interface LineageNodeTypeItemMember { assetTypeItem?: never; formTypeItem?: never; lineageNodeTypeItem: LineageNodeTypeItem; $unknown?: never; } /** * @public */ interface $UnknownMember { assetTypeItem?: never; formTypeItem?: never; lineageNodeTypeItem?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe results of the SearchTypes action.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchTypes to list the next set of results.
Total number of search results.
* @public */ totalMatchCount?: number | undefined; } /** * @public */ export interface SearchUserProfilesInput { /** *The identifier of the Amazon DataZone domain in which you want to search user profiles.
* @public */ domainIdentifier: string | undefined; /** *Specifies the user type for the SearchUserProfiles action.
Specifies the text for which to search.
* @public */ searchText?: string | undefined; /** *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.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.
The details of the user profile.
* @public */ export interface UserProfileSummary { /** *The ID of the Amazon DataZone domain of the user profile.
* @public */ domainId?: string | undefined; /** *The ID of the user profile.
* @public */ id?: string | undefined; /** *The type of the user profile.
* @public */ type?: UserProfileType | undefined; /** *The status of the user profile.
* @public */ status?: UserProfileStatus | undefined; /** *The details of the user profile.
* @public */ details?: UserProfileDetails | undefined; } /** * @public */ export interface SearchUserProfilesOutput { /** *The results of the SearchUserProfiles action.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.
The source location for a notebook import in Amazon SageMaker Unified Studio.
* @public */ export type SourceLocation = SourceLocation.S3Member | SourceLocation.$UnknownMember; /** * @public */ export declare namespace SourceLocation { /** *The Amazon Simple Storage Service URI of the notebook source file.
* @public */ interface S3Member { s3: string; $unknown?: never; } /** * @public */ interface $UnknownMember { s3?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe identifier of the Amazon SageMaker Unified Studio domain in which to import the notebook.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the project that will own the imported notebook.
* @public */ owningProjectIdentifier: string | undefined; /** *The source location of the notebook to import. This specifies the Amazon Simple Storage Service URI of the notebook file.
* @public */ sourceLocation: SourceLocation | undefined; /** *The name of the imported notebook. The name must be between 1 and 256 characters.
* @public */ name: string | undefined; /** *The description of the imported notebook.
* @public */ description?: string | undefined; /** *A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface StartNotebookImportOutput { /** *The identifier of the imported notebook.
* @public */ notebookId?: string | undefined; /** *The status of the notebook import.
* @public */ status?: NotebookStatus | undefined; /** *The identifier of the Amazon SageMaker Unified Studio domain.
* @public */ domainId?: string | undefined; /** *The identifier of the project that owns the imported notebook.
* @public */ owningProjectId?: string | undefined; /** *The name of the imported notebook.
* @public */ name?: string | undefined; /** *The description of the imported notebook.
* @public */ description?: string | undefined; /** *The source location from which the notebook was imported.
* @public */ sourceLocation?: SourceLocation | undefined; /** *The timestamp of when the notebook import was started.
* @public */ createdAt?: Date | undefined; /** *The identifier of the user who started the notebook import.
* @public */ createdBy?: string | undefined; } /** * @public */ export interface TagResourceRequest { /** *The ARN of the resource to be tagged in Amazon DataZone.
* @public */ resourceArn: string | undefined; /** *Specifies the tags for the TagResource action.
The ARN of the resource to be untagged in Amazon DataZone.
* @public */ resourceArn: string | undefined; /** *Specifies the tag keys for the UntagResource action.
The domain ID where the account pool that is to be updated lives.
* @public */ domainIdentifier: string | undefined; /** *The ID of the account pool that is to be updated.
* @public */ identifier: string | undefined; /** *The name of the account pool that is to be updated.
* @public */ name?: string | undefined; /** *The description of the account pool that is to be udpated.
* @public */ description?: string | undefined; /** *The mechanism used to resolve the account selection from the account pool.
* @public */ resolutionStrategy?: ResolutionStrategy | undefined; /** *The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.
* @public */ accountSource?: AccountSource | undefined; } /** * @public */ export interface UpdateAccountPoolOutput { /** *The domain ID where the account pool that is to be updated lives.
* @public */ domainId?: string | undefined; /** *The name of the account pool that is to be updated.
* @public */ name?: string | undefined; /** *The ID of the account pool that is to be updated.
* @public */ id?: string | undefined; /** *The description of the account pool that is to be udpated.
* @public */ description?: string | undefined; /** *The mechanism used to resolve the account selection from the account pool.
* @public */ resolutionStrategy?: ResolutionStrategy | undefined; /** *The source of accounts for the account pool. In the current release, it's either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.
* @public */ accountSource: AccountSource | undefined; /** *The user who created the account pool.
* @public */ createdBy: string | undefined; /** *The timestamp at which the account pool was created.
* @public */ createdAt?: Date | undefined; /** *The timestamp at which the account pool was last updated.
* @public */ lastUpdatedAt?: Date | undefined; /** *The user who last updated the account pool.
* @public */ updatedBy?: string | undefined; /** *The domain ID in which the account pool that is to be updated lives.
* @public */ domainUnitId?: string | undefined; } /** * @public */ export interface UpdateConnectionInput { /** *The configurations of the connection.
* @public */ configurations?: Configuration[] | undefined; /** *The ID of the domain where a connection is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The ID of the connection to be updated.
* @public */ identifier: string | undefined; /** *The description of a connection.
* @public */ description?: string | undefined; /** *The location where a connection is to be updated.
* @public */ awsLocation?: AwsLocation | undefined; /** *The connection props.
* @public */ props?: ConnectionPropertiesPatch | undefined; } /** * @public */ export interface UpdateConnectionOutput { /** *The configurations of the connection.
* @public */ configurations?: Configuration[] | undefined; /** *The ID of the connection.
* @public */ connectionId: string | undefined; /** *The connection description.
* @public */ description?: string | undefined; /** *The ID of the domain where a connection is to be updated.
* @public */ domainId: string | undefined; /** *The ID of the domain unit where a connection is to be updated.
* @public */ domainUnitId: string | undefined; /** *The ID of the environment where a connection is to be updated.
* @public */ environmentId?: string | undefined; /** *The name of the connection.
* @public */ name: string | undefined; /** *The physical endpoints of the connection.
* @public */ physicalEndpoints: PhysicalEndpoint[] | undefined; /** *The project ID of the connection.
* @public */ projectId?: string | undefined; /** *The connection props.
* @public */ props?: ConnectionPropertiesOutput | undefined; /** *The connection type.
* @public */ type: ConnectionType | undefined; /** *The scope of the connection.
* @public */ scope?: ConnectionScope | undefined; } /** * @public */ export interface UpdateEnvironmentInput { /** *The identifier of the domain in which the environment is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the environment that is to be updated.
* @public */ identifier: string | undefined; /** *The name to be updated as part of the UpdateEnvironment action.
The description to be updated as part of the UpdateEnvironment action.
The glossary terms to be updated as part of the UpdateEnvironment action.
The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: latest.
The user parameters of the environment.
* @public */ userParameters?: EnvironmentParameter[] | undefined; /** *The configuration name of the environment.
* @public */ environmentConfigurationName?: string | undefined; } /** * @public */ export interface UpdateEnvironmentOutput { /** *The project identifier of the environment.
* @public */ projectId: string | undefined; /** *The identifier of the environment that is to be updated.
* @public */ id?: string | undefined; /** *The identifier of the domain in which the environment is to be updated.
* @public */ domainId: string | undefined; /** *The Amazon DataZone user who created the environment.
* @public */ createdBy: string | undefined; /** *The timestamp of when the environment was created.
* @public */ createdAt?: Date | undefined; /** *The timestamp of when the environment was updated.
* @public */ updatedAt?: Date | undefined; /** *The name to be updated as part of the UpdateEnvironment action.
The description to be updated as part of the UpdateEnvironment action.
The profile identifier of the environment.
* @public */ environmentProfileId?: string | undefined; /** *The identifier of the Amazon Web Services account in which the environment is to be updated.
* @public */ awsAccountId?: string | undefined; /** *The Amazon Web Services Region in which the environment is updated.
* @public */ awsAccountRegion?: string | undefined; /** *The provider identifier of the environment.
* @public */ provider: string | undefined; /** *The provisioned resources to be updated as part of the UpdateEnvironment action.
The status to be updated as part of the UpdateEnvironment action.
The environment actions to be updated as part of the UpdateEnvironment action.
The glossary terms to be updated as part of the UpdateEnvironment action.
The user parameters to be updated as part of the UpdateEnvironment action.
The last deployment of the environment.
* @public */ lastDeployment?: Deployment | undefined; /** *The provisioning properties to be updated as part of the UpdateEnvironment action.
The deployment properties to be updated as part of the UpdateEnvironment action.
The blueprint identifier of the environment.
* @public */ environmentBlueprintId?: string | undefined; /** *The configuration ID of the environment.
* @public */ environmentConfigurationId?: string | undefined; /** *The configuration name of the environment.
* @public */ environmentConfigurationName?: string | undefined; } /** * @public */ export interface UpdateEnvironmentActionInput { /** *The domain ID of the environment action.
* @public */ domainIdentifier: string | undefined; /** *The environment ID of the environment action.
* @public */ environmentIdentifier: string | undefined; /** *The ID of the environment action.
* @public */ identifier: string | undefined; /** *The parameters of the environment action.
* @public */ parameters?: ActionParameters | undefined; /** *The name of the environment action.
* @public */ name?: string | undefined; /** *The description of the environment action.
* @public */ description?: string | undefined; } /** * @public */ export interface UpdateEnvironmentActionOutput { /** *The domain ID of the environment action.
* @public */ domainId: string | undefined; /** *The environment ID of the environment action.
* @public */ environmentId: string | undefined; /** *The ID of the environment action.
* @public */ id: string | undefined; /** *The name of the environment action.
* @public */ name: string | undefined; /** *The parameters of the environment action.
* @public */ parameters: ActionParameters | undefined; /** *The description of the environment action.
* @public */ description?: string | undefined; } /** * @public */ export interface UpdateEnvironmentBlueprintInput { /** *The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the environment blueprint to be updated.
* @public */ identifier: string | undefined; /** *The description to be updated as part of the UpdateEnvironmentBlueprint action.
The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.
The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.
The identifier of the blueprint to be updated.
* @public */ id: string | undefined; /** *The name to be updated as part of the UpdateEnvironmentBlueprint action.
The description to be updated as part of the UpdateEnvironmentBlueprint action.
The provider of the blueprint to be udpated.
* @public */ provider: string | undefined; /** *The provisioning properties to be updated as part of the UpdateEnvironmentBlueprint action.
The deployment properties to be updated as part of the UpdateEnvironmentBlueprint action.
The user parameters to be updated as part of the UpdateEnvironmentBlueprint action.
The glossary terms to be updated as part of the UpdateEnvironmentBlueprint action.
The timestamp of when the environment blueprint was created.
* @public */ createdAt?: Date | undefined; /** *The timestamp of when the blueprint was updated.
* @public */ updatedAt?: Date | undefined; } /** * @public */ export interface UpdateEnvironmentProfileInput { /** *The identifier of the Amazon DataZone domain in which an environment profile is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the environment profile that is to be updated.
* @public */ identifier: string | undefined; /** *The name to be updated as part of the UpdateEnvironmentProfile action.
The description to be updated as part of the UpdateEnvironmentProfile action.
The user parameters to be updated as part of the UpdateEnvironmentProfile action.
The Amazon Web Services account in which a specified environment profile is to be udpated.
* @public */ awsAccountId?: string | undefined; /** *The Amazon Web Services Region in which a specified environment profile is to be updated.
* @public */ awsAccountRegion?: string | undefined; } /** * @public */ export interface UpdateEnvironmentProfileOutput { /** *The identifier of the environment profile that is to be udpated.
* @public */ id: string | undefined; /** *The identifier of the Amazon DataZone domain in which the environment profile is to be updated.
* @public */ domainId: string | undefined; /** *The Amazon Web Services account in which a specified environment profile is to be udpated.
* @public */ awsAccountId?: string | undefined; /** *The Amazon Web Services Region in which a specified environment profile is to be updated.
* @public */ awsAccountRegion?: string | undefined; /** *The Amazon DataZone user who created the environment profile.
* @public */ createdBy: string | undefined; /** *The timestamp of when the environment profile was created.
* @public */ createdAt?: Date | undefined; /** *The timestamp of when the environment profile was updated.
* @public */ updatedAt?: Date | undefined; /** *The name to be updated as part of the UpdateEnvironmentProfile action.
The description to be updated as part of the UpdateEnvironmentProfile action.
The identifier of the blueprint of the environment profile that is to be updated.
* @public */ environmentBlueprintId: string | undefined; /** *The identifier of the project of the environment profile that is to be updated.
* @public */ projectId?: string | undefined; /** *The user parameters to be updated as part of the UpdateEnvironmentProfile action.
The identifier of the Amazon DataZone domain in which a group profile is updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the group profile that is updated.
* @public */ groupIdentifier: string | undefined; /** *The status of the group profile that is updated.
* @public */ status: GroupProfileStatus | undefined; } /** * @public */ export interface UpdateGroupProfileOutput { /** *The identifier of the Amazon DataZone domain in which a group profile is updated.
* @public */ domainId?: string | undefined; /** *The identifier of the group profile that is updated.
* @public */ id?: string | undefined; /** *The status of the group profile that is updated.
* @public */ status?: GroupProfileStatus | undefined; /** *The name of the group profile that is updated.
* @public */ groupName?: string | undefined; /** *The ARN of the IAM role principal. This role is associated with the updated group profile.
* @public */ rolePrincipalArn?: string | undefined; /** *The unique identifier of the IAM role principal. This principal is associated with the updated group profile.
* @public */ rolePrincipalId?: string | undefined; } /** * @public */ export interface UpdateProjectInput { /** *The ID of the Amazon DataZone domain where a project is being updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the project that is to be updated.
* @public */ identifier: string | undefined; /** *The name to be updated as part of the UpdateProject action.
The description to be updated as part of the UpdateProject action.
The resource tags of the project.
* @public */ resourceTags?: RecordThe glossary terms to be updated as part of the UpdateProject action.
The ID of the domain unit.
* @public */ domainUnitId?: string | undefined; /** *The environment deployment details of the project.
* @public */ environmentDeploymentDetails?: EnvironmentDeploymentDetails | undefined; /** *The user parameters of the project.
* @public */ userParameters?: EnvironmentConfigurationUserParameter[] | undefined; /** *The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.
The identifier of the Amazon DataZone domain in which a project is updated.
* @public */ domainId: string | undefined; /** *The identifier of the project that is to be updated.
* @public */ id: string | undefined; /** *The name of the project that is to be updated.
* @public */ name: string | undefined; /** *The description of the project that is to be updated.
* @public */ description?: string | undefined; /** *The status of the project.
* @public */ projectStatus?: ProjectStatus | undefined; /** *Specifies the error message that is returned if the operation cannot be successfully completed.
* @public */ failureReasons?: ProjectDeletionError[] | undefined; /** *The Amazon DataZone user who created the project.
* @public */ createdBy: string | undefined; /** *The timestamp of when the project was created.
* @public */ createdAt?: Date | undefined; /** *The timestamp of when the project was last updated.
* @public */ lastUpdatedAt?: Date | undefined; /** *The resource tags of the project.
* @public */ resourceTags?: ResourceTag[] | undefined; /** *The glossary terms of the project that are to be updated.
* @public */ glossaryTerms?: string[] | undefined; /** *The ID of the domain unit.
* @public */ domainUnitId?: string | undefined; /** *The ID of the project profile.
* @public */ projectProfileId?: string | undefined; /** *The user parameters of the project.
* @public */ userParameters?: EnvironmentConfigurationUserParameter[] | undefined; /** *The environment deployment details of the project.
* @public */ environmentDeploymentDetails?: EnvironmentDeploymentDetails | undefined; /** *The category of the project.
* @public */ projectCategory?: string | undefined; } /** * @public */ export interface UpdateProjectProfileInput { /** *The ID of the domain where a project profile is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The ID of a project profile that is to be updated.
* @public */ identifier: string | undefined; /** *The name of a project profile.
* @public */ name?: string | undefined; /** *The description of a project profile.
* @public */ description?: string | undefined; /** *The status of a project profile.
* @public */ status?: Status | undefined; /** *The resource tags of the project profile.
* @public */ projectResourceTags?: ResourceTagParameter[] | undefined; /** *Specifies whether custom project resource tags are supported.
* @public */ allowCustomProjectResourceTags?: boolean | undefined; /** *Field viewable through the UI that provides a project user with the allowed resource tag specifications.
* @public */ projectResourceTagsDescription?: string | undefined; /** *The environment configurations of a project profile.
* @public */ environmentConfigurations?: EnvironmentConfiguration[] | undefined; /** *The ID of the domain unit where a project profile is to be updated.
* @public */ domainUnitIdentifier?: string | undefined; } /** * @public */ export interface UpdateProjectProfileOutput { /** *The ID of the domain where project profile is to be updated.
* @public */ domainId: string | undefined; /** *The ID of the project profile.
* @public */ id: string | undefined; /** *The name of the project profile.
* @public */ name: string | undefined; /** *The description of a project profile.
* @public */ description?: string | undefined; /** *The status of the project profile.
* @public */ status?: Status | undefined; /** *The resource tags of the project profile.
* @public */ projectResourceTags?: ResourceTagParameter[] | undefined; /** *Specifies whether custom project resource tags are supported.
* @public */ allowCustomProjectResourceTags?: boolean | undefined; /** *Field viewable through the UI that provides a project user with the allowed resource tag specifications.
* @public */ projectResourceTagsDescription?: string | undefined; /** *The environment configurations of a project profile.
* @public */ environmentConfigurations?: EnvironmentConfiguration[] | undefined; /** *The user who created a project profile.
* @public */ createdBy: string | undefined; /** *The timestamp at which a project profile is created.
* @public */ createdAt?: Date | undefined; /** *The timestamp at which a project profile was last updated.
* @public */ lastUpdatedAt?: Date | undefined; /** *The domain unit ID of the project profile to be updated.
* @public */ domainUnitId?: string | undefined; } /** * @public */ export interface UpdateRootDomainUnitOwnerInput { /** *The ID of the domain where the root domain unit owner is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The current owner of the root domain unit.
* @public */ currentOwner: string | undefined; /** *The new owner of the root domain unit.
* @public */ newOwner: string | undefined; /** *A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface UpdateRootDomainUnitOwnerOutput { } /** * @public */ export interface UpdateSubscriptionGrantStatusInput { /** *The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the subscription grant the status of which is to be updated.
* @public */ identifier: string | undefined; /** *The identifier of the asset the subscription grant status of which is to be updated.
* @public */ assetIdentifier: string | undefined; /** *The status to be updated as part of the UpdateSubscriptionGrantStatus action.
Specifies the error message that is returned if the operation cannot be successfully completed.
* @public */ failureCause?: FailureCause | undefined; /** *The target name to be updated as part of the UpdateSubscriptionGrantStatus action.
The identifier of the subscription grant.
* @public */ id: string | undefined; /** *The Amazon DataZone domain user who created the subscription grant status.
* @public */ createdBy: string | undefined; /** *The Amazon DataZone user who updated the subscription grant status.
* @public */ updatedBy?: string | undefined; /** *The identifier of the Amazon DataZone domain in which a subscription grant status is to be updated.
* @public */ domainId: string | undefined; /** *The timestamp of when the subscription grant status was created.
* @public */ createdAt: Date | undefined; /** *The timestamp of when the subscription grant status is to be updated.
* @public */ updatedAt: Date | undefined; /** *The ID of the environment in which the subscription grant is updated.
* @public */ environmentId?: string | undefined; /** *The identifier of the subscription target whose subscription grant status is to be updated.
* @public */ subscriptionTargetId: string | undefined; /** *The granted entity to be updated as part of the UpdateSubscriptionGrantStatus action.
The status to be updated as part of the UpdateSubscriptionGrantStatus action.
The details of the asset for which the subscription grant is created.
* @public */ assets?: SubscribedAsset[] | undefined; /** *The identifier of the subscription.
* * @deprecated Multiple subscriptions can exist for a single grant. * @public */ subscriptionId?: string | undefined; } /** * @public */ export interface UpdateSubscriptionRequestInput { /** *The identifier of the Amazon DataZone domain in which a subscription request is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the subscription request that is to be updated.
* @public */ identifier: string | undefined; /** *The reason for the UpdateSubscriptionRequest action.
The identifier of the subscription request that is to be updated.
* @public */ id: string | undefined; /** *The Amazon DataZone user who created the subscription request.
* @public */ createdBy: string | undefined; /** *The Amazon DataZone user who updated the subscription request.
* @public */ updatedBy?: string | undefined; /** *The identifier of the Amazon DataZone domain in which a subscription request is to be updated.
* @public */ domainId: string | undefined; /** *The status of the subscription request.
* @public */ status: SubscriptionRequestStatus | undefined; /** *The timestamp of when the subscription request was created.
* @public */ createdAt: Date | undefined; /** *The timestamp of when the subscription request was updated.
* @public */ updatedAt: Date | undefined; /** *The reason for the UpdateSubscriptionRequest action.
The subscribed principals of the subscription request.
* @public */ subscribedPrincipals: SubscribedPrincipal[] | undefined; /** *The subscribed listings of the subscription request.
* @public */ subscribedListings: SubscribedListing[] | undefined; /** *The identifier of the Amazon DataZone user who reviews the subscription request.
* @public */ reviewerId?: string | undefined; /** *The decision comment of the UpdateSubscriptionRequest action.
The ID of the existing subscription.
* @public */ existingSubscriptionId?: string | undefined; /** *Metadata forms included in the subscription request.
* @public */ metadataForms?: FormOutput[] | undefined; } /** * @public */ export interface UpdateSubscriptionTargetInput { /** *The identifier of the Amazon DataZone domain in which a subscription target is to be updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the environment in which a subscription target is to be updated.
* @public */ environmentIdentifier: string | undefined; /** *Identifier of the subscription target that is to be updated.
* @public */ identifier: string | undefined; /** *The name to be updated as part of the UpdateSubscriptionTarget action.
The authorized principals to be updated as part of the UpdateSubscriptionTarget action.
The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
The configuration to be updated as part of the UpdateSubscriptionTarget action.
The manage access role to be updated as part of the UpdateSubscriptionTarget action.
The provider to be updated as part of the UpdateSubscriptionTarget action.
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
* @public */ subscriptionGrantCreationMode?: SubscriptionGrantCreationMode | undefined; } /** * @public */ export interface UpdateSubscriptionTargetOutput { /** *Identifier of the subscription target that is to be updated.
* @public */ id: string | undefined; /** *The authorized principals to be updated as part of the UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a time.
The identifier of the Amazon DataZone domain in which a subscription target is to be updated.
* @public */ domainId: string | undefined; /** *The identifier of the project in which a subscription target is to be updated.
* @public */ projectId: string | undefined; /** *The identifier of the environment in which a subscription target is to be updated.
* @public */ environmentId: string | undefined; /** *The name to be updated as part of the UpdateSubscriptionTarget action.
The type to be updated as part of the UpdateSubscriptionTarget action.
The Amazon DataZone user who created the subscription target.
* @public */ createdBy: string | undefined; /** *The Amazon DataZone user who updated the subscription target.
* @public */ updatedBy?: string | undefined; /** *The timestamp of when a subscription target was created.
* @public */ createdAt: Date | undefined; /** *The timestamp of when the subscription target was updated.
* @public */ updatedAt?: Date | undefined; /** *The manage access role to be updated as part of the UpdateSubscriptionTarget action.
The applicable asset types to be updated as part of the UpdateSubscriptionTarget action.
The configuration to be updated as part of the UpdateSubscriptionTarget action.
The provider to be updated as part of the UpdateSubscriptionTarget action.
Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.
* @public */ subscriptionGrantCreationMode?: SubscriptionGrantCreationMode | undefined; } /** * @public */ export interface UpdateUserProfileInput { /** *The identifier of the Amazon DataZone domain in which a user profile is updated.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the user whose user profile is to be updated.
* @public */ userIdentifier: string | undefined; /** *The type of the user profile that are to be updated.
* @public */ type?: UserProfileType | undefined; /** *The status of the user profile that are to be updated.
* @public */ status: UserProfileStatus | undefined; /** *The session name for IAM role sessions.
* @public */ sessionName?: string | undefined; } /** * @public */ export interface UpdateUserProfileOutput { /** *The identifier of the Amazon DataZone domain in which a user profile is updated.
* @public */ domainId?: string | undefined; /** *The identifier of the user profile.
* @public */ id?: string | undefined; /** *The type of the user profile.
* @public */ type?: UserProfileType | undefined; /** *The status of the user profile.
* @public */ status?: UserProfileStatus | undefined; /** *The results of the UpdateUserProfile action.
* @public */ details?: UserProfileDetails | undefined; } /** *A search filter clause in Amazon DataZone.
* @public */ export type FilterClause = FilterClause.AndMember | FilterClause.FilterMember | FilterClause.OrMember | FilterClause.$UnknownMember; /** * @public */ export declare namespace FilterClause { /** *A search filter in Amazon DataZone.
* @public */ interface FilterMember { filter: Filter; and?: never; or?: never; $unknown?: never; } /** *The 'and' search filter clause in Amazon DataZone.
* @public */ interface AndMember { filter?: never; and: FilterClause[]; or?: never; $unknown?: never; } /** *The 'or' search filter clause in Amazon DataZone.
* @public */ interface OrMember { filter?: never; and?: never; or: FilterClause[]; $unknown?: never; } /** * @public */ interface $UnknownMember { filter?: never; and?: never; or?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe row filter.
* @public */ export type RowFilter = RowFilter.AndMember | RowFilter.ExpressionMember | RowFilter.OrMember | RowFilter.$UnknownMember; /** * @public */ export declare namespace RowFilter { /** *The expression of the row filter.
* @public */ interface ExpressionMember { expression: RowFilterExpression; and?: never; or?: never; $unknown?: never; } /** *The 'and' clause of the row filter.
* @public */ interface AndMember { expression?: never; and: RowFilter[]; or?: never; $unknown?: never; } /** *The 'or' clause of the row filter.
* @public */ interface OrMember { expression?: never; and?: never; or: RowFilter[]; $unknown?: never; } /** * @public */ interface $UnknownMember { expression?: never; and?: never; or?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe pattern describing the entities to be matched during the graph query.
* @public */ export interface EntityPattern { /** *The type of entity to be matched during the graph query.
* @public */ entityType: GraphEntityType | undefined; /** *The identifier of the root entity to start traversal from during the graph query.
* @public */ identifier: string | undefined; /** *A search filter clause in Amazon DataZone.
* @public */ filters?: FilterClause | undefined; } /** *The row filter configuration details.
* @public */ export interface RowFilterConfiguration { /** *The row filter.
* @public */ rowFilter: RowFilter | undefined; /** *Specifies whether the row filter is sensitive.
* @public */ sensitive?: boolean | undefined; } /** * @public */ export interface SearchInput { /** *The identifier of the Amazon DataZone domain.
* @public */ domainIdentifier: string | undefined; /** *The identifier of the owning project specified for the search.
* @public */ owningProjectIdentifier?: string | undefined; /** *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.
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.
The scope of the search.
* @public */ searchScope: InventorySearchScope | undefined; /** *Specifies the text for which to search.
* @public */ searchText?: string | undefined; /** *The details of the search.
* @public */ searchIn?: SearchInItem[] | undefined; /** *Specifies the search filters.
* @public */ filters?: FilterClause | undefined; /** *Specifies the way in which the search results are to be sorted.
* @public */ sort?: SearchSort | undefined; /** *Specifies additional attributes for the Search action.
The identifier of the domain in which to search listings.
* @public */ domainIdentifier: string | undefined; /** *Specifies the text for which to search.
* @public */ searchText?: string | undefined; /** *The details of the search.
* @public */ searchIn?: SearchInItem[] | undefined; /** *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.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.
Specifies the filters for the search of listings.
* @public */ filters?: FilterClause | undefined; /** *Enables you to specify one or more attributes to compute and return counts grouped by field values.
* @public */ aggregations?: AggregationListItem[] | undefined; /** *Specifies the way for sorting the search results.
* @public */ sort?: SearchSort | undefined; /** *Specifies additional attributes for the search.
* @public */ additionalAttributes?: SearchOutputAdditionalAttribute[] | undefined; } /** * @public */ export interface SearchTypesInput { /** *The identifier of the Amazon DataZone domain in which to invoke the SearchTypes action.
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.
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchTypes to list the next set of results.
Specifies the scope of the search for types.
* @public */ searchScope: TypesSearchScope | undefined; /** *Specifies the text for which to search.
* @public */ searchText?: string | undefined; /** *The details of the search.
* @public */ searchIn?: SearchInItem[] | undefined; /** *The filters for the SearchTypes action.
The specifies the way to sort the SearchTypes results.
Specifies whether the search is managed.
* @public */ managed: boolean | undefined; } /** *The configuration details of the asset filter.
* @public */ export type AssetFilterConfiguration = AssetFilterConfiguration.ColumnConfigurationMember | AssetFilterConfiguration.RowConfigurationMember | AssetFilterConfiguration.$UnknownMember; /** * @public */ export declare namespace AssetFilterConfiguration { /** *The column configuration of the asset filter.
* @public */ interface ColumnConfigurationMember { columnConfiguration: ColumnFilterConfiguration; rowConfiguration?: never; $unknown?: never; } /** *The row configuration of the asset filter.
* @public */ interface RowConfigurationMember { columnConfiguration?: never; rowConfiguration: RowFilterConfiguration; $unknown?: never; } /** * @public */ interface $UnknownMember { columnConfiguration?: never; rowConfiguration?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorA clause to match a query pattern
* @public */ export type MatchClause = MatchClause.EntityPatternMember | MatchClause.RelationPatternMember | MatchClause.$UnknownMember; /** * @public */ export declare namespace MatchClause { /** *The pattern describing the query's relational traversal.
* @public */ interface RelationPatternMember { relationPattern: RelationPattern; entityPattern?: never; $unknown?: never; } /** *The pattern describing the entities for the query to traverse.
* @public */ interface EntityPatternMember { relationPattern?: never; entityPattern: EntityPattern; $unknown?: never; } /** * @public */ interface $UnknownMember { relationPattern?: never; entityPattern?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe ID of the domain in which you want to create an asset filter.
* @public */ domainIdentifier: string | undefined; /** *The ID of the data asset.
* @public */ assetIdentifier: string | undefined; /** *The name of the asset filter.
* @public */ name: string | undefined; /** *The description of the asset filter.
* @public */ description?: string | undefined; /** *The configuration of the asset filter.
* @public */ configuration: AssetFilterConfiguration | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
* @public */ clientToken?: string | undefined; } /** * @public */ export interface CreateAssetFilterOutput { /** *The ID of the asset filter.
* @public */ id: string | undefined; /** *The ID of the domain where the asset filter is created.
* @public */ domainId: string | undefined; /** *The ID of the asset.
* @public */ assetId: string | undefined; /** *The name of the asset filter.
* @public */ name: string | undefined; /** *The description of the asset filter.
* @public */ description?: string | undefined; /** *The status of the asset filter.
* @public */ status?: FilterStatus | undefined; /** *The configuration of the asset filter.
* @public */ configuration: AssetFilterConfiguration | undefined; /** *The timestamp at which the asset filter was created.
* @public */ createdAt?: Date | undefined; /** *The error message that is displayed if the asset filter is not created successfully.
* @public */ errorMessage?: string | undefined; /** *The column names in the asset filter.
* @public */ effectiveColumnNames?: string[] | undefined; /** *The row filter in the asset filter.
* @public */ effectiveRowFilter?: string | undefined; } /** * @public */ export interface GetAssetFilterOutput { /** *The ID of the asset filter.
* @public */ id: string | undefined; /** *The ID of the domain where you want to get an asset filter.
* @public */ domainId: string | undefined; /** *The ID of the data asset.
* @public */ assetId: string | undefined; /** *The name of the asset filter.
* @public */ name: string | undefined; /** *The description of the asset filter.
* @public */ description?: string | undefined; /** *The status of the asset filter.
* @public */ status?: FilterStatus | undefined; /** *The configuration of the asset filter.
* @public */ configuration: AssetFilterConfiguration | undefined; /** *The timestamp at which the asset filter was created.
* @public */ createdAt?: Date | undefined; /** *The error message that is displayed if the action does not complete successfully.
* @public */ errorMessage?: string | undefined; /** *The column names of the asset filter.
* @public */ effectiveColumnNames?: string[] | undefined; /** *The row filter of the asset filter.
* @public */ effectiveRowFilter?: string | undefined; } /** * @public */ export interface UpdateAssetFilterInput { /** *The ID of the domain where you want to update an asset filter.
* @public */ domainIdentifier: string | undefined; /** *The ID of the data asset.
* @public */ assetIdentifier: string | undefined; /** *The ID of the asset filter.
* @public */ identifier: string | undefined; /** *The name of the asset filter.
* @public */ name?: string | undefined; /** *The description of the asset filter.
* @public */ description?: string | undefined; /** *The configuration of the asset filter.
* @public */ configuration?: AssetFilterConfiguration | undefined; } /** * @public */ export interface UpdateAssetFilterOutput { /** *The ID of the asset filter.
* @public */ id: string | undefined; /** *The ID of the domain where the asset filter was created.
* @public */ domainId: string | undefined; /** *The ID of the data asset.
* @public */ assetId: string | undefined; /** *The name of the asset filter.
* @public */ name: string | undefined; /** *The description of the asset filter.
* @public */ description?: string | undefined; /** *The status of the asset filter.
* @public */ status?: FilterStatus | undefined; /** *The configuration of the asset filter.
* @public */ configuration: AssetFilterConfiguration | undefined; /** *The timestamp at which the asset filter was created.
* @public */ createdAt?: Date | undefined; /** *The error message that is displayed if the action is not completed successfully.
* @public */ errorMessage?: string | undefined; /** *The column names of the asset filter.
* @public */ effectiveColumnNames?: string[] | undefined; /** *The row filter of the asset filter.
* @public */ effectiveRowFilter?: string | undefined; } /** * @public */ export interface QueryGraphInput { /** *The identifier of the Amazon DataZone domain.
* @public */ domainIdentifier: string | undefined; /** *List of query match clauses.
* @public */ match: MatchClause[] | undefined; /** *The maximum number of entities to return in a single call to QueryGraph. When the number of entities to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to QueryGraph to list the next set of entities.
When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to QueryGraph to list the next set of entities.
Additional details on the queried entity that can be requested in the response.
* @public */ additionalAttributes?: AdditionalAttributes | undefined; }