String reason
A reason code for the exception.
String columnName
Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.
Integer minimum
The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.
String type
The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.
String collaborationId
The unique ID for the associated collaboration.
String type
The type of analysis rule. Valid values are `AGGREGATION` and `LIST`.
String name
The name for the analysis rule.
Date createTime
The time the analysis rule was created.
Date updateTime
The time the analysis rule was last updated.
AnalysisRulePolicy policy
A policy that describes the associated data usage limitations.
List<E> aggregateColumns
The columns that query runners are allowed to use in aggregation queries.
List<E> joinColumns
Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
String joinRequired
Control that requires member who runs query to do a join with their configured table and/or other configured table in query
List<E> dimensionColumns
The columns that query runners are allowed to select, group by, or filter by.
List<E> scalarFunctions
Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
List<E> outputConstraints
Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
AnalysisRulePolicyV1 v1
Controls on the query specifications that can be run on configured table..
AnalysisRuleList list
Analysis rule type that enables only list queries on a configured table.
AnalysisRuleAggregation aggregation
Analysis rule type that enables only aggregation queries on a configured table.
String id
The unique ID for the collaboration.
String arn
The unique ARN for the collaboration.
String name
A human-readable identifier provided by the collaboration owner. Display names are not unique.
String description
A description of the collaboration provided by the collaboration owner.
String creatorAccountId
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
String creatorDisplayName
A display name of the collaboration creator.
Date createTime
The time when the collaboration was created.
Date updateTime
The time the collaboration metadata was last updated.
String memberStatus
The status of a member in a collaboration.
String membershipId
The unique ID for your membership within the collaboration.
String membershipArn
The unique ARN for your membership within the collaboration.
DataEncryptionMetadata dataEncryptionMetadata
The settings for client-side encryption for cryptographic computing.
String queryLogStatus
An indicator as to whether query logging has been enabled or disabled for the collaboration.
String id
The identifier for the collaboration.
String arn
The ARN of the collaboration.
String name
A human-readable identifier provided by the collaboration owner. Display names are not unique.
String creatorAccountId
The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.
String creatorDisplayName
The display name of the collaboration creator.
Date createTime
The time when the collaboration was created.
Date updateTime
The time the collaboration metadata was last updated.
String memberStatus
The status of a member in a collaboration.
String membershipId
The identifier of a member in a collaboration.
String membershipArn
The ARN of a member in a collaboration.
String id
The unique ID for the configured table.
String arn
The unique ARN for the configured table.
String name
A name for the configured table.
String description
A description for the configured table.
TableReference tableReference
The AWS Glue table that this configured table represents.
Date createTime
The time the configured table was created.
Date updateTime
The time the configured table was last updated
List<E> analysisRuleTypes
The types of analysis rules associated with this configured table. Valid values are `AGGREGATION` and `LIST`. Currently, only one analysis rule may be associated with a configured table.
String analysisMethod
The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.
List<E> allowedColumns
The columns within the underlying AWS Glue table that can be utilized within collaborations.
String configuredTableId
The unique ID for the configured table.
String configuredTableArn
The unique ARN for the configured table.
ConfiguredTableAnalysisRulePolicy policy
The policy that controls SQL query rules.
String type
The type of configured table analysis rule. Valid values are `AGGREGATION` and `LIST`.
Date createTime
The time the configured table analysis rule was created.
Date updateTime
The time the configured table analysis rule was last updated.
ConfiguredTableAnalysisRulePolicyV1 v1
Controls on the query specifications that can be run on a configured table.
AnalysisRuleList list
Analysis rule type that enables only list queries on a configured table.
AnalysisRuleAggregation aggregation
Analysis rule type that enables only aggregation queries on a configured table.
String arn
The unique ARN for the configured table association.
String id
The unique ID for the configured table association.
String configuredTableId
The unique ID for the configured table that the association refers to.
String configuredTableArn
The unique ARN for the configured table that the association refers to.
String membershipId
The unique ID for the membership this configured table association belongs to.
String membershipArn
The unique ARN for the membership this configured table association belongs to.
String roleArn
The service will assume this role to access catalog metadata and query the table.
String name
The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.
String description
A description of the configured table association.
Date createTime
The time the configured table association was created.
Date updateTime
The time the configured table association was last updated.
String configuredTableId
The unique configured table ID that this configured table association refers to.
String membershipId
The unique ID for the membership that the configured table association belongs to.
String membershipArn
The unique ARN for the membership that the configured table association belongs to.
String name
The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.
Date createTime
The time the configured table association was created.
Date updateTime
The time the configured table association was last updated.
String id
The unique ID for the configured table association.
String arn
The unique ARN for the configured table association.
String id
The unique ID of the configured table.
String arn
The unique ARN of the configured table.
String name
The name of the configured table.
Date createTime
The time the configured table was created.
Date updateTime
The time the configured table was last updated.
List<E> analysisRuleTypes
The types of analysis rules associated with this configured table.
String analysisMethod
The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
List<E> members
A list of initial members, not including the creator. This list is immutable.
String name
The display name for a collaboration.
String description
A description of the collaboration provided by the collaboration owner.
List<E> creatorMemberAbilities
The abilities granted to the collaboration creator.
String creatorDisplayName
The display name of the collaboration creator.
DataEncryptionMetadata dataEncryptionMetadata
The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
String queryLogStatus
An indicator as to whether query logging has been enabled or disabled for the collaboration.
Map<K,V> tags
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Collaboration collaboration
The entire created collaboration object.
String configuredTableIdentifier
The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
String analysisRuleType
The type of analysis rule. Valid values are AGGREGATION and LIST.
ConfiguredTableAnalysisRulePolicy analysisRulePolicy
The entire created configured table analysis rule object.
ConfiguredTableAnalysisRule analysisRule
The entire created analysis rule.
String name
The name of the configured table association. This name is used to query the underlying configured table.
String description
A description for the configured table association.
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
String configuredTableIdentifier
A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.
String roleArn
The service will assume this role to access catalog metadata and query the table.
Map<K,V> tags
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
ConfiguredTableAssociation configuredTableAssociation
The entire configured table association object.
String name
The name of the configured table.
String description
A description for the configured table.
TableReference tableReference
A reference to the AWS Glue table being configured.
List<E> allowedColumns
The columns of the underlying table that can be used by collaborations or analysis rules.
String analysisMethod
The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
Map<K,V> tags
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
ConfiguredTable configuredTable
The created configured table.
String collaborationIdentifier
The unique ID for the associated collaboration.
String queryLogStatus
An indicator as to whether query logging has been enabled or disabled for the collaboration.
Map<K,V> tags
An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
Membership membership
The membership that was created.
Boolean allowCleartext
Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).
Boolean allowDuplicates
Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).
Boolean allowJoinsOnColumnsWithDifferentNames
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).
Boolean preserveNulls
Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).
String collaborationIdentifier
The identifier for the collaboration.
String configuredTableIdentifier
The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
String analysisRuleType
The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
String configuredTableAssociationIdentifier
The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
String membershipIdentifier
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
String configuredTableIdentifier
The unique ID for the configured table to delete.
String membershipIdentifier
The identifier for a membership resource.
String collaborationIdentifier
The identifier for the collaboration.
Collaboration collaboration
The entire collaboration for this identifier.
String configuredTableIdentifier
The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
String analysisRuleType
The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
ConfiguredTableAnalysisRule analysisRule
The entire analysis rule output.
String configuredTableAssociationIdentifier
The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
String membershipIdentifier
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
ConfiguredTableAssociation configuredTableAssociation
The entire configured table association object.
String configuredTableIdentifier
The unique ID for the configured table to retrieve.
ConfiguredTable configuredTable
The retrieved configured table.
String membershipIdentifier
The identifier for a membership resource.
Membership membership
The membership retrieved for the provided identifier.
ProtectedQuery protectedQuery
The query processing metadata.
String collaborationIdentifier
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
String name
The name of the schema to retrieve the analysis rule for.
String type
The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
AnalysisRule analysisRule
A specification about how data from the configured table can be used.
Schema schema
The entire schema object.
String nextToken
The token value retrieved from a previous call to access the next page of results.
Integer maxResults
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
String memberStatus
The caller's status in a collaboration.
String membershipIdentifier
A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.
String nextToken
The token value retrieved from a previous call to access the next page of results.
Integer maxResults
The maximum size of the results that is returned per call.
String collaborationIdentifier
The identifier of the collaboration in which the members are listed.
String nextToken
The token value retrieved from a previous call to access the next page of results.
Integer maxResults
The maximum size of the results that is returned per call.
String membershipIdentifier
The identifier for the membership in the collaboration.
String status
A filter on the status of the protected query.
String nextToken
The token value retrieved from a previous call to access the next page of results.
Integer maxResults
The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.
String collaborationIdentifier
A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
String schemaType
If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.
String nextToken
The token value retrieved from a previous call to access the next page of results.
Integer maxResults
The maximum size of the results that is returned per call.
String resourceArn
The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
String id
The unique ID of the membership.
String arn
The unique ARN for the membership.
String collaborationArn
The unique ARN for the membership's associated collaboration.
String collaborationId
The unique ID for the membership's collaboration.
String collaborationCreatorAccountId
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.
String collaborationCreatorDisplayName
The display name of the collaboration creator.
String collaborationName
The name of the membership's collaboration.
Date createTime
The time when the membership was created.
Date updateTime
The time the membership metadata was last updated.
String status
The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
List<E> memberAbilities
The abilities granted to the collaboration member.
String queryLogStatus
An indicator as to whether query logging has been enabled or disabled for the collaboration.
String id
The unique ID for the membership's collaboration.
String arn
The unique ARN for the membership.
String collaborationArn
The unique ARN for the membership's associated collaboration.
String collaborationId
The unique ID for the membership's collaboration.
String collaborationCreatorAccountId
The identifier of the AWS principal that created the collaboration. Currently only supports AWS account ID.
String collaborationCreatorDisplayName
The display name of the collaboration creator.
String collaborationName
The name for the membership's collaboration.
Date createTime
The time when the membership was created.
Date updateTime
The time the membership metadata was last updated.
String status
The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
List<E> memberAbilities
The abilities granted to the collaboration member.
String accountId
The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.
String status
The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.
String displayName
The member's display name.
List<E> abilities
The abilities granted to the collaboration member.
Date createTime
The time when the member was created.
Date updateTime
The time the member metadata was last updated.
String membershipId
The unique ID for the member's associated membership, if present.
String membershipArn
The unique ARN for the member's associated membership, if present.
String id
The identifier for a protected query instance.
String membershipId
The identifier for the membership.
String membershipArn
The ARN of the membership.
Date createTime
The time at which the protected query was created.
ProtectedQuerySQLParameters sqlParameters
The protected query SQL parameters.
String status
The status of the query.
ProtectedQueryResultConfiguration resultConfiguration
Contains any details needed to write the query results.
ProtectedQueryStatistics statistics
Statistics about protected query execution.
ProtectedQueryResult result
The result of the protected query.
ProtectedQueryError error
An error thrown by the protected query.
ProtectedQueryS3Output s3
If present, the output for a protected query with an `S3` output type.
ProtectedQueryS3OutputConfiguration s3
Required configuration for a protected query with an `S3` output type.
ProtectedQueryOutput output
The output of the protected query.
ProtectedQueryOutputConfiguration outputConfiguration
Configuration for protected query results.
String location
The S3 location of the result.
String queryString
The query string to be submitted.
Long totalDurationInMillis
The duration of the Protected Query, from creation until query completion.
String id
The unique ID of the protected query.
String membershipId
The unique ID for the membership that initiated the protected query.
String membershipArn
The unique ARN for the membership that initiated the protected query.
Date createTime
The time the protected query was created.
String status
The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.
List<E> columns
The columns for the relation this schema represents.
List<E> partitionKeys
The partition keys for the dataset underlying this schema.
List<E> analysisRuleTypes
The analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.
String analysisMethod
The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
String creatorAccountId
The unique account ID for the AWS account that owns the schema.
String name
A name for the schema. The schema relation is referred to by this name when queried by a protected query.
String collaborationId
The unique ID for the collaboration that the schema belongs to.
String collaborationArn
The unique ARN for the collaboration that the schema belongs to.
String description
A description for the schema.
Date createTime
The time the schema was created.
Date updateTime
The time the schema was last updated.
String type
The type of schema. The only valid value is currently `TABLE`.
String name
The name for the schema object.
String type
The type of schema object. The only valid schema type is currently `TABLE`.
String creatorAccountId
The unique account ID for the AWS account that owns the schema.
Date createTime
The time the schema object was created.
Date updateTime
The time the schema object was last updated.
String collaborationId
The unique ID for the collaboration that the schema belongs to.
String collaborationArn
The unique ARN for the collaboration that the schema belongs to.
List<E> analysisRuleTypes
The types of analysis rules that are associated with this schema object.
String analysisMethod
The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.
String type
The type of the protected query to be started.
String membershipIdentifier
A unique identifier for the membership to run this query against. Currently accepts a membership ID.
ProtectedQuerySQLParameters sqlParameters
The protected SQL query parameters.
ProtectedQueryResultConfiguration resultConfiguration
The details needed to write the query results.
ProtectedQuery protectedQuery
The protected query.
GlueTableReference glue
If present, a reference to the AWS Glue table referred to by this table reference.
Collaboration collaboration
The entire collaboration that has been updated.
String configuredTableIdentifier
The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
String analysisRuleType
The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
ConfiguredTableAnalysisRulePolicy analysisRulePolicy
The new analysis rule policy for the configured table analysis rule.
ConfiguredTableAnalysisRule analysisRule
The entire updated analysis rule.
String configuredTableAssociationIdentifier
The unique identifier for the configured table association to update. Currently accepts the configured table association ID.
String membershipIdentifier
The unique ID for the membership that the configured table association belongs to.
String description
A new description for the configured table association.
String roleArn
The service will assume this role to access catalog metadata and query the table.
ConfiguredTableAssociation configuredTableAssociation
The entire updated configured table association.
ConfiguredTable configuredTable
The updated configured table.
Membership membership
String membershipIdentifier
The identifier for a member of a protected query instance.
String protectedQueryIdentifier
The identifier for a protected query instance.
String targetStatus
The target status of a query. Used to update the execution status of a currently running query.
ProtectedQuery protectedQuery
The protected query output.
Copyright © 2023. All rights reserved.