cleanroomsml

package module
v0.0.0-...-68f2935 Latest Latest
Warning

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

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

Documentation

Overview

Package cleanroomsml provides the API client, operations, and parameter types for 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.

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-09-06"
View Source 
const ServiceID = "CleanRoomsML"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for AWS Clean Rooms ML.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateAudienceModel 

func (c *Client) CreateAudienceModel(ctx context.Context, params *CreateAudienceModelInput, optFns ...func(*Options)) (*CreateAudienceModelOutput, error)

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 StartAudienceGenerationJobAPI.

func (*Client) CreateConfiguredAudienceModel 

func (c *Client) CreateConfiguredAudienceModel(ctx context.Context, params *CreateConfiguredAudienceModelInput, optFns ...func(*Options)) (*CreateConfiguredAudienceModelOutput, error)

Defines the information necessary to create a configured audience model.

func (*Client) CreateTrainingDataset 

func (c *Client) CreateTrainingDataset(ctx context.Context, params *CreateTrainingDatasetInput, optFns ...func(*Options)) (*CreateTrainingDatasetOutput, error)

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.

func (*Client) DeleteAudienceGenerationJob 

func (c *Client) DeleteAudienceGenerationJob(ctx context.Context, params *DeleteAudienceGenerationJobInput, optFns ...func(*Options)) (*DeleteAudienceGenerationJobOutput, error)

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

func (*Client) DeleteAudienceModel 

func (c *Client) DeleteAudienceModel(ctx context.Context, params *DeleteAudienceModelInput, optFns ...func(*Options)) (*DeleteAudienceModelOutput, error)

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.

func (*Client) DeleteConfiguredAudienceModel 

func (c *Client) DeleteConfiguredAudienceModel(ctx context.Context, params *DeleteConfiguredAudienceModelInput, optFns ...func(*Options)) (*DeleteConfiguredAudienceModelOutput, error)

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.

func (*Client) DeleteConfiguredAudienceModelPolicy 

func (c *Client) DeleteConfiguredAudienceModelPolicy(ctx context.Context, params *DeleteConfiguredAudienceModelPolicyInput, optFns ...func(*Options)) (*DeleteConfiguredAudienceModelPolicyOutput, error)

Deletes the specified configured audience model policy.

func (*Client) DeleteTrainingDataset 

func (c *Client) DeleteTrainingDataset(ctx context.Context, params *DeleteTrainingDatasetInput, optFns ...func(*Options)) (*DeleteTrainingDatasetOutput, error)

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.

func (*Client) GetAudienceGenerationJob 

func (c *Client) GetAudienceGenerationJob(ctx context.Context, params *GetAudienceGenerationJobInput, optFns ...func(*Options)) (*GetAudienceGenerationJobOutput, error)

Returns information about an audience generation job.

func (*Client) GetAudienceModel 

func (c *Client) GetAudienceModel(ctx context.Context, params *GetAudienceModelInput, optFns ...func(*Options)) (*GetAudienceModelOutput, error)

Returns information about an audience model

func (*Client) GetConfiguredAudienceModel 

func (c *Client) GetConfiguredAudienceModel(ctx context.Context, params *GetConfiguredAudienceModelInput, optFns ...func(*Options)) (*GetConfiguredAudienceModelOutput, error)

Returns information about a specified configured audience model.

func (*Client) GetConfiguredAudienceModelPolicy 

func (c *Client) GetConfiguredAudienceModelPolicy(ctx context.Context, params *GetConfiguredAudienceModelPolicyInput, optFns ...func(*Options)) (*GetConfiguredAudienceModelPolicyOutput, error)

Returns information about a configured audience model policy.

func (*Client) GetTrainingDataset 

func (c *Client) GetTrainingDataset(ctx context.Context, params *GetTrainingDatasetInput, optFns ...func(*Options)) (*GetTrainingDatasetOutput, error)

Returns information about a training dataset.

func (*Client) ListAudienceExportJobs 

func (c *Client) ListAudienceExportJobs(ctx context.Context, params *ListAudienceExportJobsInput, optFns ...func(*Options)) (*ListAudienceExportJobsOutput, error)

Returns a list of the audience export jobs.

func (*Client) ListAudienceGenerationJobs 

func (c *Client) ListAudienceGenerationJobs(ctx context.Context, params *ListAudienceGenerationJobsInput, optFns ...func(*Options)) (*ListAudienceGenerationJobsOutput, error)

Returns a list of audience generation jobs.

func (*Client) ListAudienceModels 

func (c *Client) ListAudienceModels(ctx context.Context, params *ListAudienceModelsInput, optFns ...func(*Options)) (*ListAudienceModelsOutput, error)

Returns a list of audience models.

func (*Client) ListConfiguredAudienceModels 

func (c *Client) ListConfiguredAudienceModels(ctx context.Context, params *ListConfiguredAudienceModelsInput, optFns ...func(*Options)) (*ListConfiguredAudienceModelsOutput, error)

Returns a list of the configured audience models.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Returns a list of tags for a provided resource.

func (*Client) ListTrainingDatasets 

func (c *Client) ListTrainingDatasets(ctx context.Context, params *ListTrainingDatasetsInput, optFns ...func(*Options)) (*ListTrainingDatasetsOutput, error)

Returns a list of training datasets.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutConfiguredAudienceModelPolicy 

func (c *Client) PutConfiguredAudienceModelPolicy(ctx context.Context, params *PutConfiguredAudienceModelPolicyInput, optFns ...func(*Options)) (*PutConfiguredAudienceModelPolicyOutput, error)

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

func (*Client) StartAudienceExportJob 

func (c *Client) StartAudienceExportJob(ctx context.Context, params *StartAudienceExportJobInput, optFns ...func(*Options)) (*StartAudienceExportJobOutput, error)

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

func (*Client) StartAudienceGenerationJob 

func (c *Client) StartAudienceGenerationJob(ctx context.Context, params *StartAudienceGenerationJobInput, optFns ...func(*Options)) (*StartAudienceGenerationJobOutput, error)

Information necessary to start the audience generation job.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds metadata tags to a specified resource.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes metadata tags from a specified resource.

func (*Client) UpdateConfiguredAudienceModel 

func (c *Client) UpdateConfiguredAudienceModel(ctx context.Context, params *UpdateConfiguredAudienceModelInput, optFns ...func(*Options)) (*UpdateConfiguredAudienceModelOutput, error)

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.

type CreateAudienceModelInput 

type CreateAudienceModelInput struct {

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

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

	// The description of the audience model.
	Description *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

	// 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

	// The end date and time of the training window.
	TrainingDataEndTime *time.Time

	// The start date and time of the training window.
	TrainingDataStartTime *time.Time
	// contains filtered or unexported fields
}

type CreateAudienceModelOutput 

type CreateAudienceModelOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateConfiguredAudienceModelInput 

type CreateConfiguredAudienceModelInput struct {

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

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

	// 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.
	//
	// This member is required.
	OutputConfig *types.ConfiguredAudienceModelOutputConfig

	// Whether audience metrics are shared.
	//
	// This member is required.
	SharedAudienceMetrics []types.SharedAudienceMetrics

	// Configure the list of output sizes of audiences that can be created using this
	// configured audience model. A request to StartAudienceGenerationJobthat 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.
	AudienceSizeConfig *types.AudienceSizeConfig

	// 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 StartAudienceGenerationJobwill 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 types.TagOnCreatePolicy

	// The description of the configured audience model.
	Description *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 *int32

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

type CreateConfiguredAudienceModelOutput 

type CreateConfiguredAudienceModelOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTrainingDatasetInput 

type CreateTrainingDatasetInput struct {

	// The name of the training dataset. This name must be unique in your account and
	// region.
	//
	// This member is required.
	Name *string

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

	// 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.
	//
	// This member is required.
	TrainingData []types.Dataset

	// The description of the training dataset.
	Description *string

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

type CreateTrainingDatasetOutput 

type CreateTrainingDatasetOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAudienceGenerationJobInput 

type DeleteAudienceGenerationJobInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you want to
	// delete.
	//
	// This member is required.
	AudienceGenerationJobArn *string
	// contains filtered or unexported fields
}

type DeleteAudienceGenerationJobOutput 

type DeleteAudienceGenerationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAudienceModelInput 

type DeleteAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the audience model that you want to delete.
	//
	// This member is required.
	AudienceModelArn *string
	// contains filtered or unexported fields
}

type DeleteAudienceModelOutput 

type DeleteAudienceModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConfiguredAudienceModelInput 

type DeleteConfiguredAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that you want
	// to delete.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string
	// contains filtered or unexported fields
}

type DeleteConfiguredAudienceModelOutput 

type DeleteConfiguredAudienceModelOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConfiguredAudienceModelPolicyInput 

type DeleteConfiguredAudienceModelPolicyInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model policy that you
	// want to delete.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string
	// contains filtered or unexported fields
}

type DeleteConfiguredAudienceModelPolicyOutput 

type DeleteConfiguredAudienceModelPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTrainingDatasetInput 

type DeleteTrainingDatasetInput struct {

	// The Amazon Resource Name (ARN) of the training dataset that you want to delete.
	//
	// This member is required.
	TrainingDatasetArn *string
	// contains filtered or unexported fields
}

type DeleteTrainingDatasetOutput 

type DeleteTrainingDatasetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAudienceGenerationJobInput 

type GetAudienceGenerationJobInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you are
	// interested in.
	//
	// This member is required.
	AudienceGenerationJobArn *string
	// contains filtered or unexported fields
}

type GetAudienceGenerationJobOutput 

type GetAudienceGenerationJobOutput 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 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 types.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 this audience generation job is
	// associated with.
	CollaborationId *string

	// The description of the audience generation job.
	Description *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

	// The relevance scores for different audience sizes and the recall score of the
	// generated audience.
	Metrics *types.AudienceQualityMetrics

	// 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 *types.AudienceGenerationJobDataSource

	// The AWS account that started this audience generation job.
	StartedBy *string

	// Details about the status of the audience generation job.
	StatusDetails *types.StatusDetails

	// The tags that are associated to this audience generation job.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAudienceModelInput 

type GetAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the audience model that you are interested in.
	//
	// This member is required.
	AudienceModelArn *string
	// contains filtered or unexported fields
}

type GetAudienceModelOutput 

type GetAudienceModelOutput 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 types.AudienceModelStatus

	// The Amazon Resource Name (ARN) of the training dataset that was used for this
	// 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

	// The KMS key ARN used for the audience model.
	KmsKeyArn *string

	// Details about the status of the audience model.
	StatusDetails *types.StatusDetails

	// The tags that are assigned to the audience model.
	Tags map[string]string

	// The end date specified for the training window.
	TrainingDataEndTime *time.Time

	// The start date specified for the training window.
	TrainingDataStartTime *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetConfiguredAudienceModelInput 

type GetConfiguredAudienceModelInput struct {

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

type GetConfiguredAudienceModelOutput 

type GetConfiguredAudienceModelOutput struct {

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

	// The Amazon Resource Name (ARN) of the configured audience model.
	//
	// 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 *types.ConfiguredAudienceModelOutputConfig

	// Whether audience metrics are shared.
	//
	// This member is required.
	SharedAudienceMetrics []types.SharedAudienceMetrics

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

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

	// The list of output sizes of audiences that can be created using this configured
	// audience model. A request to StartAudienceGenerationJobthat 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.
	AudienceSizeConfig *types.AudienceSizeConfig

	// Provides the childResourceTagOnCreatePolicy that was used for this configured
	// audience model.
	ChildResourceTagOnCreatePolicy types.TagOnCreatePolicy

	// The description of the configured audience model.
	Description *string

	// The minimum number of users from the seed audience that must match with users
	// in the training data of the audience model.
	MinMatchingSeedSize *int32

	// The tags that are associated to this configured audience model.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetConfiguredAudienceModelPolicyInput 

type GetConfiguredAudienceModelPolicyInput struct {

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

type GetConfiguredAudienceModelPolicyOutput 

type GetConfiguredAudienceModelPolicyOutput struct {

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

	// The configured audience model policy. This is a JSON IAM resource policy.
	//
	// This member is required.
	ConfiguredAudienceModelPolicy *string

	// A cryptographic hash of the contents of the policy used to prevent unexpected
	// concurrent modification of the policy.
	//
	// This member is required.
	PolicyHash *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetTrainingDatasetInput 

type GetTrainingDatasetInput struct {

	// The Amazon Resource Name (ARN) of the training dataset that you are interested
	// in.
	//
	// This member is required.
	TrainingDatasetArn *string
	// contains filtered or unexported fields
}

type GetTrainingDatasetOutput 

type GetTrainingDatasetOutput 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 IAM role used to read the training data.
	//
	// This member is required.
	RoleArn *string

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

	// Metadata about the requested training data.
	//
	// This member is required.
	TrainingData []types.Dataset

	// 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

	// The tags that are assigned to this training dataset.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAudienceExportJobsAPIClient 

type ListAudienceExportJobsAPIClient interface {
	ListAudienceExportJobs(context.Context, *ListAudienceExportJobsInput, ...func(*Options)) (*ListAudienceExportJobsOutput, error)
}

ListAudienceExportJobsAPIClient is a client that implements the ListAudienceExportJobs operation.

type ListAudienceExportJobsInput 

type ListAudienceExportJobsInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you are
	// interested in.
	AudienceGenerationJobArn *string

	// The maximum size of the results that is returned per call.
	MaxResults *int32

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAudienceExportJobsOutput 

type ListAudienceExportJobsOutput struct {

	// The audience export jobs that match the request.
	//
	// This member is required.
	AudienceExportJobs []types.AudienceExportJobSummary

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAudienceExportJobsPaginator 

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

ListAudienceExportJobsPaginator is a paginator for ListAudienceExportJobs

func NewListAudienceExportJobsPaginator 

func NewListAudienceExportJobsPaginator(client ListAudienceExportJobsAPIClient, params *ListAudienceExportJobsInput, optFns ...func(*ListAudienceExportJobsPaginatorOptions)) *ListAudienceExportJobsPaginator

NewListAudienceExportJobsPaginator returns a new ListAudienceExportJobsPaginator

func (*ListAudienceExportJobsPaginator) HasMorePages 

func (p *ListAudienceExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAudienceExportJobsPaginator) NextPage 

func (p *ListAudienceExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAudienceExportJobsOutput, error)

NextPage retrieves the next ListAudienceExportJobs page.

type ListAudienceExportJobsPaginatorOptions 

type ListAudienceExportJobsPaginatorOptions struct {
	// The maximum size of the results that is returned per call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAudienceExportJobsPaginatorOptions is the paginator options for ListAudienceExportJobs

type ListAudienceGenerationJobsAPIClient 

type ListAudienceGenerationJobsAPIClient interface {
	ListAudienceGenerationJobs(context.Context, *ListAudienceGenerationJobsInput, ...func(*Options)) (*ListAudienceGenerationJobsOutput, error)
}

ListAudienceGenerationJobsAPIClient is a client that implements the ListAudienceGenerationJobs operation.

type ListAudienceGenerationJobsInput 

type ListAudienceGenerationJobsInput struct {

	// The identifier of the collaboration that contains the audience generation jobs
	// that you are interested in.
	CollaborationId *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

	// The maximum size of the results that is returned per call.
	MaxResults *int32

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAudienceGenerationJobsOutput 

type ListAudienceGenerationJobsOutput struct {

	// The audience generation jobs that match the request.
	//
	// This member is required.
	AudienceGenerationJobs []types.AudienceGenerationJobSummary

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAudienceGenerationJobsPaginator 

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

ListAudienceGenerationJobsPaginator is a paginator for ListAudienceGenerationJobs

func NewListAudienceGenerationJobsPaginator 

func NewListAudienceGenerationJobsPaginator(client ListAudienceGenerationJobsAPIClient, params *ListAudienceGenerationJobsInput, optFns ...func(*ListAudienceGenerationJobsPaginatorOptions)) *ListAudienceGenerationJobsPaginator

NewListAudienceGenerationJobsPaginator returns a new ListAudienceGenerationJobsPaginator

func (*ListAudienceGenerationJobsPaginator) HasMorePages 

func (p *ListAudienceGenerationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAudienceGenerationJobsPaginator) NextPage 

func (p *ListAudienceGenerationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAudienceGenerationJobsOutput, error)

NextPage retrieves the next ListAudienceGenerationJobs page.

type ListAudienceGenerationJobsPaginatorOptions 

type ListAudienceGenerationJobsPaginatorOptions struct {
	// The maximum size of the results that is returned per call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAudienceGenerationJobsPaginatorOptions is the paginator options for ListAudienceGenerationJobs

type ListAudienceModelsAPIClient 

type ListAudienceModelsAPIClient interface {
	ListAudienceModels(context.Context, *ListAudienceModelsInput, ...func(*Options)) (*ListAudienceModelsOutput, error)
}

ListAudienceModelsAPIClient is a client that implements the ListAudienceModels operation.

type ListAudienceModelsInput 

type ListAudienceModelsInput struct {

	// The maximum size of the results that is returned per call.
	MaxResults *int32

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAudienceModelsOutput 

type ListAudienceModelsOutput struct {

	// The audience models that match the request.
	//
	// This member is required.
	AudienceModels []types.AudienceModelSummary

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAudienceModelsPaginator 

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

ListAudienceModelsPaginator is a paginator for ListAudienceModels

func NewListAudienceModelsPaginator 

func NewListAudienceModelsPaginator(client ListAudienceModelsAPIClient, params *ListAudienceModelsInput, optFns ...func(*ListAudienceModelsPaginatorOptions)) *ListAudienceModelsPaginator

NewListAudienceModelsPaginator returns a new ListAudienceModelsPaginator

func (*ListAudienceModelsPaginator) HasMorePages 

func (p *ListAudienceModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAudienceModelsPaginator) NextPage 

func (p *ListAudienceModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAudienceModelsOutput, error)

NextPage retrieves the next ListAudienceModels page.

type ListAudienceModelsPaginatorOptions 

type ListAudienceModelsPaginatorOptions struct {
	// The maximum size of the results that is returned per call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAudienceModelsPaginatorOptions is the paginator options for ListAudienceModels

type ListConfiguredAudienceModelsAPIClient 

type ListConfiguredAudienceModelsAPIClient interface {
	ListConfiguredAudienceModels(context.Context, *ListConfiguredAudienceModelsInput, ...func(*Options)) (*ListConfiguredAudienceModelsOutput, error)
}

ListConfiguredAudienceModelsAPIClient is a client that implements the ListConfiguredAudienceModels operation.

type ListConfiguredAudienceModelsInput 

type ListConfiguredAudienceModelsInput struct {

	// The maximum size of the results that is returned per call.
	MaxResults *int32

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListConfiguredAudienceModelsOutput 

type ListConfiguredAudienceModelsOutput struct {

	// The configured audience models.
	//
	// This member is required.
	ConfiguredAudienceModels []types.ConfiguredAudienceModelSummary

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListConfiguredAudienceModelsPaginator 

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

ListConfiguredAudienceModelsPaginator is a paginator for ListConfiguredAudienceModels

func NewListConfiguredAudienceModelsPaginator 

func NewListConfiguredAudienceModelsPaginator(client ListConfiguredAudienceModelsAPIClient, params *ListConfiguredAudienceModelsInput, optFns ...func(*ListConfiguredAudienceModelsPaginatorOptions)) *ListConfiguredAudienceModelsPaginator

NewListConfiguredAudienceModelsPaginator returns a new ListConfiguredAudienceModelsPaginator

func (*ListConfiguredAudienceModelsPaginator) HasMorePages 

func (p *ListConfiguredAudienceModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListConfiguredAudienceModelsPaginator) NextPage 

func (p *ListConfiguredAudienceModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListConfiguredAudienceModelsOutput, error)

NextPage retrieves the next ListConfiguredAudienceModels page.

type ListConfiguredAudienceModelsPaginatorOptions 

type ListConfiguredAudienceModelsPaginatorOptions struct {
	// The maximum size of the results that is returned per call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListConfiguredAudienceModelsPaginatorOptions is the paginator options for ListConfiguredAudienceModels

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you are interested in.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags that are associated with the resource.
	//
	// This member is required.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTrainingDatasetsAPIClient 

type ListTrainingDatasetsAPIClient interface {
	ListTrainingDatasets(context.Context, *ListTrainingDatasetsInput, ...func(*Options)) (*ListTrainingDatasetsOutput, error)
}

ListTrainingDatasetsAPIClient is a client that implements the ListTrainingDatasets operation.

type ListTrainingDatasetsInput 

type ListTrainingDatasetsInput struct {

	// The maximum size of the results that is returned per call.
	MaxResults *int32

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTrainingDatasetsOutput 

type ListTrainingDatasetsOutput struct {

	// The training datasets that match the request.
	//
	// This member is required.
	TrainingDatasets []types.TrainingDatasetSummary

	// The token value retrieved from a previous call to access the next page of
	// results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTrainingDatasetsPaginator 

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

ListTrainingDatasetsPaginator is a paginator for ListTrainingDatasets

func NewListTrainingDatasetsPaginator 

func NewListTrainingDatasetsPaginator(client ListTrainingDatasetsAPIClient, params *ListTrainingDatasetsInput, optFns ...func(*ListTrainingDatasetsPaginatorOptions)) *ListTrainingDatasetsPaginator

NewListTrainingDatasetsPaginator returns a new ListTrainingDatasetsPaginator

func (*ListTrainingDatasetsPaginator) HasMorePages 

func (p *ListTrainingDatasetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrainingDatasetsPaginator) NextPage 

func (p *ListTrainingDatasetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrainingDatasetsOutput, error)

NextPage retrieves the next ListTrainingDatasets page.

type ListTrainingDatasetsPaginatorOptions 

type ListTrainingDatasetsPaginatorOptions struct {
	// The maximum size of the results that is returned per call.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTrainingDatasetsPaginatorOptions is the paginator options for ListTrainingDatasets

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutConfiguredAudienceModelPolicyInput 

type PutConfiguredAudienceModelPolicyInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that the
	// resource policy will govern.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string

	// The IAM resource policy.
	//
	// This member is required.
	ConfiguredAudienceModelPolicy *string

	// Use this to prevent unexpected concurrent modification of the policy.
	PolicyExistenceCondition types.PolicyExistenceCondition

	// A cryptographic hash of the contents of the policy used to prevent unexpected
	// concurrent modification of the policy.
	PreviousPolicyHash *string
	// contains filtered or unexported fields
}

type PutConfiguredAudienceModelPolicyOutput 

type PutConfiguredAudienceModelPolicyOutput struct {

	// The IAM resource policy.
	//
	// This member is required.
	ConfiguredAudienceModelPolicy *string

	// A cryptographic hash of the contents of the policy used to prevent unexpected
	// concurrent modification of the policy.
	//
	// This member is required.
	PolicyHash *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartAudienceExportJobInput 

type StartAudienceExportJobInput struct {

	// The Amazon Resource Name (ARN) of the audience generation job that you want to
	// export.
	//
	// 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 *types.AudienceSize

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

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

type StartAudienceExportJobOutput 

type StartAudienceExportJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartAudienceGenerationJobInput 

type StartAudienceGenerationJobInput struct {

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

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

	// The seed audience that is used to generate the audience.
	//
	// This member is required.
	SeedAudience *types.AudienceGenerationJobDataSource

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

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

	// Whether the seed audience is included in the audience generation output.
	IncludeSeedInOutput bool

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

type StartAudienceGenerationJobOutput 

type StartAudienceGenerationJobOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to assign tags.
	//
	// This member is required.
	ResourceArn *string

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

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to remove tags
	// from.
	//
	// This member is required.
	ResourceArn *string

	// The key values of tags that you want to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateConfiguredAudienceModelInput 

type UpdateConfiguredAudienceModelInput struct {

	// The Amazon Resource Name (ARN) of the configured audience model that you want
	// to update.
	//
	// This member is required.
	ConfiguredAudienceModelArn *string

	// The Amazon Resource Name (ARN) of the new audience model that you want to use.
	AudienceModelArn *string

	// The new audience size configuration.
	AudienceSizeConfig *types.AudienceSizeConfig

	// The new description of the configured audience model.
	Description *string

	// The minimum number of users from the seed audience that must match with users
	// in the training data of the audience model.
	MinMatchingSeedSize *int32

	// The new output configuration.
	OutputConfig *types.ConfiguredAudienceModelOutputConfig

	// The new value for whether to share audience metrics.
	SharedAudienceMetrics []types.SharedAudienceMetrics
	// contains filtered or unexported fields
}

type UpdateConfiguredAudienceModelOutput 

type UpdateConfiguredAudienceModelOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.