types

package
v1.4.4 Latest Latest
Warning

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

 Go to latest Published: May 23, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

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

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AudienceDestination 

type AudienceDestination struct {

	// The Amazon S3 bucket and path for the configured audience.
	//
	// This member is required.
	S3Destination *S3ConfigMap
	// contains filtered or unexported fields
}

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

type AudienceExportJobStatus 

type AudienceExportJobStatus string
const (
	AudienceExportJobStatusCreatePending    AudienceExportJobStatus = "CREATE_PENDING"
	AudienceExportJobStatusCreateInProgress AudienceExportJobStatus = "CREATE_IN_PROGRESS"
	AudienceExportJobStatusCreateFailed     AudienceExportJobStatus = "CREATE_FAILED"
	AudienceExportJobStatusActive           AudienceExportJobStatus = "ACTIVE"
)

Enum values for AudienceExportJobStatus

func (AudienceExportJobStatus) Values 

func (AudienceExportJobStatus) Values() []AudienceExportJobStatus

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

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

type AudienceExportJobSummary 

type AudienceExportJobSummary struct {

	// The Amazon Resource Name (ARN) of the audience generation job that was exported.
	//
	// This member is required.
	AudienceGenerationJobArn *string

	// The size of the generated audience. Must match one of the sizes in the
	// configured audience model.
	//
	// This member is required.
	AudienceSize *AudienceSize

	// The time at which the audience export job was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The name of the audience export job.
	//
	// This member is required.
	Name *string

	// The status of the audience export job.
	//
	// This member is required.
	Status AudienceExportJobStatus

	// The most recent time at which the audience export job was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the audience export job.
	Description *string

	// The Amazon S3 bucket where the audience export is stored.
	OutputLocation *string

	// Details about the status of a resource.
	StatusDetails *StatusDetails
	// contains filtered or unexported fields
}

Provides information about the audience export job.

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"}
	//
	//     ...
	//
	// This member is required.
	DataSource *S3ConfigMap

	// The ARN of the IAM role that can read the Amazon S3 bucket where the training
	// data is stored.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

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

type AudienceGenerationJobStatus 

type AudienceGenerationJobStatus string
const (
	AudienceGenerationJobStatusCreatePending    AudienceGenerationJobStatus = "CREATE_PENDING"
	AudienceGenerationJobStatusCreateInProgress AudienceGenerationJobStatus = "CREATE_IN_PROGRESS"
	AudienceGenerationJobStatusCreateFailed     AudienceGenerationJobStatus = "CREATE_FAILED"
	AudienceGenerationJobStatusActive           AudienceGenerationJobStatus = "ACTIVE"
	AudienceGenerationJobStatusDeletePending    AudienceGenerationJobStatus = "DELETE_PENDING"
	AudienceGenerationJobStatusDeleteInProgress AudienceGenerationJobStatus = "DELETE_IN_PROGRESS"
	AudienceGenerationJobStatusDeleteFailed     AudienceGenerationJobStatus = "DELETE_FAILED"
)

Enum values for AudienceGenerationJobStatus

func (AudienceGenerationJobStatus) Values 

func (AudienceGenerationJobStatus) Values() []AudienceGenerationJobStatus

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

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

type AudienceGenerationJobSummary 

type AudienceGenerationJobSummary struct {

	// The Amazon Resource Name (ARN) of the audience generation job.
	//
	// This member is required.
	AudienceGenerationJobArn *string

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

	// The time at which the audience generation job was created.
	//
	// This member is required.
	CreateTime *time.Time

	// The name of the audience generation job.
	//
	// This member is required.
	Name *string

	// The status of the audience generation job.
	//
	// This member is required.
	Status AudienceGenerationJobStatus

	// The most recent time at which the audience generation job was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The identifier of the collaboration that contains this audience generation job.
	CollaborationId *string

	// The description of the audience generation job.
	Description *string

	// The AWS Account that submitted the job.
	StartedBy *string
	// contains filtered or unexported fields
}

Provides information about the configured audience generation job.

type AudienceModelStatus 

type AudienceModelStatus string
const (
	AudienceModelStatusCreatePending    AudienceModelStatus = "CREATE_PENDING"
	AudienceModelStatusCreateInProgress AudienceModelStatus = "CREATE_IN_PROGRESS"
	AudienceModelStatusCreateFailed     AudienceModelStatus = "CREATE_FAILED"
	AudienceModelStatusActive           AudienceModelStatus = "ACTIVE"
	AudienceModelStatusDeletePending    AudienceModelStatus = "DELETE_PENDING"
	AudienceModelStatusDeleteInProgress AudienceModelStatus = "DELETE_IN_PROGRESS"
	AudienceModelStatusDeleteFailed     AudienceModelStatus = "DELETE_FAILED"
)

