cleanroomsml

package
v1.55.5 Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package cleanroomsml provides the client and types for making API requests to AWS Clean Rooms ML.

Welcome to the Amazon Web Services Clean Rooms ML API Reference.

Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.

To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the Clean Rooms User Guide (https://docs.aws.amazon.com/clean-rooms/latest/userguide/machine-learning.html).

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference (https://docs.aws.amazon.com/clean-rooms/latest/sql-reference/sql-reference.html).

See https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06 for more information on this service.

See cleanroomsml package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cleanroomsml/

Using the Client

To contact AWS Clean Rooms ML with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Clean Rooms ML client CleanRoomsML for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cleanroomsml/#New

Index

Constants

View Source
const (
	// AudienceExportJobStatusCreatePending is a AudienceExportJobStatus enum value
	AudienceExportJobStatusCreatePending = "CREATE_PENDING"

	// AudienceExportJobStatusCreateInProgress is a AudienceExportJobStatus enum value
	AudienceExportJobStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// AudienceExportJobStatusCreateFailed is a AudienceExportJobStatus enum value
	AudienceExportJobStatusCreateFailed = "CREATE_FAILED"

	// AudienceExportJobStatusActive is a AudienceExportJobStatus enum value
	AudienceExportJobStatusActive = "ACTIVE"
)
View Source
const (
	// AudienceGenerationJobStatusCreatePending is a AudienceGenerationJobStatus enum value
	AudienceGenerationJobStatusCreatePending = "CREATE_PENDING"

	// AudienceGenerationJobStatusCreateInProgress is a AudienceGenerationJobStatus enum value
	AudienceGenerationJobStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// AudienceGenerationJobStatusCreateFailed is a AudienceGenerationJobStatus enum value
	AudienceGenerationJobStatusCreateFailed = "CREATE_FAILED"

	// AudienceGenerationJobStatusActive is a AudienceGenerationJobStatus enum value
	AudienceGenerationJobStatusActive = "ACTIVE"

	// AudienceGenerationJobStatusDeletePending is a AudienceGenerationJobStatus enum value
	AudienceGenerationJobStatusDeletePending = "DELETE_PENDING"

	// AudienceGenerationJobStatusDeleteInProgress is a AudienceGenerationJobStatus enum value
	AudienceGenerationJobStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// AudienceGenerationJobStatusDeleteFailed is a AudienceGenerationJobStatus enum value
	AudienceGenerationJobStatusDeleteFailed = "DELETE_FAILED"
)
View Source
const (
	// AudienceModelStatusCreatePending is a AudienceModelStatus enum value
	AudienceModelStatusCreatePending = "CREATE_PENDING"

	// AudienceModelStatusCreateInProgress is a AudienceModelStatus enum value
	AudienceModelStatusCreateInProgress = "CREATE_IN_PROGRESS"

	// AudienceModelStatusCreateFailed is a AudienceModelStatus enum value
	AudienceModelStatusCreateFailed = "CREATE_FAILED"

	// AudienceModelStatusActive is a AudienceModelStatus enum value
	AudienceModelStatusActive = "ACTIVE"

	// AudienceModelStatusDeletePending is a AudienceModelStatus enum value
	AudienceModelStatusDeletePending = "DELETE_PENDING"

	// AudienceModelStatusDeleteInProgress is a AudienceModelStatus enum value
	AudienceModelStatusDeleteInProgress = "DELETE_IN_PROGRESS"

	// AudienceModelStatusDeleteFailed is a AudienceModelStatus enum value
	AudienceModelStatusDeleteFailed = "DELETE_FAILED"
)
View Source
const (
	// AudienceSizeTypeAbsolute is a AudienceSizeType enum value
	AudienceSizeTypeAbsolute = "ABSOLUTE"

	// AudienceSizeTypePercentage is a AudienceSizeType enum value
	AudienceSizeTypePercentage = "PERCENTAGE"
)
View Source
const (
	// ColumnTypeUserId is a ColumnType enum value
	ColumnTypeUserId = "USER_ID"

	// ColumnTypeItemId is a ColumnType enum value
	ColumnTypeItemId = "ITEM_ID"

	// ColumnTypeTimestamp is a ColumnType enum value
	ColumnTypeTimestamp = "TIMESTAMP"

	// ColumnTypeCategoricalFeature is a ColumnType enum value
	ColumnTypeCategoricalFeature = "CATEGORICAL_FEATURE"

	// ColumnTypeNumericalFeature is a ColumnType enum value
	ColumnTypeNumericalFeature = "NUMERICAL_FEATURE"
)
View Source
const (
	// PolicyExistenceConditionPolicyMustExist is a PolicyExistenceCondition enum value
	PolicyExistenceConditionPolicyMustExist = "POLICY_MUST_EXIST"

	// PolicyExistenceConditionPolicyMustNotExist is a PolicyExistenceCondition enum value
	PolicyExistenceConditionPolicyMustNotExist = "POLICY_MUST_NOT_EXIST"
)
View Source
const (
	// SharedAudienceMetricsAll is a SharedAudienceMetrics enum value
	SharedAudienceMetricsAll = "ALL"

	// SharedAudienceMetricsNone is a SharedAudienceMetrics enum value
	SharedAudienceMetricsNone = "NONE"
)
View Source
const (
	// TagOnCreatePolicyFromParentResource is a TagOnCreatePolicy enum value
	TagOnCreatePolicyFromParentResource = "FROM_PARENT_RESOURCE"

	// TagOnCreatePolicyNone is a TagOnCreatePolicy enum value
	TagOnCreatePolicyNone = "NONE"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// You can't complete this action because another resource depends on this resource.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource you are requesting does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You have exceeded your service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The request parameters for this request are incorrect.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "CleanRoomsML"  // Name of service.
	EndpointsID = "cleanrooms-ml" // ID to lookup a service endpoint with.
	ServiceID   = "CleanRoomsML"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ConfiguredAudienceModelStatusActive is a ConfiguredAudienceModelStatus enum value
	ConfiguredAudienceModelStatusActive = "ACTIVE"
)
View Source
const (
	// DatasetTypeInteractions is a DatasetType enum value
	DatasetTypeInteractions = "INTERACTIONS"
)
View Source
const (
	// TrainingDatasetStatusActive is a TrainingDatasetStatus enum value
	TrainingDatasetStatusActive = "ACTIVE"
)

Variables

This section is empty.

Functions

func AudienceExportJobStatus_Values

func AudienceExportJobStatus_Values() []string

AudienceExportJobStatus_Values returns all elements of the AudienceExportJobStatus enum

func AudienceGenerationJobStatus_Values

func AudienceGenerationJobStatus_Values() []string

AudienceGenerationJobStatus_Values returns all elements of the AudienceGenerationJobStatus enum

func AudienceModelStatus_Values

func AudienceModelStatus_Values() []string

AudienceModelStatus_Values returns all elements of the AudienceModelStatus enum

func AudienceSizeType_Values

func AudienceSizeType_Values() []string

AudienceSizeType_Values returns all elements of the AudienceSizeType enum

func ColumnType_Values

func ColumnType_Values() []string

ColumnType_Values returns all elements of the ColumnType enum

func ConfiguredAudienceModelStatus_Values

func ConfiguredAudienceModelStatus_Values() []string

ConfiguredAudienceModelStatus_Values returns all elements of the ConfiguredAudienceModelStatus enum

func DatasetType_Values

func DatasetType_Values() []string

DatasetType_Values returns all elements of the DatasetType enum

func PolicyExistenceCondition_Values

func PolicyExistenceCondition_Values() []string

PolicyExistenceCondition_Values returns all elements of the PolicyExistenceCondition enum

func SharedAudienceMetrics_Values

func SharedAudienceMetrics_Values() []string

SharedAudienceMetrics_Values returns all elements of the SharedAudienceMetrics enum

func TagOnCreatePolicy_Values

func TagOnCreatePolicy_Values() []string

TagOnCreatePolicy_Values returns all elements of the TagOnCreatePolicy enum

func TrainingDatasetStatus_Values

func TrainingDatasetStatus_Values() []string

TrainingDatasetStatus_Values returns all elements of the TrainingDatasetStatus enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AudienceDestination

type AudienceDestination struct {

	// The Amazon S3 bucket and path for the configured audience.
	//
	// S3Destination is a required field
	S3Destination *S3ConfigMap `locationName:"s3Destination" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Defines the Amazon S3 bucket where the configured audience is stored.

func (AudienceDestination) GoString

func (s AudienceDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceDestination) SetS3Destination

func (s *AudienceDestination) SetS3Destination(v *S3ConfigMap) *AudienceDestination

SetS3Destination sets the S3Destination field's value.

func (AudienceDestination) String

func (s AudienceDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceDestination) Validate

func (s *AudienceDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AudienceExportJobSummary

type AudienceExportJobSummary struct {

	// The Amazon Resource Name (ARN) of the audience generation job that was exported.
	//
	// AudienceGenerationJobArn is a required field
	AudienceGenerationJobArn *string `locationName:"audienceGenerationJobArn" min:"20" type:"string" required:"true"`

	// The size of the generated audience. Must match one of the sizes in the configured
	// audience model.
	//
	// AudienceSize is a required field
	AudienceSize *AudienceSize `locationName:"audienceSize" type:"structure" required:"true"`

	// The time at which the audience export job was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the audience export job.
	Description *string `locationName:"description" type:"string"`

	// The name of the audience export job.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The Amazon S3 bucket where the audience export is stored.
	OutputLocation *string `locationName:"outputLocation" min:"1" type:"string"`

	// The status of the audience export job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AudienceExportJobStatus"`

	// Details about the status of a resource.
	StatusDetails *StatusDetails `locationName:"statusDetails" type:"structure"`

	// The most recent time at which the audience export job was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the audience export job.

func (AudienceExportJobSummary) GoString

func (s AudienceExportJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceExportJobSummary) SetAudienceGenerationJobArn

func (s *AudienceExportJobSummary) SetAudienceGenerationJobArn(v string) *AudienceExportJobSummary

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (*AudienceExportJobSummary) SetAudienceSize

SetAudienceSize sets the AudienceSize field's value.

func (*AudienceExportJobSummary) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*AudienceExportJobSummary) SetDescription

SetDescription sets the Description field's value.

func (*AudienceExportJobSummary) SetName

SetName sets the Name field's value.

func (*AudienceExportJobSummary) SetOutputLocation

func (s *AudienceExportJobSummary) SetOutputLocation(v string) *AudienceExportJobSummary

SetOutputLocation sets the OutputLocation field's value.

func (*AudienceExportJobSummary) SetStatus

SetStatus sets the Status field's value.

func (*AudienceExportJobSummary) SetStatusDetails

SetStatusDetails sets the StatusDetails field's value.

func (*AudienceExportJobSummary) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (AudienceExportJobSummary) String

func (s AudienceExportJobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AudienceGenerationJobDataSource

type AudienceGenerationJobDataSource struct {

	// Defines the Amazon S3 bucket where the seed audience for the generating audience
	// is stored. A valid data source is a JSON line file in the following format:
	//
	// {"user_id": "111111"}
	//
	// {"user_id": "222222"}
	//
	// ...
	DataSource *S3ConfigMap `locationName:"dataSource" type:"structure"`

	// The ARN of the IAM role that can read the Amazon S3 bucket where the seed
	// audience is stored.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// The protected SQL query parameters.
	//
	// SqlParameters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AudienceGenerationJobDataSource's
	// String and GoString methods.
	SqlParameters *ProtectedQuerySQLParameters `locationName:"sqlParameters" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Defines the Amazon S3 bucket where the seed audience for the generating audience is stored.

func (AudienceGenerationJobDataSource) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceGenerationJobDataSource) SetDataSource

SetDataSource sets the DataSource field's value.

func (*AudienceGenerationJobDataSource) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*AudienceGenerationJobDataSource) SetSqlParameters added in v1.55.1

SetSqlParameters sets the SqlParameters field's value.

func (AudienceGenerationJobDataSource) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceGenerationJobDataSource) Validate

func (s *AudienceGenerationJobDataSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AudienceGenerationJobSummary

type AudienceGenerationJobSummary struct {

	// The Amazon Resource Name (ARN) of the audience generation job.
	//
	// AudienceGenerationJobArn is a required field
	AudienceGenerationJobArn *string `locationName:"audienceGenerationJobArn" min:"20" type:"string" required:"true"`

	// The identifier of the collaboration that contains this audience generation
	// job.
	CollaborationId *string `locationName:"collaborationId" min:"36" type:"string"`

	// The Amazon Resource Name (ARN) of the configured audience model that was
	// used for this audience generation job.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The time at which the audience generation job was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the audience generation job.
	Description *string `locationName:"description" type:"string"`

	// The name of the audience generation job.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The AWS Account that submitted the job.
	StartedBy *string `locationName:"startedBy" min:"12" type:"string"`

	// The status of the audience generation job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AudienceGenerationJobStatus"`

	// The most recent time at which the audience generation job was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the configured audience generation job.

func (AudienceGenerationJobSummary) GoString

func (s AudienceGenerationJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceGenerationJobSummary) SetAudienceGenerationJobArn

func (s *AudienceGenerationJobSummary) SetAudienceGenerationJobArn(v string) *AudienceGenerationJobSummary

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (*AudienceGenerationJobSummary) SetCollaborationId

SetCollaborationId sets the CollaborationId field's value.

func (*AudienceGenerationJobSummary) SetConfiguredAudienceModelArn

func (s *AudienceGenerationJobSummary) SetConfiguredAudienceModelArn(v string) *AudienceGenerationJobSummary

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*AudienceGenerationJobSummary) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*AudienceGenerationJobSummary) SetDescription

SetDescription sets the Description field's value.

func (*AudienceGenerationJobSummary) SetName

SetName sets the Name field's value.

func (*AudienceGenerationJobSummary) SetStartedBy

SetStartedBy sets the StartedBy field's value.

func (*AudienceGenerationJobSummary) SetStatus

SetStatus sets the Status field's value.

func (*AudienceGenerationJobSummary) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (AudienceGenerationJobSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AudienceModelSummary

type AudienceModelSummary struct {

	// The Amazon Resource Name (ARN) of the audience model.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `locationName:"audienceModelArn" min:"20" type:"string" required:"true"`

	// The time at which the audience model was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the audience model.
	Description *string `locationName:"description" type:"string"`

	// The name of the audience model.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The status of the audience model.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AudienceModelStatus"`

	// The Amazon Resource Name (ARN) of the training dataset that was used for
	// the audience model.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`

	// The most recent time at which the audience model was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Information about the audience model.

func (AudienceModelSummary) GoString

func (s AudienceModelSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceModelSummary) SetAudienceModelArn

func (s *AudienceModelSummary) SetAudienceModelArn(v string) *AudienceModelSummary

SetAudienceModelArn sets the AudienceModelArn field's value.

func (*AudienceModelSummary) SetCreateTime

func (s *AudienceModelSummary) SetCreateTime(v time.Time) *AudienceModelSummary

SetCreateTime sets the CreateTime field's value.

func (*AudienceModelSummary) SetDescription

func (s *AudienceModelSummary) SetDescription(v string) *AudienceModelSummary

SetDescription sets the Description field's value.

func (*AudienceModelSummary) SetName

SetName sets the Name field's value.

func (*AudienceModelSummary) SetStatus

SetStatus sets the Status field's value.

func (*AudienceModelSummary) SetTrainingDatasetArn

func (s *AudienceModelSummary) SetTrainingDatasetArn(v string) *AudienceModelSummary

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (*AudienceModelSummary) SetUpdateTime

func (s *AudienceModelSummary) SetUpdateTime(v time.Time) *AudienceModelSummary

SetUpdateTime sets the UpdateTime field's value.

func (AudienceModelSummary) String

func (s AudienceModelSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AudienceQualityMetrics

type AudienceQualityMetrics struct {

	// The recall score of the generated audience. Recall is the percentage of the
	// most similar users (by default, the most similar 20%) from a sample of the
	// training data that are included in the seed audience by the audience generation
	// job. Values range from 0-1, larger values indicate a better audience. A recall
	// value approximately equal to the maximum bin size indicates that the audience
	// model is equivalent to random selection.
	RecallMetric *float64 `locationName:"recallMetric" type:"double"`

	// The relevance scores of the generated audience.
	//
	// RelevanceMetrics is a required field
	RelevanceMetrics []*RelevanceMetric `locationName:"relevanceMetrics" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Metrics that describe the quality of the generated audience.

func (AudienceQualityMetrics) GoString

func (s AudienceQualityMetrics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceQualityMetrics) SetRecallMetric added in v1.51.14

func (s *AudienceQualityMetrics) SetRecallMetric(v float64) *AudienceQualityMetrics

SetRecallMetric sets the RecallMetric field's value.

func (*AudienceQualityMetrics) SetRelevanceMetrics

func (s *AudienceQualityMetrics) SetRelevanceMetrics(v []*RelevanceMetric) *AudienceQualityMetrics

SetRelevanceMetrics sets the RelevanceMetrics field's value.

func (AudienceQualityMetrics) String

func (s AudienceQualityMetrics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AudienceSize

type AudienceSize struct {

	// Whether the audience size is defined in absolute terms or as a percentage.
	// You can use the ABSOLUTE AudienceSize to configure out audience sizes using
	// the count of identifiers in the output. You can use the Percentage AudienceSize
	// to configure sizes in the range 1-100 percent.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"AudienceSizeType"`

	// Specify an audience size value.
	//
	// Value is a required field
	Value *int64 `locationName:"value" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The size of the generated audience. Must match one of the sizes in the configured audience model.

func (AudienceSize) GoString

func (s AudienceSize) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceSize) SetType

func (s *AudienceSize) SetType(v string) *AudienceSize

SetType sets the Type field's value.

func (*AudienceSize) SetValue

func (s *AudienceSize) SetValue(v int64) *AudienceSize

SetValue sets the Value field's value.

func (AudienceSize) String

func (s AudienceSize) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceSize) Validate

func (s *AudienceSize) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AudienceSizeConfig

type AudienceSizeConfig struct {

	// An array of the different audience output sizes.
	//
	// AudienceSizeBins is a required field
	AudienceSizeBins []*int64 `locationName:"audienceSizeBins" min:"1" type:"list" required:"true"`

	// Whether the audience output sizes are defined as an absolute number or a
	// percentage.
	//
	// AudienceSizeType is a required field
	AudienceSizeType *string `locationName:"audienceSizeType" type:"string" required:"true" enum:"AudienceSizeType"`
	// contains filtered or unexported fields
}

Returns the relevance scores at these audience sizes when used in the GetAudienceGenerationJob for a specified audience generation job and configured audience model.

Specifies the list of allowed audienceSize values when used in the StartAudienceExportJob for an audience generation job. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

func (AudienceSizeConfig) GoString

func (s AudienceSizeConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceSizeConfig) SetAudienceSizeBins

func (s *AudienceSizeConfig) SetAudienceSizeBins(v []*int64) *AudienceSizeConfig

SetAudienceSizeBins sets the AudienceSizeBins field's value.

func (*AudienceSizeConfig) SetAudienceSizeType

func (s *AudienceSizeConfig) SetAudienceSizeType(v string) *AudienceSizeConfig

SetAudienceSizeType sets the AudienceSizeType field's value.

func (AudienceSizeConfig) String

func (s AudienceSizeConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AudienceSizeConfig) Validate

func (s *AudienceSizeConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CleanRoomsML

type CleanRoomsML struct {
	*client.Client
}

CleanRoomsML provides the API operation methods for making requests to AWS Clean Rooms ML. See this package's package overview docs for details on the service.

CleanRoomsML methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CleanRoomsML

New creates a new instance of the CleanRoomsML client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a CleanRoomsML client from just a session.
svc := cleanroomsml.New(mySession)

// Create a CleanRoomsML client with additional configuration
svc := cleanroomsml.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CleanRoomsML) CreateAudienceModel

func (c *CleanRoomsML) CreateAudienceModel(input *CreateAudienceModelInput) (*CreateAudienceModelOutput, error)

CreateAudienceModel API operation for AWS Clean Rooms ML.

Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation CreateAudienceModel for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

  • ServiceQuotaExceededException You have exceeded your service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateAudienceModel

func (*CleanRoomsML) CreateAudienceModelRequest

func (c *CleanRoomsML) CreateAudienceModelRequest(input *CreateAudienceModelInput) (req *request.Request, output *CreateAudienceModelOutput)

CreateAudienceModelRequest generates a "aws/request.Request" representing the client's request for the CreateAudienceModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAudienceModel for more information on using the CreateAudienceModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAudienceModelRequest method.
req, resp := client.CreateAudienceModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateAudienceModel

func (*CleanRoomsML) CreateAudienceModelWithContext

func (c *CleanRoomsML) CreateAudienceModelWithContext(ctx aws.Context, input *CreateAudienceModelInput, opts ...request.Option) (*CreateAudienceModelOutput, error)

CreateAudienceModelWithContext is the same as CreateAudienceModel with the addition of the ability to pass a context and additional request options.

See CreateAudienceModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) CreateConfiguredAudienceModel

CreateConfiguredAudienceModel API operation for AWS Clean Rooms ML.

Defines the information necessary to create a configured audience model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation CreateConfiguredAudienceModel for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

  • ServiceQuotaExceededException You have exceeded your service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredAudienceModel

func (*CleanRoomsML) CreateConfiguredAudienceModelRequest

func (c *CleanRoomsML) CreateConfiguredAudienceModelRequest(input *CreateConfiguredAudienceModelInput) (req *request.Request, output *CreateConfiguredAudienceModelOutput)

CreateConfiguredAudienceModelRequest generates a "aws/request.Request" representing the client's request for the CreateConfiguredAudienceModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConfiguredAudienceModel for more information on using the CreateConfiguredAudienceModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateConfiguredAudienceModelRequest method.
req, resp := client.CreateConfiguredAudienceModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateConfiguredAudienceModel

func (*CleanRoomsML) CreateConfiguredAudienceModelWithContext

func (c *CleanRoomsML) CreateConfiguredAudienceModelWithContext(ctx aws.Context, input *CreateConfiguredAudienceModelInput, opts ...request.Option) (*CreateConfiguredAudienceModelOutput, error)

CreateConfiguredAudienceModelWithContext is the same as CreateConfiguredAudienceModel with the addition of the ability to pass a context and additional request options.

See CreateConfiguredAudienceModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) CreateTrainingDataset

func (c *CleanRoomsML) CreateTrainingDataset(input *CreateTrainingDatasetInput) (*CreateTrainingDatasetOutput, error)

CreateTrainingDataset API operation for AWS Clean Rooms ML.

Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation CreateTrainingDataset for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDataset

func (*CleanRoomsML) CreateTrainingDatasetRequest

func (c *CleanRoomsML) CreateTrainingDatasetRequest(input *CreateTrainingDatasetInput) (req *request.Request, output *CreateTrainingDatasetOutput)

CreateTrainingDatasetRequest generates a "aws/request.Request" representing the client's request for the CreateTrainingDataset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTrainingDataset for more information on using the CreateTrainingDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateTrainingDatasetRequest method.
req, resp := client.CreateTrainingDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/CreateTrainingDataset

func (*CleanRoomsML) CreateTrainingDatasetWithContext

func (c *CleanRoomsML) CreateTrainingDatasetWithContext(ctx aws.Context, input *CreateTrainingDatasetInput, opts ...request.Option) (*CreateTrainingDatasetOutput, error)

CreateTrainingDatasetWithContext is the same as CreateTrainingDataset with the addition of the ability to pass a context and additional request options.

See CreateTrainingDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) DeleteAudienceGenerationJob

func (c *CleanRoomsML) DeleteAudienceGenerationJob(input *DeleteAudienceGenerationJobInput) (*DeleteAudienceGenerationJobOutput, error)

DeleteAudienceGenerationJob API operation for AWS Clean Rooms ML.

Deletes the specified audience generation job, and removes all data associated with the job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation DeleteAudienceGenerationJob for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceGenerationJob

func (*CleanRoomsML) DeleteAudienceGenerationJobRequest

func (c *CleanRoomsML) DeleteAudienceGenerationJobRequest(input *DeleteAudienceGenerationJobInput) (req *request.Request, output *DeleteAudienceGenerationJobOutput)

DeleteAudienceGenerationJobRequest generates a "aws/request.Request" representing the client's request for the DeleteAudienceGenerationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAudienceGenerationJob for more information on using the DeleteAudienceGenerationJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAudienceGenerationJobRequest method.
req, resp := client.DeleteAudienceGenerationJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceGenerationJob

func (*CleanRoomsML) DeleteAudienceGenerationJobWithContext

func (c *CleanRoomsML) DeleteAudienceGenerationJobWithContext(ctx aws.Context, input *DeleteAudienceGenerationJobInput, opts ...request.Option) (*DeleteAudienceGenerationJobOutput, error)

DeleteAudienceGenerationJobWithContext is the same as DeleteAudienceGenerationJob with the addition of the ability to pass a context and additional request options.

See DeleteAudienceGenerationJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) DeleteAudienceModel

func (c *CleanRoomsML) DeleteAudienceModel(input *DeleteAudienceModelInput) (*DeleteAudienceModelOutput, error)

DeleteAudienceModel API operation for AWS Clean Rooms ML.

Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation DeleteAudienceModel for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceModel

func (*CleanRoomsML) DeleteAudienceModelRequest

func (c *CleanRoomsML) DeleteAudienceModelRequest(input *DeleteAudienceModelInput) (req *request.Request, output *DeleteAudienceModelOutput)

DeleteAudienceModelRequest generates a "aws/request.Request" representing the client's request for the DeleteAudienceModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAudienceModel for more information on using the DeleteAudienceModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAudienceModelRequest method.
req, resp := client.DeleteAudienceModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteAudienceModel

func (*CleanRoomsML) DeleteAudienceModelWithContext

func (c *CleanRoomsML) DeleteAudienceModelWithContext(ctx aws.Context, input *DeleteAudienceModelInput, opts ...request.Option) (*DeleteAudienceModelOutput, error)

DeleteAudienceModelWithContext is the same as DeleteAudienceModel with the addition of the ability to pass a context and additional request options.

See DeleteAudienceModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) DeleteConfiguredAudienceModel

DeleteConfiguredAudienceModel API operation for AWS Clean Rooms ML.

Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation DeleteConfiguredAudienceModel for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModel

func (*CleanRoomsML) DeleteConfiguredAudienceModelPolicy

DeleteConfiguredAudienceModelPolicy API operation for AWS Clean Rooms ML.

Deletes the specified configured audience model policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation DeleteConfiguredAudienceModelPolicy for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelPolicy

func (*CleanRoomsML) DeleteConfiguredAudienceModelPolicyRequest

func (c *CleanRoomsML) DeleteConfiguredAudienceModelPolicyRequest(input *DeleteConfiguredAudienceModelPolicyInput) (req *request.Request, output *DeleteConfiguredAudienceModelPolicyOutput)

DeleteConfiguredAudienceModelPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteConfiguredAudienceModelPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfiguredAudienceModelPolicy for more information on using the DeleteConfiguredAudienceModelPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConfiguredAudienceModelPolicyRequest method.
req, resp := client.DeleteConfiguredAudienceModelPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModelPolicy

func (*CleanRoomsML) DeleteConfiguredAudienceModelPolicyWithContext

func (c *CleanRoomsML) DeleteConfiguredAudienceModelPolicyWithContext(ctx aws.Context, input *DeleteConfiguredAudienceModelPolicyInput, opts ...request.Option) (*DeleteConfiguredAudienceModelPolicyOutput, error)

DeleteConfiguredAudienceModelPolicyWithContext is the same as DeleteConfiguredAudienceModelPolicy with the addition of the ability to pass a context and additional request options.

See DeleteConfiguredAudienceModelPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) DeleteConfiguredAudienceModelRequest

func (c *CleanRoomsML) DeleteConfiguredAudienceModelRequest(input *DeleteConfiguredAudienceModelInput) (req *request.Request, output *DeleteConfiguredAudienceModelOutput)

DeleteConfiguredAudienceModelRequest generates a "aws/request.Request" representing the client's request for the DeleteConfiguredAudienceModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConfiguredAudienceModel for more information on using the DeleteConfiguredAudienceModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteConfiguredAudienceModelRequest method.
req, resp := client.DeleteConfiguredAudienceModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteConfiguredAudienceModel

func (*CleanRoomsML) DeleteConfiguredAudienceModelWithContext

func (c *CleanRoomsML) DeleteConfiguredAudienceModelWithContext(ctx aws.Context, input *DeleteConfiguredAudienceModelInput, opts ...request.Option) (*DeleteConfiguredAudienceModelOutput, error)

DeleteConfiguredAudienceModelWithContext is the same as DeleteConfiguredAudienceModel with the addition of the ability to pass a context and additional request options.

See DeleteConfiguredAudienceModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) DeleteTrainingDataset

func (c *CleanRoomsML) DeleteTrainingDataset(input *DeleteTrainingDatasetInput) (*DeleteTrainingDatasetOutput, error)

DeleteTrainingDataset API operation for AWS Clean Rooms ML.

Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation DeleteTrainingDataset for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainingDataset

func (*CleanRoomsML) DeleteTrainingDatasetRequest

func (c *CleanRoomsML) DeleteTrainingDatasetRequest(input *DeleteTrainingDatasetInput) (req *request.Request, output *DeleteTrainingDatasetOutput)

DeleteTrainingDatasetRequest generates a "aws/request.Request" representing the client's request for the DeleteTrainingDataset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTrainingDataset for more information on using the DeleteTrainingDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteTrainingDatasetRequest method.
req, resp := client.DeleteTrainingDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/DeleteTrainingDataset

func (*CleanRoomsML) DeleteTrainingDatasetWithContext

func (c *CleanRoomsML) DeleteTrainingDatasetWithContext(ctx aws.Context, input *DeleteTrainingDatasetInput, opts ...request.Option) (*DeleteTrainingDatasetOutput, error)

DeleteTrainingDatasetWithContext is the same as DeleteTrainingDataset with the addition of the ability to pass a context and additional request options.

See DeleteTrainingDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) GetAudienceGenerationJob

func (c *CleanRoomsML) GetAudienceGenerationJob(input *GetAudienceGenerationJobInput) (*GetAudienceGenerationJobOutput, error)

GetAudienceGenerationJob API operation for AWS Clean Rooms ML.

Returns information about an audience generation job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation GetAudienceGenerationJob for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJob

func (*CleanRoomsML) GetAudienceGenerationJobRequest

func (c *CleanRoomsML) GetAudienceGenerationJobRequest(input *GetAudienceGenerationJobInput) (req *request.Request, output *GetAudienceGenerationJobOutput)

GetAudienceGenerationJobRequest generates a "aws/request.Request" representing the client's request for the GetAudienceGenerationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAudienceGenerationJob for more information on using the GetAudienceGenerationJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAudienceGenerationJobRequest method.
req, resp := client.GetAudienceGenerationJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceGenerationJob

func (*CleanRoomsML) GetAudienceGenerationJobWithContext

func (c *CleanRoomsML) GetAudienceGenerationJobWithContext(ctx aws.Context, input *GetAudienceGenerationJobInput, opts ...request.Option) (*GetAudienceGenerationJobOutput, error)

GetAudienceGenerationJobWithContext is the same as GetAudienceGenerationJob with the addition of the ability to pass a context and additional request options.

See GetAudienceGenerationJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) GetAudienceModel

func (c *CleanRoomsML) GetAudienceModel(input *GetAudienceModelInput) (*GetAudienceModelOutput, error)

GetAudienceModel API operation for AWS Clean Rooms ML.

Returns information about an audience model

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation GetAudienceModel for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModel

func (*CleanRoomsML) GetAudienceModelRequest

func (c *CleanRoomsML) GetAudienceModelRequest(input *GetAudienceModelInput) (req *request.Request, output *GetAudienceModelOutput)

GetAudienceModelRequest generates a "aws/request.Request" representing the client's request for the GetAudienceModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAudienceModel for more information on using the GetAudienceModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAudienceModelRequest method.
req, resp := client.GetAudienceModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetAudienceModel

func (*CleanRoomsML) GetAudienceModelWithContext

func (c *CleanRoomsML) GetAudienceModelWithContext(ctx aws.Context, input *GetAudienceModelInput, opts ...request.Option) (*GetAudienceModelOutput, error)

GetAudienceModelWithContext is the same as GetAudienceModel with the addition of the ability to pass a context and additional request options.

See GetAudienceModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) GetConfiguredAudienceModel

func (c *CleanRoomsML) GetConfiguredAudienceModel(input *GetConfiguredAudienceModelInput) (*GetConfiguredAudienceModelOutput, error)

GetConfiguredAudienceModel API operation for AWS Clean Rooms ML.

Returns information about a specified configured audience model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation GetConfiguredAudienceModel for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModel

func (*CleanRoomsML) GetConfiguredAudienceModelPolicy

GetConfiguredAudienceModelPolicy API operation for AWS Clean Rooms ML.

Returns information about a configured audience model policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation GetConfiguredAudienceModelPolicy for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicy

func (*CleanRoomsML) GetConfiguredAudienceModelPolicyRequest

func (c *CleanRoomsML) GetConfiguredAudienceModelPolicyRequest(input *GetConfiguredAudienceModelPolicyInput) (req *request.Request, output *GetConfiguredAudienceModelPolicyOutput)

GetConfiguredAudienceModelPolicyRequest generates a "aws/request.Request" representing the client's request for the GetConfiguredAudienceModelPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConfiguredAudienceModelPolicy for more information on using the GetConfiguredAudienceModelPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetConfiguredAudienceModelPolicyRequest method.
req, resp := client.GetConfiguredAudienceModelPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModelPolicy

func (*CleanRoomsML) GetConfiguredAudienceModelPolicyWithContext

func (c *CleanRoomsML) GetConfiguredAudienceModelPolicyWithContext(ctx aws.Context, input *GetConfiguredAudienceModelPolicyInput, opts ...request.Option) (*GetConfiguredAudienceModelPolicyOutput, error)

GetConfiguredAudienceModelPolicyWithContext is the same as GetConfiguredAudienceModelPolicy with the addition of the ability to pass a context and additional request options.

See GetConfiguredAudienceModelPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) GetConfiguredAudienceModelRequest

func (c *CleanRoomsML) GetConfiguredAudienceModelRequest(input *GetConfiguredAudienceModelInput) (req *request.Request, output *GetConfiguredAudienceModelOutput)

GetConfiguredAudienceModelRequest generates a "aws/request.Request" representing the client's request for the GetConfiguredAudienceModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConfiguredAudienceModel for more information on using the GetConfiguredAudienceModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetConfiguredAudienceModelRequest method.
req, resp := client.GetConfiguredAudienceModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetConfiguredAudienceModel

func (*CleanRoomsML) GetConfiguredAudienceModelWithContext

func (c *CleanRoomsML) GetConfiguredAudienceModelWithContext(ctx aws.Context, input *GetConfiguredAudienceModelInput, opts ...request.Option) (*GetConfiguredAudienceModelOutput, error)

GetConfiguredAudienceModelWithContext is the same as GetConfiguredAudienceModel with the addition of the ability to pass a context and additional request options.

See GetConfiguredAudienceModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) GetTrainingDataset

func (c *CleanRoomsML) GetTrainingDataset(input *GetTrainingDatasetInput) (*GetTrainingDatasetOutput, error)

GetTrainingDataset API operation for AWS Clean Rooms ML.

Returns information about a training dataset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation GetTrainingDataset for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDataset

func (*CleanRoomsML) GetTrainingDatasetRequest

func (c *CleanRoomsML) GetTrainingDatasetRequest(input *GetTrainingDatasetInput) (req *request.Request, output *GetTrainingDatasetOutput)

GetTrainingDatasetRequest generates a "aws/request.Request" representing the client's request for the GetTrainingDataset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTrainingDataset for more information on using the GetTrainingDataset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetTrainingDatasetRequest method.
req, resp := client.GetTrainingDatasetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDataset

func (*CleanRoomsML) GetTrainingDatasetWithContext

func (c *CleanRoomsML) GetTrainingDatasetWithContext(ctx aws.Context, input *GetTrainingDatasetInput, opts ...request.Option) (*GetTrainingDatasetOutput, error)

GetTrainingDatasetWithContext is the same as GetTrainingDataset with the addition of the ability to pass a context and additional request options.

See GetTrainingDataset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListAudienceExportJobs

func (c *CleanRoomsML) ListAudienceExportJobs(input *ListAudienceExportJobsInput) (*ListAudienceExportJobsOutput, error)

ListAudienceExportJobs API operation for AWS Clean Rooms ML.

Returns a list of the audience export jobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation ListAudienceExportJobs for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobs

func (*CleanRoomsML) ListAudienceExportJobsPages

func (c *CleanRoomsML) ListAudienceExportJobsPages(input *ListAudienceExportJobsInput, fn func(*ListAudienceExportJobsOutput, bool) bool) error

ListAudienceExportJobsPages iterates over the pages of a ListAudienceExportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAudienceExportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAudienceExportJobs operation.
pageNum := 0
err := client.ListAudienceExportJobsPages(params,
    func(page *cleanroomsml.ListAudienceExportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CleanRoomsML) ListAudienceExportJobsPagesWithContext

func (c *CleanRoomsML) ListAudienceExportJobsPagesWithContext(ctx aws.Context, input *ListAudienceExportJobsInput, fn func(*ListAudienceExportJobsOutput, bool) bool, opts ...request.Option) error

ListAudienceExportJobsPagesWithContext same as ListAudienceExportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListAudienceExportJobsRequest

func (c *CleanRoomsML) ListAudienceExportJobsRequest(input *ListAudienceExportJobsInput) (req *request.Request, output *ListAudienceExportJobsOutput)

ListAudienceExportJobsRequest generates a "aws/request.Request" representing the client's request for the ListAudienceExportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAudienceExportJobs for more information on using the ListAudienceExportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAudienceExportJobsRequest method.
req, resp := client.ListAudienceExportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceExportJobs

func (*CleanRoomsML) ListAudienceExportJobsWithContext

func (c *CleanRoomsML) ListAudienceExportJobsWithContext(ctx aws.Context, input *ListAudienceExportJobsInput, opts ...request.Option) (*ListAudienceExportJobsOutput, error)

ListAudienceExportJobsWithContext is the same as ListAudienceExportJobs with the addition of the ability to pass a context and additional request options.

See ListAudienceExportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListAudienceGenerationJobs

func (c *CleanRoomsML) ListAudienceGenerationJobs(input *ListAudienceGenerationJobsInput) (*ListAudienceGenerationJobsOutput, error)

ListAudienceGenerationJobs API operation for AWS Clean Rooms ML.

Returns a list of audience generation jobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation ListAudienceGenerationJobs for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobs

func (*CleanRoomsML) ListAudienceGenerationJobsPages

func (c *CleanRoomsML) ListAudienceGenerationJobsPages(input *ListAudienceGenerationJobsInput, fn func(*ListAudienceGenerationJobsOutput, bool) bool) error

ListAudienceGenerationJobsPages iterates over the pages of a ListAudienceGenerationJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAudienceGenerationJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAudienceGenerationJobs operation.
pageNum := 0
err := client.ListAudienceGenerationJobsPages(params,
    func(page *cleanroomsml.ListAudienceGenerationJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CleanRoomsML) ListAudienceGenerationJobsPagesWithContext

func (c *CleanRoomsML) ListAudienceGenerationJobsPagesWithContext(ctx aws.Context, input *ListAudienceGenerationJobsInput, fn func(*ListAudienceGenerationJobsOutput, bool) bool, opts ...request.Option) error

ListAudienceGenerationJobsPagesWithContext same as ListAudienceGenerationJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListAudienceGenerationJobsRequest

func (c *CleanRoomsML) ListAudienceGenerationJobsRequest(input *ListAudienceGenerationJobsInput) (req *request.Request, output *ListAudienceGenerationJobsOutput)

ListAudienceGenerationJobsRequest generates a "aws/request.Request" representing the client's request for the ListAudienceGenerationJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAudienceGenerationJobs for more information on using the ListAudienceGenerationJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAudienceGenerationJobsRequest method.
req, resp := client.ListAudienceGenerationJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceGenerationJobs

func (*CleanRoomsML) ListAudienceGenerationJobsWithContext

func (c *CleanRoomsML) ListAudienceGenerationJobsWithContext(ctx aws.Context, input *ListAudienceGenerationJobsInput, opts ...request.Option) (*ListAudienceGenerationJobsOutput, error)

ListAudienceGenerationJobsWithContext is the same as ListAudienceGenerationJobs with the addition of the ability to pass a context and additional request options.

See ListAudienceGenerationJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListAudienceModels

func (c *CleanRoomsML) ListAudienceModels(input *ListAudienceModelsInput) (*ListAudienceModelsOutput, error)

ListAudienceModels API operation for AWS Clean Rooms ML.

Returns a list of audience models.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation ListAudienceModels for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModels

func (*CleanRoomsML) ListAudienceModelsPages

func (c *CleanRoomsML) ListAudienceModelsPages(input *ListAudienceModelsInput, fn func(*ListAudienceModelsOutput, bool) bool) error

ListAudienceModelsPages iterates over the pages of a ListAudienceModels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAudienceModels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAudienceModels operation.
pageNum := 0
err := client.ListAudienceModelsPages(params,
    func(page *cleanroomsml.ListAudienceModelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CleanRoomsML) ListAudienceModelsPagesWithContext

func (c *CleanRoomsML) ListAudienceModelsPagesWithContext(ctx aws.Context, input *ListAudienceModelsInput, fn func(*ListAudienceModelsOutput, bool) bool, opts ...request.Option) error

ListAudienceModelsPagesWithContext same as ListAudienceModelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListAudienceModelsRequest

func (c *CleanRoomsML) ListAudienceModelsRequest(input *ListAudienceModelsInput) (req *request.Request, output *ListAudienceModelsOutput)

ListAudienceModelsRequest generates a "aws/request.Request" representing the client's request for the ListAudienceModels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAudienceModels for more information on using the ListAudienceModels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAudienceModelsRequest method.
req, resp := client.ListAudienceModelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListAudienceModels

func (*CleanRoomsML) ListAudienceModelsWithContext

func (c *CleanRoomsML) ListAudienceModelsWithContext(ctx aws.Context, input *ListAudienceModelsInput, opts ...request.Option) (*ListAudienceModelsOutput, error)

ListAudienceModelsWithContext is the same as ListAudienceModels with the addition of the ability to pass a context and additional request options.

See ListAudienceModels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListConfiguredAudienceModels

func (c *CleanRoomsML) ListConfiguredAudienceModels(input *ListConfiguredAudienceModelsInput) (*ListConfiguredAudienceModelsOutput, error)

ListConfiguredAudienceModels API operation for AWS Clean Rooms ML.

Returns a list of the configured audience models.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation ListConfiguredAudienceModels for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModels

func (*CleanRoomsML) ListConfiguredAudienceModelsPages

func (c *CleanRoomsML) ListConfiguredAudienceModelsPages(input *ListConfiguredAudienceModelsInput, fn func(*ListConfiguredAudienceModelsOutput, bool) bool) error

ListConfiguredAudienceModelsPages iterates over the pages of a ListConfiguredAudienceModels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListConfiguredAudienceModels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListConfiguredAudienceModels operation.
pageNum := 0
err := client.ListConfiguredAudienceModelsPages(params,
    func(page *cleanroomsml.ListConfiguredAudienceModelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CleanRoomsML) ListConfiguredAudienceModelsPagesWithContext

func (c *CleanRoomsML) ListConfiguredAudienceModelsPagesWithContext(ctx aws.Context, input *ListConfiguredAudienceModelsInput, fn func(*ListConfiguredAudienceModelsOutput, bool) bool, opts ...request.Option) error

ListConfiguredAudienceModelsPagesWithContext same as ListConfiguredAudienceModelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListConfiguredAudienceModelsRequest

func (c *CleanRoomsML) ListConfiguredAudienceModelsRequest(input *ListConfiguredAudienceModelsInput) (req *request.Request, output *ListConfiguredAudienceModelsOutput)

ListConfiguredAudienceModelsRequest generates a "aws/request.Request" representing the client's request for the ListConfiguredAudienceModels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListConfiguredAudienceModels for more information on using the ListConfiguredAudienceModels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListConfiguredAudienceModelsRequest method.
req, resp := client.ListConfiguredAudienceModelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListConfiguredAudienceModels

func (*CleanRoomsML) ListConfiguredAudienceModelsWithContext

func (c *CleanRoomsML) ListConfiguredAudienceModelsWithContext(ctx aws.Context, input *ListConfiguredAudienceModelsInput, opts ...request.Option) (*ListConfiguredAudienceModelsOutput, error)

ListConfiguredAudienceModelsWithContext is the same as ListConfiguredAudienceModels with the addition of the ability to pass a context and additional request options.

See ListConfiguredAudienceModels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListTagsForResource

func (c *CleanRoomsML) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Clean Rooms ML.

Returns a list of tags for a provided resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResource

func (*CleanRoomsML) ListTagsForResourceRequest

func (c *CleanRoomsML) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTagsForResource

func (*CleanRoomsML) ListTagsForResourceWithContext

func (c *CleanRoomsML) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListTrainingDatasets

func (c *CleanRoomsML) ListTrainingDatasets(input *ListTrainingDatasetsInput) (*ListTrainingDatasetsOutput, error)

ListTrainingDatasets API operation for AWS Clean Rooms ML.

Returns a list of training datasets.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation ListTrainingDatasets for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasets

func (*CleanRoomsML) ListTrainingDatasetsPages

func (c *CleanRoomsML) ListTrainingDatasetsPages(input *ListTrainingDatasetsInput, fn func(*ListTrainingDatasetsOutput, bool) bool) error

ListTrainingDatasetsPages iterates over the pages of a ListTrainingDatasets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTrainingDatasets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTrainingDatasets operation.
pageNum := 0
err := client.ListTrainingDatasetsPages(params,
    func(page *cleanroomsml.ListTrainingDatasetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CleanRoomsML) ListTrainingDatasetsPagesWithContext

func (c *CleanRoomsML) ListTrainingDatasetsPagesWithContext(ctx aws.Context, input *ListTrainingDatasetsInput, fn func(*ListTrainingDatasetsOutput, bool) bool, opts ...request.Option) error

ListTrainingDatasetsPagesWithContext same as ListTrainingDatasetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) ListTrainingDatasetsRequest

func (c *CleanRoomsML) ListTrainingDatasetsRequest(input *ListTrainingDatasetsInput) (req *request.Request, output *ListTrainingDatasetsOutput)

ListTrainingDatasetsRequest generates a "aws/request.Request" representing the client's request for the ListTrainingDatasets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTrainingDatasets for more information on using the ListTrainingDatasets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTrainingDatasetsRequest method.
req, resp := client.ListTrainingDatasetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/ListTrainingDatasets

func (*CleanRoomsML) ListTrainingDatasetsWithContext

func (c *CleanRoomsML) ListTrainingDatasetsWithContext(ctx aws.Context, input *ListTrainingDatasetsInput, opts ...request.Option) (*ListTrainingDatasetsOutput, error)

ListTrainingDatasetsWithContext is the same as ListTrainingDatasets with the addition of the ability to pass a context and additional request options.

See ListTrainingDatasets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) PutConfiguredAudienceModelPolicy

PutConfiguredAudienceModelPolicy API operation for AWS Clean Rooms ML.

Create or update the resource policy for a configured audience model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation PutConfiguredAudienceModelPolicy for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PutConfiguredAudienceModelPolicy

func (*CleanRoomsML) PutConfiguredAudienceModelPolicyRequest

func (c *CleanRoomsML) PutConfiguredAudienceModelPolicyRequest(input *PutConfiguredAudienceModelPolicyInput) (req *request.Request, output *PutConfiguredAudienceModelPolicyOutput)

PutConfiguredAudienceModelPolicyRequest generates a "aws/request.Request" representing the client's request for the PutConfiguredAudienceModelPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutConfiguredAudienceModelPolicy for more information on using the PutConfiguredAudienceModelPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutConfiguredAudienceModelPolicyRequest method.
req, resp := client.PutConfiguredAudienceModelPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/PutConfiguredAudienceModelPolicy

func (*CleanRoomsML) PutConfiguredAudienceModelPolicyWithContext

func (c *CleanRoomsML) PutConfiguredAudienceModelPolicyWithContext(ctx aws.Context, input *PutConfiguredAudienceModelPolicyInput, opts ...request.Option) (*PutConfiguredAudienceModelPolicyOutput, error)

PutConfiguredAudienceModelPolicyWithContext is the same as PutConfiguredAudienceModelPolicy with the addition of the ability to pass a context and additional request options.

See PutConfiguredAudienceModelPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) StartAudienceExportJob

func (c *CleanRoomsML) StartAudienceExportJob(input *StartAudienceExportJobInput) (*StartAudienceExportJobOutput, error)

StartAudienceExportJob API operation for AWS Clean Rooms ML.

Export an audience of a specified size after you have generated an audience.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation StartAudienceExportJob for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

  • ServiceQuotaExceededException You have exceeded your service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceExportJob

func (*CleanRoomsML) StartAudienceExportJobRequest

func (c *CleanRoomsML) StartAudienceExportJobRequest(input *StartAudienceExportJobInput) (req *request.Request, output *StartAudienceExportJobOutput)

StartAudienceExportJobRequest generates a "aws/request.Request" representing the client's request for the StartAudienceExportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartAudienceExportJob for more information on using the StartAudienceExportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartAudienceExportJobRequest method.
req, resp := client.StartAudienceExportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceExportJob

func (*CleanRoomsML) StartAudienceExportJobWithContext

func (c *CleanRoomsML) StartAudienceExportJobWithContext(ctx aws.Context, input *StartAudienceExportJobInput, opts ...request.Option) (*StartAudienceExportJobOutput, error)

StartAudienceExportJobWithContext is the same as StartAudienceExportJob with the addition of the ability to pass a context and additional request options.

See StartAudienceExportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) StartAudienceGenerationJob

func (c *CleanRoomsML) StartAudienceGenerationJob(input *StartAudienceGenerationJobInput) (*StartAudienceGenerationJobOutput, error)

StartAudienceGenerationJob API operation for AWS Clean Rooms ML.

Information necessary to start the audience generation job.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation StartAudienceGenerationJob for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

  • ServiceQuotaExceededException You have exceeded your service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceGenerationJob

func (*CleanRoomsML) StartAudienceGenerationJobRequest

func (c *CleanRoomsML) StartAudienceGenerationJobRequest(input *StartAudienceGenerationJobInput) (req *request.Request, output *StartAudienceGenerationJobOutput)

StartAudienceGenerationJobRequest generates a "aws/request.Request" representing the client's request for the StartAudienceGenerationJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartAudienceGenerationJob for more information on using the StartAudienceGenerationJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartAudienceGenerationJobRequest method.
req, resp := client.StartAudienceGenerationJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/StartAudienceGenerationJob

func (*CleanRoomsML) StartAudienceGenerationJobWithContext

func (c *CleanRoomsML) StartAudienceGenerationJobWithContext(ctx aws.Context, input *StartAudienceGenerationJobInput, opts ...request.Option) (*StartAudienceGenerationJobOutput, error)

StartAudienceGenerationJobWithContext is the same as StartAudienceGenerationJob with the addition of the ability to pass a context and additional request options.

See StartAudienceGenerationJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) TagResource

func (c *CleanRoomsML) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Clean Rooms ML.

Adds metadata tags to a specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation TagResource for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TagResource

func (*CleanRoomsML) TagResourceRequest

func (c *CleanRoomsML) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/TagResource

func (*CleanRoomsML) TagResourceWithContext

func (c *CleanRoomsML) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) UntagResource

func (c *CleanRoomsML) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Clean Rooms ML.

Removes metadata tags from a specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UntagResource

func (*CleanRoomsML) UntagResourceRequest

func (c *CleanRoomsML) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UntagResource

func (*CleanRoomsML) UntagResourceWithContext

func (c *CleanRoomsML) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CleanRoomsML) UpdateConfiguredAudienceModel

UpdateConfiguredAudienceModel API operation for AWS Clean Rooms ML.

Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Clean Rooms ML's API operation UpdateConfiguredAudienceModel for usage and error information.

Returned Error Types:

  • ConflictException You can't complete this action because another resource depends on this resource.

  • ValidationException The request parameters for this request are incorrect.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException The resource you are requesting does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UpdateConfiguredAudienceModel

func (*CleanRoomsML) UpdateConfiguredAudienceModelRequest

func (c *CleanRoomsML) UpdateConfiguredAudienceModelRequest(input *UpdateConfiguredAudienceModelInput) (req *request.Request, output *UpdateConfiguredAudienceModelOutput)

UpdateConfiguredAudienceModelRequest generates a "aws/request.Request" representing the client's request for the UpdateConfiguredAudienceModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConfiguredAudienceModel for more information on using the UpdateConfiguredAudienceModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateConfiguredAudienceModelRequest method.
req, resp := client.UpdateConfiguredAudienceModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/UpdateConfiguredAudienceModel

func (*CleanRoomsML) UpdateConfiguredAudienceModelWithContext

func (c *CleanRoomsML) UpdateConfiguredAudienceModelWithContext(ctx aws.Context, input *UpdateConfiguredAudienceModelInput, opts ...request.Option) (*UpdateConfiguredAudienceModelOutput, error)

UpdateConfiguredAudienceModelWithContext is the same as UpdateConfiguredAudienceModel with the addition of the ability to pass a context and additional request options.

See UpdateConfiguredAudienceModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ColumnSchema

type ColumnSchema struct {

	// The name of a column.
	//
	// ColumnName is a required field
	ColumnName *string `locationName:"columnName" min:"1" type:"string" required:"true"`

	// The data type of column.
	//
	// ColumnTypes is a required field
	ColumnTypes []*string `locationName:"columnTypes" min:"1" type:"list" required:"true" enum:"ColumnType"`
	// contains filtered or unexported fields
}

Metadata for a column.

func (ColumnSchema) GoString

func (s ColumnSchema) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnSchema) SetColumnName

func (s *ColumnSchema) SetColumnName(v string) *ColumnSchema

SetColumnName sets the ColumnName field's value.

func (*ColumnSchema) SetColumnTypes

func (s *ColumnSchema) SetColumnTypes(v []*string) *ColumnSchema

SetColumnTypes sets the ColumnTypes field's value.

func (ColumnSchema) String

func (s ColumnSchema) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnSchema) Validate

func (s *ColumnSchema) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfiguredAudienceModelOutputConfig

type ConfiguredAudienceModelOutputConfig struct {

	// Defines the Amazon S3 bucket where the configured audience is stored.
	//
	// Destination is a required field
	Destination *AudienceDestination `locationName:"destination" type:"structure" required:"true"`

	// The ARN of the IAM role that can write the Amazon S3 bucket.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Configuration information necessary for the configure audience model output.

func (ConfiguredAudienceModelOutputConfig) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfiguredAudienceModelOutputConfig) SetDestination

SetDestination sets the Destination field's value.

func (*ConfiguredAudienceModelOutputConfig) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (ConfiguredAudienceModelOutputConfig) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfiguredAudienceModelOutputConfig) Validate

Validate inspects the fields of the type to determine if they are valid.

type ConfiguredAudienceModelSummary

type ConfiguredAudienceModelSummary struct {

	// The Amazon Resource Name (ARN) of the audience model that was used to create
	// the configured audience model.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `locationName:"audienceModelArn" min:"20" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the configured audience model that you
	// are interested in.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The time at which the configured audience model was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the configured audience model.
	Description *string `locationName:"description" type:"string"`

	// The name of the configured audience model.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The output configuration of the configured audience model.
	//
	// OutputConfig is a required field
	OutputConfig *ConfiguredAudienceModelOutputConfig `locationName:"outputConfig" type:"structure" required:"true"`

	// The status of the configured audience model.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ConfiguredAudienceModelStatus"`

	// The most recent time at which the configured audience model was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Information about the configured audience model.

func (ConfiguredAudienceModelSummary) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfiguredAudienceModelSummary) SetAudienceModelArn

SetAudienceModelArn sets the AudienceModelArn field's value.

func (*ConfiguredAudienceModelSummary) SetConfiguredAudienceModelArn

func (s *ConfiguredAudienceModelSummary) SetConfiguredAudienceModelArn(v string) *ConfiguredAudienceModelSummary

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*ConfiguredAudienceModelSummary) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*ConfiguredAudienceModelSummary) SetDescription

SetDescription sets the Description field's value.

func (*ConfiguredAudienceModelSummary) SetName

SetName sets the Name field's value.

func (*ConfiguredAudienceModelSummary) SetOutputConfig

SetOutputConfig sets the OutputConfig field's value.

func (*ConfiguredAudienceModelSummary) SetStatus

SetStatus sets the Status field's value.

func (*ConfiguredAudienceModelSummary) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (ConfiguredAudienceModelSummary) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You can't complete this action because another resource depends on this resource.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAudienceModelInput

type CreateAudienceModelInput struct {

	// The description of the audience model.
	Description *string `locationName:"description" type:"string"`

	// The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt
	// and decrypt customer-owned data in the trained ML model and the associated
	// data.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"`

	// The name of the audience model resource.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The optional metadata that you apply to the resource to help you categorize
	// and organize them. Each tag consists of a key and an optional value, both
	// of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50.
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8.
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8.
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for keys as it is reserved for AWS use. You cannot edit or
	//    delete tag keys with this prefix. Values can have this prefix. If a tag
	//    value has aws as its prefix but the key does not, then Clean Rooms ML
	//    considers it to be a user tag and will count against the limit of 50 tags.
	//    Tags with only the key prefix of aws do not count against your tags per
	//    resource limit.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The end date and time of the training window.
	TrainingDataEndTime *time.Time `locationName:"trainingDataEndTime" type:"timestamp" timestampFormat:"iso8601"`

	// The start date and time of the training window.
	TrainingDataStartTime *time.Time `locationName:"trainingDataStartTime" type:"timestamp" timestampFormat:"iso8601"`

	// The Amazon Resource Name (ARN) of the training dataset for this audience
	// model.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAudienceModelInput) GoString

func (s CreateAudienceModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAudienceModelInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateAudienceModelInput) SetKmsKeyArn

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*CreateAudienceModelInput) SetName

SetName sets the Name field's value.

func (*CreateAudienceModelInput) SetTags

SetTags sets the Tags field's value.

func (*CreateAudienceModelInput) SetTrainingDataEndTime

func (s *CreateAudienceModelInput) SetTrainingDataEndTime(v time.Time) *CreateAudienceModelInput

SetTrainingDataEndTime sets the TrainingDataEndTime field's value.

func (*CreateAudienceModelInput) SetTrainingDataStartTime

func (s *CreateAudienceModelInput) SetTrainingDataStartTime(v time.Time) *CreateAudienceModelInput

SetTrainingDataStartTime sets the TrainingDataStartTime field's value.

func (*CreateAudienceModelInput) SetTrainingDatasetArn

func (s *CreateAudienceModelInput) SetTrainingDatasetArn(v string) *CreateAudienceModelInput

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (CreateAudienceModelInput) String

func (s CreateAudienceModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAudienceModelInput) Validate

func (s *CreateAudienceModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAudienceModelOutput

type CreateAudienceModelOutput struct {

	// The Amazon Resource Name (ARN) of the audience model.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `locationName:"audienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAudienceModelOutput) GoString

func (s CreateAudienceModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAudienceModelOutput) SetAudienceModelArn

func (s *CreateAudienceModelOutput) SetAudienceModelArn(v string) *CreateAudienceModelOutput

SetAudienceModelArn sets the AudienceModelArn field's value.

func (CreateAudienceModelOutput) String

func (s CreateAudienceModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateConfiguredAudienceModelInput

type CreateConfiguredAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the audience model to use for the configured
	// audience model.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `locationName:"audienceModelArn" min:"20" type:"string" required:"true"`

	// Configure the list of output sizes of audiences that can be created using
	// this configured audience model. A request to StartAudienceGenerationJob that
	// uses this configured audience model must have an audienceSize selected from
	// this list. You can use the ABSOLUTE AudienceSize to configure out audience
	// sizes using the count of identifiers in the output. You can use the Percentage
	// AudienceSize to configure sizes in the range 1-100 percent.
	AudienceSizeConfig *AudienceSizeConfig `locationName:"audienceSizeConfig" type:"structure"`

	// Configure how the service tags audience generation jobs created using this
	// configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob
	// request determine the tags of the audience generation job. If you specify
	// FROM_PARENT_RESOURCE, the audience generation job inherits the tags from
	// the configured audience model, by default. Tags in the StartAudienceGenerationJob
	// will override the default.
	//
	// When the client is in a different account than the configured audience model,
	// the tags from the client are never applied to a resource in the caller's
	// account.
	ChildResourceTagOnCreatePolicy *string `locationName:"childResourceTagOnCreatePolicy" type:"string" enum:"TagOnCreatePolicy"`

	// The description of the configured audience model.
	Description *string `locationName:"description" type:"string"`

	// The minimum number of users from the seed audience that must match with users
	// in the training data of the audience model. The default value is 500.
	MinMatchingSeedSize *int64 `locationName:"minMatchingSeedSize" min:"25" type:"integer"`

	// The name of the configured audience model.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// Configure the Amazon S3 location and IAM Role for audiences created using
	// this configured audience model. Each audience will have a unique location.
	// The IAM Role must have s3:PutObject permission on the destination Amazon
	// S3 location. If the destination is protected with Amazon S3 KMS-SSE, then
	// the Role must also have the required KMS permissions.
	//
	// OutputConfig is a required field
	OutputConfig *ConfiguredAudienceModelOutputConfig `locationName:"outputConfig" type:"structure" required:"true"`

	// Whether audience metrics are shared.
	//
	// SharedAudienceMetrics is a required field
	SharedAudienceMetrics []*string `locationName:"sharedAudienceMetrics" min:"1" type:"list" required:"true" enum:"SharedAudienceMetrics"`

	// The optional metadata that you apply to the resource to help you categorize
	// and organize them. Each tag consists of a key and an optional value, both
	// of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50.
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8.
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8.
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for keys as it is reserved for AWS use. You cannot edit or
	//    delete tag keys with this prefix. Values can have this prefix. If a tag
	//    value has aws as its prefix but the key does not, then Clean Rooms ML
	//    considers it to be a user tag and will count against the limit of 50 tags.
	//    Tags with only the key prefix of aws do not count against your tags per
	//    resource limit.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateConfiguredAudienceModelInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConfiguredAudienceModelInput) SetAudienceModelArn

SetAudienceModelArn sets the AudienceModelArn field's value.

func (*CreateConfiguredAudienceModelInput) SetAudienceSizeConfig

SetAudienceSizeConfig sets the AudienceSizeConfig field's value.

func (*CreateConfiguredAudienceModelInput) SetChildResourceTagOnCreatePolicy

func (s *CreateConfiguredAudienceModelInput) SetChildResourceTagOnCreatePolicy(v string) *CreateConfiguredAudienceModelInput

SetChildResourceTagOnCreatePolicy sets the ChildResourceTagOnCreatePolicy field's value.

func (*CreateConfiguredAudienceModelInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateConfiguredAudienceModelInput) SetMinMatchingSeedSize

SetMinMatchingSeedSize sets the MinMatchingSeedSize field's value.

func (*CreateConfiguredAudienceModelInput) SetName

SetName sets the Name field's value.

func (*CreateConfiguredAudienceModelInput) SetOutputConfig

SetOutputConfig sets the OutputConfig field's value.

func (*CreateConfiguredAudienceModelInput) SetSharedAudienceMetrics

SetSharedAudienceMetrics sets the SharedAudienceMetrics field's value.

func (*CreateConfiguredAudienceModelInput) SetTags

SetTags sets the Tags field's value.

func (CreateConfiguredAudienceModelInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConfiguredAudienceModelInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type CreateConfiguredAudienceModelOutput

type CreateConfiguredAudienceModelOutput struct {

	// The Amazon Resource Name (ARN) of the configured audience model.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateConfiguredAudienceModelOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConfiguredAudienceModelOutput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (CreateConfiguredAudienceModelOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTrainingDatasetInput

type CreateTrainingDatasetInput struct {

	// The description of the training dataset.
	Description *string `locationName:"description" type:"string"`

	// The name of the training dataset. This name must be unique in your account
	// and region.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The ARN of the IAM role that Clean Rooms ML can assume to read the data referred
	// to in the dataSource field of each dataset.
	//
	// Passing a role across AWS accounts is not allowed. If you pass a role that
	// isn't in your account, you get an AccessDeniedException error.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// The optional metadata that you apply to the resource to help you categorize
	// and organize them. Each tag consists of a key and an optional value, both
	// of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50.
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8.
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8.
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for keys as it is reserved for AWS use. You cannot edit or
	//    delete tag keys with this prefix. Values can have this prefix. If a tag
	//    value has aws as its prefix but the key does not, then Clean Rooms ML
	//    considers it to be a user tag and will count against the limit of 50 tags.
	//    Tags with only the key prefix of aws do not count against your tags per
	//    resource limit.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// An array of information that lists the Dataset objects, which specifies the
	// dataset type and details on its location and schema. You must provide a role
	// that has read access to these tables.
	//
	// TrainingData is a required field
	TrainingData []*Dataset `locationName:"trainingData" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTrainingDatasetInput) GoString

func (s CreateTrainingDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTrainingDatasetInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateTrainingDatasetInput) SetName

SetName sets the Name field's value.

func (*CreateTrainingDatasetInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*CreateTrainingDatasetInput) SetTags

SetTags sets the Tags field's value.

func (*CreateTrainingDatasetInput) SetTrainingData

SetTrainingData sets the TrainingData field's value.

func (CreateTrainingDatasetInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTrainingDatasetInput) Validate

func (s *CreateTrainingDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTrainingDatasetOutput

type CreateTrainingDatasetOutput struct {

	// The Amazon Resource Name (ARN) of the training dataset resource.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTrainingDatasetOutput) GoString

func (s CreateTrainingDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTrainingDatasetOutput) SetTrainingDatasetArn

func (s *CreateTrainingDatasetOutput) SetTrainingDatasetArn(v string) *CreateTrainingDatasetOutput

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (CreateTrainingDatasetOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSource

type DataSource struct {

	// A GlueDataSource object that defines the catalog ID, database name, and table
	// name for the training data.
	//
	// GlueDataSource is a required field
	GlueDataSource *GlueDataSource `locationName:"glueDataSource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Defines information about the Glue data source that contains the training data.

func (DataSource) GoString

func (s DataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSource) SetGlueDataSource

func (s *DataSource) SetGlueDataSource(v *GlueDataSource) *DataSource

SetGlueDataSource sets the GlueDataSource field's value.

func (DataSource) String

func (s DataSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSource) Validate

func (s *DataSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Dataset

type Dataset struct {

	// A DatasetInputConfig object that defines the data source and schema mapping.
	//
	// InputConfig is a required field
	InputConfig *DatasetInputConfig `locationName:"inputConfig" type:"structure" required:"true"`

	// What type of information is found in the dataset.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"DatasetType"`
	// contains filtered or unexported fields
}

Defines where the training dataset is located, what type of data it contains, and how to access the data.

func (Dataset) GoString

func (s Dataset) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Dataset) SetInputConfig

func (s *Dataset) SetInputConfig(v *DatasetInputConfig) *Dataset

SetInputConfig sets the InputConfig field's value.

func (*Dataset) SetType

func (s *Dataset) SetType(v string) *Dataset

SetType sets the Type field's value.

func (Dataset) String

func (s Dataset) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Dataset) Validate

func (s *Dataset) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DatasetInputConfig

type DatasetInputConfig struct {

	// A DataSource object that specifies the Glue data source for the training
	// data.
	//
	// DataSource is a required field
	DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"`

	// The schema information for the training data.
	//
	// Schema is a required field
	Schema []*ColumnSchema `locationName:"schema" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Defines the Glue data source and schema mapping information.

func (DatasetInputConfig) GoString

func (s DatasetInputConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetInputConfig) SetDataSource

func (s *DatasetInputConfig) SetDataSource(v *DataSource) *DatasetInputConfig

SetDataSource sets the DataSource field's value.

func (*DatasetInputConfig) SetSchema

SetSchema sets the Schema field's value.

func (DatasetInputConfig) String

func (s DatasetInputConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DatasetInputConfig) Validate

func (s *DatasetInputConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAudienceGenerationJobInput

type DeleteAudienceGenerationJobInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you want
	// to delete.
	//
	// AudienceGenerationJobArn is a required field
	AudienceGenerationJobArn *string `location:"uri" locationName:"audienceGenerationJobArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAudienceGenerationJobInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAudienceGenerationJobInput) SetAudienceGenerationJobArn

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (DeleteAudienceGenerationJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAudienceGenerationJobInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteAudienceGenerationJobOutput

type DeleteAudienceGenerationJobOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAudienceGenerationJobOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAudienceGenerationJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAudienceModelInput

type DeleteAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the audience model that you want to delete.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `location:"uri" locationName:"audienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAudienceModelInput) GoString

func (s DeleteAudienceModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAudienceModelInput) SetAudienceModelArn

func (s *DeleteAudienceModelInput) SetAudienceModelArn(v string) *DeleteAudienceModelInput

SetAudienceModelArn sets the AudienceModelArn field's value.

func (DeleteAudienceModelInput) String

func (s DeleteAudienceModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAudienceModelInput) Validate

func (s *DeleteAudienceModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAudienceModelOutput

type DeleteAudienceModelOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAudienceModelOutput) GoString

func (s DeleteAudienceModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAudienceModelOutput) String

func (s DeleteAudienceModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteConfiguredAudienceModelInput

type DeleteConfiguredAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that you
	// want to delete.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `location:"uri" locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConfiguredAudienceModelInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConfiguredAudienceModelInput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (DeleteConfiguredAudienceModelInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConfiguredAudienceModelInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteConfiguredAudienceModelOutput

type DeleteConfiguredAudienceModelOutput struct {
	// contains filtered or unexported fields
}

func (DeleteConfiguredAudienceModelOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteConfiguredAudienceModelOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteConfiguredAudienceModelPolicyInput

type DeleteConfiguredAudienceModelPolicyInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model policy that
	// you want to delete.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `location:"uri" locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConfiguredAudienceModelPolicyInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConfiguredAudienceModelPolicyInput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (DeleteConfiguredAudienceModelPolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConfiguredAudienceModelPolicyInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteConfiguredAudienceModelPolicyOutput

type DeleteConfiguredAudienceModelPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteConfiguredAudienceModelPolicyOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteConfiguredAudienceModelPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTrainingDatasetInput

type DeleteTrainingDatasetInput struct {

	// The Amazon Resource Name (ARN) of the training dataset that you want to delete.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `location:"uri" locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTrainingDatasetInput) GoString

func (s DeleteTrainingDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTrainingDatasetInput) SetTrainingDatasetArn

func (s *DeleteTrainingDatasetInput) SetTrainingDatasetArn(v string) *DeleteTrainingDatasetInput

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (DeleteTrainingDatasetInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTrainingDatasetInput) Validate

func (s *DeleteTrainingDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTrainingDatasetOutput

type DeleteTrainingDatasetOutput struct {
	// contains filtered or unexported fields
}

func (DeleteTrainingDatasetOutput) GoString

func (s DeleteTrainingDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTrainingDatasetOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAudienceGenerationJobInput

type GetAudienceGenerationJobInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you are
	// interested in.
	//
	// AudienceGenerationJobArn is a required field
	AudienceGenerationJobArn *string `location:"uri" locationName:"audienceGenerationJobArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAudienceGenerationJobInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAudienceGenerationJobInput) SetAudienceGenerationJobArn

func (s *GetAudienceGenerationJobInput) SetAudienceGenerationJobArn(v string) *GetAudienceGenerationJobInput

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (GetAudienceGenerationJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAudienceGenerationJobInput) Validate

func (s *GetAudienceGenerationJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAudienceGenerationJobOutput

type GetAudienceGenerationJobOutput struct {

	// The Amazon Resource Name (ARN) of the audience generation job.
	//
	// AudienceGenerationJobArn is a required field
	AudienceGenerationJobArn *string `locationName:"audienceGenerationJobArn" min:"20" type:"string" required:"true"`

	// The identifier of the collaboration that this audience generation job is
	// associated with.
	CollaborationId *string `locationName:"collaborationId" min:"36" type:"string"`

	// The Amazon Resource Name (ARN) of the configured audience model used for
	// this audience generation job.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The time at which the audience generation job was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the audience generation job.
	Description *string `locationName:"description" type:"string"`

	// Configure whether the seed users are included in the output audience. By
	// default, Clean Rooms ML removes seed users from the output audience. If you
	// specify TRUE, the seed users will appear first in the output. Clean Rooms
	// ML does not explicitly reveal whether a user was in the seed, but the recipient
	// of the audience will know that the first minimumSeedSize count of users are
	// from the seed.
	IncludeSeedInOutput *bool `locationName:"includeSeedInOutput" type:"boolean"`

	// The relevance scores for different audience sizes and the recall score of
	// the generated audience.
	Metrics *AudienceQualityMetrics `locationName:"metrics" type:"structure"`

	// The name of the audience generation job.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The unique identifier of the protected query for this audience generation
	// job.
	ProtectedQueryIdentifier *string `locationName:"protectedQueryIdentifier" type:"string"`

	// The seed audience that was used for this audience generation job. This field
	// will be null if the account calling the API is the account that started this
	// audience generation job.
	SeedAudience *AudienceGenerationJobDataSource `locationName:"seedAudience" type:"structure"`

	// The AWS account that started this audience generation job.
	StartedBy *string `locationName:"startedBy" min:"12" type:"string"`

	// The status of the audience generation job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AudienceGenerationJobStatus"`

	// Details about the status of the audience generation job.
	StatusDetails *StatusDetails `locationName:"statusDetails" type:"structure"`

	// The tags that are associated to this audience generation job.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The most recent time at which the audience generation job was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (GetAudienceGenerationJobOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAudienceGenerationJobOutput) SetAudienceGenerationJobArn

func (s *GetAudienceGenerationJobOutput) SetAudienceGenerationJobArn(v string) *GetAudienceGenerationJobOutput

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (*GetAudienceGenerationJobOutput) SetCollaborationId

SetCollaborationId sets the CollaborationId field's value.

func (*GetAudienceGenerationJobOutput) SetConfiguredAudienceModelArn

func (s *GetAudienceGenerationJobOutput) SetConfiguredAudienceModelArn(v string) *GetAudienceGenerationJobOutput

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*GetAudienceGenerationJobOutput) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*GetAudienceGenerationJobOutput) SetDescription

SetDescription sets the Description field's value.

func (*GetAudienceGenerationJobOutput) SetIncludeSeedInOutput

SetIncludeSeedInOutput sets the IncludeSeedInOutput field's value.

func (*GetAudienceGenerationJobOutput) SetMetrics

SetMetrics sets the Metrics field's value.

func (*GetAudienceGenerationJobOutput) SetName

SetName sets the Name field's value.

func (*GetAudienceGenerationJobOutput) SetProtectedQueryIdentifier added in v1.55.1

func (s *GetAudienceGenerationJobOutput) SetProtectedQueryIdentifier(v string) *GetAudienceGenerationJobOutput

SetProtectedQueryIdentifier sets the ProtectedQueryIdentifier field's value.

func (*GetAudienceGenerationJobOutput) SetSeedAudience

SetSeedAudience sets the SeedAudience field's value.

func (*GetAudienceGenerationJobOutput) SetStartedBy

SetStartedBy sets the StartedBy field's value.

func (*GetAudienceGenerationJobOutput) SetStatus

SetStatus sets the Status field's value.

func (*GetAudienceGenerationJobOutput) SetStatusDetails

SetStatusDetails sets the StatusDetails field's value.

func (*GetAudienceGenerationJobOutput) SetTags

SetTags sets the Tags field's value.

func (*GetAudienceGenerationJobOutput) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (GetAudienceGenerationJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAudienceModelInput

type GetAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the audience model that you are interested
	// in.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `location:"uri" locationName:"audienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAudienceModelInput) GoString

func (s GetAudienceModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAudienceModelInput) SetAudienceModelArn

func (s *GetAudienceModelInput) SetAudienceModelArn(v string) *GetAudienceModelInput

SetAudienceModelArn sets the AudienceModelArn field's value.

func (GetAudienceModelInput) String

func (s GetAudienceModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAudienceModelInput) Validate

func (s *GetAudienceModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAudienceModelOutput

type GetAudienceModelOutput struct {

	// The Amazon Resource Name (ARN) of the audience model.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `locationName:"audienceModelArn" min:"20" type:"string" required:"true"`

	// The time at which the audience model was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the audience model.
	Description *string `locationName:"description" type:"string"`

	// The KMS key ARN used for the audience model.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"`

	// The name of the audience model.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The status of the audience model.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AudienceModelStatus"`

	// Details about the status of the audience model.
	StatusDetails *StatusDetails `locationName:"statusDetails" type:"structure"`

	// The tags that are assigned to the audience model.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The end date specified for the training window.
	TrainingDataEndTime *time.Time `locationName:"trainingDataEndTime" type:"timestamp" timestampFormat:"iso8601"`

	// The start date specified for the training window.
	TrainingDataStartTime *time.Time `locationName:"trainingDataStartTime" type:"timestamp" timestampFormat:"iso8601"`

	// The Amazon Resource Name (ARN) of the training dataset that was used for
	// this audience model.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`

	// The most recent time at which the audience model was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (GetAudienceModelOutput) GoString

func (s GetAudienceModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAudienceModelOutput) SetAudienceModelArn

func (s *GetAudienceModelOutput) SetAudienceModelArn(v string) *GetAudienceModelOutput

SetAudienceModelArn sets the AudienceModelArn field's value.

func (*GetAudienceModelOutput) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*GetAudienceModelOutput) SetDescription

SetDescription sets the Description field's value.

func (*GetAudienceModelOutput) SetKmsKeyArn

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*GetAudienceModelOutput) SetName

SetName sets the Name field's value.

func (*GetAudienceModelOutput) SetStatus

SetStatus sets the Status field's value.

func (*GetAudienceModelOutput) SetStatusDetails

SetStatusDetails sets the StatusDetails field's value.

func (*GetAudienceModelOutput) SetTags

SetTags sets the Tags field's value.

func (*GetAudienceModelOutput) SetTrainingDataEndTime

func (s *GetAudienceModelOutput) SetTrainingDataEndTime(v time.Time) *GetAudienceModelOutput

SetTrainingDataEndTime sets the TrainingDataEndTime field's value.

func (*GetAudienceModelOutput) SetTrainingDataStartTime

func (s *GetAudienceModelOutput) SetTrainingDataStartTime(v time.Time) *GetAudienceModelOutput

SetTrainingDataStartTime sets the TrainingDataStartTime field's value.

func (*GetAudienceModelOutput) SetTrainingDatasetArn

func (s *GetAudienceModelOutput) SetTrainingDatasetArn(v string) *GetAudienceModelOutput

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (*GetAudienceModelOutput) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (GetAudienceModelOutput) String

func (s GetAudienceModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetConfiguredAudienceModelInput

type GetConfiguredAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that you
	// are interested in.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `location:"uri" locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetConfiguredAudienceModelInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfiguredAudienceModelInput) SetConfiguredAudienceModelArn

func (s *GetConfiguredAudienceModelInput) SetConfiguredAudienceModelArn(v string) *GetConfiguredAudienceModelInput

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (GetConfiguredAudienceModelInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfiguredAudienceModelInput) Validate

func (s *GetConfiguredAudienceModelInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConfiguredAudienceModelOutput

type GetConfiguredAudienceModelOutput struct {

	// The Amazon Resource Name (ARN) of the audience model used for this configured
	// audience model.
	//
	// AudienceModelArn is a required field
	AudienceModelArn *string `locationName:"audienceModelArn" min:"20" type:"string" required:"true"`

	// The list of output sizes of audiences that can be created using this configured
	// audience model. A request to StartAudienceGenerationJob that uses this configured
	// audience model must have an audienceSize selected from this list. You can
	// use the ABSOLUTE AudienceSize to configure out audience sizes using the count
	// of identifiers in the output. You can use the Percentage AudienceSize to
	// configure sizes in the range 1-100 percent.
	AudienceSizeConfig *AudienceSizeConfig `locationName:"audienceSizeConfig" type:"structure"`

	// Provides the childResourceTagOnCreatePolicy that was used for this configured
	// audience model.
	ChildResourceTagOnCreatePolicy *string `locationName:"childResourceTagOnCreatePolicy" type:"string" enum:"TagOnCreatePolicy"`

	// The Amazon Resource Name (ARN) of the configured audience model.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The time at which the configured audience model was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the configured audience model.
	Description *string `locationName:"description" type:"string"`

	// The minimum number of users from the seed audience that must match with users
	// in the training data of the audience model.
	MinMatchingSeedSize *int64 `locationName:"minMatchingSeedSize" min:"25" type:"integer"`

	// The name of the configured audience model.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The output configuration of the configured audience model
	//
	// OutputConfig is a required field
	OutputConfig *ConfiguredAudienceModelOutputConfig `locationName:"outputConfig" type:"structure" required:"true"`

	// Whether audience metrics are shared.
	//
	// SharedAudienceMetrics is a required field
	SharedAudienceMetrics []*string `locationName:"sharedAudienceMetrics" min:"1" type:"list" required:"true" enum:"SharedAudienceMetrics"`

	// The status of the configured audience model.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ConfiguredAudienceModelStatus"`

	// The tags that are associated to this configured audience model.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The most recent time at which the configured audience model was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (GetConfiguredAudienceModelOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfiguredAudienceModelOutput) SetAudienceModelArn

SetAudienceModelArn sets the AudienceModelArn field's value.

func (*GetConfiguredAudienceModelOutput) SetAudienceSizeConfig

SetAudienceSizeConfig sets the AudienceSizeConfig field's value.

func (*GetConfiguredAudienceModelOutput) SetChildResourceTagOnCreatePolicy

func (s *GetConfiguredAudienceModelOutput) SetChildResourceTagOnCreatePolicy(v string) *GetConfiguredAudienceModelOutput

SetChildResourceTagOnCreatePolicy sets the ChildResourceTagOnCreatePolicy field's value.

func (*GetConfiguredAudienceModelOutput) SetConfiguredAudienceModelArn

func (s *GetConfiguredAudienceModelOutput) SetConfiguredAudienceModelArn(v string) *GetConfiguredAudienceModelOutput

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*GetConfiguredAudienceModelOutput) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*GetConfiguredAudienceModelOutput) SetDescription

SetDescription sets the Description field's value.

func (*GetConfiguredAudienceModelOutput) SetMinMatchingSeedSize

SetMinMatchingSeedSize sets the MinMatchingSeedSize field's value.

func (*GetConfiguredAudienceModelOutput) SetName

SetName sets the Name field's value.

func (*GetConfiguredAudienceModelOutput) SetOutputConfig

SetOutputConfig sets the OutputConfig field's value.

func (*GetConfiguredAudienceModelOutput) SetSharedAudienceMetrics

SetSharedAudienceMetrics sets the SharedAudienceMetrics field's value.

func (*GetConfiguredAudienceModelOutput) SetStatus

SetStatus sets the Status field's value.

func (*GetConfiguredAudienceModelOutput) SetTags

SetTags sets the Tags field's value.

func (*GetConfiguredAudienceModelOutput) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (GetConfiguredAudienceModelOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetConfiguredAudienceModelPolicyInput

type GetConfiguredAudienceModelPolicyInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that you
	// are interested in.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `location:"uri" locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetConfiguredAudienceModelPolicyInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfiguredAudienceModelPolicyInput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (GetConfiguredAudienceModelPolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfiguredAudienceModelPolicyInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetConfiguredAudienceModelPolicyOutput

type GetConfiguredAudienceModelPolicyOutput struct {

	// The Amazon Resource Name (ARN) of the configured audience model.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The configured audience model policy. This is a JSON IAM resource policy.
	//
	// ConfiguredAudienceModelPolicy is a required field
	ConfiguredAudienceModelPolicy *string `locationName:"configuredAudienceModelPolicy" min:"1" type:"string" required:"true"`

	// A cryptographic hash of the contents of the policy used to prevent unexpected
	// concurrent modification of the policy.
	//
	// PolicyHash is a required field
	PolicyHash *string `locationName:"policyHash" min:"64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetConfiguredAudienceModelPolicyOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConfiguredAudienceModelPolicyOutput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*GetConfiguredAudienceModelPolicyOutput) SetConfiguredAudienceModelPolicy

SetConfiguredAudienceModelPolicy sets the ConfiguredAudienceModelPolicy field's value.

func (*GetConfiguredAudienceModelPolicyOutput) SetPolicyHash

SetPolicyHash sets the PolicyHash field's value.

func (GetConfiguredAudienceModelPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTrainingDatasetInput

type GetTrainingDatasetInput struct {

	// The Amazon Resource Name (ARN) of the training dataset that you are interested
	// in.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `location:"uri" locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTrainingDatasetInput) GoString

func (s GetTrainingDatasetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTrainingDatasetInput) SetTrainingDatasetArn

func (s *GetTrainingDatasetInput) SetTrainingDatasetArn(v string) *GetTrainingDatasetInput

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (GetTrainingDatasetInput) String

func (s GetTrainingDatasetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTrainingDatasetInput) Validate

func (s *GetTrainingDatasetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTrainingDatasetOutput

type GetTrainingDatasetOutput struct {

	// The time at which the training dataset was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the training dataset.
	Description *string `locationName:"description" type:"string"`

	// The name of the training dataset.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The IAM role used to read the training data.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"20" type:"string" required:"true"`

	// The status of the training dataset.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"TrainingDatasetStatus"`

	// The tags that are assigned to this training dataset.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Metadata about the requested training data.
	//
	// TrainingData is a required field
	TrainingData []*Dataset `locationName:"trainingData" type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the training dataset.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`

	// The most recent time at which the training dataset was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (GetTrainingDatasetOutput) GoString

func (s GetTrainingDatasetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTrainingDatasetOutput) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*GetTrainingDatasetOutput) SetDescription

SetDescription sets the Description field's value.

func (*GetTrainingDatasetOutput) SetName

SetName sets the Name field's value.

func (*GetTrainingDatasetOutput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*GetTrainingDatasetOutput) SetStatus

SetStatus sets the Status field's value.

func (*GetTrainingDatasetOutput) SetTags

SetTags sets the Tags field's value.

func (*GetTrainingDatasetOutput) SetTrainingData

func (s *GetTrainingDatasetOutput) SetTrainingData(v []*Dataset) *GetTrainingDatasetOutput

SetTrainingData sets the TrainingData field's value.

func (*GetTrainingDatasetOutput) SetTrainingDatasetArn

func (s *GetTrainingDatasetOutput) SetTrainingDatasetArn(v string) *GetTrainingDatasetOutput

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (*GetTrainingDatasetOutput) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (GetTrainingDatasetOutput) String

func (s GetTrainingDatasetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GlueDataSource

type GlueDataSource struct {

	// The Glue catalog that contains the training data.
	CatalogId *string `locationName:"catalogId" min:"12" type:"string"`

	// The Glue database that contains the training data.
	//
	// DatabaseName is a required field
	DatabaseName *string `locationName:"databaseName" min:"1" type:"string" required:"true"`

	// The Glue table that contains the training data.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Defines the Glue data source that contains the training data.

func (GlueDataSource) GoString

func (s GlueDataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlueDataSource) SetCatalogId

func (s *GlueDataSource) SetCatalogId(v string) *GlueDataSource

SetCatalogId sets the CatalogId field's value.

func (*GlueDataSource) SetDatabaseName

func (s *GlueDataSource) SetDatabaseName(v string) *GlueDataSource

SetDatabaseName sets the DatabaseName field's value.

func (*GlueDataSource) SetTableName

func (s *GlueDataSource) SetTableName(v string) *GlueDataSource

SetTableName sets the TableName field's value.

func (GlueDataSource) String

func (s GlueDataSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GlueDataSource) Validate

func (s *GlueDataSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAudienceExportJobsInput

type ListAudienceExportJobsInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you are
	// interested in.
	AudienceGenerationJobArn *string `location:"querystring" locationName:"audienceGenerationJobArn" min:"20" type:"string"`

	// The maximum size of the results that is returned per call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAudienceExportJobsInput) GoString

func (s ListAudienceExportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceExportJobsInput) SetAudienceGenerationJobArn

func (s *ListAudienceExportJobsInput) SetAudienceGenerationJobArn(v string) *ListAudienceExportJobsInput

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (*ListAudienceExportJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAudienceExportJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAudienceExportJobsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceExportJobsInput) Validate

func (s *ListAudienceExportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAudienceExportJobsOutput

type ListAudienceExportJobsOutput struct {

	// The audience export jobs that match the request.
	//
	// AudienceExportJobs is a required field
	AudienceExportJobs []*AudienceExportJobSummary `locationName:"audienceExportJobs" type:"list" required:"true"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAudienceExportJobsOutput) GoString

func (s ListAudienceExportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceExportJobsOutput) SetAudienceExportJobs

SetAudienceExportJobs sets the AudienceExportJobs field's value.

func (*ListAudienceExportJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAudienceExportJobsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAudienceGenerationJobsInput

type ListAudienceGenerationJobsInput struct {

	// The identifier of the collaboration that contains the audience generation
	// jobs that you are interested in.
	CollaborationId *string `location:"querystring" locationName:"collaborationId" min:"36" type:"string"`

	// The Amazon Resource Name (ARN) of the configured audience model that was
	// used for the audience generation jobs that you are interested in.
	ConfiguredAudienceModelArn *string `location:"querystring" locationName:"configuredAudienceModelArn" min:"20" type:"string"`

	// The maximum size of the results that is returned per call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAudienceGenerationJobsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceGenerationJobsInput) SetCollaborationId

SetCollaborationId sets the CollaborationId field's value.

func (*ListAudienceGenerationJobsInput) SetConfiguredAudienceModelArn

func (s *ListAudienceGenerationJobsInput) SetConfiguredAudienceModelArn(v string) *ListAudienceGenerationJobsInput

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*ListAudienceGenerationJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAudienceGenerationJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAudienceGenerationJobsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceGenerationJobsInput) Validate

func (s *ListAudienceGenerationJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAudienceGenerationJobsOutput

type ListAudienceGenerationJobsOutput struct {

	// The audience generation jobs that match the request.
	//
	// AudienceGenerationJobs is a required field
	AudienceGenerationJobs []*AudienceGenerationJobSummary `locationName:"audienceGenerationJobs" type:"list" required:"true"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAudienceGenerationJobsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceGenerationJobsOutput) SetAudienceGenerationJobs

SetAudienceGenerationJobs sets the AudienceGenerationJobs field's value.

func (*ListAudienceGenerationJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAudienceGenerationJobsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAudienceModelsInput

type ListAudienceModelsInput struct {

	// The maximum size of the results that is returned per call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAudienceModelsInput) GoString

func (s ListAudienceModelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceModelsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAudienceModelsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAudienceModelsInput) String

func (s ListAudienceModelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceModelsInput) Validate

func (s *ListAudienceModelsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAudienceModelsOutput

type ListAudienceModelsOutput struct {

	// The audience models that match the request.
	//
	// AudienceModels is a required field
	AudienceModels []*AudienceModelSummary `locationName:"audienceModels" type:"list" required:"true"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAudienceModelsOutput) GoString

func (s ListAudienceModelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAudienceModelsOutput) SetAudienceModels

SetAudienceModels sets the AudienceModels field's value.

func (*ListAudienceModelsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAudienceModelsOutput) String

func (s ListAudienceModelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListConfiguredAudienceModelsInput

type ListConfiguredAudienceModelsInput struct {

	// The maximum size of the results that is returned per call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListConfiguredAudienceModelsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConfiguredAudienceModelsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListConfiguredAudienceModelsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListConfiguredAudienceModelsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConfiguredAudienceModelsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListConfiguredAudienceModelsOutput

type ListConfiguredAudienceModelsOutput struct {

	// The configured audience models.
	//
	// ConfiguredAudienceModels is a required field
	ConfiguredAudienceModels []*ConfiguredAudienceModelSummary `locationName:"configuredAudienceModels" type:"list" required:"true"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListConfiguredAudienceModelsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConfiguredAudienceModelsOutput) SetConfiguredAudienceModels

SetConfiguredAudienceModels sets the ConfiguredAudienceModels field's value.

func (*ListConfiguredAudienceModelsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListConfiguredAudienceModelsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you are interested in.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags that are associated with the resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTrainingDatasetsInput

type ListTrainingDatasetsInput struct {

	// The maximum size of the results that is returned per call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTrainingDatasetsInput) GoString

func (s ListTrainingDatasetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrainingDatasetsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListTrainingDatasetsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListTrainingDatasetsInput) String

func (s ListTrainingDatasetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrainingDatasetsInput) Validate

func (s *ListTrainingDatasetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTrainingDatasetsOutput

type ListTrainingDatasetsOutput struct {

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The training datasets that match the request.
	//
	// TrainingDatasets is a required field
	TrainingDatasets []*TrainingDatasetSummary `locationName:"trainingDatasets" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListTrainingDatasetsOutput) GoString

func (s ListTrainingDatasetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTrainingDatasetsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTrainingDatasetsOutput) SetTrainingDatasets

SetTrainingDatasets sets the TrainingDatasets field's value.

func (ListTrainingDatasetsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProtectedQuerySQLParameters added in v1.55.1

type ProtectedQuerySQLParameters struct {

	// The Amazon Resource Name (ARN) associated with the analysis template within
	// a collaboration.
	AnalysisTemplateArn *string `locationName:"analysisTemplateArn" type:"string"`

	// The protected query SQL parameters.
	Parameters map[string]*string `locationName:"parameters" type:"map"`

	// The query string to be submitted.
	QueryString *string `locationName:"queryString" type:"string"`
	// contains filtered or unexported fields
}

The parameters for the SQL type Protected Query.

func (ProtectedQuerySQLParameters) GoString added in v1.55.1

func (s ProtectedQuerySQLParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProtectedQuerySQLParameters) SetAnalysisTemplateArn added in v1.55.1

func (s *ProtectedQuerySQLParameters) SetAnalysisTemplateArn(v string) *ProtectedQuerySQLParameters

SetAnalysisTemplateArn sets the AnalysisTemplateArn field's value.

func (*ProtectedQuerySQLParameters) SetParameters added in v1.55.1

SetParameters sets the Parameters field's value.

func (*ProtectedQuerySQLParameters) SetQueryString added in v1.55.1

SetQueryString sets the QueryString field's value.

func (ProtectedQuerySQLParameters) String added in v1.55.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutConfiguredAudienceModelPolicyInput

type PutConfiguredAudienceModelPolicyInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that the
	// resource policy will govern.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `location:"uri" locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The IAM resource policy.
	//
	// ConfiguredAudienceModelPolicy is a required field
	ConfiguredAudienceModelPolicy *string `locationName:"configuredAudienceModelPolicy" min:"1" type:"string" required:"true"`

	// Use this to prevent unexpected concurrent modification of the policy.
	PolicyExistenceCondition *string `locationName:"policyExistenceCondition" type:"string" enum:"PolicyExistenceCondition"`

	// A cryptographic hash of the contents of the policy used to prevent unexpected
	// concurrent modification of the policy.
	PreviousPolicyHash *string `locationName:"previousPolicyHash" min:"64" type:"string"`
	// contains filtered or unexported fields
}

func (PutConfiguredAudienceModelPolicyInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutConfiguredAudienceModelPolicyInput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*PutConfiguredAudienceModelPolicyInput) SetConfiguredAudienceModelPolicy

SetConfiguredAudienceModelPolicy sets the ConfiguredAudienceModelPolicy field's value.

func (*PutConfiguredAudienceModelPolicyInput) SetPolicyExistenceCondition

SetPolicyExistenceCondition sets the PolicyExistenceCondition field's value.

func (*PutConfiguredAudienceModelPolicyInput) SetPreviousPolicyHash

SetPreviousPolicyHash sets the PreviousPolicyHash field's value.

func (PutConfiguredAudienceModelPolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutConfiguredAudienceModelPolicyInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutConfiguredAudienceModelPolicyOutput

type PutConfiguredAudienceModelPolicyOutput struct {

	// The IAM resource policy.
	//
	// ConfiguredAudienceModelPolicy is a required field
	ConfiguredAudienceModelPolicy *string `locationName:"configuredAudienceModelPolicy" min:"1" type:"string" required:"true"`

	// A cryptographic hash of the contents of the policy used to prevent unexpected
	// concurrent modification of the policy.
	//
	// PolicyHash is a required field
	PolicyHash *string `locationName:"policyHash" min:"64" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutConfiguredAudienceModelPolicyOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutConfiguredAudienceModelPolicyOutput) SetConfiguredAudienceModelPolicy

SetConfiguredAudienceModelPolicy sets the ConfiguredAudienceModelPolicy field's value.

func (*PutConfiguredAudienceModelPolicyOutput) SetPolicyHash

SetPolicyHash sets the PolicyHash field's value.

func (PutConfiguredAudienceModelPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelevanceMetric

type RelevanceMetric struct {

	// The size of the generated audience. Must match one of the sizes in the configured
	// audience model.
	//
	// AudienceSize is a required field
	AudienceSize *AudienceSize `locationName:"audienceSize" type:"structure" required:"true"`

	// The relevance score of the generated audience.
	Score *float64 `locationName:"score" type:"double"`
	// contains filtered or unexported fields
}

The relevance score of a generated audience.

func (RelevanceMetric) GoString

func (s RelevanceMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelevanceMetric) SetAudienceSize

func (s *RelevanceMetric) SetAudienceSize(v *AudienceSize) *RelevanceMetric

SetAudienceSize sets the AudienceSize field's value.

func (*RelevanceMetric) SetScore

func (s *RelevanceMetric) SetScore(v float64) *RelevanceMetric

SetScore sets the Score field's value.

func (RelevanceMetric) String

func (s RelevanceMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource you are requesting does not exist.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3ConfigMap

type S3ConfigMap struct {

	// The Amazon S3 location URI.
	//
	// S3Uri is a required field
	S3Uri *string `locationName:"s3Uri" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Provides information about an Amazon S3 bucket and path.

func (S3ConfigMap) GoString

func (s S3ConfigMap) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3ConfigMap) SetS3Uri

func (s *S3ConfigMap) SetS3Uri(v string) *S3ConfigMap

SetS3Uri sets the S3Uri field's value.

func (S3ConfigMap) String

func (s S3ConfigMap) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3ConfigMap) Validate

func (s *S3ConfigMap) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You have exceeded your service quota.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartAudienceExportJobInput

type StartAudienceExportJobInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you want
	// to export.
	//
	// AudienceGenerationJobArn is a required field
	AudienceGenerationJobArn *string `locationName:"audienceGenerationJobArn" min:"20" type:"string" required:"true"`

	// The size of the generated audience. Must match one of the sizes in the configured
	// audience model.
	//
	// AudienceSize is a required field
	AudienceSize *AudienceSize `locationName:"audienceSize" type:"structure" required:"true"`

	// The description of the audience export job.
	Description *string `locationName:"description" type:"string"`

	// The name of the audience export job.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartAudienceExportJobInput) GoString

func (s StartAudienceExportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAudienceExportJobInput) SetAudienceGenerationJobArn

func (s *StartAudienceExportJobInput) SetAudienceGenerationJobArn(v string) *StartAudienceExportJobInput

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (*StartAudienceExportJobInput) SetAudienceSize

SetAudienceSize sets the AudienceSize field's value.

func (*StartAudienceExportJobInput) SetDescription

SetDescription sets the Description field's value.

func (*StartAudienceExportJobInput) SetName

SetName sets the Name field's value.

func (StartAudienceExportJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAudienceExportJobInput) Validate

func (s *StartAudienceExportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartAudienceExportJobOutput

type StartAudienceExportJobOutput struct {
	// contains filtered or unexported fields
}

func (StartAudienceExportJobOutput) GoString

func (s StartAudienceExportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StartAudienceExportJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartAudienceGenerationJobInput

type StartAudienceGenerationJobInput struct {

	// The identifier of the collaboration that contains the audience generation
	// job.
	CollaborationId *string `locationName:"collaborationId" min:"36" type:"string"`

	// The Amazon Resource Name (ARN) of the configured audience model that is used
	// for this audience generation job.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The description of the audience generation job.
	Description *string `locationName:"description" type:"string"`

	// Whether the seed audience is included in the audience generation output.
	IncludeSeedInOutput *bool `locationName:"includeSeedInOutput" type:"boolean"`

	// The name of the audience generation job.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The seed audience that is used to generate the audience.
	//
	// SeedAudience is a required field
	SeedAudience *AudienceGenerationJobDataSource `locationName:"seedAudience" type:"structure" required:"true"`

	// The optional metadata that you apply to the resource to help you categorize
	// and organize them. Each tag consists of a key and an optional value, both
	// of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50.
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8.
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8.
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for keys as it is reserved for AWS use. You cannot edit or
	//    delete tag keys with this prefix. Values can have this prefix. If a tag
	//    value has aws as its prefix but the key does not, then Clean Rooms ML
	//    considers it to be a user tag and will count against the limit of 50 tags.
	//    Tags with only the key prefix of aws do not count against your tags per
	//    resource limit.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (StartAudienceGenerationJobInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAudienceGenerationJobInput) SetCollaborationId

SetCollaborationId sets the CollaborationId field's value.

func (*StartAudienceGenerationJobInput) SetConfiguredAudienceModelArn

func (s *StartAudienceGenerationJobInput) SetConfiguredAudienceModelArn(v string) *StartAudienceGenerationJobInput

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*StartAudienceGenerationJobInput) SetDescription

SetDescription sets the Description field's value.

func (*StartAudienceGenerationJobInput) SetIncludeSeedInOutput

SetIncludeSeedInOutput sets the IncludeSeedInOutput field's value.

func (*StartAudienceGenerationJobInput) SetName

SetName sets the Name field's value.

func (*StartAudienceGenerationJobInput) SetSeedAudience

SetSeedAudience sets the SeedAudience field's value.

func (*StartAudienceGenerationJobInput) SetTags

SetTags sets the Tags field's value.

func (StartAudienceGenerationJobInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAudienceGenerationJobInput) Validate

func (s *StartAudienceGenerationJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartAudienceGenerationJobOutput

type StartAudienceGenerationJobOutput struct {

	// The Amazon Resource Name (ARN) of the audience generation job.
	//
	// AudienceGenerationJobArn is a required field
	AudienceGenerationJobArn *string `locationName:"audienceGenerationJobArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartAudienceGenerationJobOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartAudienceGenerationJobOutput) SetAudienceGenerationJobArn

SetAudienceGenerationJobArn sets the AudienceGenerationJobArn field's value.

func (StartAudienceGenerationJobOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatusDetails

type StatusDetails struct {

	// The error message that was returned. The message is intended for human consumption
	// and can change at any time. Use the statusCode for programmatic error handling.
	Message *string `locationName:"message" type:"string"`

	// The status code that was returned. The status code is intended for programmatic
	// error handling. Clean Rooms ML will not change the status code for existing
	// error conditions.
	StatusCode *string `locationName:"statusCode" type:"string"`
	// contains filtered or unexported fields
}

Details about the status of a resource.

func (StatusDetails) GoString

func (s StatusDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatusDetails) SetMessage

func (s *StatusDetails) SetMessage(v string) *StatusDetails

SetMessage sets the Message field's value.

func (*StatusDetails) SetStatusCode

func (s *StatusDetails) SetStatusCode(v string) *StatusDetails

SetStatusCode sets the StatusCode field's value.

func (StatusDetails) String

func (s StatusDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to assign tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The optional metadata that you apply to the resource to help you categorize
	// and organize them. Each tag consists of a key and an optional value, both
	// of which you define.
	//
	// The following basic restrictions apply to tags:
	//
	//    * Maximum number of tags per resource - 50.
	//
	//    * For each resource, each tag key must be unique, and each tag key can
	//    have only one value.
	//
	//    * Maximum key length - 128 Unicode characters in UTF-8.
	//
	//    * Maximum value length - 256 Unicode characters in UTF-8.
	//
	//    * If your tagging schema is used across multiple services and resources,
	//    remember that other services may have restrictions on allowed characters.
	//    Generally allowed characters are: letters, numbers, and spaces representable
	//    in UTF-8, and the following characters: + - = . _ : / @.
	//
	//    * Tag keys and values are case sensitive.
	//
	//    * Do not use aws:, AWS:, or any upper or lowercase combination of such
	//    as a prefix for keys as it is reserved for AWS use. You cannot edit or
	//    delete tag keys with this prefix. Values can have this prefix. If a tag
	//    value has aws as its prefix but the key does not, then Clean Rooms considers
	//    it to be a user tag and will count against the limit of 50 tags. Tags
	//    with only the key prefix of aws do not count against your tags per resource
	//    limit.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TrainingDatasetSummary

type TrainingDatasetSummary struct {

	// The time at which the training dataset was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the training dataset.
	Description *string `locationName:"description" type:"string"`

	// The name of the training dataset.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The status of the training dataset.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"TrainingDatasetStatus"`

	// The Amazon Resource Name (ARN) of the training dataset.
	//
	// TrainingDatasetArn is a required field
	TrainingDatasetArn *string `locationName:"trainingDatasetArn" min:"20" type:"string" required:"true"`

	// The most recent time at which the training dataset was updated.
	//
	// UpdateTime is a required field
	UpdateTime *time.Time `locationName:"updateTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Provides information about the training dataset.

func (TrainingDatasetSummary) GoString

func (s TrainingDatasetSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TrainingDatasetSummary) SetCreateTime

SetCreateTime sets the CreateTime field's value.

func (*TrainingDatasetSummary) SetDescription

SetDescription sets the Description field's value.

func (*TrainingDatasetSummary) SetName

SetName sets the Name field's value.

func (*TrainingDatasetSummary) SetStatus

SetStatus sets the Status field's value.

func (*TrainingDatasetSummary) SetTrainingDatasetArn

func (s *TrainingDatasetSummary) SetTrainingDatasetArn(v string) *TrainingDatasetSummary

SetTrainingDatasetArn sets the TrainingDatasetArn field's value.

func (*TrainingDatasetSummary) SetUpdateTime

SetUpdateTime sets the UpdateTime field's value.

func (TrainingDatasetSummary) String

func (s TrainingDatasetSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove tags
	// from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The key values of tags that you want to remove.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateConfiguredAudienceModelInput

type UpdateConfiguredAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the new audience model that you want to
	// use.
	AudienceModelArn *string `locationName:"audienceModelArn" min:"20" type:"string"`

	// The new audience size configuration.
	AudienceSizeConfig *AudienceSizeConfig `locationName:"audienceSizeConfig" type:"structure"`

	// The Amazon Resource Name (ARN) of the configured audience model that you
	// want to update.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `location:"uri" locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`

	// The new description of the configured audience model.
	Description *string `locationName:"description" type:"string"`

	// The minimum number of users from the seed audience that must match with users
	// in the training data of the audience model.
	MinMatchingSeedSize *int64 `locationName:"minMatchingSeedSize" min:"25" type:"integer"`

	// The new output configuration.
	OutputConfig *ConfiguredAudienceModelOutputConfig `locationName:"outputConfig" type:"structure"`

	// The new value for whether to share audience metrics.
	SharedAudienceMetrics []*string `locationName:"sharedAudienceMetrics" min:"1" type:"list" enum:"SharedAudienceMetrics"`
	// contains filtered or unexported fields
}

func (UpdateConfiguredAudienceModelInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConfiguredAudienceModelInput) SetAudienceModelArn

SetAudienceModelArn sets the AudienceModelArn field's value.

func (*UpdateConfiguredAudienceModelInput) SetAudienceSizeConfig

SetAudienceSizeConfig sets the AudienceSizeConfig field's value.

func (*UpdateConfiguredAudienceModelInput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (*UpdateConfiguredAudienceModelInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateConfiguredAudienceModelInput) SetMinMatchingSeedSize

SetMinMatchingSeedSize sets the MinMatchingSeedSize field's value.

func (*UpdateConfiguredAudienceModelInput) SetOutputConfig

SetOutputConfig sets the OutputConfig field's value.

func (*UpdateConfiguredAudienceModelInput) SetSharedAudienceMetrics

SetSharedAudienceMetrics sets the SharedAudienceMetrics field's value.

func (UpdateConfiguredAudienceModelInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConfiguredAudienceModelInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateConfiguredAudienceModelOutput

type UpdateConfiguredAudienceModelOutput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that was
	// updated.
	//
	// ConfiguredAudienceModelArn is a required field
	ConfiguredAudienceModelArn *string `locationName:"configuredAudienceModelArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateConfiguredAudienceModelOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConfiguredAudienceModelOutput) SetConfiguredAudienceModelArn

SetConfiguredAudienceModelArn sets the ConfiguredAudienceModelArn field's value.

func (UpdateConfiguredAudienceModelOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request parameters for this request are incorrect.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package cleanroomsmliface provides an interface to enable mocking the AWS Clean Rooms ML service client for testing your code.
Package cleanroomsmliface provides an interface to enable mocking the AWS Clean Rooms ML service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL