types

package
v1.33.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 10, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string

	Reason AccessDeniedExceptionReason
	// contains filtered or unexported fields
}

Caller does not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccessDeniedExceptionReason 

type AccessDeniedExceptionReason string
const (
	AccessDeniedExceptionReasonInsufficientPermissions AccessDeniedExceptionReason = "INSUFFICIENT_PERMISSIONS"
)

Enum values for AccessDeniedExceptionReason

func (AccessDeniedExceptionReason) Values 

func (AccessDeniedExceptionReason) Values() []AccessDeniedExceptionReason

Values returns all known values for AccessDeniedExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AdditionalAnalyses added in v1.16.0 

type AdditionalAnalyses string
const (
	AdditionalAnalysesAllowed    AdditionalAnalyses = "ALLOWED"
	AdditionalAnalysesRequired   AdditionalAnalyses = "REQUIRED"
	AdditionalAnalysesNotAllowed AdditionalAnalyses = "NOT_ALLOWED"
)

Enum values for AdditionalAnalyses

func (AdditionalAnalyses) Values added in v1.16.0 

func (AdditionalAnalyses) Values() []AdditionalAnalyses

Values returns all known values for AdditionalAnalyses. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AggregateColumn 

type AggregateColumn struct {

	// Column names in configured table of aggregate columns.
	//
	// This member is required.
	ColumnNames []string

	// Aggregation function that can be applied to aggregate column in query.
	//
	// This member is required.
	Function AggregateFunctionName
	// contains filtered or unexported fields
}

Column in configured table that can be used in aggregate function in query.

type AggregateFunctionName 

type AggregateFunctionName string
const (
	AggregateFunctionNameSum           AggregateFunctionName = "SUM"
	AggregateFunctionNameSumDistinct   AggregateFunctionName = "SUM_DISTINCT"
	AggregateFunctionNameCount         AggregateFunctionName = "COUNT"
	AggregateFunctionNameCountDistinct AggregateFunctionName = "COUNT_DISTINCT"
	AggregateFunctionNameAvg           AggregateFunctionName = "AVG"
)

Enum values for AggregateFunctionName

func (AggregateFunctionName) Values 

func (AggregateFunctionName) Values() []AggregateFunctionName

Values returns all known values for AggregateFunctionName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AggregationConstraint 

type AggregationConstraint struct {

	// 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.
	//
	// This member is required.
	ColumnName *string

	// 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.
	//
	// This member is required.
	Minimum *int32

	// The type of aggregation the constraint allows. The only valid value is
	// currently `COUNT_DISTINCT`.
	//
	// This member is required.
	Type AggregationType
	// contains filtered or unexported fields
}

Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.

type AggregationType 

type AggregationType string
const (
	AggregationTypeCountDistinct AggregationType = "COUNT_DISTINCT"
)

Enum values for AggregationType

func (AggregationType) Values 

func (AggregationType) Values() []AggregationType

Values returns all known values for AggregationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisFormat added in v1.3.0 

type AnalysisFormat string
const (
	AnalysisFormatSql       AnalysisFormat = "SQL"
	AnalysisFormatPyspark10 AnalysisFormat = "PYSPARK_1_0"
)

Enum values for AnalysisFormat

func (AnalysisFormat) Values added in v1.3.0 

func (AnalysisFormat) Values() []AnalysisFormat

Values returns all known values for AnalysisFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisMethod 

type AnalysisMethod string
const (
	AnalysisMethodDirectQuery AnalysisMethod = "DIRECT_QUERY"
	AnalysisMethodDirectJob   AnalysisMethod = "DIRECT_JOB"
	AnalysisMethodMultiple    AnalysisMethod = "MULTIPLE"
)

Enum values for AnalysisMethod

func (AnalysisMethod) Values 

func (AnalysisMethod) Values() []AnalysisMethod

Values returns all known values for AnalysisMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisParameter added in v1.3.0 

type AnalysisParameter struct {

	// The name of the parameter. The name must use only alphanumeric, underscore (_),
	// or hyphen (-) characters but cannot start or end with a hyphen.
	//
	// This member is required.
	Name *string

	// The type of parameter.
	//
	// This member is required.
	Type ParameterType

	// Optional. The default value that is applied in the analysis template. The
	// member who can query can override this value in the query editor.
	DefaultValue *string
	// contains filtered or unexported fields
}

Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.

type AnalysisRule 

type AnalysisRule struct {

	// The unique ID for the associated collaboration.
	//
	// This member is required.
	CollaborationId *string

	// The time the analysis rule was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The name for the analysis rule.
	//
	// This member is required.
	Name *string

	// A policy that describes the associated data usage limitations.
	//
	// This member is required.
	Policy AnalysisRulePolicy

	// The type of analysis rule.
	//
	// This member is required.
	Type AnalysisRuleType

	// The time the analysis rule was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  Controls on the query specifications that can be run on an associated
	// configured table.
	CollaborationPolicy ConfiguredTableAssociationAnalysisRulePolicy

	//  The consolidated policy for the analysis rule.
	ConsolidatedPolicy ConsolidatedPolicy
	// contains filtered or unexported fields
}

A specification about how data from the configured table can be used in a query.

type AnalysisRuleAggregation 

type AnalysisRuleAggregation struct {

	// The columns that query runners are allowed to use in aggregation queries.
	//
	// This member is required.
	AggregateColumns []AggregateColumn

	// The columns that query runners are allowed to select, group by, or filter by.
	//
	// This member is required.
	DimensionColumns []string

	// Columns in configured table that can be used in join statements and/or as
	// aggregate columns. They can never be outputted directly.
	//
	// This member is required.
	JoinColumns []string

	// Columns that must meet a specific threshold value (after an aggregation
	// function is applied to it) for each output row to be returned.
	//
	// This member is required.
	OutputConstraints []AggregationConstraint

	// Set of scalar functions that are allowed to be used on dimension columns and
	// the output of aggregation of metrics.
	//
	// This member is required.
	ScalarFunctions []ScalarFunctions

	//  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 ).
	AdditionalAnalyses AdditionalAnalyses

	// Which logical operators (if any) are to be used in an INNER JOIN match
	// condition. Default is AND .
	AllowedJoinOperators []JoinOperator

	// Control that requires member who runs query to do a join with their configured
	// table and/or other configured table in query.
	JoinRequired JoinRequiredOption
	// contains filtered or unexported fields
}

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

type AnalysisRuleCustom added in v1.3.0 

type AnalysisRuleCustom struct {

	// The ARN of the analysis templates that are allowed by the custom analysis rule.
	//
	// This member is required.
	AllowedAnalyses []string

	//  An indicator as to whether additional analyses (such as Clean Rooms ML) can be
	// applied to the output of the direct query.
	AdditionalAnalyses AdditionalAnalyses

	// The IDs of the Amazon Web Services accounts that are allowed to query by the
	// custom analysis rule. Required when allowedAnalyses is ANY_QUERY .
	AllowedAnalysisProviders []string

	// The differential privacy configuration.
	DifferentialPrivacy *DifferentialPrivacyConfiguration

	//  A list of columns that aren't allowed to be shown in the query output.
	DisallowedOutputColumns []string
	// contains filtered or unexported fields
}

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

type AnalysisRuleIdMappingTable added in v1.15.0 

type AnalysisRuleIdMappingTable struct {

	// The columns that query runners are allowed to use in an INNER JOIN statement.
	//
	// This member is required.
	JoinColumns []string

	// The query constraints of the analysis rule ID mapping table.
	//
	// This member is required.
	QueryConstraints []QueryConstraint

	// The columns that query runners are allowed to select, group by, or filter by.
	DimensionColumns []string
	// contains filtered or unexported fields
}

Defines details for the analysis rule ID mapping table.

type AnalysisRuleList 

type AnalysisRuleList struct {

	// Columns that can be used to join a configured table with the table of the
	// member who can query and other members' configured tables.
	//
	// This member is required.
	JoinColumns []string

	// Columns that can be listed in the output.
	//
	// This member is required.
	ListColumns []string

	//  An indicator as to whether additional analyses (such as Clean Rooms ML) can be
	// applied to the output of the direct query.
	AdditionalAnalyses AdditionalAnalyses

	// The logical operators (if any) that are to be used in an INNER JOIN match
	// condition. Default is AND .
	AllowedJoinOperators []JoinOperator
	// contains filtered or unexported fields
}

A type of analysis rule that enables row-level analysis.

type AnalysisRulePolicy 

type AnalysisRulePolicy interface {
	// contains filtered or unexported methods
}

Controls on the query specifications that can be run on configured table.

The following types satisfy this interface: 

AnalysisRulePolicyMemberV1
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.AnalysisRulePolicy
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AnalysisRulePolicyMemberV1:
		_ = v.Value // Value is types.AnalysisRulePolicyV1

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type AnalysisRulePolicyMemberV1 

type AnalysisRulePolicyMemberV1 struct {
	Value AnalysisRulePolicyV1
	// contains filtered or unexported fields
}

Controls on the query specifications that can be run on configured table.

type AnalysisRulePolicyV1 

type AnalysisRulePolicyV1 interface {
	// contains filtered or unexported methods
}

Controls on the query specifications that can be run on configured table.

The following types satisfy this interface: 

AnalysisRulePolicyV1MemberAggregation
AnalysisRulePolicyV1MemberCustom
AnalysisRulePolicyV1MemberIdMappingTable
AnalysisRulePolicyV1MemberList
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.AnalysisRulePolicyV1
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AnalysisRulePolicyV1MemberAggregation:
		_ = v.Value // Value is types.AnalysisRuleAggregation

	case *types.AnalysisRulePolicyV1MemberCustom:
		_ = v.Value // Value is types.AnalysisRuleCustom

	case *types.AnalysisRulePolicyV1MemberIdMappingTable:
		_ = v.Value // Value is types.AnalysisRuleIdMappingTable

	case *types.AnalysisRulePolicyV1MemberList:
		_ = v.Value // Value is types.AnalysisRuleList

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type AnalysisRulePolicyV1MemberAggregation 

type AnalysisRulePolicyV1MemberAggregation struct {
	Value AnalysisRuleAggregation
	// contains filtered or unexported fields
}

Analysis rule type that enables only aggregation queries on a configured table.

type AnalysisRulePolicyV1MemberCustom added in v1.3.0 

type AnalysisRulePolicyV1MemberCustom struct {
	Value AnalysisRuleCustom
	// contains filtered or unexported fields
}

Analysis rule type that enables custom SQL queries on a configured table.

type AnalysisRulePolicyV1MemberIdMappingTable added in v1.15.0 

type AnalysisRulePolicyV1MemberIdMappingTable struct {
	Value AnalysisRuleIdMappingTable
	// contains filtered or unexported fields
}

The ID mapping table.

type AnalysisRulePolicyV1MemberList 

type AnalysisRulePolicyV1MemberList struct {
	Value AnalysisRuleList
	// contains filtered or unexported fields
}

Analysis rule type that enables only list queries on a configured table.

type AnalysisRuleType 

type AnalysisRuleType string
const (
	AnalysisRuleTypeAggregation    AnalysisRuleType = "AGGREGATION"
	AnalysisRuleTypeList           AnalysisRuleType = "LIST"
	AnalysisRuleTypeCustom         AnalysisRuleType = "CUSTOM"
	AnalysisRuleTypeIdMappingTable AnalysisRuleType = "ID_MAPPING_TABLE"
)

Enum values for AnalysisRuleType

func (AnalysisRuleType) Values 

func (AnalysisRuleType) Values() []AnalysisRuleType

Values returns all known values for AnalysisRuleType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisSchema added in v1.3.0 

type AnalysisSchema struct {

	// The tables referenced in the analysis schema.
	ReferencedTables []string
	// contains filtered or unexported fields
}

A relation within an analysis.

type AnalysisSource added in v1.3.0 

type AnalysisSource interface {
	// contains filtered or unexported methods
}

The structure that defines the body of the analysis template.

The following types satisfy this interface: 

AnalysisSourceMemberArtifacts
AnalysisSourceMemberText
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.AnalysisSource
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AnalysisSourceMemberArtifacts:
		_ = v.Value // Value is types.AnalysisTemplateArtifacts

	case *types.AnalysisSourceMemberText:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type AnalysisSourceMemberArtifacts added in v1.23.0 

type AnalysisSourceMemberArtifacts struct {
	Value AnalysisTemplateArtifacts
	// contains filtered or unexported fields
}

The artifacts of the analysis source.

type AnalysisSourceMemberText added in v1.3.0 

type AnalysisSourceMemberText struct {
	Value string
	// contains filtered or unexported fields
}

The query text.

type AnalysisSourceMetadata added in v1.23.0 

type AnalysisSourceMetadata interface {
	// contains filtered or unexported methods
}

The analysis source metadata.

The following types satisfy this interface: 

AnalysisSourceMetadataMemberArtifacts
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.AnalysisSourceMetadata
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.AnalysisSourceMetadataMemberArtifacts:
		_ = v.Value // Value is types.AnalysisTemplateArtifactMetadata

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type AnalysisSourceMetadataMemberArtifacts added in v1.23.0 

type AnalysisSourceMetadataMemberArtifacts struct {
	Value AnalysisTemplateArtifactMetadata
	// contains filtered or unexported fields
}

The artifacts of the analysis source metadata.

type AnalysisTemplate added in v1.3.0 

type AnalysisTemplate struct {

	// The Amazon Resource Name (ARN) of the analysis template.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the analysis template’s associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// The unique ID for the associated collaboration of the analysis template.
	//
	// This member is required.
	CollaborationId *string

	// The time that the analysis template was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The format of the analysis template.
	//
	// This member is required.
	Format AnalysisFormat

	// The identifier for the analysis template.
	//
	// This member is required.
	Id *string

	// The Amazon Resource Name (ARN) of the member who created the analysis template.
	//
	// This member is required.
	MembershipArn *string

	// The identifier of a member who created the analysis template.
	//
	// This member is required.
	MembershipId *string

	// The name of the analysis template.
	//
	// This member is required.
	Name *string

	// The entire schema object.
	//
	// This member is required.
	Schema *AnalysisSchema

	// The source of the analysis template.
	//
	// This member is required.
	Source AnalysisSource

	// The time that the analysis template was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The parameters of the analysis template.
	AnalysisParameters []AnalysisParameter

	// The description of the analysis template.
	Description *string

	// The configuration that specifies the level of detail in error messages returned
	// by analyses using this template. When set to DETAILED , error messages include
	// more information to help troubleshoot issues with PySpark jobs. Detailed error
	// messages may expose underlying data, including sensitive information.
	// Recommended for faster troubleshooting in development and testing environments.
	ErrorMessageConfiguration *ErrorMessageConfiguration

	//  The source metadata for the analysis template.
	SourceMetadata AnalysisSourceMetadata

	// Information about the validations performed on the analysis template.
	Validations []AnalysisTemplateValidationStatusDetail
	// contains filtered or unexported fields
}

The analysis template.

type AnalysisTemplateArtifact added in v1.23.0 

type AnalysisTemplateArtifact struct {

	//  The artifact location.
	//
	// This member is required.
	Location *S3Location
	// contains filtered or unexported fields
}

The analysis template artifact.

type AnalysisTemplateArtifactMetadata added in v1.23.0 

type AnalysisTemplateArtifactMetadata struct {

	//  The hash of the entry point for the analysis template artifact metadata.
	//
	// This member is required.
	EntryPointHash *Hash

	//  Additional artifact hashes for the analysis template.
	AdditionalArtifactHashes []Hash
	// contains filtered or unexported fields
}

The analysis template artifact metadata.

type AnalysisTemplateArtifacts added in v1.23.0 

type AnalysisTemplateArtifacts struct {

	//  The entry point for the analysis template artifacts.
	//
	// This member is required.
	EntryPoint *AnalysisTemplateArtifact

	//  The role ARN for the analysis template artifacts.
	//
	// This member is required.
	RoleArn *string

	//  Additional artifacts for the analysis template.
	AdditionalArtifacts []AnalysisTemplateArtifact
	// contains filtered or unexported fields
}

The analysis template artifacts.

type AnalysisTemplateSummary added in v1.3.0 

type AnalysisTemplateSummary struct {

	// The Amazon Resource Name (ARN) of the analysis template.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the analysis template summary’s associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// A unique identifier for the collaboration that the analysis template summary
	// belongs to. Currently accepts collaboration ID.
	//
	// This member is required.
	CollaborationId *string

	// The time that the analysis template summary was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier of the analysis template.
	//
	// This member is required.
	Id *string

	// The Amazon Resource Name (ARN) of the member who created the analysis template.
	//
	// This member is required.
	MembershipArn *string

	// The identifier for a membership resource.
	//
	// This member is required.
	MembershipId *string

	// The name of the analysis template.
	//
	// This member is required.
	Name *string

	// The time that the analysis template summary was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the analysis template.
	Description *string
	// contains filtered or unexported fields
}

The metadata of the analysis template.

type AnalysisTemplateValidationStatus added in v1.12.0 

type AnalysisTemplateValidationStatus string
const (
	AnalysisTemplateValidationStatusValid            AnalysisTemplateValidationStatus = "VALID"
	AnalysisTemplateValidationStatusInvalid          AnalysisTemplateValidationStatus = "INVALID"
	AnalysisTemplateValidationStatusUnableToValidate AnalysisTemplateValidationStatus = "UNABLE_TO_VALIDATE"
)

Enum values for AnalysisTemplateValidationStatus

func (AnalysisTemplateValidationStatus) Values added in v1.12.0 

func (AnalysisTemplateValidationStatus) Values() []AnalysisTemplateValidationStatus

Values returns all known values for AnalysisTemplateValidationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisTemplateValidationStatusDetail added in v1.12.0 

type AnalysisTemplateValidationStatusDetail struct {

	// The status of the validation.
	//
	// This member is required.
	Status AnalysisTemplateValidationStatus

	// The type of validation that was performed.
	//
	// This member is required.
	Type AnalysisTemplateValidationType

	// The reasons for the validation results.
	Reasons []AnalysisTemplateValidationStatusReason
	// contains filtered or unexported fields
}

The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.

For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.

type AnalysisTemplateValidationStatusReason added in v1.12.0 

type AnalysisTemplateValidationStatusReason struct {

	// The validation message.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

The reasons for the validation results.

type AnalysisTemplateValidationType added in v1.12.0 

type AnalysisTemplateValidationType string
const (
	AnalysisTemplateValidationTypeDifferentialPrivacy AnalysisTemplateValidationType = "DIFFERENTIAL_PRIVACY"
)

Enum values for AnalysisTemplateValidationType

func (AnalysisTemplateValidationType) Values added in v1.12.0 

func (AnalysisTemplateValidationType) Values() []AnalysisTemplateValidationType

Values returns all known values for AnalysisTemplateValidationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnalysisType added in v1.16.0 

type AnalysisType string
const (
	AnalysisTypeDirectAnalysis     AnalysisType = "DIRECT_ANALYSIS"
	AnalysisTypeAdditionalAnalysis AnalysisType = "ADDITIONAL_ANALYSIS"
)

Enum values for AnalysisType

func (AnalysisType) Values added in v1.16.0 

func (AnalysisType) Values() []AnalysisType

Values returns all known values for AnalysisType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsEngine added in v1.19.0 

type AnalyticsEngine string
const (
	AnalyticsEngineSpark         AnalyticsEngine = "SPARK"
	AnalyticsEngineCleanRoomsSql AnalyticsEngine = "CLEAN_ROOMS_SQL"
)

Enum values for AnalyticsEngine

func (AnalyticsEngine) Values added in v1.19.0 

func (AnalyticsEngine) Values() []AnalyticsEngine

Values returns all known values for AnalyticsEngine. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AthenaTableReference added in v1.21.0 

type AthenaTableReference struct {

	//  The database name.
	//
	// This member is required.
	DatabaseName *string

	//  The table reference.
	//
	// This member is required.
	TableName *string

	//  The workgroup of the Athena table reference.
	//
	// This member is required.
	WorkGroup *string

	//  The output location for the Athena table.
	OutputLocation *string
	// contains filtered or unexported fields
}

A reference to a table within Athena.

type AutoApprovedChangeType added in v1.33.1 

type AutoApprovedChangeType string
const (
	AutoApprovedChangeTypeAddMember AutoApprovedChangeType = "ADD_MEMBER"
)

Enum values for AutoApprovedChangeType

func (AutoApprovedChangeType) Values added in v1.33.1 

func (AutoApprovedChangeType) Values() []AutoApprovedChangeType

Values returns all known values for AutoApprovedChangeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BatchGetCollaborationAnalysisTemplateError added in v1.3.0 

type BatchGetCollaborationAnalysisTemplateError struct {

	// The Amazon Resource Name (ARN) of the analysis template.
	//
	// This member is required.
	Arn *string

	// An error code for the error.
	//
	// This member is required.
	Code *string

	// A description of why the call failed.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

type BatchGetSchemaAnalysisRuleError added in v1.11.0 

type BatchGetSchemaAnalysisRuleError struct {

	// An error code for the error.
	//
	// This member is required.
	Code *string

	// A description of why the call failed.
	//
	// This member is required.
	Message *string

	// An error name for the error.
	//
	// This member is required.
	Name *string

	// The analysis rule type.
	//
	// This member is required.
	Type AnalysisRuleType
	// contains filtered or unexported fields
}

An error that describes why a schema could not be fetched.

type BatchGetSchemaError 

type BatchGetSchemaError struct {

	// An error code for the error.
	//
	// This member is required.
	Code *string

	// An error message for the error.
	//
	// This member is required.
	Message *string

	// An error name for the error.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

An error describing why a schema could not be fetched.

type BilledJobResourceUtilization added in v1.23.0 

type BilledJobResourceUtilization struct {

	//  The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
	//
	// This member is required.
	Units *float64
	// contains filtered or unexported fields
}
Information related to the utilization of resources that have been billed or

charged for in a given context, such as a protected job.

type BilledResourceUtilization added in v1.19.0 

type BilledResourceUtilization struct {

	//  The number of Clean Rooms Processing Unit (CRPU) hours that have been billed.
	//
	// This member is required.
	Units *float64
	// contains filtered or unexported fields
}
Information related to the utilization of resources that have been billed or

charged for in a given context, such as a protected query.

type Change added in v1.33.1 

type Change struct {

	// The specification details for this change.
	//
	// This member is required.
	Specification ChangeSpecification

	// The type of specification for this change.
	//
	// This member is required.
	SpecificationType ChangeSpecificationType

	// The list of change types that were applied.
	//
	// This member is required.
	Types []ChangeType
	// contains filtered or unexported fields
}

Represents a single change within a collaboration change request, containing the change identifier and specification.

type ChangeInput added in v1.33.1 

type ChangeInput struct {

	// The specification details for the change. The structure depends on the
	// specification type.
	//
	// This member is required.
	Specification ChangeSpecification

	// The type of specification for the change. Currently supports MEMBER for
	// member-related changes.
	//
	// This member is required.
	SpecificationType ChangeSpecificationType
	// contains filtered or unexported fields
}

Specifies a change to apply to a collaboration.

type ChangeRequestStatus added in v1.33.1 

type ChangeRequestStatus string
const (
	ChangeRequestStatusPending   ChangeRequestStatus = "PENDING"
	ChangeRequestStatusApproved  ChangeRequestStatus = "APPROVED"
	ChangeRequestStatusCancelled ChangeRequestStatus = "CANCELLED"
	ChangeRequestStatusDenied    ChangeRequestStatus = "DENIED"
	ChangeRequestStatusCommitted ChangeRequestStatus = "COMMITTED"
)

Enum values for ChangeRequestStatus

func (ChangeRequestStatus) Values added in v1.33.1 

func (ChangeRequestStatus) Values() []ChangeRequestStatus

Values returns all known values for ChangeRequestStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeSpecification added in v1.33.1 

type ChangeSpecification interface {
	// contains filtered or unexported methods
}

A union that contains the specification details for different types of changes.

The following types satisfy this interface: 

ChangeSpecificationMemberMember
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ChangeSpecification
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ChangeSpecificationMemberMember:
		_ = v.Value // Value is types.MemberChangeSpecification

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ChangeSpecificationMemberMember added in v1.33.1 

type ChangeSpecificationMemberMember struct {
	Value MemberChangeSpecification
	// contains filtered or unexported fields
}

The member change specification when the change type is MEMBER .

type ChangeSpecificationType added in v1.33.1 

type ChangeSpecificationType string
const (
	ChangeSpecificationTypeMember ChangeSpecificationType = "MEMBER"
)

Enum values for ChangeSpecificationType

func (ChangeSpecificationType) Values added in v1.33.1 

func (ChangeSpecificationType) Values() []ChangeSpecificationType

Values returns all known values for ChangeSpecificationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChangeType added in v1.33.1 

type ChangeType string
const (
	ChangeTypeAddMember ChangeType = "ADD_MEMBER"
)

Enum values for ChangeType

func (ChangeType) Values added in v1.33.1 

func (ChangeType) Values() []ChangeType

Values returns all known values for ChangeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Collaboration 

type Collaboration struct {

	// The unique ARN for the collaboration.
	//
	// This member is required.
	Arn *string

	// The time when the collaboration was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier used to reference members of the collaboration. Currently only
	// supports Amazon Web Services account ID.
	//
	// This member is required.
	CreatorAccountId *string

	// A display name of the collaboration creator.
	//
	// This member is required.
	CreatorDisplayName *string

	// The unique ID for the collaboration.
	//
	// This member is required.
	Id *string

	// The status of a member in a collaboration.
	//
	// This member is required.
	MemberStatus MemberStatus

	// A human-readable identifier provided by the collaboration owner. Display names
	// are not unique.
	//
	// This member is required.
	Name *string

	// An indicator as to whether query logging has been enabled or disabled for the
	// collaboration.
	//
	// When ENABLED , Clean Rooms logs details about queries run within this
	// collaboration and those logs can be viewed in Amazon CloudWatch Logs. The
	// default value is DISABLED .
	//
	// This member is required.
	QueryLogStatus CollaborationQueryLogStatus

	// The time the collaboration metadata was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The analytics engine for the collaboration.
	//
	// After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
	AnalyticsEngine AnalyticsEngine

	// The types of change requests that are automatically approved for this
	// collaboration.
	AutoApprovedChangeTypes []AutoApprovedChangeType

	// The settings for client-side encryption for cryptographic computing.
	DataEncryptionMetadata *DataEncryptionMetadata

	// A description of the collaboration provided by the collaboration owner.
	Description *string

	// An indicator as to whether job logging has been enabled or disabled for the
	// collaboration.
	//
	// When ENABLED , Clean Rooms logs details about jobs run within this collaboration
	// and those logs can be viewed in Amazon CloudWatch Logs. The default value is
	// DISABLED .
	JobLogStatus CollaborationJobLogStatus

	// The unique ARN for your membership within the collaboration.
	MembershipArn *string

	// The unique ID for your membership within the collaboration.
	MembershipId *string
	// contains filtered or unexported fields
}

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

type CollaborationAnalysisTemplate added in v1.3.0 

type CollaborationAnalysisTemplate struct {

	// The Amazon Resource Name (ARN) of the analysis template.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the analysis template’s associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// A unique identifier for the collaboration that the analysis templates belong
	// to. Currently accepts collaboration ID.
	//
	// This member is required.
	CollaborationId *string

	// The time that the analysis template within a collaboration was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier used to reference members of the collaboration. Currently only
	// supports Amazon Web Services account ID.
	//
	// This member is required.
	CreatorAccountId *string

	// The format of the analysis template in the collaboration.
	//
	// This member is required.
	Format AnalysisFormat

	// The identifier of the analysis template.
	//
	// This member is required.
	Id *string

	// The name of the analysis template.
	//
	// This member is required.
	Name *string

	// The entire schema object.
	//
	// This member is required.
	Schema *AnalysisSchema

	// The time that the analysis template in the collaboration was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The analysis parameters that have been specified in the analysis template.
	AnalysisParameters []AnalysisParameter

	// The description of the analysis template.
	Description *string

	// The configuration that specifies the level of detail in error messages returned
	// by analyses using this template. When set to DETAILED , error messages include
	// more information to help troubleshoot issues with PySpark jobs. Detailed error
	// messages may expose underlying data, including sensitive information.
	// Recommended for faster troubleshooting in development and testing environments.
	ErrorMessageConfiguration *ErrorMessageConfiguration

	// The source of the analysis template within a collaboration.
	Source AnalysisSource

	//  The source metadata for the collaboration analysis template.
	SourceMetadata AnalysisSourceMetadata

	// The validations that were performed.
	Validations []AnalysisTemplateValidationStatusDetail
	// contains filtered or unexported fields
}

The analysis template within a collaboration.

type CollaborationAnalysisTemplateSummary added in v1.3.0 

type CollaborationAnalysisTemplateSummary struct {

	// The Amazon Resource Name (ARN) of the analysis template.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the analysis template’s associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// A unique identifier for the collaboration that the analysis templates belong
	// to. Currently accepts collaboration ID.
	//
	// This member is required.
	CollaborationId *string

	// The time that the summary of the analysis template in a collaboration was
	// created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier used to reference members of the collaboration. Currently only
	// supports Amazon Web Services account ID.
	//
	// This member is required.
	CreatorAccountId *string

	// The identifier of the analysis template.
	//
	// This member is required.
	Id *string

	// The name of the analysis template.
	//
	// This member is required.
	Name *string

	// The time that the summary of the analysis template in the collaboration was
	// last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the analysis template.
	Description *string
	// contains filtered or unexported fields
}

The metadata of the analysis template within a collaboration.

type CollaborationChangeRequest added in v1.33.1 

type CollaborationChangeRequest struct {

	// The list of changes specified in this change request.
	//
	// This member is required.
	Changes []Change

	// The unique identifier for the collaboration being modified.
	//
	// This member is required.
	CollaborationId *string

	// The time when the change request was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier for the change request.
	//
	// This member is required.
	Id *string

	// Whether the change request was automatically approved based on the
	// collaboration's auto-approval settings.
	//
	// This member is required.
	IsAutoApproved *bool

	// The current status of the change request. Valid values are PENDING , APPROVED ,
	// DENIED , COMMITTED , and CANCELLED .
	//
	// This member is required.
	Status ChangeRequestStatus

	// The time when the change request was last updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.

type CollaborationChangeRequestSummary added in v1.33.1 

type CollaborationChangeRequestSummary struct {

	// Summary of the changes in this change request.
	//
	// This member is required.
	Changes []Change

	// The unique identifier for the collaboration.
	//
	// This member is required.
	CollaborationId *string

	// The time when the change request was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier for the change request.
	//
	// This member is required.
	Id *string

	// Whether the change request was automatically approved.
	//
	// This member is required.
	IsAutoApproved *bool

	// The current status of the change request.
	//
	// This member is required.
	Status ChangeRequestStatus

	// The time when the change request was last updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

Summary information about a collaboration change request.

type CollaborationConfiguredAudienceModelAssociation added in v1.8.0 

type CollaborationConfiguredAudienceModelAssociation struct {

	// The Amazon Resource Name (ARN) of the configured audience model association.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the configured audience model's associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// A unique identifier for the collaboration that the configured audience model
	// associations belong to. Accepts collaboration ID.
	//
	// This member is required.
	CollaborationId *string

	// The Amazon Resource Name (ARN) of the configure audience model.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string

	// The time at which the configured audience model association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier used to reference members of the collaboration. Only supports
	// Amazon Web Services account ID.
	//
	// This member is required.
	CreatorAccountId *string

	// The identifier of the configured audience model association.
	//
	// This member is required.
	Id *string

	// The name of the configured audience model association.
	//
	// This member is required.
	Name *string

	// The most recent time at which the configured audience model association was
	// updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the configured audience model association.
	Description *string
	// contains filtered or unexported fields
}

The configured audience model association within a collaboration.

type CollaborationConfiguredAudienceModelAssociationSummary added in v1.8.0 

type CollaborationConfiguredAudienceModelAssociationSummary struct {

	// The Amazon Resource Name (ARN) of the configured audience model association.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the configured audience model's associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// A unique identifier for the collaboration that the configured audience model
	// associations belong to. Accepts collaboration ID.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the configured audience model association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier used to reference members of the collaboration. Only supports
	// Amazon Web Services account ID.
	//
	// This member is required.
	CreatorAccountId *string

	// The identifier of the configured audience model association.
	//
	// This member is required.
	Id *string

	// The name of the configured audience model association.
	//
	// This member is required.
	Name *string

	// The most recent time at which the configured audience model association was
	// updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the configured audience model association.
	Description *string
	// contains filtered or unexported fields
}

A summary of the configured audience model association in the collaboration.

type CollaborationIdNamespaceAssociation added in v1.15.0 

type CollaborationIdNamespaceAssociation struct {

	// The Amazon Resource Name (ARN) of the collaboration ID namespace association.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains the
	// collaboration ID namespace association.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains the collaboration ID
	// namespace association.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the collaboration ID namespace association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the Amazon Web Services account that created the
	// collaboration ID namespace association.
	//
	// This member is required.
	CreatorAccountId *string

	// The unique identifier of the collaboration ID namespace association.
	//
	// This member is required.
	Id *string

	// The input reference configuration that's necessary to create the collaboration
	// ID namespace association.
	//
	// This member is required.
	InputReferenceConfig *IdNamespaceAssociationInputReferenceConfig

	// The input reference properties that are needed to create the collaboration ID
	// namespace association.
	//
	// This member is required.
	InputReferenceProperties *IdNamespaceAssociationInputReferenceProperties

	// The name of the collaboration ID namespace association.
	//
	// This member is required.
	Name *string

	// The most recent time at which the collaboration ID namespace was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the collaboration ID namespace association.
	Description *string

	// The configuration settings for the ID mapping table.
	IdMappingConfig *IdMappingConfig
	// contains filtered or unexported fields
}

Defines details for the collaboration ID namespace association.

type CollaborationIdNamespaceAssociationSummary added in v1.15.0 

type CollaborationIdNamespaceAssociationSummary struct {

	// The Amazon Resource Name (ARN) of the collaboration ID namespace association.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains this
	// collaboration ID namespace association.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains this collaboration ID
	// namespace association.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the collaboration ID namespace association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The Amazon Web Services account that created this collaboration ID namespace
	// association.
	//
	// This member is required.
	CreatorAccountId *string

	// The unique identifier of the collaboration ID namespace association.
	//
	// This member is required.
	Id *string

	// The input reference configuration that's used to create the collaboration ID
	// namespace association.
	//
	// This member is required.
	InputReferenceConfig *IdNamespaceAssociationInputReferenceConfig

	// The input reference properties that are used to create the collaboration ID
	// namespace association.
	//
	// This member is required.
	InputReferenceProperties *IdNamespaceAssociationInputReferencePropertiesSummary

	// The name of the collaboration ID namespace association.
	//
	// This member is required.
	Name *string

	// The most recent time at which the collaboration ID namespace association was
	// updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the collaboration ID namepsace association.
	Description *string
	// contains filtered or unexported fields
}

Provides summary information about the collaboration ID namespace association.

type CollaborationJobLogStatus added in v1.23.0 

type CollaborationJobLogStatus string
const (
	CollaborationJobLogStatusEnabled  CollaborationJobLogStatus = "ENABLED"
	CollaborationJobLogStatusDisabled CollaborationJobLogStatus = "DISABLED"
)

Enum values for CollaborationJobLogStatus

func (CollaborationJobLogStatus) Values added in v1.23.0 

func (CollaborationJobLogStatus) Values() []CollaborationJobLogStatus

Values returns all known values for CollaborationJobLogStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CollaborationPrivacyBudgetSummary added in v1.8.0 

type CollaborationPrivacyBudgetSummary struct {

	// The includes epsilon provided and utility in terms of aggregations.
	//
	// This member is required.
	Budget PrivacyBudget

	// The ARN of the collaboration that includes this privacy budget.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that includes this privacy budget.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the privacy budget was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the account that created this privacy budget.
	//
	// This member is required.
	CreatorAccountId *string

	// The unique identifier of the collaboration privacy budget.
	//
	// This member is required.
	Id *string

	// The ARN of the collaboration privacy budget template.
	//
	// This member is required.
	PrivacyBudgetTemplateArn *string

	// The unique identifier of the collaboration privacy budget template.
	//
	// This member is required.
	PrivacyBudgetTemplateId *string

	// The type of privacy budget template.
	//
	// This member is required.
	Type PrivacyBudgetType

	// The most recent time at which the privacy budget was updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

A summary of the collaboration privacy budgets. This summary includes the collaboration information, creation information, epsilon provided, and utility in terms of aggregations.

type CollaborationPrivacyBudgetTemplate added in v1.8.0 

type CollaborationPrivacyBudgetTemplate struct {

	// The ARN of the collaboration privacy budget template.
	//
	// This member is required.
	Arn *string

	// 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.
	//
	// This member is required.
	AutoRefresh PrivacyBudgetTemplateAutoRefresh

	// The ARN of the collaboration that includes this collaboration privacy budget
	// template.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that includes this collaboration
	// privacy budget template.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the collaboration privacy budget template was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the account that created this collaboration privacy
	// budget template.
	//
	// This member is required.
	CreatorAccountId *string

	// The unique identifier of the collaboration privacy budget template.
	//
	// This member is required.
	Id *string

	// Specifies the epsilon and noise parameters for the privacy budget template.
	//
	// This member is required.
	Parameters PrivacyBudgetTemplateParametersOutput

	// The type of privacy budget template.
	//
	// This member is required.
	PrivacyBudgetType PrivacyBudgetType

	// The most recent time at which the collaboration privacy budget template was
	// updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

An array that specifies the information for a collaboration's privacy budget template.

type CollaborationPrivacyBudgetTemplateSummary added in v1.8.0 

type CollaborationPrivacyBudgetTemplateSummary struct {

	// The ARN of the collaboration privacy budget template.
	//
	// This member is required.
	Arn *string

	// The ARN of the collaboration that contains this collaboration privacy budget
	// template.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains this collaboration
	// privacy budget template.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the collaboration privacy budget template was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the account that created this collaboration privacy
	// budget template.
	//
	// This member is required.
	CreatorAccountId *string

	// The unique identifier of the collaboration privacy budget template.
	//
	// This member is required.
	Id *string

	// The type of the privacy budget template.
	//
	// This member is required.
	PrivacyBudgetType PrivacyBudgetType

	// The most recent time at which the collaboration privacy budget template was
	// updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

A summary of the collaboration's privacy budget template. This summary includes information about who created the privacy budget template and what collaborations it belongs to.

type CollaborationQueryLogStatus 

type CollaborationQueryLogStatus string
const (
	CollaborationQueryLogStatusEnabled  CollaborationQueryLogStatus = "ENABLED"
	CollaborationQueryLogStatusDisabled CollaborationQueryLogStatus = "DISABLED"
)

Enum values for CollaborationQueryLogStatus

func (CollaborationQueryLogStatus) Values 

func (CollaborationQueryLogStatus) Values() []CollaborationQueryLogStatus

Values returns all known values for CollaborationQueryLogStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CollaborationSummary 

type CollaborationSummary struct {

	// The ARN of the collaboration.
	//
	// This member is required.
	Arn *string

	// The time when the collaboration was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier used to reference members of the collaboration. Currently only
	// supports Amazon Web Services account ID.
	//
	// This member is required.
	CreatorAccountId *string

	// The display name of the collaboration creator.
	//
	// This member is required.
	CreatorDisplayName *string

	// The identifier for the collaboration.
	//
	// This member is required.
	Id *string

	// The status of a member in a collaboration.
	//
	// This member is required.
	MemberStatus MemberStatus

	// A human-readable identifier provided by the collaboration owner. Display names
	// are not unique.
	//
	// This member is required.
	Name *string

	// The time the collaboration metadata was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The analytics engine.
	//
	// After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.
	AnalyticsEngine AnalyticsEngine

	// The ARN of a member in a collaboration.
	MembershipArn *string

	// The identifier of a member in a collaboration.
	MembershipId *string
	// contains filtered or unexported fields
}

The metadata of the collaboration.

type Column 

type Column struct {

	// The name of the column.
	//
	// This member is required.
	Name *string

	// The type of the column.
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

A column within a schema relation, derived from the underlying table.

type ComputeConfiguration added in v1.19.0 

type ComputeConfiguration interface {
	// contains filtered or unexported methods
}
The configuration of the compute resources for an analysis with the Spark

analytics engine.

The following types satisfy this interface: 

ComputeConfigurationMemberWorker
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ComputeConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ComputeConfigurationMemberWorker:
		_ = v.Value // Value is types.WorkerComputeConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ComputeConfigurationMemberWorker added in v1.19.0 

type ComputeConfigurationMemberWorker struct {
	Value WorkerComputeConfiguration
	// contains filtered or unexported fields
}

The worker configuration for the compute environment.

type ConfigurationDetails added in v1.16.0 

type ConfigurationDetails interface {
	// contains filtered or unexported methods
}
The configuration details.

The following types satisfy this interface: 

ConfigurationDetailsMemberDirectAnalysisConfigurationDetails
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ConfigurationDetails
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfigurationDetailsMemberDirectAnalysisConfigurationDetails:
		_ = v.Value // Value is types.DirectAnalysisConfigurationDetails

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ConfigurationDetailsMemberDirectAnalysisConfigurationDetails added in v1.16.0 

type ConfigurationDetailsMemberDirectAnalysisConfigurationDetails struct {
	Value DirectAnalysisConfigurationDetails
	// contains filtered or unexported fields
}

The direct analysis configuration details.

type ConfiguredAudienceModelAssociation added in v1.8.0 

type ConfiguredAudienceModelAssociation struct {

	// The Amazon Resource Name (ARN) of the configured audience model association.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains this
	// configured audience model association.
	//
	// This member is required.
	CollaborationArn *string

	// A unique identifier of the collaboration that contains this configured audience
	// model association.
	//
	// This member is required.
	CollaborationId *string

	// The Amazon Resource Name (ARN) of the configured audience model that was used
	// for this configured audience model association.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string

	// The time at which the configured audience model association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// A unique identifier of the configured audience model association.
	//
	// This member is required.
	Id *string

	// 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.
	//
	// This member is required.
	ManageResourcePolicies *bool

	// The Amazon Resource Name (ARN) of the membership that contains this configured
	// audience model association.
	//
	// This member is required.
	MembershipArn *string

	// A unique identifier for the membership that contains this configured audience
	// model association.
	//
	// This member is required.
	MembershipId *string

	// The name of the configured audience model association.
	//
	// This member is required.
	Name *string

	// The most recent time at which the configured audience model association was
	// updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the configured audience model association.
	Description *string
	// contains filtered or unexported fields
}

Details about the configured audience model association.

type ConfiguredAudienceModelAssociationSummary added in v1.8.0 

type ConfiguredAudienceModelAssociationSummary struct {

	// The Amazon Resource Name (ARN) of the configured audience model association.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains the
	// configured audience model association.
	//
	// This member is required.
	CollaborationArn *string

	// A unique identifier of the collaboration that configured audience model is
	// associated with.
	//
	// This member is required.
	CollaborationId *string

	// The Amazon Resource Name (ARN) of the configured audience model that was used
	// for this configured audience model association.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string

	// The time at which the configured audience model association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// A unique identifier of the configured audience model association.
	//
	// This member is required.
	Id *string

	// The Amazon Resource Name (ARN) of the membership that contains the configured
	// audience model association.
	//
	// This member is required.
	MembershipArn *string

	// A unique identifier of the membership that contains the configured audience
	// model association.
	//
	// This member is required.
	MembershipId *string

	// The name of the configured audience model association.
	//
	// This member is required.
	Name *string

	// The most recent time at which the configured audience model association was
	// updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the configured audience model association.
	Description *string
	// contains filtered or unexported fields
}

A summary of the configured audience model association.

type ConfiguredTable 

type ConfiguredTable struct {

	// The columns within the underlying Glue table that can be utilized within
	// collaborations.
	//
	// This member is required.
	AllowedColumns []string

	// The analysis method for the configured table.
	//
	// DIRECT_QUERY allows SQL queries to be run directly on this table.
	//
	// DIRECT_JOB allows PySpark jobs to be run directly on this table.
	//
	// MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this
	// table.
	//
	// This member is required.
	AnalysisMethod AnalysisMethod

	// The types of analysis rules associated with this configured table. Currently,
	// only one analysis rule may be associated with a configured table.
	//
	// This member is required.
	AnalysisRuleTypes []ConfiguredTableAnalysisRuleType

	// The unique ARN for the configured table.
	//
	// This member is required.
	Arn *string

	// The time the configured table was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique ID for the configured table.
	//
	// This member is required.
	Id *string

	// A name for the configured table.
	//
	// This member is required.
	Name *string

	// The table that this configured table represents.
	//
	// This member is required.
	TableReference TableReference

	// The time the configured table was last updated
	//
	// This member is required.
	UpdateTime *time.Time

	// A description for the configured table.
	Description *string

	//  The selected analysis methods for the configured table.
	SelectedAnalysisMethods []SelectedAnalysisMethod
	// contains filtered or unexported fields
}

A table that has been configured for use in a collaboration.

type ConfiguredTableAnalysisRule 

type ConfiguredTableAnalysisRule struct {

	// The unique ARN for the configured table.
	//
	// This member is required.
	ConfiguredTableArn *string

	// The unique ID for the configured table.
	//
	// This member is required.
	ConfiguredTableId *string

	// The time the configured table analysis rule was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The policy that controls SQL query rules.
	//
	// This member is required.
	Policy ConfiguredTableAnalysisRulePolicy

	// The type of configured table analysis rule.
	//
	// This member is required.
	Type ConfiguredTableAnalysisRuleType

	// The time the configured table analysis rule was last updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

A configured table analysis rule, which limits how data for this table can be used.

type ConfiguredTableAnalysisRulePolicy 

type ConfiguredTableAnalysisRulePolicy interface {
	// contains filtered or unexported methods
}

Controls on the query specifications that can be run on a configured table.

The following types satisfy this interface: 

ConfiguredTableAnalysisRulePolicyMemberV1
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ConfiguredTableAnalysisRulePolicy
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfiguredTableAnalysisRulePolicyMemberV1:
		_ = v.Value // Value is types.ConfiguredTableAnalysisRulePolicyV1

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ConfiguredTableAnalysisRulePolicyMemberV1 

type ConfiguredTableAnalysisRulePolicyMemberV1 struct {
	Value ConfiguredTableAnalysisRulePolicyV1
	// contains filtered or unexported fields
}

Controls on the query specifications that can be run on a configured table.

type ConfiguredTableAnalysisRulePolicyV1 

type ConfiguredTableAnalysisRulePolicyV1 interface {
	// contains filtered or unexported methods
}

Controls on the query specifications that can be run on a configured table.

The following types satisfy this interface: 

ConfiguredTableAnalysisRulePolicyV1MemberAggregation
ConfiguredTableAnalysisRulePolicyV1MemberCustom
ConfiguredTableAnalysisRulePolicyV1MemberList
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ConfiguredTableAnalysisRulePolicyV1
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfiguredTableAnalysisRulePolicyV1MemberAggregation:
		_ = v.Value // Value is types.AnalysisRuleAggregation

	case *types.ConfiguredTableAnalysisRulePolicyV1MemberCustom:
		_ = v.Value // Value is types.AnalysisRuleCustom

	case *types.ConfiguredTableAnalysisRulePolicyV1MemberList:
		_ = v.Value // Value is types.AnalysisRuleList

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ConfiguredTableAnalysisRulePolicyV1MemberAggregation 

type ConfiguredTableAnalysisRulePolicyV1MemberAggregation struct {
	Value AnalysisRuleAggregation
	// contains filtered or unexported fields
}

Analysis rule type that enables only aggregation queries on a configured table.

type ConfiguredTableAnalysisRulePolicyV1MemberCustom added in v1.3.0 

type ConfiguredTableAnalysisRulePolicyV1MemberCustom struct {
	Value AnalysisRuleCustom
	// contains filtered or unexported fields
}

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

type ConfiguredTableAnalysisRulePolicyV1MemberList 

type ConfiguredTableAnalysisRulePolicyV1MemberList struct {
	Value AnalysisRuleList
	// contains filtered or unexported fields
}

Analysis rule type that enables only list queries on a configured table.

type ConfiguredTableAnalysisRuleType 

type ConfiguredTableAnalysisRuleType string
const (
	ConfiguredTableAnalysisRuleTypeAggregation ConfiguredTableAnalysisRuleType = "AGGREGATION"
	ConfiguredTableAnalysisRuleTypeList        ConfiguredTableAnalysisRuleType = "LIST"
	ConfiguredTableAnalysisRuleTypeCustom      ConfiguredTableAnalysisRuleType = "CUSTOM"
)

Enum values for ConfiguredTableAnalysisRuleType

func (ConfiguredTableAnalysisRuleType) Values 

func (ConfiguredTableAnalysisRuleType) Values() []ConfiguredTableAnalysisRuleType

Values returns all known values for ConfiguredTableAnalysisRuleType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfiguredTableAssociation 

type ConfiguredTableAssociation struct {

	// The unique ARN for the configured table association.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the configured table that the association refers to.
	//
	// This member is required.
	ConfiguredTableArn *string

	// The unique ID for the configured table that the association refers to.
	//
	// This member is required.
	ConfiguredTableId *string

	// The time the configured table association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique ID for the configured table association.
	//
	// This member is required.
	Id *string

	// The unique ARN for the membership this configured table association belongs to.
	//
	// This member is required.
	MembershipArn *string

	// The unique ID for the membership this configured table association belongs to.
	//
	// This member is required.
	MembershipId *string

	// The name of the configured table association, in lowercase. The table is
	// identified by this name when running protected queries against the underlying
	// data.
	//
	// This member is required.
	Name *string

	// The service will assume this role to access catalog metadata and query the
	// table.
	//
	// This member is required.
	RoleArn *string

	// The time the configured table association was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The analysis rule types for the configured table association.
	AnalysisRuleTypes []ConfiguredTableAssociationAnalysisRuleType

	// A description of the configured table association.
	Description *string
	// contains filtered or unexported fields
}

A configured table association links a configured table to a collaboration.

type ConfiguredTableAssociationAnalysisRule added in v1.16.0 

type ConfiguredTableAssociationAnalysisRule struct {

	//  The Amazon Resource Name (ARN) of the configured table association.
	//
	// This member is required.
	ConfiguredTableAssociationArn *string

	//  The unique identifier for the configured table association.
	//
	// This member is required.
	ConfiguredTableAssociationId *string

	//  The creation time of the configured table association analysis rule.
	//
	// This member is required.
	CreateTime *time.Time

	//  The membership identifier for the configured table association analysis rule.
	//
	// This member is required.
	MembershipIdentifier *string

	//  The policy of the configured table association analysis rule.
	//
	// This member is required.
	Policy ConfiguredTableAssociationAnalysisRulePolicy

	//  The type of the configured table association analysis rule.
	//
	// This member is required.
	Type ConfiguredTableAssociationAnalysisRuleType

	//  The update time of the configured table association analysis rule.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.

type ConfiguredTableAssociationAnalysisRuleAggregation added in v1.16.0 

type ConfiguredTableAssociationAnalysisRuleAggregation struct {

	//  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 ).
	AllowedAdditionalAnalyses []string

	//  The list of collaboration members who are allowed to receive results of
	// queries run with this configured table.
	AllowedResultReceivers []string
	// contains filtered or unexported fields
}
The configured table association analysis rule applied to a configured table

with the aggregation analysis rule.

type ConfiguredTableAssociationAnalysisRuleCustom added in v1.16.0 

type ConfiguredTableAssociationAnalysisRuleCustom struct {

	//  The list of resources or wildcards (ARNs) that are allowed to perform
	// additional analysis on query output.
	AllowedAdditionalAnalyses []string

	//  The list of collaboration members who are allowed to receive results of
	// queries run with this configured table.
	AllowedResultReceivers []string
	// contains filtered or unexported fields
}
The configured table association analysis rule applied to a configured table

with the custom analysis rule.

type ConfiguredTableAssociationAnalysisRuleList added in v1.16.0 

type ConfiguredTableAssociationAnalysisRuleList struct {

	//  The list of resources or wildcards (ARNs) that are allowed to perform
	// additional analysis on query output.
	AllowedAdditionalAnalyses []string

	//  The list of collaboration members who are allowed to receive results of
	// queries run with this configured table.
	AllowedResultReceivers []string
	// contains filtered or unexported fields
}
The configured table association analysis rule applied to a configured table

with the list analysis rule.

type ConfiguredTableAssociationAnalysisRulePolicy added in v1.16.0 

type ConfiguredTableAssociationAnalysisRulePolicy interface {
	// contains filtered or unexported methods
}
Controls on the query specifications that can be run on an associated

configured table.

The following types satisfy this interface: 

ConfiguredTableAssociationAnalysisRulePolicyMemberV1
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ConfiguredTableAssociationAnalysisRulePolicy
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfiguredTableAssociationAnalysisRulePolicyMemberV1:
		_ = v.Value // Value is types.ConfiguredTableAssociationAnalysisRulePolicyV1

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ConfiguredTableAssociationAnalysisRulePolicyMemberV1 added in v1.16.0 

type ConfiguredTableAssociationAnalysisRulePolicyMemberV1 struct {
	Value ConfiguredTableAssociationAnalysisRulePolicyV1
	// contains filtered or unexported fields
}

The policy for the configured table association analysis rule.

type ConfiguredTableAssociationAnalysisRulePolicyV1 added in v1.16.0 

type ConfiguredTableAssociationAnalysisRulePolicyV1 interface {
	// contains filtered or unexported methods
}
Controls on the query specifications that can be run on an associated

configured table.

The following types satisfy this interface: 

ConfiguredTableAssociationAnalysisRulePolicyV1MemberAggregation
ConfiguredTableAssociationAnalysisRulePolicyV1MemberCustom
ConfiguredTableAssociationAnalysisRulePolicyV1MemberList
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ConfiguredTableAssociationAnalysisRulePolicyV1
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConfiguredTableAssociationAnalysisRulePolicyV1MemberAggregation:
		_ = v.Value // Value is types.ConfiguredTableAssociationAnalysisRuleAggregation

	case *types.ConfiguredTableAssociationAnalysisRulePolicyV1MemberCustom:
		_ = v.Value // Value is types.ConfiguredTableAssociationAnalysisRuleCustom

	case *types.ConfiguredTableAssociationAnalysisRulePolicyV1MemberList:
		_ = v.Value // Value is types.ConfiguredTableAssociationAnalysisRuleList

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ConfiguredTableAssociationAnalysisRulePolicyV1MemberAggregation added in v1.16.0 

type ConfiguredTableAssociationAnalysisRulePolicyV1MemberAggregation struct {
	Value ConfiguredTableAssociationAnalysisRuleAggregation
	// contains filtered or unexported fields
}

Analysis rule type that enables only aggregation queries on a configured table.

type ConfiguredTableAssociationAnalysisRulePolicyV1MemberCustom added in v1.16.0 

type ConfiguredTableAssociationAnalysisRulePolicyV1MemberCustom struct {
	Value ConfiguredTableAssociationAnalysisRuleCustom
	// contains filtered or unexported fields
}
Analysis rule type that enables the table owner to approve custom SQL queries

on their configured tables. It supports differential privacy.

type ConfiguredTableAssociationAnalysisRulePolicyV1MemberList added in v1.16.0 

type ConfiguredTableAssociationAnalysisRulePolicyV1MemberList struct {
	Value ConfiguredTableAssociationAnalysisRuleList
	// contains filtered or unexported fields
}

Analysis rule type that enables only list queries on a configured table.

type ConfiguredTableAssociationAnalysisRuleType added in v1.16.0 

type ConfiguredTableAssociationAnalysisRuleType string
const (
	ConfiguredTableAssociationAnalysisRuleTypeAggregation ConfiguredTableAssociationAnalysisRuleType = "AGGREGATION"
	ConfiguredTableAssociationAnalysisRuleTypeList        ConfiguredTableAssociationAnalysisRuleType = "LIST"
	ConfiguredTableAssociationAnalysisRuleTypeCustom      ConfiguredTableAssociationAnalysisRuleType = "CUSTOM"
)

Enum values for ConfiguredTableAssociationAnalysisRuleType

func (ConfiguredTableAssociationAnalysisRuleType) Values added in v1.16.0 

func (ConfiguredTableAssociationAnalysisRuleType) Values() []ConfiguredTableAssociationAnalysisRuleType

Values returns all known values for ConfiguredTableAssociationAnalysisRuleType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConfiguredTableAssociationSummary 

type ConfiguredTableAssociationSummary struct {

	// The unique ARN for the configured table association.
	//
	// This member is required.
	Arn *string

	// The unique configured table ID that this configured table association refers to.
	//
	// This member is required.
	ConfiguredTableId *string

	// The time the configured table association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique ID for the configured table association.
	//
	// This member is required.
	Id *string

	// The unique ARN for the membership that the configured table association belongs
	// to.
	//
	// This member is required.
	MembershipArn *string

	// The unique ID for the membership that the configured table association belongs
	// to.
	//
	// This member is required.
	MembershipId *string

	// The name of the configured table association. The table is identified by this
	// name when running Protected Queries against the underlying data.
	//
	// This member is required.
	Name *string

	// The time the configured table association was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The analysis rule types that are associated with the configured table
	// associations in this summary.
	AnalysisRuleTypes []ConfiguredTableAssociationAnalysisRuleType
	// contains filtered or unexported fields
}

The configured table association summary for the objects listed by the request.

type ConfiguredTableSummary 

type ConfiguredTableSummary struct {

	// The analysis method for the configured tables.
	//
	// DIRECT_QUERY allows SQL queries to be run directly on this table.
	//
	// DIRECT_JOB allows PySpark jobs to be run directly on this table.
	//
	// MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this
	// table.
	//
	// This member is required.
	AnalysisMethod AnalysisMethod

	// The types of analysis rules associated with this configured table.
	//
	// This member is required.
	AnalysisRuleTypes []ConfiguredTableAnalysisRuleType

	// The unique ARN of the configured table.
	//
	// This member is required.
	Arn *string

	// The time the configured table was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique ID of the configured table.
	//
	// This member is required.
	Id *string

	// The name of the configured table.
	//
	// This member is required.
	Name *string

	// The time the configured table was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The selected analysis methods for the configured table summary.
	SelectedAnalysisMethods []SelectedAnalysisMethod
	// contains filtered or unexported fields
}

The configured table summary for the objects listed by the request.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	Reason       ConflictExceptionReason
	// contains filtered or unexported fields
}

Updating or deleting a resource can cause an inconsistent state.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConflictExceptionReason 

type ConflictExceptionReason string
const (
	ConflictExceptionReasonAlreadyExists     ConflictExceptionReason = "ALREADY_EXISTS"
	ConflictExceptionReasonSubresourcesExist ConflictExceptionReason = "SUBRESOURCES_EXIST"
	ConflictExceptionReasonInvalidState      ConflictExceptionReason = "INVALID_STATE"
)

Enum values for ConflictExceptionReason

func (ConflictExceptionReason) Values 

func (ConflictExceptionReason) Values() []ConflictExceptionReason

Values returns all known values for ConflictExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConsolidatedPolicy added in v1.23.0 

type ConsolidatedPolicy interface {
	// contains filtered or unexported methods
}

Controls on the analysis specifications that can be run on a configured table.

The following types satisfy this interface: 

ConsolidatedPolicyMemberV1
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ConsolidatedPolicy
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConsolidatedPolicyMemberV1:
		_ = v.Value // Value is types.ConsolidatedPolicyV1

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ConsolidatedPolicyAggregation added in v1.23.0 

type ConsolidatedPolicyAggregation struct {

	//  Aggregate columns in consolidated policy aggregation.
	//
	// This member is required.
	AggregateColumns []AggregateColumn

	//  The dimension columns of the consolidated policy aggregation.
	//
	// This member is required.
	DimensionColumns []string

	//  The columns to join on.
	//
	// This member is required.
	JoinColumns []string

	//  The output constraints of the consolidated policy aggregation.
	//
	// This member is required.
	OutputConstraints []AggregationConstraint

	//  The scalar functions.
	//
	// This member is required.
	ScalarFunctions []ScalarFunctions

	//  Additional analyses for the consolidated policy aggregation.
	AdditionalAnalyses AdditionalAnalyses

	//  The additional analyses allowed by the consolidated policy aggregation.
	AllowedAdditionalAnalyses []string

	//  The allowed join operators.
	AllowedJoinOperators []JoinOperator

	//  The allowed result receivers.
	AllowedResultReceivers []string

	//  Join required
	JoinRequired JoinRequiredOption
	// contains filtered or unexported fields
}

Controls on the analysis specifications that can be run on a configured table.

type ConsolidatedPolicyCustom added in v1.23.0 

type ConsolidatedPolicyCustom struct {

	//  The allowed analyses.
	//
	// This member is required.
	AllowedAnalyses []string

	//  Additional analyses for the consolidated policy.
	AdditionalAnalyses AdditionalAnalyses

	//  The additional analyses allowed by the consolidated policy.
	AllowedAdditionalAnalyses []string

	//  The allowed analysis providers.
	AllowedAnalysisProviders []string

	//  The allowed result receivers.
	AllowedResultReceivers []string

	// Specifies the unique identifier for your users.
	DifferentialPrivacy *DifferentialPrivacyConfiguration

	//  Disallowed output columns
	DisallowedOutputColumns []string
	// contains filtered or unexported fields
}

Controls on the analysis specifications that can be run on a configured table.

type ConsolidatedPolicyList added in v1.23.0 

type ConsolidatedPolicyList struct {

	//  The columns to join on.
	//
	// This member is required.
	JoinColumns []string

	//  The columns in the consolidated policy list.
	//
	// This member is required.
	ListColumns []string

	//  Additional analyses for the consolidated policy list.
	AdditionalAnalyses AdditionalAnalyses

	//  The additional analyses allowed by the consolidated policy list.
	AllowedAdditionalAnalyses []string

	//  The allowed join operators in the consolidated policy list.
	AllowedJoinOperators []JoinOperator

	//  The allowed result receivers.
	AllowedResultReceivers []string
	// contains filtered or unexported fields
}

Controls on the analysis specifications that can be run on a configured table.

type ConsolidatedPolicyMemberV1 added in v1.23.0 

type ConsolidatedPolicyMemberV1 struct {
	Value ConsolidatedPolicyV1
	// contains filtered or unexported fields
}

The consolidated policy version 1.

type ConsolidatedPolicyV1 added in v1.23.0 

type ConsolidatedPolicyV1 interface {
	// contains filtered or unexported methods
}

Controls on the analysis specifications that can be run on a configured table.

The following types satisfy this interface: 

ConsolidatedPolicyV1MemberAggregation
ConsolidatedPolicyV1MemberCustom
ConsolidatedPolicyV1MemberList
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ConsolidatedPolicyV1
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ConsolidatedPolicyV1MemberAggregation:
		_ = v.Value // Value is types.ConsolidatedPolicyAggregation

	case *types.ConsolidatedPolicyV1MemberCustom:
		_ = v.Value // Value is types.ConsolidatedPolicyCustom

	case *types.ConsolidatedPolicyV1MemberList:
		_ = v.Value // Value is types.ConsolidatedPolicyList

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ConsolidatedPolicyV1MemberAggregation added in v1.23.0 

type ConsolidatedPolicyV1MemberAggregation struct {
	Value ConsolidatedPolicyAggregation
	// contains filtered or unexported fields
}

The aggregation setting for the consolidated policy.

type ConsolidatedPolicyV1MemberCustom added in v1.23.0 

type ConsolidatedPolicyV1MemberCustom struct {
	Value ConsolidatedPolicyCustom
	// contains filtered or unexported fields
}

Custom policy

type ConsolidatedPolicyV1MemberList added in v1.23.0 

type ConsolidatedPolicyV1MemberList struct {
	Value ConsolidatedPolicyList
	// contains filtered or unexported fields
}

The list of consolidated policies.

type CustomMLMemberAbility added in v1.20.0 

type CustomMLMemberAbility string
const (
	CustomMLMemberAbilityCanReceiveModelOutput     CustomMLMemberAbility = "CAN_RECEIVE_MODEL_OUTPUT"
	CustomMLMemberAbilityCanReceiveInferenceOutput CustomMLMemberAbility = "CAN_RECEIVE_INFERENCE_OUTPUT"
)

Enum values for CustomMLMemberAbility

func (CustomMLMemberAbility) Values added in v1.20.0 

func (CustomMLMemberAbility) Values() []CustomMLMemberAbility

Values returns all known values for CustomMLMemberAbility. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DataEncryptionMetadata 

type DataEncryptionMetadata struct {

	// Indicates whether encrypted tables can contain cleartext data ( TRUE ) or are to
	// cryptographically process every column ( FALSE ).
	//
	// This member is required.
	AllowCleartext *bool

	// Indicates whether Fingerprint columns can contain duplicate entries ( TRUE ) or
	// are to contain only non-repeated values ( FALSE ).
	//
	// This member is required.
	AllowDuplicates *bool

	// 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 ).
	//
	// This member is required.
	AllowJoinsOnColumnsWithDifferentNames *bool

	// Indicates whether NULL values are to be copied as NULL to encrypted tables ( TRUE
	// ) or cryptographically processed ( FALSE ).
	//
	// This member is required.
	PreserveNulls *bool
	// contains filtered or unexported fields
}

The settings for client-side encryption for cryptographic computing.

type DifferentialPrivacyAggregationType added in v1.8.0 

type DifferentialPrivacyAggregationType string
const (
	DifferentialPrivacyAggregationTypeAvg           DifferentialPrivacyAggregationType = "AVG"
	DifferentialPrivacyAggregationTypeCount         DifferentialPrivacyAggregationType = "COUNT"
	DifferentialPrivacyAggregationTypeCountDistinct DifferentialPrivacyAggregationType = "COUNT_DISTINCT"
	DifferentialPrivacyAggregationTypeSum           DifferentialPrivacyAggregationType = "SUM"
	DifferentialPrivacyAggregationTypeStddev        DifferentialPrivacyAggregationType = "STDDEV"
)

Enum values for DifferentialPrivacyAggregationType

func (DifferentialPrivacyAggregationType) Values added in v1.8.0 

func (DifferentialPrivacyAggregationType) Values() []DifferentialPrivacyAggregationType

Values returns all known values for DifferentialPrivacyAggregationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DifferentialPrivacyColumn added in v1.8.0 

type DifferentialPrivacyColumn struct {

	// 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.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Specifies the name of the column that contains the unique identifier of your users, whose privacy you want to protect.

type DifferentialPrivacyConfiguration added in v1.8.0 

type DifferentialPrivacyConfiguration struct {

	// 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.
	//
	// This member is required.
	Columns []DifferentialPrivacyColumn
	// contains filtered or unexported fields
}

Specifies the unique identifier for your users.

type DifferentialPrivacyParameters added in v1.8.0 

type DifferentialPrivacyParameters struct {

	// Provides the sensitivity parameters that you can use to better understand the
	// total amount of noise in query results.
	//
	// This member is required.
	SensitivityParameters []DifferentialPrivacySensitivityParameters
	// contains filtered or unexported fields
}

An array that contains the sensitivity parameters.

type DifferentialPrivacyPreviewAggregation added in v1.8.0 

type DifferentialPrivacyPreviewAggregation struct {

	// The maximum number of aggregations that the member who can query can run given
	// the epsilon and noise parameters.
	//
	// This member is required.
	MaxCount *int32

	// The type of aggregation function.
	//
	// This member is required.
	Type DifferentialPrivacyAggregationType
	// contains filtered or unexported fields
}

Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.

type DifferentialPrivacyPreviewParametersInput added in v1.8.0 

type DifferentialPrivacyPreviewParametersInput struct {

	// The epsilon value that you want to preview.
	//
	// This member is required.
	Epsilon *int32

	// Noise added per query 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.
	//
	// This member is required.
	UsersNoisePerQuery *int32
	// contains filtered or unexported fields
}

The epsilon and noise parameters that you want to preview.

type DifferentialPrivacyPrivacyBudget added in v1.8.0 

type DifferentialPrivacyPrivacyBudget struct {

	// This information includes the configured epsilon value and the utility in terms
	// of total aggregations, as well as the remaining aggregations.
	//
	// This member is required.
	Aggregations []DifferentialPrivacyPrivacyBudgetAggregation

	// The epsilon value that you configured.
	//
	// This member is required.
	Epsilon *int32
	// contains filtered or unexported fields
}

Specifies the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations available.

type DifferentialPrivacyPrivacyBudgetAggregation added in v1.8.0 

type DifferentialPrivacyPrivacyBudgetAggregation struct {

	// The maximum number of aggregation functions that you can perform with the given
	// privacy budget.
	//
	// This member is required.
	MaxCount *int32

	// The remaining number of aggregation functions that can be run with the
	// available privacy budget.
	//
	// This member is required.
	RemainingCount *int32

	// The different types of aggregation functions that you can perform.
	//
	// This member is required.
	Type DifferentialPrivacyAggregationType
	// contains filtered or unexported fields
}

Information about the total number of aggregations, as well as the remaining aggregations.

type DifferentialPrivacyPrivacyImpact added in v1.8.0 

type DifferentialPrivacyPrivacyImpact struct {

	// The number of aggregation functions that you can perform.
	//
	// This member is required.
	Aggregations []DifferentialPrivacyPreviewAggregation
	// contains filtered or unexported fields
}

Information about the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.

type DifferentialPrivacySensitivityParameters added in v1.8.0 

type DifferentialPrivacySensitivityParameters struct {

	// The aggregation expression that was run.
	//
	// This member is required.
	AggregationExpression *string

	// The type of aggregation function that was run.
	//
	// This member is required.
	AggregationType DifferentialPrivacyAggregationType

	// The maximum number of rows contributed by a user in a SQL query.
	//
	// This member is required.
	UserContributionLimit *int32

	// The upper bound of the aggregation expression.
	MaxColumnValue *float32

	// The lower bound of the aggregation expression.
	MinColumnValue *float32
	// contains filtered or unexported fields
}

Provides the sensitivity parameters.

type DifferentialPrivacyTemplateParametersInput added in v1.8.0 

type DifferentialPrivacyTemplateParametersInput struct {

	// The epsilon value that you want to use.
	//
	// This member is required.
	Epsilon *int32

	// Noise added per query 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.
	//
	// This member is required.
	UsersNoisePerQuery *int32
	// contains filtered or unexported fields
}

The epsilon and noise parameter values that you want to use for the differential privacy template.

type DifferentialPrivacyTemplateParametersOutput added in v1.8.0 

type DifferentialPrivacyTemplateParametersOutput struct {

	// The epsilon value that you specified.
	//
	// This member is required.
	Epsilon *int32

	// Noise added per query 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.
	//
	// This member is required.
	UsersNoisePerQuery *int32
	// contains filtered or unexported fields
}

The epsilon and noise parameter values that were used for the differential privacy template.

type DifferentialPrivacyTemplateUpdateParameters added in v1.8.0 

type DifferentialPrivacyTemplateUpdateParameters struct {

	// The updated epsilon value that you want to use.
	Epsilon *int32

	// 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.
	UsersNoisePerQuery *int32
	// contains filtered or unexported fields
}

The epsilon and noise parameter values that you want to update in the differential privacy template.

type DirectAnalysisConfigurationDetails added in v1.16.0 

type DirectAnalysisConfigurationDetails struct {

	//  The account IDs for the member who received the results of a protected query.
	ReceiverAccountIds []string
	// contains filtered or unexported fields
}

The direct analysis configuration details.

type ErrorMessageConfiguration added in v1.30.0 

type ErrorMessageConfiguration struct {

	// The level of detail for error messages returned by the PySpark job. When set to
	// DETAILED, error messages include more information to help troubleshoot issues
	// with your PySpark job.
	//
	// Because this setting may expose sensitive data, it is recommended for
	// development and testing environments.
	//
	// This member is required.
	Type ErrorMessageType
	// contains filtered or unexported fields
}

A structure that defines the level of detail included in error messages returned by PySpark jobs. This configuration allows you to control the verbosity of error messages to help with troubleshooting PySpark jobs while maintaining appropriate security controls.

type ErrorMessageType added in v1.30.0 

type ErrorMessageType string
const (
	ErrorMessageTypeDetailed ErrorMessageType = "DETAILED"
)

Enum values for ErrorMessageType

func (ErrorMessageType) Values added in v1.30.0 

func (ErrorMessageType) Values() []ErrorMessageType

Values returns all known values for ErrorMessageType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FilterableMemberStatus 

type FilterableMemberStatus string
const (
	FilterableMemberStatusInvited FilterableMemberStatus = "INVITED"
	FilterableMemberStatusActive  FilterableMemberStatus = "ACTIVE"
)

Enum values for FilterableMemberStatus

func (FilterableMemberStatus) Values 

func (FilterableMemberStatus) Values() []FilterableMemberStatus

Values returns all known values for FilterableMemberStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type GlueTableReference 

type GlueTableReference struct {

	// The name of the database the Glue table belongs to.
	//
	// This member is required.
	DatabaseName *string

	// The name of the Glue table.
	//
	// This member is required.
	TableName *string
	// contains filtered or unexported fields
}

A reference to a table within an Glue data catalog.

type Hash added in v1.23.0 

type Hash struct {

	//  The SHA-256 hash value.
	Sha256 *string
	// contains filtered or unexported fields
}

Hash

type IdMappingConfig added in v1.15.0 

type IdMappingConfig struct {

	// An indicator as to whether you can use your column as a dimension column in the
	// ID mapping table ( TRUE ) or not ( FALSE ).
	//
	// Default is FALSE .
	//
	// This member is required.
	AllowUseAsDimensionColumn bool
	// contains filtered or unexported fields
}

The configuration settings for the ID mapping table.

type IdMappingTable added in v1.15.0 

type IdMappingTable struct {

	// The Amazon Resource Name (ARN) of the ID mapping table.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains this ID
	// mapping table.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains this ID mapping table.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the ID mapping table was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the ID mapping table.
	//
	// This member is required.
	Id *string

	// The input reference configuration for the ID mapping table.
	//
	// This member is required.
	InputReferenceConfig *IdMappingTableInputReferenceConfig

	// The input reference properties for the ID mapping table.
	//
	// This member is required.
	InputReferenceProperties *IdMappingTableInputReferenceProperties

	// The Amazon Resource Name (ARN) of the membership resource for the ID mapping
	// table.
	//
	// This member is required.
	MembershipArn *string

	// The unique identifier of the membership resource for the ID mapping table.
	//
	// This member is required.
	MembershipId *string

	// The name of the ID mapping table.
	//
	// This member is required.
	Name *string

	// The most recent time at which the ID mapping table was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the ID mapping table.
	Description *string

	// The Amazon Resource Name (ARN) of the Amazon Web Services KMS key.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Describes information about the ID mapping table.

type IdMappingTableInputReferenceConfig added in v1.15.0 

type IdMappingTableInputReferenceConfig struct {

	// The Amazon Resource Name (ARN) of the referenced resource in Entity Resolution.
	// Valid values are ID mapping workflow ARNs.
	//
	// This member is required.
	InputReferenceArn *string

	// 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.
	//
	// This member is required.
	ManageResourcePolicies *bool
	// contains filtered or unexported fields
}

Provides the input reference configuration for the ID mapping table.

type IdMappingTableInputReferenceProperties added in v1.15.0 

type IdMappingTableInputReferenceProperties struct {

	// The input source of the ID mapping table.
	//
	// This member is required.
	IdMappingTableInputSource []IdMappingTableInputSource
	// contains filtered or unexported fields
}

The input reference properties for the ID mapping table.

type IdMappingTableInputSource added in v1.15.0 

type IdMappingTableInputSource struct {

	// The unique identifier of the ID namespace association.
	//
	// This member is required.
	IdNamespaceAssociationId *string

	// The type of the input source of the ID mapping table.
	//
	// This member is required.
	Type IdNamespaceType
	// contains filtered or unexported fields
}

The input source of the ID mapping table.

type IdMappingTableSchemaTypeProperties added in v1.15.0 

type IdMappingTableSchemaTypeProperties struct {

	// Defines which ID namespace associations are used to create the ID mapping table.
	//
	// This member is required.
	IdMappingTableInputSource []IdMappingTableInputSource
	// contains filtered or unexported fields
}

Additional properties that are specific to the type of the associated schema.

type IdMappingTableSummary added in v1.15.0 

type IdMappingTableSummary struct {

	// The Amazon Resource Name (ARN) of this ID mapping table.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains this ID
	// mapping table.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains this ID mapping table.
	//
	// This member is required.
	CollaborationId *string

	// The time at which this ID mapping table was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of this ID mapping table.
	//
	// This member is required.
	Id *string

	// The input reference configuration for the ID mapping table.
	//
	// This member is required.
	InputReferenceConfig *IdMappingTableInputReferenceConfig

	// The Amazon Resource Name (ARN) of the membership resource for this ID mapping
	// table.
	//
	// This member is required.
	MembershipArn *string

	// The unique identifier of the membership resource for this ID mapping table.
	//
	// This member is required.
	MembershipId *string

	// The name of this ID mapping table.
	//
	// This member is required.
	Name *string

	// The most recent time at which this ID mapping table was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of this ID mapping table.
	Description *string
	// contains filtered or unexported fields
}

Detailed information about the ID mapping table.

type IdNamespaceAssociation added in v1.15.0 

type IdNamespaceAssociation struct {

	// The Amazon Resource Name (ARN) of the ID namespace association.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains this ID
	// namespace association.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains this ID namespace
	// association.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the ID namespace association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier for this ID namespace association.
	//
	// This member is required.
	Id *string

	// The input reference configuration for the ID namespace association.
	//
	// This member is required.
	InputReferenceConfig *IdNamespaceAssociationInputReferenceConfig

	// The input reference properties for the ID namespace association.
	//
	// This member is required.
	InputReferenceProperties *IdNamespaceAssociationInputReferenceProperties

	// The Amazon Resource Name (ARN) of the membership resource for this ID namespace
	// association.
	//
	// This member is required.
	MembershipArn *string

	// The unique identifier of the membership resource for this ID namespace
	// association.
	//
	// This member is required.
	MembershipId *string

	// The name of this ID namespace association.
	//
	// This member is required.
	Name *string

	// The most recent time at which the ID namespace association was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the ID namespace association.
	Description *string

	// The configuration settings for the ID mapping table.
	IdMappingConfig *IdMappingConfig
	// contains filtered or unexported fields
}

Provides information to create the ID namespace association.

type IdNamespaceAssociationInputReferenceConfig added in v1.15.0 

type IdNamespaceAssociationInputReferenceConfig struct {

	// 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.
	//
	// This member is required.
	InputReferenceArn *string

	// 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.
	//
	// This member is required.
	ManageResourcePolicies *bool
	// contains filtered or unexported fields
}

Provides the information for the ID namespace association input reference configuration.

type IdNamespaceAssociationInputReferenceProperties added in v1.15.0 

type IdNamespaceAssociationInputReferenceProperties struct {

	// Defines how ID mapping workflows are supported for this ID namespace
	// association.
	//
	// This member is required.
	IdMappingWorkflowsSupported []document.Interface

	// The ID namespace type for this ID namespace association.
	//
	// This member is required.
	IdNamespaceType IdNamespaceType
	// contains filtered or unexported fields
}

Provides the information for the ID namespace association input reference properties.

type IdNamespaceAssociationInputReferencePropertiesSummary added in v1.15.0 

type IdNamespaceAssociationInputReferencePropertiesSummary struct {

	// The ID namespace type for this ID namespace association.
	//
	// This member is required.
	IdNamespaceType IdNamespaceType
	// contains filtered or unexported fields
}

Detailed information about the ID namespace association input reference properties.

type IdNamespaceAssociationSummary added in v1.15.0 

type IdNamespaceAssociationSummary struct {

	// The Amazon Resource Name (ARN) of this ID namespace association.
	//
	// This member is required.
	Arn *string

	// The Amazon Resource Name (ARN) of the collaboration that contains this ID
	// namespace association.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains this ID namespace
	// association.
	//
	// This member is required.
	CollaborationId *string

	// The time at which this ID namespace association was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of this ID namespace association.
	//
	// This member is required.
	Id *string

	// The input reference configuration details for this ID namespace association.
	//
	// This member is required.
	InputReferenceConfig *IdNamespaceAssociationInputReferenceConfig

	// The input reference properties for this ID namespace association.
	//
	// This member is required.
	InputReferenceProperties *IdNamespaceAssociationInputReferencePropertiesSummary

	// The Amazon Resource Name (ARN) of the membership resource for this ID namespace
	// association.
	//
	// This member is required.
	MembershipArn *string

	// The unique identifier of the membership resource for this ID namespace
	// association.
	//
	// This member is required.
	MembershipId *string

	// The name of the ID namespace association.
	//
	// This member is required.
	Name *string

	// The most recent time at which this ID namespace association has been updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the ID namespace association.
	Description *string
	// contains filtered or unexported fields
}

Detailed information about the ID namespace association.

type IdNamespaceType added in v1.15.0 

type IdNamespaceType string
const (
	IdNamespaceTypeSource IdNamespaceType = "SOURCE"
	IdNamespaceTypeTarget IdNamespaceType = "TARGET"
)

Enum values for IdNamespaceType

func (IdNamespaceType) Values added in v1.15.0 

func (IdNamespaceType) Values() []IdNamespaceType

Values returns all known values for IdNamespaceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Unexpected error during processing of request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type JobComputePaymentConfig added in v1.23.0 

type JobComputePaymentConfig struct {

	// Indicates whether the collaboration creator has configured the collaboration
	// member to pay for query and job compute costs ( TRUE ) or has not configured the
	// collaboration member to pay for query and job compute costs ( FALSE ).
	//
	// Exactly one member can be configured to pay for query and job compute costs. An
	// error is returned if the collaboration creator sets a TRUE value for more than
	// one member in the collaboration.
	//
	// An error is returned if the collaboration creator sets a FALSE value for the
	// member who can run queries and jobs.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.

type JoinOperator added in v1.2.0 

type JoinOperator string
const (
	JoinOperatorOr  JoinOperator = "OR"
	JoinOperatorAnd JoinOperator = "AND"
)

Enum values for JoinOperator

func (JoinOperator) Values added in v1.2.0 

func (JoinOperator) Values() []JoinOperator

Values returns all known values for JoinOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JoinRequiredOption 

type JoinRequiredOption string
const (
	JoinRequiredOptionQueryRunner JoinRequiredOption = "QUERY_RUNNER"
)

Enum values for JoinRequiredOption

func (JoinRequiredOption) Values 

func (JoinRequiredOption) Values() []JoinRequiredOption

Values returns all known values for JoinRequiredOption. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MLMemberAbilities added in v1.20.0 

type MLMemberAbilities struct {

	// The custom ML member abilities for a collaboration member.
	//
	// This member is required.
	CustomMLMemberAbilities []CustomMLMemberAbility
	// contains filtered or unexported fields
}

The ML member abilities for a collaboration member.

type MLPaymentConfig added in v1.20.0 

type MLPaymentConfig struct {

	// The payment responsibilities accepted by the member for model inference.
	ModelInference *ModelInferencePaymentConfig

	// The payment responsibilities accepted by the member for model training.
	ModelTraining *ModelTrainingPaymentConfig
	// contains filtered or unexported fields
}

An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.

type MemberAbility 

type MemberAbility string
const (
	MemberAbilityCanQuery          MemberAbility = "CAN_QUERY"
	MemberAbilityCanReceiveResults MemberAbility = "CAN_RECEIVE_RESULTS"
	MemberAbilityCanRunJob         MemberAbility = "CAN_RUN_JOB"
)

Enum values for MemberAbility

func (MemberAbility) Values 

func (MemberAbility) Values() []MemberAbility

Values returns all known values for MemberAbility. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MemberChangeSpecification added in v1.33.1 

type MemberChangeSpecification struct {

	// The Amazon Web Services account ID of the member to add to the collaboration.
	//
	// This member is required.
	AccountId *string

	// The abilities granted to the collaboration member. These determine what actions
	// the member can perform within the collaboration.
	//
	// The following values are currently not supported: CAN_QUERY ,
	// CAN_RECEIVE_RESULTS, and CAN_RUN_JOB .
	//
	// Set the value of memberAbilities to [] to allow a member to contribute data.
	//
	// This member is required.
	MemberAbilities []MemberAbility

	// Specifies the display name that will be shown for this member in the
	// collaboration. While this field is required when inviting new members, it
	// becomes optional when modifying abilities of existing collaboration members.
	DisplayName *string
	// contains filtered or unexported fields
}

Specifies changes to collaboration membership, including adding new members with their abilities and display names.

type MemberSpecification 

type MemberSpecification struct {

	// The identifier used to reference members of the collaboration. Currently only
	// supports Amazon Web Services account ID.
	//
	// This member is required.
	AccountId *string

	// The member's display name.
	//
	// This member is required.
	DisplayName *string

	// The abilities granted to the collaboration member.
	//
	// This member is required.
	MemberAbilities []MemberAbility

	// The ML abilities granted to the collaboration member.
	MlMemberAbilities *MLMemberAbilities

	// 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.
	PaymentConfiguration *PaymentConfiguration
	// contains filtered or unexported fields
}

Basic metadata used to construct a new member.

type MemberStatus 

type MemberStatus string
const (
	MemberStatusInvited MemberStatus = "INVITED"
	MemberStatusActive  MemberStatus = "ACTIVE"
	MemberStatusLeft    MemberStatus = "LEFT"
	MemberStatusRemoved MemberStatus = "REMOVED"
)

Enum values for MemberStatus

func (MemberStatus) Values 

func (MemberStatus) Values() []MemberStatus

Values returns all known values for MemberStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MemberSummary 

type MemberSummary struct {

	// The abilities granted to the collaboration member.
	//
	// This member is required.
	Abilities []MemberAbility

	// The identifier used to reference members of the collaboration. Currently only
	// supports Amazon Web Services account ID.
	//
	// This member is required.
	AccountId *string

	// The time when the member was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The member's display name.
	//
	// This member is required.
	DisplayName *string

	// The collaboration member's payment responsibilities set by the collaboration
	// creator.
	//
	// This member is required.
	PaymentConfiguration *PaymentConfiguration

	// The status of the member.
	//
	// This member is required.
	Status MemberStatus

	// The time the member metadata was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The unique ARN for the member's associated membership, if present.
	MembershipArn *string

	// The unique ID for the member's associated membership, if present.
	MembershipId *string

	// Provides a summary of the ML abilities for the collaboration member.
	MlAbilities *MLMemberAbilities
	// contains filtered or unexported fields
}

The member object listed by the request.

type Membership 

type Membership struct {

	// The unique ARN for the membership.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the membership's associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// The identifier used to reference members of the collaboration. Currently only
	// supports Amazon Web Services account ID.
	//
	// This member is required.
	CollaborationCreatorAccountId *string

	// The display name of the collaboration creator.
	//
	// This member is required.
	CollaborationCreatorDisplayName *string

	// The unique ID for the membership's collaboration.
	//
	// This member is required.
	CollaborationId *string

	// The name of the membership's collaboration.
	//
	// This member is required.
	CollaborationName *string

	// The time when the membership was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique ID of the membership.
	//
	// This member is required.
	Id *string

	// The abilities granted to the collaboration member.
	//
	// This member is required.
	MemberAbilities []MemberAbility

	// The payment responsibilities accepted by the collaboration member.
	//
	// This member is required.
	PaymentConfiguration *MembershipPaymentConfiguration

	// An indicator as to whether query logging has been enabled or disabled for the
	// membership.
	//
	// When ENABLED , Clean Rooms logs details about queries run within this
	// collaboration and those logs can be viewed in Amazon CloudWatch Logs. The
	// default value is DISABLED .
	//
	// This member is required.
	QueryLogStatus MembershipQueryLogStatus

	// The status of the membership.
	//
	// This member is required.
	Status MembershipStatus

	// The time the membership metadata was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	//  The default job result configuration for the membership.
	DefaultJobResultConfiguration *MembershipProtectedJobResultConfiguration

	// The default protected query result configuration as specified by the member who
	// can receive results.
	DefaultResultConfiguration *MembershipProtectedQueryResultConfiguration

	// An indicator as to whether job logging has been enabled or disabled for the
	// collaboration.
	//
	// When ENABLED , Clean Rooms logs details about jobs run within this collaboration
	// and those logs can be viewed in Amazon CloudWatch Logs. The default value is
	// DISABLED .
	JobLogStatus MembershipJobLogStatus

	// Specifies the ML member abilities that are granted to a collaboration member.
	MlMemberAbilities *MLMemberAbilities
	// contains filtered or unexported fields
}

The membership object.

type MembershipJobComputePaymentConfig added in v1.23.0 

type MembershipJobComputePaymentConfig struct {

	// Indicates whether the collaboration member has accepted to pay for job compute
	// costs ( TRUE ) or has not accepted to pay for query and job compute costs ( FALSE
	// ).
	//
	// There is only one member who pays for queries and jobs.
	//
	// An error message is returned for the following reasons:
	//
	//   - If you set the value to FALSE but you are responsible to pay for query and
	//   job compute costs.
	//
	//   - If you set the value to TRUE but you are not responsible to pay for query
	//   and job compute costs.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.

type MembershipJobLogStatus added in v1.23.0 

type MembershipJobLogStatus string
const (
	MembershipJobLogStatusEnabled  MembershipJobLogStatus = "ENABLED"
	MembershipJobLogStatusDisabled MembershipJobLogStatus = "DISABLED"
)

Enum values for MembershipJobLogStatus

func (MembershipJobLogStatus) Values added in v1.23.0 

func (MembershipJobLogStatus) Values() []MembershipJobLogStatus

Values returns all known values for MembershipJobLogStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MembershipMLPaymentConfig added in v1.20.0 

type MembershipMLPaymentConfig struct {

	// The payment responsibilities accepted by the member for model inference.
	ModelInference *MembershipModelInferencePaymentConfig

	// The payment responsibilities accepted by the member for model training.
	ModelTraining *MembershipModelTrainingPaymentConfig
	// contains filtered or unexported fields
}

An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.

type MembershipModelInferencePaymentConfig added in v1.20.0 

type MembershipModelInferencePaymentConfig struct {

	// Indicates whether the collaboration member has accepted to pay for model
	// inference costs ( TRUE ) or has not accepted to pay for model inference costs (
	// FALSE ).
	//
	// If the collaboration creator has not specified anyone to pay for model
	// inference 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 model
	//   inference costs.
	//
	//   - If you set the value to TRUE but you are not responsible to pay for model
	//   inference costs.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.

type MembershipModelTrainingPaymentConfig added in v1.20.0 

type MembershipModelTrainingPaymentConfig struct {

	// Indicates whether the collaboration member has accepted to pay for model
	// training costs ( TRUE ) or has not accepted to pay for model training costs (
	// FALSE ).
	//
	// If the collaboration creator has not specified anyone to pay for model training
	// 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 model
	//   training costs.
	//
	//   - If you set the value to TRUE but you are not responsible to pay for model
	//   training costs.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.

type MembershipPaymentConfiguration added in v1.7.0 

type MembershipPaymentConfiguration struct {

	// The payment responsibilities accepted by the collaboration member for query
	// compute costs.
	//
	// This member is required.
	QueryCompute *MembershipQueryComputePaymentConfig

	// The payment responsibilities accepted by the collaboration member for job
	// compute costs.
	JobCompute *MembershipJobComputePaymentConfig

	// The payment responsibilities accepted by the collaboration member for machine
	// learning costs.
	MachineLearning *MembershipMLPaymentConfig
	// contains filtered or unexported fields
}

An object representing the payment responsibilities accepted by the collaboration member.

type MembershipProtectedJobOutputConfiguration added in v1.23.0 

type MembershipProtectedJobOutputConfiguration interface {
	// contains filtered or unexported methods
}

Contains configurations for protected job results.

The following types satisfy this interface: 

MembershipProtectedJobOutputConfigurationMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.MembershipProtectedJobOutputConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.MembershipProtectedJobOutputConfigurationMemberS3:
		_ = v.Value // Value is types.ProtectedJobS3OutputConfigurationInput

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type MembershipProtectedJobOutputConfigurationMemberS3 added in v1.23.0 

type MembershipProtectedJobOutputConfigurationMemberS3 struct {
	Value ProtectedJobS3OutputConfigurationInput
	// contains filtered or unexported fields
}

Contains the configuration to write the job results to S3.

type MembershipProtectedJobResultConfiguration added in v1.23.0 

type MembershipProtectedJobResultConfiguration struct {

	//  The output configuration for a protected job result.
	//
	// This member is required.
	OutputConfiguration MembershipProtectedJobOutputConfiguration

	// The unique ARN for an IAM role that is used by Clean Rooms to write protected
	// job results to the result location, given by the member who can receive results.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

Contains configurations for protected job results.

type MembershipProtectedQueryOutputConfiguration added in v1.4.0 

type MembershipProtectedQueryOutputConfiguration interface {
	// contains filtered or unexported methods
}

Contains configurations for protected query results.

The following types satisfy this interface: 

MembershipProtectedQueryOutputConfigurationMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.MembershipProtectedQueryOutputConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.MembershipProtectedQueryOutputConfigurationMemberS3:
		_ = v.Value // Value is types.ProtectedQueryS3OutputConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type MembershipProtectedQueryOutputConfigurationMemberS3 added in v1.4.0 

type MembershipProtectedQueryOutputConfigurationMemberS3 struct {
	Value ProtectedQueryS3OutputConfiguration
	// contains filtered or unexported fields
}

Contains the configuration to write the query results to S3.

type MembershipProtectedQueryResultConfiguration added in v1.4.0 

type MembershipProtectedQueryResultConfiguration struct {

	// Configuration for protected query results.
	//
	// This member is required.
	OutputConfiguration MembershipProtectedQueryOutputConfiguration

	// 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.
	RoleArn *string
	// contains filtered or unexported fields
}

Contains configurations for protected query results.

type MembershipQueryComputePaymentConfig added in v1.7.0 

type MembershipQueryComputePaymentConfig struct {

	// 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.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the payment responsibilities accepted by the collaboration member for query compute costs.

type MembershipQueryLogStatus 

type MembershipQueryLogStatus string
const (
	MembershipQueryLogStatusEnabled  MembershipQueryLogStatus = "ENABLED"
	MembershipQueryLogStatusDisabled MembershipQueryLogStatus = "DISABLED"
)

Enum values for MembershipQueryLogStatus

func (MembershipQueryLogStatus) Values 

func (MembershipQueryLogStatus) Values() []MembershipQueryLogStatus

Values returns all known values for MembershipQueryLogStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MembershipStatus 

type MembershipStatus string
const (
	MembershipStatusActive               MembershipStatus = "ACTIVE"
	MembershipStatusRemoved              MembershipStatus = "REMOVED"
	MembershipStatusCollaborationDeleted MembershipStatus = "COLLABORATION_DELETED"
)

Enum values for MembershipStatus

func (MembershipStatus) Values 

func (MembershipStatus) Values() []MembershipStatus

Values returns all known values for MembershipStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MembershipSummary 

type MembershipSummary struct {

	// The unique ARN for the membership.
	//
	// This member is required.
	Arn *string

	// The unique ARN for the membership's associated collaboration.
	//
	// This member is required.
	CollaborationArn *string

	// The identifier of the Amazon Web Services principal that created the
	// collaboration. Currently only supports Amazon Web Services account ID.
	//
	// This member is required.
	CollaborationCreatorAccountId *string

	// The display name of the collaboration creator.
	//
	// This member is required.
	CollaborationCreatorDisplayName *string

	// The unique ID for the membership's collaboration.
	//
	// This member is required.
	CollaborationId *string

	// The name for the membership's collaboration.
	//
	// This member is required.
	CollaborationName *string

	// The time when the membership was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique ID for the membership's collaboration.
	//
	// This member is required.
	Id *string

	// The abilities granted to the collaboration member.
	//
	// This member is required.
	MemberAbilities []MemberAbility

	// The payment responsibilities accepted by the collaboration member.
	//
	// This member is required.
	PaymentConfiguration *MembershipPaymentConfiguration

	// The status of the membership.
	//
	// This member is required.
	Status MembershipStatus

	// The time the membership metadata was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// Provides a summary of the ML abilities for the collaboration member.
	MlMemberAbilities *MLMemberAbilities
	// contains filtered or unexported fields
}

The membership object listed by the request.

type ModelInferencePaymentConfig added in v1.20.0 

type ModelInferencePaymentConfig struct {

	// Indicates whether the collaboration creator has configured the collaboration
	// member to pay for model inference costs ( TRUE ) or has not configured the
	// collaboration member to pay for model inference costs ( FALSE ).
	//
	// Exactly one member can be configured to pay for model inference 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
	// model inference 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.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.

type ModelTrainingPaymentConfig added in v1.20.0 

type ModelTrainingPaymentConfig struct {

	// Indicates whether the collaboration creator has configured the collaboration
	// member to pay for model training costs ( TRUE ) or has not configured the
	// collaboration member to pay for model training costs ( FALSE ).
	//
	// Exactly one member can be configured to pay for model training 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
	// model training 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.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.

type ParameterType added in v1.3.0 

type ParameterType string
const (
	ParameterTypeSmallint        ParameterType = "SMALLINT"
	ParameterTypeInteger         ParameterType = "INTEGER"
	ParameterTypeBigint          ParameterType = "BIGINT"
	ParameterTypeDecimal         ParameterType = "DECIMAL"
	ParameterTypeReal            ParameterType = "REAL"
	ParameterTypeDoublePrecision ParameterType = "DOUBLE_PRECISION"
	ParameterTypeBoolean         ParameterType = "BOOLEAN"
	ParameterTypeChar            ParameterType = "CHAR"
	ParameterTypeVarchar         ParameterType = "VARCHAR"
	ParameterTypeDate            ParameterType = "DATE"
	ParameterTypeTimestamp       ParameterType = "TIMESTAMP"
	ParameterTypeTimestamptz     ParameterType = "TIMESTAMPTZ"
	ParameterTypeTime            ParameterType = "TIME"
	ParameterTypeTimetz          ParameterType = "TIMETZ"
	ParameterTypeVarbyte         ParameterType = "VARBYTE"
	ParameterTypeBinary          ParameterType = "BINARY"
	ParameterTypeByte            ParameterType = "BYTE"
	ParameterTypeCharacter       ParameterType = "CHARACTER"
	ParameterTypeDouble          ParameterType = "DOUBLE"
	ParameterTypeFloat           ParameterType = "FLOAT"
	ParameterTypeInt             ParameterType = "INT"
	ParameterTypeLong            ParameterType = "LONG"
	ParameterTypeNumeric         ParameterType = "NUMERIC"
	ParameterTypeShort           ParameterType = "SHORT"
	ParameterTypeString          ParameterType = "STRING"
	ParameterTypeTimestampLtz    ParameterType = "TIMESTAMP_LTZ"
	ParameterTypeTimestampNtz    ParameterType = "TIMESTAMP_NTZ"
	ParameterTypeTinyint         ParameterType = "TINYINT"
)

Enum values for ParameterType

func (ParameterType) Values added in v1.3.0 

func (ParameterType) Values() []ParameterType

Values returns all known values for ParameterType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PaymentConfiguration added in v1.7.0 

type PaymentConfiguration struct {

	// The collaboration member's payment responsibilities set by the collaboration
	// creator for query compute costs.
	//
	// This member is required.
	QueryCompute *QueryComputePaymentConfig

	//  The compute configuration for the job.
	JobCompute *JobComputePaymentConfig

	// An object representing the collaboration member's machine learning payment
	// responsibilities set by the collaboration creator.
	MachineLearning *MLPaymentConfig
	// contains filtered or unexported fields
}

An object representing the collaboration member's payment responsibilities set by the collaboration creator.

type PreviewPrivacyImpactParametersInput added in v1.8.0 

type PreviewPrivacyImpactParametersInput interface {
	// contains filtered or unexported methods
}

Specifies the updated epsilon and noise parameters to preview. The preview allows you to see how the maximum number of each type of aggregation function would change with the new parameters.

The following types satisfy this interface: 

PreviewPrivacyImpactParametersInputMemberDifferentialPrivacy
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.PreviewPrivacyImpactParametersInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PreviewPrivacyImpactParametersInputMemberDifferentialPrivacy:
		_ = v.Value // Value is types.DifferentialPrivacyPreviewParametersInput

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type PreviewPrivacyImpactParametersInputMemberDifferentialPrivacy added in v1.8.0 

type PreviewPrivacyImpactParametersInputMemberDifferentialPrivacy struct {
	Value DifferentialPrivacyPreviewParametersInput
	// contains filtered or unexported fields
}

An array that specifies the epsilon and noise parameters.

type PrivacyBudget added in v1.8.0 

type PrivacyBudget interface {
	// contains filtered or unexported methods
}

The epsilon parameter value and number of each aggregation function that you can perform.

The following types satisfy this interface: 

PrivacyBudgetMemberDifferentialPrivacy
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.PrivacyBudget
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PrivacyBudgetMemberDifferentialPrivacy:
		_ = v.Value // Value is types.DifferentialPrivacyPrivacyBudget

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type PrivacyBudgetMemberDifferentialPrivacy added in v1.8.0 

type PrivacyBudgetMemberDifferentialPrivacy struct {
	Value DifferentialPrivacyPrivacyBudget
	// contains filtered or unexported fields
}

An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.

type PrivacyBudgetSummary added in v1.8.0 

type PrivacyBudgetSummary struct {

	// The provided privacy budget.
	//
	// This member is required.
	Budget PrivacyBudget

	// The ARN of the collaboration that contains this privacy budget.
	//
	// This member is required.
	CollaborationArn *string

	// The unique identifier of the collaboration that contains this privacy budget.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the privacy budget was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the privacy budget.
	//
	// This member is required.
	Id *string

	// The Amazon Resource Name (ARN) of the member who created the privacy budget
	// summary.
	//
	// This member is required.
	MembershipArn *string

	// The identifier for a membership resource.
	//
	// This member is required.
	MembershipId *string

	// The ARN of the privacy budget template.
	//
	// This member is required.
	PrivacyBudgetTemplateArn *string

	// The unique identifier of the privacy budget template.
	//
	// This member is required.
	PrivacyBudgetTemplateId *string

	// Specifies the type of the privacy budget.
	//
	// This member is required.
	Type PrivacyBudgetType

	// The most recent time at which the privacy budget was updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

An array that summaries the specified privacy budget. This summary includes collaboration information, creation information, membership information, and privacy budget information.

type PrivacyBudgetTemplate added in v1.8.0 

type PrivacyBudgetTemplate struct {

	// The ARN of the privacy budget template.
	//
	// This member is required.
	Arn *string

	// 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.
	//
	// This member is required.
	AutoRefresh PrivacyBudgetTemplateAutoRefresh

	// The ARN of the collaboration that contains this privacy budget template.
	//
	// This member is required.
	CollaborationArn *string

	// The unique ID of the collaboration that contains this privacy budget template.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the privacy budget template was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the privacy budget template.
	//
	// This member is required.
	Id *string

	// The Amazon Resource Name (ARN) of the member who created the privacy budget
	// template.
	//
	// This member is required.
	MembershipArn *string

	// The identifier for a membership resource.
	//
	// This member is required.
	MembershipId *string

	// Specifies the epsilon and noise parameters for the privacy budget template.
	//
	// This member is required.
	Parameters PrivacyBudgetTemplateParametersOutput

	// Specifies the type of the privacy budget template.
	//
	// This member is required.
	PrivacyBudgetType PrivacyBudgetType

	// The most recent time at which the privacy budget template was updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

An object that defines the privacy budget template.

type PrivacyBudgetTemplateAutoRefresh added in v1.8.0 

type PrivacyBudgetTemplateAutoRefresh string
const (
	PrivacyBudgetTemplateAutoRefreshCalendarMonth PrivacyBudgetTemplateAutoRefresh = "CALENDAR_MONTH"
	PrivacyBudgetTemplateAutoRefreshNone          PrivacyBudgetTemplateAutoRefresh = "NONE"
)

Enum values for PrivacyBudgetTemplateAutoRefresh

func (PrivacyBudgetTemplateAutoRefresh) Values added in v1.8.0 

func (PrivacyBudgetTemplateAutoRefresh) Values() []PrivacyBudgetTemplateAutoRefresh

Values returns all known values for PrivacyBudgetTemplateAutoRefresh. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PrivacyBudgetTemplateParametersInput added in v1.8.0 

type PrivacyBudgetTemplateParametersInput interface {
	// contains filtered or unexported methods
}

The epsilon and noise parameters that you want to use for the privacy budget template.

The following types satisfy this interface: 

PrivacyBudgetTemplateParametersInputMemberDifferentialPrivacy
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.PrivacyBudgetTemplateParametersInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PrivacyBudgetTemplateParametersInputMemberDifferentialPrivacy:
		_ = v.Value // Value is types.DifferentialPrivacyTemplateParametersInput

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type PrivacyBudgetTemplateParametersInputMemberDifferentialPrivacy added in v1.8.0 

type PrivacyBudgetTemplateParametersInputMemberDifferentialPrivacy struct {
	Value DifferentialPrivacyTemplateParametersInput
	// contains filtered or unexported fields
}

An object that specifies the epsilon and noise parameters.

type PrivacyBudgetTemplateParametersOutput added in v1.8.0 

type PrivacyBudgetTemplateParametersOutput interface {
	// contains filtered or unexported methods
}

The epsilon and noise parameters that were used in the privacy budget template.

The following types satisfy this interface: 

PrivacyBudgetTemplateParametersOutputMemberDifferentialPrivacy
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.PrivacyBudgetTemplateParametersOutput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PrivacyBudgetTemplateParametersOutputMemberDifferentialPrivacy:
		_ = v.Value // Value is types.DifferentialPrivacyTemplateParametersOutput

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type PrivacyBudgetTemplateParametersOutputMemberDifferentialPrivacy added in v1.8.0 

type PrivacyBudgetTemplateParametersOutputMemberDifferentialPrivacy struct {
	Value DifferentialPrivacyTemplateParametersOutput
	// contains filtered or unexported fields
}

The epsilon and noise parameters.

type PrivacyBudgetTemplateSummary added in v1.8.0 

type PrivacyBudgetTemplateSummary struct {

	// The ARN of the privacy budget template.
	//
	// This member is required.
	Arn *string

	// The ARN of the collaboration that contains this privacy budget template.
	//
	// This member is required.
	CollaborationArn *string

	// The unique ID of the collaboration that contains this privacy budget template.
	//
	// This member is required.
	CollaborationId *string

	// The time at which the privacy budget template was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique identifier of the privacy budget template.
	//
	// This member is required.
	Id *string

	// The Amazon Resource Name (ARN) of the member who created the privacy budget
	// template.
	//
	// This member is required.
	MembershipArn *string

	// The identifier for a membership resource.
	//
	// This member is required.
	MembershipId *string

	// The type of the privacy budget template.
	//
	// This member is required.
	PrivacyBudgetType PrivacyBudgetType

	// The most recent time at which the privacy budget template was updated.
	//
	// This member is required.
	UpdateTime *time.Time
	// contains filtered or unexported fields
}

A summary of the privacy budget template. The summary includes membership information, collaboration information, and creation information.

type PrivacyBudgetTemplateUpdateParameters added in v1.8.0 

type PrivacyBudgetTemplateUpdateParameters interface {
	// contains filtered or unexported methods
}

The epsilon and noise parameters that you want to update in the privacy budget template.

The following types satisfy this interface: 

PrivacyBudgetTemplateUpdateParametersMemberDifferentialPrivacy
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.PrivacyBudgetTemplateUpdateParameters
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PrivacyBudgetTemplateUpdateParametersMemberDifferentialPrivacy:
		_ = v.Value // Value is types.DifferentialPrivacyTemplateUpdateParameters

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type PrivacyBudgetTemplateUpdateParametersMemberDifferentialPrivacy added in v1.8.0 

type PrivacyBudgetTemplateUpdateParametersMemberDifferentialPrivacy struct {
	Value DifferentialPrivacyTemplateUpdateParameters
	// contains filtered or unexported fields
}

An object that specifies the new values for the epsilon and noise parameters.

type PrivacyBudgetType added in v1.8.0 

type PrivacyBudgetType string
const (
	PrivacyBudgetTypeDifferentialPrivacy PrivacyBudgetType = "DIFFERENTIAL_PRIVACY"
)

Enum values for PrivacyBudgetType

func (PrivacyBudgetType) Values added in v1.8.0 

func (PrivacyBudgetType) Values() []PrivacyBudgetType

Values returns all known values for PrivacyBudgetType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PrivacyImpact added in v1.8.0 

type PrivacyImpact interface {
	// contains filtered or unexported methods
}

Provides an estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters.

The following types satisfy this interface: 

PrivacyImpactMemberDifferentialPrivacy
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.PrivacyImpact
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PrivacyImpactMemberDifferentialPrivacy:
		_ = v.Value // Value is types.DifferentialPrivacyPrivacyImpact

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type PrivacyImpactMemberDifferentialPrivacy added in v1.8.0 

type PrivacyImpactMemberDifferentialPrivacy struct {
	Value DifferentialPrivacyPrivacyImpact
	// contains filtered or unexported fields
}

An object that lists the number and type of aggregation functions you can perform.

type ProtectedJob added in v1.23.0 

type ProtectedJob struct {

	//  The creation time of the protected job.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier for a protected job instance.
	//
	// This member is required.
	Id *string

	// The ARN of the membership.
	//
	// This member is required.
	MembershipArn *string

	// he identifier for the membership.
	//
	// This member is required.
	MembershipId *string

	//  The status of the protected job.
	//
	// This member is required.
	Status ProtectedJobStatus

	// The compute configuration for the protected job.
	ComputeConfiguration ProtectedJobComputeConfiguration

	//  The error from the protected job.
	Error *ProtectedJobError

	//  The job parameters for the protected job.
	JobParameters *ProtectedJobParameters

	//  The result of the protected job.
	Result *ProtectedJobResult

	// Contains any details needed to write the job results.
	ResultConfiguration *ProtectedJobResultConfigurationOutput

	//  The statistics of the protected job.
	Statistics *ProtectedJobStatistics
	// contains filtered or unexported fields
}

The parameters for an Clean Rooms protected job.

type ProtectedJobAnalysisType added in v1.23.0 

type ProtectedJobAnalysisType string
const (
	ProtectedJobAnalysisTypeDirectAnalysis ProtectedJobAnalysisType = "DIRECT_ANALYSIS"
)

Enum values for ProtectedJobAnalysisType

func (ProtectedJobAnalysisType) Values added in v1.23.0 

func (ProtectedJobAnalysisType) Values() []ProtectedJobAnalysisType

Values returns all known values for ProtectedJobAnalysisType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectedJobComputeConfiguration added in v1.33.1 

type ProtectedJobComputeConfiguration interface {
	// contains filtered or unexported methods
}

The configuration of the compute resources for a PySpark job.

The following types satisfy this interface: 

ProtectedJobComputeConfigurationMemberWorker
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedJobComputeConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedJobComputeConfigurationMemberWorker:
		_ = v.Value // Value is types.ProtectedJobWorkerComputeConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedJobComputeConfigurationMemberWorker added in v1.33.1 

type ProtectedJobComputeConfigurationMemberWorker struct {
	Value ProtectedJobWorkerComputeConfiguration
	// contains filtered or unexported fields
}

The worker configuration for the compute environment.

type ProtectedJobConfigurationDetails added in v1.23.0 

type ProtectedJobConfigurationDetails interface {
	// contains filtered or unexported methods
}

The protected job configuration details.

The following types satisfy this interface: 

ProtectedJobConfigurationDetailsMemberDirectAnalysisConfigurationDetails
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedJobConfigurationDetails
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedJobConfigurationDetailsMemberDirectAnalysisConfigurationDetails:
		_ = v.Value // Value is types.ProtectedJobDirectAnalysisConfigurationDetails

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedJobConfigurationDetailsMemberDirectAnalysisConfigurationDetails added in v1.23.0 

type ProtectedJobConfigurationDetailsMemberDirectAnalysisConfigurationDetails struct {
	Value ProtectedJobDirectAnalysisConfigurationDetails
	// contains filtered or unexported fields
}

The details needed to configure the direct analysis.

type ProtectedJobDirectAnalysisConfigurationDetails added in v1.23.0 

type ProtectedJobDirectAnalysisConfigurationDetails struct {

	//  The receiver account IDs.
	ReceiverAccountIds []string
	// contains filtered or unexported fields
}

The protected job direct analysis configuration details.

type ProtectedJobError added in v1.23.0 

type ProtectedJobError struct {

	//  The error code for the protected job.
	//
	// This member is required.
	Code *string

	//  The message for the protected job error.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

The protected job error.

type ProtectedJobMemberOutputConfigurationInput added in v1.23.0 

type ProtectedJobMemberOutputConfigurationInput struct {

	//  The account ID.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

The protected job member output configuration input.

type ProtectedJobMemberOutputConfigurationOutput added in v1.23.0 

type ProtectedJobMemberOutputConfigurationOutput struct {

	//  The account ID.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

The protected job member output configuration output.

type ProtectedJobOutput added in v1.23.0 

type ProtectedJobOutput interface {
	// contains filtered or unexported methods
}

Contains details about the protected job output.

The following types satisfy this interface: 

ProtectedJobOutputMemberMemberList
ProtectedJobOutputMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedJobOutput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedJobOutputMemberMemberList:
		_ = v.Value // Value is []types.ProtectedJobSingleMemberOutput

	case *types.ProtectedJobOutputMemberS3:
		_ = v.Value // Value is types.ProtectedJobS3Output

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedJobOutputConfigurationInput added in v1.23.0 

type ProtectedJobOutputConfigurationInput interface {
	// contains filtered or unexported methods
}
The protected job output configuration input.

The following types satisfy this interface: 

ProtectedJobOutputConfigurationInputMemberMember
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedJobOutputConfigurationInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedJobOutputConfigurationInputMemberMember:
		_ = v.Value // Value is types.ProtectedJobMemberOutputConfigurationInput

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedJobOutputConfigurationInputMemberMember added in v1.23.0 

type ProtectedJobOutputConfigurationInputMemberMember struct {
	Value ProtectedJobMemberOutputConfigurationInput
	// contains filtered or unexported fields
}

The member of the protected job output configuration input.

type ProtectedJobOutputConfigurationOutput added in v1.23.0 

type ProtectedJobOutputConfigurationOutput interface {
	// contains filtered or unexported methods
}
The protected job output configuration output.

The following types satisfy this interface: 

ProtectedJobOutputConfigurationOutputMemberMember
ProtectedJobOutputConfigurationOutputMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedJobOutputConfigurationOutput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedJobOutputConfigurationOutputMemberMember:
		_ = v.Value // Value is types.ProtectedJobMemberOutputConfigurationOutput

	case *types.ProtectedJobOutputConfigurationOutputMemberS3:
		_ = v.Value // Value is types.ProtectedJobS3OutputConfigurationOutput

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedJobOutputConfigurationOutputMemberMember added in v1.23.0 

type ProtectedJobOutputConfigurationOutputMemberMember struct {
	Value ProtectedJobMemberOutputConfigurationOutput
	// contains filtered or unexported fields
}

The member output configuration for a protected job.

type ProtectedJobOutputConfigurationOutputMemberS3 added in v1.23.0 

type ProtectedJobOutputConfigurationOutputMemberS3 struct {
	Value ProtectedJobS3OutputConfigurationOutput
	// contains filtered or unexported fields
}

If present, the output for a protected job with an `S3` output type.

type ProtectedJobOutputMemberMemberList added in v1.23.0 

type ProtectedJobOutputMemberMemberList struct {
	Value []ProtectedJobSingleMemberOutput
	// contains filtered or unexported fields
}

The list of member Amazon Web Services account(s) that received the results of the job.

type ProtectedJobOutputMemberS3 added in v1.23.0 

type ProtectedJobOutputMemberS3 struct {
	Value ProtectedJobS3Output
	// contains filtered or unexported fields
}

If present, the output for a protected job with an `S3` output type.

type ProtectedJobParameters added in v1.23.0 

type ProtectedJobParameters struct {

	//  The ARN of the analysis template.
	AnalysisTemplateArn *string
	// contains filtered or unexported fields
}

The parameters for the protected job.

type ProtectedJobReceiverConfiguration added in v1.23.0 

type ProtectedJobReceiverConfiguration struct {

	//  The analysis type for the protected job receiver configuration.
	//
	// This member is required.
	AnalysisType ProtectedJobAnalysisType

	//  The configuration details for the protected job receiver.
	ConfigurationDetails ProtectedJobConfigurationDetails
	// contains filtered or unexported fields
}

The protected job receiver configuration.

type ProtectedJobResult added in v1.23.0 

type ProtectedJobResult struct {

	//  The output of the protected job.
	//
	// This member is required.
	Output ProtectedJobOutput
	// contains filtered or unexported fields
}

Details about the job results.

type ProtectedJobResultConfigurationInput added in v1.23.0 

type ProtectedJobResultConfigurationInput struct {

	//  The output configuration for a protected job result.
	//
	// This member is required.
	OutputConfiguration ProtectedJobOutputConfigurationInput
	// contains filtered or unexported fields
}

The protected job result configuration input.

type ProtectedJobResultConfigurationOutput added in v1.23.0 

type ProtectedJobResultConfigurationOutput struct {

	// The output configuration.
	//
	// This member is required.
	OutputConfiguration ProtectedJobOutputConfigurationOutput
	// contains filtered or unexported fields
}

The output configuration for a protected job result.

type ProtectedJobS3Output added in v1.23.0 

type ProtectedJobS3Output struct {

	//  The S3 location for the protected job output.
	//
	// This member is required.
	Location *string
	// contains filtered or unexported fields
}

Contains output information for protected jobs with an S3 output type.

type ProtectedJobS3OutputConfigurationInput added in v1.23.0 

type ProtectedJobS3OutputConfigurationInput struct {

	//  The S3 bucket for job output.
	//
	// This member is required.
	Bucket *string

	// The S3 prefix to unload the protected job results.
	KeyPrefix *string
	// contains filtered or unexported fields
}

Contains input information for protected jobs with an S3 output type.

type ProtectedJobS3OutputConfigurationOutput added in v1.23.0 

type ProtectedJobS3OutputConfigurationOutput struct {

	//  The S3 bucket for job output.
	//
	// This member is required.
	Bucket *string

	// The S3 prefix to unload the protected job results.
	KeyPrefix *string
	// contains filtered or unexported fields
}

The output configuration for a protected job's S3 output.

type ProtectedJobSingleMemberOutput added in v1.23.0 

type ProtectedJobSingleMemberOutput struct {

	// The Amazon Web Services account ID of the member in the collaboration who can
	// receive results from analyses.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

Details about the member who received the job result.

type ProtectedJobStatistics added in v1.23.0 

type ProtectedJobStatistics struct {

	//  The billed resource utilization for the protected job.
	BilledResourceUtilization *BilledJobResourceUtilization

	// The duration of the protected job, from creation until job completion, in
	// milliseconds.
	TotalDurationInMillis *int64
	// contains filtered or unexported fields
}

Contains statistics about the execution of the protected job.

type ProtectedJobStatus added in v1.23.0 

type ProtectedJobStatus string
const (
	ProtectedJobStatusSubmitted  ProtectedJobStatus = "SUBMITTED"
	ProtectedJobStatusStarted    ProtectedJobStatus = "STARTED"
	ProtectedJobStatusCancelled  ProtectedJobStatus = "CANCELLED"
	ProtectedJobStatusCancelling ProtectedJobStatus = "CANCELLING"
	ProtectedJobStatusFailed     ProtectedJobStatus = "FAILED"
	ProtectedJobStatusSuccess    ProtectedJobStatus = "SUCCESS"
)

Enum values for ProtectedJobStatus

func (ProtectedJobStatus) Values added in v1.23.0 

func (ProtectedJobStatus) Values() []ProtectedJobStatus

Values returns all known values for ProtectedJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectedJobSummary added in v1.23.0 

type ProtectedJobSummary struct {

	// The time the protected job was created.
	//
	// This member is required.
	CreateTime *time.Time

	//  The ID of the protected job.
	//
	// This member is required.
	Id *string

	// The unique ARN for the membership that initiated the protected job.
	//
	// This member is required.
	MembershipArn *string

	// The unique ID for the membership that initiated the protected job.
	//
	// This member is required.
	MembershipId *string

	//  The receiver configurations for the protected job.
	//
	// This member is required.
	ReceiverConfigurations []ProtectedJobReceiverConfiguration

	// The status of the protected job.
	//
	// This member is required.
	Status ProtectedJobStatus
	// contains filtered or unexported fields
}

The protected job summary for the objects listed by the request.

type ProtectedJobType added in v1.23.0 

type ProtectedJobType string
const (
	ProtectedJobTypePyspark ProtectedJobType = "PYSPARK"
)

Enum values for ProtectedJobType

func (ProtectedJobType) Values added in v1.23.0 

func (ProtectedJobType) Values() []ProtectedJobType

Values returns all known values for ProtectedJobType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectedJobWorkerComputeConfiguration added in v1.33.1 

type ProtectedJobWorkerComputeConfiguration struct {

	// The number of workers for a PySpark job.
	//
	// This member is required.
	Number *int32

	// The worker compute configuration type.
	//
	// This member is required.
	Type ProtectedJobWorkerComputeType
	// contains filtered or unexported fields
}

The configuration of the compute resources for a PySpark job.

type ProtectedJobWorkerComputeType added in v1.33.1 

type ProtectedJobWorkerComputeType string
const (
	ProtectedJobWorkerComputeTypeCr1x ProtectedJobWorkerComputeType = "CR.1X"
	ProtectedJobWorkerComputeTypeCr4x ProtectedJobWorkerComputeType = "CR.4X"
)

Enum values for ProtectedJobWorkerComputeType

func (ProtectedJobWorkerComputeType) Values added in v1.33.1 

func (ProtectedJobWorkerComputeType) Values() []ProtectedJobWorkerComputeType

Values returns all known values for ProtectedJobWorkerComputeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectedQuery 

type ProtectedQuery struct {

	// The time at which the protected query was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The identifier for a protected query instance.
	//
	// This member is required.
	Id *string

	// The ARN of the membership.
	//
	// This member is required.
	MembershipArn *string

	// The identifier for the membership.
	//
	// This member is required.
	MembershipId *string

	// The status of the query.
	//
	// This member is required.
	Status ProtectedQueryStatus

	//  The compute configuration for the protected query.
	ComputeConfiguration ComputeConfiguration

	// The sensitivity parameters of the differential privacy results of the protected
	// query.
	DifferentialPrivacy *DifferentialPrivacyParameters

	// An error thrown by the protected query.
	Error *ProtectedQueryError

	// The result of the protected query.
	Result *ProtectedQueryResult

	// Contains any details needed to write the query results.
	ResultConfiguration *ProtectedQueryResultConfiguration

	// The protected query SQL parameters.
	SqlParameters *ProtectedQuerySQLParameters

	// Statistics about protected query execution.
	Statistics *ProtectedQueryStatistics
	// contains filtered or unexported fields
}

The parameters for an Clean Rooms protected query.

type ProtectedQueryDistributeOutput added in v1.25.0 

type ProtectedQueryDistributeOutput struct {

	//  Contains the output results for each member location specified in the
	// distribute output configuration. Each entry provides details about the result
	// distribution to a specific collaboration member.
	MemberList []ProtectedQuerySingleMemberOutput

	// Contains output information for protected queries with an S3 output type.
	S3 *ProtectedQueryS3Output
	// contains filtered or unexported fields
}
Contains the output information for a protected query with a distribute output

configuration.

This output type allows query results to be distributed to multiple receivers, including S3 and collaboration members. It is only available for queries using the Spark analytics engine.

type ProtectedQueryDistributeOutputConfiguration added in v1.25.0 

type ProtectedQueryDistributeOutputConfiguration struct {

	//  A list of locations where you want to distribute the protected query results.
	// Each location must specify either an S3 destination or a collaboration member
	// destination.
	//
	// You can't specify more than one S3 location.
	//
	// You can't specify the query runner's account as a member location.
	//
	// You must include either an S3 or member output configuration for each location,
	// but not both.
	//
	// This member is required.
	Locations []ProtectedQueryDistributeOutputConfigurationLocation
	// contains filtered or unexported fields
}
Specifies the configuration for distributing protected query results to

multiple receivers, including S3 and collaboration members.

type ProtectedQueryDistributeOutputConfigurationLocation added in v1.25.0 

type ProtectedQueryDistributeOutputConfigurationLocation interface {
	// contains filtered or unexported methods
}
Specifies where you'll distribute the results of your protected query. You

must configure either an S3 destination or a collaboration member destination.

The following types satisfy this interface: 

ProtectedQueryDistributeOutputConfigurationLocationMemberMember
ProtectedQueryDistributeOutputConfigurationLocationMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedQueryDistributeOutputConfigurationLocation
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedQueryDistributeOutputConfigurationLocationMemberMember:
		_ = v.Value // Value is types.ProtectedQueryMemberOutputConfiguration

	case *types.ProtectedQueryDistributeOutputConfigurationLocationMemberS3:
		_ = v.Value // Value is types.ProtectedQueryS3OutputConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedQueryDistributeOutputConfigurationLocationMemberMember added in v1.25.0 

type ProtectedQueryDistributeOutputConfigurationLocationMemberMember struct {
	Value ProtectedQueryMemberOutputConfiguration
	// contains filtered or unexported fields
}

Contains configuration details for the protected query member output.

type ProtectedQueryDistributeOutputConfigurationLocationMemberS3 added in v1.25.0 

type ProtectedQueryDistributeOutputConfigurationLocationMemberS3 struct {
	Value ProtectedQueryS3OutputConfiguration
	// contains filtered or unexported fields
}

Contains the configuration to write the query results to S3.

type ProtectedQueryError 

type ProtectedQueryError struct {

	// An error code for the error.
	//
	// This member is required.
	Code *string

	// A description of why the query failed.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

Details of errors thrown by the protected query.

type ProtectedQueryMemberOutputConfiguration added in v1.16.0 

type ProtectedQueryMemberOutputConfiguration struct {

	// The unique identifier for the account.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

Contains configuration details for the protected query member output.

type ProtectedQueryOutput 

type ProtectedQueryOutput interface {
	// contains filtered or unexported methods
}

Contains details about the protected query output.

The following types satisfy this interface: 

ProtectedQueryOutputMemberDistribute
ProtectedQueryOutputMemberMemberList
ProtectedQueryOutputMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedQueryOutput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedQueryOutputMemberDistribute:
		_ = v.Value // Value is types.ProtectedQueryDistributeOutput

	case *types.ProtectedQueryOutputMemberMemberList:
		_ = v.Value // Value is []types.ProtectedQuerySingleMemberOutput

	case *types.ProtectedQueryOutputMemberS3:
		_ = v.Value // Value is types.ProtectedQueryS3Output

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedQueryOutputConfiguration 

type ProtectedQueryOutputConfiguration interface {
	// contains filtered or unexported methods
}

Contains configuration details for protected query output.

The following types satisfy this interface: 

ProtectedQueryOutputConfigurationMemberDistribute
ProtectedQueryOutputConfigurationMemberMember
ProtectedQueryOutputConfigurationMemberS3
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.ProtectedQueryOutputConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ProtectedQueryOutputConfigurationMemberDistribute:
		_ = v.Value // Value is types.ProtectedQueryDistributeOutputConfiguration

	case *types.ProtectedQueryOutputConfigurationMemberMember:
		_ = v.Value // Value is types.ProtectedQueryMemberOutputConfiguration

	case *types.ProtectedQueryOutputConfigurationMemberS3:
		_ = v.Value // Value is types.ProtectedQueryS3OutputConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ProtectedQueryOutputConfigurationMemberDistribute added in v1.25.0 

type ProtectedQueryOutputConfigurationMemberDistribute struct {
	Value ProtectedQueryDistributeOutputConfiguration
	// contains filtered or unexported fields
}

Required configuration for a protected query with a distribute output type.

type ProtectedQueryOutputConfigurationMemberMember added in v1.16.0 

type ProtectedQueryOutputConfigurationMemberMember struct {
	Value ProtectedQueryMemberOutputConfiguration
	// contains filtered or unexported fields
}

Required configuration for a protected query with a member output type.

type ProtectedQueryOutputConfigurationMemberS3 

type ProtectedQueryOutputConfigurationMemberS3 struct {
	Value ProtectedQueryS3OutputConfiguration
	// contains filtered or unexported fields
}

Required configuration for a protected query with an s3 output type.

type ProtectedQueryOutputMemberDistribute added in v1.25.0 

type ProtectedQueryOutputMemberDistribute struct {
	Value ProtectedQueryDistributeOutput
	// contains filtered or unexported fields
}

Contains output information for protected queries that use a distribute output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.

You can only use the distribute output type with the Spark analytics engine.

type ProtectedQueryOutputMemberMemberList added in v1.4.0 

type ProtectedQueryOutputMemberMemberList struct {
	Value []ProtectedQuerySingleMemberOutput
	// contains filtered or unexported fields
}

The list of member Amazon Web Services account(s) that received the results of the query.

type ProtectedQueryOutputMemberS3 

type ProtectedQueryOutputMemberS3 struct {
	Value ProtectedQueryS3Output
	// contains filtered or unexported fields
}

If present, the output for a protected query with an S3 output type.

type ProtectedQueryResult 

type ProtectedQueryResult struct {

	// The output of the protected query.
	//
	// This member is required.
	Output ProtectedQueryOutput
	// contains filtered or unexported fields
}

Details about the query results.

type ProtectedQueryResultConfiguration 

type ProtectedQueryResultConfiguration struct {

	// Configuration for protected query results.
	//
	// This member is required.
	OutputConfiguration ProtectedQueryOutputConfiguration
	// contains filtered or unexported fields
}

Contains configurations for protected query results.

type ProtectedQueryS3Output 

type ProtectedQueryS3Output struct {

	// The S3 location of the result.
	//
	// This member is required.
	Location *string
	// contains filtered or unexported fields
}

Contains output information for protected queries with an S3 output type.

type ProtectedQueryS3OutputConfiguration 

type ProtectedQueryS3OutputConfiguration struct {

	// The S3 bucket to unload the protected query results.
	//
	// This member is required.
	Bucket *string

	// Intended file format of the result.
	//
	// This member is required.
	ResultFormat ResultFormat

	// The S3 prefix to unload the protected query results.
	KeyPrefix *string

	// Indicates whether files should be output as a single file ( TRUE ) or output as
	// multiple files ( FALSE ). This parameter is only supported for analyses with the
	// Spark analytics engine.
	SingleFileOutput *bool
	// contains filtered or unexported fields
}

Contains the configuration to write the query results to S3.

type ProtectedQuerySQLParameters 

type ProtectedQuerySQLParameters struct {

	// The Amazon Resource Name (ARN) associated with the analysis template within a
	// collaboration.
	AnalysisTemplateArn *string

	// The protected query SQL parameters.
	Parameters map[string]string

	// The query string to be submitted.
	QueryString *string
	// contains filtered or unexported fields
}

The parameters for the SQL type Protected Query.

type ProtectedQuerySingleMemberOutput added in v1.4.0 

type ProtectedQuerySingleMemberOutput struct {

	// The Amazon Web Services account ID of the member in the collaboration who can
	// receive results for the query.
	//
	// This member is required.
	AccountId *string
	// contains filtered or unexported fields
}

Details about the member who received the query result.

type ProtectedQueryStatistics 

type ProtectedQueryStatistics struct {

	//  The billed resource utilization.
	BilledResourceUtilization *BilledResourceUtilization

	// The duration of the protected query, from creation until query completion, in
	// milliseconds.
	TotalDurationInMillis *int64
	// contains filtered or unexported fields
}

Contains statistics about the execution of the protected query.

type ProtectedQueryStatus 

type ProtectedQueryStatus string
const (
	ProtectedQueryStatusSubmitted  ProtectedQueryStatus = "SUBMITTED"
	ProtectedQueryStatusStarted    ProtectedQueryStatus = "STARTED"
	ProtectedQueryStatusCancelled  ProtectedQueryStatus = "CANCELLED"
	ProtectedQueryStatusCancelling ProtectedQueryStatus = "CANCELLING"
	ProtectedQueryStatusFailed     ProtectedQueryStatus = "FAILED"
	ProtectedQueryStatusSuccess    ProtectedQueryStatus = "SUCCESS"
	ProtectedQueryStatusTimedOut   ProtectedQueryStatus = "TIMED_OUT"
)

Enum values for ProtectedQueryStatus

func (ProtectedQueryStatus) Values 

func (ProtectedQueryStatus) Values() []ProtectedQueryStatus

Values returns all known values for ProtectedQueryStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProtectedQuerySummary 

type ProtectedQuerySummary struct {

	// The time the protected query was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique ID of the protected query.
	//
	// This member is required.
	Id *string

	// The unique ARN for the membership that initiated the protected query.
	//
	// This member is required.
	MembershipArn *string

	// The unique ID for the membership that initiated the protected query.
	//
	// This member is required.
	MembershipId *string

	//  The receiver configuration.
	//
	// This member is required.
	ReceiverConfigurations []ReceiverConfiguration

	// The status of the protected query.
	//
	// This member is required.
	Status ProtectedQueryStatus
	// contains filtered or unexported fields
}

The protected query summary for the objects listed by the request.

type ProtectedQueryType 

type ProtectedQueryType string
const (
	ProtectedQueryTypeSql ProtectedQueryType = "SQL"
)

Enum values for ProtectedQueryType

func (ProtectedQueryType) Values 

func (ProtectedQueryType) Values() []ProtectedQueryType

Values returns all known values for ProtectedQueryType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QueryComputePaymentConfig added in v1.7.0 

type QueryComputePaymentConfig struct {

	// 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.
	//
	// This member is required.
	IsResponsible *bool
	// contains filtered or unexported fields
}

An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.

type QueryConstraint added in v1.15.0 

type QueryConstraint interface {
	// contains filtered or unexported methods
}

Provides any necessary query constraint information.

The following types satisfy this interface: 

QueryConstraintMemberRequireOverlap
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.QueryConstraint
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.QueryConstraintMemberRequireOverlap:
		_ = v.Value // Value is types.QueryConstraintRequireOverlap

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type QueryConstraintMemberRequireOverlap added in v1.15.0 

type QueryConstraintMemberRequireOverlap struct {
	Value QueryConstraintRequireOverlap
	// contains filtered or unexported fields
}

An array of column names that specifies which columns are required in the JOIN statement.

type QueryConstraintRequireOverlap added in v1.15.0 

type QueryConstraintRequireOverlap struct {

	// The columns that are required to overlap.
	Columns []string
	// contains filtered or unexported fields
}

Provides the name of the columns that are required to overlap.

type ReceiverConfiguration added in v1.16.0 

type ReceiverConfiguration struct {

	//  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.
	//
	// This member is required.
	AnalysisType AnalysisType

	//  The configuration details of the receiver configuration.
	ConfigurationDetails ConfigurationDetails
	// contains filtered or unexported fields
}

The receiver configuration for a protected query.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType ResourceType
	// contains filtered or unexported fields
}

Request references a resource which does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType 

type ResourceType string
const (
	ResourceTypeConfiguredTable            ResourceType = "CONFIGURED_TABLE"
	ResourceTypeCollaboration              ResourceType = "COLLABORATION"
	ResourceTypeMembership                 ResourceType = "MEMBERSHIP"
	ResourceTypeConfiguredTableAssociation ResourceType = "CONFIGURED_TABLE_ASSOCIATION"
)

Enum values for ResourceType

func (ResourceType) Values 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResultFormat 

type ResultFormat string
const (
	ResultFormatCsv     ResultFormat = "CSV"
	ResultFormatParquet ResultFormat = "PARQUET"
)

Enum values for ResultFormat

func (ResultFormat) Values 

func (ResultFormat) Values() []ResultFormat

Values returns all known values for ResultFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type S3Location added in v1.23.0 

type S3Location struct {

	//  The bucket name.
	//
	// This member is required.
	Bucket *string

	//  The object key.
	//
	// This member is required.
	Key *string
	// contains filtered or unexported fields
}

The S3 location.

type ScalarFunctions 

type ScalarFunctions string
const (
	ScalarFunctionsAbs         ScalarFunctions = "ABS"
	ScalarFunctionsCast        ScalarFunctions = "CAST"
	ScalarFunctionsCeiling     ScalarFunctions = "CEILING"
	ScalarFunctionsCoalesce    ScalarFunctions = "COALESCE"
	ScalarFunctionsConvert     ScalarFunctions = "CONVERT"
	ScalarFunctionsCurrentDate ScalarFunctions = "CURRENT_DATE"
	ScalarFunctionsDateadd     ScalarFunctions = "DATEADD"
	ScalarFunctionsExtract     ScalarFunctions = "EXTRACT"
	ScalarFunctionsFloor       ScalarFunctions = "FLOOR"
	ScalarFunctionsGetdate     ScalarFunctions = "GETDATE"
	ScalarFunctionsLn          ScalarFunctions = "LN"
	ScalarFunctionsLog         ScalarFunctions = "LOG"
	ScalarFunctionsLower       ScalarFunctions = "LOWER"
	ScalarFunctionsRound       ScalarFunctions = "ROUND"
	ScalarFunctionsRtrim       ScalarFunctions = "RTRIM"
	ScalarFunctionsSqrt        ScalarFunctions = "SQRT"
	ScalarFunctionsSubstring   ScalarFunctions = "SUBSTRING"
	ScalarFunctionsToChar      ScalarFunctions = "TO_CHAR"
	ScalarFunctionsToDate      ScalarFunctions = "TO_DATE"
	ScalarFunctionsToNumber    ScalarFunctions = "TO_NUMBER"
	ScalarFunctionsToTimestamp ScalarFunctions = "TO_TIMESTAMP"
	ScalarFunctionsTrim        ScalarFunctions = "TRIM"
	ScalarFunctionsTrunc       ScalarFunctions = "TRUNC"
	ScalarFunctionsUpper       ScalarFunctions = "UPPER"
)

Enum values for ScalarFunctions

func (ScalarFunctions) Values 

func (ScalarFunctions) Values() []ScalarFunctions

Values returns all known values for ScalarFunctions. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Schema 

type Schema struct {

	// The analysis rule types that are associated with the schema. Currently, only
	// one entry is present.
	//
	// This member is required.
	AnalysisRuleTypes []AnalysisRuleType

	// The unique Amazon Resource Name (ARN) for the collaboration that the schema
	// belongs to.
	//
	// This member is required.
	CollaborationArn *string

	// The unique ID for the collaboration that the schema belongs to.
	//
	// This member is required.
	CollaborationId *string

	// The columns for the relation that this schema represents.
	//
	// This member is required.
	Columns []Column

	// The time at which the schema was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique account ID for the Amazon Web Services account that owns the schema.
	//
	// This member is required.
	CreatorAccountId *string

	// A description for the schema.
	//
	// This member is required.
	Description *string

	// A name for the schema. The schema relation is referred to by this name when
	// queried by a protected query.
	//
	// This member is required.
	Name *string

	// The partition keys for the dataset underlying this schema.
	//
	// This member is required.
	PartitionKeys []Column

	// Details about the status of the schema. Currently, only one entry is present.
	//
	// This member is required.
	SchemaStatusDetails []SchemaStatusDetail

	// The type of schema.
	//
	// This member is required.
	Type SchemaType

	// The most recent time at which the schema was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The analysis method for the schema.
	//
	// DIRECT_QUERY allows SQL queries to be run directly on this table.
	//
	// DIRECT_JOB allows PySpark jobs to be run directly on this table.
	//
	// MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this
	// table.
	AnalysisMethod AnalysisMethod

	// The schema type properties.
	SchemaTypeProperties SchemaTypeProperties

	//  The selected analysis methods for the schema.
	SelectedAnalysisMethods []SelectedAnalysisMethod
	// contains filtered or unexported fields
}

A schema is a relation within a collaboration.

type SchemaAnalysisRuleRequest added in v1.11.0 

type SchemaAnalysisRuleRequest struct {

	// The name of the analysis rule schema that you are requesting.
	//
	// This member is required.
	Name *string

	// The type of analysis rule schema that you are requesting.
	//
	// This member is required.
	Type AnalysisRuleType
	// contains filtered or unexported fields
}

Defines the information that's necessary to retrieve an analysis rule schema. Schema analysis rules are uniquely identified by a combination of the schema name and the analysis rule type for a given collaboration.

type SchemaConfiguration added in v1.11.0 

type SchemaConfiguration string
const (
	SchemaConfigurationDifferentialPrivacy SchemaConfiguration = "DIFFERENTIAL_PRIVACY"
)

Enum values for SchemaConfiguration

func (SchemaConfiguration) Values added in v1.11.0 

func (SchemaConfiguration) Values() []SchemaConfiguration

Values returns all known values for SchemaConfiguration. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SchemaStatus added in v1.11.0 

type SchemaStatus string
const (
	SchemaStatusReady    SchemaStatus = "READY"
	SchemaStatusNotReady SchemaStatus = "NOT_READY"
)

Enum values for SchemaStatus

func (SchemaStatus) Values added in v1.11.0 

func (SchemaStatus) Values() []SchemaStatus

Values returns all known values for SchemaStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SchemaStatusDetail added in v1.11.0 

type SchemaStatusDetail struct {

	// 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.
	//
	// This member is required.
	AnalysisType AnalysisType

	// The status of the schema, indicating if it is ready to query.
	//
	// This member is required.
	Status SchemaStatus

	// The analysis rule type for which the schema status has been evaluated.
	AnalysisRuleType AnalysisRuleType

	// The configuration details of the schema analysis rule for the given type.
	Configurations []SchemaConfiguration

	// The reasons why the schema status is set to its current state.
	Reasons []SchemaStatusReason
	// contains filtered or unexported fields
}

Information about the schema status.

A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.

type SchemaStatusReason added in v1.11.0 

type SchemaStatusReason struct {

	// The schema status reason code.
	//
	// This member is required.
	Code SchemaStatusReasonCode

	// An explanation of the schema status reason code.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

A reason why the schema status is set to its current value.

type SchemaStatusReasonCode added in v1.11.0 

type SchemaStatusReasonCode string
const (
	SchemaStatusReasonCodeAnalysisRuleMissing                    SchemaStatusReasonCode = "ANALYSIS_RULE_MISSING"
	SchemaStatusReasonCodeAnalysisTemplatesNotConfigured         SchemaStatusReasonCode = "ANALYSIS_TEMPLATES_NOT_CONFIGURED"
	SchemaStatusReasonCodeAnalysisProvidersNotConfigured         SchemaStatusReasonCode = "ANALYSIS_PROVIDERS_NOT_CONFIGURED"
	SchemaStatusReasonCodeDifferentialPrivacyPolicyNotConfigured SchemaStatusReasonCode = "DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED"
	SchemaStatusReasonCodeIdMappingTableNotPopulated             SchemaStatusReasonCode = "ID_MAPPING_TABLE_NOT_POPULATED"
	SchemaStatusReasonCodeCollaborationAnalysisRuleNotConfigured SchemaStatusReasonCode = "COLLABORATION_ANALYSIS_RULE_NOT_CONFIGURED"
	SchemaStatusReasonCodeAdditionalAnalysesNotConfigured        SchemaStatusReasonCode = "ADDITIONAL_ANALYSES_NOT_CONFIGURED"
	SchemaStatusReasonCodeResultReceiversNotConfigured           SchemaStatusReasonCode = "RESULT_RECEIVERS_NOT_CONFIGURED"
	SchemaStatusReasonCodeAdditionalAnalysesNotAllowed           SchemaStatusReasonCode = "ADDITIONAL_ANALYSES_NOT_ALLOWED"
	SchemaStatusReasonCodeResultReceiversNotAllowed              SchemaStatusReasonCode = "RESULT_RECEIVERS_NOT_ALLOWED"
	SchemaStatusReasonCodeAnalysisRuleTypesNotCompatible         SchemaStatusReasonCode = "ANALYSIS_RULE_TYPES_NOT_COMPATIBLE"
)

Enum values for SchemaStatusReasonCode

func (SchemaStatusReasonCode) Values added in v1.11.0 

func (SchemaStatusReasonCode) Values() []SchemaStatusReasonCode

Values returns all known values for SchemaStatusReasonCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SchemaSummary 

type SchemaSummary struct {

	// The types of analysis rules that are associated with this schema object.
	//
	// This member is required.
	AnalysisRuleTypes []AnalysisRuleType

	// The unique ARN for the collaboration that the schema belongs to.
	//
	// This member is required.
	CollaborationArn *string

	// The unique ID for the collaboration that the schema belongs to.
	//
	// This member is required.
	CollaborationId *string

	// The time the schema object was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The unique account ID for the Amazon Web Services account that owns the schema.
	//
	// This member is required.
	CreatorAccountId *string

	// The name for the schema object.
	//
	// This member is required.
	Name *string

	// The type of schema object.
	//
	// This member is required.
	Type SchemaType

	// The time the schema object was last updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The analysis method for the associated schema.
	//
	// DIRECT_QUERY allows SQL queries to be run directly on this table.
	//
	// DIRECT_JOB allows PySpark jobs to be run directly on this table.
	//
	// MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this
	// table.
	AnalysisMethod AnalysisMethod

	//  The selected analysis methods for the schema.
	SelectedAnalysisMethods []SelectedAnalysisMethod
	// contains filtered or unexported fields
}

The schema summary for the objects listed by the request.

type SchemaType 

type SchemaType string
const (
	SchemaTypeTable          SchemaType = "TABLE"
	SchemaTypeIdMappingTable SchemaType = "ID_MAPPING_TABLE"
)

Enum values for SchemaType

func (SchemaType) Values 

func (SchemaType) Values() []SchemaType

Values returns all known values for SchemaType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SchemaTypeProperties added in v1.15.0 

type SchemaTypeProperties interface {
	// contains filtered or unexported methods
}

Information about the schema type properties.

The following types satisfy this interface: 

SchemaTypePropertiesMemberIdMappingTable
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.SchemaTypeProperties
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SchemaTypePropertiesMemberIdMappingTable:
		_ = v.Value // Value is types.IdMappingTableSchemaTypeProperties

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SchemaTypePropertiesMemberIdMappingTable added in v1.15.0 

type SchemaTypePropertiesMemberIdMappingTable struct {
	Value IdMappingTableSchemaTypeProperties
	// contains filtered or unexported fields
}

The ID mapping table for the schema type properties.

type SelectedAnalysisMethod added in v1.23.0 

type SelectedAnalysisMethod string
const (
	SelectedAnalysisMethodDirectQuery SelectedAnalysisMethod = "DIRECT_QUERY"
	SelectedAnalysisMethodDirectJob   SelectedAnalysisMethod = "DIRECT_JOB"
)

Enum values for SelectedAnalysisMethod

func (SelectedAnalysisMethod) Values added in v1.23.0 

func (SelectedAnalysisMethod) Values() []SelectedAnalysisMethod

Values returns all known values for SelectedAnalysisMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	QuotaName  *string
	QuotaValue *float64
	// contains filtered or unexported fields
}

Request denied because service quota has been exceeded.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SnowflakeTableReference added in v1.21.0 

type SnowflakeTableReference struct {

	//  The account identifier for the Snowflake table reference.
	//
	// This member is required.
	AccountIdentifier *string

	//  The name of the database the Snowflake table belongs to.
	//
	// This member is required.
	DatabaseName *string

	//  The schema name of the Snowflake table reference.
	//
	// This member is required.
	SchemaName *string

	//  The secret ARN of the Snowflake table reference.
	//
	// This member is required.
	SecretArn *string

	//  The name of the Snowflake table.
	//
	// This member is required.
	TableName *string

	//  The schema of the Snowflake table.
	//
	// This member is required.
	TableSchema SnowflakeTableSchema
	// contains filtered or unexported fields
}

A reference to a table within Snowflake.

type SnowflakeTableSchema added in v1.21.0 

type SnowflakeTableSchema interface {
	// contains filtered or unexported methods
}
The schema of a Snowflake table.

The following types satisfy this interface: 

SnowflakeTableSchemaMemberV1
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.SnowflakeTableSchema
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SnowflakeTableSchemaMemberV1:
		_ = v.Value // Value is []types.SnowflakeTableSchemaV1

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type SnowflakeTableSchemaMemberV1 added in v1.21.0 

type SnowflakeTableSchemaMemberV1 struct {
	Value []SnowflakeTableSchemaV1
	// contains filtered or unexported fields
}

The schema of a Snowflake table.

type SnowflakeTableSchemaV1 added in v1.21.0 

type SnowflakeTableSchemaV1 struct {

	//  The column name.
	//
	// This member is required.
	ColumnName *string

	//  The column's data type. Supported data types: ARRAY , BIGINT , BOOLEAN , CHAR ,
	// DATE , DECIMAL , DOUBLE , DOUBLE PRECISION , FLOAT , FLOAT4 , INT , INTEGER ,
	// MAP , NUMERIC , NUMBER , REAL , SMALLINT , STRING , TIMESTAMP , TIMESTAMP_LTZ ,
	// TIMESTAMP_NTZ , DATETIME , TINYINT , VARCHAR , TEXT , CHARACTER .
	//
	// This member is required.
	ColumnType *string
	// contains filtered or unexported fields
}

The Snowflake table schema.

type TableReference 

type TableReference interface {
	// contains filtered or unexported methods
}

A pointer to the dataset that underlies this table.

The following types satisfy this interface: 

TableReferenceMemberAthena
TableReferenceMemberGlue
TableReferenceMemberSnowflake
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/cleanrooms/types"
)

func main() {
	var union types.TableReference
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TableReferenceMemberAthena:
		_ = v.Value // Value is types.AthenaTableReference

	case *types.TableReferenceMemberGlue:
		_ = v.Value // Value is types.GlueTableReference

	case *types.TableReferenceMemberSnowflake:
		_ = v.Value // Value is types.SnowflakeTableReference

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type TableReferenceMemberAthena added in v1.21.0 

type TableReferenceMemberAthena struct {
	Value AthenaTableReference
	// contains filtered or unexported fields
}
If present, a reference to the Athena table referred to by this table

reference.

type TableReferenceMemberGlue 

type TableReferenceMemberGlue struct {
	Value GlueTableReference
	// contains filtered or unexported fields
}

If present, a reference to the Glue table referred to by this table reference.

type TableReferenceMemberSnowflake added in v1.21.0 

type TableReferenceMemberSnowflake struct {
	Value SnowflakeTableReference
	// contains filtered or unexported fields
}
If present, a reference to the Snowflake table referred to by this table

reference.

type TargetProtectedJobStatus added in v1.23.0 

type TargetProtectedJobStatus string
const (
	TargetProtectedJobStatusCancelled TargetProtectedJobStatus = "CANCELLED"
)

Enum values for TargetProtectedJobStatus

func (TargetProtectedJobStatus) Values added in v1.23.0 

func (TargetProtectedJobStatus) Values() []TargetProtectedJobStatus

Values returns all known values for TargetProtectedJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TargetProtectedQueryStatus 

type TargetProtectedQueryStatus string
const (
	TargetProtectedQueryStatusCancelled TargetProtectedQueryStatus = "CANCELLED"
)

Enum values for TargetProtectedQueryStatus

func (TargetProtectedQueryStatus) Values 

func (TargetProtectedQueryStatus) Values() []TargetProtectedQueryStatus

Values returns all known values for TargetProtectedQueryStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

The input fails to satisfy the specified constraints.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message for the input validation error.
	//
	// This member is required.
	Message *string

	// The name of the input parameter.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Describes validation errors for specific input parameters.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonFieldValidationFailed   ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonInvalidConfiguration    ValidationExceptionReason = "INVALID_CONFIGURATION"
	ValidationExceptionReasonInvalidQuery            ValidationExceptionReason = "INVALID_QUERY"
	ValidationExceptionReasonIamSynchronizationDelay ValidationExceptionReason = "IAM_SYNCHRONIZATION_DELAY"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkerComputeConfiguration added in v1.19.0 

type WorkerComputeConfiguration struct {

	//  The number of workers.
	//
	// SQL queries support a minimum value of 2 and a maximum value of 400.
	//
	// PySpark jobs support a minimum value of 4 and a maximum value of 128.
	Number *int32

	//  The worker compute configuration type.
	Type WorkerComputeType
	// contains filtered or unexported fields
}
The configuration of the compute resources for workers running an analysis

with the Clean Rooms SQL analytics engine.

type WorkerComputeType added in v1.19.0 

type WorkerComputeType string
const (
	WorkerComputeTypeCr1x WorkerComputeType = "CR.1X"
	WorkerComputeTypeCr4x WorkerComputeType = "CR.4X"
)

Enum values for WorkerComputeType

func (WorkerComputeType) Values added in v1.19.0 

func (WorkerComputeType) Values() []WorkerComputeType

Values returns all known values for WorkerComputeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.