Enum values for AudienceModelStatus

func (AudienceModelStatus) Values 

func (AudienceModelStatus) Values() []AudienceModelStatus

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

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

type AudienceModelSummary 

type AudienceModelSummary struct {

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

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

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

	// The status of the audience model.
	//
	// This member is required.
	Status AudienceModelStatus

	// The Amazon Resource Name (ARN) of the training dataset that was used for the
	// audience model.
	//
	// This member is required.
	TrainingDatasetArn *string

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

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

Information about the audience model.

type AudienceQualityMetrics 

type AudienceQualityMetrics struct {

	// The relevance scores of the generated audience.
	//
	// This member is required.
	RelevanceMetrics []RelevanceMetric

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

Metrics that describe the quality of the generated audience.

type AudienceSize 

type AudienceSize struct {

	// Whether the audience size is defined in absolute terms or as a percentage. You
	// can use the ABSOLUTEAudienceSize to configure out audience sizes using the count of
	// identifiers in the output. You can use the PercentageAudienceSize to configure sizes in the
	// range 1-100 percent.
	//
	// This member is required.
	Type AudienceSizeType

	// Specify an audience size value.
	//
	// This member is required.
	Value *int32
	// contains filtered or unexported fields
}

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

type AudienceSizeConfig 

type AudienceSizeConfig struct {

	// An array of the different audience output sizes.
	//
	// This member is required.
	AudienceSizeBins []int32

	// Whether the audience output sizes are defined as an absolute number or a
	// percentage.
	//
	// This member is required.
	AudienceSizeType AudienceSizeType
	// contains filtered or unexported fields
}

Configure the list of audience output sizes that can be created. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTEAudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the PercentageAudienceSize to configure sizes in the range 1-100 percent.

type AudienceSizeType 

type AudienceSizeType string
const (
	AudienceSizeTypeAbsolute   AudienceSizeType = "ABSOLUTE"
	AudienceSizeTypePercentage AudienceSizeType = "PERCENTAGE"
)

Enum values for AudienceSizeType

func (AudienceSizeType) Values 

func (AudienceSizeType) Values() []AudienceSizeType

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

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

type ColumnSchema 

type ColumnSchema struct {

	// The name of a column.
	//
	// This member is required.
	ColumnName *string

	// The data type of column.
	//
	// This member is required.
	ColumnTypes []ColumnType
	// contains filtered or unexported fields
}

Metadata for a column.

type ColumnType 

type ColumnType string
const (
	ColumnTypeUserId             ColumnType = "USER_ID"
	ColumnTypeItemId             ColumnType = "ITEM_ID"
	ColumnTypeTimestamp          ColumnType = "TIMESTAMP"
	ColumnTypeCategoricalFeature ColumnType = "CATEGORICAL_FEATURE"
	ColumnTypeNumericalFeature   ColumnType = "NUMERICAL_FEATURE"
)

Enum values for ColumnType

func (ColumnType) Values 

func (ColumnType) Values() []ColumnType

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

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

type ConfiguredAudienceModelOutputConfig 

type ConfiguredAudienceModelOutputConfig struct {

	// Defines the Amazon S3 bucket where the configured audience is stored.
	//
	// This member is required.
	Destination *AudienceDestination

	// The ARN of the IAM role that can write the Amazon S3 bucket.
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

Configuration information necessary for the configure audience model output.

type ConfiguredAudienceModelStatus 

type ConfiguredAudienceModelStatus string
const (
	ConfiguredAudienceModelStatusActive ConfiguredAudienceModelStatus = "ACTIVE"
)

Enum values for ConfiguredAudienceModelStatus

func (ConfiguredAudienceModelStatus) Values 

func (ConfiguredAudienceModelStatus) Values() []ConfiguredAudienceModelStatus

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

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

type ConfiguredAudienceModelSummary 

type ConfiguredAudienceModelSummary struct {

	// The Amazon Resource Name (ARN) of the audience model that was used to create
	// the configured audience model.
	//
	// This member is required.
	AudienceModelArn *string

	// The Amazon Resource Name (ARN) of the configured audience model that you are
	// interested in.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string

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

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

	// The output configuration of the configured audience model.
	//
	// This member is required.
	OutputConfig *ConfiguredAudienceModelOutputConfig

	// The status of the configured audience model.
	//
	// This member is required.
	Status ConfiguredAudienceModelStatus

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

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

Information about the configured audience model.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DataSource 

type DataSource struct {

	// A GlueDataSource object that defines the catalog ID, database name, and table
	// name for the training data.
	//
	// This member is required.
	GlueDataSource *GlueDataSource
	// contains filtered or unexported fields
}

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

type Dataset 

type Dataset struct {

	// A DatasetInputConfig object that defines the data source and schema mapping.
	//
	// This member is required.
	InputConfig *DatasetInputConfig

	// What type of information is found in the dataset.
	//
	// This member is required.
	Type 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.

type DatasetInputConfig 

type DatasetInputConfig struct {

	// A DataSource object that specifies the Glue data source for the training data.
	//
	// This member is required.
	DataSource *DataSource

	// The schema information for the training data.
	//
	// This member is required.
	Schema []ColumnSchema
	// contains filtered or unexported fields
}

Defines the Glue data source and schema mapping information.

type DatasetType 

type DatasetType string
const (
	DatasetTypeInteractions DatasetType = "INTERACTIONS"
)

Enum values for DatasetType

func (DatasetType) Values 

func (DatasetType) Values() []DatasetType

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

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

type GlueDataSource 

type GlueDataSource struct {

	// The Glue database that contains the training data.
	//
	// This member is required.
	DatabaseName *string

	// The Glue table that contains the training data.
	//
	// This member is required.
	TableName *string

	// The Glue catalog that contains the training data.
	CatalogId *string
	// contains filtered or unexported fields
}

Defines the Glue data source that contains the training data.

type PolicyExistenceCondition 

type PolicyExistenceCondition string
const (
	PolicyExistenceConditionPolicyMustExist    PolicyExistenceCondition = "POLICY_MUST_EXIST"
	PolicyExistenceConditionPolicyMustNotExist PolicyExistenceCondition = "POLICY_MUST_NOT_EXIST"
)

Enum values for PolicyExistenceCondition

func (PolicyExistenceCondition) Values 

func (PolicyExistenceCondition) Values() []PolicyExistenceCondition

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

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

type RelevanceMetric 

type RelevanceMetric struct {

	// The size of the generated audience. Must match one of the sizes in the
	// configured audience model.
	//
	// This member is required.
	AudienceSize *AudienceSize

	// The relevance score of the generated audience.
	Score *float64
	// contains filtered or unexported fields
}

The relevance score of a generated audience.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource you are requesting does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

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

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3ConfigMap 

type S3ConfigMap struct {

	// The Amazon S3 location URI.
	//
	// This member is required.
	S3Uri *string
	// contains filtered or unexported fields
}

Provides information about an Amazon S3 bucket and path.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You have exceeded your service quota.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SharedAudienceMetrics 

type SharedAudienceMetrics string
const (
	SharedAudienceMetricsAll  SharedAudienceMetrics = "ALL"
	SharedAudienceMetricsNone SharedAudienceMetrics = "NONE"
)

Enum values for SharedAudienceMetrics

func (SharedAudienceMetrics) Values 

func (SharedAudienceMetrics) Values() []SharedAudienceMetrics

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

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

type 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

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

Details about the status of a resource.

type TagOnCreatePolicy 

type TagOnCreatePolicy string
const (
	TagOnCreatePolicyFromParentResource TagOnCreatePolicy = "FROM_PARENT_RESOURCE"
	TagOnCreatePolicyNone               TagOnCreatePolicy = "NONE"
)

Enum values for TagOnCreatePolicy

func (TagOnCreatePolicy) Values 

func (TagOnCreatePolicy) Values() []TagOnCreatePolicy

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

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

type TrainingDatasetStatus 

type TrainingDatasetStatus string
const (
	TrainingDatasetStatusActive TrainingDatasetStatus = "ACTIVE"
)

Enum values for TrainingDatasetStatus

func (TrainingDatasetStatus) Values 

func (TrainingDatasetStatus) Values() []TrainingDatasetStatus

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

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

type TrainingDatasetSummary 

type TrainingDatasetSummary struct {

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

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

	// The status of the training dataset.
	//
	// This member is required.
	Status TrainingDatasetStatus

	// The Amazon Resource Name (ARN) of the training dataset.
	//
	// This member is required.
	TrainingDatasetArn *string

	// The most recent time at which the training dataset was updated.
	//
	// This member is required.
	UpdateTime *time.Time

	// The description of the training dataset.
	Description *string
	// contains filtered or unexported fields
}

Provides information about the training dataset.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request parameters for this request are incorrect.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

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

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.