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 name
The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
String type
The type of parameter.
String defaultValue
Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.
String collaborationId
The unique ID for the associated collaboration.
String type
The type of analysis rule.
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> allowedJoinOperators
Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
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.
String additionalAnalyses
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
The additionalAnalyses parameter is currently supported for the list analysis rule (
AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
List<E> allowedAnalyses
The ARN of the analysis templates that are allowed by the custom analysis rule.
List<E> allowedAnalysisProviders
The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when
allowedAnalyses is ANY_QUERY.
String additionalAnalyses
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
List<E> disallowedOutputColumns
A list of columns that aren't allowed to be shown in the query output.
DifferentialPrivacyConfiguration differentialPrivacy
The differential privacy configuration.
List<E> joinColumns
The columns that query runners are allowed to use in an INNER JOIN statement.
List<E> queryConstraints
The query constraints of the analysis rule ID mapping table.
List<E> dimensionColumns
The columns that query runners are allowed to select, group by, or filter by.
List<E> joinColumns
Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.
List<E> allowedJoinOperators
The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
List<E> listColumns
Columns that can be listed in the output.
String additionalAnalyses
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
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.
AnalysisRuleCustom custom
Analysis rule type that enables custom SQL queries on a configured table.
AnalysisRuleIdMappingTable idMappingTable
The ID mapping table.
String text
The query text.
String id
The identifier for the analysis template.
String arn
The Amazon Resource Name (ARN) of the analysis template.
String collaborationId
The unique ID for the associated collaboration of the analysis template.
String collaborationArn
The unique ARN for the analysis template’s associated collaboration.
String membershipId
The identifier of a member who created the analysis template.
String membershipArn
The Amazon Resource Name (ARN) of the member who created the analysis template.
String description
The description of the analysis template.
String name
The name of the analysis template.
Date createTime
The time that the analysis template was created.
Date updateTime
The time that the analysis template was last updated.
AnalysisSchema schema
The entire schema object.
String format
The format of the analysis template.
AnalysisSource source
The source of the analysis template.
List<E> analysisParameters
The parameters of the analysis template.
List<E> validations
Information about the validations performed on the analysis template.
String arn
The Amazon Resource Name (ARN) of the analysis template.
Date createTime
The time that the analysis template summary was created.
String id
The identifier of the analysis template.
String name
The name of the analysis template.
Date updateTime
The time that the analysis template summary was last updated.
String membershipArn
The Amazon Resource Name (ARN) of the member who created the analysis template.
String membershipId
The identifier for a membership resource.
String collaborationArn
The unique ARN for the analysis template summary’s associated collaboration.
String collaborationId
A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.
String description
The description of the analysis template.
String message
The validation message.
String collaborationIdentifier
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
List<E> analysisTemplateArns
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
List<E> collaborationAnalysisTemplates
The retrieved list of analysis templates within a collaboration.
List<E> errors
Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.
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 Amazon Web Services 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 of the analysis template.
String arn
The Amazon Resource Name (ARN) of the analysis template.
String collaborationId
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
String collaborationArn
The unique ARN for the analysis template’s associated collaboration.
String description
The description of the analysis template.
String creatorAccountId
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
String name
The name of the analysis template.
Date createTime
The time that the analysis template within a collaboration was created.
Date updateTime
The time that the analysis template in the collaboration was last updated.
AnalysisSchema schema
The entire schema object.
String format
The format of the analysis template in the collaboration.
AnalysisSource source
The source of the analysis template within a collaboration.
List<E> analysisParameters
The analysis parameters that have been specified in the analysis template.
List<E> validations
The validations that were performed.
String arn
The Amazon Resource Name (ARN) of the analysis template.
Date createTime
The time that the summary of the analysis template in a collaboration was created.
String id
The identifier of the analysis template.
String name
The name of the analysis template.
Date updateTime
The time that the summary of the analysis template in the collaboration was last updated.
String collaborationArn
The unique ARN for the analysis template’s associated collaboration.
String collaborationId
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
String creatorAccountId
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
String description
The description of the analysis template.
String id
The identifier of the configured audience model association.
String arn
The Amazon Resource Name (ARN) of the configured audience model association.
String collaborationId
A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.
String collaborationArn
The unique ARN for the configured audience model's associated collaboration.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configure audience model.
String name
The name of the configured audience model association.
String description
The description of the configured audience model association.
String creatorAccountId
The identifier used to reference members of the collaboration. Only supports AWS account ID.
Date createTime
The time at which the configured audience model association was created.
Date updateTime
The most recent time at which the configured audience model association was updated.
String arn
The Amazon Resource Name (ARN) of the configured audience model association.
Date createTime
The time at which the configured audience model association was created.
String id
The identifier of the configured audience model association.
String name
The name of the configured audience model association.
Date updateTime
The most recent time at which the configured audience model association was updated.
String collaborationArn
The unique ARN for the configured audience model's associated collaboration.
String collaborationId
A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.
String creatorAccountId
The identifier used to reference members of the collaboration. Only supports AWS account ID.
String description
The description of the configured audience model association.
String arn
The Amazon Resource Name (ARN) of the collaboration ID namespace association.
Date createTime
The time at which the collaboration ID namespace association was created.
String id
The unique identifier of the collaboration ID namespace association.
Date updateTime
The most recent time at which the collaboration ID namespace association was updated.
String collaborationArn
The Amazon Resource Name (ARN) of the collaboration that contains this collaboration ID namespace association.
String collaborationId
The unique identifier of the collaboration that contains this collaboration ID namespace association.
String creatorAccountId
The Amazon Web Services account that created this collaboration ID namespace association.
IdNamespaceAssociationInputReferenceConfig inputReferenceConfig
The input reference configuration that's used to create the collaboration ID namespace association.
String name
The name of the collaboration ID namespace association.
String description
The description of the collaboration ID namepsace association.
IdNamespaceAssociationInputReferencePropertiesSummary inputReferenceProperties
The input reference properties that are used to create the collaboration ID namespace association.
String id
The unique identifier of the collaboration privacy budget.
String privacyBudgetTemplateId
The unique identifier of the collaboration privacy budget template.
String privacyBudgetTemplateArn
The ARN of the collaboration privacy budget template.
String collaborationId
The unique identifier of the collaboration that includes this privacy budget.
String collaborationArn
The ARN of the collaboration that includes this privacy budget.
String creatorAccountId
The unique identifier of the account that created this privacy budget.
String type
The type of privacy budget template.
Date createTime
The time at which the privacy budget was created.
Date updateTime
The most recent time at which the privacy budget was updated.
PrivacyBudget budget
The includes epsilon provided and utility in terms of aggregations.
String id
The unique identifier of the collaboration privacy budget template.
String arn
The ARN of the collaboration privacy budget template.
String collaborationId
The unique identifier of the collaboration that includes this collaboration privacy budget template.
String collaborationArn
The ARN of the collaboration that includes this collaboration privacy budget template.
String creatorAccountId
The unique identifier of the account that created this collaboration privacy budget template.
Date createTime
The time at which the collaboration privacy budget template was created.
Date updateTime
The most recent time at which the collaboration privacy budget template was updated.
String privacyBudgetType
The type of privacy budget template.
String autoRefresh
How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically
get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary
amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid
choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
PrivacyBudgetTemplateParametersOutput parameters
Specifies the epsilon and noise parameters for the privacy budget template.
String id
The unique identifier of the collaboration privacy budget template.
String arn
The ARN of the collaboration privacy budget template.
String collaborationId
The unique identifier of the collaboration that contains this collaboration privacy budget template.
String collaborationArn
The ARN of the collaboration that contains this collaboration privacy budget template.
String creatorAccountId
The unique identifier of the account that created this collaboration privacy budget template.
String privacyBudgetType
The type of the privacy budget template.
Date createTime
The time at which the collaboration privacy budget template was created.
Date updateTime
The most recent time at which the collaboration privacy budget template was updated.
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 Amazon Web Services 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.
DirectAnalysisConfigurationDetails directAnalysisConfigurationDetails
The direct analysis configuration details.
String id
A unique identifier of the configured audience model association.
String arn
The Amazon Resource Name (ARN) of the configured audience model association.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.
String membershipId
A unique identifier for the membership that contains this configured audience model association.
String membershipArn
The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.
String collaborationId
A unique identifier of the collaboration that contains this configured audience model association.
String collaborationArn
The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.
String name
The name of the configured audience model association.
Boolean manageResourcePolicies
When TRUE, indicates that the resource policy for the configured audience model resource being
associated is configured for Clean Rooms to manage permissions related to the given collaboration. When
FALSE, indicates that the configured audience model resource owner will manage permissions related
to the given collaboration.
String description
The description of the configured audience model association.
Date createTime
The time at which the configured audience model association was created.
Date updateTime
The most recent time at which the configured audience model association was updated.
String membershipId
A unique identifier of the membership that contains the configured audience model association.
String membershipArn
The Amazon Resource Name (ARN) of the membership that contains the configured audience model association.
String collaborationArn
The Amazon Resource Name (ARN) of the collaboration that contains the configured audience model association.
String collaborationId
A unique identifier of the collaboration that configured audience model is associated with.
Date createTime
The time at which the configured audience model association was created.
Date updateTime
The most recent time at which the configured audience model association was updated.
String id
A unique identifier of the configured audience model association.
String arn
The Amazon Resource Name (ARN) of the configured audience model association.
String name
The name of the configured audience model association.
String configuredAudienceModelArn
The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.
String description
The description of the configured audience model association.
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 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. 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 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.
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.
AnalysisRuleCustom custom
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.
List<E> analysisRuleTypes
The analysis rule types for 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 membershipIdentifier
The membership identifier for the configured table association analysis rule.
String configuredTableAssociationId
The unique identifier for the configured table association.
String configuredTableAssociationArn
The Amazon Resource Name (ARN) of the configured table association.
ConfiguredTableAssociationAnalysisRulePolicy policy
The policy of the configured table association analysis rule.
String type
The type of the configured table association analysis rule.
Date createTime
The creation time of the configured table association analysis rule.
Date updateTime
The update time of the configured table association analysis rule.
List<E> allowedResultReceivers
The list of collaboration members who are allowed to receive results of queries run with this configured table.
List<E> allowedAdditionalAnalyses
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
The allowedAdditionalAnalyses parameter is currently supported for the list analysis rule (
AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
List<E> allowedResultReceivers
The list of collaboration members who are allowed to receive results of queries run with this configured table.
List<E> allowedAdditionalAnalyses
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
List<E> allowedResultReceivers
The list of collaboration members who are allowed to receive results of queries run with this configured table.
List<E> allowedAdditionalAnalyses
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
ConfiguredTableAssociationAnalysisRulePolicyV1 v1
The policy for the configured table association analysis rule.
ConfiguredTableAssociationAnalysisRuleList list
Analysis rule type that enables only list queries on a configured table.
ConfiguredTableAssociationAnalysisRuleAggregation aggregation
Analysis rule type that enables only aggregation queries on a configured table.
ConfiguredTableAssociationAnalysisRuleCustom custom
Analysis rule type that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
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`.
String description
The description of the analysis template.
String membershipIdentifier
The identifier for a membership resource.
String name
The name of the analysis template.
String format
The format of the analysis template.
AnalysisSource source
The information in the analysis template. Currently supports text, the query text for the analysis
template.
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.
List<E> analysisParameters
The parameters of the analysis template.
AnalysisTemplate analysisTemplate
The analysis template.
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.
PaymentConfiguration creatorPaymentConfiguration
The collaboration creator's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
Collaboration collaboration
The collaboration.
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.
String configuredAudienceModelArn
A unique identifier for the configured audience model that you want to associate.
String configuredAudienceModelAssociationName
The name of the configured audience model association.
Boolean manageResourcePolicies
When TRUE, indicates that the resource policy for the configured audience model resource being
associated is configured for Clean Rooms to manage permissions related to the given collaboration. When
FALSE, indicates that the configured audience model resource owner will manage permissions related
to the given collaboration.
Setting this to TRUE requires you to have permissions to create, update, and delete the resource
policy for the cleanrooms-ml resource when you call the
DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and
specify TRUE, you must have the same permissions when you call the DeleteMember and
DeleteCollaboration APIs.
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.
String description
A description of the configured audience model association.
ConfiguredAudienceModelAssociation configuredAudienceModelAssociation
Information about the configured audience model association.
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.
ConfiguredTableAnalysisRulePolicy analysisRulePolicy
The analysis rule policy that was created for the configured table.
ConfiguredTableAnalysisRule analysisRule
The analysis rule that was created for the configured table.
String membershipIdentifier
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
String configuredTableAssociationIdentifier
The unique ID for the configured table association. Currently accepts the configured table association ID.
String analysisRuleType
The type of analysis rule.
ConfiguredTableAssociationAnalysisRulePolicy analysisRulePolicy
The analysis rule policy that was created for the configured table association.
ConfiguredTableAssociationAnalysisRule analysisRule
The analysis rule for the configured table association. In the console, the
ConfiguredTableAssociationAnalysisRule is referred to as the collaboration 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 configured table association.
String name
The name of the configured table.
String description
A description for the configured table.
TableReference tableReference
A reference to the 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 membershipIdentifier
The unique identifier of the membership that contains the ID mapping table.
String name
A name for the ID mapping table.
String description
A description of the ID mapping table.
IdMappingTableInputReferenceConfig inputReferenceConfig
The input reference configuration needed to create the ID mapping 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.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key. This value is used to encrypt the mapping table data that is stored by Clean Rooms.
IdMappingTable idMappingTable
The ID mapping table that was created.
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 membership.
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.
MembershipProtectedQueryResultConfiguration defaultResultConfiguration
The default protected query result configuration as specified by the member who can receive results.
MembershipPaymentConfiguration paymentConfiguration
The payment responsibilities accepted by the collaboration member.
Not required if the collaboration member has the member ability to run queries.
Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.
Membership membership
The membership that was created.
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.
String autoRefresh
How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to
automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows
arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes.
Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
String privacyBudgetType
Specifies the type of the privacy budget template.
PrivacyBudgetTemplateParametersInput parameters
Specifies your parameters for the privacy budget template.
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.
PrivacyBudgetTemplate privacyBudgetTemplate
A summary of the elements in the privacy budget template.
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 configuredAudienceModelAssociationIdentifier
A unique identifier of the configured audience model association that you want to delete.
String membershipIdentifier
A unique identifier of the membership that contains the audience model association that you want to delete.
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 membershipIdentifier
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
String configuredTableAssociationIdentifier
The identifier for the configured table association that's related to the analysis rule that you want to delete.
String analysisRuleType
The type of the analysis rule that you want to delete.
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 idNamespaceAssociationIdentifier
The unique identifier of the ID namespace association that you want to delete.
String membershipIdentifier
The unique identifier of the membership that contains the ID namespace association that you want to delete.
String membershipIdentifier
The identifier for a membership resource.
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.
String privacyBudgetTemplateIdentifier
A unique identifier for your privacy budget template.
String name
The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
List<E> columns
The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
String type
The different types of aggregation functions that you can perform.
Integer maxCount
The maximum number of aggregation functions that you can perform with the given privacy budget.
Integer remainingCount
The remaining number of aggregation functions that can be run with the available privacy budget.
String aggregationType
The type of aggregation function that was run.
String aggregationExpression
The aggregation expression that was run.
Integer userContributionLimit
The maximum number of rows contributed by a user in a SQL query.
Float minColumnValue
The lower bound of the aggregation expression.
Float maxColumnValue
The upper bound of the aggregation expression.
Integer epsilon
The updated epsilon value that you want to use.
Integer usersNoisePerQuery
The updated value of noise added per query. It is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
AnalysisTemplate analysisTemplate
The analysis template.
String collaborationIdentifier
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
String analysisTemplateArn
The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
CollaborationAnalysisTemplate collaborationAnalysisTemplate
The analysis template within a collaboration.
String collaborationIdentifier
A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
String configuredAudienceModelAssociationIdentifier
A unique identifier for the configured audience model association that you want to retrieve.
CollaborationConfiguredAudienceModelAssociation collaborationConfiguredAudienceModelAssociation
The metadata of the configured audience model association.
CollaborationPrivacyBudgetTemplate collaborationPrivacyBudgetTemplate
Returns the details of the privacy budget template that you requested.
String collaborationIdentifier
The identifier for the collaboration.
Collaboration collaboration
The entire collaboration for this identifier.
String configuredAudienceModelAssociationIdentifier
A unique identifier for the configured audience model association that you want to retrieve.
String membershipIdentifier
A unique identifier for the membership that contains the configured audience model association that you want to retrieve.
ConfiguredAudienceModelAssociation configuredAudienceModelAssociation
Information about the configured audience model association that you requested.
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 membershipIdentifier
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
String configuredTableAssociationIdentifier
The identifier for the configured table association that's related to the analysis rule.
String analysisRuleType
The type of analysis rule that you want to retrieve.
ConfiguredTableAssociationAnalysisRule analysisRule
The analysis rule for the configured table association. In the console, the
ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
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.
IdMappingTable idMappingTable
The ID mapping table that you requested.
String membershipIdentifier
The identifier for a membership resource.
Membership membership
The membership retrieved for the provided identifier.
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
String privacyBudgetTemplateIdentifier
A unique identifier for your privacy budget template.
PrivacyBudgetTemplate privacyBudgetTemplate
Returns the details of the privacy budget template that you requested.
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 id
The unique identifier of the ID mapping table.
String arn
The Amazon Resource Name (ARN) of the ID mapping table.
IdMappingTableInputReferenceConfig inputReferenceConfig
The input reference configuration for the ID mapping table.
String membershipId
The unique identifier of the membership resource for the ID mapping table.
String membershipArn
The Amazon Resource Name (ARN) of the membership resource for the ID mapping table.
String collaborationId
The unique identifier of the collaboration that contains this ID mapping table.
String collaborationArn
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
String description
The description of the ID mapping table.
String name
The name of the ID mapping table.
Date createTime
The time at which the ID mapping table was created.
Date updateTime
The most recent time at which the ID mapping table was updated.
IdMappingTableInputReferenceProperties inputReferenceProperties
The input reference properties for the ID mapping table.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
String inputReferenceArn
The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution. Valid values are ID mapping workflow ARNs.
Boolean manageResourcePolicies
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
String collaborationArn
The Amazon Resource Name (ARN) of the collaboration that contains this ID mapping table.
String collaborationId
The unique identifier of the collaboration that contains this ID mapping table.
String membershipId
The unique identifier of the membership resource for this ID mapping table.
String membershipArn
The Amazon Resource Name (ARN) of the membership resource for this ID mapping table.
Date createTime
The time at which this ID mapping table was created.
Date updateTime
The most recent time at which this ID mapping table was updated.
String id
The unique identifier of this ID mapping table.
String arn
The Amazon Resource Name (ARN) of this ID mapping table.
String description
The description of this ID mapping table.
IdMappingTableInputReferenceConfig inputReferenceConfig
The input reference configuration for the ID mapping table.
String name
The name of this ID mapping table.
String inputReferenceArn
The Amazon Resource Name (ARN) of the Entity Resolution resource that is being associated to the collaboration. Valid resource ARNs are from the ID namespaces that you own.
Boolean manageResourcePolicies
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
String idNamespaceType
The ID namespace type for this ID namespace association.
String membershipId
The unique identifier of the membership resource for this ID namespace association.
String membershipArn
The Amazon Resource Name (ARN) of the membership resource for this ID namespace association.
String collaborationArn
The Amazon Resource Name (ARN) of the collaboration that contains this ID namespace association.
String collaborationId
The unique identifier of the collaboration that contains this ID namespace association.
Date createTime
The time at which this ID namespace association was created.
Date updateTime
The most recent time at which this ID namespace association has been updated.
String id
The unique identifier of this ID namespace association.
String arn
The Amazon Resource Name (ARN) of this ID namespace association.
IdNamespaceAssociationInputReferenceConfig inputReferenceConfig
The input reference configuration details for this ID namespace association.
String name
The name of the ID namespace association.
String description
The description of the ID namespace association.
IdNamespaceAssociationInputReferencePropertiesSummary inputReferenceProperties
The input reference properties for this ID namespace association.
String collaborationIdentifier
A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration 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
A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration 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.
List<E> collaborationConfiguredAudienceModelAssociationSummaries
The metadata of the configured audience model association within a collaboration.
String nextToken
The token value retrieved from a previous call to access the next page of results.
String collaborationIdentifier
The unique identifier of the collaboration that contains the ID namespace associations that you want to retrieve.
String nextToken
The pagination token that's used to fetch the next set 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 collaborationIdentifier
A unique identifier for one of your collaborations.
String privacyBudgetType
Specifies the type of the privacy budget.
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 nextToken
The token value retrieved from a previous call to access the next page of results.
String collaborationIdentifier
A unique identifier for one of your collaborations.
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 nextToken
The token value retrieved from a previous call to access the next page of results.
List<E> collaborationPrivacyBudgetTemplateSummaries
An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.
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 a membership that contains the configured audience model associations that you want to retrieve.
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 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 membershipIdentifier
The unique identifier of the membership that contains the ID mapping tables that you want to view.
String nextToken
The pagination token that's used to fetch the next set 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 membershipIdentifier
The unique identifier of the membership that contains the ID namespace association that you want to view.
String nextToken
The pagination token that's used to fetch the next set 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 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
A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
String privacyBudgetType
The privacy budget type.
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.
List<E> privacyBudgetSummaries
An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.
String nextToken
The token value retrieved from a previous call to access the next page of results.
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a 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. 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 nextToken
The token value retrieved from a previous call to access the next page of results.
List<E> privacyBudgetTemplateSummaries
An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.
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 Amazon Web Services 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.
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 membership.
MembershipProtectedQueryResultConfiguration defaultResultConfiguration
The default protected query result configuration as specified by the member who can receive results.
MembershipPaymentConfiguration paymentConfiguration
The payment responsibilities accepted by the collaboration member.
MembershipQueryComputePaymentConfig queryCompute
The payment responsibilities accepted by the collaboration member for query compute costs.
MembershipProtectedQueryOutputConfiguration outputConfiguration
Configuration for protected query results.
String roleArn
The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
Boolean isResponsible
Indicates whether the collaboration member has accepted to pay for query compute costs (TRUE) or has
not accepted to pay for query compute costs (FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
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 Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services 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.
List<E> memberAbilities
The abilities granted to the collaboration member.
MembershipPaymentConfiguration paymentConfiguration
The payment responsibilities accepted by the collaboration member.
String accountId
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
List<E> memberAbilities
The abilities granted to the collaboration member.
String displayName
The member's display name.
PaymentConfiguration paymentConfiguration
The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
String accountId
The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
String status
The status of the member.
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.
PaymentConfiguration paymentConfiguration
The collaboration member's payment responsibilities set by the collaboration creator.
QueryComputePaymentConfig queryCompute
The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
String idMappingJobId
The unique identifier of the mapping job that will populate the ID mapping table.
DifferentialPrivacyPreviewParametersInput differentialPrivacy
An array that specifies the epsilon and noise parameters.
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.
PreviewPrivacyImpactParametersInput parameters
Specifies the desired epsilon and noise parameters to preview.
PrivacyImpact privacyImpact
An estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters. This does not change the privacy budget.
DifferentialPrivacyPrivacyBudget differentialPrivacy
An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.
String id
The unique identifier of the privacy budget.
String privacyBudgetTemplateId
The unique identifier of the privacy budget template.
String privacyBudgetTemplateArn
The ARN of the privacy budget template.
String membershipId
The identifier for a membership resource.
String membershipArn
The Amazon Resource Name (ARN) of the member who created the privacy budget summary.
String collaborationId
The unique identifier of the collaboration that contains this privacy budget.
String collaborationArn
The ARN of the collaboration that contains this privacy budget.
String type
Specifies the type of the privacy budget.
Date createTime
The time at which the privacy budget was created.
Date updateTime
The most recent time at which the privacy budget was updated.
PrivacyBudget budget
The provided privacy budget.
String id
The unique identifier of the privacy budget template.
String arn
The ARN of the privacy budget template.
String membershipId
The identifier for a membership resource.
String membershipArn
The Amazon Resource Name (ARN) of the member who created the privacy budget template.
String collaborationId
The unique ID of the collaboration that contains this privacy budget template.
String collaborationArn
The ARN of the collaboration that contains this privacy budget template.
Date createTime
The time at which the privacy budget template was created.
Date updateTime
The most recent time at which the privacy budget template was updated.
String privacyBudgetType
Specifies the type of the privacy budget template.
String autoRefresh
How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically
get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary
amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid
choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
PrivacyBudgetTemplateParametersOutput parameters
Specifies the epsilon and noise parameters for the privacy budget template.
DifferentialPrivacyTemplateParametersInput differentialPrivacy
An object that specifies the epsilon and noise parameters.
DifferentialPrivacyTemplateParametersOutput differentialPrivacy
The epsilon and noise parameters.
String id
The unique identifier of the privacy budget template.
String arn
The ARN of the privacy budget template.
String membershipId
The identifier for a membership resource.
String membershipArn
The Amazon Resource Name (ARN) of the member who created the privacy budget template.
String collaborationId
The unique ID of the collaboration that contains this privacy budget template.
String collaborationArn
The ARN of the collaboration that contains this privacy budget template.
String privacyBudgetType
The type of the privacy budget template.
Date createTime
The time at which the privacy budget template was created.
Date updateTime
The most recent time at which the privacy budget template was updated.
DifferentialPrivacyTemplateUpdateParameters differentialPrivacy
An object that specifies the new values for the epsilon and noise parameters.
DifferentialPrivacyPrivacyImpact differentialPrivacy
An object that lists the number and type of aggregation functions you can perform.
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.
DifferentialPrivacyParameters differentialPrivacy
The sensitivity parameters of the differential privacy results of the protected query.
String accountId
The unique identifier for the account.
ProtectedQueryS3Output s3
If present, the output for a protected query with an `S3` output type.
List<E> memberList
The list of member Amazon Web Services account(s) that received the results of the query.
ProtectedQueryS3OutputConfiguration s3
Required configuration for a protected query with an s3 output type.
ProtectedQueryMemberOutputConfiguration member
Required configuration for a protected query with a member 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 accountId
The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
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> receiverConfigurations
The receiver configuration.
Boolean isResponsible
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute
costs (TRUE) or has not configured the collaboration member to pay for query compute costs (
FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration
creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the
member who can query is the default payer. An error is returned if the collaboration creator sets a
FALSE value for the member who can query.
QueryConstraintRequireOverlap requireOverlap
An array of column names that specifies which columns are required in the JOIN statement.
String analysisType
The type of analysis for the protected query. The results of the query can be analyzed directly (
DIRECT_ANALYSIS) or used as input into additional analyses (ADDITIONAL_ANALYSIS), such
as a query that is a seed for a lookalike ML model.
ConfigurationDetails configurationDetails
The configuration details of the receiver configuration.
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. 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 Amazon Web Services 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`.
List<E> schemaStatusDetails
Details about the status of the schema. Currently, only one entry is present.
SchemaTypeProperties schemaTypeProperties
The schema type properties.
String status
The status of the schema, indicating if it is ready to query.
List<E> reasons
The reasons why the schema status is set to its current state.
String analysisRuleType
The analysis rule type for which the schema status has been evaluated.
List<E> configurations
The configuration details of the schema analysis rule for the given type.
String analysisType
The type of analysis that can be performed on the schema.
A schema can have an analysisType of DIRECT_ANALYSIS,
ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
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 Amazon Web Services 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`.
IdMappingTableSchemaTypeProperties idMappingTable
The ID mapping table for the schema type properties.
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 Glue table referred to by this table reference.
AnalysisTemplate analysisTemplate
The analysis template.
Collaboration collaboration
The entire collaboration that has been updated.
String configuredAudienceModelAssociationIdentifier
A unique identifier for the configured audience model association that you want to update.
String membershipIdentifier
A unique identifier of the membership that contains the configured audience model association that you want to update.
String description
A new description for the configured audience model association.
String name
A new name for the configured audience model association.
ConfiguredAudienceModelAssociation configuredAudienceModelAssociation
Details about the configured audience model association that you 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 membershipIdentifier
A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
String configuredTableAssociationIdentifier
The identifier for the configured table association to update.
String analysisRuleType
The analysis rule type that you want to update.
ConfiguredTableAssociationAnalysisRulePolicy analysisRulePolicy
The updated analysis rule policy for the configured table association.
ConfiguredTableAssociationAnalysisRule analysisRule
The updated analysis rule for the configured table association. In the console, the
ConfiguredTableAssociationAnalysisRule is referred to as the collaboration 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.
String idMappingTableIdentifier
The unique identifier of the ID mapping table that you want to update.
String membershipIdentifier
The unique identifier of the membership that contains the ID mapping table that you want to update.
String description
A new description for the ID mapping table.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
IdMappingTable idMappingTable
The updated ID mapping table.
String membershipIdentifier
The unique identifier of the membership.
String queryLogStatus
An indicator as to whether query logging has been enabled or disabled for the membership.
MembershipProtectedQueryResultConfiguration defaultResultConfiguration
The default protected query result configuration as specified by the member who can receive results.
Membership membership
String membershipIdentifier
A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.
String privacyBudgetTemplateIdentifier
A unique identifier for your privacy budget template that you want to update.
String privacyBudgetType
Specifies the type of the privacy budget template.
PrivacyBudgetTemplateUpdateParameters parameters
Specifies the epsilon and noise parameters for the privacy budget template.
PrivacyBudgetTemplate privacyBudgetTemplate
Summary of the privacy budget template.
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 © 2024. All rights reserved.