sagemaker

package module
v1.137.0 Latest Latest
Warning

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

Go to latest
Published: Apr 22, 2024 License: Apache-2.0 Imports: 45 Imported by: 45

Documentation

Overview

Package sagemaker provides the API client, operations, and parameter types for Amazon SageMaker Service.

Provides APIs for creating and managing SageMaker resources. Other Resources:

Index

Constants

View Source
const ServiceAPIVersion = "2017-07-24"
View Source
const ServiceID = "SageMaker"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

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 added in v1.96.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

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

func WithSigV4SigningName added in v1.116.1

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 added in v1.116.1

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 AddAssociationInput added in v0.31.0

type AddAssociationInput struct {

	// The Amazon Resource Name (ARN) of the destination.
	//
	// This member is required.
	DestinationArn *string

	// The ARN of the source.
	//
	// This member is required.
	SourceArn *string

	// The type of association. The following are suggested uses for each type. Amazon
	// SageMaker places no restrictions on their use.
	//   - ContributedTo - The source contributed to the destination or had a part in
	//   enabling the destination. For example, the training data contributed to the
	//   training job.
	//   - AssociatedWith - The source is connected to the destination. For example,
	//   an approval workflow is associated with a model deployment.
	//   - DerivedFrom - The destination is a modification of the source. For example,
	//   a digest output of a channel input for a processing job is derived from the
	//   original inputs.
	//   - Produced - The source generated the destination. For example, a training
	//   job produced a model artifact.
	AssociationType types.AssociationEdgeType
	// contains filtered or unexported fields
}

type AddAssociationOutput added in v0.31.0

type AddAssociationOutput struct {

	// The Amazon Resource Name (ARN) of the destination.
	DestinationArn *string

	// The ARN of the source.
	SourceArn *string

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

type AddTagsInput

type AddTagsInput struct {

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

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type AddTagsOutput

type AddTagsOutput struct {

	// A list of tags associated with the SageMaker resource.
	Tags []types.Tag

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

type AssociateTrialComponentInput

type AssociateTrialComponentInput struct {

	// The name of the component to associated with the trial.
	//
	// This member is required.
	TrialComponentName *string

	// The name of the trial to associate with.
	//
	// This member is required.
	TrialName *string
	// contains filtered or unexported fields
}

type AssociateTrialComponentOutput

type AssociateTrialComponentOutput struct {

	// The Amazon Resource Name (ARN) of the trial.
	TrialArn *string

	// The Amazon Resource Name (ARN) of the trial component.
	TrialComponentArn *string

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

type AuthResolverParameters added in v1.116.1

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 added in v1.116.1

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

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

type BatchDescribeModelPackageInput added in v1.18.0

type BatchDescribeModelPackageInput struct {

	// The list of Amazon Resource Name (ARN) of the model package groups.
	//
	// This member is required.
	ModelPackageArnList []string
	// contains filtered or unexported fields
}

type BatchDescribeModelPackageOutput added in v1.18.0

type BatchDescribeModelPackageOutput struct {

	// A map of the resource and BatchDescribeModelPackageError objects reporting the
	// error associated with describing the model package.
	BatchDescribeModelPackageErrorMap map[string]types.BatchDescribeModelPackageError

	// The summaries for the model package versions
	ModelPackageSummaries map[string]types.BatchDescribeModelPackageSummary

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

type Client

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

Client provides the API client to make operations call for Amazon SageMaker Service.

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) AddAssociation added in v0.31.0

func (c *Client) AddAssociation(ctx context.Context, params *AddAssociationInput, optFns ...func(*Options)) (*AddAssociationOutput, error)

Creates an association between the source and the destination. A source can be associated with multiple destinations, and a destination can be associated with multiple sources. An association is a lineage tracking entity. For more information, see Amazon SageMaker ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) .

func (*Client) AddTags

func (c *Client) AddTags(ctx context.Context, params *AddTagsInput, optFns ...func(*Options)) (*AddTagsOutput, error)

Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) . Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html) Tags that you add to a SageMaker Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateDomain.html) or CreateUserProfile (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateUserProfile.html) .

func (*Client) AssociateTrialComponent

func (c *Client) AssociateTrialComponent(ctx context.Context, params *AssociateTrialComponentInput, optFns ...func(*Options)) (*AssociateTrialComponentOutput, error)

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html) API.

func (*Client) BatchDescribeModelPackage added in v1.18.0

func (c *Client) BatchDescribeModelPackage(ctx context.Context, params *BatchDescribeModelPackageInput, optFns ...func(*Options)) (*BatchDescribeModelPackageOutput, error)

This action batch describes a list of versioned model packages

func (*Client) CreateAction added in v0.31.0

func (c *Client) CreateAction(ctx context.Context, params *CreateActionInput, optFns ...func(*Options)) (*CreateActionOutput, error)

Creates an action. An action is a lineage tracking entity that represents an action or activity. For example, a model deployment or an HPO job. Generally, an action involves at least one input or output artifact. For more information, see Amazon SageMaker ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) .

func (*Client) CreateAlgorithm

func (c *Client) CreateAlgorithm(ctx context.Context, params *CreateAlgorithmInput, optFns ...func(*Options)) (*CreateAlgorithmOutput, error)

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

func (*Client) CreateApp

func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error)

Creates a running app for the specified UserProfile. This operation is automatically invoked by Amazon SageMaker upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

func (*Client) CreateAppImageConfig added in v0.29.0

func (c *Client) CreateAppImageConfig(ctx context.Context, params *CreateAppImageConfigInput, optFns ...func(*Options)) (*CreateAppImageConfigOutput, error)

Creates a configuration for running a SageMaker image as a KernelGateway app. The configuration specifies the Amazon Elastic File System storage volume on the image, and a list of the kernels in the image.

func (*Client) CreateArtifact added in v0.31.0

func (c *Client) CreateArtifact(ctx context.Context, params *CreateArtifactInput, optFns ...func(*Options)) (*CreateArtifactOutput, error)

Creates an artifact. An artifact is a lineage tracking entity that represents a URI addressable object or data. Some examples are the S3 URI of a dataset and the ECR registry path of an image. For more information, see Amazon SageMaker ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) .

func (*Client) CreateAutoMLJob

func (c *Client) CreateAutoMLJob(ctx context.Context, params *CreateAutoMLJobInput, optFns ...func(*Options)) (*CreateAutoMLJobOutput, error)

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job. We recommend using the new versions CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) and DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) , which offer backward compatibility. CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob , as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning). Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2) . You can find the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) (recommended) or DescribeAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html) .

func (*Client) CreateAutoMLJobV2 added in v1.72.0

func (c *Client) CreateAutoMLJobV2(ctx context.Context, params *CreateAutoMLJobV2Input, optFns ...func(*Options)) (*CreateAutoMLJobV2Output, error)

Creates an Autopilot job also referred to as Autopilot experiment or AutoML job V2. CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) and DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) are new versions of CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) and DescribeAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJob.html) which offer backward compatibility. CreateAutoMLJobV2 can manage tabular problem types identical to those of its previous version CreateAutoMLJob , as well as time-series forecasting, non-tabular problem types such as image or text classification, and text generation (LLMs fine-tuning). Find guidelines about how to migrate a CreateAutoMLJob to CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-automate-model-development-create-experiment.html#autopilot-create-experiment-api-migrate-v1-v2) . For the list of available problem types supported by CreateAutoMLJobV2 , see AutoMLProblemTypeConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLProblemTypeConfig.html) . You can find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeAutoMLJobV2.html) .

func (*Client) CreateCluster added in v1.119.0

func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)

Creates a SageMaker HyperPod cluster. SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod.html) in the Amazon SageMaker Developer Guide.

func (*Client) CreateCodeRepository

func (c *Client) CreateCodeRepository(ctx context.Context, params *CreateCodeRepositoryInput, optFns ...func(*Options)) (*CreateCodeRepositoryOutput, error)

Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. The repository can be hosted either in Amazon Web Services CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository.

func (*Client) CreateCompilationJob

func (c *Client) CreateCompilationJob(ctx context.Context, params *CreateCompilationJobInput, optFns ...func(*Options)) (*CreateCompilationJobOutput, error)

Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify. If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with Amazon Web Services IoT Greengrass. In that case, deploy them as an ML resource. In the request body, you provide the following:

  • A name for the compilation job
  • Information about the input model artifacts
  • The output location for the compiled model and the device (target) that the model runs on
  • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.

You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job. To stop a model compilation job, use StopCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopCompilationJob.html) . To get information about a particular model compilation job, use DescribeCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html) . To get information about multiple model compilation jobs, use ListCompilationJobs (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html) .

func (*Client) CreateContext added in v0.31.0

func (c *Client) CreateContext(ctx context.Context, params *CreateContextInput, optFns ...func(*Options)) (*CreateContextOutput, error)

Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking.html) .

func (*Client) CreateDataQualityJobDefinition added in v0.31.0

func (c *Client) CreateDataQualityJobDefinition(ctx context.Context, params *CreateDataQualityJobDefinitionInput, optFns ...func(*Options)) (*CreateDataQualityJobDefinitionOutput, error)

Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) .

func (*Client) CreateDeviceFleet added in v0.31.0

func (c *Client) CreateDeviceFleet(ctx context.Context, params *CreateDeviceFleetInput, optFns ...func(*Options)) (*CreateDeviceFleetOutput, error)

Creates a device fleet.

func (*Client) CreateDomain

func (c *Client) CreateDomain(ctx context.Context, params *CreateDomainInput, optFns ...func(*Options)) (*CreateDomainOutput, error)

Creates a Domain . A domain consists of an associated Amazon Elastic File System volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other. EFS storage When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files. SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption (https://docs.aws.amazon.com/sagemaker/latest/dg/encryption-at-rest.html) . VPC configuration All traffic between the domain and the Amazon EFS volume is through the specified VPC and subnets. For other traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to the domain. The following options are available:

  • PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
  • VpcOnly - All traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway. When internet access is disabled, you won't be able to run a Amazon SageMaker Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.

NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a Amazon SageMaker Studio app successfully. For more information, see Connect Amazon SageMaker Studio Notebooks to Resources in a VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-notebooks-and-internet-access.html) .

func (*Client) CreateEdgeDeploymentPlan added in v1.37.0

func (c *Client) CreateEdgeDeploymentPlan(ctx context.Context, params *CreateEdgeDeploymentPlanInput, optFns ...func(*Options)) (*CreateEdgeDeploymentPlanOutput, error)

Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.

func (*Client) CreateEdgeDeploymentStage added in v1.37.0

func (c *Client) CreateEdgeDeploymentStage(ctx context.Context, params *CreateEdgeDeploymentStageInput, optFns ...func(*Options)) (*CreateEdgeDeploymentStageOutput, error)

Creates a new stage in an existing edge deployment plan.

func (*Client) CreateEdgePackagingJob added in v0.31.0

func (c *Client) CreateEdgePackagingJob(ctx context.Context, params *CreateEdgePackagingJobInput, optFns ...func(*Options)) (*CreateEdgePackagingJobOutput, error)

Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.

func (*Client) CreateEndpoint

func (c *Client) CreateEndpoint(ctx context.Context, params *CreateEndpointInput, optFns ...func(*Options)) (*CreateEndpointOutput, error)

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) API. Use this API to deploy models using SageMaker hosting services. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig . The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) , a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html) before calling CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating . After it creates the endpoint, it sets the status to InService . SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console (https://console.aws.amazon.com/iam/) , and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) and CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html) API operations, add the following policies to the role.

  • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
  • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference (https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html) .

func (*Client) CreateEndpointConfig

func (c *Client) CreateEndpointConfig(ctx context.Context, params *CreateEndpointConfigInput, optFns ...func(*Options)) (*CreateEndpointConfigOutput, error)

Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) API. Use this API if you want to use SageMaker hosting services to deploy models into production. In the request, you define a ProductionVariant , for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy. If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. When you call CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) , a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html) , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpointConfig.html) before calling CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html) to minimize the potential impact of a DynamoDB eventually consistent read.

func (*Client) CreateExperiment

func (c *Client) CreateExperiment(ctx context.Context, params *CreateExperimentInput, optFns ...func(*Options)) (*CreateExperimentOutput, error)

Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model. In the Studio UI, trials are referred to as run groups and trial components are referred to as runs. The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to experiments, trials, trial components and then use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API to search for the tags. To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateExperiment.html) API. To get a list of all your experiments, call the ListExperiments (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListExperiments.html) API. To view an experiment's properties, call the DescribeExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html) API. To get a list of all the trials associated with an experiment, call the ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) API. To create a trial call the CreateTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrial.html) API.

func (*Client) CreateFeatureGroup added in v0.31.0

func (c *Client) CreateFeatureGroup(ctx context.Context, params *CreateFeatureGroupInput, optFns ...func(*Options)) (*CreateFeatureGroupOutput, error)

Create a new FeatureGroup . A FeatureGroup is a group of Features defined in the FeatureStore to describe a Record . The FeatureGroup defines the schema and features contained in the FeatureGroup . A FeatureGroup definition is composed of a list of Features , a RecordIdentifierFeatureName , an EventTimeFeatureName and configurations for its OnlineStore and OfflineStore . Check Amazon Web Services service quotas (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to see the FeatureGroup s quota for your Amazon Web Services account. Note that it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup with the InMemory StorageType . You must include at least one of OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup .

func (*Client) CreateFlowDefinition

func (c *Client) CreateFlowDefinition(ctx context.Context, params *CreateFlowDefinitionInput, optFns ...func(*Options)) (*CreateFlowDefinitionOutput, error)

Creates a flow definition.

func (*Client) CreateHub added in v1.56.0

func (c *Client) CreateHub(ctx context.Context, params *CreateHubInput, optFns ...func(*Options)) (*CreateHubOutput, error)

Create a hub. Hub APIs are only callable through SageMaker Studio.

func (*Client) CreateHumanTaskUi

func (c *Client) CreateHumanTaskUi(ctx context.Context, params *CreateHumanTaskUiInput, optFns ...func(*Options)) (*CreateHumanTaskUiOutput, error)

Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.

func (*Client) CreateHyperParameterTuningJob

func (c *Client) CreateHyperParameterTuningJob(ctx context.Context, params *CreateHyperParameterTuningJobInput, optFns ...func(*Options)) (*CreateHyperParameterTuningJobOutput, error)

Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose. A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components (https://docs.aws.amazon.com/sagemaker/latest/dg/experiments-view-compare.html#experiments-view) . Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

func (*Client) CreateImage added in v0.29.0

func (c *Client) CreateImage(ctx context.Context, params *CreateImageInput, optFns ...func(*Options)) (*CreateImageOutput, error)

Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon ECR. For more information, see Bring your own SageMaker image (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html) .

func (*Client) CreateImageVersion added in v0.29.0

func (c *Client) CreateImageVersion(ctx context.Context, params *CreateImageVersionInput, optFns ...func(*Options)) (*CreateImageVersionOutput, error)

Creates a version of the SageMaker image specified by ImageName . The version represents the Amazon ECR container image specified by BaseImage .

func (*Client) CreateInferenceComponent added in v1.119.0

func (c *Client) CreateInferenceComponent(ctx context.Context, params *CreateInferenceComponentInput, optFns ...func(*Options)) (*CreateInferenceComponentOutput, error)

Creates an inference component, which is a SageMaker hosting object that you can use to deploy a model to an endpoint. In the inference component settings, you specify the model, the endpoint, and how the model utilizes the resources that the endpoint hosts. You can optimize resource utilization by tailoring how the required CPU cores, accelerators, and memory are allocated. You can deploy multiple inference components to an endpoint, where each inference component contains one model and the resource utilization needs for that individual model. After you deploy an inference component, you can directly invoke the associated model when you use the InvokeEndpoint API action.

func (*Client) CreateInferenceExperiment added in v1.56.0

func (c *Client) CreateInferenceExperiment(ctx context.Context, params *CreateInferenceExperimentInput, optFns ...func(*Options)) (*CreateInferenceExperimentOutput, error)

Creates an inference experiment using the configurations specified in the request. Use this API to setup and schedule an experiment to compare model variants on a Amazon SageMaker inference endpoint. For more information about inference experiments, see Shadow tests (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html) . Amazon SageMaker begins your experiment at the scheduled time and routes traffic to your endpoint's model variants based on your specified configuration. While the experiment is in progress or after it has concluded, you can view metrics that compare your model variants. For more information, see View, monitor, and edit shadow tests (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests-view-monitor-edit.html) .

func (*Client) CreateInferenceRecommendationsJob added in v1.20.0

func (c *Client) CreateInferenceRecommendationsJob(ctx context.Context, params *CreateInferenceRecommendationsJobInput, optFns ...func(*Options)) (*CreateInferenceRecommendationsJobOutput, error)

Starts a recommendation job. You can create either an instance recommendation or load test job.

func (*Client) CreateLabelingJob

func (c *Client) CreateLabelingJob(ctx context.Context, params *CreateLabelingJobInput, optFns ...func(*Options)) (*CreateLabelingJobOutput, error)

Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models. You can select your workforce from one of three providers:

  • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
  • One or more vendors that you select from the Amazon Web Services Marketplace. Vendors provide expertise in specific areas.
  • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-automated-labeling.html) . The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-data.html) . The output can be used as the manifest file for another labeling job or as training data for your machine learning models. You can use this operation to create a static labeling job or a streaming labeling job. A static labeling job stops if all data objects in the input manifest file identified in ManifestS3Uri have been labeled. A streaming labeling job runs perpetually until it is manually stopped, or remains idle for 10 days. You can send new data objects to an active ( InProgress ) streaming labeling job in real time. To learn how to create a static labeling job, see Create a Labeling Job (API) (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-create-labeling-job-api.html) in the Amazon SageMaker Developer Guide. To learn how to create a streaming labeling job, see Create a Streaming Labeling Job (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-streaming-create-job.html) .

func (*Client) CreateModel

func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error)

Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job. To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment. To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.

func (*Client) CreateModelBiasJobDefinition added in v0.31.0

func (c *Client) CreateModelBiasJobDefinition(ctx context.Context, params *CreateModelBiasJobDefinitionInput, optFns ...func(*Options)) (*CreateModelBiasJobDefinitionOutput, error)

Creates the definition for a model bias job.

func (*Client) CreateModelCard added in v1.56.0

func (c *Client) CreateModelCard(ctx context.Context, params *CreateModelCardInput, optFns ...func(*Options)) (*CreateModelCardOutput, error)

Creates an Amazon SageMaker Model Card. For information about how to use model cards, see Amazon SageMaker Model Card (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html) .

func (*Client) CreateModelCardExportJob added in v1.56.0

func (c *Client) CreateModelCardExportJob(ctx context.Context, params *CreateModelCardExportJobInput, optFns ...func(*Options)) (*CreateModelCardExportJobOutput, error)

Creates an Amazon SageMaker Model Card export job.

func (*Client) CreateModelExplainabilityJobDefinition added in v0.31.0

func (c *Client) CreateModelExplainabilityJobDefinition(ctx context.Context, params *CreateModelExplainabilityJobDefinitionInput, optFns ...func(*Options)) (*CreateModelExplainabilityJobDefinitionOutput, error)

Creates the definition for a model explainability job.

func (*Client) CreateModelPackage

func (c *Client) CreateModelPackage(ctx context.Context, params *CreateModelPackageInput, optFns ...func(*Options)) (*CreateModelPackageOutput, error)

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification . To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification . There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.
  • Unversioned - a model package that is not part of a model group.

func (*Client) CreateModelPackageGroup added in v0.31.0

func (c *Client) CreateModelPackageGroup(ctx context.Context, params *CreateModelPackageGroupInput, optFns ...func(*Options)) (*CreateModelPackageGroupOutput, error)

Creates a model group. A model group contains a group of model versions.

func (*Client) CreateModelQualityJobDefinition added in v0.31.0

func (c *Client) CreateModelQualityJobDefinition(ctx context.Context, params *CreateModelQualityJobDefinitionInput, optFns ...func(*Options)) (*CreateModelQualityJobDefinitionOutput, error)

Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html) .

func (*Client) CreateMonitoringSchedule

func (c *Client) CreateMonitoringSchedule(ctx context.Context, params *CreateMonitoringScheduleInput, optFns ...func(*Options)) (*CreateMonitoringScheduleOutput, error)

Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endpoint.

func (*Client) CreateNotebookInstance

func (c *Client) CreateNotebookInstance(ctx context.Context, params *CreateNotebookInstanceInput, optFns ...func(*Options)) (*CreateNotebookInstanceOutput, error)

Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework. After receiving the request, SageMaker does the following:

  • Creates a network interface in the SageMaker VPC.
  • (Option) If you specified SubnetId , SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.
  • Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it. After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models. For more information, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html) .

func (*Client) CreateNotebookInstanceLifecycleConfig

func (c *Client) CreateNotebookInstanceLifecycleConfig(ctx context.Context, params *CreateNotebookInstanceLifecycleConfigInput, optFns ...func(*Options)) (*CreateNotebookInstanceLifecycleConfigOutput, error)

Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance. Each lifecycle configuration script has a limit of 16384 characters. The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin . View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook] . Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) .

func (*Client) CreatePipeline added in v0.31.0

func (c *Client) CreatePipeline(ctx context.Context, params *CreatePipelineInput, optFns ...func(*Options)) (*CreatePipelineOutput, error)

Creates a pipeline using a JSON pipeline definition.

func (*Client) CreatePresignedDomainUrl

func (c *Client) CreatePresignedDomainUrl(ctx context.Context, params *CreatePresignedDomainUrlInput, optFns ...func(*Options)) (*CreatePresignedDomainUrlOutput, error)

Creates a URL for a specified UserProfile in a Domain. When accessed in a web browser, the user will be automatically signed in to the domain, and granted access to all of the Apps and files associated with the Domain's Amazon Elastic File System volume. This operation can only be called when the authentication mode equals IAM. The IAM role or user passed to this API defines the permissions to access the app. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the app. You can restrict access to this API and to the URL that it returns to a list of IP addresses, Amazon VPCs or Amazon VPC Endpoints that you specify. For more information, see Connect to Amazon SageMaker Studio Through an Interface VPC Endpoint (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-interface-endpoint.html) . The URL that you get from a call to CreatePresignedDomainUrl has a default timeout of 5 minutes. You can configure this value using ExpiresInSeconds . If you try to use the URL after the timeout limit expires, you are directed to the Amazon Web Services console sign-in page.

func (*Client) CreatePresignedNotebookInstanceUrl

func (c *Client) CreatePresignedNotebookInstanceUrl(ctx context.Context, params *CreatePresignedNotebookInstanceUrlInput, optFns ...func(*Options)) (*CreatePresignedNotebookInstanceUrlOutput, error)

Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance. You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address (https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter) . The URL that you get from a call to CreatePresignedNotebookInstanceUrl (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreatePresignedNotebookInstanceUrl.html) is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.

func (*Client) CreateProcessingJob

func (c *Client) CreateProcessingJob(ctx context.Context, params *CreateProcessingJobInput, optFns ...func(*Options)) (*CreateProcessingJobOutput, error)

Creates a processing job.

func (*Client) CreateProject added in v0.31.0

func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

Creates a machine learning (ML) project that can contain one or more templates that set up an ML pipeline from training to deploying an approved model.

func (*Client) CreateSpace added in v1.56.0

func (c *Client) CreateSpace(ctx context.Context, params *CreateSpaceInput, optFns ...func(*Options)) (*CreateSpaceOutput, error)

Creates a space used for real time collaboration in a domain.

func (*Client) CreateStudioLifecycleConfig added in v1.15.0

func (c *Client) CreateStudioLifecycleConfig(ctx context.Context, params *CreateStudioLifecycleConfigInput, optFns ...func(*Options)) (*CreateStudioLifecycleConfigOutput, error)

Creates a new Amazon SageMaker Studio Lifecycle Configuration.

func (*Client) CreateTrainingJob

func (c *Client) CreateTrainingJob(ctx context.Context, params *CreateTrainingJobInput, optFns ...func(*Options)) (*CreateTrainingJobOutput, error)

Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference. In the request body, you provide the following:

  • AlgorithmSpecification - Identifies the training algorithm to use.
  • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) . Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
  • InputDataConfig - Describes the input required by the training job and the Amazon S3, EFS, or FSx location where it is stored.
  • OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training.
  • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.
  • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training (https://docs.aws.amazon.com/sagemaker/latest/dg/model-managed-spot-training.html) .
  • RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training.
  • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete.
  • Environment - The environment variables to set in the Docker container.
  • RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError .

For more information about SageMaker, see How It Works (https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html) .

func (*Client) CreateTransformJob

func (c *Client) CreateTransformJob(ctx context.Context, params *CreateTransformJobInput, optFns ...func(*Options)) (*CreateTransformJobOutput, error)

Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify. To perform batch transformations, you create a transform job and use the data that you have readily available. In the request body, you provide the following:

  • TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
  • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see CreateModel (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html) .
  • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
  • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
  • TransformResources - Identifies the ML compute instances for the transform job.

For more information about how batch transformation works, see Batch Transform (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html) .

func (*Client) CreateTrial

func (c *Client) CreateTrial(ctx context.Context, params *CreateTrialInput, optFns ...func(*Options)) (*CreateTrialOutput, error)

Creates an SageMaker trial. A trial is a set of steps called trial components that produce a machine learning model. A trial is part of a single SageMaker experiment. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial and then use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API to search for the tags. To get a list of all your trials, call the ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) API. To view a trial's properties, call the DescribeTrial (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html) API. To create a trial component, call the CreateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrialComponent.html) API.

func (*Client) CreateTrialComponent

func (c *Client) CreateTrialComponent(ctx context.Context, params *CreateTrialComponentInput, optFns ...func(*Options)) (*CreateTrialComponentOutput, error)

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials. Trial components include pre-processing jobs, training jobs, and batch transform jobs. When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK. You can add tags to a trial component and then use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API to search for the tags.

func (*Client) CreateUserProfile

func (c *Client) CreateUserProfile(ctx context.Context, params *CreateUserProfileInput, optFns ...func(*Options)) (*CreateUserProfileOutput, error)

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a "person" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to a domain. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System home directory.

func (*Client) CreateWorkforce

func (c *Client) CreateWorkforce(ctx context.Context, params *CreateWorkforceInput, optFns ...func(*Options)) (*CreateWorkforceOutput, error)

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account. If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkforce.html) API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce. To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig . You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito) (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html) . To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig . Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP) (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private-oidc.html) .

func (*Client) CreateWorkteam

func (c *Client) CreateWorkteam(ctx context.Context, params *CreateWorkteamInput, optFns ...func(*Options)) (*CreateWorkteamOutput, error)

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team. You cannot create more than 25 work teams in an account and region.

func (*Client) DeleteAction added in v0.31.0

func (c *Client) DeleteAction(ctx context.Context, params *DeleteActionInput, optFns ...func(*Options)) (*DeleteActionOutput, error)

Deletes an action.

func (*Client) DeleteAlgorithm

func (c *Client) DeleteAlgorithm(ctx context.Context, params *DeleteAlgorithmInput, optFns ...func(*Options)) (*DeleteAlgorithmOutput, error)

Removes the specified algorithm from your account.

func (*Client) DeleteApp

func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)

Used to stop and delete an app.

func (*Client) DeleteAppImageConfig added in v0.29.0

func (c *Client) DeleteAppImageConfig(ctx context.Context, params *DeleteAppImageConfigInput, optFns ...func(*Options)) (*DeleteAppImageConfigOutput, error)

Deletes an AppImageConfig.

func (*Client) DeleteArtifact added in v0.31.0

func (c *Client) DeleteArtifact(ctx context.Context, params *DeleteArtifactInput, optFns ...func(*Options)) (*DeleteArtifactOutput, error)

Deletes an artifact. Either ArtifactArn or Source must be specified.

func (*Client) DeleteAssociation added in v0.31.0

func (c *Client) DeleteAssociation(ctx context.Context, params *DeleteAssociationInput, optFns ...func(*Options)) (*DeleteAssociationOutput, error)

Deletes an association.

func (*Client) DeleteCluster added in v1.119.0

func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)

Delete a SageMaker HyperPod cluster.

func (*Client) DeleteCodeRepository

func (c *Client) DeleteCodeRepository(ctx context.Context, params *DeleteCodeRepositoryInput, optFns ...func(*Options)) (*DeleteCodeRepositoryOutput, error)

Deletes the specified Git repository from your account.

func (*Client) DeleteCompilationJob added in v1.121.0

func (c *Client) DeleteCompilationJob(ctx context.Context, params *DeleteCompilationJobInput, optFns ...func(*Options)) (*DeleteCompilationJobOutput, error)

Deletes the specified compilation job. This action deletes only the compilation job resource in Amazon SageMaker. It doesn't delete other resources that are related to that job, such as the model artifacts that the job creates, the compilation logs in CloudWatch, the compiled model, or the IAM role. You can delete a compilation job only if its current status is COMPLETED , FAILED , or STOPPED . If the job status is STARTING or INPROGRESS , stop the job, and then delete it after its status becomes STOPPED .

func (*Client) DeleteContext added in v0.31.0

func (c *Client) DeleteContext(ctx context.Context, params *DeleteContextInput, optFns ...func(*Options)) (*DeleteContextOutput, error)

Deletes an context.

func (*Client) DeleteDataQualityJobDefinition added in v0.31.0

func (c *Client) DeleteDataQualityJobDefinition(ctx context.Context, params *DeleteDataQualityJobDefinitionInput, optFns ...func(*Options)) (*DeleteDataQualityJobDefinitionOutput, error)

Deletes a data quality monitoring job definition.

func (*Client) DeleteDeviceFleet added in v0.31.0

func (c *Client) DeleteDeviceFleet(ctx context.Context, params *DeleteDeviceFleetInput, optFns ...func(*Options)) (*DeleteDeviceFleetOutput, error)

Deletes a fleet.

func (*Client) DeleteDomain

func (c *Client) DeleteDomain(ctx context.Context, params *DeleteDomainInput, optFns ...func(*Options)) (*DeleteDomainOutput, error)

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

func (*Client) DeleteEdgeDeploymentPlan added in v1.37.0

func (c *Client) DeleteEdgeDeploymentPlan(ctx context.Context, params *DeleteEdgeDeploymentPlanInput, optFns ...func(*Options)) (*DeleteEdgeDeploymentPlanOutput, error)

Deletes an edge deployment plan if (and only if) all the stages in the plan are inactive or there are no stages in the plan.

func (*Client) DeleteEdgeDeploymentStage added in v1.37.0

func (c *Client) DeleteEdgeDeploymentStage(ctx context.Context, params *DeleteEdgeDeploymentStageInput, optFns ...func(*Options)) (*DeleteEdgeDeploymentStageOutput, error)

Delete a stage in an edge deployment plan if (and only if) the stage is inactive.

func (*Client) DeleteEndpoint

func (c *Client) DeleteEndpoint(ctx context.Context, params *DeleteEndpointInput, optFns ...func(*Options)) (*DeleteEndpointOutput, error)

Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created. SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant (http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html) API call. When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html#sagemaker-CreateModel-request-ExecutionRoleArn) , otherwise SageMaker cannot delete these resources.

func (*Client) DeleteEndpointConfig

func (c *Client) DeleteEndpointConfig(ctx context.Context, params *DeleteEndpointConfigInput, optFns ...func(*Options)) (*DeleteEndpointConfigOutput, error)

Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

func (*Client) DeleteExperiment

func (c *Client) DeleteExperiment(ctx context.Context, params *DeleteExperimentInput, optFns ...func(*Options)) (*DeleteExperimentOutput, error)

Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListTrials.html) API to get a list of the trials associated with the experiment.

func (*Client) DeleteFeatureGroup added in v0.31.0

func (c *Client) DeleteFeatureGroup(ctx context.Context, params *DeleteFeatureGroupInput, optFns ...func(*Options)) (*DeleteFeatureGroupOutput, error)

Delete the FeatureGroup and any data that was written to the OnlineStore of the FeatureGroup . Data cannot be accessed from the OnlineStore immediately after DeleteFeatureGroup is called. Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore are not deleted. Note that it can take approximately 10-15 minutes to delete an OnlineStore FeatureGroup with the InMemory StorageType .

func (*Client) DeleteFlowDefinition

func (c *Client) DeleteFlowDefinition(ctx context.Context, params *DeleteFlowDefinitionInput, optFns ...func(*Options)) (*DeleteFlowDefinitionOutput, error)

Deletes the specified flow definition.

func (*Client) DeleteHub added in v1.56.0

func (c *Client) DeleteHub(ctx context.Context, params *DeleteHubInput, optFns ...func(*Options)) (*DeleteHubOutput, error)

Delete a hub. Hub APIs are only callable through SageMaker Studio.

func (*Client) DeleteHubContent added in v1.56.0

func (c *Client) DeleteHubContent(ctx context.Context, params *DeleteHubContentInput, optFns ...func(*Options)) (*DeleteHubContentOutput, error)

Delete the contents of a hub. Hub APIs are only callable through SageMaker Studio.

func (*Client) DeleteHumanTaskUi

func (c *Client) DeleteHumanTaskUi(ctx context.Context, params *DeleteHumanTaskUiInput, optFns ...func(*Options)) (*DeleteHumanTaskUiOutput, error)

Use this operation to delete a human task user interface (worker task template). To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html) . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis .

func (*Client) DeleteHyperParameterTuningJob added in v1.126.0

func (c *Client) DeleteHyperParameterTuningJob(ctx context.Context, params *DeleteHyperParameterTuningJobInput, optFns ...func(*Options)) (*DeleteHyperParameterTuningJobOutput, error)

Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.

func (*Client) DeleteImage added in v0.29.0

func (c *Client) DeleteImage(ctx context.Context, params *DeleteImageInput, optFns ...func(*Options)) (*DeleteImageOutput, error)

Deletes a SageMaker image and all versions of the image. The container images aren't deleted.

func (*Client) DeleteImageVersion added in v0.29.0

func (c *Client) DeleteImageVersion(ctx context.Context, params *DeleteImageVersionInput, optFns ...func(*Options)) (*DeleteImageVersionOutput, error)

Deletes a version of a SageMaker image. The container image the version represents isn't deleted.

func (*Client) DeleteInferenceComponent added in v1.119.0

func (c *Client) DeleteInferenceComponent(ctx context.Context, params *DeleteInferenceComponentInput, optFns ...func(*Options)) (*DeleteInferenceComponentOutput, error)

Deletes an inference component.

func (*Client) DeleteInferenceExperiment added in v1.56.0

func (c *Client) DeleteInferenceExperiment(ctx context.Context, params *DeleteInferenceExperimentInput, optFns ...func(*Options)) (*DeleteInferenceExperimentOutput, error)

Deletes an inference experiment. This operation does not delete your endpoint, variants, or any underlying resources. This operation only deletes the metadata of your experiment.

func (*Client) DeleteModel

func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optFns ...func(*Options)) (*DeleteModelOutput, error)

Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

func (*Client) DeleteModelBiasJobDefinition added in v0.31.0

func (c *Client) DeleteModelBiasJobDefinition(ctx context.Context, params *DeleteModelBiasJobDefinitionInput, optFns ...func(*Options)) (*DeleteModelBiasJobDefinitionOutput, error)

Deletes an Amazon SageMaker model bias job definition.

func (*Client) DeleteModelCard added in v1.56.0

func (c *Client) DeleteModelCard(ctx context.Context, params *DeleteModelCardInput, optFns ...func(*Options)) (*DeleteModelCardOutput, error)

Deletes an Amazon SageMaker Model Card.

func (*Client) DeleteModelExplainabilityJobDefinition added in v0.31.0

func (c *Client) DeleteModelExplainabilityJobDefinition(ctx context.Context, params *DeleteModelExplainabilityJobDefinitionInput, optFns ...func(*Options)) (*DeleteModelExplainabilityJobDefinitionOutput, error)

Deletes an Amazon SageMaker model explainability job definition.

func (*Client) DeleteModelPackage

func (c *Client) DeleteModelPackage(ctx context.Context, params *DeleteModelPackageInput, optFns ...func(*Options)) (*DeleteModelPackageOutput, error)

Deletes a model package. A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

func (*Client) DeleteModelPackageGroup added in v0.31.0

func (c *Client) DeleteModelPackageGroup(ctx context.Context, params *DeleteModelPackageGroupInput, optFns ...func(*Options)) (*DeleteModelPackageGroupOutput, error)

Deletes the specified model group.

func (*Client) DeleteModelPackageGroupPolicy added in v0.31.0

func (c *Client) DeleteModelPackageGroupPolicy(ctx context.Context, params *DeleteModelPackageGroupPolicyInput, optFns ...func(*Options)) (*DeleteModelPackageGroupPolicyOutput, error)

Deletes a model group resource policy.

func (*Client) DeleteModelQualityJobDefinition added in v0.31.0

func (c *Client) DeleteModelQualityJobDefinition(ctx context.Context, params *DeleteModelQualityJobDefinitionInput, optFns ...func(*Options)) (*DeleteModelQualityJobDefinitionOutput, error)

Deletes the secified model quality monitoring job definition.

func (*Client) DeleteMonitoringSchedule

func (c *Client) DeleteMonitoringSchedule(ctx context.Context, params *DeleteMonitoringScheduleInput, optFns ...func(*Options)) (*DeleteMonitoringScheduleOutput, error)

Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.

func (*Client) DeleteNotebookInstance

func (c *Client) DeleteNotebookInstance(ctx context.Context, params *DeleteNotebookInstanceInput, optFns ...func(*Options)) (*DeleteNotebookInstanceOutput, error)

Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API. When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

func (*Client) DeleteNotebookInstanceLifecycleConfig

func (c *Client) DeleteNotebookInstanceLifecycleConfig(ctx context.Context, params *DeleteNotebookInstanceLifecycleConfigInput, optFns ...func(*Options)) (*DeleteNotebookInstanceLifecycleConfigOutput, error)

Deletes a notebook instance lifecycle configuration.

func (*Client) DeletePipeline added in v0.31.0

func (c *Client) DeletePipeline(ctx context.Context, params *DeletePipelineInput, optFns ...func(*Options)) (*DeletePipelineOutput, error)

Deletes a pipeline if there are no running instances of the pipeline. To delete a pipeline, you must stop all running instances of the pipeline using the StopPipelineExecution API. When you delete a pipeline, all instances of the pipeline are deleted.

func (*Client) DeleteProject added in v0.31.0

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Delete the specified project.

func (*Client) DeleteSpace added in v1.56.0

func (c *Client) DeleteSpace(ctx context.Context, params *DeleteSpaceInput, optFns ...func(*Options)) (*DeleteSpaceOutput, error)

Used to delete a space.

func (*Client) DeleteStudioLifecycleConfig added in v1.15.0

func (c *Client) DeleteStudioLifecycleConfig(ctx context.Context, params *DeleteStudioLifecycleConfigInput, optFns ...func(*Options)) (*DeleteStudioLifecycleConfigOutput, error)

Deletes the Amazon SageMaker Studio Lifecycle Configuration. In order to delete the Lifecycle Configuration, there must be no running apps using the Lifecycle Configuration. You must also remove the Lifecycle Configuration from UserSettings in all Domains and UserProfiles.

func (*Client) DeleteTags

func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error)

Deletes the specified tags from an SageMaker resource. To list a resource's tags, use the ListTags API. When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API. When you call this API to delete tags from a SageMaker Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Domain or User Profile launched before you called this API.

func (*Client) DeleteTrial

func (c *Client) DeleteTrial(ctx context.Context, params *DeleteTrialInput, optFns ...func(*Options)) (*DeleteTrialOutput, error)

Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html) API to get the list of trial components.

func (*Client) DeleteTrialComponent

func (c *Client) DeleteTrialComponent(ctx context.Context, params *DeleteTrialComponentInput, optFns ...func(*Options)) (*DeleteTrialComponentOutput, error)

Deletes the specified trial component. A trial component must be disassociated from all trials before the trial component can be deleted. To disassociate a trial component from a trial, call the DisassociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DisassociateTrialComponent.html) API.

func (*Client) DeleteUserProfile

func (c *Client) DeleteUserProfile(ctx context.Context, params *DeleteUserProfileInput, optFns ...func(*Options)) (*DeleteUserProfileOutput, error)

Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.

func (*Client) DeleteWorkforce

func (c *Client) DeleteWorkforce(ctx context.Context, params *DeleteWorkforceInput, optFns ...func(*Options)) (*DeleteWorkforceOutput, error)

Use this operation to delete a workforce. If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use this operation to delete the existing workforce and then use CreateWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateWorkforce.html) to create a new workforce. If a private workforce contains one or more work teams, you must use the DeleteWorkteam (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.

func (*Client) DeleteWorkteam

func (c *Client) DeleteWorkteam(ctx context.Context, params *DeleteWorkteamInput, optFns ...func(*Options)) (*DeleteWorkteamOutput, error)

Deletes an existing work team. This operation can't be undone.

func (*Client) DeregisterDevices added in v0.31.0

func (c *Client) DeregisterDevices(ctx context.Context, params *DeregisterDevicesInput, optFns ...func(*Options)) (*DeregisterDevicesOutput, error)

Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.

func (*Client) DescribeAction added in v0.31.0

func (c *Client) DescribeAction(ctx context.Context, params *DescribeActionInput, optFns ...func(*Options)) (*DescribeActionOutput, error)

Describes an action.

func (*Client) DescribeAlgorithm

func (c *Client) DescribeAlgorithm(ctx context.Context, params *DescribeAlgorithmInput, optFns ...func(*Options)) (*DescribeAlgorithmOutput, error)

Returns a description of the specified algorithm that is in your account.

func (*Client) DescribeApp

func (c *Client) DescribeApp(ctx context.Context, params *DescribeAppInput, optFns ...func(*Options)) (*DescribeAppOutput, error)

Describes the app.

func (*Client) DescribeAppImageConfig added in v0.29.0

func (c *Client) DescribeAppImageConfig(ctx context.Context, params *DescribeAppImageConfigInput, optFns ...func(*Options)) (*DescribeAppImageConfigOutput, error)

Describes an AppImageConfig.

func (*Client) DescribeArtifact added in v0.31.0

func (c *Client) DescribeArtifact(ctx context.Context, params *DescribeArtifactInput, optFns ...func(*Options)) (*DescribeArtifactOutput, error)

Describes an artifact.

func (*Client) DescribeAutoMLJob

func (c *Client) DescribeAutoMLJob(ctx context.Context, params *DescribeAutoMLJobInput, optFns ...func(*Options)) (*DescribeAutoMLJobOutput, error)

Returns information about an AutoML job created by calling CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) . AutoML jobs created by calling CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) cannot be described by DescribeAutoMLJob .

func (*Client) DescribeAutoMLJobV2 added in v1.72.0

func (c *Client) DescribeAutoMLJobV2(ctx context.Context, params *DescribeAutoMLJobV2Input, optFns ...func(*Options)) (*DescribeAutoMLJobV2Output, error)

Returns information about an AutoML job created by calling CreateAutoMLJobV2 (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJobV2.html) or CreateAutoMLJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html) .

func (*Client) DescribeCluster added in v1.119.0

func (c *Client) DescribeCluster(ctx context.Context, params *DescribeClusterInput, optFns ...func(*Options)) (*DescribeClusterOutput, error)

Retrieves information of a SageMaker HyperPod cluster.

func (*Client) DescribeClusterNode added in v1.119.0

func (c *Client) DescribeClusterNode(ctx context.Context, params *DescribeClusterNodeInput, optFns ...func(*Options)) (*DescribeClusterNodeOutput, error)

Retrieves information of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

func (*Client) DescribeCodeRepository

func (c *Client) DescribeCodeRepository(ctx context.Context, params *DescribeCodeRepositoryInput, optFns ...func(*Options)) (*DescribeCodeRepositoryOutput, error)

Gets details about the specified Git repository.

func (*Client) DescribeCompilationJob

func (c *Client) DescribeCompilationJob(ctx context.Context, params *DescribeCompilationJobInput, optFns ...func(*Options)) (*DescribeCompilationJobOutput, error)

Returns information about a model compilation job. To create a model compilation job, use CreateCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html) . To get information about multiple model compilation jobs, use ListCompilationJobs (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListCompilationJobs.html) .

func (*Client) DescribeContext added in v0.31.0

func (c *Client) DescribeContext(ctx context.Context, params *DescribeContextInput, optFns ...func(*Options)) (*DescribeContextOutput, error)

Describes a context.

func (*Client) DescribeDataQualityJobDefinition added in v0.31.0

func (c *Client) DescribeDataQualityJobDefinition(ctx context.Context, params *DescribeDataQualityJobDefinitionInput, optFns ...func(*Options)) (*DescribeDataQualityJobDefinitionOutput, error)

Gets the details of a data quality monitoring job definition.

func (*Client) DescribeDevice added in v0.31.0

func (c *Client) DescribeDevice(ctx context.Context, params *DescribeDeviceInput, optFns ...func(*Options)) (*DescribeDeviceOutput, error)

Describes the device.

func (*Client) DescribeDeviceFleet added in v0.31.0

func (c *Client) DescribeDeviceFleet(ctx context.Context, params *DescribeDeviceFleetInput, optFns ...func(*Options)) (*DescribeDeviceFleetOutput, error)

A description of the fleet the device belongs to.

func (*Client) DescribeDomain

func (c *Client) DescribeDomain(ctx context.Context, params *DescribeDomainInput, optFns ...func(*Options)) (*DescribeDomainOutput, error)

The description of the domain.

func (*Client) DescribeEdgeDeploymentPlan added in v1.37.0

func (c *Client) DescribeEdgeDeploymentPlan(ctx context.Context, params *DescribeEdgeDeploymentPlanInput, optFns ...func(*Options)) (*DescribeEdgeDeploymentPlanOutput, error)

Describes an edge deployment plan with deployment status per stage.

func (*Client) DescribeEdgePackagingJob added in v0.31.0

func (c *Client) DescribeEdgePackagingJob(ctx context.Context, params *DescribeEdgePackagingJobInput, optFns ...func(*Options)) (*DescribeEdgePackagingJobOutput, error)

A description of edge packaging jobs.

func (*Client) DescribeEndpoint

func (c *Client) DescribeEndpoint(ctx context.Context, params *DescribeEndpointInput, optFns ...func(*Options)) (*DescribeEndpointOutput, error)

Returns the description of an endpoint.

func (*Client) DescribeEndpointConfig

func (c *Client) DescribeEndpointConfig(ctx context.Context, params *DescribeEndpointConfigInput, optFns ...func(*Options)) (*DescribeEndpointConfigOutput, error)

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

func (*Client) DescribeExperiment

func (c *Client) DescribeExperiment(ctx context.Context, params *DescribeExperimentInput, optFns ...func(*Options)) (*DescribeExperimentOutput, error)

Provides a list of an experiment's properties.

func (*Client) DescribeFeatureGroup added in v0.31.0

func (c *Client) DescribeFeatureGroup(ctx context.Context, params *DescribeFeatureGroupInput, optFns ...func(*Options)) (*DescribeFeatureGroupOutput, error)

Use this operation to describe a FeatureGroup . The response includes information on the creation time, FeatureGroup name, the unique identifier for each FeatureGroup , and more.

func (*Client) DescribeFeatureMetadata added in v1.34.0

func (c *Client) DescribeFeatureMetadata(ctx context.Context, params *DescribeFeatureMetadataInput, optFns ...func(*Options)) (*DescribeFeatureMetadataOutput, error)

Shows the metadata for a feature within a feature group.

func (*Client) DescribeFlowDefinition

func (c *Client) DescribeFlowDefinition(ctx context.Context, params *DescribeFlowDefinitionInput, optFns ...func(*Options)) (*DescribeFlowDefinitionOutput, error)

Returns information about the specified flow definition.

func (*Client) DescribeHub added in v1.56.0

func (c *Client) DescribeHub(ctx context.Context, params *DescribeHubInput, optFns ...func(*Options)) (*DescribeHubOutput, error)

Describe a hub. Hub APIs are only callable through SageMaker Studio.

func (*Client) DescribeHubContent added in v1.56.0

func (c *Client) DescribeHubContent(ctx context.Context, params *DescribeHubContentInput, optFns ...func(*Options)) (*DescribeHubContentOutput, error)

Describe the content of a hub. Hub APIs are only callable through SageMaker Studio.

func (*Client) DescribeHumanTaskUi

func (c *Client) DescribeHumanTaskUi(ctx context.Context, params *DescribeHumanTaskUiInput, optFns ...func(*Options)) (*DescribeHumanTaskUiOutput, error)

Returns information about the requested human task user interface (worker task template).

func (*Client) DescribeHyperParameterTuningJob

func (c *Client) DescribeHyperParameterTuningJob(ctx context.Context, params *DescribeHyperParameterTuningJobInput, optFns ...func(*Options)) (*DescribeHyperParameterTuningJobOutput, error)

Returns a description of a hyperparameter tuning job, depending on the fields selected. These fields can include the name, Amazon Resource Name (ARN), job status of your tuning job and more.

func (*Client) DescribeImage added in v0.29.0

func (c *Client) DescribeImage(ctx context.Context, params *DescribeImageInput, optFns ...func(*Options)) (*DescribeImageOutput, error)

Describes a SageMaker image.

func (*Client) DescribeImageVersion added in v0.29.0

func (c *Client) DescribeImageVersion(ctx context.Context, params *DescribeImageVersionInput, optFns ...func(*Options)) (*DescribeImageVersionOutput, error)

Describes a version of a SageMaker image.

func (*Client) DescribeInferenceComponent added in v1.119.0

func (c *Client) DescribeInferenceComponent(ctx context.Context, params *DescribeInferenceComponentInput, optFns ...func(*Options)) (*DescribeInferenceComponentOutput, error)

Returns information about an inference component.

func (*Client) DescribeInferenceExperiment added in v1.56.0

func (c *Client) DescribeInferenceExperiment(ctx context.Context, params *DescribeInferenceExperimentInput, optFns ...func(*Options)) (*DescribeInferenceExperimentOutput, error)

Returns details about an inference experiment.

func (*Client) DescribeInferenceRecommendationsJob added in v1.20.0

func (c *Client) DescribeInferenceRecommendationsJob(ctx context.Context, params *DescribeInferenceRecommendationsJobInput, optFns ...func(*Options)) (*DescribeInferenceRecommendationsJobOutput, error)

Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.

func (*Client) DescribeLabelingJob

func (c *Client) DescribeLabelingJob(ctx context.Context, params *DescribeLabelingJobInput, optFns ...func(*Options)) (*DescribeLabelingJobOutput, error)

Gets information about a labeling job.

func (*Client) DescribeLineageGroup added in v1.20.0

func (c *Client) DescribeLineageGroup(ctx context.Context, params *DescribeLineageGroupInput, optFns ...func(*Options)) (*DescribeLineageGroupOutput, error)

Provides a list of properties for the requested lineage group. For more information, see Cross-Account Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) in the Amazon SageMaker Developer Guide.

func (*Client) DescribeModel

func (c *Client) DescribeModel(ctx context.Context, params *DescribeModelInput, optFns ...func(*Options)) (*DescribeModelOutput, error)

Describes a model that you created using the CreateModel API.

func (*Client) DescribeModelBiasJobDefinition added in v0.31.0

func (c *Client) DescribeModelBiasJobDefinition(ctx context.Context, params *DescribeModelBiasJobDefinitionInput, optFns ...func(*Options)) (*DescribeModelBiasJobDefinitionOutput, error)

Returns a description of a model bias job definition.

func (*Client) DescribeModelCard added in v1.56.0

func (c *Client) DescribeModelCard(ctx context.Context, params *DescribeModelCardInput, optFns ...func(*Options)) (*DescribeModelCardOutput, error)

Describes the content, creation time, and security configuration of an Amazon SageMaker Model Card.

func (*Client) DescribeModelCardExportJob added in v1.56.0

func (c *Client) DescribeModelCardExportJob(ctx context.Context, params *DescribeModelCardExportJobInput, optFns ...func(*Options)) (*DescribeModelCardExportJobOutput, error)

Describes an Amazon SageMaker Model Card export job.

func (*Client) DescribeModelExplainabilityJobDefinition added in v0.31.0

func (c *Client) DescribeModelExplainabilityJobDefinition(ctx context.Context, params *DescribeModelExplainabilityJobDefinitionInput, optFns ...func(*Options)) (*DescribeModelExplainabilityJobDefinitionOutput, error)

Returns a description of a model explainability job definition.

func (*Client) DescribeModelPackage

func (c *Client) DescribeModelPackage(ctx context.Context, params *DescribeModelPackageInput, optFns ...func(*Options)) (*DescribeModelPackageOutput, error)

Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace. To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.

func (*Client) DescribeModelPackageGroup added in v0.31.0

func (c *Client) DescribeModelPackageGroup(ctx context.Context, params *DescribeModelPackageGroupInput, optFns ...func(*Options)) (*DescribeModelPackageGroupOutput, error)

Gets a description for the specified model group.

func (*Client) DescribeModelQualityJobDefinition added in v0.31.0

func (c *Client) DescribeModelQualityJobDefinition(ctx context.Context, params *DescribeModelQualityJobDefinitionInput, optFns ...func(*Options)) (*DescribeModelQualityJobDefinitionOutput, error)

Returns a description of a model quality job definition.

func (*Client) DescribeMonitoringSchedule

func (c *Client) DescribeMonitoringSchedule(ctx context.Context, params *DescribeMonitoringScheduleInput, optFns ...func(*Options)) (*DescribeMonitoringScheduleOutput, error)

Describes the schedule for a monitoring job.

func (*Client) DescribeNotebookInstance

func (c *Client) DescribeNotebookInstance(ctx context.Context, params *DescribeNotebookInstanceInput, optFns ...func(*Options)) (*DescribeNotebookInstanceOutput, error)

Returns information about a notebook instance.

func (*Client) DescribeNotebookInstanceLifecycleConfig

func (c *Client) DescribeNotebookInstanceLifecycleConfig(ctx context.Context, params *DescribeNotebookInstanceLifecycleConfigInput, optFns ...func(*Options)) (*DescribeNotebookInstanceLifecycleConfigOutput, error)

Returns a description of a notebook instance lifecycle configuration. For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html) .

func (*Client) DescribePipeline added in v0.31.0

func (c *Client) DescribePipeline(ctx context.Context, params *DescribePipelineInput, optFns ...func(*Options)) (*DescribePipelineOutput, error)

Describes the details of a pipeline.

func (*Client) DescribePipelineDefinitionForExecution added in v0.31.0

func (c *Client) DescribePipelineDefinitionForExecution(ctx context.Context, params *DescribePipelineDefinitionForExecutionInput, optFns ...func(*Options)) (*DescribePipelineDefinitionForExecutionOutput, error)

Describes the details of an execution's pipeline definition.

func (*Client) DescribePipelineExecution added in v0.31.0

func (c *Client) DescribePipelineExecution(ctx context.Context, params *DescribePipelineExecutionInput, optFns ...func(*Options)) (*DescribePipelineExecutionOutput, error)

Describes the details of a pipeline execution.

func (*Client) DescribeProcessingJob

func (c *Client) DescribeProcessingJob(ctx context.Context, params *DescribeProcessingJobInput, optFns ...func(*Options)) (*DescribeProcessingJobOutput, error)

Returns a description of a processing job.

func (*Client) DescribeProject added in v0.31.0

func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)

Describes the details of a project.

func (*Client) DescribeSpace added in v1.56.0

func (c *Client) DescribeSpace(ctx context.Context, params *DescribeSpaceInput, optFns ...func(*Options)) (*DescribeSpaceOutput, error)

Describes the space.

func (*Client) DescribeStudioLifecycleConfig added in v1.15.0

func (c *Client) DescribeStudioLifecycleConfig(ctx context.Context, params *DescribeStudioLifecycleConfigInput, optFns ...func(*Options)) (*DescribeStudioLifecycleConfigOutput, error)

Describes the Amazon SageMaker Studio Lifecycle Configuration.

func (*Client) DescribeSubscribedWorkteam

func (c *Client) DescribeSubscribedWorkteam(ctx context.Context, params *DescribeSubscribedWorkteamInput, optFns ...func(*Options)) (*DescribeSubscribedWorkteamOutput, error)

Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the Amazon Web Services Marketplace.

func (*Client) DescribeTrainingJob

func (c *Client) DescribeTrainingJob(ctx context.Context, params *DescribeTrainingJobInput, optFns ...func(*Options)) (*DescribeTrainingJobOutput, error)

Returns information about a training job. Some of the attributes below only appear if the training job successfully starts. If the training job fails, TrainingJobStatus is Failed and, depending on the FailureReason , attributes like TrainingStartTime , TrainingTimeInSeconds , TrainingEndTime , and BillableTimeInSeconds may not be present in the response.

func (*Client) DescribeTransformJob

func (c *Client) DescribeTransformJob(ctx context.Context, params *DescribeTransformJobInput, optFns ...func(*Options)) (*DescribeTransformJobOutput, error)

Returns information about a transform job.

func (*Client) DescribeTrial

func (c *Client) DescribeTrial(ctx context.Context, params *DescribeTrialInput, optFns ...func(*Options)) (*DescribeTrialOutput, error)

Provides a list of a trial's properties.

func (*Client) DescribeTrialComponent

func (c *Client) DescribeTrialComponent(ctx context.Context, params *DescribeTrialComponentInput, optFns ...func(*Options)) (*DescribeTrialComponentOutput, error)

Provides a list of a trials component's properties.

func (*Client) DescribeUserProfile

func (c *Client) DescribeUserProfile(ctx context.Context, params *DescribeUserProfileInput, optFns ...func(*Options)) (*DescribeUserProfileOutput, error)

Describes a user profile. For more information, see CreateUserProfile .

func (*Client) DescribeWorkforce

func (c *Client) DescribeWorkforce(ctx context.Context, params *DescribeWorkforceInput, optFns ...func(*Options)) (*DescribeWorkforceOutput, error)

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) ). Allowable IP address ranges are the IP addresses that workers can use to access tasks. This operation applies only to private workforces.

func (*Client) DescribeWorkteam

func (c *Client) DescribeWorkteam(ctx context.Context, params *DescribeWorkteamInput, optFns ...func(*Options)) (*DescribeWorkteamOutput, error)

Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

func (*Client) DisableSagemakerServicecatalogPortfolio added in v0.31.0

func (c *Client) DisableSagemakerServicecatalogPortfolio(ctx context.Context, params *DisableSagemakerServicecatalogPortfolioInput, optFns ...func(*Options)) (*DisableSagemakerServicecatalogPortfolioOutput, error)

Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

func (*Client) DisassociateTrialComponent

func (c *Client) DisassociateTrialComponent(ctx context.Context, params *DisassociateTrialComponentInput, optFns ...func(*Options)) (*DisassociateTrialComponentOutput, error)

Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AssociateTrialComponent.html) API. To get a list of the trials a component is associated with, use the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html) API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents .

func (*Client) EnableSagemakerServicecatalogPortfolio added in v0.31.0

func (c *Client) EnableSagemakerServicecatalogPortfolio(ctx context.Context, params *EnableSagemakerServicecatalogPortfolioInput, optFns ...func(*Options)) (*EnableSagemakerServicecatalogPortfolioOutput, error)

Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

func (*Client) GetDeviceFleetReport added in v0.31.0

func (c *Client) GetDeviceFleetReport(ctx context.Context, params *GetDeviceFleetReportInput, optFns ...func(*Options)) (*GetDeviceFleetReportOutput, error)

Describes a fleet.

func (*Client) GetLineageGroupPolicy added in v1.20.0

func (c *Client) GetLineageGroupPolicy(ctx context.Context, params *GetLineageGroupPolicyInput, optFns ...func(*Options)) (*GetLineageGroupPolicyOutput, error)

The resource policy for the lineage group.

func (*Client) GetModelPackageGroupPolicy added in v0.31.0

func (c *Client) GetModelPackageGroupPolicy(ctx context.Context, params *GetModelPackageGroupPolicyInput, optFns ...func(*Options)) (*GetModelPackageGroupPolicyOutput, error)

Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) in the Amazon Web Services Identity and Access Management User Guide..

func (*Client) GetSagemakerServicecatalogPortfolioStatus added in v0.31.0

func (c *Client) GetSagemakerServicecatalogPortfolioStatus(ctx context.Context, params *GetSagemakerServicecatalogPortfolioStatusInput, optFns ...func(*Options)) (*GetSagemakerServicecatalogPortfolioStatusOutput, error)

Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.

func (*Client) GetScalingConfigurationRecommendation added in v1.98.0

func (c *Client) GetScalingConfigurationRecommendation(ctx context.Context, params *GetScalingConfigurationRecommendationInput, optFns ...func(*Options)) (*GetScalingConfigurationRecommendationOutput, error)

Starts an Amazon SageMaker Inference Recommender autoscaling recommendation job. Returns recommendations for autoscaling policies that you can apply to your SageMaker endpoint.

func (*Client) GetSearchSuggestions

func (c *Client) GetSearchSuggestions(ctx context.Context, params *GetSearchSuggestionsInput, optFns ...func(*Options)) (*GetSearchSuggestionsOutput, error)

An auto-complete API for the search functionality in the SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters , Tags , and Metrics .

func (*Client) ImportHubContent added in v1.56.0

func (c *Client) ImportHubContent(ctx context.Context, params *ImportHubContentInput, optFns ...func(*Options)) (*ImportHubContentOutput, error)

Import hub content. Hub APIs are only callable through SageMaker Studio.

func (*Client) ListActions added in v0.31.0

func (c *Client) ListActions(ctx context.Context, params *ListActionsInput, optFns ...func(*Options)) (*ListActionsOutput, error)

Lists the actions in your account and their properties.

func (*Client) ListAlgorithms

func (c *Client) ListAlgorithms(ctx context.Context, params *ListAlgorithmsInput, optFns ...func(*Options)) (*ListAlgorithmsOutput, error)

Lists the machine learning algorithms that have been created.

func (*Client) ListAliases added in v1.59.0

func (c *Client) ListAliases(ctx context.Context, params *ListAliasesInput, optFns ...func(*Options)) (*ListAliasesOutput, error)

Lists the aliases of a specified image or image version.

func (*Client) ListAppImageConfigs added in v0.29.0

func (c *Client) ListAppImageConfigs(ctx context.Context, params *ListAppImageConfigsInput, optFns ...func(*Options)) (*ListAppImageConfigsOutput, error)

Lists the AppImageConfigs in your account and their properties. The list can be filtered by creation time or modified time, and whether the AppImageConfig name contains a specified string.

func (*Client) ListApps

func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)

Lists apps.

func (*Client) ListArtifacts added in v0.31.0

func (c *Client) ListArtifacts(ctx context.Context, params *ListArtifactsInput, optFns ...func(*Options)) (*ListArtifactsOutput, error)

Lists the artifacts in your account and their properties.

func (*Client) ListAssociations added in v0.31.0

func (c *Client) ListAssociations(ctx context.Context, params *ListAssociationsInput, optFns ...func(*Options)) (*ListAssociationsOutput, error)

Lists the associations in your account and their properties.

func (*Client) ListAutoMLJobs

func (c *Client) ListAutoMLJobs(ctx context.Context, params *ListAutoMLJobsInput, optFns ...func(*Options)) (*ListAutoMLJobsOutput, error)

Request a list of jobs.

func (*Client) ListCandidatesForAutoMLJob

func (c *Client) ListCandidatesForAutoMLJob(ctx context.Context, params *ListCandidatesForAutoMLJobInput, optFns ...func(*Options)) (*ListCandidatesForAutoMLJobOutput, error)

List the candidates created for the job.

func (*Client) ListClusterNodes added in v1.119.0

func (c *Client) ListClusterNodes(ctx context.Context, params *ListClusterNodesInput, optFns ...func(*Options)) (*ListClusterNodesOutput, error)

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

func (*Client) ListClusters added in v1.119.0

func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)

Retrieves the list of SageMaker HyperPod clusters.

func (*Client) ListCodeRepositories

func (c *Client) ListCodeRepositories(ctx context.Context, params *ListCodeRepositoriesInput, optFns ...func(*Options)) (*ListCodeRepositoriesOutput, error)

Gets a list of the Git repositories in your account.

func (*Client) ListCompilationJobs

func (c *Client) ListCompilationJobs(ctx context.Context, params *ListCompilationJobsInput, optFns ...func(*Options)) (*ListCompilationJobsOutput, error)

Lists model compilation jobs that satisfy various filters. To create a model compilation job, use CreateCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateCompilationJob.html) . To get information about a particular model compilation job you have created, use DescribeCompilationJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeCompilationJob.html) .

func (*Client) ListContexts added in v0.31.0

func (c *Client) ListContexts(ctx context.Context, params *ListContextsInput, optFns ...func(*Options)) (*ListContextsOutput, error)

Lists the contexts in your account and their properties.

func (*Client) ListDataQualityJobDefinitions added in v0.31.0

func (c *Client) ListDataQualityJobDefinitions(ctx context.Context, params *ListDataQualityJobDefinitionsInput, optFns ...func(*Options)) (*ListDataQualityJobDefinitionsOutput, error)

Lists the data quality job definitions in your account.

func (*Client) ListDeviceFleets added in v0.31.0

func (c *Client) ListDeviceFleets(ctx context.Context, params *ListDeviceFleetsInput, optFns ...func(*Options)) (*ListDeviceFleetsOutput, error)

Returns a list of devices in the fleet.

func (*Client) ListDevices added in v0.31.0

func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error)

A list of devices.

func (*Client) ListDomains

func (c *Client) ListDomains(ctx context.Context, params *ListDomainsInput, optFns ...func(*Options)) (*ListDomainsOutput, error)

Lists the domains.

func (*Client) ListEdgeDeploymentPlans added in v1.37.0

func (c *Client) ListEdgeDeploymentPlans(ctx context.Context, params *ListEdgeDeploymentPlansInput, optFns ...func(*Options)) (*ListEdgeDeploymentPlansOutput, error)

Lists all edge deployment plans.

func (*Client) ListEdgePackagingJobs added in v0.31.0

func (c *Client) ListEdgePackagingJobs(ctx context.Context, params *ListEdgePackagingJobsInput, optFns ...func(*Options)) (*ListEdgePackagingJobsOutput, error)

Returns a list of edge packaging jobs.

func (*Client) ListEndpointConfigs

func (c *Client) ListEndpointConfigs(ctx context.Context, params *ListEndpointConfigsInput, optFns ...func(*Options)) (*ListEndpointConfigsOutput, error)

Lists endpoint configurations.

func (*Client) ListEndpoints

func (c *Client) ListEndpoints(ctx context.Context, params *ListEndpointsInput, optFns ...func(*Options)) (*ListEndpointsOutput, error)

Lists endpoints.

func (*Client) ListExperiments

func (c *Client) ListExperiments(ctx context.Context, params *ListExperimentsInput, optFns ...func(*Options)) (*ListExperimentsOutput, error)

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

func (*Client) ListFeatureGroups added in v0.31.0

func (c *Client) ListFeatureGroups(ctx context.Context, params *ListFeatureGroupsInput, optFns ...func(*Options)) (*ListFeatureGroupsOutput, error)

List FeatureGroup s based on given filter and order.

func (*Client) ListFlowDefinitions

func (c *Client) ListFlowDefinitions(ctx context.Context, params *ListFlowDefinitionsInput, optFns ...func(*Options)) (*ListFlowDefinitionsOutput, error)

Returns information about the flow definitions in your account.

func (*Client) ListHubContentVersions added in v1.56.0

func (c *Client) ListHubContentVersions(ctx context.Context, params *ListHubContentVersionsInput, optFns ...func(*Options)) (*ListHubContentVersionsOutput, error)

List hub content versions. Hub APIs are only callable through SageMaker Studio.

func (*Client) ListHubContents added in v1.56.0

func (c *Client) ListHubContents(ctx context.Context, params *ListHubContentsInput, optFns ...func(*Options)) (*ListHubContentsOutput, error)

List the contents of a hub. Hub APIs are only callable through SageMaker Studio.

func (*Client) ListHubs added in v1.56.0

func (c *Client) ListHubs(ctx context.Context, params *ListHubsInput, optFns ...func(*Options)) (*ListHubsOutput, error)

List all existing hubs. Hub APIs are only callable through SageMaker Studio.

func (*Client) ListHumanTaskUis

func (c *Client) ListHumanTaskUis(ctx context.Context, params *ListHumanTaskUisInput, optFns ...func(*Options)) (*ListHumanTaskUisOutput, error)

Returns information about the human task user interfaces in your account.

func (*Client) ListHyperParameterTuningJobs

func (c *Client) ListHyperParameterTuningJobs(ctx context.Context, params *ListHyperParameterTuningJobsInput, optFns ...func(*Options)) (*ListHyperParameterTuningJobsOutput, error)

Gets a list of HyperParameterTuningJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html) objects that describe the hyperparameter tuning jobs launched in your account.

func (*Client) ListImageVersions added in v0.29.0

func (c *Client) ListImageVersions(ctx context.Context, params *ListImageVersionsInput, optFns ...func(*Options)) (*ListImageVersionsOutput, error)

Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.

func (*Client) ListImages added in v0.29.0

func (c *Client) ListImages(ctx context.Context, params *ListImagesInput, optFns ...func(*Options)) (*ListImagesOutput, error)

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

func (*Client) ListInferenceComponents added in v1.119.0

func (c *Client) ListInferenceComponents(ctx context.Context, params *ListInferenceComponentsInput, optFns ...func(*Options)) (*ListInferenceComponentsOutput, error)

Lists the inference components in your account and their properties.

func (*Client) ListInferenceExperiments added in v1.56.0

func (c *Client) ListInferenceExperiments(ctx context.Context, params *ListInferenceExperimentsInput, optFns ...func(*Options)) (*ListInferenceExperimentsOutput, error)

Returns the list of all inference experiments.

func (*Client) ListInferenceRecommendationsJobSteps added in v1.50.0

func (c *Client) ListInferenceRecommendationsJobSteps(ctx context.Context, params *ListInferenceRecommendationsJobStepsInput, optFns ...func(*Options)) (*ListInferenceRecommendationsJobStepsOutput, error)

Returns a list of the subtasks for an Inference Recommender job. The supported subtasks are benchmarks, which evaluate the performance of your model on different instance types.

func (*Client) ListInferenceRecommendationsJobs added in v1.20.0

func (c *Client) ListInferenceRecommendationsJobs(ctx context.Context, params *ListInferenceRecommendationsJobsInput, optFns ...func(*Options)) (*ListInferenceRecommendationsJobsOutput, error)

Lists recommendation jobs that satisfy various filters.

func (*Client) ListLabelingJobs

func (c *Client) ListLabelingJobs(ctx context.Context, params *ListLabelingJobsInput, optFns ...func(*Options)) (*ListLabelingJobsOutput, error)

Gets a list of labeling jobs.

func (*Client) ListLabelingJobsForWorkteam

func (c *Client) ListLabelingJobsForWorkteam(ctx context.Context, params *ListLabelingJobsForWorkteamInput, optFns ...func(*Options)) (*ListLabelingJobsForWorkteamOutput, error)

Gets a list of labeling jobs assigned to a specified work team.

func (*Client) ListLineageGroups added in v1.20.0

func (c *Client) ListLineageGroups(ctx context.Context, params *ListLineageGroupsInput, optFns ...func(*Options)) (*ListLineageGroupsOutput, error)

A list of lineage groups shared with your Amazon Web Services account. For more information, see Cross-Account Lineage Tracking (https://docs.aws.amazon.com/sagemaker/latest/dg/xaccount-lineage-tracking.html) in the Amazon SageMaker Developer Guide.

func (*Client) ListModelBiasJobDefinitions added in v0.31.0

func (c *Client) ListModelBiasJobDefinitions(ctx context.Context, params *ListModelBiasJobDefinitionsInput, optFns ...func(*Options)) (*ListModelBiasJobDefinitionsOutput, error)

Lists model bias jobs definitions that satisfy various filters.

func (*Client) ListModelCardExportJobs added in v1.56.0

func (c *Client) ListModelCardExportJobs(ctx context.Context, params *ListModelCardExportJobsInput, optFns ...func(*Options)) (*ListModelCardExportJobsOutput, error)

List the export jobs for the Amazon SageMaker Model Card.

func (*Client) ListModelCardVersions added in v1.56.0

func (c *Client) ListModelCardVersions(ctx context.Context, params *ListModelCardVersionsInput, optFns ...func(*Options)) (*ListModelCardVersionsOutput, error)

List existing versions of an Amazon SageMaker Model Card.

func (*Client) ListModelCards added in v1.56.0

func (c *Client) ListModelCards(ctx context.Context, params *ListModelCardsInput, optFns ...func(*Options)) (*ListModelCardsOutput, error)

List existing model cards.

func (*Client) ListModelExplainabilityJobDefinitions added in v0.31.0

func (c *Client) ListModelExplainabilityJobDefinitions(ctx context.Context, params *ListModelExplainabilityJobDefinitionsInput, optFns ...func(*Options)) (*ListModelExplainabilityJobDefinitionsOutput, error)

Lists model explainability job definitions that satisfy various filters.

func (*Client) ListModelMetadata added in v1.20.0

func (c *Client) ListModelMetadata(ctx context.Context, params *ListModelMetadataInput, optFns ...func(*Options)) (*ListModelMetadataOutput, error)

Lists the domain, framework, task, and model name of standard machine learning models found in common model zoos.

func (*Client) ListModelPackageGroups added in v0.31.0

func (c *Client) ListModelPackageGroups(ctx context.Context, params *ListModelPackageGroupsInput, optFns ...func(*Options)) (*ListModelPackageGroupsOutput, error)

Gets a list of the model groups in your Amazon Web Services account.

func (*Client) ListModelPackages

func (c *Client) ListModelPackages(ctx context.Context, params *ListModelPackagesInput, optFns ...func(*Options)) (*ListModelPackagesOutput, error)

Lists the model packages that have been created.

func (*Client) ListModelQualityJobDefinitions added in v0.31.0

func (c *Client) ListModelQualityJobDefinitions(ctx context.Context, params *ListModelQualityJobDefinitionsInput, optFns ...func(*Options)) (*ListModelQualityJobDefinitionsOutput, error)

Gets a list of model quality monitoring job definitions in your account.

func (*Client) ListModels

func (c *Client) ListModels(ctx context.Context, params *ListModelsInput, optFns ...func(*Options)) (*ListModelsOutput, error)

Lists models created with the CreateModel API.

func (*Client) ListMonitoringAlertHistory added in v1.56.0

func (c *Client) ListMonitoringAlertHistory(ctx context.Context, params *ListMonitoringAlertHistoryInput, optFns ...func(*Options)) (*ListMonitoringAlertHistoryOutput, error)

Gets a list of past alerts in a model monitoring schedule.

func (*Client) ListMonitoringAlerts added in v1.56.0

func (c *Client) ListMonitoringAlerts(ctx context.Context, params *ListMonitoringAlertsInput, optFns ...func(*Options)) (*ListMonitoringAlertsOutput, error)

Gets the alerts for a single monitoring schedule.

func (*Client) ListMonitoringExecutions

func (c *Client) ListMonitoringExecutions(ctx context.Context, params *ListMonitoringExecutionsInput, optFns ...func(*Options)) (*ListMonitoringExecutionsOutput, error)

Returns list of all monitoring job executions.

func (*Client) ListMonitoringSchedules

func (c *Client) ListMonitoringSchedules(ctx context.Context, params *ListMonitoringSchedulesInput, optFns ...func(*Options)) (*ListMonitoringSchedulesOutput, error)

Returns list of all monitoring schedules.

func (*Client) ListNotebookInstanceLifecycleConfigs

func (c *Client) ListNotebookInstanceLifecycleConfigs(ctx context.Context, params *ListNotebookInstanceLifecycleConfigsInput, optFns ...func(*Options)) (*ListNotebookInstanceLifecycleConfigsOutput, error)

Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) API.

func (*Client) ListNotebookInstances

func (c *Client) ListNotebookInstances(ctx context.Context, params *ListNotebookInstancesInput, optFns ...func(*Options)) (*ListNotebookInstancesOutput, error)

Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.

func (*Client) ListPipelineExecutionSteps added in v0.31.0

func (c *Client) ListPipelineExecutionSteps(ctx context.Context, params *ListPipelineExecutionStepsInput, optFns ...func(*Options)) (*ListPipelineExecutionStepsOutput, error)

Gets a list of PipeLineExecutionStep objects.

func (*Client) ListPipelineExecutions added in v0.31.0

func (c *Client) ListPipelineExecutions(ctx context.Context, params *ListPipelineExecutionsInput, optFns ...func(*Options)) (*ListPipelineExecutionsOutput, error)

Gets a list of the pipeline executions.

func (*Client) ListPipelineParametersForExecution added in v0.31.0

func (c *Client) ListPipelineParametersForExecution(ctx context.Context, params *ListPipelineParametersForExecutionInput, optFns ...func(*Options)) (*ListPipelineParametersForExecutionOutput, error)

Gets a list of parameters for a pipeline execution.

func (*Client) ListPipelines added in v0.31.0

func (c *Client) ListPipelines(ctx context.Context, params *ListPipelinesInput, optFns ...func(*Options)) (*ListPipelinesOutput, error)

Gets a list of pipelines.

func (*Client) ListProcessingJobs

func (c *Client) ListProcessingJobs(ctx context.Context, params *ListProcessingJobsInput, optFns ...func(*Options)) (*ListProcessingJobsOutput, error)

Lists processing jobs that satisfy various filters.

func (*Client) ListProjects added in v0.31.0

func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)

Gets a list of the projects in an Amazon Web Services account.

func (*Client) ListResourceCatalogs added in v1.93.0

func (c *Client) ListResourceCatalogs(ctx context.Context, params *ListResourceCatalogsInput, optFns ...func(*Options)) (*ListResourceCatalogsOutput, error)

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ResourceCatalog s viewable is 1000.

func (*Client) ListSpaces added in v1.56.0

func (c *Client) ListSpaces(ctx context.Context, params *ListSpacesInput, optFns ...func(*Options)) (*ListSpacesOutput, error)

Lists spaces.

func (*Client) ListStageDevices added in v1.37.0

func (c *Client) ListStageDevices(ctx context.Context, params *ListStageDevicesInput, optFns ...func(*Options)) (*ListStageDevicesOutput, error)

Lists devices allocated to the stage, containing detailed device information and deployment status.

func (*Client) ListStudioLifecycleConfigs added in v1.15.0

func (c *Client) ListStudioLifecycleConfigs(ctx context.Context, params *ListStudioLifecycleConfigsInput, optFns ...func(*Options)) (*ListStudioLifecycleConfigsOutput, error)

Lists the Amazon SageMaker Studio Lifecycle Configurations in your Amazon Web Services Account.

func (*Client) ListSubscribedWorkteams

func (c *Client) ListSubscribedWorkteams(ctx context.Context, params *ListSubscribedWorkteamsInput, optFns ...func(*Options)) (*ListSubscribedWorkteamsOutput, error)

Gets a list of the work teams that you are subscribed to in the Amazon Web Services Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

func (*Client) ListTags

func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)

Returns the tags for the specified SageMaker resource.

func (*Client) ListTrainingJobs

func (c *Client) ListTrainingJobs(ctx context.Context, params *ListTrainingJobsInput, optFns ...func(*Options)) (*ListTrainingJobsOutput, error)

Lists training jobs. When StatusEquals and MaxResults are set at the same time, the MaxResults number of training jobs are first retrieved ignoring the StatusEquals parameter and then they are filtered by the StatusEquals parameter, which is returned as a response. For example, if ListTrainingJobs is invoked with the following parameters: { ... MaxResults: 100, StatusEquals: InProgress ... } First, 100 trainings jobs with any status, including those other than InProgress , are selected (sorted according to the creation time, from the most current to the oldest). Next, those with a status of InProgress are returned. You can quickly test the API using the following Amazon Web Services CLI code. aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress

func (*Client) ListTrainingJobsForHyperParameterTuningJob

func (c *Client) ListTrainingJobsForHyperParameterTuningJob(ctx context.Context, params *ListTrainingJobsForHyperParameterTuningJobInput, optFns ...func(*Options)) (*ListTrainingJobsForHyperParameterTuningJobOutput, error)

Gets a list of TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) objects that describe the training jobs that a hyperparameter tuning job launched.

func (*Client) ListTransformJobs

func (c *Client) ListTransformJobs(ctx context.Context, params *ListTransformJobsInput, optFns ...func(*Options)) (*ListTransformJobsOutput, error)

Lists transform jobs.

func (*Client) ListTrialComponents

func (c *Client) ListTrialComponents(ctx context.Context, params *ListTrialComponentsInput, optFns ...func(*Options)) (*ListTrialComponentsOutput, error)

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

  • ExperimentName
  • SourceArn
  • TrialName

func (*Client) ListTrials

func (c *Client) ListTrials(ctx context.Context, params *ListTrialsInput, optFns ...func(*Options)) (*ListTrialsOutput, error)

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

func (*Client) ListUserProfiles

func (c *Client) ListUserProfiles(ctx context.Context, params *ListUserProfilesInput, optFns ...func(*Options)) (*ListUserProfilesOutput, error)

Lists user profiles.

func (*Client) ListWorkforces

func (c *Client) ListWorkforces(ctx context.Context, params *ListWorkforcesInput, optFns ...func(*Options)) (*ListWorkforcesOutput, error)

Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.

func (*Client) ListWorkteams

func (c *Client) ListWorkteams(ctx context.Context, params *ListWorkteamsInput, optFns ...func(*Options)) (*ListWorkteamsOutput, error)

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

func (*Client) Options added in v1.119.0

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) PutModelPackageGroupPolicy added in v0.31.0

func (c *Client) PutModelPackageGroupPolicy(ctx context.Context, params *PutModelPackageGroupPolicyInput, optFns ...func(*Options)) (*PutModelPackageGroupPolicyOutput, error)

Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) in the Amazon Web Services Identity and Access Management User Guide..

func (*Client) QueryLineage added in v1.20.0

func (c *Client) QueryLineage(ctx context.Context, params *QueryLineageInput, optFns ...func(*Options)) (*QueryLineageOutput, error)

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities (https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html) in the Amazon SageMaker Developer Guide.

func (*Client) RegisterDevices added in v0.31.0

func (c *Client) RegisterDevices(ctx context.Context, params *RegisterDevicesInput, optFns ...func(*Options)) (*RegisterDevicesOutput, error)

Register devices.

func (*Client) RenderUiTemplate

func (c *Client) RenderUiTemplate(ctx context.Context, params *RenderUiTemplateInput, optFns ...func(*Options)) (*RenderUiTemplateOutput, error)

Renders the UI template so that you can preview the worker's experience.

func (*Client) RetryPipelineExecution added in v1.15.0

func (c *Client) RetryPipelineExecution(ctx context.Context, params *RetryPipelineExecutionInput, optFns ...func(*Options)) (*RetryPipelineExecutionOutput, error)

Retry the execution of the pipeline.

func (*Client) Search

func (c *Client) Search(ctx context.Context, params *SearchInput, optFns ...func(*Options)) (*SearchOutput, error)

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order. You can query against the following value types: numeric, text, Boolean, and timestamp. The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference (https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html) for more information.

func (*Client) SendPipelineExecutionStepFailure added in v1.7.0

func (c *Client) SendPipelineExecutionStepFailure(ctx context.Context, params *SendPipelineExecutionStepFailureInput, optFns ...func(*Options)) (*SendPipelineExecutionStepFailureOutput, error)

Notifies the pipeline that the execution of a callback step failed, along with a message describing why. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

func (*Client) SendPipelineExecutionStepSuccess added in v1.7.0

func (c *Client) SendPipelineExecutionStepSuccess(ctx context.Context, params *SendPipelineExecutionStepSuccessInput, optFns ...func(*Options)) (*SendPipelineExecutionStepSuccessOutput, error)

Notifies the pipeline that the execution of a callback step succeeded and provides a list of the step's output parameters. When a callback step is run, the pipeline generates a callback token and includes the token in a message sent to Amazon Simple Queue Service (Amazon SQS).

func (*Client) StartEdgeDeploymentStage added in v1.37.0

func (c *Client) StartEdgeDeploymentStage(ctx context.Context, params *StartEdgeDeploymentStageInput, optFns ...func(*Options)) (*StartEdgeDeploymentStageOutput, error)

Starts a stage in an edge deployment plan.

func (*Client) StartInferenceExperiment added in v1.56.0

func (c *Client) StartInferenceExperiment(ctx context.Context, params *StartInferenceExperimentInput, optFns ...func(*Options)) (*StartInferenceExperimentOutput, error)

Starts an inference experiment.

func (*Client) StartMonitoringSchedule

func (c *Client) StartMonitoringSchedule(ctx context.Context, params *StartMonitoringScheduleInput, optFns ...func(*Options)) (*StartMonitoringScheduleOutput, error)

Starts a previously stopped monitoring schedule. By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled .

func (*Client) StartNotebookInstance

func (c *Client) StartNotebookInstance(ctx context.Context, params *StartNotebookInstanceInput, optFns ...func(*Options)) (*StartNotebookInstanceOutput, error)

Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService . A notebook instance's status must be InService before you can connect to your Jupyter notebook.

func (*Client) StartPipelineExecution added in v0.31.0

func (c *Client) StartPipelineExecution(ctx context.Context, params *StartPipelineExecutionInput, optFns ...func(*Options)) (*StartPipelineExecutionOutput, error)

Starts a pipeline execution.

func (*Client) StopAutoMLJob

func (c *Client) StopAutoMLJob(ctx context.Context, params *StopAutoMLJobInput, optFns ...func(*Options)) (*StopAutoMLJobOutput, error)

A method for forcing a running job to shut down.

func (*Client) StopCompilationJob

func (c *Client) StopCompilationJob(ctx context.Context, params *StopCompilationJobInput, optFns ...func(*Options)) (*StopCompilationJobOutput, error)

Stops a model compilation job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal. When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobStatus of the job to Stopping . After Amazon SageMaker stops the job, it sets the CompilationJobStatus to Stopped .

func (*Client) StopEdgeDeploymentStage added in v1.37.0

func (c *Client) StopEdgeDeploymentStage(ctx context.Context, params *StopEdgeDeploymentStageInput, optFns ...func(*Options)) (*StopEdgeDeploymentStageOutput, error)

Stops a stage in an edge deployment plan.

func (*Client) StopEdgePackagingJob added in v0.31.0

func (c *Client) StopEdgePackagingJob(ctx context.Context, params *StopEdgePackagingJobInput, optFns ...func(*Options)) (*StopEdgePackagingJobOutput, error)

Request to stop an edge packaging job.

func (*Client) StopHyperParameterTuningJob

func (c *Client) StopHyperParameterTuningJob(ctx context.Context, params *StopHyperParameterTuningJobInput, optFns ...func(*Options)) (*StopHyperParameterTuningJobOutput, error)

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched. All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

func (*Client) StopInferenceExperiment added in v1.56.0

func (c *Client) StopInferenceExperiment(ctx context.Context, params *StopInferenceExperimentInput, optFns ...func(*Options)) (*StopInferenceExperimentOutput, error)

Stops an inference experiment.

func (*Client) StopInferenceRecommendationsJob added in v1.20.0

func (c *Client) StopInferenceRecommendationsJob(ctx context.Context, params *StopInferenceRecommendationsJobInput, optFns ...func(*Options)) (*StopInferenceRecommendationsJobOutput, error)

Stops an Inference Recommender job.

func (*Client) StopLabelingJob

func (c *Client) StopLabelingJob(ctx context.Context, params *StopLabelingJobInput, optFns ...func(*Options)) (*StopLabelingJobOutput, error)

Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

func (*Client) StopMonitoringSchedule

func (c *Client) StopMonitoringSchedule(ctx context.Context, params *StopMonitoringScheduleInput, optFns ...func(*Options)) (*StopMonitoringScheduleOutput, error)

Stops a previously started monitoring schedule.

func (*Client) StopNotebookInstance

func (c *Client) StopNotebookInstance(ctx context.Context, params *StopNotebookInstanceInput, optFns ...func(*Options)) (*StopNotebookInstanceOutput, error)

Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance . To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

func (*Client) StopPipelineExecution added in v0.31.0

func (c *Client) StopPipelineExecution(ctx context.Context, params *StopPipelineExecutionInput, optFns ...func(*Options)) (*StopPipelineExecutionOutput, error)

Stops a pipeline execution. Callback Step A pipeline execution won't stop while a callback step is running. When you call StopPipelineExecution on a pipeline execution with a running callback step, SageMaker Pipelines sends an additional Amazon SQS message to the specified SQS queue. The body of the SQS message contains a "Status" field which is set to "Stopping". You should add logic to your Amazon SQS message consumer to take any needed action (for example, resource cleanup) upon receipt of the message followed by a call to SendPipelineExecutionStepSuccess or SendPipelineExecutionStepFailure . Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution. Lambda Step A pipeline execution can't be stopped while a lambda step is running because the Lambda function invoked by the lambda step can't be stopped. If you attempt to stop the execution while the Lambda function is running, the pipeline waits for the Lambda function to finish or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function finishes, the pipeline execution status is Stopped . If the timeout is hit the pipeline execution status is Failed .

func (*Client) StopProcessingJob

func (c *Client) StopProcessingJob(ctx context.Context, params *StopProcessingJobInput, optFns ...func(*Options)) (*StopProcessingJobOutput, error)

Stops a processing job.

func (*Client) StopTrainingJob

func (c *Client) StopTrainingJob(ctx context.Context, params *StopTrainingJobInput, optFns ...func(*Options)) (*StopTrainingJobOutput, error)

Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping . After SageMaker stops the job, it sets the status to Stopped .

func (*Client) StopTransformJob

func (c *Client) StopTransformJob(ctx context.Context, params *StopTransformJobInput, optFns ...func(*Options)) (*StopTransformJobOutput, error)

Stops a batch transform job. When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping . After Amazon SageMaker stops the job, the status is set to Stopped . When you stop a batch transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

func (*Client) UpdateAction added in v0.31.0

func (c *Client) UpdateAction(ctx context.Context, params *UpdateActionInput, optFns ...func(*Options)) (*UpdateActionOutput, error)

Updates an action.

func (*Client) UpdateAppImageConfig added in v0.29.0

func (c *Client) UpdateAppImageConfig(ctx context.Context, params *UpdateAppImageConfigInput, optFns ...func(*Options)) (*UpdateAppImageConfigOutput, error)

Updates the properties of an AppImageConfig.

func (*Client) UpdateArtifact added in v0.31.0

func (c *Client) UpdateArtifact(ctx context.Context, params *UpdateArtifactInput, optFns ...func(*Options)) (*UpdateArtifactOutput, error)

Updates an artifact.

func (*Client) UpdateCluster added in v1.119.0

func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, optFns ...func(*Options)) (*UpdateClusterOutput, error)

Updates a SageMaker HyperPod cluster.

func (*Client) UpdateClusterSoftware added in v1.129.0

func (c *Client) UpdateClusterSoftware(ctx context.Context, params *UpdateClusterSoftwareInput, optFns ...func(*Options)) (*UpdateClusterSoftwareOutput, error)

Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see Update the SageMaker HyperPod platform software of a cluster (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software) .

func (*Client) UpdateCodeRepository

func (c *Client) UpdateCodeRepository(ctx context.Context, params *UpdateCodeRepositoryInput, optFns ...func(*Options)) (*UpdateCodeRepositoryOutput, error)

Updates the specified Git repository with the specified values.

func (*Client) UpdateContext added in v0.31.0

func (c *Client) UpdateContext(ctx context.Context, params *UpdateContextInput, optFns ...func(*Options)) (*UpdateContextOutput, error)

Updates a context.

func (*Client) UpdateDeviceFleet added in v0.31.0

func (c *Client) UpdateDeviceFleet(ctx context.Context, params *UpdateDeviceFleetInput, optFns ...func(*Options)) (*UpdateDeviceFleetOutput, error)

Updates a fleet of devices.

func (*Client) UpdateDevices added in v0.31.0

func (c *Client) UpdateDevices(ctx context.Context, params *UpdateDevicesInput, optFns ...func(*Options)) (*UpdateDevicesOutput, error)

Updates one or more devices in a fleet.

func (*Client) UpdateDomain

func (c *Client) UpdateDomain(ctx context.Context, params *UpdateDomainInput, optFns ...func(*Options)) (*UpdateDomainOutput, error)

Updates the default settings for new user profiles in the domain.

func (*Client) UpdateEndpoint

func (c *Client) UpdateEndpoint(ctx context.Context, params *UpdateEndpointInput, optFns ...func(*Options)) (*UpdateEndpointOutput, error)

Deploys the EndpointConfig specified in the request to a new fleet of instances. SageMaker shifts endpoint traffic to the new instances with the updated endpoint configuration and then deletes the old instances using the previous EndpointConfig (there is no availability loss). For more information about how to control the update and traffic shifting process, see Update models in production (https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails.html) . When SageMaker receives the request, it sets the endpoint status to Updating . After updating the endpoint, it sets the status to InService . To check the status of an endpoint, use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) API. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig . If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

func (*Client) UpdateEndpointWeightsAndCapacities

func (c *Client) UpdateEndpointWeightsAndCapacities(ctx context.Context, params *UpdateEndpointWeightsAndCapacitiesInput, optFns ...func(*Options)) (*UpdateEndpointWeightsAndCapacitiesOutput, error)

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating . After updating the endpoint, it sets the status to InService . To check the status of an endpoint, use the DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html) API.

func (*Client) UpdateExperiment

func (c *Client) UpdateExperiment(ctx context.Context, params *UpdateExperimentInput, optFns ...func(*Options)) (*UpdateExperimentOutput, error)

Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.

func (*Client) UpdateFeatureGroup added in v1.34.0

func (c *Client) UpdateFeatureGroup(ctx context.Context, params *UpdateFeatureGroupInput, optFns ...func(*Options)) (*UpdateFeatureGroupOutput, error)

Updates the feature group by either adding features or updating the online store configuration. Use one of the following request parameters at a time while using the UpdateFeatureGroup API. You can add features for your feature group using the FeatureAdditions request parameter. Features cannot be removed from a feature group. You can update the online store configuration by using the OnlineStoreConfig request parameter. If a TtlDuration is specified, the default TtlDuration applies for all records added to the feature group after the feature group is updated. If a record level TtlDuration exists from using the PutRecord API, the record level TtlDuration applies to that record instead of the default TtlDuration . To remove the default TtlDuration from an existing feature group, use the UpdateFeatureGroup API and set the TtlDuration Unit and Value to null .

func (*Client) UpdateFeatureMetadata added in v1.34.0

func (c *Client) UpdateFeatureMetadata(ctx context.Context, params *UpdateFeatureMetadataInput, optFns ...func(*Options)) (*UpdateFeatureMetadataOutput, error)

Updates the description and parameters of the feature group.

func (*Client) UpdateHub added in v1.56.0

func (c *Client) UpdateHub(ctx context.Context, params *UpdateHubInput, optFns ...func(*Options)) (*UpdateHubOutput, error)

Update a hub. Hub APIs are only callable through SageMaker Studio.

func (*Client) UpdateImage added in v0.29.0

func (c *Client) UpdateImage(ctx context.Context, params *UpdateImageInput, optFns ...func(*Options)) (*UpdateImageOutput, error)

Updates the properties of a SageMaker image. To change the image's tags, use the AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html) and DeleteTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteTags.html) APIs.

func (*Client) UpdateImageVersion added in v1.59.0

func (c *Client) UpdateImageVersion(ctx context.Context, params *UpdateImageVersionInput, optFns ...func(*Options)) (*UpdateImageVersionOutput, error)

Updates the properties of a SageMaker image version.

func (*Client) UpdateInferenceComponent added in v1.119.0

func (c *Client) UpdateInferenceComponent(ctx context.Context, params *UpdateInferenceComponentInput, optFns ...func(*Options)) (*UpdateInferenceComponentOutput, error)

Updates an inference component.

func (*Client) UpdateInferenceComponentRuntimeConfig added in v1.119.0

func (c *Client) UpdateInferenceComponentRuntimeConfig(ctx context.Context, params *UpdateInferenceComponentRuntimeConfigInput, optFns ...func(*Options)) (*UpdateInferenceComponentRuntimeConfigOutput, error)

Runtime settings for a model that is deployed with an inference component.

func (*Client) UpdateInferenceExperiment added in v1.56.0

func (c *Client) UpdateInferenceExperiment(ctx context.Context, params *UpdateInferenceExperimentInput, optFns ...func(*Options)) (*UpdateInferenceExperimentOutput, error)

Updates an inference experiment that you created. The status of the inference experiment has to be either Created , Running . For more information on the status of an inference experiment, see DescribeInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html) .

func (*Client) UpdateModelCard added in v1.56.0

func (c *Client) UpdateModelCard(ctx context.Context, params *UpdateModelCardInput, optFns ...func(*Options)) (*UpdateModelCardOutput, error)

Update an Amazon SageMaker Model Card. You cannot update both model card content and model card status in a single call.

func (*Client) UpdateModelPackage added in v0.31.0

func (c *Client) UpdateModelPackage(ctx context.Context, params *UpdateModelPackageInput, optFns ...func(*Options)) (*UpdateModelPackageOutput, error)

Updates a versioned model.

func (*Client) UpdateMonitoringAlert added in v1.56.0

func (c *Client) UpdateMonitoringAlert(ctx context.Context, params *UpdateMonitoringAlertInput, optFns ...func(*Options)) (*UpdateMonitoringAlertOutput, error)

Update the parameters of a model monitor alert.

func (*Client) UpdateMonitoringSchedule

func (c *Client) UpdateMonitoringSchedule(ctx context.Context, params *UpdateMonitoringScheduleInput, optFns ...func(*Options)) (*UpdateMonitoringScheduleOutput, error)

Updates a previously created schedule.

func (*Client) UpdateNotebookInstance

func (c *Client) UpdateNotebookInstance(ctx context.Context, params *UpdateNotebookInstanceInput, optFns ...func(*Options)) (*UpdateNotebookInstanceOutput, error)

Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

func (*Client) UpdateNotebookInstanceLifecycleConfig

func (c *Client) UpdateNotebookInstanceLifecycleConfig(ctx context.Context, params *UpdateNotebookInstanceLifecycleConfigInput, optFns ...func(*Options)) (*UpdateNotebookInstanceLifecycleConfigOutput, error)

Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateNotebookInstanceLifecycleConfig.html) API.

func (*Client) UpdatePipeline added in v0.31.0

func (c *Client) UpdatePipeline(ctx context.Context, params *UpdatePipelineInput, optFns ...func(*Options)) (*UpdatePipelineOutput, error)

Updates a pipeline.

func (*Client) UpdatePipelineExecution added in v0.31.0

func (c *Client) UpdatePipelineExecution(ctx context.Context, params *UpdatePipelineExecutionInput, optFns ...func(*Options)) (*UpdatePipelineExecutionOutput, error)

Updates a pipeline execution.

func (*Client) UpdateProject added in v1.18.0

func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model. You must not update a project that is in use. If you update the ServiceCatalogProvisioningUpdateDetails of a project that is active or being created, or updated, you may lose resources already created by the project.

func (*Client) UpdateSpace added in v1.56.0

func (c *Client) UpdateSpace(ctx context.Context, params *UpdateSpaceInput, optFns ...func(*Options)) (*UpdateSpaceOutput, error)

Updates the settings of a space.

func (*Client) UpdateTrainingJob added in v0.31.0

func (c *Client) UpdateTrainingJob(ctx context.Context, params *UpdateTrainingJobInput, optFns ...func(*Options)) (*UpdateTrainingJobOutput, error)

Update a model training job to request a new Debugger profiling configuration or to change warm pool retention length.

func (*Client) UpdateTrial

func (c *Client) UpdateTrial(ctx context.Context, params *UpdateTrialInput, optFns ...func(*Options)) (*UpdateTrialOutput, error)

Updates the display name of a trial.

func (*Client) UpdateTrialComponent

func (c *Client) UpdateTrialComponent(ctx context.Context, params *UpdateTrialComponentInput, optFns ...func(*Options)) (*UpdateTrialComponentOutput, error)

Updates one or more properties of a trial component.

func (*Client) UpdateUserProfile

func (c *Client) UpdateUserProfile(ctx context.Context, params *UpdateUserProfileInput, optFns ...func(*Options)) (*UpdateUserProfileOutput, error)

Updates a user profile.

func (*Client) UpdateWorkforce

func (c *Client) UpdateWorkforce(ctx context.Context, params *UpdateWorkforceInput, optFns ...func(*Options)) (*UpdateWorkforceOutput, error)

Use this operation to update your workforce. You can use this operation to require that workers use specific IP addresses to work on tasks and to update your OpenID Connect (OIDC) Identity Provider (IdP) workforce configuration. The worker portal is now supported in VPC and public internet. Use SourceIpConfig to restrict worker access to tasks to a specific range of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html) . By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied and get a Not Found error message on the worker portal. To restrict access to all the workers in public internet, add the SourceIpConfig CIDR value as "10.0.0.0/16". Amazon SageMaker does not support Source Ip restriction for worker portals in VPC. Use OidcConfig to update the configuration of a workforce created using your own OIDC IdP. You can only update your OIDC IdP configuration when there are no work teams associated with your workforce. You can delete work teams using the DeleteWorkteam (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteWorkteam.html) operation. After restricting access to a range of IP addresses or updating your OIDC IdP configuration with this operation, you can view details about your update workforce using the DescribeWorkforce (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeWorkforce.html) operation. This operation only applies to private workforces.

func (*Client) UpdateWorkteam

func (c *Client) UpdateWorkteam(ctx context.Context, params *UpdateWorkteamInput, optFns ...func(*Options)) (*UpdateWorkteamOutput, error)

Updates an existing work team with new member definitions or description.

type CreateActionInput added in v0.31.0

type CreateActionInput struct {

	// The name of the action. Must be unique to your account in an Amazon Web
	// Services Region.
	//
	// This member is required.
	ActionName *string

	// The action type.
	//
	// This member is required.
	ActionType *string

	// The source type, ID, and URI.
	//
	// This member is required.
	Source *types.ActionSource

	// The description of the action.
	Description *string

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// A list of properties to add to the action.
	Properties map[string]string

	// The status of the action.
	Status types.ActionStatus

	// A list of tags to apply to the action.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateActionOutput added in v0.31.0

type CreateActionOutput struct {

	// The Amazon Resource Name (ARN) of the action.
	ActionArn *string

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

type CreateAlgorithmInput

type CreateAlgorithmInput struct {

	// The name of the algorithm.
	//
	// This member is required.
	AlgorithmName *string

	// Specifies details about training jobs run by this algorithm, including the
	// following:
	//   - The Amazon ECR path of the container and the version digest of the
	//   algorithm.
	//   - The hyperparameters that the algorithm supports.
	//   - The instance types that the algorithm supports for training.
	//   - Whether the algorithm supports distributed training.
	//   - The metrics that the algorithm emits to Amazon CloudWatch.
	//   - Which metrics that the algorithm emits can be used as the objective metric
	//   for hyperparameter tuning jobs.
	//   - The input channels that the algorithm supports for training data. For
	//   example, an algorithm might support train , validation , and test channels.
	//
	// This member is required.
	TrainingSpecification *types.TrainingSpecification

	// A description of the algorithm.
	AlgorithmDescription *string

	// Whether to certify the algorithm so that it can be listed in Amazon Web
	// Services Marketplace.
	CertifyForMarketplace *bool

	// Specifies details about inference jobs that the algorithm runs, including the
	// following:
	//   - The Amazon ECR paths of containers that contain the inference code and
	//   model artifacts.
	//   - The instance types that the algorithm supports for transform jobs and
	//   real-time endpoints used for inference.
	//   - The input and output content formats that the algorithm supports for
	//   inference.
	InferenceSpecification *types.InferenceSpecification

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag

	// Specifies configurations for one or more training jobs and that SageMaker runs
	// to test the algorithm's training code and, optionally, one or more batch
	// transform jobs that SageMaker runs to test the algorithm's inference code.
	ValidationSpecification *types.AlgorithmValidationSpecification
	// contains filtered or unexported fields
}

type CreateAlgorithmOutput

type CreateAlgorithmOutput struct {

	// The Amazon Resource Name (ARN) of the new algorithm.
	//
	// This member is required.
	AlgorithmArn *string

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

type CreateAppImageConfigInput added in v0.29.0

type CreateAppImageConfigInput struct {

	// The name of the AppImageConfig. Must be unique to your account.
	//
	// This member is required.
	AppImageConfigName *string

	// The CodeEditorAppImageConfig . You can only specify one image kernel in the
	// AppImageConfig API. This kernel is shown to users before the image starts. After
	// the image runs, all kernels are visible in Code Editor.
	CodeEditorAppImageConfig *types.CodeEditorAppImageConfig

	// The JupyterLabAppImageConfig . You can only specify one image kernel in the
	// AppImageConfig API. This kernel is shown to users before the image starts. After
	// the image runs, all kernels are visible in JupyterLab.
	JupyterLabAppImageConfig *types.JupyterLabAppImageConfig

	// The KernelGatewayImageConfig. You can only specify one image kernel in the
	// AppImageConfig API. This kernel will be shown to users before the image starts.
	// Once the image runs, all kernels are visible in JupyterLab.
	KernelGatewayImageConfig *types.KernelGatewayImageConfig

	// A list of tags to apply to the AppImageConfig.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAppImageConfigOutput added in v0.29.0

type CreateAppImageConfigOutput struct {

	// The ARN of the AppImageConfig.
	AppImageConfigArn *string

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

type CreateAppInput

type CreateAppInput struct {

	// The name of the app.
	//
	// This member is required.
	AppName *string

	// The type of app.
	//
	// This member is required.
	AppType types.AppType

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The instance type and the Amazon Resource Name (ARN) of the SageMaker image
	// created on the instance. The value of InstanceType passed as part of the
	// ResourceSpec in the CreateApp call overrides the value passed as part of the
	// ResourceSpec configured for the user profile or the domain. If InstanceType is
	// not specified in any of those three ResourceSpec values for a KernelGateway
	// app, the CreateApp call fails with a request validation error.
	ResourceSpec *types.ResourceSpec

	// The name of the space. If this value is not set, then UserProfileName must be
	// set.
	SpaceName *string

	// Each tag consists of a key and an optional value. Tag keys must be unique per
	// resource.
	Tags []types.Tag

	// The user profile name. If this value is not set, then SpaceName must be set.
	UserProfileName *string
	// contains filtered or unexported fields
}

type CreateAppOutput

type CreateAppOutput struct {

	// The Amazon Resource Name (ARN) of the app.
	AppArn *string

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

type CreateArtifactInput added in v0.31.0

type CreateArtifactInput struct {

	// The artifact type.
	//
	// This member is required.
	ArtifactType *string

	// The ID, ID type, and URI of the source.
	//
	// This member is required.
	Source *types.ArtifactSource

	// The name of the artifact. Must be unique to your account in an Amazon Web
	// Services Region.
	ArtifactName *string

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// A list of properties to add to the artifact.
	Properties map[string]string

	// A list of tags to apply to the artifact.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateArtifactOutput added in v0.31.0

type CreateArtifactOutput struct {

	// The Amazon Resource Name (ARN) of the artifact.
	ArtifactArn *string

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

type CreateAutoMLJobInput

type CreateAutoMLJobInput struct {

	// Identifies an Autopilot job. The name must be unique to your account and is
	// case insensitive.
	//
	// This member is required.
	AutoMLJobName *string

	// An array of channel objects that describes the input data and its location.
	// Each channel is a named input source. Similar to InputDataConfig supported by
	// HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)
	// . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the
	// training dataset. There is not a minimum number of rows required for the
	// validation dataset.
	//
	// This member is required.
	InputDataConfig []types.AutoMLChannel

	// Provides information about encryption and the Amazon S3 output path needed to
	// store artifacts from an AutoML job. Format(s) supported: CSV.
	//
	// This member is required.
	OutputDataConfig *types.AutoMLOutputDataConfig

	// The ARN of the role that is used to access the data.
	//
	// This member is required.
	RoleArn *string

	// A collection of settings used to configure an AutoML job.
	AutoMLJobConfig *types.AutoMLJobConfig

	// Specifies a metric to minimize or maximize as the objective of a job. If not
	// specified, the default objective metric depends on the problem type. See
	// AutoMLJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html)
	// for the default values.
	AutoMLJobObjective *types.AutoMLJobObjective

	// Generates possible candidates without training the models. A candidate is a
	// combination of data preprocessors, algorithms, and algorithm parameter settings.
	GenerateCandidateDefinitionsOnly *bool

	// Specifies how to generate the endpoint name for an automatic one-click
	// Autopilot model deployment.
	ModelDeployConfig *types.ModelDeployConfig

	// Defines the type of supervised learning problem available for the candidates.
	// For more information, see SageMaker Autopilot problem types (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-datasets-problem-types.html#autopilot-problem-types)
	// .
	ProblemType types.ProblemType

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web ServicesResources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// . Tag keys must be unique per resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAutoMLJobOutput

type CreateAutoMLJobOutput struct {

	// The unique ARN assigned to the AutoML job when it is created.
	//
	// This member is required.
	AutoMLJobArn *string

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

type CreateAutoMLJobV2Input added in v1.72.0

type CreateAutoMLJobV2Input struct {

	// An array of channel objects describing the input data and their location. Each
	// channel is a named input source. Similar to the InputDataConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateAutoMLJob.html#sagemaker-CreateAutoMLJob-request-InputDataConfig)
	// attribute in the CreateAutoMLJob input parameters. The supported formats depend
	// on the problem type:
	//   - For tabular problem types: S3Prefix , ManifestFile .
	//   - For image classification: S3Prefix , ManifestFile , AugmentedManifestFile .
	//   - For text classification: S3Prefix .
	//   - For time-series forecasting: S3Prefix .
	//   - For text generation (LLMs fine-tuning): S3Prefix .
	//
	// This member is required.
	AutoMLJobInputDataConfig []types.AutoMLJobChannel

	// Identifies an Autopilot job. The name must be unique to your account and is
	// case insensitive.
	//
	// This member is required.
	AutoMLJobName *string

	// Defines the configuration settings of one of the supported problem types.
	//
	// This member is required.
	AutoMLProblemTypeConfig types.AutoMLProblemTypeConfig

	// Provides information about encryption and the Amazon S3 output path needed to
	// store artifacts from an AutoML job.
	//
	// This member is required.
	OutputDataConfig *types.AutoMLOutputDataConfig

	// The ARN of the role that is used to access the data.
	//
	// This member is required.
	RoleArn *string

	// Specifies a metric to minimize or maximize as the objective of a job. If not
	// specified, the default objective metric depends on the problem type. For the
	// list of default values per problem type, see AutoMLJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AutoMLJobObjective.html)
	// .
	//   - For tabular problem types: You must either provide both the
	//   AutoMLJobObjective and indicate the type of supervised learning problem in
	//   AutoMLProblemTypeConfig ( TabularJobConfig.ProblemType ), or none at all.
	//   - For text generation problem types (LLMs fine-tuning): Fine-tuning language
	//   models in Autopilot does not require setting the AutoMLJobObjective field.
	//   Autopilot fine-tunes LLMs without requiring multiple candidates to be trained
	//   and evaluated. Instead, using your dataset, Autopilot directly fine-tunes your
	//   target model to enhance a default objective metric, the cross-entropy loss.
	//   After fine-tuning a language model, you can evaluate the quality of its
	//   generated text using different metrics. For a list of the available metrics, see
	//   Metrics for fine-tuning LLMs in Autopilot (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-llms-finetuning-metrics.html)
	//   .
	AutoMLJobObjective *types.AutoMLJobObjective

	// This structure specifies how to split the data into train and validation
	// datasets. The validation and training datasets must contain the same headers.
	// For jobs created by calling CreateAutoMLJob , the validation dataset must be
	// less than 2 GB in size. This attribute must not be set for the time-series
	// forecasting problem type, as Autopilot automatically splits the input dataset
	// into training and validation sets.
	DataSplitConfig *types.AutoMLDataSplitConfig

	// Specifies how to generate the endpoint name for an automatic one-click
	// Autopilot model deployment.
	ModelDeployConfig *types.ModelDeployConfig

	// The security configuration for traffic encryption or Amazon VPC settings.
	SecurityConfig *types.AutoMLSecurityConfig

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, such as by purpose, owner, or environment.
	// For more information, see Tagging Amazon Web ServicesResources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// . Tag keys must be unique per resource.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAutoMLJobV2Output added in v1.72.0

type CreateAutoMLJobV2Output struct {

	// The unique ARN assigned to the AutoMLJob when it is created.
	//
	// This member is required.
	AutoMLJobArn *string

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

type CreateClusterInput added in v1.119.0

type CreateClusterInput struct {

	// The name for the new SageMaker HyperPod cluster.
	//
	// This member is required.
	ClusterName *string

	// The instance groups to be created in the SageMaker HyperPod cluster.
	//
	// This member is required.
	InstanceGroups []types.ClusterInstanceGroupSpecification

	// Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web
	// Services resource. You can add tags to your cluster in the same way you add them
	// in other Amazon Web Services services that support tagging. To learn more about
	// tagging Amazon Web Services resources in general, see Tagging Amazon Web
	// Services Resources User Guide (https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html)
	// .
	Tags []types.Tag

	// Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,
	// hosted models, and compute resources have access to. You can control access to
	// and from your resources by configuring a VPC. For more information, see Give
	// SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html)
	// .
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateClusterOutput added in v1.119.0

type CreateClusterOutput struct {

	// The Amazon Resource Name (ARN) of the cluster.
	//
	// This member is required.
	ClusterArn *string

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

type CreateCodeRepositoryInput

type CreateCodeRepositoryInput struct {

	// The name of the Git repository. The name must have 1 to 63 characters. Valid
	// characters are a-z, A-Z, 0-9, and - (hyphen).
	//
	// This member is required.
	CodeRepositoryName *string

	// Specifies details about the repository, including the URL where the repository
	// is located, the default branch, and credentials to use to access the repository.
	//
	// This member is required.
	GitConfig *types.GitConfig

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCodeRepositoryOutput

type CreateCodeRepositoryOutput struct {

	// The Amazon Resource Name (ARN) of the new repository.
	//
	// This member is required.
	CodeRepositoryArn *string

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

type CreateCompilationJobInput

type CreateCompilationJobInput struct {

	// A name for the model compilation job. The name must be unique within the Amazon
	// Web Services Region and within your Amazon Web Services account.
	//
	// This member is required.
	CompilationJobName *string

	// Provides information about the output location for the compiled model and the
	// target device the model runs on.
	//
	// This member is required.
	OutputConfig *types.OutputConfig

	// The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to
	// perform tasks on your behalf. During model compilation, Amazon SageMaker needs
	// your permission to:
	//   - Read input data from an S3 bucket
	//   - Write model artifacts to an S3 bucket
	//   - Write logs to Amazon CloudWatch Logs
	//   - Publish metrics to Amazon CloudWatch
	// You grant permissions for all of these tasks to an IAM role. To pass this role
	// to Amazon SageMaker, the caller of this API must have the iam:PassRole
	// permission. For more information, see Amazon SageMaker Roles. (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html)
	//
	// This member is required.
	RoleArn *string

	// Specifies a limit to how long a model compilation job can run. When the job
	// reaches the time limit, Amazon SageMaker ends the compilation job. Use this API
	// to cap model training costs.
	//
	// This member is required.
	StoppingCondition *types.StoppingCondition

	// Provides information about the location of input model artifacts, the name and
	// shape of the expected data inputs, and the framework in which the model was
	// trained.
	InputConfig *types.InputConfig

	// The Amazon Resource Name (ARN) of a versioned model package. Provide either a
	// ModelPackageVersionArn or an InputConfig object in the request syntax. The
	// presence of both objects in the CreateCompilationJob request will return an
	// exception.
	ModelPackageVersionArn *string

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag

	// A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)
	// object that specifies the VPC that you want your compilation job to connect to.
	// Control access to your models by configuring the VPC. For more information, see
	// Protect Compilation Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html)
	// .
	VpcConfig *types.NeoVpcConfig
	// contains filtered or unexported fields
}

type CreateCompilationJobOutput

type CreateCompilationJobOutput struct {

	// If the action is successful, the service sends back an HTTP 200 response.
	// Amazon SageMaker returns the following data in JSON format:
	//   - CompilationJobArn : The Amazon Resource Name (ARN) of the compiled job.
	//
	// This member is required.
	CompilationJobArn *string

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

type CreateContextInput added in v0.31.0

type CreateContextInput struct {

	// The name of the context. Must be unique to your account in an Amazon Web
	// Services Region.
	//
	// This member is required.
	ContextName *string

	// The context type.
	//
	// This member is required.
	ContextType *string

	// The source type, ID, and URI.
	//
	// This member is required.
	Source *types.ContextSource

	// The description of the context.
	Description *string

	// A list of properties to add to the context.
	Properties map[string]string

	// A list of tags to apply to the context.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateContextOutput added in v0.31.0

type CreateContextOutput struct {

	// The Amazon Resource Name (ARN) of the context.
	ContextArn *string

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

type CreateDataQualityJobDefinitionInput added in v0.31.0

type CreateDataQualityJobDefinitionInput struct {

	// Specifies the container that runs the monitoring job.
	//
	// This member is required.
	DataQualityAppSpecification *types.DataQualityAppSpecification

	// A list of inputs for the monitoring job. Currently endpoints are supported as
	// monitoring inputs.
	//
	// This member is required.
	DataQualityJobInput *types.DataQualityJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	DataQualityJobOutputConfig *types.MonitoringOutputConfig

	// The name for the monitoring job definition.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// Configures the constraints and baselines for the monitoring job.
	DataQualityBaselineConfig *types.DataQualityBaselineConfig

	// Specifies networking configuration for the monitoring job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

	// (Optional) An array of key-value pairs. For more information, see  Using Cost
	// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDataQualityJobDefinitionOutput added in v0.31.0

type CreateDataQualityJobDefinitionOutput struct {

	// The Amazon Resource Name (ARN) of the job definition.
	//
	// This member is required.
	JobDefinitionArn *string

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

type CreateDeviceFleetInput added in v0.31.0

type CreateDeviceFleetInput struct {

	// The name of the fleet that the device belongs to.
	//
	// This member is required.
	DeviceFleetName *string

	// The output configuration for storing sample data collected by the fleet.
	//
	// This member is required.
	OutputConfig *types.EdgeOutputConfig

	// A description of the fleet.
	Description *string

	// Whether to create an Amazon Web Services IoT Role Alias during device fleet
	// creation. The name of the role alias generated will match this pattern:
	// "SageMakerEdge-{DeviceFleetName}". For example, if your device fleet is called
	// "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".
	EnableIotRoleAlias *bool

	// The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet
	// of Things (IoT).
	RoleArn *string

	// Creates tags for the specified fleet.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDeviceFleetOutput added in v0.31.0

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

type CreateDomainInput

type CreateDomainInput struct {

	// The mode of authentication that members use to access the domain.
	//
	// This member is required.
	AuthMode types.AuthMode

	// The default settings to use to create a user profile when UserSettings isn't
	// specified in the call to the CreateUserProfile API. SecurityGroups is
	// aggregated when specified in both calls. For all other settings in UserSettings
	// , the values specified in CreateUserProfile take precedence over those
	// specified in CreateDomain .
	//
	// This member is required.
	DefaultUserSettings *types.UserSettings

	// A name for the domain.
	//
	// This member is required.
	DomainName *string

	// The VPC subnets that the domain uses for communication.
	//
	// This member is required.
	SubnetIds []string

	// The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for
	// communication.
	//
	// This member is required.
	VpcId *string

	// Specifies the VPC used for non-EFS traffic. The default value is
	// PublicInternetOnly .
	//   - PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon
	//   SageMaker, which allows direct internet access
	//   - VpcOnly - All traffic is through the specified VPC and subnets
	AppNetworkAccessType types.AppNetworkAccessType

	// The entity that creates and manages the required security groups for inter-app
	// communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType
	// is VPCOnly and
	// DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
	// provided. If setting up the domain for use with RStudio, this value must be set
	// to Service .
	AppSecurityGroupManagement types.AppSecurityGroupManagement

	// The default settings used to create a space.
	DefaultSpaceSettings *types.DefaultSpaceSettings

	// A collection of Domain settings.
	DomainSettings *types.DomainSettings

	// Use KmsKeyId .
	//
	// Deprecated: This property is deprecated, use KmsKeyId instead.
	HomeEfsFileSystemKmsKeyId *string

	// SageMaker uses Amazon Web Services KMS to encrypt EFS and EBS volumes attached
	// to the domain with an Amazon Web Services managed key by default. For more
	// control, specify a customer managed key.
	KmsKeyId *string

	// Tags to associated with the Domain. Each tag consists of a key and an optional
	// value. Tag keys must be unique per resource. Tags are searchable using the
	// Search API. Tags that you specify for the Domain are also added to all Apps that
	// the Domain launches.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateDomainOutput

type CreateDomainOutput struct {

	// The Amazon Resource Name (ARN) of the created domain.
	DomainArn *string

	// The URL to the created domain.
	Url *string

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

type CreateEdgeDeploymentPlanInput added in v1.37.0

type CreateEdgeDeploymentPlanInput struct {

	// The device fleet used for this edge deployment plan.
	//
	// This member is required.
	DeviceFleetName *string

	// The name of the edge deployment plan.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// List of models associated with the edge deployment plan.
	//
	// This member is required.
	ModelConfigs []types.EdgeDeploymentModelConfig

	// List of stages of the edge deployment plan. The number of stages is limited to
	// 10 per deployment.
	Stages []types.DeploymentStage

	// List of tags with which to tag the edge deployment plan.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateEdgeDeploymentPlanOutput added in v1.37.0

type CreateEdgeDeploymentPlanOutput struct {

	// The ARN of the edge deployment plan.
	//
	// This member is required.
	EdgeDeploymentPlanArn *string

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

type CreateEdgeDeploymentStageInput added in v1.37.0

type CreateEdgeDeploymentStageInput struct {

	// The name of the edge deployment plan.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// List of stages to be added to the edge deployment plan.
	//
	// This member is required.
	Stages []types.DeploymentStage
	// contains filtered or unexported fields
}

type CreateEdgeDeploymentStageOutput added in v1.37.0

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

type CreateEdgePackagingJobInput added in v0.31.0

type CreateEdgePackagingJobInput struct {

	// The name of the SageMaker Neo compilation job that will be used to locate model
	// artifacts for packaging.
	//
	// This member is required.
	CompilationJobName *string

	// The name of the edge packaging job.
	//
	// This member is required.
	EdgePackagingJobName *string

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

	// The version of the model.
	//
	// This member is required.
	ModelVersion *string

	// Provides information about the output location for the packaged model.
	//
	// This member is required.
	OutputConfig *types.EdgeOutputConfig

	// The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to
	// download and upload the model, and to contact SageMaker Neo.
	//
	// This member is required.
	RoleArn *string

	// The Amazon Web Services KMS key to use when encrypting the EBS volume the edge
	// packaging job runs on.
	ResourceKey *string

	// Creates tags for the packaging job.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateEdgePackagingJobOutput added in v0.31.0

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

type CreateEndpointConfigInput

type CreateEndpointConfigInput struct {

	// The name of the endpoint configuration. You specify this name in a
	// CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)
	// request.
	//
	// This member is required.
	EndpointConfigName *string

	// An array of ProductionVariant objects, one for each model that you want to host
	// at this endpoint.
	//
	// This member is required.
	ProductionVariants []types.ProductionVariant

	// Specifies configuration for how an endpoint performs asynchronous inference.
	// This is a required field in order for your Endpoint to be invoked using
	// InvokeEndpointAsync (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html)
	// .
	AsyncInferenceConfig *types.AsyncInferenceConfig

	// Configuration to control how SageMaker captures inference data.
	DataCaptureConfig *types.DataCaptureConfig

	// Sets whether all model containers deployed to the endpoint are isolated. If
	// they are, no inbound or outbound network calls can be made to or from the model
	// containers.
	EnableNetworkIsolation *bool

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform actions on your behalf. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html)
	// . To be able to pass this role to Amazon SageMaker, the caller of this action
	// must have the iam:PassRole permission.
	ExecutionRoleArn *string

	// A member of CreateEndpointConfig that enables explainers.
	ExplainerConfig *types.ExplainerConfig

	// The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service
	// key that SageMaker uses to encrypt data on the storage volume attached to the ML
	// compute instance that hosts the endpoint. The KmsKeyId can be any of the
	// following formats:
	//   - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
	//   - Key ARN:
	//   arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
	//   - Alias name: alias/ExampleAlias
	//   - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
	// The KMS key policy must grant permission to the IAM role that you specify in
	// your CreateEndpoint , UpdateEndpoint requests. For more information, refer to
	// the Amazon Web Services Key Management Service section Using Key Policies in
	// Amazon Web Services KMS  (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)
	// Certain Nitro-based instances include local storage, dependent on the instance
	// type. Local storage volumes are encrypted using a hardware module on the
	// instance. You can't request a KmsKeyId when using an instance type with local
	// storage. If any of the models that you specify in the ProductionVariants
	// parameter use nitro-based instances with local storage, do not specify a value
	// for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any
	// nitro-based instances with local storage, the call to CreateEndpointConfig
	// fails. For a list of instance types that support local instance storage, see
	// Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes)
	// . For more information about local instance storage encryption, see SSD
	// Instance Store Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html)
	// .
	KmsKeyId *string

	// An array of ProductionVariant objects, one for each model that you want to host
	// at this endpoint in shadow mode with production traffic replicated from the
	// model specified on ProductionVariants . If you use this field, you can only
	// specify one variant for ProductionVariants and one variant for
	// ShadowProductionVariants .
	ShadowProductionVariants []types.ProductionVariant

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag

	// Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,
	// hosted models, and compute resources have access to. You can control access to
	// and from your resources by configuring a VPC. For more information, see Give
	// SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html)
	// .
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateEndpointConfigOutput

type CreateEndpointConfigOutput struct {

	// The Amazon Resource Name (ARN) of the endpoint configuration.
	//
	// This member is required.
	EndpointConfigArn *string

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

type CreateEndpointInput

type CreateEndpointInput struct {

	// The name of an endpoint configuration. For more information, see
	// CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html)
	// .
	//
	// This member is required.
	EndpointConfigName *string

	// The name of the endpoint.The name must be unique within an Amazon Web Services
	// Region in your Amazon Web Services account. The name is case-insensitive in
	// CreateEndpoint , but the case is preserved and must be matched in InvokeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html)
	// .
	//
	// This member is required.
	EndpointName *string

	// The deployment configuration for an endpoint, which contains the desired
	// deployment strategy and rollback configurations.
	DeploymentConfig *types.DeploymentConfig

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateEndpointOutput

type CreateEndpointOutput struct {

	// The Amazon Resource Name (ARN) of the endpoint.
	//
	// This member is required.
	EndpointArn *string

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

type CreateExperimentInput

type CreateExperimentInput struct {

	// The name of the experiment. The name must be unique in your Amazon Web Services
	// account and is not case-sensitive.
	//
	// This member is required.
	ExperimentName *string

	// The description of the experiment.
	Description *string

	// The name of the experiment as displayed. The name doesn't need to be unique. If
	// you don't specify DisplayName , the value in ExperimentName is displayed.
	DisplayName *string

	// A list of tags to associate with the experiment. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html)
	// API to search on the tags.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateExperimentOutput

type CreateExperimentOutput struct {

	// The Amazon Resource Name (ARN) of the experiment.
	ExperimentArn *string

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

type CreateFeatureGroupInput added in v0.31.0

type CreateFeatureGroupInput struct {

	// The name of the feature that stores the EventTime of a Record in a FeatureGroup
	// . An EventTime is a point in time when a new event occurs that corresponds to
	// the creation or update of a Record in a FeatureGroup . All Records in the
	// FeatureGroup must have a corresponding EventTime . An EventTime can be a String
	// or Fractional .
	//   - Fractional : EventTime feature values must be a Unix timestamp in seconds.
	//   - String : EventTime feature values must be an ISO-8601 string in the format.
	//   The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and
	//   yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy , MM , and dd represent the year, month,
	//   and day respectively and HH , mm , ss , and if applicable, SSS represent the
	//   hour, month, second and milliseconds respsectively. 'T' and Z are constants.
	//
	// This member is required.
	EventTimeFeatureName *string

	// A list of Feature names and types. Name and Type is compulsory per Feature .
	// Valid feature FeatureType s are Integral , Fractional and String . FeatureName s
	// cannot be any of the following: is_deleted , write_time , api_invocation_time
	// You can create up to 2,500 FeatureDefinition s per FeatureGroup .
	//
	// This member is required.
	FeatureDefinitions []types.FeatureDefinition

	// The name of the FeatureGroup . The name must be unique within an Amazon Web
	// Services Region in an Amazon Web Services account. The name:
	//   - Must start with an alphanumeric character.
	//   - Can only include alphanumeric characters, underscores, and hyphens. Spaces
	//   are not allowed.
	//
	// This member is required.
	FeatureGroupName *string

	// The name of the Feature whose value uniquely identifies a Record defined in the
	// FeatureStore . Only the latest record per identifier value will be stored in the
	// OnlineStore . RecordIdentifierFeatureName must be one of feature definitions'
	// names. You use the RecordIdentifierFeatureName to access data in a FeatureStore
	// . This name:
	//   - Must start with an alphanumeric character.
	//   - Can only contains alphanumeric characters, hyphens, underscores. Spaces are
	//   not allowed.
	//
	// This member is required.
	RecordIdentifierFeatureName *string

	// A free-form description of a FeatureGroup .
	Description *string

	// Use this to configure an OfflineFeatureStore . This parameter allows you to
	// specify:
	//   - The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore .
	//   - A configuration for an Amazon Web Services Glue or Amazon Web Services Hive
	//   data catalog.
	//   - An KMS encryption key to encrypt the Amazon S3 location used for
	//   OfflineStore . If KMS encryption key is not specified, by default we encrypt
	//   all data at rest using Amazon Web Services KMS key. By defining your
	//   bucket-level key (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html)
	//   for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99
	//   percent.
	//   - Format for the offline store table. Supported formats are Glue (Default)
	//   and Apache Iceberg (https://iceberg.apache.org/) .
	// To learn more about this parameter, see OfflineStoreConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html)
	// .
	OfflineStoreConfig *types.OfflineStoreConfig

	// You can turn the OnlineStore on or off by specifying True for the
	// EnableOnlineStore flag in OnlineStoreConfig . You can also include an Amazon Web
	// Services KMS key ID ( KMSKeyId ) for at-rest encryption of the OnlineStore . The
	// default value is False .
	OnlineStoreConfig *types.OnlineStoreConfig

	// The Amazon Resource Name (ARN) of the IAM execution role used to persist data
	// into the OfflineStore if an OfflineStoreConfig is provided.
	RoleArn *string

	// Tags used to identify Features in each FeatureGroup .
	Tags []types.Tag

	// Used to set feature group throughput configuration. There are two modes:
	// ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads
	// and writes that your application performs on your feature group. You do not need
	// to specify read and write throughput because Feature Store accommodates your
	// workloads as they ramp up and down. You can switch a feature group to on-demand
	// only once in a 24 hour period. With provisioned throughput mode, you specify the
	// read and write capacity per second that you expect your application to require,
	// and you are billed based on those limits. Exceeding provisioned throughput will
	// result in your requests being throttled. Note: PROVISIONED throughput mode is
	// supported only for feature groups that are offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType)
	// tier online store.
	ThroughputConfig *types.ThroughputConfig
	// contains filtered or unexported fields
}

type CreateFeatureGroupOutput added in v0.31.0

type CreateFeatureGroupOutput struct {

	// The Amazon Resource Name (ARN) of the FeatureGroup . This is a unique identifier
	// for the feature group.
	//
	// This member is required.
	FeatureGroupArn *string

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

type CreateFlowDefinitionInput

type CreateFlowDefinitionInput struct {

	// The name of your flow definition.
	//
	// This member is required.
	FlowDefinitionName *string

	// An object containing information about where the human review results will be
	// uploaded.
	//
	// This member is required.
	OutputConfig *types.FlowDefinitionOutputConfig

	// The Amazon Resource Name (ARN) of the role needed to call other services on
	// your behalf. For example,
	// arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298
	// .
	//
	// This member is required.
	RoleArn *string

	// An object containing information about the events that trigger a human workflow.
	HumanLoopActivationConfig *types.HumanLoopActivationConfig

	// An object containing information about the tasks the human reviewers will
	// perform.
	HumanLoopConfig *types.HumanLoopConfig

	// Container for configuring the source of human task requests. Use to specify if
	// Amazon Rekognition or Amazon Textract is used as an integration source.
	HumanLoopRequestSource *types.HumanLoopRequestSource

	// An array of key-value pairs that contain metadata to help you categorize and
	// organize a flow definition. Each tag consists of a key and a value, both of
	// which you define.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateFlowDefinitionOutput

type CreateFlowDefinitionOutput struct {

	// The Amazon Resource Name (ARN) of the flow definition you create.
	//
	// This member is required.
	FlowDefinitionArn *string

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

type CreateHubInput added in v1.56.0

type CreateHubInput struct {

	// A description of the hub.
	//
	// This member is required.
	HubDescription *string

	// The name of the hub to create.
	//
	// This member is required.
	HubName *string

	// The display name of the hub.
	HubDisplayName *string

	// The searchable keywords for the hub.
	HubSearchKeywords []string

	// The Amazon S3 storage configuration for the hub.
	S3StorageConfig *types.HubS3StorageConfig

	// Any tags to associate with the hub.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateHubOutput added in v1.56.0

type CreateHubOutput struct {

	// The Amazon Resource Name (ARN) of the hub.
	//
	// This member is required.
	HubArn *string

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

type CreateHumanTaskUiInput

type CreateHumanTaskUiInput struct {

	// The name of the user interface you are creating.
	//
	// This member is required.
	HumanTaskUiName *string

	// The Liquid template for the worker user interface.
	//
	// This member is required.
	UiTemplate *types.UiTemplate

	// An array of key-value pairs that contain metadata to help you categorize and
	// organize a human review workflow user interface. Each tag consists of a key and
	// a value, both of which you define.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateHumanTaskUiOutput

type CreateHumanTaskUiOutput struct {

	// The Amazon Resource Name (ARN) of the human review workflow user interface you
	// create.
	//
	// This member is required.
	HumanTaskUiArn *string

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

type CreateHyperParameterTuningJobInput

type CreateHyperParameterTuningJobInput struct {

	// The HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html)
	// object that describes the tuning job, including the search strategy, the
	// objective metric used to evaluate training jobs, ranges of parameters to search,
	// and resource limits for the tuning job. For more information, see How
	// Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html)
	// .
	//
	// This member is required.
	HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig

	// The name of the tuning job. This name is the prefix for the names of all
	// training jobs that this tuning job launches. The name must be unique within the
	// same Amazon Web Services account and Amazon Web Services Region. The name must
	// have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % -
	// (hyphen). The name is not case sensitive.
	//
	// This member is required.
	HyperParameterTuningJobName *string

	// Configures SageMaker Automatic model tuning (AMT) to automatically find optimal
	// parameters for the following fields:
	//   - ParameterRanges (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges)
	//   : The names and ranges of parameters that a hyperparameter tuning job can
	//   optimize.
	//   - ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html)
	//   : The maximum resources that can be used for a training job. These resources
	//   include the maximum number of training jobs, the maximum runtime of a tuning
	//   job, and the maximum number of training jobs to run at the same time.
	//   - TrainingJobEarlyStoppingType (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType)
	//   : A flag that specifies whether or not to use early stopping for training jobs
	//   launched by a hyperparameter tuning job.
	//   - RetryStrategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy)
	//   : The number of times to retry a training job.
	//   - Strategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html)
	//   : Specifies how hyperparameter tuning chooses the combinations of hyperparameter
	//   values to use for the training jobs that it launches.
	//   - ConvergenceDetected (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html)
	//   : A flag to indicate that Automatic model tuning (AMT) has detected model
	//   convergence.
	Autotune *types.Autotune

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// . Tags that you specify for the tuning job are also added to all training jobs
	// that the tuning job launches.
	Tags []types.Tag

	// The HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)
	// object that describes the training jobs that this tuning job launches, including
	// static hyperparameters, input data configuration, output data configuration,
	// resource configuration, and stopping condition.
	TrainingJobDefinition *types.HyperParameterTrainingJobDefinition

	// A list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)
	// objects launched for this tuning job.
	TrainingJobDefinitions []types.HyperParameterTrainingJobDefinition

	// Specifies the configuration for starting the hyperparameter tuning job using
	// one or more previous tuning jobs as a starting point. The results of previous
	// tuning jobs are used to inform which combinations of hyperparameters to search
	// over in the new tuning job. All training jobs launched by the new hyperparameter
	// tuning job are evaluated by using the objective metric. If you specify
	// IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start
	// configuration, the training job that performs the best in the new tuning job is
	// compared to the best training jobs from the parent tuning jobs. From these, the
	// training job that performs the best as measured by the objective metric is
	// returned as the overall best training job. All training jobs launched by parent
	// hyperparameter tuning jobs and the new hyperparameter tuning jobs count against
	// the limit of training jobs for the tuning job.
	WarmStartConfig *types.HyperParameterTuningJobWarmStartConfig
	// contains filtered or unexported fields
}

type CreateHyperParameterTuningJobOutput

type CreateHyperParameterTuningJobOutput struct {

	// The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a
	// hyperparameter tuning job when you create it.
	//
	// This member is required.
	HyperParameterTuningJobArn *string

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

type CreateImageInput added in v0.29.0

type CreateImageInput struct {

	// The name of the image. Must be unique to your account.
	//
	// This member is required.
	ImageName *string

	// The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your
	// behalf.
	//
	// This member is required.
	RoleArn *string

	// The description of the image.
	Description *string

	// The display name of the image. If not provided, ImageName is displayed.
	DisplayName *string

	// A list of tags to apply to the image.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateImageOutput added in v0.29.0

type CreateImageOutput struct {

	// The ARN of the image.
	ImageArn *string

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

type CreateImageVersionInput added in v0.29.0

type CreateImageVersionInput struct {

	// The registry path of the container image to use as the starting point for this
	// version. The path is an Amazon ECR URI in the following format:
	// .dkr.ecr..amazonaws.com/
	//
	// This member is required.
	BaseImage *string

	// A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web
	// Services SDKs, such as the SDK for Python (Boto3), add a unique value to the
	// call.
	//
	// This member is required.
	ClientToken *string

	// The ImageName of the Image to create a version of.
	//
	// This member is required.
	ImageName *string

	// A list of aliases created with the image version.
	Aliases []string

	// Indicates Horovod compatibility.
	Horovod *bool

	// Indicates SageMaker job type compatibility.
	//   - TRAINING : The image version is compatible with SageMaker training jobs.
	//   - INFERENCE : The image version is compatible with SageMaker inference jobs.
	//   - NOTEBOOK_KERNEL : The image version is compatible with SageMaker notebook
	//   kernels.
	JobType types.JobType

	// The machine learning framework vended in the image version.
	MLFramework *string

	// Indicates CPU or GPU compatibility.
	//   - CPU : The image version is compatible with CPU.
	//   - GPU : The image version is compatible with GPU.
	Processor types.Processor

	// The supported programming language and its version.
	ProgrammingLang *string

	// The maintainer description of the image version.
	ReleaseNotes *string

	// The stability of the image version, specified by the maintainer.
	//   - NOT_PROVIDED : The maintainers did not provide a status for image version
	//   stability.
	//   - STABLE : The image version is stable.
	//   - TO_BE_ARCHIVED : The image version is set to be archived. Custom image
	//   versions that are set to be archived are automatically archived after three
	//   months.
	//   - ARCHIVED : The image version is archived. Archived image versions are not
	//   searchable and are no longer actively supported.
	VendorGuidance types.VendorGuidance
	// contains filtered or unexported fields
}

type CreateImageVersionOutput added in v0.29.0

type CreateImageVersionOutput struct {

	// The ARN of the image version.
	ImageVersionArn *string

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

type CreateInferenceComponentInput added in v1.119.0

type CreateInferenceComponentInput struct {

	// The name of an existing endpoint where you host the inference component.
	//
	// This member is required.
	EndpointName *string

	// A unique name to assign to the inference component.
	//
	// This member is required.
	InferenceComponentName *string

	// Runtime settings for a model that is deployed with an inference component.
	//
	// This member is required.
	RuntimeConfig *types.InferenceComponentRuntimeConfig

	// Details about the resources to deploy with this inference component, including
	// the model, container, and compute resources.
	//
	// This member is required.
	Specification *types.InferenceComponentSpecification

	// The name of an existing production variant where you host the inference
	// component.
	//
	// This member is required.
	VariantName *string

	// A list of key-value pairs associated with the model. For more information, see
	// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateInferenceComponentOutput added in v1.119.0

type CreateInferenceComponentOutput struct {

	// The Amazon Resource Name (ARN) of the inference component.
	//
	// This member is required.
	InferenceComponentArn *string

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

type CreateInferenceExperimentInput added in v1.56.0

type CreateInferenceExperimentInput struct {

	// The name of the Amazon SageMaker endpoint on which you want to run the
	// inference experiment.
	//
	// This member is required.
	EndpointName *string

	// An array of ModelVariantConfig objects. There is one for each variant in the
	// inference experiment. Each ModelVariantConfig object in the array describes the
	// infrastructure configuration for the corresponding variant.
	//
	// This member is required.
	ModelVariants []types.ModelVariantConfig

	// The name for the inference experiment.
	//
	// This member is required.
	Name *string

	// The ARN of the IAM role that Amazon SageMaker can assume to access model
	// artifacts and container images, and manage Amazon SageMaker Inference endpoints
	// for model deployment.
	//
	// This member is required.
	RoleArn *string

	// The configuration of ShadowMode inference experiment type. Use this field to
	// specify a production variant which takes all the inference requests, and a
	// shadow variant to which Amazon SageMaker replicates a percentage of the
	// inference requests. For the shadow variant also specify the percentage of
	// requests that Amazon SageMaker replicates.
	//
	// This member is required.
	ShadowModeConfig *types.ShadowModeConfig

	// The type of the inference experiment that you want to run. The following types
	// of experiments are possible:
	//   - ShadowMode : You can use this type to validate a shadow variant. For more
	//   information, see Shadow tests (https://docs.aws.amazon.com/sagemaker/latest/dg/shadow-tests.html)
	//   .
	//
	// This member is required.
	Type types.InferenceExperimentType

	// The Amazon S3 location and configuration for storing inference request and
	// response data. This is an optional parameter that you can use for data capture.
	// For more information, see Capture data (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html)
	// .
	DataStorageConfig *types.InferenceExperimentDataStorageConfig

	// A description for the inference experiment.
	Description *string

	// The Amazon Web Services Key Management Service (Amazon Web Services KMS) key
	// that Amazon SageMaker uses to encrypt data on the storage volume attached to the
	// ML compute instance that hosts the endpoint. The KmsKey can be any of the
	// following formats:
	//   - KMS key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
	//   - Amazon Resource Name (ARN) of a KMS key
	//   "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
	//   - KMS key Alias "alias/ExampleAlias"
	//   - Amazon Resource Name (ARN) of a KMS key Alias
	//   "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
	// If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker
	// execution role must include permissions to call kms:Encrypt . If you don't
	// provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3
	// for your role's account. Amazon SageMaker uses server-side encryption with KMS
	// managed keys for OutputDataConfig . If you use a bucket policy with an
	// s3:PutObject permission that only allows objects with server-side encryption,
	// set the condition key of s3:x-amz-server-side-encryption to "aws:kms" . For more
	// information, see KMS managed Encryption Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html)
	// in the Amazon Simple Storage Service Developer Guide. The KMS key policy must
	// grant permission to the IAM role that you specify in your CreateEndpoint and
	// UpdateEndpoint requests. For more information, see Using Key Policies in Amazon
	// Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)
	// in the Amazon Web Services Key Management Service Developer Guide.
	KmsKey *string

	// The duration for which you want the inference experiment to run. If you don't
	// specify this field, the experiment automatically starts immediately upon
	// creation and concludes after 7 days.
	Schedule *types.InferenceExperimentSchedule

	// Array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging your Amazon Web Services
	// Resources (https://docs.aws.amazon.com/ARG/latest/userguide/tagging.html) .
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateInferenceExperimentOutput added in v1.56.0

type CreateInferenceExperimentOutput struct {

	// The ARN for your inference experiment.
	//
	// This member is required.
	InferenceExperimentArn *string

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

type CreateInferenceRecommendationsJobInput added in v1.20.0

type CreateInferenceRecommendationsJobInput struct {

	// Provides information about the versioned model package Amazon Resource Name
	// (ARN), the traffic pattern, and endpoint configurations.
	//
	// This member is required.
	InputConfig *types.RecommendationJobInputConfig

	// A name for the recommendation job. The name must be unique within the Amazon
	// Web Services Region and within your Amazon Web Services account. The job name is
	// passed down to the resources created by the recommendation job. The names of
	// resources (such as the model, endpoint configuration, endpoint, and compilation)
	// that are prefixed with the job name are truncated at 40 characters.
	//
	// This member is required.
	JobName *string

	// Defines the type of recommendation job. Specify Default to initiate an instance
	// recommendation and Advanced to initiate a load test. If left unspecified,
	// Amazon SageMaker Inference Recommender will run an instance recommendation (
	// DEFAULT ) job.
	//
	// This member is required.
	JobType types.RecommendationJobType

	// The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to
	// perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// Description of the recommendation job.
	JobDescription *string

	// Provides information about the output artifacts and the KMS key to use for
	// Amazon S3 server-side encryption.
	OutputConfig *types.RecommendationJobOutputConfig

	// A set of conditions for stopping a recommendation job. If any of the conditions
	// are met, the job is automatically stopped.
	StoppingConditions *types.RecommendationJobStoppingConditions

	// The metadata that you apply to Amazon Web Services resources to help you
	// categorize and organize them. Each tag consists of a key and a value, both of
	// which you define. For more information, see Tagging Amazon Web Services
	// Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in
	// the Amazon Web Services General Reference.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateInferenceRecommendationsJobOutput added in v1.20.0

type CreateInferenceRecommendationsJobOutput struct {

	// The Amazon Resource Name (ARN) of the recommendation job.
	//
	// This member is required.
	JobArn *string

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

type CreateLabelingJobInput

type CreateLabelingJobInput struct {

	// Configures the labeling task and how it is presented to workers; including, but
	// not limited to price, keywords, and batch size (task count).
	//
	// This member is required.
	HumanTaskConfig *types.HumanTaskConfig

	// Input data for the labeling job, such as the Amazon S3 location of the data
	// objects and the location of the manifest file that describes the data objects.
	// You must specify at least one of the following: S3DataSource or SnsDataSource .
	//   - Use SnsDataSource to specify an SNS input topic for a streaming labeling
	//   job. If you do not specify and SNS input topic ARN, Ground Truth will create a
	//   one-time labeling job that stops after all data objects in the input manifest
	//   file have been labeled.
	//   - Use S3DataSource to specify an input manifest file for both streaming and
	//   one-time labeling jobs. Adding an S3DataSource is optional if you use
	//   SnsDataSource to create a streaming labeling job.
	// If you use the Amazon Mechanical Turk workforce, your input data should not
	// include confidential information, personal information or protected health
	// information. Use ContentClassifiers to specify that your data is free of
	// personally identifiable information and adult content.
	//
	// This member is required.
	InputConfig *types.LabelingJobInputConfig

	// The attribute name to use for the label in the output manifest file. This is
	// the key for the key/value pair formed with the label that a worker assigns to
	// the object. The LabelAttributeName must meet the following requirements.
	//   - The name can't end with "-metadata".
	//   - If you are using one of the following built-in task types (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html)
	//   , the attribute name must end with "-ref". If the task type you are using is not
	//   listed below, the attribute name must not end with "-ref".
	//   - Image semantic segmentation ( SemanticSegmentation) , and adjustment (
	//   AdjustmentSemanticSegmentation ) and verification (
	//   VerificationSemanticSegmentation ) labeling jobs for this task type.
	//   - Video frame object detection ( VideoObjectDetection ), and adjustment and
	//   verification ( AdjustmentVideoObjectDetection ) labeling jobs for this task
	//   type.
	//   - Video frame object tracking ( VideoObjectTracking ), and adjustment and
	//   verification ( AdjustmentVideoObjectTracking ) labeling jobs for this task
	//   type.
	//   - 3D point cloud semantic segmentation ( 3DPointCloudSemanticSegmentation ),
	//   and adjustment and verification ( Adjustment3DPointCloudSemanticSegmentation )
	//   labeling jobs for this task type.
	//   - 3D point cloud object tracking ( 3DPointCloudObjectTracking ), and
	//   adjustment and verification ( Adjustment3DPointCloudObjectTracking ) labeling
	//   jobs for this task type.
	// If you are creating an adjustment or verification labeling job, you must use a
	// different LabelAttributeName than the one used in the original labeling job.
	// The original labeling job is the Ground Truth labeling job that produced the
	// labels that you want verified or adjusted. To learn more about adjustment and
	// verification labeling jobs, see Verify and Adjust Labels (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-verification-data.html)
	// .
	//
	// This member is required.
	LabelAttributeName *string

	// The name of the labeling job. This name is used to identify the job in a list
	// of labeling jobs. Labeling job names must be unique within an Amazon Web
	// Services account and region. LabelingJobName is not case sensitive. For
	// example, Example-job and example-job are considered the same labeling job name
	// by Ground Truth.
	//
	// This member is required.
	LabelingJobName *string

	// The location of the output data and the Amazon Web Services Key Management
	// Service key ID for the key used to encrypt the output data, if any.
	//
	// This member is required.
	OutputConfig *types.LabelingJobOutputConfig

	// The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks
	// on your behalf during data labeling. You must grant this role the necessary
	// permissions so that Amazon SageMaker can successfully complete data labeling.
	//
	// This member is required.
	RoleArn *string

	// The S3 URI of the file, referred to as a label category configuration file,
	// that defines the categories used to label the data objects. For 3D point cloud
	// and video frame task types, you can add label category attributes and frame
	// attributes to your label category configuration file. To learn how, see Create
	// a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-point-cloud-label-category-config.html)
	// . For named entity recognition jobs, in addition to "labels" , you must provide
	// worker instructions in the label category configuration file using the
	// "instructions" parameter: "instructions": {"shortInstruction":"
	// Add header
	//
	//     Add Instructions
	// ", "fullInstruction":"Add additional instructions."} . For details and an
	// example, see Create a Named Entity Recognition Labeling Job (API)  (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-named-entity-recg.html#sms-creating-ner-api)
	// . For all other built-in task types (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-task-types.html)
	// and custom tasks (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-custom-templates.html)
	// , your label category configuration file must be a JSON file in the following
	// format. Identify the labels you want to use by replacing label_1 , label_2 , ...
	// , label_n with your label categories. {
	//     "document-version": "2018-11-28",
	//
	//     "labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]
	// } Note the following about the label category configuration file:
	//   - For image classification and text classification (single and multi-label)
	//   you must specify at least two label categories. For all other task types, the
	//   minimum number of label categories required is one.
	//   - Each label category must be unique, you cannot specify duplicate label
	//   categories.
	//   - If you create a 3D point cloud or video frame adjustment or verification
	//   labeling job, you must include auditLabelAttributeName in the label category
	//   configuration. Use this parameter to enter the LabelAttributeName (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateLabelingJob.html#sagemaker-CreateLabelingJob-request-LabelAttributeName)
	//   of the labeling job you want to adjust or verify annotations of.
	LabelCategoryConfigS3Uri *string

	// Configures the information required to perform automated data labeling.
	LabelingJobAlgorithmsConfig *types.LabelingJobAlgorithmsConfig

	// A set of conditions for stopping the labeling job. If any of the conditions are
	// met, the job is automatically stopped. You can use these conditions to control
	// the cost of data labeling.
	StoppingConditions *types.LabelingJobStoppingConditions

	// An array of key/value pairs. For more information, see Using Cost Allocation
	// Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateLabelingJobOutput

type CreateLabelingJobOutput struct {

	// The Amazon Resource Name (ARN) of the labeling job. You use this ARN to
	// identify the labeling job.
	//
	// This member is required.
	LabelingJobArn *string

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

type CreateModelBiasJobDefinitionInput added in v0.31.0

type CreateModelBiasJobDefinitionInput struct {

	// The name of the bias job definition. The name must be unique within an Amazon
	// Web Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// Configures the model bias job to run a specified Docker container image.
	//
	// This member is required.
	ModelBiasAppSpecification *types.ModelBiasAppSpecification

	// Inputs for the model bias job.
	//
	// This member is required.
	ModelBiasJobInput *types.ModelBiasJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	ModelBiasJobOutputConfig *types.MonitoringOutputConfig

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The baseline configuration for a model bias job.
	ModelBiasBaselineConfig *types.ModelBiasBaselineConfig

	// Networking options for a model bias job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

	// (Optional) An array of key-value pairs. For more information, see  Using Cost
	// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateModelBiasJobDefinitionOutput added in v0.31.0

type CreateModelBiasJobDefinitionOutput struct {

	// The Amazon Resource Name (ARN) of the model bias job.
	//
	// This member is required.
	JobDefinitionArn *string

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

type CreateModelCardExportJobInput added in v1.56.0

type CreateModelCardExportJobInput struct {

	// The name of the model card export job.
	//
	// This member is required.
	ModelCardExportJobName *string

	// The name or Amazon Resource Name (ARN) of the model card to export.
	//
	// This member is required.
	ModelCardName *string

	// The model card output configuration that specifies the Amazon S3 path for
	// exporting.
	//
	// This member is required.
	OutputConfig *types.ModelCardExportOutputConfig

	// The version of the model card to export. If a version is not provided, then the
	// latest version of the model card is exported.
	ModelCardVersion *int32
	// contains filtered or unexported fields
}

type CreateModelCardExportJobOutput added in v1.56.0

type CreateModelCardExportJobOutput struct {

	// The Amazon Resource Name (ARN) of the model card export job.
	//
	// This member is required.
	ModelCardExportJobArn *string

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

type CreateModelCardInput added in v1.56.0

type CreateModelCardInput struct {

	// The content of the model card. Content must be in model card JSON schema (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema)
	// and provided as a string.
	//
	// This member is required.
	Content *string

	// The unique name of the model card.
	//
	// This member is required.
	ModelCardName *string

	// The approval status of the model card within your organization. Different
	// organizations might have different criteria for model card review and approval.
	//   - Draft : The model card is a work in progress.
	//   - PendingReview : The model card is pending review.
	//   - Approved : The model card is approved.
	//   - Archived : The model card is archived. No more updates should be made to the
	//   model card, but it can still be exported.
	//
	// This member is required.
	ModelCardStatus types.ModelCardStatus

	// An optional Key Management Service key to encrypt, decrypt, and re-encrypt
	// model card content for regulated workloads with highly sensitive data.
	SecurityConfig *types.ModelCardSecurityConfig

	// Key-value pairs used to manage metadata for model cards.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateModelCardOutput added in v1.56.0

type CreateModelCardOutput struct {

	// The Amazon Resource Name (ARN) of the successfully created model card.
	//
	// This member is required.
	ModelCardArn *string

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

type CreateModelExplainabilityJobDefinitionInput added in v0.31.0

type CreateModelExplainabilityJobDefinitionInput struct {

	// The name of the model explainability job definition. The name must be unique
	// within an Amazon Web Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// Configures the model explainability job to run a specified Docker container
	// image.
	//
	// This member is required.
	ModelExplainabilityAppSpecification *types.ModelExplainabilityAppSpecification

	// Inputs for the model explainability job.
	//
	// This member is required.
	ModelExplainabilityJobInput *types.ModelExplainabilityJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	ModelExplainabilityJobOutputConfig *types.MonitoringOutputConfig

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The baseline configuration for a model explainability job.
	ModelExplainabilityBaselineConfig *types.ModelExplainabilityBaselineConfig

	// Networking options for a model explainability job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

	// (Optional) An array of key-value pairs. For more information, see  Using Cost
	// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateModelExplainabilityJobDefinitionOutput added in v0.31.0

type CreateModelExplainabilityJobDefinitionOutput struct {

	// The Amazon Resource Name (ARN) of the model explainability job.
	//
	// This member is required.
	JobDefinitionArn *string

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

type CreateModelInput

type CreateModelInput struct {

	// The name of the new model.
	//
	// This member is required.
	ModelName *string

	// Specifies the containers in the inference pipeline.
	Containers []types.ContainerDefinition

	// Isolates the model container. No inbound or outbound network calls can be made
	// to or from the model container.
	EnableNetworkIsolation *bool

	// The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to
	// access model artifacts and docker image for deployment on ML compute instances
	// or for batch transform jobs. Deploying on ML compute instances is part of model
	// hosting. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html)
	// . To be able to pass this role to SageMaker, the caller of this API must have
	// the iam:PassRole permission.
	ExecutionRoleArn *string

	// Specifies details of how containers in a multi-container endpoint are called.
	InferenceExecutionConfig *types.InferenceExecutionConfig

	// The location of the primary docker image containing inference code, associated
	// artifacts, and custom environment map that the inference code uses when the
	// model is deployed for predictions.
	PrimaryContainer *types.ContainerDefinition

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag

	// A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)
	// object that specifies the VPC that you want your model to connect to. Control
	// access to and from your model container by configuring the VPC. VpcConfig is
	// used in hosting services and in batch transform. For more information, see
	// Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html)
	// and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private
	// Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html) .
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateModelOutput

type CreateModelOutput struct {

	// The ARN of the model created in SageMaker.
	//
	// This member is required.
	ModelArn *string

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

type CreateModelPackageGroupInput added in v0.31.0

type CreateModelPackageGroupInput struct {

	// The name of the model group.
	//
	// This member is required.
	ModelPackageGroupName *string

	// A description for the model group.
	ModelPackageGroupDescription *string

	// A list of key value pairs associated with the model group. For more
	// information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateModelPackageGroupOutput added in v0.31.0

type CreateModelPackageGroupOutput struct {

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

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

type CreateModelPackageInput

type CreateModelPackageInput struct {

	// An array of additional Inference Specification objects. Each additional
	// Inference Specification specifies artifacts based on this model package that can
	// be used on inference endpoints. Generally used with SageMaker Neo to store the
	// compiled artifacts.
	AdditionalInferenceSpecifications []types.AdditionalInferenceSpecificationDefinition

	// Whether to certify the model package for listing on Amazon Web Services
	// Marketplace. This parameter is optional for unversioned models, and does not
	// apply to versioned models.
	CertifyForMarketplace *bool

	// A unique token that guarantees that the call to this API is idempotent.
	ClientToken *string

	// The metadata properties associated with the model package versions.
	CustomerMetadataProperties map[string]string

	// The machine learning domain of your model package and its components. Common
	// machine learning domains include computer vision and natural language
	// processing.
	Domain *string

	// Represents the drift check baselines that can be used when the model monitor is
	// set using the model package. For more information, see the topic on Drift
	// Detection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection)
	// in the Amazon SageMaker Developer Guide.
	DriftCheckBaselines *types.DriftCheckBaselines

	// Specifies details about inference jobs that you can run with models based on
	// this model package, including the following information:
	//   - The Amazon ECR paths of containers that contain the inference code and
	//   model artifacts.
	//   - The instance types that the model package supports for transform jobs and
	//   real-time endpoints used for inference.
	//   - The input and output content formats that the model package supports for
	//   inference.
	InferenceSpecification *types.InferenceSpecification

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// Whether the model is approved for deployment. This parameter is optional for
	// versioned models, and does not apply to unversioned models. For versioned
	// models, the value of this parameter must be set to Approved to deploy the model.
	ModelApprovalStatus types.ModelApprovalStatus

	// A structure that contains model metrics reports.
	ModelMetrics *types.ModelMetrics

	// A description of the model package.
	ModelPackageDescription *string

	// The name or Amazon Resource Name (ARN) of the model package group that this
	// model version belongs to. This parameter is required for versioned models, and
	// does not apply to unversioned models.
	ModelPackageGroupName *string

	// The name of the model package. The name must have 1 to 63 characters. Valid
	// characters are a-z, A-Z, 0-9, and - (hyphen). This parameter is required for
	// unversioned models. It is not applicable to versioned models.
	ModelPackageName *string

	// The Amazon Simple Storage Service (Amazon S3) path where the sample payload is
	// stored. This path must point to a single gzip compressed tar archive (.tar.gz
	// suffix). This archive can hold multiple files that are all equally used in the
	// load test. Each file in the archive must satisfy the size constraints of the
	// InvokeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax)
	// call.
	SamplePayloadUrl *string

	// Indicates if you want to skip model validation.
	SkipModelValidation types.SkipModelValidation

	// Details about the algorithm that was used to create the model package.
	SourceAlgorithmSpecification *types.SourceAlgorithmSpecification

	// The URI of the source for the model package. If you want to clone a model
	// package, set it to the model package Amazon Resource Name (ARN). If you want to
	// register a model, set it to the model ARN.
	SourceUri *string

	// A list of key value pairs associated with the model. For more information, see
	// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference Guide. If you supply
	// ModelPackageGroupName , your model package belongs to the model group you
	// specify and uses the tags associated with the model group. In this case, you
	// cannot supply a tag argument.
	Tags []types.Tag

	// The machine learning task your model package accomplishes. Common machine
	// learning tasks include object detection and image classification. The following
	// tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" |
	// "OBJECT_DETECTION" | "TEXT_GENERATION" | "IMAGE_SEGMENTATION" | "FILL_MASK" |
	// "CLASSIFICATION" | "REGRESSION" | "OTHER" . Specify "OTHER" if none of the tasks
	// listed fit your use case.
	Task *string

	// Specifies configurations for one or more transform jobs that SageMaker runs to
	// test the model package.
	ValidationSpecification *types.ModelPackageValidationSpecification
	// contains filtered or unexported fields
}

type CreateModelPackageOutput

type CreateModelPackageOutput struct {

	// The Amazon Resource Name (ARN) of the new model package.
	//
	// This member is required.
	ModelPackageArn *string

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

type CreateModelQualityJobDefinitionInput added in v0.31.0

type CreateModelQualityJobDefinitionInput struct {

	// The name of the monitoring job definition.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// The container that runs the monitoring job.
	//
	// This member is required.
	ModelQualityAppSpecification *types.ModelQualityAppSpecification

	// A list of the inputs that are monitored. Currently endpoints are supported.
	//
	// This member is required.
	ModelQualityJobInput *types.ModelQualityJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	ModelQualityJobOutputConfig *types.MonitoringOutputConfig

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// Specifies the constraints and baselines for the monitoring job.
	ModelQualityBaselineConfig *types.ModelQualityBaselineConfig

	// Specifies the network configuration for the monitoring job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

	// (Optional) An array of key-value pairs. For more information, see  Using Cost
	// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateModelQualityJobDefinitionOutput added in v0.31.0

type CreateModelQualityJobDefinitionOutput struct {

	// The Amazon Resource Name (ARN) of the model quality monitoring job.
	//
	// This member is required.
	JobDefinitionArn *string

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

type CreateMonitoringScheduleInput

type CreateMonitoringScheduleInput struct {

	// The configuration object that specifies the monitoring schedule and defines the
	// monitoring job.
	//
	// This member is required.
	MonitoringScheduleConfig *types.MonitoringScheduleConfig

	// The name of the monitoring schedule. The name must be unique within an Amazon
	// Web Services Region within an Amazon Web Services account.
	//
	// This member is required.
	MonitoringScheduleName *string

	// (Optional) An array of key-value pairs. For more information, see Using Cost
	// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateMonitoringScheduleOutput

type CreateMonitoringScheduleOutput struct {

	// The Amazon Resource Name (ARN) of the monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleArn *string

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

type CreateNotebookInstanceInput

type CreateNotebookInstanceInput struct {

	// The type of ML compute instance to launch for the notebook instance.
	//
	// This member is required.
	InstanceType types.InstanceType

	// The name of the new notebook instance.
	//
	// This member is required.
	NotebookInstanceName *string

	// When you send any requests to Amazon Web Services resources from the notebook
	// instance, SageMaker assumes this role to perform tasks on your behalf. You must
	// grant this role necessary permissions so SageMaker can perform these tasks. The
	// policy must allow the SageMaker service principal (sagemaker.amazonaws.com)
	// permissions to assume this role. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html)
	// . To be able to pass this role to SageMaker, the caller of this API must have
	// the iam:PassRole permission.
	//
	// This member is required.
	RoleArn *string

	// A list of Elastic Inference (EI) instance types to associate with this notebook
	// instance. Currently, only one instance type can be associated with a notebook
	// instance. For more information, see Using Elastic Inference in Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html)
	// .
	AcceleratorTypes []types.NotebookInstanceAcceleratorType

	// An array of up to three Git repositories to associate with the notebook
	// instance. These can be either the names of Git repositories stored as resources
	// in your account, or the URL of Git repositories in Amazon Web Services
	// CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. These repositories are cloned at the same level
	// as the default repository of your notebook instance. For more information, see
	// Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// .
	AdditionalCodeRepositories []string

	// A Git repository to associate with the notebook instance as its default code
	// repository. This can be either the name of a Git repository stored as a resource
	// in your account, or the URL of a Git repository in Amazon Web Services
	// CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. When you open a notebook instance, it opens in
	// the directory that contains this repository. For more information, see
	// Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// .
	DefaultCodeRepository *string

	// Sets whether SageMaker provides internet access to the notebook instance. If
	// you set this to Disabled this notebook instance is able to access resources
	// only in your VPC, and is not be able to connect to SageMaker training and
	// endpoint services unless you configure a NAT Gateway in your VPC. For more
	// information, see Notebook Instances Are Internet-Enabled by Default (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access)
	// . You can set the value of this parameter to Disabled only if you set a value
	// for the SubnetId parameter.
	DirectInternetAccess types.DirectInternetAccess

	// Information on the IMDS configuration of the notebook instance
	InstanceMetadataServiceConfiguration *types.InstanceMetadataServiceConfiguration

	// The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service
	// key that SageMaker uses to encrypt data on the storage volume attached to your
	// notebook instance. The KMS key you provide must be enabled. For information, see
	// Enabling and Disabling Keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html)
	// in the Amazon Web Services Key Management Service Developer Guide.
	KmsKeyId *string

	// The name of a lifecycle configuration to associate with the notebook instance.
	// For information about lifestyle configurations, see Step 2.1: (Optional)
	// Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html)
	// .
	LifecycleConfigName *string

	// The platform identifier of the notebook instance runtime environment.
	PlatformIdentifier *string

	// Whether root access is enabled or disabled for users of the notebook instance.
	// The default value is Enabled . Lifecycle configurations need root access to be
	// able to set up a notebook instance. Because of this, lifecycle configurations
	// associated with a notebook instance always run with root access even if you
	// disable root access for users.
	RootAccess types.RootAccess

	// The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must
	// be for the same VPC as specified in the subnet.
	SecurityGroupIds []string

	// The ID of the subnet in a VPC to which you would like to have a connectivity
	// from your ML compute instance.
	SubnetId *string

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag

	// The size, in GB, of the ML storage volume to attach to the notebook instance.
	// The default value is 5 GB.
	VolumeSizeInGB *int32
	// contains filtered or unexported fields
}

type CreateNotebookInstanceLifecycleConfigInput

type CreateNotebookInstanceLifecycleConfigInput struct {

	// The name of the lifecycle configuration.
	//
	// This member is required.
	NotebookInstanceLifecycleConfigName *string

	// A shell script that runs only once, when you create a notebook instance. The
	// shell script must be a base64-encoded string.
	OnCreate []types.NotebookInstanceLifecycleHook

	// A shell script that runs every time you start a notebook instance, including
	// when you create the notebook instance. The shell script must be a base64-encoded
	// string.
	OnStart []types.NotebookInstanceLifecycleHook
	// contains filtered or unexported fields
}

type CreateNotebookInstanceLifecycleConfigOutput

type CreateNotebookInstanceLifecycleConfigOutput struct {

	// The Amazon Resource Name (ARN) of the lifecycle configuration.
	NotebookInstanceLifecycleConfigArn *string

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

type CreateNotebookInstanceOutput

type CreateNotebookInstanceOutput struct {

	// The Amazon Resource Name (ARN) of the notebook instance.
	NotebookInstanceArn *string

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

type CreatePipelineInput added in v0.31.0

type CreatePipelineInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time.
	//
	// This member is required.
	ClientRequestToken *string

	// The name of the pipeline.
	//
	// This member is required.
	PipelineName *string

	// The Amazon Resource Name (ARN) of the role used by the pipeline to access and
	// create resources.
	//
	// This member is required.
	RoleArn *string

	// This is the configuration that controls the parallelism of the pipeline. If
	// specified, it applies to all runs of this pipeline by default.
	ParallelismConfiguration *types.ParallelismConfiguration

	// The JSON pipeline definition (https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/)
	// of the pipeline.
	PipelineDefinition *string

	// The location of the pipeline definition stored in Amazon S3. If specified,
	// SageMaker will retrieve the pipeline definition from this location.
	PipelineDefinitionS3Location *types.PipelineDefinitionS3Location

	// A description of the pipeline.
	PipelineDescription *string

	// The display name of the pipeline.
	PipelineDisplayName *string

	// A list of tags to apply to the created pipeline.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreatePipelineOutput added in v0.31.0

type CreatePipelineOutput struct {

	// The Amazon Resource Name (ARN) of the created pipeline.
	PipelineArn *string

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

type CreatePresignedDomainUrlInput

type CreatePresignedDomainUrlInput struct {

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The name of the UserProfile to sign-in as.
	//
	// This member is required.
	UserProfileName *string

	// The number of seconds until the pre-signed URL expires. This value defaults to
	// 300.
	ExpiresInSeconds *int32

	// The landing page that the user is directed to when accessing the presigned URL.
	// Using this value, users can access Studio or Studio Classic, even if it is not
	// the default experience for the domain. The supported values are:
	//   - studio::relative/path : Directs users to the relative path in Studio.
	//   - app:JupyterServer:relative/path : Directs users to the relative path in the
	//   Studio Classic application.
	//   - app:JupyterLab:relative/path : Directs users to the relative path in the
	//   JupyterLab application.
	//   - app:RStudioServerPro:relative/path : Directs users to the relative path in
	//   the RStudio application.
	//   - app:CodeEditor:relative/path : Directs users to the relative path in the
	//   Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.
	//   - app:Canvas:relative/path : Directs users to the relative path in the Canvas
	//   application.
	LandingUri *string

	// The session expiration duration in seconds. This value defaults to 43200.
	SessionExpirationDurationInSeconds *int32

	// The name of the space.
	SpaceName *string
	// contains filtered or unexported fields
}

type CreatePresignedDomainUrlOutput

type CreatePresignedDomainUrlOutput struct {

	// The presigned URL.
	AuthorizedUrl *string

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

type CreatePresignedNotebookInstanceUrlInput

type CreatePresignedNotebookInstanceUrlInput struct {

	// The name of the notebook instance.
	//
	// This member is required.
	NotebookInstanceName *string

	// The duration of the session, in seconds. The default is 12 hours.
	SessionExpirationDurationInSeconds *int32
	// contains filtered or unexported fields
}

type CreatePresignedNotebookInstanceUrlOutput

type CreatePresignedNotebookInstanceUrlOutput struct {

	// A JSON object that contains the URL string.
	AuthorizedUrl *string

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

type CreateProcessingJobInput

type CreateProcessingJobInput struct {

	// Configures the processing job to run a specified Docker container image.
	//
	// This member is required.
	AppSpecification *types.AppSpecification

	// The name of the processing job. The name must be unique within an Amazon Web
	// Services Region in the Amazon Web Services account.
	//
	// This member is required.
	ProcessingJobName *string

	// Identifies the resources, ML compute instances, and ML storage volumes to
	// deploy for a processing job. In distributed training, you specify more than one
	// instance.
	//
	// This member is required.
	ProcessingResources *types.ProcessingResources

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The environment variables to set in the Docker container. Up to 100 key and
	// values entries in the map are supported.
	Environment map[string]string

	// Associates a SageMaker job as a trial component with an experiment and trial.
	// Specified when you call the following APIs:
	//   - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)
	//   - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)
	//   - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)
	ExperimentConfig *types.ExperimentConfig

	// Networking options for a processing job, such as whether to allow inbound and
	// outbound network calls to and from processing containers, and the VPC subnets
	// and security groups to use for VPC-enabled processing jobs.
	NetworkConfig *types.NetworkConfig

	// An array of inputs configuring the data to download into the processing
	// container.
	ProcessingInputs []types.ProcessingInput

	// Output configuration for the processing job.
	ProcessingOutputConfig *types.ProcessingOutputConfig

	// The time limit for how long the processing job is allowed to run.
	StoppingCondition *types.ProcessingStoppingCondition

	// (Optional) An array of key-value pairs. For more information, see Using Cost
	// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateProcessingJobOutput

type CreateProcessingJobOutput struct {

	// The Amazon Resource Name (ARN) of the processing job.
	//
	// This member is required.
	ProcessingJobArn *string

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

type CreateProjectInput added in v0.31.0

type CreateProjectInput struct {

	// The name of the project.
	//
	// This member is required.
	ProjectName *string

	// The product ID and provisioning artifact ID to provision a service catalog. The
	// provisioning artifact ID will default to the latest provisioning artifact ID of
	// the product, if you don't provide the provisioning artifact ID. For more
	// information, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html)
	// .
	//
	// This member is required.
	ServiceCatalogProvisioningDetails *types.ServiceCatalogProvisioningDetails

	// A description for the project.
	ProjectDescription *string

	// An array of key-value pairs that you want to use to organize and track your
	// Amazon Web Services resource costs. For more information, see Tagging Amazon
	// Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// in the Amazon Web Services General Reference Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateProjectOutput added in v0.31.0

type CreateProjectOutput struct {

	// The Amazon Resource Name (ARN) of the project.
	//
	// This member is required.
	ProjectArn *string

	// The ID of the new project.
	//
	// This member is required.
	ProjectId *string

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

type CreateSpaceInput added in v1.56.0

type CreateSpaceInput struct {

	// The ID of the associated domain.
	//
	// This member is required.
	DomainId *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// A collection of ownership settings.
	OwnershipSettings *types.OwnershipSettings

	// The name of the space that appears in the SageMaker Studio UI.
	SpaceDisplayName *string

	// A collection of space settings.
	SpaceSettings *types.SpaceSettings

	// A collection of space sharing settings.
	SpaceSharingSettings *types.SpaceSharingSettings

	// Tags to associated with the space. Each tag consists of a key and an optional
	// value. Tag keys must be unique for each resource. Tags are searchable using the
	// Search API.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateSpaceOutput added in v1.56.0

type CreateSpaceOutput struct {

	// The space's Amazon Resource Name (ARN).
	SpaceArn *string

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

type CreateStudioLifecycleConfigInput added in v1.15.0

type CreateStudioLifecycleConfigInput struct {

	// The App type that the Lifecycle Configuration is attached to.
	//
	// This member is required.
	StudioLifecycleConfigAppType types.StudioLifecycleConfigAppType

	// The content of your Amazon SageMaker Studio Lifecycle Configuration script.
	// This content must be base64 encoded.
	//
	// This member is required.
	StudioLifecycleConfigContent *string

	// The name of the Amazon SageMaker Studio Lifecycle Configuration to create.
	//
	// This member is required.
	StudioLifecycleConfigName *string

	// Tags to be associated with the Lifecycle Configuration. Each tag consists of a
	// key and an optional value. Tag keys must be unique per resource. Tags are
	// searchable using the Search API.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateStudioLifecycleConfigOutput added in v1.15.0

type CreateStudioLifecycleConfigOutput struct {

	// The ARN of your created Lifecycle Configuration.
	StudioLifecycleConfigArn *string

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

type CreateTrainingJobInput

type CreateTrainingJobInput struct {

	// The registry path of the Docker image that contains the training algorithm and
	// algorithm-specific metadata, including the input mode. For more information
	// about algorithms provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html)
	// . For information about providing your own algorithms, see Using Your Own
	// Algorithms with Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html)
	// .
	//
	// This member is required.
	AlgorithmSpecification *types.AlgorithmSpecification

	// Specifies the path to the S3 location where you want to store model artifacts.
	// SageMaker creates subfolders for the artifacts.
	//
	// This member is required.
	OutputDataConfig *types.OutputDataConfig

	// The resources, including the ML compute instances and ML storage volumes, to
	// use for model training. ML storage volumes store model artifacts and incremental
	// states. Training algorithms might also use ML storage volumes for scratch space.
	// If you want SageMaker to use the ML storage volume to store the training data,
	// choose File as the TrainingInputMode in the algorithm specification. For
	// distributed training algorithms, specify an instance count greater than 1.
	//
	// This member is required.
	ResourceConfig *types.ResourceConfig

	// The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to
	// perform tasks on your behalf. During model training, SageMaker needs your
	// permission to read input data from an S3 bucket, download a Docker image that
	// contains training code, write model artifacts to an S3 bucket, write logs to
	// Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant
	// permissions for all of these tasks to an IAM role. For more information, see
	// SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html)
	// . To be able to pass this role to SageMaker, the caller of this API must have
	// the iam:PassRole permission.
	//
	// This member is required.
	RoleArn *string

	// Specifies a limit to how long a model training job can run. It also specifies
	// how long a managed Spot training job has to complete. When the job reaches the
	// time limit, SageMaker ends the training job. Use this API to cap model training
	// costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which
	// delays job termination for 120 seconds. Algorithms can use this 120-second
	// window to save the model artifacts, so the results of training are not lost.
	//
	// This member is required.
	StoppingCondition *types.StoppingCondition

	// The name of the training job. The name must be unique within an Amazon Web
	// Services Region in an Amazon Web Services account.
	//
	// This member is required.
	TrainingJobName *string

	// Contains information about the output location for managed spot training
	// checkpoint data.
	CheckpointConfig *types.CheckpointConfig

	// Configuration information for the Amazon SageMaker Debugger hook parameters,
	// metric and tensor collections, and storage paths. To learn more about how to
	// configure the DebugHookConfig parameter, see Use the SageMaker and Debugger
	// Configuration API Operations to Create, Update, and Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html)
	// .
	DebugHookConfig *types.DebugHookConfig

	// Configuration information for Amazon SageMaker Debugger rules for debugging
	// output tensors.
	DebugRuleConfigurations []types.DebugRuleConfiguration

	// To encrypt all communications between ML compute instances in distributed
	// training, choose True . Encryption provides greater security for distributed
	// training, but training might take longer. How long it takes depends on the
	// amount of communication between compute instances, especially if you use a deep
	// learning algorithm in distributed training. For more information, see Protect
	// Communications Between ML Compute Instances in a Distributed Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html)
	// .
	EnableInterContainerTrafficEncryption *bool

	// To train models using managed spot training, choose True . Managed spot training
	// provides a fully managed and scalable infrastructure for training machine
	// learning models. this option is useful when training jobs can be interrupted and
	// when there is flexibility when the training job is run. The complete and
	// intermediate results of jobs are stored in an Amazon S3 bucket, and can be used
	// as a starting point to train models incrementally. Amazon SageMaker provides
	// metrics and logs in CloudWatch. They can be used to see when managed spot
	// training jobs are running, interrupted, resumed, or completed.
	EnableManagedSpotTraining *bool

	// Isolates the training container. No inbound or outbound network calls can be
	// made, except for calls between peers within a training cluster for distributed
	// training. If you enable network isolation for training jobs that are configured
	// to use a VPC, SageMaker downloads and uploads customer data and model artifacts
	// through the specified VPC, but the training container does not have network
	// access.
	EnableNetworkIsolation *bool

	// The environment variables to set in the Docker container.
	Environment map[string]string

	// Associates a SageMaker job as a trial component with an experiment and trial.
	// Specified when you call the following APIs:
	//   - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)
	//   - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)
	//   - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)
	ExperimentConfig *types.ExperimentConfig

	// Algorithm-specific parameters that influence the quality of the model. You set
	// hyperparameters before you start the learning process. For a list of
	// hyperparameters for each training algorithm provided by SageMaker, see
	// Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html) . You
	// can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value
	// pair. Each key and value is limited to 256 characters, as specified by the
	// Length Constraint . Do not include any security-sensitive information including
	// account access IDs, secrets or tokens in any hyperparameter field. If the use of
	// security-sensitive credentials are detected, SageMaker will reject your training
	// job request and return an exception error.
	HyperParameters map[string]string

	// Contains information about the infrastructure health check configuration for
	// the training job.
	InfraCheckConfig *types.InfraCheckConfig

	// An array of Channel objects. Each channel is a named input source.
	// InputDataConfig describes the input data and its location. Algorithms can accept
	// input data from one or more channels. For example, an algorithm might have two
	// channels of input data, training_data and validation_data . The configuration
	// for each channel provides the S3, EFS, or FSx location where the input data is
	// stored. It also provides information about the stored data: the MIME type,
	// compression method, and whether the data is wrapped in RecordIO format.
	// Depending on the input mode that the algorithm supports, SageMaker either copies
	// input data files from an S3 bucket to a local directory in the Docker container,
	// or makes it available as input streams. For example, if you specify an EFS
	// location, input data files are available as input streams. They do not need to
	// be downloaded. Your input must be in the same Amazon Web Services region as your
	// training job.
	InputDataConfig []types.Channel

	// Configuration information for Amazon SageMaker Debugger system monitoring,
	// framework profiling, and storage paths.
	ProfilerConfig *types.ProfilerConfig

	// Configuration information for Amazon SageMaker Debugger rules for profiling
	// system and framework metrics.
	ProfilerRuleConfigurations []types.ProfilerRuleConfiguration

	// Configuration for remote debugging. To learn more about the remote debugging
	// functionality of SageMaker, see Access a training container through Amazon Web
	// Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html)
	// .
	RemoteDebugConfig *types.RemoteDebugConfig

	// The number of times to retry the job when the job fails due to an
	// InternalServerError .
	RetryStrategy *types.RetryStrategy

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag

	// Configuration of storage locations for the Amazon SageMaker Debugger
	// TensorBoard output data.
	TensorBoardOutputConfig *types.TensorBoardOutputConfig

	// A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)
	// object that specifies the VPC that you want your training job to connect to.
	// Control access to and from your training container by configuring the VPC. For
	// more information, see Protect Training Jobs by Using an Amazon Virtual Private
	// Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html) .
	VpcConfig *types.VpcConfig
	// contains filtered or unexported fields
}

type CreateTrainingJobOutput

type CreateTrainingJobOutput struct {

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

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

type CreateTransformJobInput

type CreateTransformJobInput struct {

	// The name of the model that you want to use for the transform job. ModelName
	// must be the name of an existing Amazon SageMaker model within an Amazon Web
	// Services Region in an Amazon Web Services account.
	//
	// This member is required.
	ModelName *string

	// Describes the input source and the way the transform job consumes it.
	//
	// This member is required.
	TransformInput *types.TransformInput

	// The name of the transform job. The name must be unique within an Amazon Web
	// Services Region in an Amazon Web Services account.
	//
	// This member is required.
	TransformJobName *string

	// Describes the results of the transform job.
	//
	// This member is required.
	TransformOutput *types.TransformOutput

	// Describes the resources, including ML instance types and ML instance count, to
	// use for the transform job.
	//
	// This member is required.
	TransformResources *types.TransformResources

	// Specifies the number of records to include in a mini-batch for an HTTP
	// inference request. A record is a single unit of input data that inference can be
	// made on. For example, a single line in a CSV file is a record. To enable the
	// batch strategy, you must set the SplitType property to Line , RecordIO , or
	// TFRecord . To use only one record when making an HTTP invocation request to a
	// container, set BatchStrategy to SingleRecord and SplitType to Line . To fit as
	// many records in a mini-batch as can fit within the MaxPayloadInMB limit, set
	// BatchStrategy to MultiRecord and SplitType to Line .
	BatchStrategy types.BatchStrategy

	// Configuration to control how SageMaker captures inference data.
	DataCaptureConfig *types.BatchDataCaptureConfig

	// The data structure used to specify the data to be used for inference in a batch
	// transform job and to associate the data that is relevant to the prediction
	// results in the output. The input filter provided allows you to exclude input
	// data that is not needed for inference in a batch transform job. The output
	// filter provided allows you to include input data relevant to interpreting the
	// predictions in the output from the job. For more information, see Associate
	// Prediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html)
	// .
	DataProcessing *types.DataProcessing

	// The environment variables to set in the Docker container. We support up to 16
	// key and values entries in the map.
	Environment map[string]string

	// Associates a SageMaker job as a trial component with an experiment and trial.
	// Specified when you call the following APIs:
	//   - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)
	//   - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)
	//   - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)
	ExperimentConfig *types.ExperimentConfig

	// The maximum number of parallel requests that can be sent to each instance in a
	// transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon
	// SageMaker checks the optional execution-parameters to determine the settings for
	// your chosen algorithm. If the execution-parameters endpoint is not enabled, the
	// default value is 1 . For more information on execution-parameters, see How
	// Containers Serve Requests (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests)
	// . For built-in algorithms, you don't need to set a value for
	// MaxConcurrentTransforms .
	MaxConcurrentTransforms *int32

	// The maximum allowed size of the payload, in MB. A payload is the data portion
	// of a record (without metadata). The value in MaxPayloadInMB must be greater
	// than, or equal to, the size of a single record. To estimate the size of a record
	// in MB, divide the size of your dataset by the number of records. To ensure that
	// the records fit within the maximum payload size, we recommend using a slightly
	// larger value. The default value is 6 MB. The value of MaxPayloadInMB cannot be
	// greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the
	// value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.
	// For cases where the payload might be arbitrarily large and is transmitted using
	// HTTP chunked encoding, set the value to 0 . This feature works only in supported
	// algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP
	// chunked encoding.
	MaxPayloadInMB *int32

	// Configures the timeout and maximum number of retries for processing a transform
	// job invocation.
	ModelClientConfig *types.ModelClientConfig

	// (Optional) An array of key-value pairs. For more information, see Using Cost
	// Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateTransformJobOutput

type CreateTransformJobOutput struct {

	// The Amazon Resource Name (ARN) of the transform job.
	//
	// This member is required.
	TransformJobArn *string

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

type CreateTrialComponentInput

type CreateTrialComponentInput struct {

	// The name of the component. The name must be unique in your Amazon Web Services
	// account and is not case-sensitive.
	//
	// This member is required.
	TrialComponentName *string

	// The name of the component as displayed. The name doesn't need to be unique. If
	// DisplayName isn't specified, TrialComponentName is displayed.
	DisplayName *string

	// When the component ended.
	EndTime *time.Time

	// The input artifacts for the component. Examples of input artifacts are
	// datasets, algorithms, hyperparameters, source code, and instance types.
	InputArtifacts map[string]types.TrialComponentArtifact

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// The output artifacts for the component. Examples of output artifacts are
	// metrics, snapshots, logs, and images.
	OutputArtifacts map[string]types.TrialComponentArtifact

	// The hyperparameters for the component.
	Parameters map[string]types.TrialComponentParameterValue

	// When the component started.
	StartTime *time.Time

	// The status of the component. States include:
	//   - InProgress
	//   - Completed
	//   - Failed
	Status *types.TrialComponentStatus

	// A list of tags to associate with the component. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html)
	// API to search on the tags.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateTrialComponentOutput

type CreateTrialComponentOutput struct {

	// The Amazon Resource Name (ARN) of the trial component.
	TrialComponentArn *string

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

type CreateTrialInput

type CreateTrialInput struct {

	// The name of the experiment to associate the trial with.
	//
	// This member is required.
	ExperimentName *string

	// The name of the trial. The name must be unique in your Amazon Web Services
	// account and is not case-sensitive.
	//
	// This member is required.
	TrialName *string

	// The name of the trial as displayed. The name doesn't need to be unique. If
	// DisplayName isn't specified, TrialName is displayed.
	DisplayName *string

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// A list of tags to associate with the trial. You can use Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html)
	// API to search on the tags.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateTrialOutput

type CreateTrialOutput struct {

	// The Amazon Resource Name (ARN) of the trial.
	TrialArn *string

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

type CreateUserProfileInput

type CreateUserProfileInput struct {

	// The ID of the associated Domain.
	//
	// This member is required.
	DomainId *string

	// A name for the UserProfile. This value is not case sensitive.
	//
	// This member is required.
	UserProfileName *string

	// A specifier for the type of value specified in SingleSignOnUserValue.
	// Currently, the only supported value is "UserName". If the Domain's AuthMode is
	// IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM
	// Identity Center, this field cannot be specified.
	SingleSignOnUserIdentifier *string

	// The username of the associated Amazon Web Services Single Sign-On User for this
	// UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is
	// required, and must match a valid username of a user in your directory. If the
	// Domain's AuthMode is not IAM Identity Center, this field cannot be specified.
	SingleSignOnUserValue *string

	// Each tag consists of a key and an optional value. Tag keys must be unique per
	// resource. Tags that you specify for the User Profile are also added to all Apps
	// that the User Profile launches.
	Tags []types.Tag

	// A collection of settings.
	UserSettings *types.UserSettings
	// contains filtered or unexported fields
}

type CreateUserProfileOutput

type CreateUserProfileOutput struct {

	// The user profile Amazon Resource Name (ARN).
	UserProfileArn *string

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

type CreateWorkforceInput

type CreateWorkforceInput struct {

	// The name of the private workforce.
	//
	// This member is required.
	WorkforceName *string

	// Use this parameter to configure an Amazon Cognito private workforce. A single
	// Cognito workforce is created using and corresponds to a single Amazon Cognito
	// user pool (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html)
	// . Do not use OidcConfig if you specify values for CognitoConfig .
	CognitoConfig *types.CognitoConfig

	// Use this parameter to configure a private workforce using your own OIDC
	// Identity Provider. Do not use CognitoConfig if you specify values for OidcConfig
	// .
	OidcConfig *types.OidcConfig

	// A list of IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)
	// ). Used to create an allow list of IP addresses for a private workforce. Workers
	// will only be able to login to their worker portal from an IP address within this
	// range. By default, a workforce isn't restricted to specific IP addresses.
	SourceIpConfig *types.SourceIpConfig

	// An array of key-value pairs that contain metadata to help you categorize and
	// organize our workforce. Each tag consists of a key and a value, both of which
	// you define.
	Tags []types.Tag

	// Use this parameter to configure a workforce using VPC.
	WorkforceVpcConfig *types.WorkforceVpcConfigRequest
	// contains filtered or unexported fields
}

type CreateWorkforceOutput

type CreateWorkforceOutput struct {

	// The Amazon Resource Name (ARN) of the workforce.
	//
	// This member is required.
	WorkforceArn *string

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

type CreateWorkteamInput

type CreateWorkteamInput struct {

	// A description of the work team.
	//
	// This member is required.
	Description *string

	// A list of MemberDefinition objects that contains objects that identify the
	// workers that make up the work team. Workforces can be created using Amazon
	// Cognito or your own OIDC Identity Provider (IdP). For private workforces created
	// using Amazon Cognito use CognitoMemberDefinition . For workforces created using
	// your own OIDC identity provider (IdP) use OidcMemberDefinition . Do not provide
	// input for both of these parameters in a single request. For workforces created
	// using Amazon Cognito, private work teams correspond to Amazon Cognito user
	// groups within the user pool used to create a workforce. All of the
	// CognitoMemberDefinition objects that make up the member definition must have the
	// same ClientId and UserPool values. To add a Amazon Cognito user group to an
	// existing worker pool, see Adding groups to a User Pool . For more information
	// about user pools, see Amazon Cognito User Pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html)
	// . For workforces created using your own OIDC IdP, specify the user groups that
	// you want to include in your private work team in OidcMemberDefinition by
	// listing those groups in Groups .
	//
	// This member is required.
	MemberDefinitions []types.MemberDefinition

	// The name of the work team. Use this name to identify the work team.
	//
	// This member is required.
	WorkteamName *string

	// Configures notification of workers regarding available or expiring work items.
	NotificationConfiguration *types.NotificationConfiguration

	// An array of key-value pairs. For more information, see Resource Tag (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
	// and Using Cost Allocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)
	// in the Amazon Web Services Billing and Cost Management User Guide.
	Tags []types.Tag

	// The name of the workforce.
	WorkforceName *string
	// contains filtered or unexported fields
}

type CreateWorkteamOutput

type CreateWorkteamOutput struct {

	// The Amazon Resource Name (ARN) of the work team. You can use this ARN to
	// identify the work team.
	WorkteamArn *string

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

type DeleteActionInput added in v0.31.0

type DeleteActionInput struct {

	// The name of the action to delete.
	//
	// This member is required.
	ActionName *string
	// contains filtered or unexported fields
}

type DeleteActionOutput added in v0.31.0

type DeleteActionOutput struct {

	// The Amazon Resource Name (ARN) of the action.
	ActionArn *string

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

type DeleteAlgorithmInput

type DeleteAlgorithmInput struct {

	// The name of the algorithm to delete.
	//
	// This member is required.
	AlgorithmName *string
	// contains filtered or unexported fields
}

type DeleteAlgorithmOutput

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

type DeleteAppImageConfigInput added in v0.29.0

type DeleteAppImageConfigInput struct {

	// The name of the AppImageConfig to delete.
	//
	// This member is required.
	AppImageConfigName *string
	// contains filtered or unexported fields
}

type DeleteAppImageConfigOutput added in v0.29.0

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

type DeleteAppInput

type DeleteAppInput struct {

	// The name of the app.
	//
	// This member is required.
	AppName *string

	// The type of app.
	//
	// This member is required.
	AppType types.AppType

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The name of the space. If this value is not set, then UserProfileName must be
	// set.
	SpaceName *string

	// The user profile name. If this value is not set, then SpaceName must be set.
	UserProfileName *string
	// contains filtered or unexported fields
}

type DeleteAppOutput

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

type DeleteArtifactInput added in v0.31.0

type DeleteArtifactInput struct {

	// The Amazon Resource Name (ARN) of the artifact to delete.
	ArtifactArn *string

	// The URI of the source.
	Source *types.ArtifactSource
	// contains filtered or unexported fields
}

type DeleteArtifactOutput added in v0.31.0

type DeleteArtifactOutput struct {

	// The Amazon Resource Name (ARN) of the artifact.
	ArtifactArn *string

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

type DeleteAssociationInput added in v0.31.0

type DeleteAssociationInput struct {

	// The Amazon Resource Name (ARN) of the destination.
	//
	// This member is required.
	DestinationArn *string

	// The ARN of the source.
	//
	// This member is required.
	SourceArn *string
	// contains filtered or unexported fields
}

type DeleteAssociationOutput added in v0.31.0

type DeleteAssociationOutput struct {

	// The Amazon Resource Name (ARN) of the destination.
	DestinationArn *string

	// The ARN of the source.
	SourceArn *string

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

type DeleteClusterInput added in v1.119.0

type DeleteClusterInput struct {

	// The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod
	// cluster to delete.
	//
	// This member is required.
	ClusterName *string
	// contains filtered or unexported fields
}

type DeleteClusterOutput added in v1.119.0

type DeleteClusterOutput struct {

	// The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster to delete.
	//
	// This member is required.
	ClusterArn *string

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

type DeleteCodeRepositoryInput

type DeleteCodeRepositoryInput struct {

	// The name of the Git repository to delete.
	//
	// This member is required.
	CodeRepositoryName *string
	// contains filtered or unexported fields
}

type DeleteCodeRepositoryOutput

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

type DeleteCompilationJobInput added in v1.121.0

type DeleteCompilationJobInput struct {

	// The name of the compilation job to delete.
	//
	// This member is required.
	CompilationJobName *string
	// contains filtered or unexported fields
}

type DeleteCompilationJobOutput added in v1.121.0

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

type DeleteContextInput added in v0.31.0

type DeleteContextInput struct {

	// The name of the context to delete.
	//
	// This member is required.
	ContextName *string
	// contains filtered or unexported fields
}

type DeleteContextOutput added in v0.31.0

type DeleteContextOutput struct {

	// The Amazon Resource Name (ARN) of the context.
	ContextArn *string

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

type DeleteDataQualityJobDefinitionInput added in v0.31.0

type DeleteDataQualityJobDefinitionInput struct {

	// The name of the data quality monitoring job definition to delete.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DeleteDataQualityJobDefinitionOutput added in v0.31.0

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

type DeleteDeviceFleetInput added in v0.31.0

type DeleteDeviceFleetInput struct {

	// The name of the fleet to delete.
	//
	// This member is required.
	DeviceFleetName *string
	// contains filtered or unexported fields
}

type DeleteDeviceFleetOutput added in v0.31.0

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

type DeleteDomainInput

type DeleteDomainInput struct {

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The retention policy for this domain, which specifies whether resources will be
	// retained after the Domain is deleted. By default, all resources are retained
	// (not automatically deleted).
	RetentionPolicy *types.RetentionPolicy
	// contains filtered or unexported fields
}

type DeleteDomainOutput

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

type DeleteEdgeDeploymentPlanInput added in v1.37.0

type DeleteEdgeDeploymentPlanInput struct {

	// The name of the edge deployment plan to delete.
	//
	// This member is required.
	EdgeDeploymentPlanName *string
	// contains filtered or unexported fields
}

type DeleteEdgeDeploymentPlanOutput added in v1.37.0

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

type DeleteEdgeDeploymentStageInput added in v1.37.0

type DeleteEdgeDeploymentStageInput struct {

	// The name of the edge deployment plan from which the stage will be deleted.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// The name of the stage.
	//
	// This member is required.
	StageName *string
	// contains filtered or unexported fields
}

type DeleteEdgeDeploymentStageOutput added in v1.37.0

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

type DeleteEndpointConfigInput

type DeleteEndpointConfigInput struct {

	// The name of the endpoint configuration that you want to delete.
	//
	// This member is required.
	EndpointConfigName *string
	// contains filtered or unexported fields
}

type DeleteEndpointConfigOutput

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

type DeleteEndpointInput

type DeleteEndpointInput struct {

	// The name of the endpoint that you want to delete.
	//
	// This member is required.
	EndpointName *string
	// contains filtered or unexported fields
}

type DeleteEndpointOutput

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

type DeleteExperimentInput

type DeleteExperimentInput struct {

	// The name of the experiment to delete.
	//
	// This member is required.
	ExperimentName *string
	// contains filtered or unexported fields
}

type DeleteExperimentOutput

type DeleteExperimentOutput struct {

	// The Amazon Resource Name (ARN) of the experiment that is being deleted.
	ExperimentArn *string

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

type DeleteFeatureGroupInput added in v0.31.0

type DeleteFeatureGroupInput struct {

	// The name of the FeatureGroup you want to delete. The name must be unique within
	// an Amazon Web Services Region in an Amazon Web Services account.
	//
	// This member is required.
	FeatureGroupName *string
	// contains filtered or unexported fields
}

type DeleteFeatureGroupOutput added in v0.31.0

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

type DeleteFlowDefinitionInput

type DeleteFlowDefinitionInput struct {

	// The name of the flow definition you are deleting.
	//
	// This member is required.
	FlowDefinitionName *string
	// contains filtered or unexported fields
}

type DeleteFlowDefinitionOutput

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

type DeleteHubContentInput added in v1.56.0

type DeleteHubContentInput struct {

	// The name of the content that you want to delete from a hub.
	//
	// This member is required.
	HubContentName *string

	// The type of content that you want to delete from a hub.
	//
	// This member is required.
	HubContentType types.HubContentType

	// The version of the content that you want to delete from a hub.
	//
	// This member is required.
	HubContentVersion *string

	// The name of the hub that you want to delete content in.
	//
	// This member is required.
	HubName *string
	// contains filtered or unexported fields
}

type DeleteHubContentOutput added in v1.56.0

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

type DeleteHubInput added in v1.56.0

type DeleteHubInput struct {

	// The name of the hub to delete.
	//
	// This member is required.
	HubName *string
	// contains filtered or unexported fields
}

type DeleteHubOutput added in v1.56.0

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

type DeleteHumanTaskUiInput

type DeleteHumanTaskUiInput struct {

	// The name of the human task user interface (work task template) you want to
	// delete.
	//
	// This member is required.
	HumanTaskUiName *string
	// contains filtered or unexported fields
}

type DeleteHumanTaskUiOutput

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

type DeleteHyperParameterTuningJobInput added in v1.126.0

type DeleteHyperParameterTuningJobInput struct {

	// The name of the hyperparameter tuning job that you want to delete.
	//
	// This member is required.
	HyperParameterTuningJobName *string
	// contains filtered or unexported fields
}

type DeleteHyperParameterTuningJobOutput added in v1.126.0

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

type DeleteImageInput added in v0.29.0

type DeleteImageInput struct {

	// The name of the image to delete.
	//
	// This member is required.
	ImageName *string
	// contains filtered or unexported fields
}

type DeleteImageOutput added in v0.29.0

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

type DeleteImageVersionInput added in v0.29.0

type DeleteImageVersionInput struct {

	// The name of the image to delete.
	//
	// This member is required.
	ImageName *string

	// The alias of the image to delete.
	Alias *string

	// The version to delete.
	Version *int32
	// contains filtered or unexported fields
}

type DeleteImageVersionOutput added in v0.29.0

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

type DeleteInferenceComponentInput added in v1.119.0

type DeleteInferenceComponentInput struct {

	// The name of the inference component to delete.
	//
	// This member is required.
	InferenceComponentName *string
	// contains filtered or unexported fields
}

type DeleteInferenceComponentOutput added in v1.119.0

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

type DeleteInferenceExperimentInput added in v1.56.0

type DeleteInferenceExperimentInput struct {

	// The name of the inference experiment you want to delete.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DeleteInferenceExperimentOutput added in v1.56.0

type DeleteInferenceExperimentOutput struct {

	// The ARN of the deleted inference experiment.
	//
	// This member is required.
	InferenceExperimentArn *string

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

type DeleteModelBiasJobDefinitionInput added in v0.31.0

type DeleteModelBiasJobDefinitionInput struct {

	// The name of the model bias job definition to delete.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DeleteModelBiasJobDefinitionOutput added in v0.31.0

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

type DeleteModelCardInput added in v1.56.0

type DeleteModelCardInput struct {

	// The name of the model card to delete.
	//
	// This member is required.
	ModelCardName *string
	// contains filtered or unexported fields
}

type DeleteModelCardOutput added in v1.56.0

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

type DeleteModelExplainabilityJobDefinitionInput added in v0.31.0

type DeleteModelExplainabilityJobDefinitionInput struct {

	// The name of the model explainability job definition to delete.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DeleteModelExplainabilityJobDefinitionOutput added in v0.31.0

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

type DeleteModelInput

type DeleteModelInput struct {

	// The name of the model to delete.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DeleteModelOutput

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

type DeleteModelPackageGroupInput added in v0.31.0

type DeleteModelPackageGroupInput struct {

	// The name of the model group to delete.
	//
	// This member is required.
	ModelPackageGroupName *string
	// contains filtered or unexported fields
}

type DeleteModelPackageGroupOutput added in v0.31.0

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

type DeleteModelPackageGroupPolicyInput added in v0.31.0

type DeleteModelPackageGroupPolicyInput struct {

	// The name of the model group for which to delete the policy.
	//
	// This member is required.
	ModelPackageGroupName *string
	// contains filtered or unexported fields
}

type DeleteModelPackageGroupPolicyOutput added in v0.31.0

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

type DeleteModelPackageInput

type DeleteModelPackageInput struct {

	// The name or Amazon Resource Name (ARN) of the model package to delete. When you
	// specify a name, the name must have 1 to 63 characters. Valid characters are a-z,
	// A-Z, 0-9, and - (hyphen).
	//
	// This member is required.
	ModelPackageName *string
	// contains filtered or unexported fields
}

type DeleteModelPackageOutput

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

type DeleteModelQualityJobDefinitionInput added in v0.31.0

type DeleteModelQualityJobDefinitionInput struct {

	// The name of the model quality monitoring job definition to delete.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DeleteModelQualityJobDefinitionOutput added in v0.31.0

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

type DeleteMonitoringScheduleInput

type DeleteMonitoringScheduleInput struct {

	// The name of the monitoring schedule to delete.
	//
	// This member is required.
	MonitoringScheduleName *string
	// contains filtered or unexported fields
}

type DeleteMonitoringScheduleOutput

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

type DeleteNotebookInstanceInput

type DeleteNotebookInstanceInput struct {

	// The name of the SageMaker notebook instance to delete.
	//
	// This member is required.
	NotebookInstanceName *string
	// contains filtered or unexported fields
}

type DeleteNotebookInstanceLifecycleConfigInput

type DeleteNotebookInstanceLifecycleConfigInput struct {

	// The name of the lifecycle configuration to delete.
	//
	// This member is required.
	NotebookInstanceLifecycleConfigName *string
	// contains filtered or unexported fields
}

type DeleteNotebookInstanceLifecycleConfigOutput

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

type DeleteNotebookInstanceOutput

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

type DeletePipelineInput added in v0.31.0

type DeletePipelineInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time.
	//
	// This member is required.
	ClientRequestToken *string

	// The name of the pipeline to delete.
	//
	// This member is required.
	PipelineName *string
	// contains filtered or unexported fields
}

type DeletePipelineOutput added in v0.31.0

type DeletePipelineOutput struct {

	// The Amazon Resource Name (ARN) of the pipeline to delete.
	PipelineArn *string

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

type DeleteProjectInput added in v0.31.0

type DeleteProjectInput struct {

	// The name of the project to delete.
	//
	// This member is required.
	ProjectName *string
	// contains filtered or unexported fields
}

type DeleteProjectOutput added in v0.31.0

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

type DeleteSpaceInput added in v1.56.0

type DeleteSpaceInput struct {

	// The ID of the associated domain.
	//
	// This member is required.
	DomainId *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type DeleteSpaceOutput added in v1.56.0

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

type DeleteStudioLifecycleConfigInput added in v1.15.0

type DeleteStudioLifecycleConfigInput struct {

	// The name of the Amazon SageMaker Studio Lifecycle Configuration to delete.
	//
	// This member is required.
	StudioLifecycleConfigName *string
	// contains filtered or unexported fields
}

type DeleteStudioLifecycleConfigOutput added in v1.15.0

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

type DeleteTagsInput

type DeleteTagsInput struct {

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

	// An array or one or more tag keys to delete.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type DeleteTagsOutput

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

type DeleteTrialComponentInput

type DeleteTrialComponentInput struct {

	// The name of the component to delete.
	//
	// This member is required.
	TrialComponentName *string
	// contains filtered or unexported fields
}

type DeleteTrialComponentOutput

type DeleteTrialComponentOutput struct {

	// The Amazon Resource Name (ARN) of the component is being deleted.
	TrialComponentArn *string

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

type DeleteTrialInput

type DeleteTrialInput struct {

	// The name of the trial to delete.
	//
	// This member is required.
	TrialName *string
	// contains filtered or unexported fields
}

type DeleteTrialOutput

type DeleteTrialOutput struct {

	// The Amazon Resource Name (ARN) of the trial that is being deleted.
	TrialArn *string

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

type DeleteUserProfileInput

type DeleteUserProfileInput struct {

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The user profile name.
	//
	// This member is required.
	UserProfileName *string
	// contains filtered or unexported fields
}

type DeleteUserProfileOutput

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

type DeleteWorkforceInput

type DeleteWorkforceInput struct {

	// The name of the workforce.
	//
	// This member is required.
	WorkforceName *string
	// contains filtered or unexported fields
}

type DeleteWorkforceOutput

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

type DeleteWorkteamInput

type DeleteWorkteamInput struct {

	// The name of the work team to delete.
	//
	// This member is required.
	WorkteamName *string
	// contains filtered or unexported fields
}

type DeleteWorkteamOutput

type DeleteWorkteamOutput struct {

	// Returns true if the work team was successfully deleted; otherwise, returns false
	// .
	//
	// This member is required.
	Success *bool

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

type DeregisterDevicesInput added in v0.31.0

type DeregisterDevicesInput struct {

	// The name of the fleet the devices belong to.
	//
	// This member is required.
	DeviceFleetName *string

	// The unique IDs of the devices.
	//
	// This member is required.
	DeviceNames []string
	// contains filtered or unexported fields
}

type DeregisterDevicesOutput added in v0.31.0

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

type DescribeActionInput added in v0.31.0

type DescribeActionInput struct {

	// The name of the action to describe.
	//
	// This member is required.
	ActionName *string
	// contains filtered or unexported fields
}

type DescribeActionOutput added in v0.31.0

type DescribeActionOutput struct {

	// The Amazon Resource Name (ARN) of the action.
	ActionArn *string

	// The name of the action.
	ActionName *string

	// The type of the action.
	ActionType *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// When the action was created.
	CreationTime *time.Time

	// The description of the action.
	Description *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// When the action was last modified.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the lineage group.
	LineageGroupArn *string

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// A list of the action's properties.
	Properties map[string]string

	// The source of the action.
	Source *types.ActionSource

	// The status of the action.
	Status types.ActionStatus

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

type DescribeAlgorithmInput

type DescribeAlgorithmInput struct {

	// The name of the algorithm to describe.
	//
	// This member is required.
	AlgorithmName *string
	// contains filtered or unexported fields
}

type DescribeAlgorithmOutput

type DescribeAlgorithmOutput struct {

	// The Amazon Resource Name (ARN) of the algorithm.
	//
	// This member is required.
	AlgorithmArn *string

	// The name of the algorithm being described.
	//
	// This member is required.
	AlgorithmName *string

	// The current status of the algorithm.
	//
	// This member is required.
	AlgorithmStatus types.AlgorithmStatus

	// Details about the current status of the algorithm.
	//
	// This member is required.
	AlgorithmStatusDetails *types.AlgorithmStatusDetails

	// A timestamp specifying when the algorithm was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Details about training jobs run by this algorithm.
	//
	// This member is required.
	TrainingSpecification *types.TrainingSpecification

	// A brief summary about the algorithm.
	AlgorithmDescription *string

	// Whether the algorithm is certified to be listed in Amazon Web Services
	// Marketplace.
	CertifyForMarketplace *bool

	// Details about inference jobs that the algorithm runs.
	InferenceSpecification *types.InferenceSpecification

	// The product identifier of the algorithm.
	ProductId *string

	// Details about configurations for one or more training jobs that SageMaker runs
	// to test the algorithm.
	ValidationSpecification *types.AlgorithmValidationSpecification

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

type DescribeAppImageConfigInput added in v0.29.0

type DescribeAppImageConfigInput struct {

	// The name of the AppImageConfig to describe.
	//
	// This member is required.
	AppImageConfigName *string
	// contains filtered or unexported fields
}

type DescribeAppImageConfigOutput added in v0.29.0

type DescribeAppImageConfigOutput struct {

	// The ARN of the AppImageConfig.
	AppImageConfigArn *string

	// The name of the AppImageConfig.
	AppImageConfigName *string

	// The configuration of the Code Editor app.
	CodeEditorAppImageConfig *types.CodeEditorAppImageConfig

	// When the AppImageConfig was created.
	CreationTime *time.Time

	// The configuration of the JupyterLab app.
	JupyterLabAppImageConfig *types.JupyterLabAppImageConfig

	// The configuration of a KernelGateway app.
	KernelGatewayImageConfig *types.KernelGatewayImageConfig

	// When the AppImageConfig was last modified.
	LastModifiedTime *time.Time

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

type DescribeAppInput

type DescribeAppInput struct {

	// The name of the app.
	//
	// This member is required.
	AppName *string

	// The type of app.
	//
	// This member is required.
	AppType types.AppType

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The name of the space.
	SpaceName *string

	// The user profile name. If this value is not set, then SpaceName must be set.
	UserProfileName *string
	// contains filtered or unexported fields
}

type DescribeAppOutput

type DescribeAppOutput struct {

	// The Amazon Resource Name (ARN) of the app.
	AppArn *string

	// The name of the app.
	AppName *string

	// The type of app.
	AppType types.AppType

	// The creation time of the application. After an application has been shut down
	// for 24 hours, SageMaker deletes all metadata for the application. To be
	// considered an update and retain application metadata, applications must be
	// restarted within 24 hours after the previous application has been shut down.
	// After this time window, creation of an application is considered a new
	// application rather than an update of the previous application.
	CreationTime *time.Time

	// The domain ID.
	DomainId *string

	// The failure reason.
	FailureReason *string

	// The timestamp of the last health check.
	LastHealthCheckTimestamp *time.Time

	// The timestamp of the last user's activity. LastUserActivityTimestamp is also
	// updated when SageMaker performs health checks without user activity. As a
	// result, this value is set to the same value as LastHealthCheckTimestamp .
	LastUserActivityTimestamp *time.Time

	// The instance type and the Amazon Resource Name (ARN) of the SageMaker image
	// created on the instance.
	ResourceSpec *types.ResourceSpec

	// The name of the space. If this value is not set, then UserProfileName must be
	// set.
	SpaceName *string

	// The status.
	Status types.AppStatus

	// The user profile name.
	UserProfileName *string

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

type DescribeArtifactInput added in v0.31.0

type DescribeArtifactInput struct {

	// The Amazon Resource Name (ARN) of the artifact to describe.
	//
	// This member is required.
	ArtifactArn *string
	// contains filtered or unexported fields
}

type DescribeArtifactOutput added in v0.31.0

type DescribeArtifactOutput struct {

	// The Amazon Resource Name (ARN) of the artifact.
	ArtifactArn *string

	// The name of the artifact.
	ArtifactName *string

	// The type of the artifact.
	ArtifactType *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// When the artifact was created.
	CreationTime *time.Time

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// When the artifact was last modified.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the lineage group.
	LineageGroupArn *string

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// A list of the artifact's properties.
	Properties map[string]string

	// The source of the artifact.
	Source *types.ArtifactSource

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

type DescribeAutoMLJobInput

type DescribeAutoMLJobInput struct {

	// Requests information about an AutoML job using its unique name.
	//
	// This member is required.
	AutoMLJobName *string
	// contains filtered or unexported fields
}

type DescribeAutoMLJobOutput

type DescribeAutoMLJobOutput struct {

	// Returns the ARN of the AutoML job.
	//
	// This member is required.
	AutoMLJobArn *string

	// Returns the name of the AutoML job.
	//
	// This member is required.
	AutoMLJobName *string

	// Returns the secondary status of the AutoML job.
	//
	// This member is required.
	AutoMLJobSecondaryStatus types.AutoMLJobSecondaryStatus

	// Returns the status of the AutoML job.
	//
	// This member is required.
	AutoMLJobStatus types.AutoMLJobStatus

	// Returns the creation time of the AutoML job.
	//
	// This member is required.
	CreationTime *time.Time

	// Returns the input data configuration for the AutoML job.
	//
	// This member is required.
	InputDataConfig []types.AutoMLChannel

	// Returns the job's last modified time.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// Returns the job's output data config.
	//
	// This member is required.
	OutputDataConfig *types.AutoMLOutputDataConfig

	// The ARN of the IAM role that has read permission to the input data location and
	// write permission to the output data location in Amazon S3.
	//
	// This member is required.
	RoleArn *string

	// Returns information on the job's artifacts found in AutoMLJobArtifacts .
	AutoMLJobArtifacts *types.AutoMLJobArtifacts

	// Returns the configuration for the AutoML job.
	AutoMLJobConfig *types.AutoMLJobConfig

	// Returns the job's objective.
	AutoMLJobObjective *types.AutoMLJobObjective

	// The best model candidate selected by SageMaker Autopilot using both the best
	// objective metric and lowest InferenceLatency (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-metrics-validation.html)
	// for an experiment.
	BestCandidate *types.AutoMLCandidate

	// Returns the end time of the AutoML job.
	EndTime *time.Time

	// Returns the failure reason for an AutoML job, when applicable.
	FailureReason *string

	// Indicates whether the output for an AutoML job generates candidate definitions
	// only.
	GenerateCandidateDefinitionsOnly *bool

	// Indicates whether the model was deployed automatically to an endpoint and the
	// name of that endpoint if deployed automatically.
	ModelDeployConfig *types.ModelDeployConfig

	// Provides information about endpoint for the model deployment.
	ModelDeployResult *types.ModelDeployResult

	// Returns a list of reasons for partial failures within an AutoML job.
	PartialFailureReasons []types.AutoMLPartialFailureReason

	// Returns the job's problem type.
	ProblemType types.ProblemType

	// Contains ProblemType , AutoMLJobObjective , and CompletionCriteria . If you do
	// not provide these values, they are inferred.
	ResolvedAttributes *types.ResolvedAttributes

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

type DescribeAutoMLJobV2Input added in v1.72.0

type DescribeAutoMLJobV2Input struct {

	// Requests information about an AutoML job V2 using its unique name.
	//
	// This member is required.
	AutoMLJobName *string
	// contains filtered or unexported fields
}

type DescribeAutoMLJobV2Output added in v1.72.0

type DescribeAutoMLJobV2Output struct {

	// Returns the Amazon Resource Name (ARN) of the AutoML job V2.
	//
	// This member is required.
	AutoMLJobArn *string

	// Returns an array of channel objects describing the input data and their
	// location.
	//
	// This member is required.
	AutoMLJobInputDataConfig []types.AutoMLJobChannel

	// Returns the name of the AutoML job V2.
	//
	// This member is required.
	AutoMLJobName *string

	// Returns the secondary status of the AutoML job V2.
	//
	// This member is required.
	AutoMLJobSecondaryStatus types.AutoMLJobSecondaryStatus

	// Returns the status of the AutoML job V2.
	//
	// This member is required.
	AutoMLJobStatus types.AutoMLJobStatus

	// Returns the creation time of the AutoML job V2.
	//
	// This member is required.
	CreationTime *time.Time

	// Returns the job's last modified time.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// Returns the job's output data config.
	//
	// This member is required.
	OutputDataConfig *types.AutoMLOutputDataConfig

	// The ARN of the IAM role that has read permission to the input data location and
	// write permission to the output data location in Amazon S3.
	//
	// This member is required.
	RoleArn *string

	// The artifacts that are generated during an AutoML job.
	AutoMLJobArtifacts *types.AutoMLJobArtifacts

	// Returns the job's objective.
	AutoMLJobObjective *types.AutoMLJobObjective

	// Returns the configuration settings of the problem type set for the AutoML job
	// V2.
	AutoMLProblemTypeConfig types.AutoMLProblemTypeConfig

	// Returns the name of the problem type configuration set for the AutoML job V2.
	AutoMLProblemTypeConfigName types.AutoMLProblemTypeConfigName

	// Information about the candidate produced by an AutoML training job V2,
	// including its status, steps, and other properties.
	BestCandidate *types.AutoMLCandidate

	// Returns the configuration settings of how the data are split into train and
	// validation datasets.
	DataSplitConfig *types.AutoMLDataSplitConfig

	// Returns the end time of the AutoML job V2.
	EndTime *time.Time

	// Returns the reason for the failure of the AutoML job V2, when applicable.
	FailureReason *string

	// Indicates whether the model was deployed automatically to an endpoint and the
	// name of that endpoint if deployed automatically.
	ModelDeployConfig *types.ModelDeployConfig

	// Provides information about endpoint for the model deployment.
	ModelDeployResult *types.ModelDeployResult

	// Returns a list of reasons for partial failures within an AutoML job V2.
	PartialFailureReasons []types.AutoMLPartialFailureReason

	// Returns the resolved attributes used by the AutoML job V2.
	ResolvedAttributes *types.AutoMLResolvedAttributes

	// Returns the security configuration for traffic encryption or Amazon VPC
	// settings.
	SecurityConfig *types.AutoMLSecurityConfig

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

type DescribeClusterInput added in v1.119.0

type DescribeClusterInput struct {

	// The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod
	// cluster.
	//
	// This member is required.
	ClusterName *string
	// contains filtered or unexported fields
}

type DescribeClusterNodeInput added in v1.119.0

type DescribeClusterNodeInput struct {

	// The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod
	// cluster in which the instance is.
	//
	// This member is required.
	ClusterName *string

	// The ID of the instance.
	//
	// This member is required.
	NodeId *string
	// contains filtered or unexported fields
}

type DescribeClusterNodeOutput added in v1.119.0

type DescribeClusterNodeOutput struct {

	// The details of the instance.
	//
	// This member is required.
	NodeDetails *types.ClusterNodeDetails

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

type DescribeClusterOutput added in v1.119.0

type DescribeClusterOutput struct {

	// The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.
	//
	// This member is required.
	ClusterArn *string

	// The status of the SageMaker HyperPod cluster.
	//
	// This member is required.
	ClusterStatus types.ClusterStatus

	// The instance groups of the SageMaker HyperPod cluster.
	//
	// This member is required.
	InstanceGroups []types.ClusterInstanceGroupDetails

	// The name of the SageMaker HyperPod cluster.
	ClusterName *string

	// The time when the SageMaker Cluster is created.
	CreationTime *time.Time

	// The failure message of the SageMaker HyperPod cluster.
	FailureMessage *string

	// Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,
	// hosted models, and compute resources have access to. You can control access to
	// and from your resources by configuring a VPC. For more information, see Give
	// SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html)
	// .
	VpcConfig *types.VpcConfig

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

type DescribeCodeRepositoryInput

type DescribeCodeRepositoryInput struct {

	// The name of the Git repository to describe.
	//
	// This member is required.
	CodeRepositoryName *string
	// contains filtered or unexported fields
}

type DescribeCodeRepositoryOutput

type DescribeCodeRepositoryOutput struct {

	// The Amazon Resource Name (ARN) of the Git repository.
	//
	// This member is required.
	CodeRepositoryArn *string

	// The name of the Git repository.
	//
	// This member is required.
	CodeRepositoryName *string

	// The date and time that the repository was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The date and time that the repository was last changed.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// Configuration details about the repository, including the URL where the
	// repository is located, the default branch, and the Amazon Resource Name (ARN) of
	// the Amazon Web Services Secrets Manager secret that contains the credentials
	// used to access the repository.
	GitConfig *types.GitConfig

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

type DescribeCompilationJobInput

type DescribeCompilationJobInput struct {

	// The name of the model compilation job that you want information about.
	//
	// This member is required.
	CompilationJobName *string
	// contains filtered or unexported fields
}

type DescribeCompilationJobOutput

type DescribeCompilationJobOutput struct {

	// The Amazon Resource Name (ARN) of the model compilation job.
	//
	// This member is required.
	CompilationJobArn *string

	// The name of the model compilation job.
	//
	// This member is required.
	CompilationJobName *string

	// The status of the model compilation job.
	//
	// This member is required.
	CompilationJobStatus types.CompilationJobStatus

	// The time that the model compilation job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// If a model compilation job failed, the reason it failed.
	//
	// This member is required.
	FailureReason *string

	// Information about the location in Amazon S3 of the input model artifacts, the
	// name and shape of the expected data inputs, and the framework in which the model
	// was trained.
	//
	// This member is required.
	InputConfig *types.InputConfig

	// The time that the status of the model compilation job was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// Information about the location in Amazon S3 that has been configured for
	// storing the model artifacts used in the compilation job.
	//
	// This member is required.
	ModelArtifacts *types.ModelArtifacts

	// Information about the output location for the compiled model and the target
	// device that the model runs on.
	//
	// This member is required.
	OutputConfig *types.OutputConfig

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to
	// perform the model compilation job.
	//
	// This member is required.
	RoleArn *string

	// Specifies a limit to how long a model compilation job can run. When the job
	// reaches the time limit, Amazon SageMaker ends the compilation job. Use this API
	// to cap model training costs.
	//
	// This member is required.
	StoppingCondition *types.StoppingCondition

	// The time when the model compilation job on a compilation job instance ended.
	// For a successful or stopped job, this is when the job's model artifacts have
	// finished uploading. For a failed job, this is when Amazon SageMaker detected
	// that the job failed.
	CompilationEndTime *time.Time

	// The time when the model compilation job started the CompilationJob instances.
	// You are billed for the time between this timestamp and the timestamp in the
	// CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be
	// later than this time. That's because it takes time to download the compilation
	// job, which depends on the size of the compilation job container.
	CompilationStartTime *time.Time

	// Information that SageMaker Neo automatically derived about the model.
	DerivedInformation *types.DerivedInformation

	// The inference image to use when compiling a model. Specify an image only if the
	// target device is a cloud instance.
	InferenceImage *string

	// Provides a BLAKE2 hash value that identifies the compiled model artifacts in
	// Amazon S3.
	ModelDigests *types.ModelDigests

	// The Amazon Resource Name (ARN) of the versioned model package that was provided
	// to SageMaker Neo when you initiated a compilation job.
	ModelPackageVersionArn *string

	// A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)
	// object that specifies the VPC that you want your compilation job to connect to.
	// Control access to your models by configuring the VPC. For more information, see
	// Protect Compilation Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html)
	// .
	VpcConfig *types.NeoVpcConfig

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

type DescribeContextInput added in v0.31.0

type DescribeContextInput struct {

	// The name of the context to describe.
	//
	// This member is required.
	ContextName *string
	// contains filtered or unexported fields
}

type DescribeContextOutput added in v0.31.0

type DescribeContextOutput struct {

	// The Amazon Resource Name (ARN) of the context.
	ContextArn *string

	// The name of the context.
	ContextName *string

	// The type of the context.
	ContextType *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// When the context was created.
	CreationTime *time.Time

	// The description of the context.
	Description *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// When the context was last modified.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the lineage group.
	LineageGroupArn *string

	// A list of the context's properties.
	Properties map[string]string

	// The source of the context.
	Source *types.ContextSource

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

type DescribeDataQualityJobDefinitionInput added in v0.31.0

type DescribeDataQualityJobDefinitionInput struct {

	// The name of the data quality monitoring job definition to describe.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DescribeDataQualityJobDefinitionOutput added in v0.31.0

type DescribeDataQualityJobDefinitionOutput struct {

	// The time that the data quality monitoring job definition was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Information about the container that runs the data quality monitoring job.
	//
	// This member is required.
	DataQualityAppSpecification *types.DataQualityAppSpecification

	// The list of inputs for the data quality monitoring job. Currently endpoints are
	// supported.
	//
	// This member is required.
	DataQualityJobInput *types.DataQualityJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	DataQualityJobOutputConfig *types.MonitoringOutputConfig

	// The Amazon Resource Name (ARN) of the data quality monitoring job definition.
	//
	// This member is required.
	JobDefinitionArn *string

	// The name of the data quality monitoring job definition.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The constraints and baselines for the data quality monitoring job definition.
	DataQualityBaselineConfig *types.DataQualityBaselineConfig

	// The networking configuration for the data quality monitoring job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

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

type DescribeDeviceFleetInput added in v0.31.0

type DescribeDeviceFleetInput struct {

	// The name of the fleet.
	//
	// This member is required.
	DeviceFleetName *string
	// contains filtered or unexported fields
}

type DescribeDeviceFleetOutput added in v0.31.0

type DescribeDeviceFleetOutput struct {

	// Timestamp of when the device fleet was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	DeviceFleetArn *string

	// The name of the fleet.
	//
	// This member is required.
	DeviceFleetName *string

	// Timestamp of when the device fleet was last updated.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The output configuration for storing sampled data.
	//
	// This member is required.
	OutputConfig *types.EdgeOutputConfig

	// A description of the fleet.
	Description *string

	// The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of
	// Things (IoT).
	IotRoleAlias *string

	// The Amazon Resource Name (ARN) that has access to Amazon Web Services Internet
	// of Things (IoT).
	RoleArn *string

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

type DescribeDeviceInput added in v0.31.0

type DescribeDeviceInput struct {

	// The name of the fleet the devices belong to.
	//
	// This member is required.
	DeviceFleetName *string

	// The unique ID of the device.
	//
	// This member is required.
	DeviceName *string

	// Next token of device description.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeDeviceOutput added in v0.31.0

type DescribeDeviceOutput struct {

	// The name of the fleet the device belongs to.
	//
	// This member is required.
	DeviceFleetName *string

	// The unique identifier of the device.
	//
	// This member is required.
	DeviceName *string

	// The timestamp of the last registration or de-reregistration.
	//
	// This member is required.
	RegistrationTime *time.Time

	// Edge Manager agent version.
	AgentVersion *string

	// A description of the device.
	Description *string

	// The Amazon Resource Name (ARN) of the device.
	DeviceArn *string

	// The Amazon Web Services Internet of Things (IoT) object thing name associated
	// with the device.
	IotThingName *string

	// The last heartbeat received from the device.
	LatestHeartbeat *time.Time

	// The maximum number of models.
	MaxModels *int32

	// Models on the device.
	Models []types.EdgeModel

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string

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

type DescribeDomainInput

type DescribeDomainInput struct {

	// The domain ID.
	//
	// This member is required.
	DomainId *string
	// contains filtered or unexported fields
}

type DescribeDomainOutput

type DescribeDomainOutput struct {

	// Specifies the VPC used for non-EFS traffic. The default value is
	// PublicInternetOnly .
	//   - PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon
	//   SageMaker, which allows direct internet access
	//   - VpcOnly - All traffic is through the specified VPC and subnets
	AppNetworkAccessType types.AppNetworkAccessType

	// The entity that creates and manages the required security groups for inter-app
	// communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType
	// is VPCOnly and
	// DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.
	AppSecurityGroupManagement types.AppSecurityGroupManagement

	// The domain's authentication mode.
	AuthMode types.AuthMode

	// The creation time.
	CreationTime *time.Time

	// The default settings used to create a space.
	DefaultSpaceSettings *types.DefaultSpaceSettings

	// Settings which are applied to UserProfiles in this domain if settings are not
	// explicitly specified in a given UserProfile.
	DefaultUserSettings *types.UserSettings

	// The domain's Amazon Resource Name (ARN).
	DomainArn *string

	// The domain ID.
	DomainId *string

	// The domain name.
	DomainName *string

	// A collection of Domain settings.
	DomainSettings *types.DomainSettings

	// The failure reason.
	FailureReason *string

	// The ID of the Amazon Elastic File System managed by this Domain.
	HomeEfsFileSystemId *string

	// Use KmsKeyId .
	//
	// Deprecated: This property is deprecated, use KmsKeyId instead.
	HomeEfsFileSystemKmsKeyId *string

	// The Amazon Web Services KMS customer managed key used to encrypt the EFS volume
	// attached to the domain.
	KmsKeyId *string

	// The last modified time.
	LastModifiedTime *time.Time

	// The ID of the security group that authorizes traffic between the RSessionGateway
	// apps and the RStudioServerPro app.
	SecurityGroupIdForDomainBoundary *string

	// The ARN of the application managed by SageMaker in IAM Identity Center. This
	// value is only returned for domains created after October 1, 2023.
	SingleSignOnApplicationArn *string

	// The IAM Identity Center managed application instance ID.
	SingleSignOnManagedApplicationInstanceId *string

	// The status.
	Status types.DomainStatus

	// The VPC subnets that the domain uses for communication.
	SubnetIds []string

	// The domain's URL.
	Url *string

	// The ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for
	// communication.
	VpcId *string

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

type DescribeEdgeDeploymentPlanInput added in v1.37.0

type DescribeEdgeDeploymentPlanInput struct {

	// The name of the deployment plan to describe.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// The maximum number of results to select (50 by default).
	MaxResults *int32

	// If the edge deployment plan has enough stages to require tokening, then this is
	// the response from the last list of stages returned.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeEdgeDeploymentPlanOutput added in v1.37.0

type DescribeEdgeDeploymentPlanOutput struct {

	// The device fleet used for this edge deployment plan.
	//
	// This member is required.
	DeviceFleetName *string

	// The ARN of edge deployment plan.
	//
	// This member is required.
	EdgeDeploymentPlanArn *string

	// The name of the edge deployment plan.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// List of models associated with the edge deployment plan.
	//
	// This member is required.
	ModelConfigs []types.EdgeDeploymentModelConfig

	// List of stages in the edge deployment plan.
	//
	// This member is required.
	Stages []types.DeploymentStageStatusSummary

	// The time when the edge deployment plan was created.
	CreationTime *time.Time

	// The number of edge devices that failed the deployment.
	EdgeDeploymentFailed *int32

	// The number of edge devices yet to pick up deployment, or in progress.
	EdgeDeploymentPending *int32

	// The number of edge devices with the successful deployment.
	EdgeDeploymentSuccess *int32

	// The time when the edge deployment plan was last updated.
	LastModifiedTime *time.Time

	// Token to use when calling the next set of stages in the edge deployment plan.
	NextToken *string

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

type DescribeEdgePackagingJobInput added in v0.31.0

type DescribeEdgePackagingJobInput struct {

	// The name of the edge packaging job.
	//
	// This member is required.
	EdgePackagingJobName *string
	// contains filtered or unexported fields
}

type DescribeEdgePackagingJobOutput added in v0.31.0

type DescribeEdgePackagingJobOutput struct {

	// The Amazon Resource Name (ARN) of the edge packaging job.
	//
	// This member is required.
	EdgePackagingJobArn *string

	// The name of the edge packaging job.
	//
	// This member is required.
	EdgePackagingJobName *string

	// The current status of the packaging job.
	//
	// This member is required.
	EdgePackagingJobStatus types.EdgePackagingJobStatus

	// The name of the SageMaker Neo compilation job that is used to locate model
	// artifacts that are being packaged.
	CompilationJobName *string

	// The timestamp of when the packaging job was created.
	CreationTime *time.Time

	// Returns a message describing the job status and error messages.
	EdgePackagingJobStatusMessage *string

	// The timestamp of when the job was last updated.
	LastModifiedTime *time.Time

	// The Amazon Simple Storage (S3) URI where model artifacts ares stored.
	ModelArtifact *string

	// The name of the model.
	ModelName *string

	// The signature document of files in the model artifact.
	ModelSignature *string

	// The version of the model.
	ModelVersion *string

	// The output configuration for the edge packaging job.
	OutputConfig *types.EdgeOutputConfig

	// The output of a SageMaker Edge Manager deployable resource.
	PresetDeploymentOutput *types.EdgePresetDeploymentOutput

	// The Amazon Web Services KMS key to use when encrypting the EBS volume the job
	// run on.
	ResourceKey *string

	// The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to
	// download and upload the model, and to contact Neo.
	RoleArn *string

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

type DescribeEndpointAPIClient added in v1.9.0

type DescribeEndpointAPIClient interface {
	DescribeEndpoint(context.Context, *DescribeEndpointInput, ...func(*Options)) (*DescribeEndpointOutput, error)
}

DescribeEndpointAPIClient is a client that implements the DescribeEndpoint operation.

type DescribeEndpointConfigInput

type DescribeEndpointConfigInput struct {

	// The name of the endpoint configuration.
	//
	// This member is required.
	EndpointConfigName *string
	// contains filtered or unexported fields
}

type DescribeEndpointConfigOutput

type DescribeEndpointConfigOutput struct {

	// A timestamp that shows when the endpoint configuration was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the endpoint configuration.
	//
	// This member is required.
	EndpointConfigArn *string

	// Name of the SageMaker endpoint configuration.
	//
	// This member is required.
	EndpointConfigName *string

	// An array of ProductionVariant objects, one for each model that you want to host
	// at this endpoint.
	//
	// This member is required.
	ProductionVariants []types.ProductionVariant

	// Returns the description of an endpoint configuration created using the
	// CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html)
	// API.
	AsyncInferenceConfig *types.AsyncInferenceConfig

	// Configuration to control how SageMaker captures inference data.
	DataCaptureConfig *types.DataCaptureConfig

	// Indicates whether all model containers deployed to the endpoint are isolated.
	// If they are, no inbound or outbound network calls can be made to or from the
	// model containers.
	EnableNetworkIsolation *bool

	// The Amazon Resource Name (ARN) of the IAM role that you assigned to the
	// endpoint configuration.
	ExecutionRoleArn *string

	// The configuration parameters for an explainer.
	ExplainerConfig *types.ExplainerConfig

	// Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when
	// storing it on the ML storage volume attached to the instance.
	KmsKeyId *string

	// An array of ProductionVariant objects, one for each model that you want to host
	// at this endpoint in shadow mode with production traffic replicated from the
	// model specified on ProductionVariants .
	ShadowProductionVariants []types.ProductionVariant

	// Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,
	// hosted models, and compute resources have access to. You can control access to
	// and from your resources by configuring a VPC. For more information, see Give
	// SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html)
	// .
	VpcConfig *types.VpcConfig

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

type DescribeEndpointInput

type DescribeEndpointInput struct {

	// The name of the endpoint.
	//
	// This member is required.
	EndpointName *string
	// contains filtered or unexported fields
}

type DescribeEndpointOutput

type DescribeEndpointOutput struct {

	// A timestamp that shows when the endpoint was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the endpoint.
	//
	// This member is required.
	EndpointArn *string

	// Name of the endpoint.
	//
	// This member is required.
	EndpointName *string

	// The status of the endpoint.
	//   - OutOfService : Endpoint is not available to take incoming requests.
	//   - Creating : CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)
	//   is executing.
	//   - Updating : UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html)
	//   or UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)
	//   is executing.
	//   - SystemUpdating : Endpoint is undergoing maintenance and cannot be updated or
	//   deleted or re-scaled until it has completed. This maintenance operation does not
	//   change any customer-specified values such as VPC config, KMS encryption, model,
	//   instance type, or instance count.
	//   - RollingBack : Endpoint fails to scale up or down or change its variant
	//   weight and is in the process of rolling back to its previous configuration. Once
	//   the rollback completes, endpoint returns to an InService status. This
	//   transitional status only applies to an endpoint that has autoscaling enabled and
	//   is undergoing variant weight or capacity changes as part of an
	//   UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)
	//   call or when the UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)
	//   operation is called explicitly.
	//   - InService : Endpoint is available to process incoming requests.
	//   - Deleting : DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html)
	//   is executing.
	//   - Failed : Endpoint could not be created, updated, or re-scaled. Use the
	//   FailureReason value returned by DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html)
	//   for information about the failure. DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html)
	//   is the only operation that can be performed on a failed endpoint.
	//   - UpdateRollbackFailed : Both the rolling deployment and auto-rollback failed.
	//   Your endpoint is in service with a mix of the old and new endpoint
	//   configurations. For information about how to remedy this issue and restore the
	//   endpoint's status to InService , see Rolling Deployments (https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html)
	//   .
	//
	// This member is required.
	EndpointStatus types.EndpointStatus

	// A timestamp that shows when the endpoint was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// Returns the description of an endpoint configuration created using the
	// CreateEndpointConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html)
	// API.
	AsyncInferenceConfig *types.AsyncInferenceConfig

	// The currently active data capture configuration used by your Endpoint.
	DataCaptureConfig *types.DataCaptureConfigSummary

	// The name of the endpoint configuration associated with this endpoint.
	EndpointConfigName *string

	// The configuration parameters for an explainer.
	ExplainerConfig *types.ExplainerConfig

	// If the status of the endpoint is Failed , the reason why it failed.
	FailureReason *string

	// The most recent deployment configuration for the endpoint.
	LastDeploymentConfig *types.DeploymentConfig

	// Returns the summary of an in-progress deployment. This field is only returned
	// when the endpoint is creating or updating with a new endpoint configuration.
	PendingDeploymentSummary *types.PendingDeploymentSummary

	// An array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html)
	// objects, one for each model hosted behind this endpoint.
	ProductionVariants []types.ProductionVariantSummary

	// An array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html)
	// objects, one for each model that you want to host at this endpoint in shadow
	// mode with production traffic replicated from the model specified on
	// ProductionVariants .
	ShadowProductionVariants []types.ProductionVariantSummary

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

type DescribeExperimentInput

type DescribeExperimentInput struct {

	// The name of the experiment to describe.
	//
	// This member is required.
	ExperimentName *string
	// contains filtered or unexported fields
}

type DescribeExperimentOutput

type DescribeExperimentOutput struct {

	// Who created the experiment.
	CreatedBy *types.UserContext

	// When the experiment was created.
	CreationTime *time.Time

	// The description of the experiment.
	Description *string

	// The name of the experiment as displayed. If DisplayName isn't specified,
	// ExperimentName is displayed.
	DisplayName *string

	// The Amazon Resource Name (ARN) of the experiment.
	ExperimentArn *string

	// The name of the experiment.
	ExperimentName *string

	// Who last modified the experiment.
	LastModifiedBy *types.UserContext

	// When the experiment was last modified.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the source and, optionally, the type.
	Source *types.ExperimentSource

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

type DescribeFeatureGroupInput added in v0.31.0

type DescribeFeatureGroupInput struct {

	// The name or Amazon Resource Name (ARN) of the FeatureGroup you want described.
	//
	// This member is required.
	FeatureGroupName *string

	// A token to resume pagination of the list of Features ( FeatureDefinitions ).
	// 2,500 Features are returned by default.
	NextToken *string
	// contains filtered or unexported fields
}

type DescribeFeatureGroupOutput added in v0.31.0

type DescribeFeatureGroupOutput struct {

	// A timestamp indicating when SageMaker created the FeatureGroup .
	//
	// This member is required.
	CreationTime *time.Time

	// The name of the feature that stores the EventTime of a Record in a FeatureGroup
	// . An EventTime is a point in time when a new event occurs that corresponds to
	// the creation or update of a Record in a FeatureGroup . All Records in the
	// FeatureGroup have a corresponding EventTime .
	//
	// This member is required.
	EventTimeFeatureName *string

	// A list of the Features in the FeatureGroup . Each feature is defined by a
	// FeatureName and FeatureType .
	//
	// This member is required.
	FeatureDefinitions []types.FeatureDefinition

	// The Amazon Resource Name (ARN) of the FeatureGroup .
	//
	// This member is required.
	FeatureGroupArn *string

	// he name of the FeatureGroup .
	//
	// This member is required.
	FeatureGroupName *string

	// A token to resume pagination of the list of Features ( FeatureDefinitions ).
	//
	// This member is required.
	NextToken *string

	// The name of the Feature used for RecordIdentifier , whose value uniquely
	// identifies a record stored in the feature store.
	//
	// This member is required.
	RecordIdentifierFeatureName *string

	// A free form description of the feature group.
	Description *string

	// The reason that the FeatureGroup failed to be replicated in the OfflineStore .
	// This is failure can occur because:
	//   - The FeatureGroup could not be created in the OfflineStore .
	//   - The FeatureGroup could not be deleted from the OfflineStore .
	FailureReason *string

	// The status of the feature group.
	FeatureGroupStatus types.FeatureGroupStatus

	// A timestamp indicating when the feature group was last updated.
	LastModifiedTime *time.Time

	// A value indicating whether the update made to the feature group was successful.
	LastUpdateStatus *types.LastUpdateStatus

	// The configuration of the offline store. It includes the following
	// configurations:
	//   - Amazon S3 location of the offline store.
	//   - Configuration of the Glue data catalog.
	//   - Table format of the offline store.
	//   - Option to disable the automatic creation of a Glue table for the offline
	//   store.
	//   - Encryption configuration.
	OfflineStoreConfig *types.OfflineStoreConfig

	// The status of the OfflineStore . Notifies you if replicating data into the
	// OfflineStore has failed. Returns either: Active or Blocked
	OfflineStoreStatus *types.OfflineStoreStatus

	// The configuration for the OnlineStore .
	OnlineStoreConfig *types.OnlineStoreConfig

	// The size of the OnlineStore in bytes.
	OnlineStoreTotalSizeBytes *int64

	// The Amazon Resource Name (ARN) of the IAM execution role used to persist data
	// into the OfflineStore if an OfflineStoreConfig is provided.
	RoleArn *string

	// Active throughput configuration of the feature group. There are two modes:
	// ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads
	// and writes that your application performs on your feature group. You do not need
	// to specify read and write throughput because Feature Store accommodates your
	// workloads as they ramp up and down. You can switch a feature group to on-demand
	// only once in a 24 hour period. With provisioned throughput mode, you specify the
	// read and write capacity per second that you expect your application to require,
	// and you are billed based on those limits. Exceeding provisioned throughput will
	// result in your requests being throttled. Note: PROVISIONED throughput mode is
	// supported only for feature groups that are offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType)
	// tier online store.
	ThroughputConfig *types.ThroughputConfigDescription

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

type DescribeFeatureMetadataInput added in v1.34.0

type DescribeFeatureMetadataInput struct {

	// The name or Amazon Resource Name (ARN) of the feature group containing the
	// feature.
	//
	// This member is required.
	FeatureGroupName *string

	// The name of the feature.
	//
	// This member is required.
	FeatureName *string
	// contains filtered or unexported fields
}

type DescribeFeatureMetadataOutput added in v1.34.0

type DescribeFeatureMetadataOutput struct {

	// A timestamp indicating when the feature was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Number (ARN) of the feature group that contains the feature.
	//
	// This member is required.
	FeatureGroupArn *string

	// The name of the feature group that you've specified.
	//
	// This member is required.
	FeatureGroupName *string

	// The name of the feature that you've specified.
	//
	// This member is required.
	FeatureName *string

	// The data type of the feature.
	//
	// This member is required.
	FeatureType types.FeatureType

	// A timestamp indicating when the metadata for the feature group was modified.
	// For example, if you add a parameter describing the feature, the timestamp
	// changes to reflect the last time you
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The description you added to describe the feature.
	Description *string

	// The key-value pairs that you added to describe the feature.
	Parameters []types.FeatureParameter

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

type DescribeFlowDefinitionInput

type DescribeFlowDefinitionInput struct {

	// The name of the flow definition.
	//
	// This member is required.
	FlowDefinitionName *string
	// contains filtered or unexported fields
}

type DescribeFlowDefinitionOutput

type DescribeFlowDefinitionOutput struct {

	// The timestamp when the flow definition was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the flow defintion.
	//
	// This member is required.
	FlowDefinitionArn *string

	// The Amazon Resource Name (ARN) of the flow definition.
	//
	// This member is required.
	FlowDefinitionName *string

	// The status of the flow definition. Valid values are listed below.
	//
	// This member is required.
	FlowDefinitionStatus types.FlowDefinitionStatus

	// An object containing information about the output file.
	//
	// This member is required.
	OutputConfig *types.FlowDefinitionOutputConfig

	// The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access
	// Management (IAM) execution role for the flow definition.
	//
	// This member is required.
	RoleArn *string

	// The reason your flow definition failed.
	FailureReason *string

	// An object containing information about what triggers a human review workflow.
	HumanLoopActivationConfig *types.HumanLoopActivationConfig

	// An object containing information about who works on the task, the workforce
	// task price, and other task details.
	HumanLoopConfig *types.HumanLoopConfig

	// Container for configuring the source of human task requests. Used to specify if
	// Amazon Rekognition or Amazon Textract is used as an integration source.
	HumanLoopRequestSource *types.HumanLoopRequestSource

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

type DescribeHubContentInput added in v1.56.0

type DescribeHubContentInput struct {

	// The name of the content to describe.
	//
	// This member is required.
	HubContentName *string

	// The type of content in the hub.
	//
	// This member is required.
	HubContentType types.HubContentType

	// The name of the hub that contains the content to describe.
	//
	// This member is required.
	HubName *string

	// The version of the content to describe.
	HubContentVersion *string
	// contains filtered or unexported fields
}

type DescribeHubContentOutput added in v1.56.0

type DescribeHubContentOutput struct {

	// The date and time that hub content was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The document schema version for the hub content.
	//
	// This member is required.
	DocumentSchemaVersion *string

	// The Amazon Resource Name (ARN) of the hub that contains the content.
	//
	// This member is required.
	HubArn *string

	// The Amazon Resource Name (ARN) of the hub content.
	//
	// This member is required.
	HubContentArn *string

	// The hub content document that describes information about the hub content such
	// as type, associated containers, scripts, and more.
	//
	// This member is required.
	HubContentDocument *string

	// The name of the hub content.
	//
	// This member is required.
	HubContentName *string

	// The status of the hub content.
	//
	// This member is required.
	HubContentStatus types.HubContentStatus

	// The type of hub content.
	//
	// This member is required.
	HubContentType types.HubContentType

	// The version of the hub content.
	//
	// This member is required.
	HubContentVersion *string

	// The name of the hub that contains the content.
	//
	// This member is required.
	HubName *string

	// The failure reason if importing hub content failed.
	FailureReason *string

	// The location of any dependencies that the hub content has, such as scripts,
	// model artifacts, datasets, or notebooks.
	HubContentDependencies []types.HubContentDependency

	// A description of the hub content.
	HubContentDescription *string

	// The display name of the hub content.
	HubContentDisplayName *string

	// A string that provides a description of the hub content. This string can
	// include links, tables, and standard markdown formating.
	HubContentMarkdown *string

	// The searchable keywords for the hub content.
	HubContentSearchKeywords []string

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

type DescribeHubInput added in v1.56.0

type DescribeHubInput struct {

	// The name of the hub to describe.
	//
	// This member is required.
	HubName *string
	// contains filtered or unexported fields
}

type DescribeHubOutput added in v1.56.0

type DescribeHubOutput struct {

	// The date and time that the hub was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the hub.
	//
	// This member is required.
	HubArn *string

	// The name of the hub.
	//
	// This member is required.
	HubName *string

	// The status of the hub.
	//
	// This member is required.
	HubStatus types.HubStatus

	// The date and time that the hub was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The failure reason if importing hub content failed.
	FailureReason *string

	// A description of the hub.
	HubDescription *string

	// The display name of the hub.
	HubDisplayName *string

	// The searchable keywords for the hub.
	HubSearchKeywords []string

	// The Amazon S3 storage configuration for the hub.
	S3StorageConfig *types.HubS3StorageConfig

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

type DescribeHumanTaskUiInput

type DescribeHumanTaskUiInput struct {

	// The name of the human task user interface (worker task template) you want
	// information about.
	//
	// This member is required.
	HumanTaskUiName *string
	// contains filtered or unexported fields
}

type DescribeHumanTaskUiOutput

type DescribeHumanTaskUiOutput struct {

	// The timestamp when the human task user interface was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the human task user interface (worker task
	// template).
	//
	// This member is required.
	HumanTaskUiArn *string

	// The name of the human task user interface (worker task template).
	//
	// This member is required.
	HumanTaskUiName *string

	// Container for user interface template information.
	//
	// This member is required.
	UiTemplate *types.UiTemplateInfo

	// The status of the human task user interface (worker task template). Valid
	// values are listed below.
	HumanTaskUiStatus types.HumanTaskUiStatus

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

type DescribeHyperParameterTuningJobInput

type DescribeHyperParameterTuningJobInput struct {

	// The name of the tuning job.
	//
	// This member is required.
	HyperParameterTuningJobName *string
	// contains filtered or unexported fields
}

type DescribeHyperParameterTuningJobOutput

type DescribeHyperParameterTuningJobOutput struct {

	// The date and time that the tuning job started.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the tuning job.
	//
	// This member is required.
	HyperParameterTuningJobArn *string

	// The HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html)
	// object that specifies the configuration of the tuning job.
	//
	// This member is required.
	HyperParameterTuningJobConfig *types.HyperParameterTuningJobConfig

	// The name of the hyperparameter tuning job.
	//
	// This member is required.
	HyperParameterTuningJobName *string

	// The status of the tuning job.
	//
	// This member is required.
	HyperParameterTuningJobStatus types.HyperParameterTuningJobStatus

	// The ObjectiveStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html)
	// object that specifies the number of training jobs, categorized by the status of
	// their final objective metric, that this tuning job launched.
	//
	// This member is required.
	ObjectiveStatusCounters *types.ObjectiveStatusCounters

	// The TrainingJobStatusCounters (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html)
	// object that specifies the number of training jobs, categorized by status, that
	// this tuning job launched.
	//
	// This member is required.
	TrainingJobStatusCounters *types.TrainingJobStatusCounters

	// A flag to indicate if autotune is enabled for the hyperparameter tuning job.
	Autotune *types.Autotune

	// A TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)
	// object that describes the training job that completed with the best current
	// HyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html)
	// .
	BestTrainingJob *types.HyperParameterTrainingJobSummary

	// The total resources consumed by your hyperparameter tuning job.
	ConsumedResources *types.HyperParameterTuningJobConsumedResources

	// If the tuning job failed, the reason it failed.
	FailureReason *string

	// The date and time that the tuning job ended.
	HyperParameterTuningEndTime *time.Time

	// The date and time that the status of the tuning job was modified.
	LastModifiedTime *time.Time

	// If the hyperparameter tuning job is an warm start tuning job with a
	// WarmStartType of IDENTICAL_DATA_AND_ALGORITHM , this is the TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)
	// for the training job with the best objective metric value of all training jobs
	// launched by this tuning job and all parent jobs specified for the warm start
	// tuning job.
	OverallBestTrainingJob *types.HyperParameterTrainingJobSummary

	// The HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)
	// object that specifies the definition of the training jobs that this tuning job
	// launches.
	TrainingJobDefinition *types.HyperParameterTrainingJobDefinition

	// A list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)
	// objects launched for this tuning job.
	TrainingJobDefinitions []types.HyperParameterTrainingJobDefinition

	// Tuning job completion information returned as the response from a
	// hyperparameter tuning job. This information tells if your tuning job has or has
	// not converged. It also includes the number of training jobs that have not
	// improved model performance as evaluated against the objective function.
	TuningJobCompletionDetails *types.HyperParameterTuningJobCompletionDetails

	// The configuration for starting the hyperparameter parameter tuning job using
	// one or more previous tuning jobs as a starting point. The results of previous
	// tuning jobs are used to inform which combinations of hyperparameters to search
	// over in the new tuning job.
	WarmStartConfig *types.HyperParameterTuningJobWarmStartConfig

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

type DescribeImageAPIClient added in v1.11.0

type DescribeImageAPIClient interface {
	DescribeImage(context.Context, *DescribeImageInput, ...func(*Options)) (*DescribeImageOutput, error)
}

DescribeImageAPIClient is a client that implements the DescribeImage operation.

type DescribeImageInput added in v0.29.0

type DescribeImageInput struct {

	// The name of the image to describe.
	//
	// This member is required.
	ImageName *string
	// contains filtered or unexported fields
}

type DescribeImageOutput added in v0.29.0

type DescribeImageOutput struct {

	// When the image was created.
	CreationTime *time.Time

	// The description of the image.
	Description *string

	// The name of the image as displayed.
	DisplayName *string

	// When a create, update, or delete operation fails, the reason for the failure.
	FailureReason *string

	// The ARN of the image.
	ImageArn *string

	// The name of the image.
	ImageName *string

	// The status of the image.
	ImageStatus types.ImageStatus

	// When the image was last modified.
	LastModifiedTime *time.Time

	// The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your
	// behalf.
	RoleArn *string

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

type DescribeImageVersionAPIClient added in v1.11.0

type DescribeImageVersionAPIClient interface {
	DescribeImageVersion(context.Context, *DescribeImageVersionInput, ...func(*Options)) (*DescribeImageVersionOutput, error)
}

DescribeImageVersionAPIClient is a client that implements the DescribeImageVersion operation.

type DescribeImageVersionInput added in v0.29.0

type DescribeImageVersionInput struct {

	// The name of the image.
	//
	// This member is required.
	ImageName *string

	// The alias of the image version.
	Alias *string

	// The version of the image. If not specified, the latest version is described.
	Version *int32
	// contains filtered or unexported fields
}

type DescribeImageVersionOutput added in v0.29.0

type DescribeImageVersionOutput struct {

	// The registry path of the container image on which this image version is based.
	BaseImage *string

	// The registry path of the container image that contains this image version.
	ContainerImage *string

	// When the version was created.
	CreationTime *time.Time

	// When a create or delete operation fails, the reason for the failure.
	FailureReason *string

	// Indicates Horovod compatibility.
	Horovod *bool

	// The ARN of the image the version is based on.
	ImageArn *string

	// The ARN of the version.
	ImageVersionArn *string

	// The status of the version.
	ImageVersionStatus types.ImageVersionStatus

	// Indicates SageMaker job type compatibility.
	//   - TRAINING : The image version is compatible with SageMaker training jobs.
	//   - INFERENCE : The image version is compatible with SageMaker inference jobs.
	//   - NOTEBOOK_KERNEL : The image version is compatible with SageMaker notebook
	//   kernels.
	JobType types.JobType

	// When the version was last modified.
	LastModifiedTime *time.Time

	// The machine learning framework vended in the image version.
	MLFramework *string

	// Indicates CPU or GPU compatibility.
	//   - CPU : The image version is compatible with CPU.
	//   - GPU : The image version is compatible with GPU.
	Processor types.Processor

	// The supported programming language and its version.
	ProgrammingLang *string

	// The maintainer description of the image version.
	ReleaseNotes *string

	// The stability of the image version specified by the maintainer.
	//   - NOT_PROVIDED : The maintainers did not provide a status for image version
	//   stability.
	//   - STABLE : The image version is stable.
	//   - TO_BE_ARCHIVED : The image version is set to be archived. Custom image
	//   versions that are set to be archived are automatically archived after three
	//   months.
	//   - ARCHIVED : The image version is archived. Archived image versions are not
	//   searchable and are no longer actively supported.
	VendorGuidance types.VendorGuidance

	// The version number.
	Version *int32

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

type DescribeInferenceComponentInput added in v1.119.0

type DescribeInferenceComponentInput struct {

	// The name of the inference component.
	//
	// This member is required.
	InferenceComponentName *string
	// contains filtered or unexported fields
}

type DescribeInferenceComponentOutput added in v1.119.0

type DescribeInferenceComponentOutput struct {

	// The time when the inference component was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the endpoint that hosts the inference
	// component.
	//
	// This member is required.
	EndpointArn *string

	// The name of the endpoint that hosts the inference component.
	//
	// This member is required.
	EndpointName *string

	// The Amazon Resource Name (ARN) of the inference component.
	//
	// This member is required.
	InferenceComponentArn *string

	// The name of the inference component.
	//
	// This member is required.
	InferenceComponentName *string

	// The time when the inference component was last updated.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// If the inference component status is Failed , the reason for the failure.
	FailureReason *string

	// The status of the inference component.
	InferenceComponentStatus types.InferenceComponentStatus

	// Details about the runtime settings for the model that is deployed with the
	// inference component.
	RuntimeConfig *types.InferenceComponentRuntimeConfigSummary

	// Details about the resources that are deployed with this inference component.
	Specification *types.InferenceComponentSpecificationSummary

	// The name of the production variant that hosts the inference component.
	VariantName *string

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

type DescribeInferenceExperimentInput added in v1.56.0

type DescribeInferenceExperimentInput struct {

	// The name of the inference experiment to describe.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type DescribeInferenceExperimentOutput added in v1.56.0

type DescribeInferenceExperimentOutput struct {

	// The ARN of the inference experiment being described.
	//
	// This member is required.
	Arn *string

	// The metadata of the endpoint on which the inference experiment ran.
	//
	// This member is required.
	EndpointMetadata *types.EndpointMetadata

	// An array of ModelVariantConfigSummary objects. There is one for each variant in
	// the inference experiment. Each ModelVariantConfigSummary object in the array
	// describes the infrastructure configuration for deploying the corresponding
	// variant.
	//
	// This member is required.
	ModelVariants []types.ModelVariantConfigSummary

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

	// The status of the inference experiment. The following are the possible statuses
	// for an inference experiment:
	//   - Creating - Amazon SageMaker is creating your experiment.
	//   - Created - Amazon SageMaker has finished the creation of your experiment and
	//   will begin the experiment at the scheduled time.
	//   - Updating - When you make changes to your experiment, your experiment shows
	//   as updating.
	//   - Starting - Amazon SageMaker is beginning your experiment.
	//   - Running - Your experiment is in progress.
	//   - Stopping - Amazon SageMaker is stopping your experiment.
	//   - Completed - Your experiment has completed.
	//   - Cancelled - When you conclude your experiment early using the
	//   StopInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html)
	//   API, or if any operation fails with an unexpected error, it shows as cancelled.
	//
	// This member is required.
	Status types.InferenceExperimentStatus

	// The type of the inference experiment.
	//
	// This member is required.
	Type types.InferenceExperimentType

	// The timestamp at which the inference experiment was completed.
	CompletionTime *time.Time

	// The timestamp at which you created the inference experiment.
	CreationTime *time.Time

	// The Amazon S3 location and configuration for storing inference request and
	// response data.
	DataStorageConfig *types.InferenceExperimentDataStorageConfig

	// The description of the inference experiment.
	Description *string

	// The Amazon Web Services Key Management Service (Amazon Web Services KMS) key
	// that Amazon SageMaker uses to encrypt data on the storage volume attached to the
	// ML compute instance that hosts the endpoint. For more information, see
	// CreateInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html)
	// .
	KmsKey *string

	// The timestamp at which you last modified the inference experiment.
	LastModifiedTime *time.Time

	// The ARN of the IAM role that Amazon SageMaker can assume to access model
	// artifacts and container images, and manage Amazon SageMaker Inference endpoints
	// for model deployment.
	RoleArn *string

	// The duration for which the inference experiment ran or will run.
	Schedule *types.InferenceExperimentSchedule

	// The configuration of ShadowMode inference experiment type, which shows the
	// production variant that takes all the inference requests, and the shadow variant
	// to which Amazon SageMaker replicates a percentage of the inference requests. For
	// the shadow variant it also shows the percentage of requests that Amazon
	// SageMaker replicates.
	ShadowModeConfig *types.ShadowModeConfig

	// The error message or client-specified Reason from the StopInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopInferenceExperiment.html)
	// API, that explains the status of the inference experiment.
	StatusReason *string

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

type DescribeInferenceRecommendationsJobInput added in v1.20.0

type DescribeInferenceRecommendationsJobInput struct {

	// The name of the job. The name must be unique within an Amazon Web Services
	// Region in the Amazon Web Services account.
	//
	// This member is required.
	JobName *string
	// contains filtered or unexported fields
}

type DescribeInferenceRecommendationsJobOutput added in v1.20.0

type DescribeInferenceRecommendationsJobOutput struct {

	// A timestamp that shows when the job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Returns information about the versioned model package Amazon Resource Name
	// (ARN), the traffic pattern, and endpoint configurations you provided when you
	// initiated the job.
	//
	// This member is required.
	InputConfig *types.RecommendationJobInputConfig

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

	// The name of the job. The name must be unique within an Amazon Web Services
	// Region in the Amazon Web Services account.
	//
	// This member is required.
	JobName *string

	// The job type that you provided when you initiated the job.
	//
	// This member is required.
	JobType types.RecommendationJobType

	// A timestamp that shows when the job was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access
	// Management (IAM) role you provided when you initiated the job.
	//
	// This member is required.
	RoleArn *string

	// The status of the job.
	//
	// This member is required.
	Status types.RecommendationJobStatus

	// A timestamp that shows when the job completed.
	CompletionTime *time.Time

	// The performance results from running an Inference Recommender job on an
	// existing endpoint.
	EndpointPerformances []types.EndpointPerformance

	// If the job fails, provides information why the job failed.
	FailureReason *string

	// The recommendations made by Inference Recommender.
	InferenceRecommendations []types.InferenceRecommendation

	// The job description that you provided when you initiated the job.
	JobDescription *string

	// The stopping conditions that you provided when you initiated the job.
	StoppingConditions *types.RecommendationJobStoppingConditions

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

type DescribeLabelingJobInput

type DescribeLabelingJobInput struct {

	// The name of the labeling job to return information for.
	//
	// This member is required.
	LabelingJobName *string
	// contains filtered or unexported fields
}

type DescribeLabelingJobOutput

type DescribeLabelingJobOutput struct {

	// The date and time that the labeling job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Configuration information required for human workers to complete a labeling
	// task.
	//
	// This member is required.
	HumanTaskConfig *types.HumanTaskConfig

	// Input configuration information for the labeling job, such as the Amazon S3
	// location of the data objects and the location of the manifest file that
	// describes the data objects.
	//
	// This member is required.
	InputConfig *types.LabelingJobInputConfig

	// A unique identifier for work done as part of a labeling job.
	//
	// This member is required.
	JobReferenceCode *string

	// Provides a breakdown of the number of data objects labeled by humans, the
	// number of objects labeled by machine, the number of objects than couldn't be
	// labeled, and the total number of objects labeled.
	//
	// This member is required.
	LabelCounters *types.LabelCounters

	// The Amazon Resource Name (ARN) of the labeling job.
	//
	// This member is required.
	LabelingJobArn *string

	// The name assigned to the labeling job when it was created.
	//
	// This member is required.
	LabelingJobName *string

	// The processing status of the labeling job.
	//
	// This member is required.
	LabelingJobStatus types.LabelingJobStatus

	// The date and time that the labeling job was last updated.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The location of the job's output data and the Amazon Web Services Key
	// Management Service key ID for the key used to encrypt the output data, if any.
	//
	// This member is required.
	OutputConfig *types.LabelingJobOutputConfig

	// The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your
	// behalf during data labeling.
	//
	// This member is required.
	RoleArn *string

	// If the job failed, the reason that it failed.
	FailureReason *string

	// The attribute used as the label in the output manifest file.
	LabelAttributeName *string

	// The S3 location of the JSON file that defines the categories used to label data
	// objects. Please note the following label-category limits:
	//   - Semantic segmentation labeling jobs using automated labeling: 20 labels
	//   - Box bounding labeling jobs (all): 10 labels
	// The file is a JSON structure in the following format: {
	//     "document-version": "2018-11-28"
	//
	//     "labels": [
	//
	//     {
	//
	//     "label": "label 1"
	//
	//     },
	//
	//     {
	//
	//     "label": "label 2"
	//
	//     },
	//
	//     ...
	//
	//     {
	//
	//     "label": "label n"
	//
	//     }
	//
	//     ]
	//
	//     }
	LabelCategoryConfigS3Uri *string

	// Configuration information for automated data labeling.
	LabelingJobAlgorithmsConfig *types.LabelingJobAlgorithmsConfig

	// The location of the output produced by the labeling job.
	LabelingJobOutput *types.LabelingJobOutput

	// A set of conditions for stopping a labeling job. If any of the conditions are
	// met, the job is automatically stopped.
	StoppingConditions *types.LabelingJobStoppingConditions

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// .
	Tags []types.Tag

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

type DescribeLineageGroupInput added in v1.20.0

type DescribeLineageGroupInput struct {

	// The name of the lineage group.
	//
	// This member is required.
	LineageGroupName *string
	// contains filtered or unexported fields
}

type DescribeLineageGroupOutput added in v1.20.0

type DescribeLineageGroupOutput struct {

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// The creation time of lineage group.
	CreationTime *time.Time

	// The description of the lineage group.
	Description *string

	// The display name of the lineage group.
	DisplayName *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// The last modified time of the lineage group.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the lineage group.
	LineageGroupArn *string

	// The name of the lineage group.
	LineageGroupName *string

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

type DescribeModelBiasJobDefinitionInput added in v0.31.0

type DescribeModelBiasJobDefinitionInput struct {

	// The name of the model bias job definition. The name must be unique within an
	// Amazon Web Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DescribeModelBiasJobDefinitionOutput added in v0.31.0

type DescribeModelBiasJobDefinitionOutput struct {

	// The time at which the model bias job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the model bias job.
	//
	// This member is required.
	JobDefinitionArn *string

	// The name of the bias job definition. The name must be unique within an Amazon
	// Web Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// Configures the model bias job to run a specified Docker container image.
	//
	// This member is required.
	ModelBiasAppSpecification *types.ModelBiasAppSpecification

	// Inputs for the model bias job.
	//
	// This member is required.
	ModelBiasJobInput *types.ModelBiasJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	ModelBiasJobOutputConfig *types.MonitoringOutputConfig

	// The Amazon Resource Name (ARN) of the IAM role that has read permission to the
	// input data location and write permission to the output data location in Amazon
	// S3.
	//
	// This member is required.
	RoleArn *string

	// The baseline configuration for a model bias job.
	ModelBiasBaselineConfig *types.ModelBiasBaselineConfig

	// Networking options for a model bias job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

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

type DescribeModelCardExportJobInput added in v1.56.0

type DescribeModelCardExportJobInput struct {

	// The Amazon Resource Name (ARN) of the model card export job to describe.
	//
	// This member is required.
	ModelCardExportJobArn *string
	// contains filtered or unexported fields
}

type DescribeModelCardExportJobOutput added in v1.56.0

type DescribeModelCardExportJobOutput struct {

	// The date and time that the model export job was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The date and time that the model export job was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The Amazon Resource Name (ARN) of the model card export job.
	//
	// This member is required.
	ModelCardExportJobArn *string

	// The name of the model card export job to describe.
	//
	// This member is required.
	ModelCardExportJobName *string

	// The name or Amazon Resource Name (ARN) of the model card that the model export
	// job exports.
	//
	// This member is required.
	ModelCardName *string

	// The version of the model card that the model export job exports.
	//
	// This member is required.
	ModelCardVersion *int32

	// The export output details for the model card.
	//
	// This member is required.
	OutputConfig *types.ModelCardExportOutputConfig

	// The completion status of the model card export job.
	//   - InProgress : The model card export job is in progress.
	//   - Completed : The model card export job is complete.
	//   - Failed : The model card export job failed. To see the reason for the
	//   failure, see the FailureReason field in the response to a
	//   DescribeModelCardExportJob call.
	//
	// This member is required.
	Status types.ModelCardExportJobStatus

	// The exported model card artifacts.
	ExportArtifacts *types.ModelCardExportArtifacts

	// The failure reason if the model export job fails.
	FailureReason *string

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

type DescribeModelCardInput added in v1.56.0

type DescribeModelCardInput struct {

	// The name or Amazon Resource Name (ARN) of the model card to describe.
	//
	// This member is required.
	ModelCardName *string

	// The version of the model card to describe. If a version is not provided, then
	// the latest version of the model card is described.
	ModelCardVersion *int32
	// contains filtered or unexported fields
}

type DescribeModelCardOutput added in v1.56.0

type DescribeModelCardOutput struct {

	// The content of the model card.
	//
	// This member is required.
	Content *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	//
	// This member is required.
	CreatedBy *types.UserContext

	// The date and time the model card was created.
	//
	// This member is required.
	CreationTime *time.Time

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

	// The name of the model card.
	//
	// This member is required.
	ModelCardName *string

	// The approval status of the model card within your organization. Different
	// organizations might have different criteria for model card review and approval.
	//   - Draft : The model card is a work in progress.
	//   - PendingReview : The model card is pending review.
	//   - Approved : The model card is approved.
	//   - Archived : The model card is archived. No more updates should be made to the
	//   model card, but it can still be exported.
	//
	// This member is required.
	ModelCardStatus types.ModelCardStatus

	// The version of the model card.
	//
	// This member is required.
	ModelCardVersion *int32

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// The date and time the model card was last modified.
	LastModifiedTime *time.Time

	// The processing status of model card deletion. The ModelCardProcessingStatus
	// updates throughout the different deletion steps.
	//   - DeletePending : Model card deletion request received.
	//   - DeleteInProgress : Model card deletion is in progress.
	//   - ContentDeleted : Deleted model card content.
	//   - ExportJobsDeleted : Deleted all export jobs associated with the model card.
	//   - DeleteCompleted : Successfully deleted the model card.
	//   - DeleteFailed : The model card failed to delete.
	ModelCardProcessingStatus types.ModelCardProcessingStatus

	// The security configuration used to protect model card content.
	SecurityConfig *types.ModelCardSecurityConfig

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

type DescribeModelExplainabilityJobDefinitionInput added in v0.31.0

type DescribeModelExplainabilityJobDefinitionInput struct {

	// The name of the model explainability job definition. The name must be unique
	// within an Amazon Web Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DescribeModelExplainabilityJobDefinitionOutput added in v0.31.0

type DescribeModelExplainabilityJobDefinitionOutput struct {

	// The time at which the model explainability job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the model explainability job.
	//
	// This member is required.
	JobDefinitionArn *string

	// The name of the explainability job definition. The name must be unique within
	// an Amazon Web Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// Configures the model explainability job to run a specified Docker container
	// image.
	//
	// This member is required.
	ModelExplainabilityAppSpecification *types.ModelExplainabilityAppSpecification

	// Inputs for the model explainability job.
	//
	// This member is required.
	ModelExplainabilityJobInput *types.ModelExplainabilityJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	ModelExplainabilityJobOutputConfig *types.MonitoringOutputConfig

	// The Amazon Resource Name (ARN) of the IAM role that has read permission to the
	// input data location and write permission to the output data location in Amazon
	// S3.
	//
	// This member is required.
	RoleArn *string

	// The baseline configuration for a model explainability job.
	ModelExplainabilityBaselineConfig *types.ModelExplainabilityBaselineConfig

	// Networking options for a model explainability job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

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

type DescribeModelInput

type DescribeModelInput struct {

	// The name of the model.
	//
	// This member is required.
	ModelName *string
	// contains filtered or unexported fields
}

type DescribeModelOutput

type DescribeModelOutput struct {

	// A timestamp that shows when the model was created.
	//
	// This member is required.
	CreationTime *time.Time

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

	// Name of the SageMaker model.
	//
	// This member is required.
	ModelName *string

	// The containers in the inference pipeline.
	Containers []types.ContainerDefinition

	// A set of recommended deployment configurations for the model.
	DeploymentRecommendation *types.DeploymentRecommendation

	// If True , no inbound or outbound network calls can be made to or from the model
	// container.
	EnableNetworkIsolation *bool

	// The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
	ExecutionRoleArn *string

	// Specifies details of how containers in a multi-container endpoint are called.
	InferenceExecutionConfig *types.InferenceExecutionConfig

	// The location of the primary inference code, associated artifacts, and custom
	// environment map that the inference code uses when it is deployed in production.
	PrimaryContainer *types.ContainerDefinition

	// A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)
	// object that specifies the VPC that this model has access to. For more
	// information, see Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html)
	VpcConfig *types.VpcConfig

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

type DescribeModelPackageGroupInput added in v0.31.0

type DescribeModelPackageGroupInput struct {

	// The name of the model group to describe.
	//
	// This member is required.
	ModelPackageGroupName *string
	// contains filtered or unexported fields
}

type DescribeModelPackageGroupOutput added in v0.31.0

type DescribeModelPackageGroupOutput struct {

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	//
	// This member is required.
	CreatedBy *types.UserContext

	// The time that the model group was created.
	//
	// This member is required.
	CreationTime *time.Time

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

	// The name of the model group.
	//
	// This member is required.
	ModelPackageGroupName *string

	// The status of the model group.
	//
	// This member is required.
	ModelPackageGroupStatus types.ModelPackageGroupStatus

	// A description of the model group.
	ModelPackageGroupDescription *string

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

type DescribeModelPackageInput

type DescribeModelPackageInput struct {

	// The name or Amazon Resource Name (ARN) of the model package to describe. When
	// you specify a name, the name must have 1 to 63 characters. Valid characters are
	// a-z, A-Z, 0-9, and - (hyphen).
	//
	// This member is required.
	ModelPackageName *string
	// contains filtered or unexported fields
}

type DescribeModelPackageOutput

type DescribeModelPackageOutput struct {

	// A timestamp specifying when the model package was created.
	//
	// This member is required.
	CreationTime *time.Time

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

	// The name of the model package being described.
	//
	// This member is required.
	ModelPackageName *string

	// The current status of the model package.
	//
	// This member is required.
	ModelPackageStatus types.ModelPackageStatus

	// Details about the current status of the model package.
	//
	// This member is required.
	ModelPackageStatusDetails *types.ModelPackageStatusDetails

	// An array of additional Inference Specification objects. Each additional
	// Inference Specification specifies artifacts based on this model package that can
	// be used on inference endpoints. Generally used with SageMaker Neo to store the
	// compiled artifacts.
	AdditionalInferenceSpecifications []types.AdditionalInferenceSpecificationDefinition

	// A description provided for the model approval.
	ApprovalDescription *string

	// Whether the model package is certified for listing on Amazon Web Services
	// Marketplace.
	CertifyForMarketplace *bool

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// The metadata properties associated with the model package versions.
	CustomerMetadataProperties map[string]string

	// The machine learning domain of the model package you specified. Common machine
	// learning domains include computer vision and natural language processing.
	Domain *string

	// Represents the drift check baselines that can be used when the model monitor is
	// set using the model package. For more information, see the topic on Drift
	// Detection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection)
	// in the Amazon SageMaker Developer Guide.
	DriftCheckBaselines *types.DriftCheckBaselines

	// Details about inference jobs that you can run with models based on this model
	// package.
	InferenceSpecification *types.InferenceSpecification

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// The last time that the model package was modified.
	LastModifiedTime *time.Time

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// The approval status of the model package.
	ModelApprovalStatus types.ModelApprovalStatus

	// Metrics for the model.
	ModelMetrics *types.ModelMetrics

	// A brief summary of the model package.
	ModelPackageDescription *string

	// If the model is a versioned model, the name of the model group that the
	// versioned model belongs to.
	ModelPackageGroupName *string

	// The version of the model package.
	ModelPackageVersion *int32

	// The Amazon Simple Storage Service (Amazon S3) path where the sample payload are
	// stored. This path points to a single gzip compressed tar archive (.tar.gz
	// suffix).
	SamplePayloadUrl *string

	// Indicates if you want to skip model validation.
	SkipModelValidation types.SkipModelValidation

	// Details about the algorithm that was used to create the model package.
	SourceAlgorithmSpecification *types.SourceAlgorithmSpecification

	// The URI of the source for the model package.
	SourceUri *string

	// The machine learning task you specified that your model package accomplishes.
	// Common machine learning tasks include object detection and image classification.
	Task *string

	// Configurations for one or more transform jobs that SageMaker runs to test the
	// model package.
	ValidationSpecification *types.ModelPackageValidationSpecification

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

type DescribeModelQualityJobDefinitionInput added in v0.31.0

type DescribeModelQualityJobDefinitionInput struct {

	// The name of the model quality job. The name must be unique within an Amazon Web
	// Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string
	// contains filtered or unexported fields
}

type DescribeModelQualityJobDefinitionOutput added in v0.31.0

type DescribeModelQualityJobDefinitionOutput struct {

	// The time at which the model quality job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the model quality job.
	//
	// This member is required.
	JobDefinitionArn *string

	// The name of the quality job definition. The name must be unique within an
	// Amazon Web Services Region in the Amazon Web Services account.
	//
	// This member is required.
	JobDefinitionName *string

	// Identifies the resources to deploy for a monitoring job.
	//
	// This member is required.
	JobResources *types.MonitoringResources

	// Configures the model quality job to run a specified Docker container image.
	//
	// This member is required.
	ModelQualityAppSpecification *types.ModelQualityAppSpecification

	// Inputs for the model quality job.
	//
	// This member is required.
	ModelQualityJobInput *types.ModelQualityJobInput

	// The output configuration for monitoring jobs.
	//
	// This member is required.
	ModelQualityJobOutputConfig *types.MonitoringOutputConfig

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The baseline configuration for a model quality job.
	ModelQualityBaselineConfig *types.ModelQualityBaselineConfig

	// Networking options for a model quality job.
	NetworkConfig *types.MonitoringNetworkConfig

	// A time limit for how long the monitoring job is allowed to run before stopping.
	StoppingCondition *types.MonitoringStoppingCondition

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

type DescribeMonitoringScheduleInput

type DescribeMonitoringScheduleInput struct {

	// Name of a previously created monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleName *string
	// contains filtered or unexported fields
}

type DescribeMonitoringScheduleOutput

type DescribeMonitoringScheduleOutput struct {

	// The time at which the monitoring job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The time at which the monitoring job was last modified.
	//
	// This member is required.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleArn *string

	// The configuration object that specifies the monitoring schedule and defines the
	// monitoring job.
	//
	// This member is required.
	MonitoringScheduleConfig *types.MonitoringScheduleConfig

	// Name of the monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleName *string

	// The status of an monitoring job.
	//
	// This member is required.
	MonitoringScheduleStatus types.ScheduleStatus

	// The name of the endpoint for the monitoring job.
	EndpointName *string

	// A string, up to one KB in size, that contains the reason a monitoring job
	// failed, if it failed.
	FailureReason *string

	// Describes metadata on the last execution to run, if there was one.
	LastMonitoringExecutionSummary *types.MonitoringExecutionSummary

	// The type of the monitoring job that this schedule runs. This is one of the
	// following values.
	//   - DATA_QUALITY - The schedule is for a data quality monitoring job.
	//   - MODEL_QUALITY - The schedule is for a model quality monitoring job.
	//   - MODEL_BIAS - The schedule is for a bias monitoring job.
	//   - MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.
	MonitoringType types.MonitoringType

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

type DescribeNotebookInstanceAPIClient added in v0.31.0

type DescribeNotebookInstanceAPIClient interface {
	DescribeNotebookInstance(context.Context, *DescribeNotebookInstanceInput, ...func(*Options)) (*DescribeNotebookInstanceOutput, error)
}

DescribeNotebookInstanceAPIClient is a client that implements the DescribeNotebookInstance operation.

type DescribeNotebookInstanceInput

type DescribeNotebookInstanceInput struct {

	// The name of the notebook instance that you want information about.
	//
	// This member is required.
	NotebookInstanceName *string
	// contains filtered or unexported fields
}

type DescribeNotebookInstanceLifecycleConfigInput

type DescribeNotebookInstanceLifecycleConfigInput struct {

	// The name of the lifecycle configuration to describe.
	//
	// This member is required.
	NotebookInstanceLifecycleConfigName *string
	// contains filtered or unexported fields
}

type DescribeNotebookInstanceLifecycleConfigOutput

type DescribeNotebookInstanceLifecycleConfigOutput struct {

	// A timestamp that tells when the lifecycle configuration was created.
	CreationTime *time.Time

	// A timestamp that tells when the lifecycle configuration was last modified.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the lifecycle configuration.
	NotebookInstanceLifecycleConfigArn *string

	// The name of the lifecycle configuration.
	NotebookInstanceLifecycleConfigName *string

	// The shell script that runs only once, when you create a notebook instance.
	OnCreate []types.NotebookInstanceLifecycleHook

	// The shell script that runs every time you start a notebook instance, including
	// when you create the notebook instance.
	OnStart []types.NotebookInstanceLifecycleHook

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

type DescribeNotebookInstanceOutput

type DescribeNotebookInstanceOutput struct {

	// A list of the Elastic Inference (EI) instance types associated with this
	// notebook instance. Currently only one EI instance type can be associated with a
	// notebook instance. For more information, see Using Elastic Inference in Amazon
	// SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) .
	AcceleratorTypes []types.NotebookInstanceAcceleratorType

	// An array of up to three Git repositories associated with the notebook instance.
	// These can be either the names of Git repositories stored as resources in your
	// account, or the URL of Git repositories in Amazon Web Services CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. These repositories are cloned at the same level
	// as the default repository of your notebook instance. For more information, see
	// Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// .
	AdditionalCodeRepositories []string

	// A timestamp. Use this parameter to return the time when the notebook instance
	// was created
	CreationTime *time.Time

	// The Git repository associated with the notebook instance as its default code
	// repository. This can be either the name of a Git repository stored as a resource
	// in your account, or the URL of a Git repository in Amazon Web Services
	// CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. When you open a notebook instance, it opens in
	// the directory that contains this repository. For more information, see
	// Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// .
	DefaultCodeRepository *string

	// Describes whether SageMaker provides internet access to the notebook instance.
	// If this value is set to Disabled, the notebook instance does not have internet
	// access, and cannot connect to SageMaker training and endpoint services. For more
	// information, see Notebook Instances Are Internet-Enabled by Default (https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access)
	// .
	DirectInternetAccess types.DirectInternetAccess

	// If status is Failed , the reason it failed.
	FailureReason *string

	// Information on the IMDS configuration of the notebook instance
	InstanceMetadataServiceConfiguration *types.InstanceMetadataServiceConfiguration

	// The type of ML compute instance running on the notebook instance.
	InstanceType types.InstanceType

	// The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing
	// it on the ML storage volume attached to the instance.
	KmsKeyId *string

	// A timestamp. Use this parameter to retrieve the time when the notebook instance
	// was last modified.
	LastModifiedTime *time.Time

	// The network interface IDs that SageMaker created at the time of creating the
	// instance.
	NetworkInterfaceId *string

	// The Amazon Resource Name (ARN) of the notebook instance.
	NotebookInstanceArn *string

	// Returns the name of a notebook instance lifecycle configuration. For
	// information about notebook instance lifestyle configurations, see Step 2.1:
	// (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html)
	NotebookInstanceLifecycleConfigName *string

	// The name of the SageMaker notebook instance.
	NotebookInstanceName *string

	// The status of the notebook instance.
	NotebookInstanceStatus types.NotebookInstanceStatus

	// The platform identifier of the notebook instance runtime environment.
	PlatformIdentifier *string

	// The Amazon Resource Name (ARN) of the IAM role associated with the instance.
	RoleArn *string

	// Whether root access is enabled or disabled for users of the notebook instance.
	// Lifecycle configurations need root access to be able to set up a notebook
	// instance. Because of this, lifecycle configurations associated with a notebook
	// instance always run with root access even if you disable root access for users.
	RootAccess types.RootAccess

	// The IDs of the VPC security groups.
	SecurityGroups []string

	// The ID of the VPC subnet.
	SubnetId *string

	// The URL that you use to connect to the Jupyter notebook that is running in your
	// notebook instance.
	Url *string

	// The size, in GB, of the ML storage volume attached to the notebook instance.
	VolumeSizeInGB *int32

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

type DescribePipelineDefinitionForExecutionInput added in v0.31.0

type DescribePipelineDefinitionForExecutionInput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	//
	// This member is required.
	PipelineExecutionArn *string
	// contains filtered or unexported fields
}

type DescribePipelineDefinitionForExecutionOutput added in v0.31.0

type DescribePipelineDefinitionForExecutionOutput struct {

	// The time when the pipeline was created.
	CreationTime *time.Time

	// The JSON pipeline definition.
	PipelineDefinition *string

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

type DescribePipelineExecutionInput added in v0.31.0

type DescribePipelineExecutionInput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	//
	// This member is required.
	PipelineExecutionArn *string
	// contains filtered or unexported fields
}

type DescribePipelineExecutionOutput added in v0.31.0

type DescribePipelineExecutionOutput struct {

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// The time when the pipeline execution was created.
	CreationTime *time.Time

	// If the execution failed, a message describing why.
	FailureReason *string

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// The time when the pipeline execution was modified last.
	LastModifiedTime *time.Time

	// The parallelism configuration applied to the pipeline.
	ParallelismConfiguration *types.ParallelismConfiguration

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string

	// The Amazon Resource Name (ARN) of the pipeline execution.
	PipelineExecutionArn *string

	// The description of the pipeline execution.
	PipelineExecutionDescription *string

	// The display name of the pipeline execution.
	PipelineExecutionDisplayName *string

	// The status of the pipeline execution.
	PipelineExecutionStatus types.PipelineExecutionStatus

	// Specifies the names of the experiment and trial created by a pipeline.
	PipelineExperimentConfig *types.PipelineExperimentConfig

	// The selective execution configuration applied to the pipeline run.
	SelectiveExecutionConfig *types.SelectiveExecutionConfig

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

type DescribePipelineInput added in v0.31.0

type DescribePipelineInput struct {

	// The name or Amazon Resource Name (ARN) of the pipeline to describe.
	//
	// This member is required.
	PipelineName *string
	// contains filtered or unexported fields
}

type DescribePipelineOutput added in v0.31.0

type DescribePipelineOutput struct {

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// The time when the pipeline was created.
	CreationTime *time.Time

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// The time when the pipeline was last modified.
	LastModifiedTime *time.Time

	// The time when the pipeline was last run.
	LastRunTime *time.Time

	// Lists the parallelism configuration applied to the pipeline.
	ParallelismConfiguration *types.ParallelismConfiguration

	// The Amazon Resource Name (ARN) of the pipeline.
	PipelineArn *string

	// The JSON pipeline definition.
	PipelineDefinition *string

	// The description of the pipeline.
	PipelineDescription *string

	// The display name of the pipeline.
	PipelineDisplayName *string

	// The name of the pipeline.
	PipelineName *string

	// The status of the pipeline execution.
	PipelineStatus types.PipelineStatus

	// The Amazon Resource Name (ARN) that the pipeline uses to execute.
	RoleArn *string

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

type DescribeProcessingJobAPIClient added in v1.9.0

type DescribeProcessingJobAPIClient interface {
	DescribeProcessingJob(context.Context, *DescribeProcessingJobInput, ...func(*Options)) (*DescribeProcessingJobOutput, error)
}

DescribeProcessingJobAPIClient is a client that implements the DescribeProcessingJob operation.

type DescribeProcessingJobInput

type DescribeProcessingJobInput struct {

	// The name of the processing job. The name must be unique within an Amazon Web
	// Services Region in the Amazon Web Services account.
	//
	// This member is required.
	ProcessingJobName *string
	// contains filtered or unexported fields
}

type DescribeProcessingJobOutput

type DescribeProcessingJobOutput struct {

	// Configures the processing job to run a specified container image.
	//
	// This member is required.
	AppSpecification *types.AppSpecification

	// The time at which the processing job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the processing job.
	//
	// This member is required.
	ProcessingJobArn *string

	// The name of the processing job. The name must be unique within an Amazon Web
	// Services Region in the Amazon Web Services account.
	//
	// This member is required.
	ProcessingJobName *string

	// Provides the status of a processing job.
	//
	// This member is required.
	ProcessingJobStatus types.ProcessingJobStatus

	// Identifies the resources, ML compute instances, and ML storage volumes to
	// deploy for a processing job. In distributed training, you specify more than one
	// instance.
	//
	// This member is required.
	ProcessingResources *types.ProcessingResources

	// The ARN of an AutoML job associated with this processing job.
	AutoMLJobArn *string

	// The environment variables set in the Docker container.
	Environment map[string]string

	// An optional string, up to one KB in size, that contains metadata from the
	// processing container when the processing job exits.
	ExitMessage *string

	// The configuration information used to create an experiment.
	ExperimentConfig *types.ExperimentConfig

	// A string, up to one KB in size, that contains the reason a processing job
	// failed, if it failed.
	FailureReason *string

	// The time at which the processing job was last modified.
	LastModifiedTime *time.Time

	// The ARN of a monitoring schedule for an endpoint associated with this
	// processing job.
	MonitoringScheduleArn *string

	// Networking options for a processing job.
	NetworkConfig *types.NetworkConfig

	// The time at which the processing job completed.
	ProcessingEndTime *time.Time

	// The inputs for a processing job.
	ProcessingInputs []types.ProcessingInput

	// Output configuration for the processing job.
	ProcessingOutputConfig *types.ProcessingOutputConfig

	// The time at which the processing job started.
	ProcessingStartTime *time.Time

	// The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume
	// to perform tasks on your behalf.
	RoleArn *string

	// The time limit for how long the processing job is allowed to run.
	StoppingCondition *types.ProcessingStoppingCondition

	// The ARN of a training job associated with this processing job.
	TrainingJobArn *string

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

type DescribeProjectInput added in v0.31.0

type DescribeProjectInput struct {

	// The name of the project to describe.
	//
	// This member is required.
	ProjectName *string
	// contains filtered or unexported fields
}

type DescribeProjectOutput added in v0.31.0

type DescribeProjectOutput struct {

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

	// The Amazon Resource Name (ARN) of the project.
	//
	// This member is required.
	ProjectArn *string

	// The ID of the project.
	//
	// This member is required.
	ProjectId *string

	// The name of the project.
	//
	// This member is required.
	ProjectName *string

	// The status of the project.
	//
	// This member is required.
	ProjectStatus types.ProjectStatus

	// Information used to provision a service catalog product. For information, see
	// What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html)
	// .
	//
	// This member is required.
	ServiceCatalogProvisioningDetails *types.ServiceCatalogProvisioningDetails

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	CreatedBy *types.UserContext

	// Information about the user who created or modified an experiment, trial, trial
	// component, lineage group, project, or model card.
	LastModifiedBy *types.UserContext

	// The timestamp when project was last modified.
	LastModifiedTime *time.Time

	// The description of the project.
	ProjectDescription *string

	// Information about a provisioned service catalog product.
	ServiceCatalogProvisionedProductDetails *types.ServiceCatalogProvisionedProductDetails

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

type DescribeSpaceInput added in v1.56.0

type DescribeSpaceInput struct {

	// The ID of the associated domain.
	//
	// This member is required.
	DomainId *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string
	// contains filtered or unexported fields
}

type DescribeSpaceOutput added in v1.56.0

type DescribeSpaceOutput struct {

	// The creation time.
	CreationTime *time.Time

	// The ID of the associated domain.
	DomainId *string

	// The failure reason.
	FailureReason *string

	// The ID of the space's profile in the Amazon EFS volume.
	HomeEfsFileSystemUid *string

	// The last modified time.
	LastModifiedTime *time.Time

	// The collection of ownership settings for a space.
	OwnershipSettings *types.OwnershipSettings

	// The space's Amazon Resource Name (ARN).
	SpaceArn *string

	// The name of the space that appears in the Amazon SageMaker Studio UI.
	SpaceDisplayName *string

	// The name of the space.
	SpaceName *string

	// A collection of space settings.
	SpaceSettings *types.SpaceSettings

	// The collection of space sharing settings for a space.
	SpaceSharingSettings *types.SpaceSharingSettings

	// The status.
	Status types.SpaceStatus

	// Returns the URL of the space. If the space is created with Amazon Web Services
	// IAM Identity Center (Successor to Amazon Web Services Single Sign-On)
	// authentication, users can navigate to the URL after appending the respective
	// redirect parameter for the application type to be federated through Amazon Web
	// Services IAM Identity Center. The following application types are supported:
	//   - Studio Classic: &redirect=JupyterServer
	//   - JupyterLab: &redirect=JupyterLab
	//   - Code Editor, based on Code-OSS, Visual Studio Code - Open Source:
	//   &redirect=CodeEditor
	Url *string

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

type DescribeStudioLifecycleConfigInput added in v1.15.0

type DescribeStudioLifecycleConfigInput struct {

	// The name of the Amazon SageMaker Studio Lifecycle Configuration to describe.
	//
	// This member is required.
	StudioLifecycleConfigName *string
	// contains filtered or unexported fields
}

type DescribeStudioLifecycleConfigOutput added in v1.15.0

type DescribeStudioLifecycleConfigOutput struct {

	// The creation time of the Amazon SageMaker Studio Lifecycle Configuration.
	CreationTime *time.Time

	// This value is equivalent to CreationTime because Amazon SageMaker Studio
	// Lifecycle Configurations are immutable.
	LastModifiedTime *time.Time

	// The App type that the Lifecycle Configuration is attached to.
	StudioLifecycleConfigAppType types.StudioLifecycleConfigAppType

	// The ARN of the Lifecycle Configuration to describe.
	StudioLifecycleConfigArn *string

	// The content of your Amazon SageMaker Studio Lifecycle Configuration script.
	StudioLifecycleConfigContent *string

	// The name of the Amazon SageMaker Studio Lifecycle Configuration that is
	// described.
	StudioLifecycleConfigName *string

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

type DescribeSubscribedWorkteamInput

type DescribeSubscribedWorkteamInput struct {

	// The Amazon Resource Name (ARN) of the subscribed work team to describe.
	//
	// This member is required.
	WorkteamArn *string
	// contains filtered or unexported fields
}

type DescribeSubscribedWorkteamOutput

type DescribeSubscribedWorkteamOutput struct {

	// A Workteam instance that contains information about the work team.
	//
	// This member is required.
	SubscribedWorkteam *types.SubscribedWorkteam

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

type DescribeTrainingJobAPIClient added in v1.9.0

type DescribeTrainingJobAPIClient interface {
	DescribeTrainingJob(context.Context, *DescribeTrainingJobInput, ...func(*Options)) (*DescribeTrainingJobOutput, error)
}

DescribeTrainingJobAPIClient is a client that implements the DescribeTrainingJob operation.

type DescribeTrainingJobInput

type DescribeTrainingJobInput struct {

	// The name of the training job.
	//
	// This member is required.
	TrainingJobName *string
	// contains filtered or unexported fields
}

type DescribeTrainingJobOutput

type DescribeTrainingJobOutput struct {

	// Information about the algorithm used for training, and algorithm metadata.
	//
	// This member is required.
	AlgorithmSpecification *types.AlgorithmSpecification

	// A timestamp that indicates when the training job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Information about the Amazon S3 location that is configured for storing model
	// artifacts.
	//
	// This member is required.
	ModelArtifacts *types.ModelArtifacts

	// Resources, including ML compute instances and ML storage volumes, that are
	// configured for model training.
	//
	// This member is required.
	ResourceConfig *types.ResourceConfig

	// Provides detailed information about the state of the training job. For detailed
	// information on the secondary status of the training job, see StatusMessage
	// under SecondaryStatusTransition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html)
	// . SageMaker provides primary statuses and secondary statuses that apply to each
	// of them: InProgress
	//   - Starting - Starting the training job.
	//   - Downloading - An optional stage for algorithms that support File training
	//   input mode. It indicates that data is being downloaded to the ML storage
	//   volumes.
	//   - Training - Training is in progress.
	//   - Interrupted - The job stopped because the managed spot training instances
	//   were interrupted.
	//   - Uploading - Training is complete and the model artifacts are being uploaded
	//   to the S3 location.
	// Completed
	//   - Completed - The training job has completed.
	// Failed
	//   - Failed - The training job has failed. The reason for the failure is returned
	//   in the FailureReason field of DescribeTrainingJobResponse .
	// Stopped
	//   - MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed
	//   runtime.
	//   - MaxWaitTimeExceeded - The job stopped because it exceeded the maximum
	//   allowed wait time.
	//   - Stopped - The training job has stopped.
	// Stopping
	//   - Stopping - Stopping the training job.
	// Valid values for SecondaryStatus are subject to change. We no longer support
	// the following secondary statuses:
	//   - LaunchingMLInstances
	//   - PreparingTraining
	//   - DownloadingTrainingImage
	//
	// This member is required.
	SecondaryStatus types.SecondaryStatus

	// Specifies a limit to how long a model training job can run. It also specifies
	// how long a managed Spot training job has to complete. When the job reaches the
	// time limit, SageMaker ends the training job. Use this API to cap model training
	// costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which
	// delays job termination for 120 seconds. Algorithms can use this 120-second
	// window to save the model artifacts, so the results of training are not lost.
	//
	// This member is required.
	StoppingCondition *types.StoppingCondition

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

	// Name of the model training job.
	//
	// This member is required.
	TrainingJobName *string

	// The status of the training job. SageMaker provides the following training job
	// statuses:
	//   - InProgress - The training is in progress.
	//   - Completed - The training job has completed.
	//   - Failed - The training job has failed. To see the reason for the failure, see
	//   the FailureReason field in the response to a DescribeTrainingJobResponse call.
	//   - Stopping - The training job is stopping.
	//   - Stopped - The training job has stopped.
	// For more detailed information, see SecondaryStatus .
	//
	// This member is required.
	TrainingJobStatus types.TrainingJobStatus

	// The Amazon Resource Name (ARN) of an AutoML job.
	AutoMLJobArn *string

	// The billable time in seconds. Billable time refers to the absolute wall-clock
	// time. Multiply BillableTimeInSeconds by the number of instances ( InstanceCount
	// ) in your training cluster to get the total compute time SageMaker bills you if
	// you run distributed training. The formula is as follows: BillableTimeInSeconds
	// * InstanceCount . You can calculate the savings from using managed spot training
	// using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100 .
	// For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500,
	// the savings is 80%.
	BillableTimeInSeconds *int32

	// Contains information about the output location for managed spot training
	// checkpoint data.
	CheckpointConfig *types.CheckpointConfig

	// Configuration information for the Amazon SageMaker Debugger hook parameters,
	// metric and tensor collections, and storage paths. To learn more about how to
	// configure the DebugHookConfig parameter, see Use the SageMaker and Debugger
	// Configuration API Operations to Create, Update, and Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html)
	// .
	DebugHookConfig *types.DebugHookConfig

	// Configuration information for Amazon SageMaker Debugger rules for debugging
	// output tensors.
	DebugRuleConfigurations []types.DebugRuleConfiguration

	// Evaluation status of Amazon SageMaker Debugger rules for debugging on a
	// training job.
	DebugRuleEvaluationStatuses []types.DebugRuleEvaluationStatus

	// To encrypt all communications between ML compute instances in distributed
	// training, choose True . Encryption provides greater security for distributed
	// training, but training might take longer. How long it takes depends on the
	// amount of communication between compute instances, especially if you use a deep
	// learning algorithms in distributed training.
	EnableInterContainerTrafficEncryption *bool

	// A Boolean indicating whether managed spot training is enabled ( True ) or not (
	// False ).
	EnableManagedSpotTraining *bool

	// If you want to allow inbound or outbound network calls, except for calls
	// between peers within a training cluster for distributed training, choose True .
	// If you enable network isolation for training jobs that are configured to use a
	// VPC, SageMaker downloads and uploads customer data and model artifacts through
	// the specified VPC, but the training container does not have network access.
	EnableNetworkIsolation *bool

	// The environment variables to set in the Docker container.
	Environment map[string]string

	// Associates a SageMaker job as a trial component with an experiment and trial.
	// Specified when you call the following APIs:
	//   - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)
	//   - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)
	//   - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)
	ExperimentConfig *types.ExperimentConfig

	// If the training job failed, the reason it failed.
	FailureReason *string

	// A collection of MetricData objects that specify the names, values, and dates
	// and times that the training algorithm emitted to Amazon CloudWatch.
	FinalMetricDataList []types.MetricData

	// Algorithm-specific parameters.
	HyperParameters map[string]string

	// Contains information about the infrastructure health check configuration for
	// the training job.
	InfraCheckConfig *types.InfraCheckConfig

	// An array of Channel objects that describes each data input channel.
	InputDataConfig []types.Channel

	// The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that
	// created the transform or training job.
	LabelingJobArn *string

	// A timestamp that indicates when the status of the training job was last
	// modified.
	LastModifiedTime *time.Time

	// The S3 path where model artifacts that you configured when creating the job are
	// stored. SageMaker creates subfolders for model artifacts.
	OutputDataConfig *types.OutputDataConfig

	// Configuration information for Amazon SageMaker Debugger system monitoring,
	// framework profiling, and storage paths.
	ProfilerConfig *types.ProfilerConfig

	// Configuration information for Amazon SageMaker Debugger rules for profiling
	// system and framework metrics.
	ProfilerRuleConfigurations []types.ProfilerRuleConfiguration

	// Evaluation status of Amazon SageMaker Debugger rules for profiling on a
	// training job.
	ProfilerRuleEvaluationStatuses []types.ProfilerRuleEvaluationStatus

	// Profiling status of a training job.
	ProfilingStatus types.ProfilingStatus

	// Configuration for remote debugging. To learn more about the remote debugging
	// functionality of SageMaker, see Access a training container through Amazon Web
	// Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html)
	// .
	RemoteDebugConfig *types.RemoteDebugConfig

	// The number of times to retry the job when the job fails due to an
	// InternalServerError .
	RetryStrategy *types.RetryStrategy

	// The Amazon Web Services Identity and Access Management (IAM) role configured
	// for the training job.
	RoleArn *string

	// A history of all of the secondary statuses that the training job has
	// transitioned through.
	SecondaryStatusTransitions []types.SecondaryStatusTransition

	// Configuration of storage locations for the Amazon SageMaker Debugger
	// TensorBoard output data.
	TensorBoardOutputConfig *types.TensorBoardOutputConfig

	// Indicates the time when the training job ends on training instances. You are
	// billed for the time interval between the value of TrainingStartTime and this
	// time. For successful jobs and stopped jobs, this is the time after model
	// artifacts are uploaded. For failed jobs, this is the time when SageMaker detects
	// a job failure.
	TrainingEndTime *time.Time

	// Indicates the time when the training job starts on training instances. You are
	// billed for the time interval between this time and the value of TrainingEndTime
	// . The start time in CloudWatch Logs might be later than this time. The
	// difference is due to the time it takes to download the training data and to the
	// size of the training container.
	TrainingStartTime *time.Time

	// The training time in seconds.
	TrainingTimeInSeconds *int32

	// The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if
	// the training job was launched by a hyperparameter tuning job.
	TuningJobArn *string

	// A VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)
	// object that specifies the VPC that this training job has access to. For more
	// information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html)
	// .
	VpcConfig *types.VpcConfig

	// The status of the warm pool associated with the training job.
	WarmPoolStatus *types.WarmPoolStatus

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

type DescribeTransformJobAPIClient added in v1.9.0

type DescribeTransformJobAPIClient interface {
	DescribeTransformJob(context.Context, *DescribeTransformJobInput, ...func(*Options)) (*DescribeTransformJobOutput, error)
}

DescribeTransformJobAPIClient is a client that implements the DescribeTransformJob operation.

type DescribeTransformJobInput

type DescribeTransformJobInput struct {

	// The name of the transform job that you want to view details of.
	//
	// This member is required.
	TransformJobName *string
	// contains filtered or unexported fields
}

type DescribeTransformJobOutput

type DescribeTransformJobOutput struct {

	// A timestamp that shows when the transform Job was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The name of the model used in the transform job.
	//
	// This member is required.
	ModelName *string

	// Describes the dataset to be transformed and the Amazon S3 location where it is
	// stored.
	//
	// This member is required.
	TransformInput *types.TransformInput

	// The Amazon Resource Name (ARN) of the transform job.
	//
	// This member is required.
	TransformJobArn *string

	// The name of the transform job.
	//
	// This member is required.
	TransformJobName *string

	// The status of the transform job. If the transform job failed, the reason is
	// returned in the FailureReason field.
	//
	// This member is required.
	TransformJobStatus types.TransformJobStatus

	// Describes the resources, including ML instance types and ML instance count, to
	// use for the transform job.
	//
	// This member is required.
	TransformResources *types.TransformResources

	// The Amazon Resource Name (ARN) of the AutoML transform job.
	AutoMLJobArn *string

	// Specifies the number of records to include in a mini-batch for an HTTP
	// inference request. A record is a single unit of input data that inference can be
	// made on. For example, a single line in a CSV file is a record. To enable the
	// batch strategy, you must set SplitType to Line , RecordIO , or TFRecord .
	BatchStrategy types.BatchStrategy

	// Configuration to control how SageMaker captures inference data.
	DataCaptureConfig *types.BatchDataCaptureConfig

	// The data structure used to specify the data to be used for inference in a batch
	// transform job and to associate the data that is relevant to the prediction
	// results in the output. The input filter provided allows you to exclude input
	// data that is not needed for inference in a batch transform job. The output
	// filter provided allows you to include input data relevant to interpreting the
	// predictions in the output from the job. For more information, see Associate
	// Prediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html)
	// .
	DataProcessing *types.DataProcessing

	// The environment variables to set in the Docker container. We support up to 16
	// key and values entries in the map.
	Environment map[string]string

	// Associates a SageMaker job as a trial component with an experiment and trial.
	// Specified when you call the following APIs:
	//   - CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)
	//   - CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)
	//   - CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)
	ExperimentConfig *types.ExperimentConfig

	// If the transform job failed, FailureReason describes why it failed. A transform
	// job creates a log file, which includes error messages, and stores it as an
	// Amazon S3 object. For more information, see Log Amazon SageMaker Events with
	// Amazon CloudWatch (https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html)
	// .
	FailureReason *string

	// The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling
	// job that created the transform or training job.
	LabelingJobArn *string

	// The maximum number of parallel requests on each instance node that can be
	// launched in a transform job. The default value is 1.
	MaxConcurrentTransforms *int32

	// The maximum payload size, in MB, used in the transform job.
	MaxPayloadInMB *int32

	// The timeout and maximum number of retries for processing a transform job
	// invocation.
	ModelClientConfig *types.ModelClientConfig

	// Indicates when the transform job has been completed, or has stopped or failed.
	// You are billed for the time interval between this time and the value of
	// TransformStartTime .
	TransformEndTime *time.Time

	// Identifies the Amazon S3 location where you want Amazon SageMaker to save the
	// results from the transform job.
	TransformOutput *types.TransformOutput

	// Indicates when the transform job starts on ML instances. You are billed for the
	// time interval between this time and the value of TransformEndTime .
	TransformStartTime *time.Time

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

type DescribeTrialComponentInput

type DescribeTrialComponentInput struct {

	// The name of the trial component to describe.
	//
	// This member is required.
	TrialComponentName *string
	// contains filtered or unexported fields
}

type DescribeTrialComponentOutput

type DescribeTrialComponentOutput struct {

	// Who created the trial component.
	CreatedBy *types.UserContext

	// When the component was created.
	CreationTime *time.Time

	// The name of the component as displayed. If DisplayName isn't specified,
	// TrialComponentName is displayed.
	DisplayName *string

	// When the component ended.
	EndTime *time.Time

	// The input artifacts of the component.
	InputArtifacts map[string]types.TrialComponentArtifact

	// Who last modified the component.
	LastModifiedBy *types.UserContext

	// When the component was last modified.
	LastModifiedTime *time.Time

	// The Amazon Resource Name (ARN) of the lineage group.
	LineageGroupArn *string

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// The metrics for the component.
	Metrics []types.TrialComponentMetricSummary

	// The output artifacts of the component.
	OutputArtifacts map[string]types.TrialComponentArtifact

	// The hyperparameters of the component.
	Parameters map[string]types.TrialComponentParameterValue

	// The Amazon Resource Name (ARN) of the source and, optionally, the job type.
	Source *types.TrialComponentSource

	// A list of ARNs and, if applicable, job types for multiple sources of an
	// experiment run.
	Sources []types.TrialComponentSource

	// When the component started.
	StartTime *time.Time

	// The status of the component. States include:
	//   - InProgress
	//   - Completed
	//   - Failed
	Status *types.TrialComponentStatus

	// The Amazon Resource Name (ARN) of the trial component.
	TrialComponentArn *string

	// The name of the trial component.
	TrialComponentName *string

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

type DescribeTrialInput

type DescribeTrialInput struct {

	// The name of the trial to describe.
	//
	// This member is required.
	TrialName *string
	// contains filtered or unexported fields
}

type DescribeTrialOutput

type DescribeTrialOutput struct {

	// Who created the trial.
	CreatedBy *types.UserContext

	// When the trial was created.
	CreationTime *time.Time

	// The name of the trial as displayed. If DisplayName isn't specified, TrialName
	// is displayed.
	DisplayName *string

	// The name of the experiment the trial is part of.
	ExperimentName *string

	// Who last modified the trial.
	LastModifiedBy *types.UserContext

	// When the trial was last modified.
	LastModifiedTime *time.Time

	// Metadata properties of the tracking entity, trial, or trial component.
	MetadataProperties *types.MetadataProperties

	// The Amazon Resource Name (ARN) of the source and, optionally, the job type.
	Source *types.TrialSource

	// The Amazon Resource Name (ARN) of the trial.
	TrialArn *string

	// The name of the trial.
	TrialName *string

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

type DescribeUserProfileInput

type DescribeUserProfileInput struct {

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The user profile name. This value is not case sensitive.
	//
	// This member is required.
	UserProfileName *string
	// contains filtered or unexported fields
}

type DescribeUserProfileOutput

type DescribeUserProfileOutput struct {

	// The creation time.
	CreationTime *time.Time

	// The ID of the domain that contains the profile.
	DomainId *string

	// The failure reason.
	FailureReason *string

	// The ID of the user's profile in the Amazon Elastic File System volume.
	HomeEfsFileSystemUid *string

	// The last modified time.
	LastModifiedTime *time.Time

	// The IAM Identity Center user identifier.
	SingleSignOnUserIdentifier *string

	// The IAM Identity Center user value.
	SingleSignOnUserValue *string

	// The status.
	Status types.UserProfileStatus

	// The user profile Amazon Resource Name (ARN).
	UserProfileArn *string

	// The user profile name.
	UserProfileName *string

	// A collection of settings.
	UserSettings *types.UserSettings

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

type DescribeWorkforceInput

type DescribeWorkforceInput struct {

	// The name of the private workforce whose access you want to restrict.
	// WorkforceName is automatically set to default when a workforce is created and
	// cannot be modified.
	//
	// This member is required.
	WorkforceName *string
	// contains filtered or unexported fields
}

type DescribeWorkforceOutput

type DescribeWorkforceOutput struct {

	// A single private workforce, which is automatically created when you create your
	// first private work team. You can create one private work force in each Amazon
	// Web Services Region. By default, any workforce-related API operation used in a
	// specific region will apply to the workforce created in that region. To learn how
	// to create a private workforce, see Create a Private Workforce (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html)
	// .
	//
	// This member is required.
	Workforce *types.Workforce

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

type DescribeWorkteamInput

type DescribeWorkteamInput struct {

	// The name of the work team to return a description of.
	//
	// This member is required.
	WorkteamName *string
	// contains filtered or unexported fields
}

type DescribeWorkteamOutput

type DescribeWorkteamOutput struct {

	// A Workteam instance that contains information about the work team.
	//
	// This member is required.
	Workteam *types.Workteam

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

type DisableSagemakerServicecatalogPortfolioInput added in v0.31.0

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

type DisableSagemakerServicecatalogPortfolioOutput added in v0.31.0

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

type DisassociateTrialComponentInput

type DisassociateTrialComponentInput struct {

	// The name of the component to disassociate from the trial.
	//
	// This member is required.
	TrialComponentName *string

	// The name of the trial to disassociate from.
	//
	// This member is required.
	TrialName *string
	// contains filtered or unexported fields
}

type DisassociateTrialComponentOutput

type DisassociateTrialComponentOutput struct {

	// The Amazon Resource Name (ARN) of the trial.
	TrialArn *string

	// The Amazon Resource Name (ARN) of the trial component.
	TrialComponentArn *string

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

type EnableSagemakerServicecatalogPortfolioInput added in v0.31.0

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

type EnableSagemakerServicecatalogPortfolioOutput added in v0.31.0

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

type EndpointDeletedWaiter added in v1.9.0

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

EndpointDeletedWaiter defines the waiters for EndpointDeleted

func NewEndpointDeletedWaiter added in v1.9.0

func NewEndpointDeletedWaiter(client DescribeEndpointAPIClient, optFns ...func(*EndpointDeletedWaiterOptions)) *EndpointDeletedWaiter

NewEndpointDeletedWaiter constructs a EndpointDeletedWaiter.

func (*EndpointDeletedWaiter) Wait added in v1.9.0

func (w *EndpointDeletedWaiter) Wait(ctx context.Context, params *DescribeEndpointInput, maxWaitDur time.Duration, optFns ...func(*EndpointDeletedWaiterOptions)) error

Wait calls the waiter function for EndpointDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*EndpointDeletedWaiter) WaitForOutput added in v1.19.0

func (w *EndpointDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeEndpointInput, maxWaitDur time.Duration, optFns ...func(*EndpointDeletedWaiterOptions)) (*DescribeEndpointOutput, error)

WaitForOutput calls the waiter function for EndpointDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type EndpointDeletedWaiterOptions added in v1.9.0

type EndpointDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// EndpointDeletedWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, EndpointDeletedWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeEndpointInput, *DescribeEndpointOutput, error) (bool, error)
}

EndpointDeletedWaiterOptions are waiter options for EndpointDeletedWaiter

type EndpointInServiceWaiter added in v1.9.0

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

EndpointInServiceWaiter defines the waiters for EndpointInService

func NewEndpointInServiceWaiter added in v1.9.0

func NewEndpointInServiceWaiter(client DescribeEndpointAPIClient, optFns ...func(*EndpointInServiceWaiterOptions)) *EndpointInServiceWaiter

NewEndpointInServiceWaiter constructs a EndpointInServiceWaiter.

func (*EndpointInServiceWaiter) Wait added in v1.9.0

Wait calls the waiter function for EndpointInService waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*EndpointInServiceWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for EndpointInService waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type EndpointInServiceWaiterOptions added in v1.9.0

type EndpointInServiceWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// EndpointInServiceWaiter will use default minimum delay of 30 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, EndpointInServiceWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeEndpointInput, *DescribeEndpointOutput, error) (bool, error)
}

EndpointInServiceWaiterOptions are waiter options for EndpointInServiceWaiter

type EndpointParameters added in v1.96.0

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 added in v1.96.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.96.0

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 added in v1.1.0

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 added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.96.0

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 added in v1.96.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetDeviceFleetReportInput added in v0.31.0

type GetDeviceFleetReportInput struct {

	// The name of the fleet.
	//
	// This member is required.
	DeviceFleetName *string
	// contains filtered or unexported fields
}

type GetDeviceFleetReportOutput added in v0.31.0

type GetDeviceFleetReportOutput struct {

	// The Amazon Resource Name (ARN) of the device.
	//
	// This member is required.
	DeviceFleetArn *string

	// The name of the fleet.
	//
	// This member is required.
	DeviceFleetName *string

	// The versions of Edge Manager agent deployed on the fleet.
	AgentVersions []types.AgentVersion

	// Description of the fleet.
	Description *string

	// Status of devices.
	DeviceStats *types.DeviceStats

	// Status of model on device.
	ModelStats []types.EdgeModelStat

	// The output configuration for storing sample data collected by the fleet.
	OutputConfig *types.EdgeOutputConfig

	// Timestamp of when the report was generated.
	ReportGenerated *time.Time

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

type GetLineageGroupPolicyInput added in v1.20.0

type GetLineageGroupPolicyInput struct {

	// The name or Amazon Resource Name (ARN) of the lineage group.
	//
	// This member is required.
	LineageGroupName *string
	// contains filtered or unexported fields
}

type GetLineageGroupPolicyOutput added in v1.20.0

type GetLineageGroupPolicyOutput struct {

	// The Amazon Resource Name (ARN) of the lineage group.
	LineageGroupArn *string

	// The resource policy that gives access to the lineage group in another account.
	ResourcePolicy *string

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

type GetModelPackageGroupPolicyInput added in v0.31.0

type GetModelPackageGroupPolicyInput struct {

	// The name of the model group for which to get the resource policy.
	//
	// This member is required.
	ModelPackageGroupName *string
	// contains filtered or unexported fields
}

type GetModelPackageGroupPolicyOutput added in v0.31.0

type GetModelPackageGroupPolicyOutput struct {

	// The resource policy for the model group.
	//
	// This member is required.
	ResourcePolicy *string

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

type GetSagemakerServicecatalogPortfolioStatusInput added in v0.31.0

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

type GetSagemakerServicecatalogPortfolioStatusOutput added in v0.31.0

type GetSagemakerServicecatalogPortfolioStatusOutput struct {

	// Whether Service Catalog is enabled or disabled in SageMaker.
	Status types.SagemakerServicecatalogStatus

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

type GetScalingConfigurationRecommendationInput added in v1.98.0

type GetScalingConfigurationRecommendationInput struct {

	// The name of a previously completed Inference Recommender job.
	//
	// This member is required.
	InferenceRecommendationsJobName *string

	// The name of an endpoint benchmarked during a previously completed inference
	// recommendation job. This name should come from one of the recommendations
	// returned by the job specified in the InferenceRecommendationsJobName field.
	// Specify either this field or the RecommendationId field.
	EndpointName *string

	// The recommendation ID of a previously completed inference recommendation. This
	// ID should come from one of the recommendations returned by the job specified in
	// the InferenceRecommendationsJobName field. Specify either this field or the
	// EndpointName field.
	RecommendationId *string

	// An object where you specify the anticipated traffic pattern for an endpoint.
	ScalingPolicyObjective *types.ScalingPolicyObjective

	// The percentage of how much utilization you want an instance to use before
	// autoscaling. The default value is 50%.
	TargetCpuUtilizationPerCore *int32
	// contains filtered or unexported fields
}

type GetScalingConfigurationRecommendationOutput added in v1.98.0

type GetScalingConfigurationRecommendationOutput struct {

	// An object with the recommended values for you to specify when creating an
	// autoscaling policy.
	DynamicScalingConfiguration *types.DynamicScalingConfiguration

	// The name of an endpoint benchmarked during a previously completed Inference
	// Recommender job.
	EndpointName *string

	// The name of a previously completed Inference Recommender job.
	InferenceRecommendationsJobName *string

	// An object with a list of metrics that were benchmarked during the previously
	// completed Inference Recommender job.
	Metric *types.ScalingPolicyMetric

	// The recommendation ID of a previously completed inference recommendation.
	RecommendationId *string

	// An object representing the anticipated traffic pattern for an endpoint that you
	// specified in the request.
	ScalingPolicyObjective *types.ScalingPolicyObjective

	// The percentage of how much utilization you want an instance to use before
	// autoscaling, which you specified in the request. The default value is 50%.
	TargetCpuUtilizationPerCore *int32

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

type GetSearchSuggestionsInput

type GetSearchSuggestionsInput struct {

	// The name of the SageMaker resource to search for.
	//
	// This member is required.
	Resource types.ResourceType

	// Limits the property names that are included in the response.
	SuggestionQuery *types.SuggestionQuery
	// contains filtered or unexported fields
}

type GetSearchSuggestionsOutput

type GetSearchSuggestionsOutput struct {

	// A list of property names for a Resource that match a SuggestionQuery .
	PropertyNameSuggestions []types.PropertyNameSuggestion

	// 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 IdempotencyTokenProvider added in v0.29.0

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImageCreatedWaiter added in v1.11.0

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

ImageCreatedWaiter defines the waiters for ImageCreated

func NewImageCreatedWaiter added in v1.11.0

func NewImageCreatedWaiter(client DescribeImageAPIClient, optFns ...func(*ImageCreatedWaiterOptions)) *ImageCreatedWaiter

NewImageCreatedWaiter constructs a ImageCreatedWaiter.

func (*ImageCreatedWaiter) Wait added in v1.11.0

func (w *ImageCreatedWaiter) Wait(ctx context.Context, params *DescribeImageInput, maxWaitDur time.Duration, optFns ...func(*ImageCreatedWaiterOptions)) error

Wait calls the waiter function for ImageCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ImageCreatedWaiter) WaitForOutput added in v1.19.0

func (w *ImageCreatedWaiter) WaitForOutput(ctx context.Context, params *DescribeImageInput, maxWaitDur time.Duration, optFns ...func(*ImageCreatedWaiterOptions)) (*DescribeImageOutput, error)

WaitForOutput calls the waiter function for ImageCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ImageCreatedWaiterOptions added in v1.11.0

type ImageCreatedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ImageCreatedWaiter will use default minimum delay of 60 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ImageCreatedWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeImageInput, *DescribeImageOutput, error) (bool, error)
}

ImageCreatedWaiterOptions are waiter options for ImageCreatedWaiter

type ImageDeletedWaiter added in v1.11.0

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

ImageDeletedWaiter defines the waiters for ImageDeleted

func NewImageDeletedWaiter added in v1.11.0

func NewImageDeletedWaiter(client DescribeImageAPIClient, optFns ...func(*ImageDeletedWaiterOptions)) *ImageDeletedWaiter

NewImageDeletedWaiter constructs a ImageDeletedWaiter.

func (*ImageDeletedWaiter) Wait added in v1.11.0

func (w *ImageDeletedWaiter) Wait(ctx context.Context, params *DescribeImageInput, maxWaitDur time.Duration, optFns ...func(*ImageDeletedWaiterOptions)) error

Wait calls the waiter function for ImageDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ImageDeletedWaiter) WaitForOutput added in v1.19.0

func (w *ImageDeletedWaiter) WaitForOutput(ctx context.Context, params *DescribeImageInput, maxWaitDur time.Duration, optFns ...func(*ImageDeletedWaiterOptions)) (*DescribeImageOutput, error)

WaitForOutput calls the waiter function for ImageDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ImageDeletedWaiterOptions added in v1.11.0

type ImageDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ImageDeletedWaiter will use default minimum delay of 60 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ImageDeletedWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeImageInput, *DescribeImageOutput, error) (bool, error)
}

ImageDeletedWaiterOptions are waiter options for ImageDeletedWaiter

type ImageUpdatedWaiter added in v1.11.0

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

ImageUpdatedWaiter defines the waiters for ImageUpdated

func NewImageUpdatedWaiter added in v1.11.0

func NewImageUpdatedWaiter(client DescribeImageAPIClient, optFns ...func(*ImageUpdatedWaiterOptions)) *ImageUpdatedWaiter

NewImageUpdatedWaiter constructs a ImageUpdatedWaiter.

func (*ImageUpdatedWaiter) Wait added in v1.11.0

func (w *ImageUpdatedWaiter) Wait(ctx context.Context, params *DescribeImageInput, maxWaitDur time.Duration, optFns ...func(*ImageUpdatedWaiterOptions)) error

Wait calls the waiter function for ImageUpdated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ImageUpdatedWaiter) WaitForOutput added in v1.19.0

func (w *ImageUpdatedWaiter) WaitForOutput(ctx context.Context, params *DescribeImageInput, maxWaitDur time.Duration, optFns ...func(*ImageUpdatedWaiterOptions)) (*DescribeImageOutput, error)

WaitForOutput calls the waiter function for ImageUpdated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ImageUpdatedWaiterOptions added in v1.11.0

type ImageUpdatedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ImageUpdatedWaiter will use default minimum delay of 60 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ImageUpdatedWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeImageInput, *DescribeImageOutput, error) (bool, error)
}

ImageUpdatedWaiterOptions are waiter options for ImageUpdatedWaiter

type ImageVersionCreatedWaiter added in v1.11.0

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

ImageVersionCreatedWaiter defines the waiters for ImageVersionCreated

func NewImageVersionCreatedWaiter added in v1.11.0

func NewImageVersionCreatedWaiter(client DescribeImageVersionAPIClient, optFns ...func(*ImageVersionCreatedWaiterOptions)) *ImageVersionCreatedWaiter

NewImageVersionCreatedWaiter constructs a ImageVersionCreatedWaiter.

func (*ImageVersionCreatedWaiter) Wait added in v1.11.0

Wait calls the waiter function for ImageVersionCreated waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ImageVersionCreatedWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for ImageVersionCreated waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ImageVersionCreatedWaiterOptions added in v1.11.0

type ImageVersionCreatedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ImageVersionCreatedWaiter will use default minimum delay of 60 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ImageVersionCreatedWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeImageVersionInput, *DescribeImageVersionOutput, error) (bool, error)
}

ImageVersionCreatedWaiterOptions are waiter options for ImageVersionCreatedWaiter

type ImageVersionDeletedWaiter added in v1.11.0

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

ImageVersionDeletedWaiter defines the waiters for ImageVersionDeleted

func NewImageVersionDeletedWaiter added in v1.11.0

func NewImageVersionDeletedWaiter(client DescribeImageVersionAPIClient, optFns ...func(*ImageVersionDeletedWaiterOptions)) *ImageVersionDeletedWaiter

NewImageVersionDeletedWaiter constructs a ImageVersionDeletedWaiter.

func (*ImageVersionDeletedWaiter) Wait added in v1.11.0

Wait calls the waiter function for ImageVersionDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ImageVersionDeletedWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for ImageVersionDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ImageVersionDeletedWaiterOptions added in v1.11.0

type ImageVersionDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ImageVersionDeletedWaiter will use default minimum delay of 60 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ImageVersionDeletedWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeImageVersionInput, *DescribeImageVersionOutput, error) (bool, error)
}

ImageVersionDeletedWaiterOptions are waiter options for ImageVersionDeletedWaiter

type ImportHubContentInput added in v1.56.0

type ImportHubContentInput struct {

	// The version of the hub content schema to import.
	//
	// This member is required.
	DocumentSchemaVersion *string

	// The hub content document that describes information about the hub content such
	// as type, associated containers, scripts, and more.
	//
	// This member is required.
	HubContentDocument *string

	// The name of the hub content to import.
	//
	// This member is required.
	HubContentName *string

	// The type of hub content to import.
	//
	// This member is required.
	HubContentType types.HubContentType

	// The name of the hub to import content into.
	//
	// This member is required.
	HubName *string

	// A description of the hub content to import.
	HubContentDescription *string

	// The display name of the hub content to import.
	HubContentDisplayName *string

	// A string that provides a description of the hub content. This string can
	// include links, tables, and standard markdown formating.
	HubContentMarkdown *string

	// The searchable keywords of the hub content.
	HubContentSearchKeywords []string

	// The version of the hub content to import.
	HubContentVersion *string

	// Any tags associated with the hub content.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type ImportHubContentOutput added in v1.56.0

type ImportHubContentOutput struct {

	// The ARN of the hub that the content was imported into.
	//
	// This member is required.
	HubArn *string

	// The ARN of the hub content that was imported.
	//
	// This member is required.
	HubContentArn *string

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

type ListActionsAPIClient added in v0.31.0

type ListActionsAPIClient interface {
	ListActions(context.Context, *ListActionsInput, ...func(*Options)) (*ListActionsOutput, error)
}

ListActionsAPIClient is a client that implements the ListActions operation.

type ListActionsInput added in v0.31.0

type ListActionsInput struct {

	// A filter that returns only actions of the specified type.
	ActionType *string

	// A filter that returns only actions created on or after the specified time.
	CreatedAfter *time.Time

	// A filter that returns only actions created on or before the specified time.
	CreatedBefore *time.Time

	// The maximum number of actions to return in the response. The default value is
	// 10.
	MaxResults *int32

	// If the previous call to ListActions didn't return the full set of actions, the
	// call returns a token for getting the next set of actions.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.SortActionsBy

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder

	// A filter that returns only actions with the specified source URI.
	SourceUri *string
	// contains filtered or unexported fields
}

type ListActionsOutput added in v0.31.0

type ListActionsOutput struct {

	// A list of actions and their properties.
	ActionSummaries []types.ActionSummary

	// A token for getting the next set of actions, if there are any.
	NextToken *string

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

type ListActionsPaginator added in v0.31.0

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

ListActionsPaginator is a paginator for ListActions

func NewListActionsPaginator added in v0.31.0

func NewListActionsPaginator(client ListActionsAPIClient, params *ListActionsInput, optFns ...func(*ListActionsPaginatorOptions)) *ListActionsPaginator

NewListActionsPaginator returns a new ListActionsPaginator

func (*ListActionsPaginator) HasMorePages added in v0.31.0

func (p *ListActionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListActionsPaginator) NextPage added in v0.31.0

func (p *ListActionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListActionsOutput, error)

NextPage retrieves the next ListActions page.

type ListActionsPaginatorOptions added in v0.31.0

type ListActionsPaginatorOptions struct {
	// The maximum number of actions to return in the response. The default value is
	// 10.
	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
}

ListActionsPaginatorOptions is the paginator options for ListActions

type ListAlgorithmsAPIClient added in v0.30.0

type ListAlgorithmsAPIClient interface {
	ListAlgorithms(context.Context, *ListAlgorithmsInput, ...func(*Options)) (*ListAlgorithmsOutput, error)
}

ListAlgorithmsAPIClient is a client that implements the ListAlgorithms operation.

type ListAlgorithmsInput

type ListAlgorithmsInput struct {

	// A filter that returns only algorithms created after the specified time
	// (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only algorithms created before the specified time
	// (timestamp).
	CreationTimeBefore *time.Time

	// The maximum number of algorithms to return in the response.
	MaxResults *int32

	// A string in the algorithm name. This filter returns only algorithms whose name
	// contains the specified string.
	NameContains *string

	// If the response to a previous ListAlgorithms request was truncated, the
	// response includes a NextToken . To retrieve the next set of algorithms, use the
	// token in the next request.
	NextToken *string

	// The parameter by which to sort the results. The default is CreationTime .
	SortBy types.AlgorithmSortBy

	// The sort order for the results. The default is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListAlgorithmsOutput

type ListAlgorithmsOutput struct {

	// >An array of AlgorithmSummary objects, each of which lists an algorithm.
	//
	// This member is required.
	AlgorithmSummaryList []types.AlgorithmSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of algorithms, use it in the subsequent request.
	NextToken *string

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

type ListAlgorithmsPaginator added in v0.30.0

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

ListAlgorithmsPaginator is a paginator for ListAlgorithms

func NewListAlgorithmsPaginator added in v0.30.0

func NewListAlgorithmsPaginator(client ListAlgorithmsAPIClient, params *ListAlgorithmsInput, optFns ...func(*ListAlgorithmsPaginatorOptions)) *ListAlgorithmsPaginator

NewListAlgorithmsPaginator returns a new ListAlgorithmsPaginator

func (*ListAlgorithmsPaginator) HasMorePages added in v0.30.0

func (p *ListAlgorithmsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAlgorithmsPaginator) NextPage added in v0.30.0

func (p *ListAlgorithmsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAlgorithmsOutput, error)

NextPage retrieves the next ListAlgorithms page.

type ListAlgorithmsPaginatorOptions added in v0.30.0

type ListAlgorithmsPaginatorOptions struct {
	// The maximum number of algorithms to return in the response.
	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
}

ListAlgorithmsPaginatorOptions is the paginator options for ListAlgorithms

type ListAliasesAPIClient added in v1.59.0

type ListAliasesAPIClient interface {
	ListAliases(context.Context, *ListAliasesInput, ...func(*Options)) (*ListAliasesOutput, error)
}

ListAliasesAPIClient is a client that implements the ListAliases operation.

type ListAliasesInput added in v1.59.0

type ListAliasesInput struct {

	// The name of the image.
	//
	// This member is required.
	ImageName *string

	// The alias of the image version.
	Alias *string

	// The maximum number of aliases to return.
	MaxResults *int32

	// If the previous call to ListAliases didn't return the full set of aliases, the
	// call returns a token for retrieving the next set of aliases.
	NextToken *string

	// The version of the image. If image version is not specified, the aliases of all
	// versions of the image are listed.
	Version *int32
	// contains filtered or unexported fields
}

type ListAliasesOutput added in v1.59.0

type ListAliasesOutput struct {

	// A token for getting the next set of aliases, if more aliases exist.
	NextToken *string

	// A list of SageMaker image version aliases.
	SageMakerImageVersionAliases []string

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

type ListAliasesPaginator added in v1.59.0

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

ListAliasesPaginator is a paginator for ListAliases

func NewListAliasesPaginator added in v1.59.0

func NewListAliasesPaginator(client ListAliasesAPIClient, params *ListAliasesInput, optFns ...func(*ListAliasesPaginatorOptions)) *ListAliasesPaginator

NewListAliasesPaginator returns a new ListAliasesPaginator

func (*ListAliasesPaginator) HasMorePages added in v1.59.0

func (p *ListAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAliasesPaginator) NextPage added in v1.59.0

func (p *ListAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAliasesOutput, error)

NextPage retrieves the next ListAliases page.

type ListAliasesPaginatorOptions added in v1.59.0

type ListAliasesPaginatorOptions struct {
	// The maximum number of aliases to return.
	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
}

ListAliasesPaginatorOptions is the paginator options for ListAliases

type ListAppImageConfigsAPIClient added in v0.31.0

type ListAppImageConfigsAPIClient interface {
	ListAppImageConfigs(context.Context, *ListAppImageConfigsInput, ...func(*Options)) (*ListAppImageConfigsOutput, error)
}

ListAppImageConfigsAPIClient is a client that implements the ListAppImageConfigs operation.

type ListAppImageConfigsInput added in v0.29.0

type ListAppImageConfigsInput struct {

	// A filter that returns only AppImageConfigs created on or after the specified
	// time.
	CreationTimeAfter *time.Time

	// A filter that returns only AppImageConfigs created on or before the specified
	// time.
	CreationTimeBefore *time.Time

	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	MaxResults *int32

	// A filter that returns only AppImageConfigs modified on or after the specified
	// time.
	ModifiedTimeAfter *time.Time

	// A filter that returns only AppImageConfigs modified on or before the specified
	// time.
	ModifiedTimeBefore *time.Time

	// A filter that returns only AppImageConfigs whose name contains the specified
	// string.
	NameContains *string

	// If the previous call to ListImages didn't return the full set of
	// AppImageConfigs, the call returns a token for getting the next set of
	// AppImageConfigs.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.AppImageConfigSortKey

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListAppImageConfigsOutput added in v0.29.0

type ListAppImageConfigsOutput struct {

	// A list of AppImageConfigs and their properties.
	AppImageConfigs []types.AppImageConfigDetails

	// A token for getting the next set of AppImageConfigs, if there are any.
	NextToken *string

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

type ListAppImageConfigsPaginator added in v0.31.0

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

ListAppImageConfigsPaginator is a paginator for ListAppImageConfigs

func NewListAppImageConfigsPaginator added in v0.31.0

func NewListAppImageConfigsPaginator(client ListAppImageConfigsAPIClient, params *ListAppImageConfigsInput, optFns ...func(*ListAppImageConfigsPaginatorOptions)) *ListAppImageConfigsPaginator

NewListAppImageConfigsPaginator returns a new ListAppImageConfigsPaginator

func (*ListAppImageConfigsPaginator) HasMorePages added in v0.31.0

func (p *ListAppImageConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppImageConfigsPaginator) NextPage added in v0.31.0

func (p *ListAppImageConfigsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppImageConfigsOutput, error)

NextPage retrieves the next ListAppImageConfigs page.

type ListAppImageConfigsPaginatorOptions added in v0.31.0

type ListAppImageConfigsPaginatorOptions struct {
	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	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
}

ListAppImageConfigsPaginatorOptions is the paginator options for ListAppImageConfigs

type ListAppsAPIClient added in v0.30.0

type ListAppsAPIClient interface {
	ListApps(context.Context, *ListAppsInput, ...func(*Options)) (*ListAppsOutput, error)
}

ListAppsAPIClient is a client that implements the ListApps operation.

type ListAppsInput

type ListAppsInput struct {

	// A parameter to search for the domain ID.
	DomainIdEquals *string

	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	MaxResults *int32

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

	// The parameter by which to sort the results. The default is CreationTime.
	SortBy types.AppSortKey

	// The sort order for the results. The default is Ascending.
	SortOrder types.SortOrder

	// A parameter to search by space name. If UserProfileNameEquals is set, then this
	// value cannot be set.
	SpaceNameEquals *string

	// A parameter to search by user profile name. If SpaceNameEquals is set, then
	// this value cannot be set.
	UserProfileNameEquals *string
	// contains filtered or unexported fields
}

type ListAppsOutput

type ListAppsOutput struct {

	// The list of apps.
	Apps []types.AppDetails

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

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

type ListAppsPaginator added in v0.30.0

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

ListAppsPaginator is a paginator for ListApps

func NewListAppsPaginator added in v0.30.0

func NewListAppsPaginator(client ListAppsAPIClient, params *ListAppsInput, optFns ...func(*ListAppsPaginatorOptions)) *ListAppsPaginator

NewListAppsPaginator returns a new ListAppsPaginator

func (*ListAppsPaginator) HasMorePages added in v0.30.0

func (p *ListAppsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppsPaginator) NextPage added in v0.30.0

func (p *ListAppsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppsOutput, error)

NextPage retrieves the next ListApps page.

type ListAppsPaginatorOptions added in v0.30.0

type ListAppsPaginatorOptions struct {
	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	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
}

ListAppsPaginatorOptions is the paginator options for ListApps

type ListArtifactsAPIClient added in v0.31.0

type ListArtifactsAPIClient interface {
	ListArtifacts(context.Context, *ListArtifactsInput, ...func(*Options)) (*ListArtifactsOutput, error)
}

ListArtifactsAPIClient is a client that implements the ListArtifacts operation.

type ListArtifactsInput added in v0.31.0

type ListArtifactsInput struct {

	// A filter that returns only artifacts of the specified type.
	ArtifactType *string

	// A filter that returns only artifacts created on or after the specified time.
	CreatedAfter *time.Time

	// A filter that returns only artifacts created on or before the specified time.
	CreatedBefore *time.Time

	// The maximum number of artifacts to return in the response. The default value is
	// 10.
	MaxResults *int32

	// If the previous call to ListArtifacts didn't return the full set of artifacts,
	// the call returns a token for getting the next set of artifacts.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.SortArtifactsBy

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder

	// A filter that returns only artifacts with the specified source URI.
	SourceUri *string
	// contains filtered or unexported fields
}

type ListArtifactsOutput added in v0.31.0

type ListArtifactsOutput struct {

	// A list of artifacts and their properties.
	ArtifactSummaries []types.ArtifactSummary

	// A token for getting the next set of artifacts, if there are any.
	NextToken *string

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

type ListArtifactsPaginator added in v0.31.0

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

ListArtifactsPaginator is a paginator for ListArtifacts

func NewListArtifactsPaginator added in v0.31.0

func NewListArtifactsPaginator(client ListArtifactsAPIClient, params *ListArtifactsInput, optFns ...func(*ListArtifactsPaginatorOptions)) *ListArtifactsPaginator

NewListArtifactsPaginator returns a new ListArtifactsPaginator

func (*ListArtifactsPaginator) HasMorePages added in v0.31.0

func (p *ListArtifactsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListArtifactsPaginator) NextPage added in v0.31.0

func (p *ListArtifactsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListArtifactsOutput, error)

NextPage retrieves the next ListArtifacts page.

type ListArtifactsPaginatorOptions added in v0.31.0

type ListArtifactsPaginatorOptions struct {
	// The maximum number of artifacts to return in the response. The default value is
	// 10.
	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
}

ListArtifactsPaginatorOptions is the paginator options for ListArtifacts

type ListAssociationsAPIClient added in v0.31.0

type ListAssociationsAPIClient interface {
	ListAssociations(context.Context, *ListAssociationsInput, ...func(*Options)) (*ListAssociationsOutput, error)
}

ListAssociationsAPIClient is a client that implements the ListAssociations operation.

type ListAssociationsInput added in v0.31.0

type ListAssociationsInput struct {

	// A filter that returns only associations of the specified type.
	AssociationType types.AssociationEdgeType

	// A filter that returns only associations created on or after the specified time.
	CreatedAfter *time.Time

	// A filter that returns only associations created on or before the specified time.
	CreatedBefore *time.Time

	// A filter that returns only associations with the specified destination Amazon
	// Resource Name (ARN).
	DestinationArn *string

	// A filter that returns only associations with the specified destination type.
	DestinationType *string

	// The maximum number of associations to return in the response. The default value
	// is 10.
	MaxResults *int32

	// If the previous call to ListAssociations didn't return the full set of
	// associations, the call returns a token for getting the next set of associations.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.SortAssociationsBy

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder

	// A filter that returns only associations with the specified source ARN.
	SourceArn *string

	// A filter that returns only associations with the specified source type.
	SourceType *string
	// contains filtered or unexported fields
}

type ListAssociationsOutput added in v0.31.0

type ListAssociationsOutput struct {

	// A list of associations and their properties.
	AssociationSummaries []types.AssociationSummary

	// A token for getting the next set of associations, if there are any.
	NextToken *string

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

type ListAssociationsPaginator added in v0.31.0

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

ListAssociationsPaginator is a paginator for ListAssociations

func NewListAssociationsPaginator added in v0.31.0

func NewListAssociationsPaginator(client ListAssociationsAPIClient, params *ListAssociationsInput, optFns ...func(*ListAssociationsPaginatorOptions)) *ListAssociationsPaginator

NewListAssociationsPaginator returns a new ListAssociationsPaginator

func (*ListAssociationsPaginator) HasMorePages added in v0.31.0

func (p *ListAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAssociationsPaginator) NextPage added in v0.31.0

func (p *ListAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssociationsOutput, error)

NextPage retrieves the next ListAssociations page.

type ListAssociationsPaginatorOptions added in v0.31.0

type ListAssociationsPaginatorOptions struct {
	// The maximum number of associations to return in the response. The default value
	// is 10.
	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
}

ListAssociationsPaginatorOptions is the paginator options for ListAssociations

type ListAutoMLJobsAPIClient added in v0.30.0

type ListAutoMLJobsAPIClient interface {
	ListAutoMLJobs(context.Context, *ListAutoMLJobsInput, ...func(*Options)) (*ListAutoMLJobsOutput, error)
}

ListAutoMLJobsAPIClient is a client that implements the ListAutoMLJobs operation.

type ListAutoMLJobsInput

type ListAutoMLJobsInput struct {

	// Request a list of jobs, using a filter for time.
	CreationTimeAfter *time.Time

	// Request a list of jobs, using a filter for time.
	CreationTimeBefore *time.Time

	// Request a list of jobs, using a filter for time.
	LastModifiedTimeAfter *time.Time

	// Request a list of jobs, using a filter for time.
	LastModifiedTimeBefore *time.Time

	// Request a list of jobs up to a specified limit.
	MaxResults *int32

	// Request a list of jobs, using a search filter for name.
	NameContains *string

	// If the previous response was truncated, you receive this token. Use it in your
	// next request to receive the next set of results.
	NextToken *string

	// The parameter by which to sort the results. The default is Name .
	SortBy types.AutoMLSortBy

	// The sort order for the results. The default is Descending .
	SortOrder types.AutoMLSortOrder

	// Request a list of jobs, using a filter for status.
	StatusEquals types.AutoMLJobStatus
	// contains filtered or unexported fields
}

type ListAutoMLJobsOutput

type ListAutoMLJobsOutput struct {

	// Returns a summary list of jobs.
	//
	// This member is required.
	AutoMLJobSummaries []types.AutoMLJobSummary

	// If the previous response was truncated, you receive this token. Use it in your
	// next request to receive the next set of results.
	NextToken *string

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

type ListAutoMLJobsPaginator added in v0.30.0

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

ListAutoMLJobsPaginator is a paginator for ListAutoMLJobs

func NewListAutoMLJobsPaginator added in v0.30.0

func NewListAutoMLJobsPaginator(client ListAutoMLJobsAPIClient, params *ListAutoMLJobsInput, optFns ...func(*ListAutoMLJobsPaginatorOptions)) *ListAutoMLJobsPaginator

NewListAutoMLJobsPaginator returns a new ListAutoMLJobsPaginator

func (*ListAutoMLJobsPaginator) HasMorePages added in v0.30.0

func (p *ListAutoMLJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAutoMLJobsPaginator) NextPage added in v0.30.0

func (p *ListAutoMLJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAutoMLJobsOutput, error)

NextPage retrieves the next ListAutoMLJobs page.

type ListAutoMLJobsPaginatorOptions added in v0.30.0

type ListAutoMLJobsPaginatorOptions struct {
	// Request a list of jobs up to a specified limit.
	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
}

ListAutoMLJobsPaginatorOptions is the paginator options for ListAutoMLJobs

type ListCandidatesForAutoMLJobAPIClient added in v0.30.0

type ListCandidatesForAutoMLJobAPIClient interface {
	ListCandidatesForAutoMLJob(context.Context, *ListCandidatesForAutoMLJobInput, ...func(*Options)) (*ListCandidatesForAutoMLJobOutput, error)
}

ListCandidatesForAutoMLJobAPIClient is a client that implements the ListCandidatesForAutoMLJob operation.

type ListCandidatesForAutoMLJobInput

type ListCandidatesForAutoMLJobInput struct {

	// List the candidates created for the job by providing the job's name.
	//
	// This member is required.
	AutoMLJobName *string

	// List the candidates for the job and filter by candidate name.
	CandidateNameEquals *string

	// List the job's candidates up to a specified limit.
	MaxResults *int32

	// If the previous response was truncated, you receive this token. Use it in your
	// next request to receive the next set of results.
	NextToken *string

	// The parameter by which to sort the results. The default is Descending .
	SortBy types.CandidateSortBy

	// The sort order for the results. The default is Ascending .
	SortOrder types.AutoMLSortOrder

	// List the candidates for the job and filter by status.
	StatusEquals types.CandidateStatus
	// contains filtered or unexported fields
}

type ListCandidatesForAutoMLJobOutput

type ListCandidatesForAutoMLJobOutput struct {

	// Summaries about the AutoMLCandidates .
	//
	// This member is required.
	Candidates []types.AutoMLCandidate

	// If the previous response was truncated, you receive this token. Use it in your
	// next request to receive the next set of results.
	NextToken *string

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

type ListCandidatesForAutoMLJobPaginator added in v0.30.0

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

ListCandidatesForAutoMLJobPaginator is a paginator for ListCandidatesForAutoMLJob

func NewListCandidatesForAutoMLJobPaginator added in v0.30.0

NewListCandidatesForAutoMLJobPaginator returns a new ListCandidatesForAutoMLJobPaginator

func (*ListCandidatesForAutoMLJobPaginator) HasMorePages added in v0.30.0

func (p *ListCandidatesForAutoMLJobPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCandidatesForAutoMLJobPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListCandidatesForAutoMLJob page.

type ListCandidatesForAutoMLJobPaginatorOptions added in v0.30.0

type ListCandidatesForAutoMLJobPaginatorOptions struct {
	// List the job's candidates up to a specified limit.
	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
}

ListCandidatesForAutoMLJobPaginatorOptions is the paginator options for ListCandidatesForAutoMLJob

type ListClusterNodesInput added in v1.119.0

type ListClusterNodesInput struct {

	// The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod
	// cluster in which you want to retrieve the list of nodes.
	//
	// This member is required.
	ClusterName *string

	// A filter that returns nodes in a SageMaker HyperPod cluster created after the
	// specified time. Timestamps are formatted according to the ISO 8601 standard.
	// Acceptable formats include:
	//   - YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z
	//   - YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
	//   2014-10-01T12:30:00.000-08:00
	//   - YYYY-MM-DD , for example, 2014-10-01
	//   - Unix time in seconds, for example, 1412195400 . This is also referred to as
	//   Unix Epoch time and represents the number of seconds since midnight, January 1,
	//   1970 UTC.
	// For more information about the timestamp format, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp)
	// in the Amazon Web Services Command Line Interface User Guide.
	CreationTimeAfter *time.Time

	// A filter that returns nodes in a SageMaker HyperPod cluster created before the
	// specified time. The acceptable formats are the same as the timestamp formats for
	// CreationTimeAfter . For more information about the timestamp format, see
	// Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp)
	// in the Amazon Web Services Command Line Interface User Guide.
	CreationTimeBefore *time.Time

	// A filter that returns the instance groups whose name contain a specified string.
	InstanceGroupNameContains *string

	// The maximum number of nodes to return in the response.
	MaxResults *int32

	// If the result of the previous ListClusterNodes request was truncated, the
	// response includes a NextToken . To retrieve the next set of cluster nodes, use
	// the token in the next request.
	NextToken *string

	// The field by which to sort results. The default value is CREATION_TIME .
	SortBy types.ClusterSortBy

	// The sort order for results. The default value is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListClusterNodesOutput added in v1.119.0

type ListClusterNodesOutput struct {

	// The summaries of listed instances in a SageMaker HyperPod cluster
	//
	// This member is required.
	ClusterNodeSummaries []types.ClusterNodeSummary

	// The next token specified for listing instances in a SageMaker HyperPod cluster.
	//
	// This member is required.
	NextToken *string

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

type ListClustersInput added in v1.119.0

type ListClustersInput struct {

	// Set a start time for the time range during which you want to list SageMaker
	// HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.
	// Acceptable formats include:
	//   - YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z
	//   - YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example,
	//   2014-10-01T12:30:00.000-08:00
	//   - YYYY-MM-DD , for example, 2014-10-01
	//   - Unix time in seconds, for example, 1412195400 . This is also referred to as
	//   Unix Epoch time and represents the number of seconds since midnight, January 1,
	//   1970 UTC.
	// For more information about the timestamp format, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp)
	// in the Amazon Web Services Command Line Interface User Guide.
	CreationTimeAfter *time.Time

	// Set an end time for the time range during which you want to list SageMaker
	// HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster
	// created before the specified time. The acceptable formats are the same as the
	// timestamp formats for CreationTimeAfter . For more information about the
	// timestamp format, see Timestamp (https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-types.html#parameter-type-timestamp)
	// in the Amazon Web Services Command Line Interface User Guide.
	CreationTimeBefore *time.Time

	// Set the maximum number of SageMaker HyperPod clusters to list.
	MaxResults *int32

	// Set the maximum number of instances to print in the list.
	NameContains *string

	// Set the next token to retrieve the list of SageMaker HyperPod clusters.
	NextToken *string

	// The field by which to sort results. The default value is CREATION_TIME .
	SortBy types.ClusterSortBy

	// The sort order for results. The default value is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListClustersOutput added in v1.119.0

type ListClustersOutput struct {

	// The summaries of listed SageMaker HyperPod clusters.
	//
	// This member is required.
	ClusterSummaries []types.ClusterSummary

	// If the result of the previous ListClusters request was truncated, the response
	// includes a NextToken . To retrieve the next set of clusters, use the token in
	// the next request.
	//
	// This member is required.
	NextToken *string

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

type ListCodeRepositoriesAPIClient added in v0.30.0

type ListCodeRepositoriesAPIClient interface {
	ListCodeRepositories(context.Context, *ListCodeRepositoriesInput, ...func(*Options)) (*ListCodeRepositoriesOutput, error)
}

ListCodeRepositoriesAPIClient is a client that implements the ListCodeRepositories operation.

type ListCodeRepositoriesInput

type ListCodeRepositoriesInput struct {

	// A filter that returns only Git repositories that were created after the
	// specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only Git repositories that were created before the
	// specified time.
	CreationTimeBefore *time.Time

	// A filter that returns only Git repositories that were last modified after the
	// specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only Git repositories that were last modified before the
	// specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of Git repositories to return in the response.
	MaxResults *int32

	// A string in the Git repositories name. This filter returns only repositories
	// whose name contains the specified string.
	NameContains *string

	// If the result of a ListCodeRepositoriesOutput request was truncated, the
	// response includes a NextToken . To get the next set of Git repositories, use the
	// token in the next request.
	NextToken *string

	// The field to sort results by. The default is Name .
	SortBy types.CodeRepositorySortBy

	// The sort order for results. The default is Ascending .
	SortOrder types.CodeRepositorySortOrder
	// contains filtered or unexported fields
}

type ListCodeRepositoriesOutput

type ListCodeRepositoriesOutput struct {

	// Gets a list of summaries of the Git repositories. Each summary specifies the
	// following values for the repository:
	//   - Name
	//   - Amazon Resource Name (ARN)
	//   - Creation time
	//   - Last modified time
	//   - Configuration information, including the URL location of the repository and
	//   the ARN of the Amazon Web Services Secrets Manager secret that contains the
	//   credentials used to access the repository.
	//
	// This member is required.
	CodeRepositorySummaryList []types.CodeRepositorySummary

	// If the result of a ListCodeRepositoriesOutput request was truncated, the
	// response includes a NextToken . To get the next set of Git repositories, use the
	// token in the next request.
	NextToken *string

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

type ListCodeRepositoriesPaginator added in v0.30.0

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

ListCodeRepositoriesPaginator is a paginator for ListCodeRepositories

func NewListCodeRepositoriesPaginator added in v0.30.0

NewListCodeRepositoriesPaginator returns a new ListCodeRepositoriesPaginator

func (*ListCodeRepositoriesPaginator) HasMorePages added in v0.30.0

func (p *ListCodeRepositoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCodeRepositoriesPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListCodeRepositories page.

type ListCodeRepositoriesPaginatorOptions added in v0.30.0

type ListCodeRepositoriesPaginatorOptions struct {
	// The maximum number of Git repositories to return in the response.
	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
}

ListCodeRepositoriesPaginatorOptions is the paginator options for ListCodeRepositories

type ListCompilationJobsAPIClient added in v0.30.0

type ListCompilationJobsAPIClient interface {
	ListCompilationJobs(context.Context, *ListCompilationJobsInput, ...func(*Options)) (*ListCompilationJobsOutput, error)
}

ListCompilationJobsAPIClient is a client that implements the ListCompilationJobs operation.

type ListCompilationJobsInput

type ListCompilationJobsInput struct {

	// A filter that returns the model compilation jobs that were created after a
	// specified time.
	CreationTimeAfter *time.Time

	// A filter that returns the model compilation jobs that were created before a
	// specified time.
	CreationTimeBefore *time.Time

	// A filter that returns the model compilation jobs that were modified after a
	// specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns the model compilation jobs that were modified before a
	// specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of model compilation jobs to return in the response.
	MaxResults *int32

	// A filter that returns the model compilation jobs whose name contains a
	// specified string.
	NameContains *string

	// If the result of the previous ListCompilationJobs request was truncated, the
	// response includes a NextToken . To retrieve the next set of model compilation
	// jobs, use the token in the next request.
	NextToken *string

	// The field by which to sort results. The default is CreationTime .
	SortBy types.ListCompilationJobsSortBy

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder

	// A filter that retrieves model compilation jobs with a specific
	// CompilationJobStatus status.
	StatusEquals types.CompilationJobStatus
	// contains filtered or unexported fields
}

type ListCompilationJobsOutput

type ListCompilationJobsOutput struct {

	// An array of CompilationJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html)
	// objects, each describing a model compilation job.
	//
	// This member is required.
	CompilationJobSummaries []types.CompilationJobSummary

	// If the response is truncated, Amazon SageMaker returns this NextToken . To
	// retrieve the next set of model compilation jobs, use this token in the next
	// request.
	NextToken *string

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

type ListCompilationJobsPaginator added in v0.30.0

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

ListCompilationJobsPaginator is a paginator for ListCompilationJobs

func NewListCompilationJobsPaginator added in v0.30.0

func NewListCompilationJobsPaginator(client ListCompilationJobsAPIClient, params *ListCompilationJobsInput, optFns ...func(*ListCompilationJobsPaginatorOptions)) *ListCompilationJobsPaginator

NewListCompilationJobsPaginator returns a new ListCompilationJobsPaginator

func (*ListCompilationJobsPaginator) HasMorePages added in v0.30.0

func (p *ListCompilationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCompilationJobsPaginator) NextPage added in v0.30.0

func (p *ListCompilationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCompilationJobsOutput, error)

NextPage retrieves the next ListCompilationJobs page.

type ListCompilationJobsPaginatorOptions added in v0.30.0

type ListCompilationJobsPaginatorOptions struct {
	// The maximum number of model compilation jobs to return in the response.
	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
}

ListCompilationJobsPaginatorOptions is the paginator options for ListCompilationJobs

type ListContextsAPIClient added in v0.31.0

type ListContextsAPIClient interface {
	ListContexts(context.Context, *ListContextsInput, ...func(*Options)) (*ListContextsOutput, error)
}

ListContextsAPIClient is a client that implements the ListContexts operation.

type ListContextsInput added in v0.31.0

type ListContextsInput struct {

	// A filter that returns only contexts of the specified type.
	ContextType *string

	// A filter that returns only contexts created on or after the specified time.
	CreatedAfter *time.Time

	// A filter that returns only contexts created on or before the specified time.
	CreatedBefore *time.Time

	// The maximum number of contexts to return in the response. The default value is
	// 10.
	MaxResults *int32

	// If the previous call to ListContexts didn't return the full set of contexts,
	// the call returns a token for getting the next set of contexts.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.SortContextsBy

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder

	// A filter that returns only contexts with the specified source URI.
	SourceUri *string
	// contains filtered or unexported fields
}

type ListContextsOutput added in v0.31.0

type ListContextsOutput struct {

	// A list of contexts and their properties.
	ContextSummaries []types.ContextSummary

	// A token for getting the next set of contexts, if there are any.
	NextToken *string

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

type ListContextsPaginator added in v0.31.0

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

ListContextsPaginator is a paginator for ListContexts

func NewListContextsPaginator added in v0.31.0

func NewListContextsPaginator(client ListContextsAPIClient, params *ListContextsInput, optFns ...func(*ListContextsPaginatorOptions)) *ListContextsPaginator

NewListContextsPaginator returns a new ListContextsPaginator

func (*ListContextsPaginator) HasMorePages added in v0.31.0

func (p *ListContextsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListContextsPaginator) NextPage added in v0.31.0

func (p *ListContextsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListContextsOutput, error)

NextPage retrieves the next ListContexts page.

type ListContextsPaginatorOptions added in v0.31.0

type ListContextsPaginatorOptions struct {
	// The maximum number of contexts to return in the response. The default value is
	// 10.
	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
}

ListContextsPaginatorOptions is the paginator options for ListContexts

type ListDataQualityJobDefinitionsAPIClient added in v0.31.0

type ListDataQualityJobDefinitionsAPIClient interface {
	ListDataQualityJobDefinitions(context.Context, *ListDataQualityJobDefinitionsInput, ...func(*Options)) (*ListDataQualityJobDefinitionsOutput, error)
}

ListDataQualityJobDefinitionsAPIClient is a client that implements the ListDataQualityJobDefinitions operation.

type ListDataQualityJobDefinitionsInput added in v0.31.0

type ListDataQualityJobDefinitionsInput struct {

	// A filter that returns only data quality monitoring job definitions created
	// after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only data quality monitoring job definitions created
	// before the specified time.
	CreationTimeBefore *time.Time

	// A filter that lists the data quality job definitions associated with the
	// specified endpoint.
	EndpointName *string

	// The maximum number of data quality monitoring job definitions to return in the
	// response.
	MaxResults *int32

	// A string in the data quality monitoring job definition name. This filter
	// returns only data quality monitoring job definitions whose name contains the
	// specified string.
	NameContains *string

	// If the result of the previous ListDataQualityJobDefinitions request was
	// truncated, the response includes a NextToken . To retrieve the next set of
	// transform jobs, use the token in the next request.>
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.MonitoringJobDefinitionSortKey

	// Whether to sort the results in Ascending or Descending order. The default is
	// Descending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListDataQualityJobDefinitionsOutput added in v0.31.0

type ListDataQualityJobDefinitionsOutput struct {

	// A list of data quality monitoring job definitions.
	//
	// This member is required.
	JobDefinitionSummaries []types.MonitoringJobDefinitionSummary

	// If the result of the previous ListDataQualityJobDefinitions request was
	// truncated, the response includes a NextToken . To retrieve the next set of data
	// quality monitoring job definitions, use the token in the next request.
	NextToken *string

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

type ListDataQualityJobDefinitionsPaginator added in v0.31.0

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

ListDataQualityJobDefinitionsPaginator is a paginator for ListDataQualityJobDefinitions

func NewListDataQualityJobDefinitionsPaginator added in v0.31.0

NewListDataQualityJobDefinitionsPaginator returns a new ListDataQualityJobDefinitionsPaginator

func (*ListDataQualityJobDefinitionsPaginator) HasMorePages added in v0.31.0

func (p *ListDataQualityJobDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataQualityJobDefinitionsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListDataQualityJobDefinitions page.

type ListDataQualityJobDefinitionsPaginatorOptions added in v0.31.0

type ListDataQualityJobDefinitionsPaginatorOptions struct {
	// The maximum number of data quality monitoring job definitions to return in the
	// response.
	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
}

ListDataQualityJobDefinitionsPaginatorOptions is the paginator options for ListDataQualityJobDefinitions

type ListDeviceFleetsAPIClient added in v0.31.0

type ListDeviceFleetsAPIClient interface {
	ListDeviceFleets(context.Context, *ListDeviceFleetsInput, ...func(*Options)) (*ListDeviceFleetsOutput, error)
}

ListDeviceFleetsAPIClient is a client that implements the ListDeviceFleets operation.

type ListDeviceFleetsInput added in v0.31.0

type ListDeviceFleetsInput struct {

	// Filter fleets where packaging job was created after specified time.
	CreationTimeAfter *time.Time

	// Filter fleets where the edge packaging job was created before specified time.
	CreationTimeBefore *time.Time

	// Select fleets where the job was updated after X
	LastModifiedTimeAfter *time.Time

	// Select fleets where the job was updated before X
	LastModifiedTimeBefore *time.Time

	// The maximum number of results to select.
	MaxResults *int32

	// Filter for fleets containing this name in their fleet device name.
	NameContains *string

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string

	// The column to sort by.
	SortBy types.ListDeviceFleetsSortBy

	// What direction to sort in.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListDeviceFleetsOutput added in v0.31.0

type ListDeviceFleetsOutput struct {

	// Summary of the device fleet.
	//
	// This member is required.
	DeviceFleetSummaries []types.DeviceFleetSummary

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string

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

type ListDeviceFleetsPaginator added in v0.31.0

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

ListDeviceFleetsPaginator is a paginator for ListDeviceFleets

func NewListDeviceFleetsPaginator added in v0.31.0

func NewListDeviceFleetsPaginator(client ListDeviceFleetsAPIClient, params *ListDeviceFleetsInput, optFns ...func(*ListDeviceFleetsPaginatorOptions)) *ListDeviceFleetsPaginator

NewListDeviceFleetsPaginator returns a new ListDeviceFleetsPaginator

func (*ListDeviceFleetsPaginator) HasMorePages added in v0.31.0

func (p *ListDeviceFleetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDeviceFleetsPaginator) NextPage added in v0.31.0

func (p *ListDeviceFleetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDeviceFleetsOutput, error)

NextPage retrieves the next ListDeviceFleets page.

type ListDeviceFleetsPaginatorOptions added in v0.31.0

type ListDeviceFleetsPaginatorOptions struct {
	// The maximum number of results to select.
	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
}

ListDeviceFleetsPaginatorOptions is the paginator options for ListDeviceFleets

type ListDevicesAPIClient added in v0.31.0

type ListDevicesAPIClient interface {
	ListDevices(context.Context, *ListDevicesInput, ...func(*Options)) (*ListDevicesOutput, error)
}

ListDevicesAPIClient is a client that implements the ListDevices operation.

type ListDevicesInput added in v0.31.0

type ListDevicesInput struct {

	// Filter for fleets containing this name in their device fleet name.
	DeviceFleetName *string

	// Select fleets where the job was updated after X
	LatestHeartbeatAfter *time.Time

	// Maximum number of results to select.
	MaxResults *int32

	// A filter that searches devices that contains this name in any of their models.
	ModelName *string

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDevicesOutput added in v0.31.0

type ListDevicesOutput struct {

	// Summary of devices.
	//
	// This member is required.
	DeviceSummaries []types.DeviceSummary

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string

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

type ListDevicesPaginator added in v0.31.0

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

ListDevicesPaginator is a paginator for ListDevices

func NewListDevicesPaginator added in v0.31.0

func NewListDevicesPaginator(client ListDevicesAPIClient, params *ListDevicesInput, optFns ...func(*ListDevicesPaginatorOptions)) *ListDevicesPaginator

NewListDevicesPaginator returns a new ListDevicesPaginator

func (*ListDevicesPaginator) HasMorePages added in v0.31.0

func (p *ListDevicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevicesPaginator) NextPage added in v0.31.0

func (p *ListDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevicesOutput, error)

NextPage retrieves the next ListDevices page.

type ListDevicesPaginatorOptions added in v0.31.0

type ListDevicesPaginatorOptions struct {
	// Maximum number of results to select.
	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
}

ListDevicesPaginatorOptions is the paginator options for ListDevices

type ListDomainsAPIClient added in v0.30.0

type ListDomainsAPIClient interface {
	ListDomains(context.Context, *ListDomainsInput, ...func(*Options)) (*ListDomainsOutput, error)
}

ListDomainsAPIClient is a client that implements the ListDomains operation.

type ListDomainsInput

type ListDomainsInput struct {

	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	MaxResults *int32

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDomainsOutput

type ListDomainsOutput struct {

	// The list of domains.
	Domains []types.DomainDetails

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

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

type ListDomainsPaginator added in v0.30.0

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

ListDomainsPaginator is a paginator for ListDomains

func NewListDomainsPaginator added in v0.30.0

func NewListDomainsPaginator(client ListDomainsAPIClient, params *ListDomainsInput, optFns ...func(*ListDomainsPaginatorOptions)) *ListDomainsPaginator

NewListDomainsPaginator returns a new ListDomainsPaginator

func (*ListDomainsPaginator) HasMorePages added in v0.30.0

func (p *ListDomainsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDomainsPaginator) NextPage added in v0.30.0

func (p *ListDomainsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDomainsOutput, error)

NextPage retrieves the next ListDomains page.

type ListDomainsPaginatorOptions added in v0.30.0

type ListDomainsPaginatorOptions struct {
	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	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
}

ListDomainsPaginatorOptions is the paginator options for ListDomains

type ListEdgeDeploymentPlansAPIClient added in v1.37.0

type ListEdgeDeploymentPlansAPIClient interface {
	ListEdgeDeploymentPlans(context.Context, *ListEdgeDeploymentPlansInput, ...func(*Options)) (*ListEdgeDeploymentPlansOutput, error)
}

ListEdgeDeploymentPlansAPIClient is a client that implements the ListEdgeDeploymentPlans operation.

type ListEdgeDeploymentPlansInput added in v1.37.0

type ListEdgeDeploymentPlansInput struct {

	// Selects edge deployment plans created after this time.
	CreationTimeAfter *time.Time

	// Selects edge deployment plans created before this time.
	CreationTimeBefore *time.Time

	// Selects edge deployment plans with a device fleet name containing this name.
	DeviceFleetNameContains *string

	// Selects edge deployment plans that were last updated after this time.
	LastModifiedTimeAfter *time.Time

	// Selects edge deployment plans that were last updated before this time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of results to select (50 by default).
	MaxResults *int32

	// Selects edge deployment plans with names containing this name.
	NameContains *string

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string

	// The column by which to sort the edge deployment plans. Can be one of NAME ,
	// DEVICEFLEETNAME , CREATIONTIME , LASTMODIFIEDTIME .
	SortBy types.ListEdgeDeploymentPlansSortBy

	// The direction of the sorting (ascending or descending).
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListEdgeDeploymentPlansOutput added in v1.37.0

type ListEdgeDeploymentPlansOutput struct {

	// List of summaries of edge deployment plans.
	//
	// This member is required.
	EdgeDeploymentPlanSummaries []types.EdgeDeploymentPlanSummary

	// The token to use when calling the next page of results.
	NextToken *string

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

type ListEdgeDeploymentPlansPaginator added in v1.37.0

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

ListEdgeDeploymentPlansPaginator is a paginator for ListEdgeDeploymentPlans

func NewListEdgeDeploymentPlansPaginator added in v1.37.0

NewListEdgeDeploymentPlansPaginator returns a new ListEdgeDeploymentPlansPaginator

func (*ListEdgeDeploymentPlansPaginator) HasMorePages added in v1.37.0

func (p *ListEdgeDeploymentPlansPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEdgeDeploymentPlansPaginator) NextPage added in v1.37.0

NextPage retrieves the next ListEdgeDeploymentPlans page.

type ListEdgeDeploymentPlansPaginatorOptions added in v1.37.0

type ListEdgeDeploymentPlansPaginatorOptions struct {
	// The maximum number of results to select (50 by default).
	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
}

ListEdgeDeploymentPlansPaginatorOptions is the paginator options for ListEdgeDeploymentPlans

type ListEdgePackagingJobsAPIClient added in v0.31.0

type ListEdgePackagingJobsAPIClient interface {
	ListEdgePackagingJobs(context.Context, *ListEdgePackagingJobsInput, ...func(*Options)) (*ListEdgePackagingJobsOutput, error)
}

ListEdgePackagingJobsAPIClient is a client that implements the ListEdgePackagingJobs operation.

type ListEdgePackagingJobsInput added in v0.31.0

type ListEdgePackagingJobsInput struct {

	// Select jobs where the job was created after specified time.
	CreationTimeAfter *time.Time

	// Select jobs where the job was created before specified time.
	CreationTimeBefore *time.Time

	// Select jobs where the job was updated after specified time.
	LastModifiedTimeAfter *time.Time

	// Select jobs where the job was updated before specified time.
	LastModifiedTimeBefore *time.Time

	// Maximum number of results to select.
	MaxResults *int32

	// Filter for jobs where the model name contains this string.
	ModelNameContains *string

	// Filter for jobs containing this name in their packaging job name.
	NameContains *string

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string

	// Use to specify what column to sort by.
	SortBy types.ListEdgePackagingJobsSortBy

	// What direction to sort by.
	SortOrder types.SortOrder

	// The job status to filter for.
	StatusEquals types.EdgePackagingJobStatus
	// contains filtered or unexported fields
}

type ListEdgePackagingJobsOutput added in v0.31.0

type ListEdgePackagingJobsOutput struct {

	// Summaries of edge packaging jobs.
	//
	// This member is required.
	EdgePackagingJobSummaries []types.EdgePackagingJobSummary

	// Token to use when calling the next page of results.
	NextToken *string

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

type ListEdgePackagingJobsPaginator added in v0.31.0

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

ListEdgePackagingJobsPaginator is a paginator for ListEdgePackagingJobs

func NewListEdgePackagingJobsPaginator added in v0.31.0

NewListEdgePackagingJobsPaginator returns a new ListEdgePackagingJobsPaginator

func (*ListEdgePackagingJobsPaginator) HasMorePages added in v0.31.0

func (p *ListEdgePackagingJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEdgePackagingJobsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListEdgePackagingJobs page.

type ListEdgePackagingJobsPaginatorOptions added in v0.31.0

type ListEdgePackagingJobsPaginatorOptions struct {
	// Maximum number of results to select.
	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
}

ListEdgePackagingJobsPaginatorOptions is the paginator options for ListEdgePackagingJobs

type ListEndpointConfigsAPIClient added in v0.30.0

type ListEndpointConfigsAPIClient interface {
	ListEndpointConfigs(context.Context, *ListEndpointConfigsInput, ...func(*Options)) (*ListEndpointConfigsOutput, error)
}

ListEndpointConfigsAPIClient is a client that implements the ListEndpointConfigs operation.

type ListEndpointConfigsInput

type ListEndpointConfigsInput struct {

	// A filter that returns only endpoint configurations with a creation time greater
	// than or equal to the specified time (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only endpoint configurations created before the specified
	// time (timestamp).
	CreationTimeBefore *time.Time

	// The maximum number of training jobs to return in the response.
	MaxResults *int32

	// A string in the endpoint configuration name. This filter returns only endpoint
	// configurations whose name contains the specified string.
	NameContains *string

	// If the result of the previous ListEndpointConfig request was truncated, the
	// response includes a NextToken . To retrieve the next set of endpoint
	// configurations, use the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.EndpointConfigSortKey

	// The sort order for results. The default is Descending .
	SortOrder types.OrderKey
	// contains filtered or unexported fields
}

type ListEndpointConfigsOutput

type ListEndpointConfigsOutput struct {

	// An array of endpoint configurations.
	//
	// This member is required.
	EndpointConfigs []types.EndpointConfigSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of endpoint configurations, use it in the subsequent request
	NextToken *string

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

type ListEndpointConfigsPaginator added in v0.30.0

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

ListEndpointConfigsPaginator is a paginator for ListEndpointConfigs

func NewListEndpointConfigsPaginator added in v0.30.0

func NewListEndpointConfigsPaginator(client ListEndpointConfigsAPIClient, params *ListEndpointConfigsInput, optFns ...func(*ListEndpointConfigsPaginatorOptions)) *ListEndpointConfigsPaginator

NewListEndpointConfigsPaginator returns a new ListEndpointConfigsPaginator

func (*ListEndpointConfigsPaginator) HasMorePages added in v0.30.0

func (p *ListEndpointConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEndpointConfigsPaginator) NextPage added in v0.30.0

func (p *ListEndpointConfigsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEndpointConfigsOutput, error)

NextPage retrieves the next ListEndpointConfigs page.

type ListEndpointConfigsPaginatorOptions added in v0.30.0

type ListEndpointConfigsPaginatorOptions struct {
	// The maximum number of training jobs to return in the response.
	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
}

ListEndpointConfigsPaginatorOptions is the paginator options for ListEndpointConfigs

type ListEndpointsAPIClient added in v0.30.0

type ListEndpointsAPIClient interface {
	ListEndpoints(context.Context, *ListEndpointsInput, ...func(*Options)) (*ListEndpointsOutput, error)
}

ListEndpointsAPIClient is a client that implements the ListEndpoints operation.

type ListEndpointsInput

type ListEndpointsInput struct {

	// A filter that returns only endpoints with a creation time greater than or equal
	// to the specified time (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only endpoints that were created before the specified
	// time (timestamp).
	CreationTimeBefore *time.Time

	// A filter that returns only endpoints that were modified after the specified
	// timestamp.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only endpoints that were modified before the specified
	// timestamp.
	LastModifiedTimeBefore *time.Time

	// The maximum number of endpoints to return in the response. This value defaults
	// to 10.
	MaxResults *int32

	// A string in endpoint names. This filter returns only endpoints whose name
	// contains the specified string.
	NameContains *string

	// If the result of a ListEndpoints request was truncated, the response includes a
	// NextToken . To retrieve the next set of endpoints, use the token in the next
	// request.
	NextToken *string

	// Sorts the list of results. The default is CreationTime .
	SortBy types.EndpointSortKey

	// The sort order for results. The default is Descending .
	SortOrder types.OrderKey

	// A filter that returns only endpoints with the specified status.
	StatusEquals types.EndpointStatus
	// contains filtered or unexported fields
}

type ListEndpointsOutput

type ListEndpointsOutput struct {

	// An array or endpoint objects.
	//
	// This member is required.
	Endpoints []types.EndpointSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of training jobs, use it in the subsequent request.
	NextToken *string

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

type ListEndpointsPaginator added in v0.30.0

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

ListEndpointsPaginator is a paginator for ListEndpoints

func NewListEndpointsPaginator added in v0.30.0

func NewListEndpointsPaginator(client ListEndpointsAPIClient, params *ListEndpointsInput, optFns ...func(*ListEndpointsPaginatorOptions)) *ListEndpointsPaginator

NewListEndpointsPaginator returns a new ListEndpointsPaginator

func (*ListEndpointsPaginator) HasMorePages added in v0.30.0

func (p *ListEndpointsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEndpointsPaginator) NextPage added in v0.30.0

func (p *ListEndpointsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEndpointsOutput, error)

NextPage retrieves the next ListEndpoints page.

type ListEndpointsPaginatorOptions added in v0.30.0

type ListEndpointsPaginatorOptions struct {
	// The maximum number of endpoints to return in the response. This value defaults
	// to 10.
	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
}

ListEndpointsPaginatorOptions is the paginator options for ListEndpoints

type ListExperimentsAPIClient added in v0.30.0

type ListExperimentsAPIClient interface {
	ListExperiments(context.Context, *ListExperimentsInput, ...func(*Options)) (*ListExperimentsOutput, error)
}

ListExperimentsAPIClient is a client that implements the ListExperiments operation.

type ListExperimentsInput

type ListExperimentsInput struct {

	// A filter that returns only experiments created after the specified time.
	CreatedAfter *time.Time

	// A filter that returns only experiments created before the specified time.
	CreatedBefore *time.Time

	// The maximum number of experiments to return in the response. The default value
	// is 10.
	MaxResults *int32

	// If the previous call to ListExperiments didn't return the full set of
	// experiments, the call returns a token for getting the next set of experiments.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.SortExperimentsBy

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListExperimentsOutput

type ListExperimentsOutput struct {

	// A list of the summaries of your experiments.
	ExperimentSummaries []types.ExperimentSummary

	// A token for getting the next set of experiments, if there are any.
	NextToken *string

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

type ListExperimentsPaginator added in v0.30.0

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

ListExperimentsPaginator is a paginator for ListExperiments

func NewListExperimentsPaginator added in v0.30.0

func NewListExperimentsPaginator(client ListExperimentsAPIClient, params *ListExperimentsInput, optFns ...func(*ListExperimentsPaginatorOptions)) *ListExperimentsPaginator

NewListExperimentsPaginator returns a new ListExperimentsPaginator

func (*ListExperimentsPaginator) HasMorePages added in v0.30.0

func (p *ListExperimentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListExperimentsPaginator) NextPage added in v0.30.0

func (p *ListExperimentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListExperimentsOutput, error)

NextPage retrieves the next ListExperiments page.

type ListExperimentsPaginatorOptions added in v0.30.0

type ListExperimentsPaginatorOptions struct {
	// The maximum number of experiments to return in the response. The default value
	// is 10.
	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
}

ListExperimentsPaginatorOptions is the paginator options for ListExperiments

type ListFeatureGroupsAPIClient added in v1.121.0

type ListFeatureGroupsAPIClient interface {
	ListFeatureGroups(context.Context, *ListFeatureGroupsInput, ...func(*Options)) (*ListFeatureGroupsOutput, error)
}

ListFeatureGroupsAPIClient is a client that implements the ListFeatureGroups operation.

type ListFeatureGroupsInput added in v0.31.0

type ListFeatureGroupsInput struct {

	// Use this parameter to search for FeatureGroups s created after a specific date
	// and time.
	CreationTimeAfter *time.Time

	// Use this parameter to search for FeatureGroups s created before a specific date
	// and time.
	CreationTimeBefore *time.Time

	// A FeatureGroup status. Filters by FeatureGroup status.
	FeatureGroupStatusEquals types.FeatureGroupStatus

	// The maximum number of results returned by ListFeatureGroups .
	MaxResults *int32

	// A string that partially matches one or more FeatureGroup s names. Filters
	// FeatureGroup s by name.
	NameContains *string

	// A token to resume pagination of ListFeatureGroups results.
	NextToken *string

	// An OfflineStore status. Filters by OfflineStore status.
	OfflineStoreStatusEquals types.OfflineStoreStatusValue

	// The value on which the feature group list is sorted.
	SortBy types.FeatureGroupSortBy

	// The order in which feature groups are listed.
	SortOrder types.FeatureGroupSortOrder
	// contains filtered or unexported fields
}

type ListFeatureGroupsOutput added in v0.31.0

type ListFeatureGroupsOutput struct {

	// A summary of feature groups.
	//
	// This member is required.
	FeatureGroupSummaries []types.FeatureGroupSummary

	// A token to resume pagination of ListFeatureGroups results.
	NextToken *string

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

type ListFeatureGroupsPaginator added in v1.121.0

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

ListFeatureGroupsPaginator is a paginator for ListFeatureGroups

func NewListFeatureGroupsPaginator added in v1.121.0

func NewListFeatureGroupsPaginator(client ListFeatureGroupsAPIClient, params *ListFeatureGroupsInput, optFns ...func(*ListFeatureGroupsPaginatorOptions)) *ListFeatureGroupsPaginator

NewListFeatureGroupsPaginator returns a new ListFeatureGroupsPaginator

func (*ListFeatureGroupsPaginator) HasMorePages added in v1.121.0

func (p *ListFeatureGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFeatureGroupsPaginator) NextPage added in v1.121.0

func (p *ListFeatureGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFeatureGroupsOutput, error)

NextPage retrieves the next ListFeatureGroups page.

type ListFeatureGroupsPaginatorOptions added in v1.121.0

type ListFeatureGroupsPaginatorOptions struct {
	// The maximum number of results returned by ListFeatureGroups .
	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
}

ListFeatureGroupsPaginatorOptions is the paginator options for ListFeatureGroups

type ListFlowDefinitionsAPIClient added in v0.30.0

type ListFlowDefinitionsAPIClient interface {
	ListFlowDefinitions(context.Context, *ListFlowDefinitionsInput, ...func(*Options)) (*ListFlowDefinitionsOutput, error)
}

ListFlowDefinitionsAPIClient is a client that implements the ListFlowDefinitions operation.

type ListFlowDefinitionsInput

type ListFlowDefinitionsInput struct {

	// A filter that returns only flow definitions with a creation time greater than
	// or equal to the specified timestamp.
	CreationTimeAfter *time.Time

	// A filter that returns only flow definitions that were created before the
	// specified timestamp.
	CreationTimeBefore *time.Time

	// The total number of items to return. If the total number of available items is
	// more than the value specified in MaxResults , then a NextToken will be provided
	// in the output that you can use to resume pagination.
	MaxResults *int32

	// A token to resume pagination.
	NextToken *string

	// An optional value that specifies whether you want the results sorted in
	// Ascending or Descending order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListFlowDefinitionsOutput

type ListFlowDefinitionsOutput struct {

	// An array of objects describing the flow definitions.
	//
	// This member is required.
	FlowDefinitionSummaries []types.FlowDefinitionSummary

	// A token to resume pagination.
	NextToken *string

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

type ListFlowDefinitionsPaginator added in v0.30.0

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

ListFlowDefinitionsPaginator is a paginator for ListFlowDefinitions

func NewListFlowDefinitionsPaginator added in v0.30.0

func NewListFlowDefinitionsPaginator(client ListFlowDefinitionsAPIClient, params *ListFlowDefinitionsInput, optFns ...func(*ListFlowDefinitionsPaginatorOptions)) *ListFlowDefinitionsPaginator

NewListFlowDefinitionsPaginator returns a new ListFlowDefinitionsPaginator

func (*ListFlowDefinitionsPaginator) HasMorePages added in v0.30.0

func (p *ListFlowDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFlowDefinitionsPaginator) NextPage added in v0.30.0

func (p *ListFlowDefinitionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFlowDefinitionsOutput, error)

NextPage retrieves the next ListFlowDefinitions page.

type ListFlowDefinitionsPaginatorOptions added in v0.30.0

type ListFlowDefinitionsPaginatorOptions struct {
	// The total number of items to return. If the total number of available items is
	// more than the value specified in MaxResults , then a NextToken will be provided
	// in the output that you can use to resume pagination.
	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
}

ListFlowDefinitionsPaginatorOptions is the paginator options for ListFlowDefinitions

type ListHubContentVersionsInput added in v1.56.0

type ListHubContentVersionsInput struct {

	// The name of the hub content.
	//
	// This member is required.
	HubContentName *string

	// The type of hub content to list versions of.
	//
	// This member is required.
	HubContentType types.HubContentType

	// The name of the hub to list the content versions of.
	//
	// This member is required.
	HubName *string

	// Only list hub content versions that were created after the time specified.
	CreationTimeAfter *time.Time

	// Only list hub content versions that were created before the time specified.
	CreationTimeBefore *time.Time

	// The maximum number of hub content versions to list.
	MaxResults *int32

	// The upper bound of the hub content schema version.
	MaxSchemaVersion *string

	// The lower bound of the hub content versions to list.
	MinVersion *string

	// If the response to a previous ListHubContentVersions request was truncated, the
	// response includes a NextToken . To retrieve the next set of hub content
	// versions, use the token in the next request.
	NextToken *string

	// Sort hub content versions by either name or creation time.
	SortBy types.HubContentSortBy

	// Sort hub content versions by ascending or descending order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListHubContentVersionsOutput added in v1.56.0

type ListHubContentVersionsOutput struct {

	// The summaries of the listed hub content versions.
	//
	// This member is required.
	HubContentSummaries []types.HubContentInfo

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of hub content versions, use it in the subsequent request.
	NextToken *string

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

type ListHubContentsInput added in v1.56.0

type ListHubContentsInput struct {

	// The type of hub content to list.
	//
	// This member is required.
	HubContentType types.HubContentType

	// The name of the hub to list the contents of.
	//
	// This member is required.
	HubName *string

	// Only list hub content that was created after the time specified.
	CreationTimeAfter *time.Time

	// Only list hub content that was created before the time specified.
	CreationTimeBefore *time.Time

	// The maximum amount of hub content to list.
	MaxResults *int32

	// The upper bound of the hub content schema verion.
	MaxSchemaVersion *string

	// Only list hub content if the name contains the specified string.
	NameContains *string

	// If the response to a previous ListHubContents request was truncated, the
	// response includes a NextToken . To retrieve the next set of hub content, use the
	// token in the next request.
	NextToken *string

	// Sort hub content versions by either name or creation time.
	SortBy types.HubContentSortBy

	// Sort hubs by ascending or descending order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListHubContentsOutput added in v1.56.0

type ListHubContentsOutput struct {

	// The summaries of the listed hub content.
	//
	// This member is required.
	HubContentSummaries []types.HubContentInfo

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of hub content, use it in the subsequent request.
	NextToken *string

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

type ListHubsInput added in v1.56.0

type ListHubsInput struct {

	// Only list hubs that were created after the time specified.
	CreationTimeAfter *time.Time

	// Only list hubs that were created before the time specified.
	CreationTimeBefore *time.Time

	// Only list hubs that were last modified after the time specified.
	LastModifiedTimeAfter *time.Time

	// Only list hubs that were last modified before the time specified.
	LastModifiedTimeBefore *time.Time

	// The maximum number of hubs to list.
	MaxResults *int32

	// Only list hubs with names that contain the specified string.
	NameContains *string

	// If the response to a previous ListHubs request was truncated, the response
	// includes a NextToken . To retrieve the next set of hubs, use the token in the
	// next request.
	NextToken *string

	// Sort hubs by either name or creation time.
	SortBy types.HubSortBy

	// Sort hubs by ascending or descending order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListHubsOutput added in v1.56.0

type ListHubsOutput struct {

	// The summaries of the listed hubs.
	//
	// This member is required.
	HubSummaries []types.HubInfo

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of hubs, use it in the subsequent request.
	NextToken *string

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

type ListHumanTaskUisAPIClient added in v0.30.0

type ListHumanTaskUisAPIClient interface {
	ListHumanTaskUis(context.Context, *ListHumanTaskUisInput, ...func(*Options)) (*ListHumanTaskUisOutput, error)
}

ListHumanTaskUisAPIClient is a client that implements the ListHumanTaskUis operation.

type ListHumanTaskUisInput

type ListHumanTaskUisInput struct {

	// A filter that returns only human task user interfaces with a creation time
	// greater than or equal to the specified timestamp.
	CreationTimeAfter *time.Time

	// A filter that returns only human task user interfaces that were created before
	// the specified timestamp.
	CreationTimeBefore *time.Time

	// The total number of items to return. If the total number of available items is
	// more than the value specified in MaxResults , then a NextToken will be provided
	// in the output that you can use to resume pagination.
	MaxResults *int32

	// A token to resume pagination.
	NextToken *string

	// An optional value that specifies whether you want the results sorted in
	// Ascending or Descending order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListHumanTaskUisOutput

type ListHumanTaskUisOutput struct {

	// An array of objects describing the human task user interfaces.
	//
	// This member is required.
	HumanTaskUiSummaries []types.HumanTaskUiSummary

	// A token to resume pagination.
	NextToken *string

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

type ListHumanTaskUisPaginator added in v0.30.0

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

ListHumanTaskUisPaginator is a paginator for ListHumanTaskUis

func NewListHumanTaskUisPaginator added in v0.30.0

func NewListHumanTaskUisPaginator(client ListHumanTaskUisAPIClient, params *ListHumanTaskUisInput, optFns ...func(*ListHumanTaskUisPaginatorOptions)) *ListHumanTaskUisPaginator

NewListHumanTaskUisPaginator returns a new ListHumanTaskUisPaginator

func (*ListHumanTaskUisPaginator) HasMorePages added in v0.30.0

func (p *ListHumanTaskUisPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListHumanTaskUisPaginator) NextPage added in v0.30.0

func (p *ListHumanTaskUisPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHumanTaskUisOutput, error)

NextPage retrieves the next ListHumanTaskUis page.

type ListHumanTaskUisPaginatorOptions added in v0.30.0

type ListHumanTaskUisPaginatorOptions struct {
	// The total number of items to return. If the total number of available items is
	// more than the value specified in MaxResults , then a NextToken will be provided
	// in the output that you can use to resume pagination.
	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
}

ListHumanTaskUisPaginatorOptions is the paginator options for ListHumanTaskUis

type ListHyperParameterTuningJobsAPIClient added in v0.30.0

type ListHyperParameterTuningJobsAPIClient interface {
	ListHyperParameterTuningJobs(context.Context, *ListHyperParameterTuningJobsInput, ...func(*Options)) (*ListHyperParameterTuningJobsOutput, error)
}

ListHyperParameterTuningJobsAPIClient is a client that implements the ListHyperParameterTuningJobs operation.

type ListHyperParameterTuningJobsInput

type ListHyperParameterTuningJobsInput struct {

	// A filter that returns only tuning jobs that were created after the specified
	// time.
	CreationTimeAfter *time.Time

	// A filter that returns only tuning jobs that were created before the specified
	// time.
	CreationTimeBefore *time.Time

	// A filter that returns only tuning jobs that were modified after the specified
	// time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only tuning jobs that were modified before the specified
	// time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of tuning jobs to return. The default value is 10.
	MaxResults *int32

	// A string in the tuning job name. This filter returns only tuning jobs whose
	// name contains the specified string.
	NameContains *string

	// If the result of the previous ListHyperParameterTuningJobs request was
	// truncated, the response includes a NextToken . To retrieve the next set of
	// tuning jobs, use the token in the next request.
	NextToken *string

	// The field to sort results by. The default is Name .
	SortBy types.HyperParameterTuningJobSortByOptions

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder

	// A filter that returns only tuning jobs with the specified status.
	StatusEquals types.HyperParameterTuningJobStatus
	// contains filtered or unexported fields
}

type ListHyperParameterTuningJobsOutput

type ListHyperParameterTuningJobsOutput struct {

	// A list of HyperParameterTuningJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html)
	// objects that describe the tuning jobs that the ListHyperParameterTuningJobs
	// request returned.
	//
	// This member is required.
	HyperParameterTuningJobSummaries []types.HyperParameterTuningJobSummary

	// If the result of this ListHyperParameterTuningJobs request was truncated, the
	// response includes a NextToken . To retrieve the next set of tuning jobs, use the
	// token in the next request.
	NextToken *string

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

type ListHyperParameterTuningJobsPaginator added in v0.30.0

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

ListHyperParameterTuningJobsPaginator is a paginator for ListHyperParameterTuningJobs

func NewListHyperParameterTuningJobsPaginator added in v0.30.0

NewListHyperParameterTuningJobsPaginator returns a new ListHyperParameterTuningJobsPaginator

func (*ListHyperParameterTuningJobsPaginator) HasMorePages added in v0.30.0

func (p *ListHyperParameterTuningJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListHyperParameterTuningJobsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListHyperParameterTuningJobs page.

type ListHyperParameterTuningJobsPaginatorOptions added in v0.30.0

type ListHyperParameterTuningJobsPaginatorOptions struct {
	// The maximum number of tuning jobs to return. The default value is 10.
	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
}

ListHyperParameterTuningJobsPaginatorOptions is the paginator options for ListHyperParameterTuningJobs

type ListImageVersionsAPIClient added in v0.30.0

type ListImageVersionsAPIClient interface {
	ListImageVersions(context.Context, *ListImageVersionsInput, ...func(*Options)) (*ListImageVersionsOutput, error)
}

ListImageVersionsAPIClient is a client that implements the ListImageVersions operation.

type ListImageVersionsInput added in v0.29.0

type ListImageVersionsInput struct {

	// The name of the image to list the versions of.
	//
	// This member is required.
	ImageName *string

	// A filter that returns only versions created on or after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only versions created on or before the specified time.
	CreationTimeBefore *time.Time

	// A filter that returns only versions modified on or after the specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only versions modified on or before the specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of versions to return in the response. The default value is
	// 10.
	MaxResults *int32

	// If the previous call to ListImageVersions didn't return the full set of
	// versions, the call returns a token for getting the next set of versions.
	NextToken *string

	// The property used to sort results. The default value is CREATION_TIME .
	SortBy types.ImageVersionSortBy

	// The sort order. The default value is DESCENDING .
	SortOrder types.ImageVersionSortOrder
	// contains filtered or unexported fields
}

type ListImageVersionsOutput added in v0.29.0

type ListImageVersionsOutput struct {

	// A list of versions and their properties.
	ImageVersions []types.ImageVersion

	// A token for getting the next set of versions, if there are any.
	NextToken *string

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

type ListImageVersionsPaginator added in v0.30.0

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

ListImageVersionsPaginator is a paginator for ListImageVersions

func NewListImageVersionsPaginator added in v0.30.0

func NewListImageVersionsPaginator(client ListImageVersionsAPIClient, params *ListImageVersionsInput, optFns ...func(*ListImageVersionsPaginatorOptions)) *ListImageVersionsPaginator

NewListImageVersionsPaginator returns a new ListImageVersionsPaginator

func (*ListImageVersionsPaginator) HasMorePages added in v0.30.0

func (p *ListImageVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImageVersionsPaginator) NextPage added in v0.30.0

func (p *ListImageVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImageVersionsOutput, error)

NextPage retrieves the next ListImageVersions page.

type ListImageVersionsPaginatorOptions added in v0.30.0

type ListImageVersionsPaginatorOptions struct {
	// The maximum number of versions to return in the response. The default value is
	// 10.
	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
}

ListImageVersionsPaginatorOptions is the paginator options for ListImageVersions

type ListImagesAPIClient added in v0.30.0

type ListImagesAPIClient interface {
	ListImages(context.Context, *ListImagesInput, ...func(*Options)) (*ListImagesOutput, error)
}

ListImagesAPIClient is a client that implements the ListImages operation.

type ListImagesInput added in v0.29.0

type ListImagesInput struct {

	// A filter that returns only images created on or after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only images created on or before the specified time.
	CreationTimeBefore *time.Time

	// A filter that returns only images modified on or after the specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only images modified on or before the specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of images to return in the response. The default value is 10.
	MaxResults *int32

	// A filter that returns only images whose name contains the specified string.
	NameContains *string

	// If the previous call to ListImages didn't return the full set of images, the
	// call returns a token for getting the next set of images.
	NextToken *string

	// The property used to sort results. The default value is CREATION_TIME .
	SortBy types.ImageSortBy

	// The sort order. The default value is DESCENDING .
	SortOrder types.ImageSortOrder
	// contains filtered or unexported fields
}

type ListImagesOutput added in v0.29.0

type ListImagesOutput struct {

	// A list of images and their properties.
	Images []types.Image

	// A token for getting the next set of images, if there are any.
	NextToken *string

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

type ListImagesPaginator added in v0.30.0

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

ListImagesPaginator is a paginator for ListImages

func NewListImagesPaginator added in v0.30.0

func NewListImagesPaginator(client ListImagesAPIClient, params *ListImagesInput, optFns ...func(*ListImagesPaginatorOptions)) *ListImagesPaginator

NewListImagesPaginator returns a new ListImagesPaginator

func (*ListImagesPaginator) HasMorePages added in v0.30.0

func (p *ListImagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListImagesPaginator) NextPage added in v0.30.0

func (p *ListImagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListImagesOutput, error)

NextPage retrieves the next ListImages page.

type ListImagesPaginatorOptions added in v0.30.0

type ListImagesPaginatorOptions struct {
	// The maximum number of images to return in the response. The default value is 10.
	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
}

ListImagesPaginatorOptions is the paginator options for ListImages

type ListInferenceComponentsAPIClient added in v1.119.0

type ListInferenceComponentsAPIClient interface {
	ListInferenceComponents(context.Context, *ListInferenceComponentsInput, ...func(*Options)) (*ListInferenceComponentsOutput, error)
}

ListInferenceComponentsAPIClient is a client that implements the ListInferenceComponents operation.

type ListInferenceComponentsInput added in v1.119.0

type ListInferenceComponentsInput struct {

	// Filters the results to only those inference components that were created after
	// the specified time.
	CreationTimeAfter *time.Time

	// Filters the results to only those inference components that were created before
	// the specified time.
	CreationTimeBefore *time.Time

	// An endpoint name to filter the listed inference components. The response
	// includes only those inference components that are hosted at the specified
	// endpoint.
	EndpointNameEquals *string

	// Filters the results to only those inference components that were updated after
	// the specified time.
	LastModifiedTimeAfter *time.Time

	// Filters the results to only those inference components that were updated before
	// the specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of inference components to return in the response. This
	// value defaults to 10.
	MaxResults *int32

	// Filters the results to only those inference components with a name that
	// contains the specified string.
	NameContains *string

	// A token that you use to get the next set of results following a truncated
	// response. If the response to the previous request was truncated, that response
	// provides the value for this token.
	NextToken *string

	// The field by which to sort the inference components in the response. The
	// default is CreationTime .
	SortBy types.InferenceComponentSortKey

	// The sort order for results. The default is Descending .
	SortOrder types.OrderKey

	// Filters the results to only those inference components with the specified
	// status.
	StatusEquals types.InferenceComponentStatus

	// A production variant name to filter the listed inference components. The
	// response includes only those inference components that are hosted at the
	// specified variant.
	VariantNameEquals *string
	// contains filtered or unexported fields
}

type ListInferenceComponentsOutput added in v1.119.0

type ListInferenceComponentsOutput struct {

	// A list of inference components and their properties that matches any of the
	// filters you specified in the request.
	//
	// This member is required.
	InferenceComponents []types.InferenceComponentSummary

	// The token to use in a subsequent request to get the next set of results
	// following a truncated response.
	NextToken *string

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

type ListInferenceComponentsPaginator added in v1.119.0

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

ListInferenceComponentsPaginator is a paginator for ListInferenceComponents

func NewListInferenceComponentsPaginator added in v1.119.0

NewListInferenceComponentsPaginator returns a new ListInferenceComponentsPaginator

func (*ListInferenceComponentsPaginator) HasMorePages added in v1.119.0

func (p *ListInferenceComponentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceComponentsPaginator) NextPage added in v1.119.0

NextPage retrieves the next ListInferenceComponents page.

type ListInferenceComponentsPaginatorOptions added in v1.119.0

type ListInferenceComponentsPaginatorOptions struct {
	// The maximum number of inference components to return in the response. This
	// value defaults to 10.
	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
}

ListInferenceComponentsPaginatorOptions is the paginator options for ListInferenceComponents

type ListInferenceExperimentsAPIClient added in v1.56.0

type ListInferenceExperimentsAPIClient interface {
	ListInferenceExperiments(context.Context, *ListInferenceExperimentsInput, ...func(*Options)) (*ListInferenceExperimentsOutput, error)
}

ListInferenceExperimentsAPIClient is a client that implements the ListInferenceExperiments operation.

type ListInferenceExperimentsInput added in v1.56.0

type ListInferenceExperimentsInput struct {

	// Selects inference experiments which were created after this timestamp.
	CreationTimeAfter *time.Time

	// Selects inference experiments which were created before this timestamp.
	CreationTimeBefore *time.Time

	// Selects inference experiments which were last modified after this timestamp.
	LastModifiedTimeAfter *time.Time

	// Selects inference experiments which were last modified before this timestamp.
	LastModifiedTimeBefore *time.Time

	// The maximum number of results to select.
	MaxResults *int32

	// Selects inference experiments whose names contain this name.
	NameContains *string

	// The response from the last list when returning a list large enough to need
	// tokening.
	NextToken *string

	// The column by which to sort the listed inference experiments.
	SortBy types.SortInferenceExperimentsBy

	// The direction of sorting (ascending or descending).
	SortOrder types.SortOrder

	// Selects inference experiments which are in this status. For the possible
	// statuses, see DescribeInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeInferenceExperiment.html)
	// .
	StatusEquals types.InferenceExperimentStatus

	// Selects inference experiments of this type. For the possible types of inference
	// experiments, see CreateInferenceExperiment (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateInferenceExperiment.html)
	// .
	Type types.InferenceExperimentType
	// contains filtered or unexported fields
}

type ListInferenceExperimentsOutput added in v1.56.0

type ListInferenceExperimentsOutput struct {

	// List of inference experiments.
	InferenceExperiments []types.InferenceExperimentSummary

	// The token to use when calling the next page of results.
	NextToken *string

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

type ListInferenceExperimentsPaginator added in v1.56.0

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

ListInferenceExperimentsPaginator is a paginator for ListInferenceExperiments

func NewListInferenceExperimentsPaginator added in v1.56.0

NewListInferenceExperimentsPaginator returns a new ListInferenceExperimentsPaginator

func (*ListInferenceExperimentsPaginator) HasMorePages added in v1.56.0

func (p *ListInferenceExperimentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceExperimentsPaginator) NextPage added in v1.56.0

NextPage retrieves the next ListInferenceExperiments page.

type ListInferenceExperimentsPaginatorOptions added in v1.56.0

type ListInferenceExperimentsPaginatorOptions struct {
	// The maximum number of results to select.
	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
}

ListInferenceExperimentsPaginatorOptions is the paginator options for ListInferenceExperiments

type ListInferenceRecommendationsJobStepsAPIClient added in v1.50.0

type ListInferenceRecommendationsJobStepsAPIClient interface {
	ListInferenceRecommendationsJobSteps(context.Context, *ListInferenceRecommendationsJobStepsInput, ...func(*Options)) (*ListInferenceRecommendationsJobStepsOutput, error)
}

ListInferenceRecommendationsJobStepsAPIClient is a client that implements the ListInferenceRecommendationsJobSteps operation.

type ListInferenceRecommendationsJobStepsInput added in v1.50.0

type ListInferenceRecommendationsJobStepsInput struct {

	// The name for the Inference Recommender job.
	//
	// This member is required.
	JobName *string

	// The maximum number of results to return.
	MaxResults *int32

	// A token that you can specify to return more results from the list. Specify this
	// field if you have a token that was returned from a previous request.
	NextToken *string

	// A filter to return benchmarks of a specified status. If this field is left
	// empty, then all benchmarks are returned.
	Status types.RecommendationJobStatus

	// A filter to return details about the specified type of subtask. BENCHMARK :
	// Evaluate the performance of your model on different instance types.
	StepType types.RecommendationStepType
	// contains filtered or unexported fields
}

type ListInferenceRecommendationsJobStepsOutput added in v1.50.0

type ListInferenceRecommendationsJobStepsOutput struct {

	// A token that you can specify in your next request to return more results from
	// the list.
	NextToken *string

	// A list of all subtask details in Inference Recommender.
	Steps []types.InferenceRecommendationsJobStep

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

type ListInferenceRecommendationsJobStepsPaginator added in v1.50.0

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

ListInferenceRecommendationsJobStepsPaginator is a paginator for ListInferenceRecommendationsJobSteps

func NewListInferenceRecommendationsJobStepsPaginator added in v1.50.0

NewListInferenceRecommendationsJobStepsPaginator returns a new ListInferenceRecommendationsJobStepsPaginator

func (*ListInferenceRecommendationsJobStepsPaginator) HasMorePages added in v1.50.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceRecommendationsJobStepsPaginator) NextPage added in v1.50.0

NextPage retrieves the next ListInferenceRecommendationsJobSteps page.

type ListInferenceRecommendationsJobStepsPaginatorOptions added in v1.50.0

type ListInferenceRecommendationsJobStepsPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

ListInferenceRecommendationsJobStepsPaginatorOptions is the paginator options for ListInferenceRecommendationsJobSteps

type ListInferenceRecommendationsJobsAPIClient added in v1.20.0

type ListInferenceRecommendationsJobsAPIClient interface {
	ListInferenceRecommendationsJobs(context.Context, *ListInferenceRecommendationsJobsInput, ...func(*Options)) (*ListInferenceRecommendationsJobsOutput, error)
}

ListInferenceRecommendationsJobsAPIClient is a client that implements the ListInferenceRecommendationsJobs operation.

type ListInferenceRecommendationsJobsInput added in v1.20.0

type ListInferenceRecommendationsJobsInput struct {

	// A filter that returns only jobs created after the specified time (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only jobs created before the specified time (timestamp).
	CreationTimeBefore *time.Time

	// A filter that returns only jobs that were last modified after the specified
	// time (timestamp).
	LastModifiedTimeAfter *time.Time

	// A filter that returns only jobs that were last modified before the specified
	// time (timestamp).
	LastModifiedTimeBefore *time.Time

	// The maximum number of recommendations to return in the response.
	MaxResults *int32

	// A filter that returns only jobs that were created for this model.
	ModelNameEquals *string

	// A filter that returns only jobs that were created for this versioned model
	// package.
	ModelPackageVersionArnEquals *string

	// A string in the job name. This filter returns only recommendations whose name
	// contains the specified string.
	NameContains *string

	// If the response to a previous ListInferenceRecommendationsJobsRequest request
	// was truncated, the response includes a NextToken . To retrieve the next set of
	// recommendations, use the token in the next request.
	NextToken *string

	// The parameter by which to sort the results.
	SortBy types.ListInferenceRecommendationsJobsSortBy

	// The sort order for the results.
	SortOrder types.SortOrder

	// A filter that retrieves only inference recommendations jobs with a specific
	// status.
	StatusEquals types.RecommendationJobStatus
	// contains filtered or unexported fields
}

type ListInferenceRecommendationsJobsOutput added in v1.20.0

type ListInferenceRecommendationsJobsOutput struct {

	// The recommendations created from the Amazon SageMaker Inference Recommender job.
	//
	// This member is required.
	InferenceRecommendationsJobs []types.InferenceRecommendationsJob

	// A token for getting the next set of recommendations, if there are any.
	NextToken *string

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

type ListInferenceRecommendationsJobsPaginator added in v1.20.0

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

ListInferenceRecommendationsJobsPaginator is a paginator for ListInferenceRecommendationsJobs

func NewListInferenceRecommendationsJobsPaginator added in v1.20.0

NewListInferenceRecommendationsJobsPaginator returns a new ListInferenceRecommendationsJobsPaginator

func (*ListInferenceRecommendationsJobsPaginator) HasMorePages added in v1.20.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListInferenceRecommendationsJobsPaginator) NextPage added in v1.20.0

NextPage retrieves the next ListInferenceRecommendationsJobs page.

type ListInferenceRecommendationsJobsPaginatorOptions added in v1.20.0

type ListInferenceRecommendationsJobsPaginatorOptions struct {
	// The maximum number of recommendations to return in the response.
	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
}

ListInferenceRecommendationsJobsPaginatorOptions is the paginator options for ListInferenceRecommendationsJobs

type ListLabelingJobsAPIClient added in v0.30.0

type ListLabelingJobsAPIClient interface {
	ListLabelingJobs(context.Context, *ListLabelingJobsInput, ...func(*Options)) (*ListLabelingJobsOutput, error)
}

ListLabelingJobsAPIClient is a client that implements the ListLabelingJobs operation.

type ListLabelingJobsForWorkteamAPIClient added in v0.30.0

type ListLabelingJobsForWorkteamAPIClient interface {
	ListLabelingJobsForWorkteam(context.Context, *ListLabelingJobsForWorkteamInput, ...func(*Options)) (*ListLabelingJobsForWorkteamOutput, error)
}

ListLabelingJobsForWorkteamAPIClient is a client that implements the ListLabelingJobsForWorkteam operation.

type ListLabelingJobsForWorkteamInput

type ListLabelingJobsForWorkteamInput struct {

	// The Amazon Resource Name (ARN) of the work team for which you want to see
	// labeling jobs for.
	//
	// This member is required.
	WorkteamArn *string

	// A filter that returns only labeling jobs created after the specified time
	// (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only labeling jobs created before the specified time
	// (timestamp).
	CreationTimeBefore *time.Time

	// A filter the limits jobs to only the ones whose job reference code contains the
	// specified string.
	JobReferenceCodeContains *string

	// The maximum number of labeling jobs to return in each page of the response.
	MaxResults *int32

	// If the result of the previous ListLabelingJobsForWorkteam request was
	// truncated, the response includes a NextToken . To retrieve the next set of
	// labeling jobs, use the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.ListLabelingJobsForWorkteamSortByOptions

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListLabelingJobsForWorkteamOutput

type ListLabelingJobsForWorkteamOutput struct {

	// An array of LabelingJobSummary objects, each describing a labeling job.
	//
	// This member is required.
	LabelingJobSummaryList []types.LabelingJobForWorkteamSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of labeling jobs, use it in the subsequent request.
	NextToken *string

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

type ListLabelingJobsForWorkteamPaginator added in v0.30.0

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

ListLabelingJobsForWorkteamPaginator is a paginator for ListLabelingJobsForWorkteam

func NewListLabelingJobsForWorkteamPaginator added in v0.30.0

NewListLabelingJobsForWorkteamPaginator returns a new ListLabelingJobsForWorkteamPaginator

func (*ListLabelingJobsForWorkteamPaginator) HasMorePages added in v0.30.0

func (p *ListLabelingJobsForWorkteamPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLabelingJobsForWorkteamPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListLabelingJobsForWorkteam page.

type ListLabelingJobsForWorkteamPaginatorOptions added in v0.30.0

type ListLabelingJobsForWorkteamPaginatorOptions struct {
	// The maximum number of labeling jobs to return in each page of the response.
	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
}

ListLabelingJobsForWorkteamPaginatorOptions is the paginator options for ListLabelingJobsForWorkteam

type ListLabelingJobsInput

type ListLabelingJobsInput struct {

	// A filter that returns only labeling jobs created after the specified time
	// (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only labeling jobs created before the specified time
	// (timestamp).
	CreationTimeBefore *time.Time

	// A filter that returns only labeling jobs modified after the specified time
	// (timestamp).
	LastModifiedTimeAfter *time.Time

	// A filter that returns only labeling jobs modified before the specified time
	// (timestamp).
	LastModifiedTimeBefore *time.Time

	// The maximum number of labeling jobs to return in each page of the response.
	MaxResults *int32

	// A string in the labeling job name. This filter returns only labeling jobs whose
	// name contains the specified string.
	NameContains *string

	// If the result of the previous ListLabelingJobs request was truncated, the
	// response includes a NextToken . To retrieve the next set of labeling jobs, use
	// the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.SortBy

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder

	// A filter that retrieves only labeling jobs with a specific status.
	StatusEquals types.LabelingJobStatus
	// contains filtered or unexported fields
}

type ListLabelingJobsOutput

type ListLabelingJobsOutput struct {

	// An array of LabelingJobSummary objects, each describing a labeling job.
	LabelingJobSummaryList []types.LabelingJobSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of labeling jobs, use it in the subsequent request.
	NextToken *string

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

type ListLabelingJobsPaginator added in v0.30.0

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

ListLabelingJobsPaginator is a paginator for ListLabelingJobs

func NewListLabelingJobsPaginator added in v0.30.0

func NewListLabelingJobsPaginator(client ListLabelingJobsAPIClient, params *ListLabelingJobsInput, optFns ...func(*ListLabelingJobsPaginatorOptions)) *ListLabelingJobsPaginator

NewListLabelingJobsPaginator returns a new ListLabelingJobsPaginator

func (*ListLabelingJobsPaginator) HasMorePages added in v0.30.0

func (p *ListLabelingJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLabelingJobsPaginator) NextPage added in v0.30.0

func (p *ListLabelingJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLabelingJobsOutput, error)

NextPage retrieves the next ListLabelingJobs page.

type ListLabelingJobsPaginatorOptions added in v0.30.0

type ListLabelingJobsPaginatorOptions struct {
	// The maximum number of labeling jobs to return in each page of the response.
	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
}

ListLabelingJobsPaginatorOptions is the paginator options for ListLabelingJobs

type ListLineageGroupsAPIClient added in v1.20.0

type ListLineageGroupsAPIClient interface {
	ListLineageGroups(context.Context, *ListLineageGroupsInput, ...func(*Options)) (*ListLineageGroupsOutput, error)
}

ListLineageGroupsAPIClient is a client that implements the ListLineageGroups operation.

type ListLineageGroupsInput added in v1.20.0

type ListLineageGroupsInput struct {

	// A timestamp to filter against lineage groups created after a certain point in
	// time.
	CreatedAfter *time.Time

	// A timestamp to filter against lineage groups created before a certain point in
	// time.
	CreatedBefore *time.Time

	// The maximum number of endpoints to return in the response. This value defaults
	// to 10.
	MaxResults *int32

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of algorithms, use it in the subsequent request.
	NextToken *string

	// The parameter by which to sort the results. The default is CreationTime .
	SortBy types.SortLineageGroupsBy

	// The sort order for the results. The default is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListLineageGroupsOutput added in v1.20.0

type ListLineageGroupsOutput struct {

	// A list of lineage groups and their properties.
	LineageGroupSummaries []types.LineageGroupSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of algorithms, use it in the subsequent request.
	NextToken *string

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

type ListLineageGroupsPaginator added in v1.20.0

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

ListLineageGroupsPaginator is a paginator for ListLineageGroups

func NewListLineageGroupsPaginator added in v1.20.0

func NewListLineageGroupsPaginator(client ListLineageGroupsAPIClient, params *ListLineageGroupsInput, optFns ...func(*ListLineageGroupsPaginatorOptions)) *ListLineageGroupsPaginator

NewListLineageGroupsPaginator returns a new ListLineageGroupsPaginator

func (*ListLineageGroupsPaginator) HasMorePages added in v1.20.0

func (p *ListLineageGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLineageGroupsPaginator) NextPage added in v1.20.0

func (p *ListLineageGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLineageGroupsOutput, error)

NextPage retrieves the next ListLineageGroups page.

type ListLineageGroupsPaginatorOptions added in v1.20.0

type ListLineageGroupsPaginatorOptions struct {
	// The maximum number of endpoints to return in the response. This value defaults
	// to 10.
	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
}

ListLineageGroupsPaginatorOptions is the paginator options for ListLineageGroups

type ListModelBiasJobDefinitionsAPIClient added in v0.31.0

type ListModelBiasJobDefinitionsAPIClient interface {
	ListModelBiasJobDefinitions(context.Context, *ListModelBiasJobDefinitionsInput, ...func(*Options)) (*ListModelBiasJobDefinitionsOutput, error)
}

ListModelBiasJobDefinitionsAPIClient is a client that implements the ListModelBiasJobDefinitions operation.

type ListModelBiasJobDefinitionsInput added in v0.31.0

type ListModelBiasJobDefinitionsInput struct {

	// A filter that returns only model bias jobs created after a specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only model bias jobs created before a specified time.
	CreationTimeBefore *time.Time

	// Name of the endpoint to monitor for model bias.
	EndpointName *string

	// The maximum number of model bias jobs to return in the response. The default
	// value is 10.
	MaxResults *int32

	// Filter for model bias jobs whose name contains a specified string.
	NameContains *string

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

	// Whether to sort results by the Name or CreationTime field. The default is
	// CreationTime .
	SortBy types.MonitoringJobDefinitionSortKey

	// Whether to sort the results in Ascending or Descending order. The default is
	// Descending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListModelBiasJobDefinitionsOutput added in v0.31.0

type ListModelBiasJobDefinitionsOutput struct {

	// A JSON array in which each element is a summary for a model bias jobs.
	//
	// This member is required.
	JobDefinitionSummaries []types.MonitoringJobDefinitionSummary

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

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

type ListModelBiasJobDefinitionsPaginator added in v0.31.0

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

ListModelBiasJobDefinitionsPaginator is a paginator for ListModelBiasJobDefinitions

func NewListModelBiasJobDefinitionsPaginator added in v0.31.0

NewListModelBiasJobDefinitionsPaginator returns a new ListModelBiasJobDefinitionsPaginator

func (*ListModelBiasJobDefinitionsPaginator) HasMorePages added in v0.31.0

func (p *ListModelBiasJobDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelBiasJobDefinitionsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListModelBiasJobDefinitions page.

type ListModelBiasJobDefinitionsPaginatorOptions added in v0.31.0

type ListModelBiasJobDefinitionsPaginatorOptions struct {
	// The maximum number of model bias jobs to return in the response. The default
	// value is 10.
	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
}

ListModelBiasJobDefinitionsPaginatorOptions is the paginator options for ListModelBiasJobDefinitions

type ListModelCardExportJobsAPIClient added in v1.56.0

type ListModelCardExportJobsAPIClient interface {
	ListModelCardExportJobs(context.Context, *ListModelCardExportJobsInput, ...func(*Options)) (*ListModelCardExportJobsOutput, error)
}

ListModelCardExportJobsAPIClient is a client that implements the ListModelCardExportJobs operation.

type ListModelCardExportJobsInput added in v1.56.0

type ListModelCardExportJobsInput struct {

	// List export jobs for the model card with the specified name.
	//
	// This member is required.
	ModelCardName *string

	// Only list model card export jobs that were created after the time specified.
	CreationTimeAfter *time.Time

	// Only list model card export jobs that were created before the time specified.
	CreationTimeBefore *time.Time

	// The maximum number of model card export jobs to list.
	MaxResults *int32

	// Only list model card export jobs with names that contain the specified string.
	ModelCardExportJobNameContains *string

	// List export jobs for the model card with the specified version.
	ModelCardVersion *int32

	// If the response to a previous ListModelCardExportJobs request was truncated,
	// the response includes a NextToken . To retrieve the next set of model card
	// export jobs, use the token in the next request.
	NextToken *string

	// Sort model card export jobs by either name or creation time. Sorts by creation
	// time by default.
	SortBy types.ModelCardExportJobSortBy

	// Sort model card export jobs by ascending or descending order.
	SortOrder types.ModelCardExportJobSortOrder

	// Only list model card export jobs with the specified status.
	StatusEquals types.ModelCardExportJobStatus
	// contains filtered or unexported fields
}

type ListModelCardExportJobsOutput added in v1.56.0

type ListModelCardExportJobsOutput struct {

	// The summaries of the listed model card export jobs.
	//
	// This member is required.
	ModelCardExportJobSummaries []types.ModelCardExportJobSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of model card export jobs, use it in the subsequent request.
	NextToken *string

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

type ListModelCardExportJobsPaginator added in v1.56.0

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

ListModelCardExportJobsPaginator is a paginator for ListModelCardExportJobs

func NewListModelCardExportJobsPaginator added in v1.56.0

NewListModelCardExportJobsPaginator returns a new ListModelCardExportJobsPaginator

func (*ListModelCardExportJobsPaginator) HasMorePages added in v1.56.0

func (p *ListModelCardExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelCardExportJobsPaginator) NextPage added in v1.56.0

NextPage retrieves the next ListModelCardExportJobs page.

type ListModelCardExportJobsPaginatorOptions added in v1.56.0

type ListModelCardExportJobsPaginatorOptions struct {
	// The maximum number of model card export jobs to list.
	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
}

ListModelCardExportJobsPaginatorOptions is the paginator options for ListModelCardExportJobs

type ListModelCardVersionsAPIClient added in v1.56.0

type ListModelCardVersionsAPIClient interface {
	ListModelCardVersions(context.Context, *ListModelCardVersionsInput, ...func(*Options)) (*ListModelCardVersionsOutput, error)
}

ListModelCardVersionsAPIClient is a client that implements the ListModelCardVersions operation.

type ListModelCardVersionsInput added in v1.56.0

type ListModelCardVersionsInput struct {

	// List model card versions for the model card with the specified name or Amazon
	// Resource Name (ARN).
	//
	// This member is required.
	ModelCardName *string

	// Only list model card versions that were created after the time specified.
	CreationTimeAfter *time.Time

	// Only list model card versions that were created before the time specified.
	CreationTimeBefore *time.Time

	// The maximum number of model card versions to list.
	MaxResults *int32

	// Only list model card versions with the specified approval status.
	ModelCardStatus types.ModelCardStatus

	// If the response to a previous ListModelCardVersions request was truncated, the
	// response includes a NextToken . To retrieve the next set of model card versions,
	// use the token in the next request.
	NextToken *string

	// Sort listed model card versions by version. Sorts by version by default.
	SortBy types.ModelCardVersionSortBy

	// Sort model card versions by ascending or descending order.
	SortOrder types.ModelCardSortOrder
	// contains filtered or unexported fields
}

type ListModelCardVersionsOutput added in v1.56.0

type ListModelCardVersionsOutput struct {

	// The summaries of the listed versions of the model card.
	//
	// This member is required.
	ModelCardVersionSummaryList []types.ModelCardVersionSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of model card versions, use it in the subsequent request.
	NextToken *string

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

type ListModelCardVersionsPaginator added in v1.56.0

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

ListModelCardVersionsPaginator is a paginator for ListModelCardVersions

func NewListModelCardVersionsPaginator added in v1.56.0

NewListModelCardVersionsPaginator returns a new ListModelCardVersionsPaginator

func (*ListModelCardVersionsPaginator) HasMorePages added in v1.56.0

func (p *ListModelCardVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelCardVersionsPaginator) NextPage added in v1.56.0

NextPage retrieves the next ListModelCardVersions page.

type ListModelCardVersionsPaginatorOptions added in v1.56.0

type ListModelCardVersionsPaginatorOptions struct {
	// The maximum number of model card versions to list.
	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
}

ListModelCardVersionsPaginatorOptions is the paginator options for ListModelCardVersions

type ListModelCardsAPIClient added in v1.56.0

type ListModelCardsAPIClient interface {
	ListModelCards(context.Context, *ListModelCardsInput, ...func(*Options)) (*ListModelCardsOutput, error)
}

ListModelCardsAPIClient is a client that implements the ListModelCards operation.

type ListModelCardsInput added in v1.56.0

type ListModelCardsInput struct {

	// Only list model cards that were created after the time specified.
	CreationTimeAfter *time.Time

	// Only list model cards that were created before the time specified.
	CreationTimeBefore *time.Time

	// The maximum number of model cards to list.
	MaxResults *int32

	// Only list model cards with the specified approval status.
	ModelCardStatus types.ModelCardStatus

	// Only list model cards with names that contain the specified string.
	NameContains *string

	// If the response to a previous ListModelCards request was truncated, the
	// response includes a NextToken . To retrieve the next set of model cards, use the
	// token in the next request.
	NextToken *string

	// Sort model cards by either name or creation time. Sorts by creation time by
	// default.
	SortBy types.ModelCardSortBy

	// Sort model cards by ascending or descending order.
	SortOrder types.ModelCardSortOrder
	// contains filtered or unexported fields
}

type ListModelCardsOutput added in v1.56.0

type ListModelCardsOutput struct {

	// The summaries of the listed model cards.
	//
	// This member is required.
	ModelCardSummaries []types.ModelCardSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of model cards, use it in the subsequent request.
	NextToken *string

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

type ListModelCardsPaginator added in v1.56.0

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

ListModelCardsPaginator is a paginator for ListModelCards

func NewListModelCardsPaginator added in v1.56.0

func NewListModelCardsPaginator(client ListModelCardsAPIClient, params *ListModelCardsInput, optFns ...func(*ListModelCardsPaginatorOptions)) *ListModelCardsPaginator

NewListModelCardsPaginator returns a new ListModelCardsPaginator

func (*ListModelCardsPaginator) HasMorePages added in v1.56.0

func (p *ListModelCardsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelCardsPaginator) NextPage added in v1.56.0

func (p *ListModelCardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelCardsOutput, error)

NextPage retrieves the next ListModelCards page.

type ListModelCardsPaginatorOptions added in v1.56.0

type ListModelCardsPaginatorOptions struct {
	// The maximum number of model cards to list.
	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
}

ListModelCardsPaginatorOptions is the paginator options for ListModelCards

type ListModelExplainabilityJobDefinitionsAPIClient added in v0.31.0

type ListModelExplainabilityJobDefinitionsAPIClient interface {
	ListModelExplainabilityJobDefinitions(context.Context, *ListModelExplainabilityJobDefinitionsInput, ...func(*Options)) (*ListModelExplainabilityJobDefinitionsOutput, error)
}

ListModelExplainabilityJobDefinitionsAPIClient is a client that implements the ListModelExplainabilityJobDefinitions operation.

type ListModelExplainabilityJobDefinitionsInput added in v0.31.0

type ListModelExplainabilityJobDefinitionsInput struct {

	// A filter that returns only model explainability jobs created after a specified
	// time.
	CreationTimeAfter *time.Time

	// A filter that returns only model explainability jobs created before a specified
	// time.
	CreationTimeBefore *time.Time

	// Name of the endpoint to monitor for model explainability.
	EndpointName *string

	// The maximum number of jobs to return in the response. The default value is 10.
	MaxResults *int32

	// Filter for model explainability jobs whose name contains a specified string.
	NameContains *string

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

	// Whether to sort results by the Name or CreationTime field. The default is
	// CreationTime .
	SortBy types.MonitoringJobDefinitionSortKey

	// Whether to sort the results in Ascending or Descending order. The default is
	// Descending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListModelExplainabilityJobDefinitionsOutput added in v0.31.0

type ListModelExplainabilityJobDefinitionsOutput struct {

	// A JSON array in which each element is a summary for a explainability bias jobs.
	//
	// This member is required.
	JobDefinitionSummaries []types.MonitoringJobDefinitionSummary

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

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

type ListModelExplainabilityJobDefinitionsPaginator added in v0.31.0

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

ListModelExplainabilityJobDefinitionsPaginator is a paginator for ListModelExplainabilityJobDefinitions

func NewListModelExplainabilityJobDefinitionsPaginator added in v0.31.0

NewListModelExplainabilityJobDefinitionsPaginator returns a new ListModelExplainabilityJobDefinitionsPaginator

func (*ListModelExplainabilityJobDefinitionsPaginator) HasMorePages added in v0.31.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelExplainabilityJobDefinitionsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListModelExplainabilityJobDefinitions page.

type ListModelExplainabilityJobDefinitionsPaginatorOptions added in v0.31.0

type ListModelExplainabilityJobDefinitionsPaginatorOptions struct {
	// The maximum number of jobs to return in the response. The default value is 10.
	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
}

ListModelExplainabilityJobDefinitionsPaginatorOptions is the paginator options for ListModelExplainabilityJobDefinitions

type ListModelMetadataAPIClient added in v1.20.0

type ListModelMetadataAPIClient interface {
	ListModelMetadata(context.Context, *ListModelMetadataInput, ...func(*Options)) (*ListModelMetadataOutput, error)
}

ListModelMetadataAPIClient is a client that implements the ListModelMetadata operation.

type ListModelMetadataInput added in v1.20.0

type ListModelMetadataInput struct {

	// The maximum number of models to return in the response.
	MaxResults *int32

	// If the response to a previous ListModelMetadataResponse request was truncated,
	// the response includes a NextToken. To retrieve the next set of model metadata,
	// use the token in the next request.
	NextToken *string

	// One or more filters that searches for the specified resource or resources in a
	// search. All resource objects that satisfy the expression's condition are
	// included in the search results. Specify the Framework, FrameworkVersion, Domain
	// or Task to filter supported. Filter names and values are case-sensitive.
	SearchExpression *types.ModelMetadataSearchExpression
	// contains filtered or unexported fields
}

type ListModelMetadataOutput added in v1.20.0

type ListModelMetadataOutput struct {

	// A structure that holds model metadata.
	//
	// This member is required.
	ModelMetadataSummaries []types.ModelMetadataSummary

	// A token for getting the next set of recommendations, if there are any.
	NextToken *string

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

type ListModelMetadataPaginator added in v1.20.0

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

ListModelMetadataPaginator is a paginator for ListModelMetadata

func NewListModelMetadataPaginator added in v1.20.0

func NewListModelMetadataPaginator(client ListModelMetadataAPIClient, params *ListModelMetadataInput, optFns ...func(*ListModelMetadataPaginatorOptions)) *ListModelMetadataPaginator

NewListModelMetadataPaginator returns a new ListModelMetadataPaginator

func (*ListModelMetadataPaginator) HasMorePages added in v1.20.0

func (p *ListModelMetadataPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelMetadataPaginator) NextPage added in v1.20.0

func (p *ListModelMetadataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelMetadataOutput, error)

NextPage retrieves the next ListModelMetadata page.

type ListModelMetadataPaginatorOptions added in v1.20.0

type ListModelMetadataPaginatorOptions struct {
	// The maximum number of models to return in the response.
	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
}

ListModelMetadataPaginatorOptions is the paginator options for ListModelMetadata

type ListModelPackageGroupsAPIClient added in v0.31.0

type ListModelPackageGroupsAPIClient interface {
	ListModelPackageGroups(context.Context, *ListModelPackageGroupsInput, ...func(*Options)) (*ListModelPackageGroupsOutput, error)
}

ListModelPackageGroupsAPIClient is a client that implements the ListModelPackageGroups operation.

type ListModelPackageGroupsInput added in v0.31.0

type ListModelPackageGroupsInput struct {

	// A filter that returns only model groups created after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only model groups created before the specified time.
	CreationTimeBefore *time.Time

	// The maximum number of results to return in the response.
	MaxResults *int32

	// A string in the model group name. This filter returns only model groups whose
	// name contains the specified string.
	NameContains *string

	// If the result of the previous ListModelPackageGroups request was truncated, the
	// response includes a NextToken . To retrieve the next set of model groups, use
	// the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.ModelPackageGroupSortBy

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListModelPackageGroupsOutput added in v0.31.0

type ListModelPackageGroupsOutput struct {

	// A list of summaries of the model groups in your Amazon Web Services account.
	//
	// This member is required.
	ModelPackageGroupSummaryList []types.ModelPackageGroupSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of model groups, use it in the subsequent request.
	NextToken *string

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

type ListModelPackageGroupsPaginator added in v0.31.0

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

ListModelPackageGroupsPaginator is a paginator for ListModelPackageGroups

func NewListModelPackageGroupsPaginator added in v0.31.0

NewListModelPackageGroupsPaginator returns a new ListModelPackageGroupsPaginator

func (*ListModelPackageGroupsPaginator) HasMorePages added in v0.31.0

func (p *ListModelPackageGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelPackageGroupsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListModelPackageGroups page.

type ListModelPackageGroupsPaginatorOptions added in v0.31.0

type ListModelPackageGroupsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	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
}

ListModelPackageGroupsPaginatorOptions is the paginator options for ListModelPackageGroups

type ListModelPackagesAPIClient added in v0.30.0

type ListModelPackagesAPIClient interface {
	ListModelPackages(context.Context, *ListModelPackagesInput, ...func(*Options)) (*ListModelPackagesOutput, error)
}

ListModelPackagesAPIClient is a client that implements the ListModelPackages operation.

type ListModelPackagesInput

type ListModelPackagesInput struct {

	// A filter that returns only model packages created after the specified time
	// (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only model packages created before the specified time
	// (timestamp).
	CreationTimeBefore *time.Time

	// The maximum number of model packages to return in the response.
	MaxResults *int32

	// A filter that returns only the model packages with the specified approval
	// status.
	ModelApprovalStatus types.ModelApprovalStatus

	// A filter that returns only model versions that belong to the specified model
	// group.
	ModelPackageGroupName *string

	// A filter that returns only the model packages of the specified type. This can
	// be one of the following values.
	//   - UNVERSIONED - List only unversioined models. This is the default value if no
	//   ModelPackageType is specified.
	//   - VERSIONED - List only versioned models.
	//   - BOTH - List both versioned and unversioned models.
	ModelPackageType types.ModelPackageType

	// A string in the model package name. This filter returns only model packages
	// whose name contains the specified string.
	NameContains *string

	// If the response to a previous ListModelPackages request was truncated, the
	// response includes a NextToken . To retrieve the next set of model packages, use
	// the token in the next request.
	NextToken *string

	// The parameter by which to sort the results. The default is CreationTime .
	SortBy types.ModelPackageSortBy

	// The sort order for the results. The default is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListModelPackagesOutput

type ListModelPackagesOutput struct {

	// An array of ModelPackageSummary objects, each of which lists a model package.
	//
	// This member is required.
	ModelPackageSummaryList []types.ModelPackageSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of model packages, use it in the subsequent request.
	NextToken *string

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

type ListModelPackagesPaginator added in v0.30.0

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

ListModelPackagesPaginator is a paginator for ListModelPackages

func NewListModelPackagesPaginator added in v0.30.0

func NewListModelPackagesPaginator(client ListModelPackagesAPIClient, params *ListModelPackagesInput, optFns ...func(*ListModelPackagesPaginatorOptions)) *ListModelPackagesPaginator

NewListModelPackagesPaginator returns a new ListModelPackagesPaginator

func (*ListModelPackagesPaginator) HasMorePages added in v0.30.0

func (p *ListModelPackagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelPackagesPaginator) NextPage added in v0.30.0

func (p *ListModelPackagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelPackagesOutput, error)

NextPage retrieves the next ListModelPackages page.

type ListModelPackagesPaginatorOptions added in v0.30.0

type ListModelPackagesPaginatorOptions struct {
	// The maximum number of model packages to return in the response.
	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
}

ListModelPackagesPaginatorOptions is the paginator options for ListModelPackages

type ListModelQualityJobDefinitionsAPIClient added in v0.31.0

type ListModelQualityJobDefinitionsAPIClient interface {
	ListModelQualityJobDefinitions(context.Context, *ListModelQualityJobDefinitionsInput, ...func(*Options)) (*ListModelQualityJobDefinitionsOutput, error)
}

ListModelQualityJobDefinitionsAPIClient is a client that implements the ListModelQualityJobDefinitions operation.

type ListModelQualityJobDefinitionsInput added in v0.31.0

type ListModelQualityJobDefinitionsInput struct {

	// A filter that returns only model quality monitoring job definitions created
	// after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only model quality monitoring job definitions created
	// before the specified time.
	CreationTimeBefore *time.Time

	// A filter that returns only model quality monitoring job definitions that are
	// associated with the specified endpoint.
	EndpointName *string

	// The maximum number of results to return in a call to
	// ListModelQualityJobDefinitions .
	MaxResults *int32

	// A string in the transform job name. This filter returns only model quality
	// monitoring job definitions whose name contains the specified string.
	NameContains *string

	// If the result of the previous ListModelQualityJobDefinitions request was
	// truncated, the response includes a NextToken . To retrieve the next set of model
	// quality monitoring job definitions, use the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.MonitoringJobDefinitionSortKey

	// Whether to sort the results in Ascending or Descending order. The default is
	// Descending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListModelQualityJobDefinitionsOutput added in v0.31.0

type ListModelQualityJobDefinitionsOutput struct {

	// A list of summaries of model quality monitoring job definitions.
	//
	// This member is required.
	JobDefinitionSummaries []types.MonitoringJobDefinitionSummary

	// If the response is truncated, Amazon SageMaker returns this token. To retrieve
	// the next set of model quality monitoring job definitions, use it in the next
	// request.
	NextToken *string

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

type ListModelQualityJobDefinitionsPaginator added in v0.31.0

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

ListModelQualityJobDefinitionsPaginator is a paginator for ListModelQualityJobDefinitions

func NewListModelQualityJobDefinitionsPaginator added in v0.31.0

NewListModelQualityJobDefinitionsPaginator returns a new ListModelQualityJobDefinitionsPaginator

func (*ListModelQualityJobDefinitionsPaginator) HasMorePages added in v0.31.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelQualityJobDefinitionsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListModelQualityJobDefinitions page.

type ListModelQualityJobDefinitionsPaginatorOptions added in v0.31.0

type ListModelQualityJobDefinitionsPaginatorOptions struct {
	// The maximum number of results to return in a call to
	// ListModelQualityJobDefinitions .
	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
}

ListModelQualityJobDefinitionsPaginatorOptions is the paginator options for ListModelQualityJobDefinitions

type ListModelsAPIClient added in v0.30.0

type ListModelsAPIClient interface {
	ListModels(context.Context, *ListModelsInput, ...func(*Options)) (*ListModelsOutput, error)
}

ListModelsAPIClient is a client that implements the ListModels operation.

type ListModelsInput

type ListModelsInput struct {

	// A filter that returns only models with a creation time greater than or equal to
	// the specified time (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only models created before the specified time (timestamp).
	CreationTimeBefore *time.Time

	// The maximum number of models to return in the response.
	MaxResults *int32

	// A string in the model name. This filter returns only models whose name contains
	// the specified string.
	NameContains *string

	// If the response to a previous ListModels request was truncated, the response
	// includes a NextToken . To retrieve the next set of models, use the token in the
	// next request.
	NextToken *string

	// Sorts the list of results. The default is CreationTime .
	SortBy types.ModelSortKey

	// The sort order for results. The default is Descending .
	SortOrder types.OrderKey
	// contains filtered or unexported fields
}

type ListModelsOutput

type ListModelsOutput struct {

	// An array of ModelSummary objects, each of which lists a model.
	//
	// This member is required.
	Models []types.ModelSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of models, use it in the subsequent request.
	NextToken *string

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

type ListModelsPaginator added in v0.30.0

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

ListModelsPaginator is a paginator for ListModels

func NewListModelsPaginator added in v0.30.0

func NewListModelsPaginator(client ListModelsAPIClient, params *ListModelsInput, optFns ...func(*ListModelsPaginatorOptions)) *ListModelsPaginator

NewListModelsPaginator returns a new ListModelsPaginator

func (*ListModelsPaginator) HasMorePages added in v0.30.0

func (p *ListModelsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListModelsPaginator) NextPage added in v0.30.0

func (p *ListModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListModelsOutput, error)

NextPage retrieves the next ListModels page.

type ListModelsPaginatorOptions added in v0.30.0

type ListModelsPaginatorOptions struct {
	// The maximum number of models to return in the response.
	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
}

ListModelsPaginatorOptions is the paginator options for ListModels

type ListMonitoringAlertHistoryAPIClient added in v1.56.0

type ListMonitoringAlertHistoryAPIClient interface {
	ListMonitoringAlertHistory(context.Context, *ListMonitoringAlertHistoryInput, ...func(*Options)) (*ListMonitoringAlertHistoryOutput, error)
}

ListMonitoringAlertHistoryAPIClient is a client that implements the ListMonitoringAlertHistory operation.

type ListMonitoringAlertHistoryInput added in v1.56.0

type ListMonitoringAlertHistoryInput struct {

	// A filter that returns only alerts created on or after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only alerts created on or before the specified time.
	CreationTimeBefore *time.Time

	// The maximum number of results to display. The default is 100.
	MaxResults *int32

	// The name of a monitoring alert.
	MonitoringAlertName *string

	// The name of a monitoring schedule.
	MonitoringScheduleName *string

	// If the result of the previous ListMonitoringAlertHistory request was truncated,
	// the response includes a NextToken . To retrieve the next set of alerts in the
	// history, use the token in the next request.
	NextToken *string

	// The field used to sort results. The default is CreationTime .
	SortBy types.MonitoringAlertHistorySortKey

	// The sort order, whether Ascending or Descending , of the alert history. The
	// default is Descending .
	SortOrder types.SortOrder

	// A filter that retrieves only alerts with a specific status.
	StatusEquals types.MonitoringAlertStatus
	// contains filtered or unexported fields
}

type ListMonitoringAlertHistoryOutput added in v1.56.0

type ListMonitoringAlertHistoryOutput struct {

	// An alert history for a model monitoring schedule.
	MonitoringAlertHistory []types.MonitoringAlertHistorySummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of alerts, use it in the subsequent request.
	NextToken *string

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

type ListMonitoringAlertHistoryPaginator added in v1.56.0

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

ListMonitoringAlertHistoryPaginator is a paginator for ListMonitoringAlertHistory

func NewListMonitoringAlertHistoryPaginator added in v1.56.0

NewListMonitoringAlertHistoryPaginator returns a new ListMonitoringAlertHistoryPaginator

func (*ListMonitoringAlertHistoryPaginator) HasMorePages added in v1.56.0

func (p *ListMonitoringAlertHistoryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitoringAlertHistoryPaginator) NextPage added in v1.56.0

NextPage retrieves the next ListMonitoringAlertHistory page.

type ListMonitoringAlertHistoryPaginatorOptions added in v1.56.0

type ListMonitoringAlertHistoryPaginatorOptions struct {
	// The maximum number of results to display. The default is 100.
	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
}

ListMonitoringAlertHistoryPaginatorOptions is the paginator options for ListMonitoringAlertHistory

type ListMonitoringAlertsAPIClient added in v1.56.0

type ListMonitoringAlertsAPIClient interface {
	ListMonitoringAlerts(context.Context, *ListMonitoringAlertsInput, ...func(*Options)) (*ListMonitoringAlertsOutput, error)
}

ListMonitoringAlertsAPIClient is a client that implements the ListMonitoringAlerts operation.

type ListMonitoringAlertsInput added in v1.56.0

type ListMonitoringAlertsInput struct {

	// The name of a monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleName *string

	// The maximum number of results to display. The default is 100.
	MaxResults *int32

	// If the result of the previous ListMonitoringAlerts request was truncated, the
	// response includes a NextToken . To retrieve the next set of alerts in the
	// history, use the token in the next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListMonitoringAlertsOutput added in v1.56.0

type ListMonitoringAlertsOutput struct {

	// A JSON array where each element is a summary for a monitoring alert.
	MonitoringAlertSummaries []types.MonitoringAlertSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of alerts, use it in the subsequent request.
	NextToken *string

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

type ListMonitoringAlertsPaginator added in v1.56.0

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

ListMonitoringAlertsPaginator is a paginator for ListMonitoringAlerts

func NewListMonitoringAlertsPaginator added in v1.56.0

NewListMonitoringAlertsPaginator returns a new ListMonitoringAlertsPaginator

func (*ListMonitoringAlertsPaginator) HasMorePages added in v1.56.0

func (p *ListMonitoringAlertsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitoringAlertsPaginator) NextPage added in v1.56.0

NextPage retrieves the next ListMonitoringAlerts page.

type ListMonitoringAlertsPaginatorOptions added in v1.56.0

type ListMonitoringAlertsPaginatorOptions struct {
	// The maximum number of results to display. The default is 100.
	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
}

ListMonitoringAlertsPaginatorOptions is the paginator options for ListMonitoringAlerts

type ListMonitoringExecutionsAPIClient added in v0.30.0

type ListMonitoringExecutionsAPIClient interface {
	ListMonitoringExecutions(context.Context, *ListMonitoringExecutionsInput, ...func(*Options)) (*ListMonitoringExecutionsOutput, error)
}

ListMonitoringExecutionsAPIClient is a client that implements the ListMonitoringExecutions operation.

type ListMonitoringExecutionsInput

type ListMonitoringExecutionsInput struct {

	// A filter that returns only jobs created after a specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only jobs created before a specified time.
	CreationTimeBefore *time.Time

	// Name of a specific endpoint to fetch jobs for.
	EndpointName *string

	// A filter that returns only jobs modified before a specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only jobs modified after a specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of jobs to return in the response. The default value is 10.
	MaxResults *int32

	// Gets a list of the monitoring job runs of the specified monitoring job
	// definitions.
	MonitoringJobDefinitionName *string

	// Name of a specific schedule to fetch jobs for.
	MonitoringScheduleName *string

	// A filter that returns only the monitoring job runs of the specified monitoring
	// type.
	MonitoringTypeEquals types.MonitoringType

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

	// Filter for jobs scheduled after a specified time.
	ScheduledTimeAfter *time.Time

	// Filter for jobs scheduled before a specified time.
	ScheduledTimeBefore *time.Time

	// Whether to sort the results by the Status , CreationTime , or ScheduledTime
	// field. The default is CreationTime .
	SortBy types.MonitoringExecutionSortKey

	// Whether to sort the results in Ascending or Descending order. The default is
	// Descending .
	SortOrder types.SortOrder

	// A filter that retrieves only jobs with a specific status.
	StatusEquals types.ExecutionStatus
	// contains filtered or unexported fields
}

type ListMonitoringExecutionsOutput

type ListMonitoringExecutionsOutput struct {

	// A JSON array in which each element is a summary for a monitoring execution.
	//
	// This member is required.
	MonitoringExecutionSummaries []types.MonitoringExecutionSummary

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

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

type ListMonitoringExecutionsPaginator added in v0.30.0

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

ListMonitoringExecutionsPaginator is a paginator for ListMonitoringExecutions

func NewListMonitoringExecutionsPaginator added in v0.30.0

NewListMonitoringExecutionsPaginator returns a new ListMonitoringExecutionsPaginator

func (*ListMonitoringExecutionsPaginator) HasMorePages added in v0.30.0

func (p *ListMonitoringExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitoringExecutionsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListMonitoringExecutions page.

type ListMonitoringExecutionsPaginatorOptions added in v0.30.0

type ListMonitoringExecutionsPaginatorOptions struct {
	// The maximum number of jobs to return in the response. The default value is 10.
	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
}

ListMonitoringExecutionsPaginatorOptions is the paginator options for ListMonitoringExecutions

type ListMonitoringSchedulesAPIClient added in v0.30.0

type ListMonitoringSchedulesAPIClient interface {
	ListMonitoringSchedules(context.Context, *ListMonitoringSchedulesInput, ...func(*Options)) (*ListMonitoringSchedulesOutput, error)
}

ListMonitoringSchedulesAPIClient is a client that implements the ListMonitoringSchedules operation.

type ListMonitoringSchedulesInput

type ListMonitoringSchedulesInput struct {

	// A filter that returns only monitoring schedules created after a specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only monitoring schedules created before a specified time.
	CreationTimeBefore *time.Time

	// Name of a specific endpoint to fetch schedules for.
	EndpointName *string

	// A filter that returns only monitoring schedules modified after a specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only monitoring schedules modified before a specified
	// time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of jobs to return in the response. The default value is 10.
	MaxResults *int32

	// Gets a list of the monitoring schedules for the specified monitoring job
	// definition.
	MonitoringJobDefinitionName *string

	// A filter that returns only the monitoring schedules for the specified
	// monitoring type.
	MonitoringTypeEquals types.MonitoringType

	// Filter for monitoring schedules whose name contains a specified string.
	NameContains *string

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

	// Whether to sort the results by the Status , CreationTime , or ScheduledTime
	// field. The default is CreationTime .
	SortBy types.MonitoringScheduleSortKey

	// Whether to sort the results in Ascending or Descending order. The default is
	// Descending .
	SortOrder types.SortOrder

	// A filter that returns only monitoring schedules modified before a specified
	// time.
	StatusEquals types.ScheduleStatus
	// contains filtered or unexported fields
}

type ListMonitoringSchedulesOutput

type ListMonitoringSchedulesOutput struct {

	// A JSON array in which each element is a summary for a monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleSummaries []types.MonitoringScheduleSummary

	// The token returned if the response is truncated. To retrieve the next set of
	// job executions, use it in the next request.
	NextToken *string

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

type ListMonitoringSchedulesPaginator added in v0.30.0

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

ListMonitoringSchedulesPaginator is a paginator for ListMonitoringSchedules

func NewListMonitoringSchedulesPaginator added in v0.30.0

NewListMonitoringSchedulesPaginator returns a new ListMonitoringSchedulesPaginator

func (*ListMonitoringSchedulesPaginator) HasMorePages added in v0.30.0

func (p *ListMonitoringSchedulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMonitoringSchedulesPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListMonitoringSchedules page.

type ListMonitoringSchedulesPaginatorOptions added in v0.30.0

type ListMonitoringSchedulesPaginatorOptions struct {
	// The maximum number of jobs to return in the response. The default value is 10.
	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
}

ListMonitoringSchedulesPaginatorOptions is the paginator options for ListMonitoringSchedules

type ListNotebookInstanceLifecycleConfigsAPIClient added in v0.30.0

type ListNotebookInstanceLifecycleConfigsAPIClient interface {
	ListNotebookInstanceLifecycleConfigs(context.Context, *ListNotebookInstanceLifecycleConfigsInput, ...func(*Options)) (*ListNotebookInstanceLifecycleConfigsOutput, error)
}

ListNotebookInstanceLifecycleConfigsAPIClient is a client that implements the ListNotebookInstanceLifecycleConfigs operation.

type ListNotebookInstanceLifecycleConfigsInput

type ListNotebookInstanceLifecycleConfigsInput struct {

	// A filter that returns only lifecycle configurations that were created after the
	// specified time (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only lifecycle configurations that were created before
	// the specified time (timestamp).
	CreationTimeBefore *time.Time

	// A filter that returns only lifecycle configurations that were modified after
	// the specified time (timestamp).
	LastModifiedTimeAfter *time.Time

	// A filter that returns only lifecycle configurations that were modified before
	// the specified time (timestamp).
	LastModifiedTimeBefore *time.Time

	// The maximum number of lifecycle configurations to return in the response.
	MaxResults *int32

	// A string in the lifecycle configuration name. This filter returns only
	// lifecycle configurations whose name contains the specified string.
	NameContains *string

	// If the result of a ListNotebookInstanceLifecycleConfigs request was truncated,
	// the response includes a NextToken . To get the next set of lifecycle
	// configurations, use the token in the next request.
	NextToken *string

	// Sorts the list of results. The default is CreationTime .
	SortBy types.NotebookInstanceLifecycleConfigSortKey

	// The sort order for results.
	SortOrder types.NotebookInstanceLifecycleConfigSortOrder
	// contains filtered or unexported fields
}

type ListNotebookInstanceLifecycleConfigsOutput

type ListNotebookInstanceLifecycleConfigsOutput struct {

	// If the response is truncated, SageMaker returns this token. To get the next set
	// of lifecycle configurations, use it in the next request.
	NextToken *string

	// An array of NotebookInstanceLifecycleConfiguration objects, each listing a
	// lifecycle configuration.
	NotebookInstanceLifecycleConfigs []types.NotebookInstanceLifecycleConfigSummary

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

type ListNotebookInstanceLifecycleConfigsPaginator added in v0.30.0

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

ListNotebookInstanceLifecycleConfigsPaginator is a paginator for ListNotebookInstanceLifecycleConfigs

func NewListNotebookInstanceLifecycleConfigsPaginator added in v0.30.0

NewListNotebookInstanceLifecycleConfigsPaginator returns a new ListNotebookInstanceLifecycleConfigsPaginator

func (*ListNotebookInstanceLifecycleConfigsPaginator) HasMorePages added in v0.30.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotebookInstanceLifecycleConfigsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListNotebookInstanceLifecycleConfigs page.

type ListNotebookInstanceLifecycleConfigsPaginatorOptions added in v0.30.0

type ListNotebookInstanceLifecycleConfigsPaginatorOptions struct {
	// The maximum number of lifecycle configurations to return in the response.
	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
}

ListNotebookInstanceLifecycleConfigsPaginatorOptions is the paginator options for ListNotebookInstanceLifecycleConfigs

type ListNotebookInstancesAPIClient added in v0.30.0

type ListNotebookInstancesAPIClient interface {
	ListNotebookInstances(context.Context, *ListNotebookInstancesInput, ...func(*Options)) (*ListNotebookInstancesOutput, error)
}

ListNotebookInstancesAPIClient is a client that implements the ListNotebookInstances operation.

type ListNotebookInstancesInput

type ListNotebookInstancesInput struct {

	// A filter that returns only notebook instances with associated with the
	// specified git repository.
	AdditionalCodeRepositoryEquals *string

	// A filter that returns only notebook instances that were created after the
	// specified time (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only notebook instances that were created before the
	// specified time (timestamp).
	CreationTimeBefore *time.Time

	// A string in the name or URL of a Git repository associated with this notebook
	// instance. This filter returns only notebook instances associated with a git
	// repository with a name that contains the specified string.
	DefaultCodeRepositoryContains *string

	// A filter that returns only notebook instances that were modified after the
	// specified time (timestamp).
	LastModifiedTimeAfter *time.Time

	// A filter that returns only notebook instances that were modified before the
	// specified time (timestamp).
	LastModifiedTimeBefore *time.Time

	// The maximum number of notebook instances to return.
	MaxResults *int32

	// A string in the notebook instances' name. This filter returns only notebook
	// instances whose name contains the specified string.
	NameContains *string

	// If the previous call to the ListNotebookInstances is truncated, the response
	// includes a NextToken . You can use this token in your subsequent
	// ListNotebookInstances request to fetch the next set of notebook instances. You
	// might specify a filter or a sort order in your request. When response is
	// truncated, you must use the same values for the filer and sort order in the next
	// request.
	NextToken *string

	// A string in the name of a notebook instances lifecycle configuration associated
	// with this notebook instance. This filter returns only notebook instances
	// associated with a lifecycle configuration with a name that contains the
	// specified string.
	NotebookInstanceLifecycleConfigNameContains *string

	// The field to sort results by. The default is Name .
	SortBy types.NotebookInstanceSortKey

	// The sort order for results.
	SortOrder types.NotebookInstanceSortOrder

	// A filter that returns only notebook instances with the specified status.
	StatusEquals types.NotebookInstanceStatus
	// contains filtered or unexported fields
}

type ListNotebookInstancesOutput

type ListNotebookInstancesOutput struct {

	// If the response to the previous ListNotebookInstances request was truncated,
	// SageMaker returns this token. To retrieve the next set of notebook instances,
	// use the token in the next request.
	NextToken *string

	// An array of NotebookInstanceSummary objects, one for each notebook instance.
	NotebookInstances []types.NotebookInstanceSummary

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

type ListNotebookInstancesPaginator added in v0.30.0

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

ListNotebookInstancesPaginator is a paginator for ListNotebookInstances

func NewListNotebookInstancesPaginator added in v0.30.0

NewListNotebookInstancesPaginator returns a new ListNotebookInstancesPaginator

func (*ListNotebookInstancesPaginator) HasMorePages added in v0.30.0

func (p *ListNotebookInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotebookInstancesPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListNotebookInstances page.

type ListNotebookInstancesPaginatorOptions added in v0.30.0

type ListNotebookInstancesPaginatorOptions struct {
	// The maximum number of notebook instances to return.
	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
}

ListNotebookInstancesPaginatorOptions is the paginator options for ListNotebookInstances

type ListPipelineExecutionStepsAPIClient added in v0.31.0

type ListPipelineExecutionStepsAPIClient interface {
	ListPipelineExecutionSteps(context.Context, *ListPipelineExecutionStepsInput, ...func(*Options)) (*ListPipelineExecutionStepsOutput, error)
}

ListPipelineExecutionStepsAPIClient is a client that implements the ListPipelineExecutionSteps operation.

type ListPipelineExecutionStepsInput added in v0.31.0

type ListPipelineExecutionStepsInput struct {

	// The maximum number of pipeline execution steps to return in the response.
	MaxResults *int32

	// If the result of the previous ListPipelineExecutionSteps request was truncated,
	// the response includes a NextToken . To retrieve the next set of pipeline
	// execution steps, use the token in the next request.
	NextToken *string

	// The Amazon Resource Name (ARN) of the pipeline execution.
	PipelineExecutionArn *string

	// The field by which to sort results. The default is CreatedTime .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListPipelineExecutionStepsOutput added in v0.31.0

type ListPipelineExecutionStepsOutput struct {

	// If the result of the previous ListPipelineExecutionSteps request was truncated,
	// the response includes a NextToken . To retrieve the next set of pipeline
	// execution steps, use the token in the next request.
	NextToken *string

	// A list of PipeLineExecutionStep objects. Each PipeLineExecutionStep consists of
	// StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object
	// with properties for each job that contains relevant information about the job
	// created by the step.
	PipelineExecutionSteps []types.PipelineExecutionStep

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

type ListPipelineExecutionStepsPaginator added in v0.31.0

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

ListPipelineExecutionStepsPaginator is a paginator for ListPipelineExecutionSteps

func NewListPipelineExecutionStepsPaginator added in v0.31.0

NewListPipelineExecutionStepsPaginator returns a new ListPipelineExecutionStepsPaginator

func (*ListPipelineExecutionStepsPaginator) HasMorePages added in v0.31.0

func (p *ListPipelineExecutionStepsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPipelineExecutionStepsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListPipelineExecutionSteps page.

type ListPipelineExecutionStepsPaginatorOptions added in v0.31.0

type ListPipelineExecutionStepsPaginatorOptions struct {
	// The maximum number of pipeline execution steps to return in the response.
	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
}

ListPipelineExecutionStepsPaginatorOptions is the paginator options for ListPipelineExecutionSteps

type ListPipelineExecutionsAPIClient added in v0.31.0

type ListPipelineExecutionsAPIClient interface {
	ListPipelineExecutions(context.Context, *ListPipelineExecutionsInput, ...func(*Options)) (*ListPipelineExecutionsOutput, error)
}

ListPipelineExecutionsAPIClient is a client that implements the ListPipelineExecutions operation.

type ListPipelineExecutionsInput added in v0.31.0

type ListPipelineExecutionsInput struct {

	// The name or Amazon Resource Name (ARN) of the pipeline.
	//
	// This member is required.
	PipelineName *string

	// A filter that returns the pipeline executions that were created after a
	// specified time.
	CreatedAfter *time.Time

	// A filter that returns the pipeline executions that were created before a
	// specified time.
	CreatedBefore *time.Time

	// The maximum number of pipeline executions to return in the response.
	MaxResults *int32

	// If the result of the previous ListPipelineExecutions request was truncated, the
	// response includes a NextToken . To retrieve the next set of pipeline executions,
	// use the token in the next request.
	NextToken *string

	// The field by which to sort results. The default is CreatedTime .
	SortBy types.SortPipelineExecutionsBy

	// The sort order for results.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListPipelineExecutionsOutput added in v0.31.0

type ListPipelineExecutionsOutput struct {

	// If the result of the previous ListPipelineExecutions request was truncated, the
	// response includes a NextToken . To retrieve the next set of pipeline executions,
	// use the token in the next request.
	NextToken *string

	// Contains a sorted list of pipeline execution summary objects matching the
	// specified filters. Each run summary includes the Amazon Resource Name (ARN) of
	// the pipeline execution, the run date, and the status. This list can be empty.
	PipelineExecutionSummaries []types.PipelineExecutionSummary

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

type ListPipelineExecutionsPaginator added in v0.31.0

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

ListPipelineExecutionsPaginator is a paginator for ListPipelineExecutions

func NewListPipelineExecutionsPaginator added in v0.31.0

NewListPipelineExecutionsPaginator returns a new ListPipelineExecutionsPaginator

func (*ListPipelineExecutionsPaginator) HasMorePages added in v0.31.0

func (p *ListPipelineExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPipelineExecutionsPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListPipelineExecutions page.

type ListPipelineExecutionsPaginatorOptions added in v0.31.0

type ListPipelineExecutionsPaginatorOptions struct {
	// The maximum number of pipeline executions to return in the response.
	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
}

ListPipelineExecutionsPaginatorOptions is the paginator options for ListPipelineExecutions

type ListPipelineParametersForExecutionAPIClient added in v0.31.0

type ListPipelineParametersForExecutionAPIClient interface {
	ListPipelineParametersForExecution(context.Context, *ListPipelineParametersForExecutionInput, ...func(*Options)) (*ListPipelineParametersForExecutionOutput, error)
}

ListPipelineParametersForExecutionAPIClient is a client that implements the ListPipelineParametersForExecution operation.

type ListPipelineParametersForExecutionInput added in v0.31.0

type ListPipelineParametersForExecutionInput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	//
	// This member is required.
	PipelineExecutionArn *string

	// The maximum number of parameters to return in the response.
	MaxResults *int32

	// If the result of the previous ListPipelineParametersForExecution request was
	// truncated, the response includes a NextToken . To retrieve the next set of
	// parameters, use the token in the next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListPipelineParametersForExecutionOutput added in v0.31.0

type ListPipelineParametersForExecutionOutput struct {

	// If the result of the previous ListPipelineParametersForExecution request was
	// truncated, the response includes a NextToken . To retrieve the next set of
	// parameters, use the token in the next request.
	NextToken *string

	// Contains a list of pipeline parameters. This list can be empty.
	PipelineParameters []types.Parameter

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

type ListPipelineParametersForExecutionPaginator added in v0.31.0

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

ListPipelineParametersForExecutionPaginator is a paginator for ListPipelineParametersForExecution

func NewListPipelineParametersForExecutionPaginator added in v0.31.0

NewListPipelineParametersForExecutionPaginator returns a new ListPipelineParametersForExecutionPaginator

func (*ListPipelineParametersForExecutionPaginator) HasMorePages added in v0.31.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPipelineParametersForExecutionPaginator) NextPage added in v0.31.0

NextPage retrieves the next ListPipelineParametersForExecution page.

type ListPipelineParametersForExecutionPaginatorOptions added in v0.31.0

type ListPipelineParametersForExecutionPaginatorOptions struct {
	// The maximum number of parameters to return in the response.
	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
}

ListPipelineParametersForExecutionPaginatorOptions is the paginator options for ListPipelineParametersForExecution

type ListPipelinesAPIClient added in v0.31.0

type ListPipelinesAPIClient interface {
	ListPipelines(context.Context, *ListPipelinesInput, ...func(*Options)) (*ListPipelinesOutput, error)
}

ListPipelinesAPIClient is a client that implements the ListPipelines operation.

type ListPipelinesInput added in v0.31.0

type ListPipelinesInput struct {

	// A filter that returns the pipelines that were created after a specified time.
	CreatedAfter *time.Time

	// A filter that returns the pipelines that were created before a specified time.
	CreatedBefore *time.Time

	// The maximum number of pipelines to return in the response.
	MaxResults *int32

	// If the result of the previous ListPipelines request was truncated, the response
	// includes a NextToken . To retrieve the next set of pipelines, use the token in
	// the next request.
	NextToken *string

	// The prefix of the pipeline name.
	PipelineNamePrefix *string

	// The field by which to sort results. The default is CreatedTime .
	SortBy types.SortPipelinesBy

	// The sort order for results.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListPipelinesOutput added in v0.31.0

type ListPipelinesOutput struct {

	// If the result of the previous ListPipelines request was truncated, the response
	// includes a NextToken . To retrieve the next set of pipelines, use the token in
	// the next request.
	NextToken *string

	// Contains a sorted list of PipelineSummary objects matching the specified
	// filters. Each PipelineSummary consists of PipelineArn, PipelineName,
	// ExperimentName, PipelineDescription, CreationTime, LastModifiedTime,
	// LastRunTime, and RoleArn. This list can be empty.
	PipelineSummaries []types.PipelineSummary

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

type ListPipelinesPaginator added in v0.31.0

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

ListPipelinesPaginator is a paginator for ListPipelines

func NewListPipelinesPaginator added in v0.31.0

func NewListPipelinesPaginator(client ListPipelinesAPIClient, params *ListPipelinesInput, optFns ...func(*ListPipelinesPaginatorOptions)) *ListPipelinesPaginator

NewListPipelinesPaginator returns a new ListPipelinesPaginator

func (*ListPipelinesPaginator) HasMorePages added in v0.31.0

func (p *ListPipelinesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPipelinesPaginator) NextPage added in v0.31.0

func (p *ListPipelinesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPipelinesOutput, error)

NextPage retrieves the next ListPipelines page.

type ListPipelinesPaginatorOptions added in v0.31.0

type ListPipelinesPaginatorOptions struct {
	// The maximum number of pipelines to return in the response.
	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
}

ListPipelinesPaginatorOptions is the paginator options for ListPipelines

type ListProcessingJobsAPIClient added in v0.30.0

type ListProcessingJobsAPIClient interface {
	ListProcessingJobs(context.Context, *ListProcessingJobsInput, ...func(*Options)) (*ListProcessingJobsOutput, error)
}

ListProcessingJobsAPIClient is a client that implements the ListProcessingJobs operation.

type ListProcessingJobsInput

type ListProcessingJobsInput struct {

	// A filter that returns only processing jobs created after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only processing jobs created after the specified time.
	CreationTimeBefore *time.Time

	// A filter that returns only processing jobs modified after the specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only processing jobs modified before the specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of processing jobs to return in the response.
	MaxResults *int32

	// A string in the processing job name. This filter returns only processing jobs
	// whose name contains the specified string.
	NameContains *string

	// If the result of the previous ListProcessingJobs request was truncated, the
	// response includes a NextToken . To retrieve the next set of processing jobs, use
	// the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.SortBy

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder

	// A filter that retrieves only processing jobs with a specific status.
	StatusEquals types.ProcessingJobStatus
	// contains filtered or unexported fields
}

type ListProcessingJobsOutput

type ListProcessingJobsOutput struct {

	// An array of ProcessingJobSummary objects, each listing a processing job.
	//
	// This member is required.
	ProcessingJobSummaries []types.ProcessingJobSummary

	// If the response is truncated, Amazon SageMaker returns this token. To retrieve
	// the next set of processing jobs, use it in the subsequent request.
	NextToken *string

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

type ListProcessingJobsPaginator added in v0.30.0

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

ListProcessingJobsPaginator is a paginator for ListProcessingJobs

func NewListProcessingJobsPaginator added in v0.30.0

func NewListProcessingJobsPaginator(client ListProcessingJobsAPIClient, params *ListProcessingJobsInput, optFns ...func(*ListProcessingJobsPaginatorOptions)) *ListProcessingJobsPaginator

NewListProcessingJobsPaginator returns a new ListProcessingJobsPaginator

func (*ListProcessingJobsPaginator) HasMorePages added in v0.30.0

func (p *ListProcessingJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProcessingJobsPaginator) NextPage added in v0.30.0

func (p *ListProcessingJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProcessingJobsOutput, error)

NextPage retrieves the next ListProcessingJobs page.

type ListProcessingJobsPaginatorOptions added in v0.30.0

type ListProcessingJobsPaginatorOptions struct {
	// The maximum number of processing jobs to return in the response.
	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
}

ListProcessingJobsPaginatorOptions is the paginator options for ListProcessingJobs

type ListProjectsAPIClient added in v0.31.0

type ListProjectsAPIClient interface {
	ListProjects(context.Context, *ListProjectsInput, ...func(*Options)) (*ListProjectsOutput, error)
}

ListProjectsAPIClient is a client that implements the ListProjects operation.

type ListProjectsInput added in v0.31.0

type ListProjectsInput struct {

	// A filter that returns the projects that were created after a specified time.
	CreationTimeAfter *time.Time

	// A filter that returns the projects that were created before a specified time.
	CreationTimeBefore *time.Time

	// The maximum number of projects to return in the response.
	MaxResults *int32

	// A filter that returns the projects whose name contains a specified string.
	NameContains *string

	// If the result of the previous ListProjects request was truncated, the response
	// includes a NextToken . To retrieve the next set of projects, use the token in
	// the next request.
	NextToken *string

	// The field by which to sort results. The default is CreationTime .
	SortBy types.ProjectSortBy

	// The sort order for results. The default is Ascending .
	SortOrder types.ProjectSortOrder
	// contains filtered or unexported fields
}

type ListProjectsOutput added in v0.31.0

type ListProjectsOutput struct {

	// A list of summaries of projects.
	//
	// This member is required.
	ProjectSummaryList []types.ProjectSummary

	// If the result of the previous ListCompilationJobs request was truncated, the
	// response includes a NextToken . To retrieve the next set of model compilation
	// jobs, use the token in the next request.
	NextToken *string

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

type ListProjectsPaginator added in v0.31.0

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

ListProjectsPaginator is a paginator for ListProjects

func NewListProjectsPaginator added in v0.31.0

func NewListProjectsPaginator(client ListProjectsAPIClient, params *ListProjectsInput, optFns ...func(*ListProjectsPaginatorOptions)) *ListProjectsPaginator

NewListProjectsPaginator returns a new ListProjectsPaginator

func (*ListProjectsPaginator) HasMorePages added in v0.31.0

func (p *ListProjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectsPaginator) NextPage added in v0.31.0

func (p *ListProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectsOutput, error)

NextPage retrieves the next ListProjects page.

type ListProjectsPaginatorOptions added in v0.31.0

type ListProjectsPaginatorOptions struct {
	// The maximum number of projects to return in the response.
	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
}

ListProjectsPaginatorOptions is the paginator options for ListProjects

type ListResourceCatalogsAPIClient added in v1.93.0

type ListResourceCatalogsAPIClient interface {
	ListResourceCatalogs(context.Context, *ListResourceCatalogsInput, ...func(*Options)) (*ListResourceCatalogsOutput, error)
}

ListResourceCatalogsAPIClient is a client that implements the ListResourceCatalogs operation.

type ListResourceCatalogsInput added in v1.93.0

type ListResourceCatalogsInput struct {

	// Use this parameter to search for ResourceCatalog s created after a specific date
	// and time.
	CreationTimeAfter *time.Time

	// Use this parameter to search for ResourceCatalog s created before a specific
	// date and time.
	CreationTimeBefore *time.Time

	// The maximum number of results returned by ListResourceCatalogs .
	MaxResults *int32

	// A string that partially matches one or more ResourceCatalog s names. Filters
	// ResourceCatalog by name.
	NameContains *string

	// A token to resume pagination of ListResourceCatalogs results.
	NextToken *string

	// The value on which the resource catalog list is sorted.
	SortBy types.ResourceCatalogSortBy

	// The order in which the resource catalogs are listed.
	SortOrder types.ResourceCatalogSortOrder
	// contains filtered or unexported fields
}

type ListResourceCatalogsOutput added in v1.93.0

type ListResourceCatalogsOutput struct {

	// A token to resume pagination of ListResourceCatalogs results.
	NextToken *string

	// A list of the requested ResourceCatalog s.
	ResourceCatalogs []types.ResourceCatalog

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

type ListResourceCatalogsPaginator added in v1.93.0

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

ListResourceCatalogsPaginator is a paginator for ListResourceCatalogs

func NewListResourceCatalogsPaginator added in v1.93.0

NewListResourceCatalogsPaginator returns a new ListResourceCatalogsPaginator

func (*ListResourceCatalogsPaginator) HasMorePages added in v1.93.0

func (p *ListResourceCatalogsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceCatalogsPaginator) NextPage added in v1.93.0

NextPage retrieves the next ListResourceCatalogs page.

type ListResourceCatalogsPaginatorOptions added in v1.93.0

type ListResourceCatalogsPaginatorOptions struct {
	// The maximum number of results returned by ListResourceCatalogs .
	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
}

ListResourceCatalogsPaginatorOptions is the paginator options for ListResourceCatalogs

type ListSpacesAPIClient added in v1.56.0

type ListSpacesAPIClient interface {
	ListSpaces(context.Context, *ListSpacesInput, ...func(*Options)) (*ListSpacesOutput, error)
}

ListSpacesAPIClient is a client that implements the ListSpaces operation.

type ListSpacesInput added in v1.56.0

type ListSpacesInput struct {

	// A parameter to search for the domain ID.
	DomainIdEquals *string

	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	MaxResults *int32

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

	// The parameter by which to sort the results. The default is CreationTime .
	SortBy types.SpaceSortKey

	// The sort order for the results. The default is Ascending .
	SortOrder types.SortOrder

	// A parameter by which to filter the results.
	SpaceNameContains *string
	// contains filtered or unexported fields
}

type ListSpacesOutput added in v1.56.0

type ListSpacesOutput struct {

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

	// The list of spaces.
	Spaces []types.SpaceDetails

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

type ListSpacesPaginator added in v1.56.0

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

ListSpacesPaginator is a paginator for ListSpaces

func NewListSpacesPaginator added in v1.56.0

func NewListSpacesPaginator(client ListSpacesAPIClient, params *ListSpacesInput, optFns ...func(*ListSpacesPaginatorOptions)) *ListSpacesPaginator

NewListSpacesPaginator returns a new ListSpacesPaginator

func (*ListSpacesPaginator) HasMorePages added in v1.56.0

func (p *ListSpacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSpacesPaginator) NextPage added in v1.56.0

func (p *ListSpacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSpacesOutput, error)

NextPage retrieves the next ListSpaces page.

type ListSpacesPaginatorOptions added in v1.56.0

type ListSpacesPaginatorOptions struct {
	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	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
}

ListSpacesPaginatorOptions is the paginator options for ListSpaces

type ListStageDevicesAPIClient added in v1.37.0

type ListStageDevicesAPIClient interface {
	ListStageDevices(context.Context, *ListStageDevicesInput, ...func(*Options)) (*ListStageDevicesOutput, error)
}

ListStageDevicesAPIClient is a client that implements the ListStageDevices operation.

type ListStageDevicesInput added in v1.37.0

type ListStageDevicesInput struct {

	// The name of the edge deployment plan.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// The name of the stage in the deployment.
	//
	// This member is required.
	StageName *string

	// Toggle for excluding devices deployed in other stages.
	ExcludeDevicesDeployedInOtherStage *bool

	// The maximum number of requests to select.
	MaxResults *int32

	// The response from the last list when returning a list large enough to neeed
	// tokening.
	NextToken *string
	// contains filtered or unexported fields
}

type ListStageDevicesOutput added in v1.37.0

type ListStageDevicesOutput struct {

	// List of summaries of devices allocated to the stage.
	//
	// This member is required.
	DeviceDeploymentSummaries []types.DeviceDeploymentSummary

	// The token to use when calling the next page of results.
	NextToken *string

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

type ListStageDevicesPaginator added in v1.37.0

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

ListStageDevicesPaginator is a paginator for ListStageDevices

func NewListStageDevicesPaginator added in v1.37.0

func NewListStageDevicesPaginator(client ListStageDevicesAPIClient, params *ListStageDevicesInput, optFns ...func(*ListStageDevicesPaginatorOptions)) *ListStageDevicesPaginator

NewListStageDevicesPaginator returns a new ListStageDevicesPaginator

func (*ListStageDevicesPaginator) HasMorePages added in v1.37.0

func (p *ListStageDevicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStageDevicesPaginator) NextPage added in v1.37.0

func (p *ListStageDevicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStageDevicesOutput, error)

NextPage retrieves the next ListStageDevices page.

type ListStageDevicesPaginatorOptions added in v1.37.0

type ListStageDevicesPaginatorOptions struct {
	// The maximum number of requests to select.
	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
}

ListStageDevicesPaginatorOptions is the paginator options for ListStageDevices

type ListStudioLifecycleConfigsAPIClient added in v1.15.0

type ListStudioLifecycleConfigsAPIClient interface {
	ListStudioLifecycleConfigs(context.Context, *ListStudioLifecycleConfigsInput, ...func(*Options)) (*ListStudioLifecycleConfigsOutput, error)
}

ListStudioLifecycleConfigsAPIClient is a client that implements the ListStudioLifecycleConfigs operation.

type ListStudioLifecycleConfigsInput added in v1.15.0

type ListStudioLifecycleConfigsInput struct {

	// A parameter to search for the App Type to which the Lifecycle Configuration is
	// attached.
	AppTypeEquals types.StudioLifecycleConfigAppType

	// A filter that returns only Lifecycle Configurations created on or after the
	// specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only Lifecycle Configurations created on or before the
	// specified time.
	CreationTimeBefore *time.Time

	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	MaxResults *int32

	// A filter that returns only Lifecycle Configurations modified after the
	// specified time.
	ModifiedTimeAfter *time.Time

	// A filter that returns only Lifecycle Configurations modified before the
	// specified time.
	ModifiedTimeBefore *time.Time

	// A string in the Lifecycle Configuration name. This filter returns only
	// Lifecycle Configurations whose name contains the specified string.
	NameContains *string

	// If the previous call to ListStudioLifecycleConfigs didn't return the full set
	// of Lifecycle Configurations, the call returns a token for getting the next set
	// of Lifecycle Configurations.
	NextToken *string

	// The property used to sort results. The default value is CreationTime.
	SortBy types.StudioLifecycleConfigSortKey

	// The sort order. The default value is Descending.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListStudioLifecycleConfigsOutput added in v1.15.0

type ListStudioLifecycleConfigsOutput struct {

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

	// A list of Lifecycle Configurations and their properties.
	StudioLifecycleConfigs []types.StudioLifecycleConfigDetails

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

type ListStudioLifecycleConfigsPaginator added in v1.15.0

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

ListStudioLifecycleConfigsPaginator is a paginator for ListStudioLifecycleConfigs

func NewListStudioLifecycleConfigsPaginator added in v1.15.0

NewListStudioLifecycleConfigsPaginator returns a new ListStudioLifecycleConfigsPaginator

func (*ListStudioLifecycleConfigsPaginator) HasMorePages added in v1.15.0

func (p *ListStudioLifecycleConfigsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListStudioLifecycleConfigsPaginator) NextPage added in v1.15.0

NextPage retrieves the next ListStudioLifecycleConfigs page.

type ListStudioLifecycleConfigsPaginatorOptions added in v1.15.0

type ListStudioLifecycleConfigsPaginatorOptions struct {
	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	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
}

ListStudioLifecycleConfigsPaginatorOptions is the paginator options for ListStudioLifecycleConfigs

type ListSubscribedWorkteamsAPIClient added in v0.30.0

type ListSubscribedWorkteamsAPIClient interface {
	ListSubscribedWorkteams(context.Context, *ListSubscribedWorkteamsInput, ...func(*Options)) (*ListSubscribedWorkteamsOutput, error)
}

ListSubscribedWorkteamsAPIClient is a client that implements the ListSubscribedWorkteams operation.

type ListSubscribedWorkteamsInput

type ListSubscribedWorkteamsInput struct {

	// The maximum number of work teams to return in each page of the response.
	MaxResults *int32

	// A string in the work team name. This filter returns only work teams whose name
	// contains the specified string.
	NameContains *string

	// If the result of the previous ListSubscribedWorkteams request was truncated,
	// the response includes a NextToken . To retrieve the next set of labeling jobs,
	// use the token in the next request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListSubscribedWorkteamsOutput

type ListSubscribedWorkteamsOutput struct {

	// An array of Workteam objects, each describing a work team.
	//
	// This member is required.
	SubscribedWorkteams []types.SubscribedWorkteam

	// If the response is truncated, Amazon SageMaker returns this token. To retrieve
	// the next set of work teams, use it in the subsequent request.
	NextToken *string

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

type ListSubscribedWorkteamsPaginator added in v0.30.0

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

ListSubscribedWorkteamsPaginator is a paginator for ListSubscribedWorkteams

func NewListSubscribedWorkteamsPaginator added in v0.30.0

NewListSubscribedWorkteamsPaginator returns a new ListSubscribedWorkteamsPaginator

func (*ListSubscribedWorkteamsPaginator) HasMorePages added in v0.30.0

func (p *ListSubscribedWorkteamsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSubscribedWorkteamsPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListSubscribedWorkteams page.

type ListSubscribedWorkteamsPaginatorOptions added in v0.30.0

type ListSubscribedWorkteamsPaginatorOptions struct {
	// The maximum number of work teams to return in each page of the response.
	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
}

ListSubscribedWorkteamsPaginatorOptions is the paginator options for ListSubscribedWorkteams

type ListTagsAPIClient added in v0.30.0

type ListTagsAPIClient interface {
	ListTags(context.Context, *ListTagsInput, ...func(*Options)) (*ListTagsOutput, error)
}

ListTagsAPIClient is a client that implements the ListTags operation.

type ListTagsInput

type ListTagsInput struct {

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

	// Maximum number of tags to return.
	MaxResults *int32

	// If the response to the previous ListTags request is truncated, SageMaker
	// returns this token. To retrieve the next set of tags, use it in the subsequent
	// request.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTagsOutput

type ListTagsOutput struct {

	// If response is truncated, SageMaker includes a token in the response. You can
	// use this token in your subsequent request to fetch next set of tokens.
	NextToken *string

	// An array of Tag objects, each with a tag key and a value.
	Tags []types.Tag

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

type ListTagsPaginator added in v0.30.0

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

ListTagsPaginator is a paginator for ListTags

func NewListTagsPaginator added in v0.30.0

func NewListTagsPaginator(client ListTagsAPIClient, params *ListTagsInput, optFns ...func(*ListTagsPaginatorOptions)) *ListTagsPaginator

NewListTagsPaginator returns a new ListTagsPaginator

func (*ListTagsPaginator) HasMorePages added in v0.30.0

func (p *ListTagsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsPaginator) NextPage added in v0.30.0

func (p *ListTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsOutput, error)

NextPage retrieves the next ListTags page.

type ListTagsPaginatorOptions added in v0.30.0

type ListTagsPaginatorOptions struct {
	// Maximum number of tags to return.
	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
}

ListTagsPaginatorOptions is the paginator options for ListTags

type ListTrainingJobsAPIClient added in v0.30.0

type ListTrainingJobsAPIClient interface {
	ListTrainingJobs(context.Context, *ListTrainingJobsInput, ...func(*Options)) (*ListTrainingJobsOutput, error)
}

ListTrainingJobsAPIClient is a client that implements the ListTrainingJobs operation.

type ListTrainingJobsForHyperParameterTuningJobAPIClient added in v0.30.0

type ListTrainingJobsForHyperParameterTuningJobAPIClient interface {
	ListTrainingJobsForHyperParameterTuningJob(context.Context, *ListTrainingJobsForHyperParameterTuningJobInput, ...func(*Options)) (*ListTrainingJobsForHyperParameterTuningJobOutput, error)
}

ListTrainingJobsForHyperParameterTuningJobAPIClient is a client that implements the ListTrainingJobsForHyperParameterTuningJob operation.

type ListTrainingJobsForHyperParameterTuningJobInput

type ListTrainingJobsForHyperParameterTuningJobInput struct {

	// The name of the tuning job whose training jobs you want to list.
	//
	// This member is required.
	HyperParameterTuningJobName *string

	// The maximum number of training jobs to return. The default value is 10.
	MaxResults *int32

	// If the result of the previous ListTrainingJobsForHyperParameterTuningJob
	// request was truncated, the response includes a NextToken . To retrieve the next
	// set of training jobs, use the token in the next request.
	NextToken *string

	// The field to sort results by. The default is Name . If the value of this field
	// is FinalObjectiveMetricValue , any training jobs that did not return an
	// objective metric are not listed.
	SortBy types.TrainingJobSortByOptions

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder

	// A filter that returns only training jobs with the specified status.
	StatusEquals types.TrainingJobStatus
	// contains filtered or unexported fields
}

type ListTrainingJobsForHyperParameterTuningJobOutput

type ListTrainingJobsForHyperParameterTuningJobOutput struct {

	// A list of TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)
	// objects that describe the training jobs that the
	// ListTrainingJobsForHyperParameterTuningJob request returned.
	//
	// This member is required.
	TrainingJobSummaries []types.HyperParameterTrainingJobSummary

	// If the result of this ListTrainingJobsForHyperParameterTuningJob request was
	// truncated, the response includes a NextToken . To retrieve the next set of
	// training jobs, use the token in the next request.
	NextToken *string

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

type ListTrainingJobsForHyperParameterTuningJobPaginator added in v0.30.0

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

ListTrainingJobsForHyperParameterTuningJobPaginator is a paginator for ListTrainingJobsForHyperParameterTuningJob

func NewListTrainingJobsForHyperParameterTuningJobPaginator added in v0.30.0

NewListTrainingJobsForHyperParameterTuningJobPaginator returns a new ListTrainingJobsForHyperParameterTuningJobPaginator

func (*ListTrainingJobsForHyperParameterTuningJobPaginator) HasMorePages added in v0.30.0

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrainingJobsForHyperParameterTuningJobPaginator) NextPage added in v0.30.0

NextPage retrieves the next ListTrainingJobsForHyperParameterTuningJob page.

type ListTrainingJobsForHyperParameterTuningJobPaginatorOptions added in v0.30.0

type ListTrainingJobsForHyperParameterTuningJobPaginatorOptions struct {
	// The maximum number of training jobs to return. The default value is 10.
	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
}

ListTrainingJobsForHyperParameterTuningJobPaginatorOptions is the paginator options for ListTrainingJobsForHyperParameterTuningJob

type ListTrainingJobsInput

type ListTrainingJobsInput struct {

	// A filter that returns only training jobs created after the specified time
	// (timestamp).
	CreationTimeAfter *time.Time

	// A filter that returns only training jobs created before the specified time
	// (timestamp).
	CreationTimeBefore *time.Time

	// A filter that returns only training jobs modified after the specified time
	// (timestamp).
	LastModifiedTimeAfter *time.Time

	// A filter that returns only training jobs modified before the specified time
	// (timestamp).
	LastModifiedTimeBefore *time.Time

	// The maximum number of training jobs to return in the response.
	MaxResults *int32

	// A string in the training job name. This filter returns only training jobs whose
	// name contains the specified string.
	NameContains *string

	// If the result of the previous ListTrainingJobs request was truncated, the
	// response includes a NextToken . To retrieve the next set of training jobs, use
	// the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.SortBy

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder

	// A filter that retrieves only training jobs with a specific status.
	StatusEquals types.TrainingJobStatus

	// A filter that retrieves only training jobs with a specific warm pool status.
	WarmPoolStatusEquals types.WarmPoolResourceStatus
	// contains filtered or unexported fields
}

type ListTrainingJobsOutput

type ListTrainingJobsOutput struct {

	// An array of TrainingJobSummary objects, each listing a training job.
	//
	// This member is required.
	TrainingJobSummaries []types.TrainingJobSummary

	// If the response is truncated, SageMaker returns this token. To retrieve the
	// next set of training jobs, use it in the subsequent request.
	NextToken *string

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

type ListTrainingJobsPaginator added in v0.30.0

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

ListTrainingJobsPaginator is a paginator for ListTrainingJobs

func NewListTrainingJobsPaginator added in v0.30.0

func NewListTrainingJobsPaginator(client ListTrainingJobsAPIClient, params *ListTrainingJobsInput, optFns ...func(*ListTrainingJobsPaginatorOptions)) *ListTrainingJobsPaginator

NewListTrainingJobsPaginator returns a new ListTrainingJobsPaginator

func (*ListTrainingJobsPaginator) HasMorePages added in v0.30.0

func (p *ListTrainingJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrainingJobsPaginator) NextPage added in v0.30.0

func (p *ListTrainingJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrainingJobsOutput, error)

NextPage retrieves the next ListTrainingJobs page.

type ListTrainingJobsPaginatorOptions added in v0.30.0

type ListTrainingJobsPaginatorOptions struct {
	// The maximum number of training jobs to return in the response.
	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
}

ListTrainingJobsPaginatorOptions is the paginator options for ListTrainingJobs

type ListTransformJobsAPIClient added in v0.30.0

type ListTransformJobsAPIClient interface {
	ListTransformJobs(context.Context, *ListTransformJobsInput, ...func(*Options)) (*ListTransformJobsOutput, error)
}

ListTransformJobsAPIClient is a client that implements the ListTransformJobs operation.

type ListTransformJobsInput

type ListTransformJobsInput struct {

	// A filter that returns only transform jobs created after the specified time.
	CreationTimeAfter *time.Time

	// A filter that returns only transform jobs created before the specified time.
	CreationTimeBefore *time.Time

	// A filter that returns only transform jobs modified after the specified time.
	LastModifiedTimeAfter *time.Time

	// A filter that returns only transform jobs modified before the specified time.
	LastModifiedTimeBefore *time.Time

	// The maximum number of transform jobs to return in the response. The default
	// value is 10 .
	MaxResults *int32

	// A string in the transform job name. This filter returns only transform jobs
	// whose name contains the specified string.
	NameContains *string

	// If the result of the previous ListTransformJobs request was truncated, the
	// response includes a NextToken . To retrieve the next set of transform jobs, use
	// the token in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.SortBy

	// The sort order for results. The default is Descending .
	SortOrder types.SortOrder

	// A filter that retrieves only transform jobs with a specific status.
	StatusEquals types.TransformJobStatus
	// contains filtered or unexported fields
}

type ListTransformJobsOutput

type ListTransformJobsOutput struct {

	// An array of TransformJobSummary objects.
	//
	// This member is required.
	TransformJobSummaries []types.TransformJobSummary

	// If the response is truncated, Amazon SageMaker returns this token. To retrieve
	// the next set of transform jobs, use it in the next request.
	NextToken *string

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

type ListTransformJobsPaginator added in v0.30.0

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

ListTransformJobsPaginator is a paginator for ListTransformJobs

func NewListTransformJobsPaginator added in v0.30.0

func NewListTransformJobsPaginator(client ListTransformJobsAPIClient, params *ListTransformJobsInput, optFns ...func(*ListTransformJobsPaginatorOptions)) *ListTransformJobsPaginator

NewListTransformJobsPaginator returns a new ListTransformJobsPaginator

func (*ListTransformJobsPaginator) HasMorePages added in v0.30.0

func (p *ListTransformJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTransformJobsPaginator) NextPage added in v0.30.0

func (p *ListTransformJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTransformJobsOutput, error)

NextPage retrieves the next ListTransformJobs page.

type ListTransformJobsPaginatorOptions added in v0.30.0

type ListTransformJobsPaginatorOptions struct {
	// The maximum number of transform jobs to return in the response. The default
	// value is 10 .
	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
}

ListTransformJobsPaginatorOptions is the paginator options for ListTransformJobs

type ListTrialComponentsAPIClient added in v0.30.0

type ListTrialComponentsAPIClient interface {
	ListTrialComponents(context.Context, *ListTrialComponentsInput, ...func(*Options)) (*ListTrialComponentsOutput, error)
}

ListTrialComponentsAPIClient is a client that implements the ListTrialComponents operation.

type ListTrialComponentsInput

type ListTrialComponentsInput struct {

	// A filter that returns only components created after the specified time.
	CreatedAfter *time.Time

	// A filter that returns only components created before the specified time.
	CreatedBefore *time.Time

	// A filter that returns only components that are part of the specified
	// experiment. If you specify ExperimentName , you can't filter by SourceArn or
	// TrialName .
	ExperimentName *string

	// The maximum number of components to return in the response. The default value
	// is 10.
	MaxResults *int32

	// If the previous call to ListTrialComponents didn't return the full set of
	// components, the call returns a token for getting the next set of components.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.SortTrialComponentsBy

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder

	// A filter that returns only components that have the specified source Amazon
	// Resource Name (ARN). If you specify SourceArn , you can't filter by
	// ExperimentName or TrialName .
	SourceArn *string

	// A filter that returns only components that are part of the specified trial. If
	// you specify TrialName , you can't filter by ExperimentName or SourceArn .
	TrialName *string
	// contains filtered or unexported fields
}

type ListTrialComponentsOutput

type ListTrialComponentsOutput struct {

	// A token for getting the next set of components, if there are any.
	NextToken *string

	// A list of the summaries of your trial components.
	TrialComponentSummaries []types.TrialComponentSummary

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

type ListTrialComponentsPaginator added in v0.30.0

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

ListTrialComponentsPaginator is a paginator for ListTrialComponents

func NewListTrialComponentsPaginator added in v0.30.0

func NewListTrialComponentsPaginator(client ListTrialComponentsAPIClient, params *ListTrialComponentsInput, optFns ...func(*ListTrialComponentsPaginatorOptions)) *ListTrialComponentsPaginator

NewListTrialComponentsPaginator returns a new ListTrialComponentsPaginator

func (*ListTrialComponentsPaginator) HasMorePages added in v0.30.0

func (p *ListTrialComponentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrialComponentsPaginator) NextPage added in v0.30.0

func (p *ListTrialComponentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrialComponentsOutput, error)

NextPage retrieves the next ListTrialComponents page.

type ListTrialComponentsPaginatorOptions added in v0.30.0

type ListTrialComponentsPaginatorOptions struct {
	// The maximum number of components to return in the response. The default value
	// is 10.
	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
}

ListTrialComponentsPaginatorOptions is the paginator options for ListTrialComponents

type ListTrialsAPIClient added in v0.30.0

type ListTrialsAPIClient interface {
	ListTrials(context.Context, *ListTrialsInput, ...func(*Options)) (*ListTrialsOutput, error)
}

ListTrialsAPIClient is a client that implements the ListTrials operation.

type ListTrialsInput

type ListTrialsInput struct {

	// A filter that returns only trials created after the specified time.
	CreatedAfter *time.Time

	// A filter that returns only trials created before the specified time.
	CreatedBefore *time.Time

	// A filter that returns only trials that are part of the specified experiment.
	ExperimentName *string

	// The maximum number of trials to return in the response. The default value is 10.
	MaxResults *int32

	// If the previous call to ListTrials didn't return the full set of trials, the
	// call returns a token for getting the next set of trials.
	NextToken *string

	// The property used to sort results. The default value is CreationTime .
	SortBy types.SortTrialsBy

	// The sort order. The default value is Descending .
	SortOrder types.SortOrder

	// A filter that returns only trials that are associated with the specified trial
	// component.
	TrialComponentName *string
	// contains filtered or unexported fields
}

type ListTrialsOutput

type ListTrialsOutput struct {

	// A token for getting the next set of trials, if there are any.
	NextToken *string

	// A list of the summaries of your trials.
	TrialSummaries []types.TrialSummary

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

type ListTrialsPaginator added in v0.30.0

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

ListTrialsPaginator is a paginator for ListTrials

func NewListTrialsPaginator added in v0.30.0

func NewListTrialsPaginator(client ListTrialsAPIClient, params *ListTrialsInput, optFns ...func(*ListTrialsPaginatorOptions)) *ListTrialsPaginator

NewListTrialsPaginator returns a new ListTrialsPaginator

func (*ListTrialsPaginator) HasMorePages added in v0.30.0

func (p *ListTrialsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTrialsPaginator) NextPage added in v0.30.0

func (p *ListTrialsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTrialsOutput, error)

NextPage retrieves the next ListTrials page.

type ListTrialsPaginatorOptions added in v0.30.0

type ListTrialsPaginatorOptions struct {
	// The maximum number of trials to return in the response. The default value is 10.
	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
}

ListTrialsPaginatorOptions is the paginator options for ListTrials

type ListUserProfilesAPIClient added in v0.30.0

type ListUserProfilesAPIClient interface {
	ListUserProfiles(context.Context, *ListUserProfilesInput, ...func(*Options)) (*ListUserProfilesOutput, error)
}

ListUserProfilesAPIClient is a client that implements the ListUserProfiles operation.

type ListUserProfilesInput

type ListUserProfilesInput struct {

	// A parameter by which to filter the results.
	DomainIdEquals *string

	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	MaxResults *int32

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

	// The parameter by which to sort the results. The default is CreationTime.
	SortBy types.UserProfileSortKey

	// The sort order for the results. The default is Ascending.
	SortOrder types.SortOrder

	// A parameter by which to filter the results.
	UserProfileNameContains *string
	// contains filtered or unexported fields
}

type ListUserProfilesOutput

type ListUserProfilesOutput struct {

	// If the previous response was truncated, you will receive this token. Use it in
	// your next request to receive the next set of results.
	NextToken *string

	// The list of user profiles.
	UserProfiles []types.UserProfileDetails

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

type ListUserProfilesPaginator added in v0.30.0

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

ListUserProfilesPaginator is a paginator for ListUserProfiles

func NewListUserProfilesPaginator added in v0.30.0

func NewListUserProfilesPaginator(client ListUserProfilesAPIClient, params *ListUserProfilesInput, optFns ...func(*ListUserProfilesPaginatorOptions)) *ListUserProfilesPaginator

NewListUserProfilesPaginator returns a new ListUserProfilesPaginator

func (*ListUserProfilesPaginator) HasMorePages added in v0.30.0

func (p *ListUserProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListUserProfilesPaginator) NextPage added in v0.30.0

func (p *ListUserProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUserProfilesOutput, error)

NextPage retrieves the next ListUserProfiles page.

type ListUserProfilesPaginatorOptions added in v0.30.0

type ListUserProfilesPaginatorOptions struct {
	// The total number of items to return in the response. If the total number of
	// items available is more than the value specified, a NextToken is provided in
	// the response. To resume pagination, provide the NextToken value in the as part
	// of a subsequent call. The default value is 10.
	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
}

ListUserProfilesPaginatorOptions is the paginator options for ListUserProfiles

type ListWorkforcesAPIClient added in v0.30.0

type ListWorkforcesAPIClient interface {
	ListWorkforces(context.Context, *ListWorkforcesInput, ...func(*Options)) (*ListWorkforcesOutput, error)
}

ListWorkforcesAPIClient is a client that implements the ListWorkforces operation.

type ListWorkforcesInput

type ListWorkforcesInput struct {

	// The maximum number of workforces returned in the response.
	MaxResults *int32

	// A filter you can use to search for workforces using part of the workforce name.
	NameContains *string

	// A token to resume pagination.
	NextToken *string

	// Sort workforces using the workforce name or creation date.
	SortBy types.ListWorkforcesSortByOptions

	// Sort workforces in ascending or descending order.
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListWorkforcesOutput

type ListWorkforcesOutput struct {

	// A list containing information about your workforce.
	//
	// This member is required.
	Workforces []types.Workforce

	// A token to resume pagination.
	NextToken *string

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

type ListWorkforcesPaginator added in v0.30.0

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

ListWorkforcesPaginator is a paginator for ListWorkforces

func NewListWorkforcesPaginator added in v0.30.0

func NewListWorkforcesPaginator(client ListWorkforcesAPIClient, params *ListWorkforcesInput, optFns ...func(*ListWorkforcesPaginatorOptions)) *ListWorkforcesPaginator

NewListWorkforcesPaginator returns a new ListWorkforcesPaginator

func (*ListWorkforcesPaginator) HasMorePages added in v0.30.0

func (p *ListWorkforcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkforcesPaginator) NextPage added in v0.30.0

func (p *ListWorkforcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkforcesOutput, error)

NextPage retrieves the next ListWorkforces page.

type ListWorkforcesPaginatorOptions added in v0.30.0

type ListWorkforcesPaginatorOptions struct {
	// The maximum number of workforces returned in the response.
	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
}

ListWorkforcesPaginatorOptions is the paginator options for ListWorkforces

type ListWorkteamsAPIClient added in v0.30.0

type ListWorkteamsAPIClient interface {
	ListWorkteams(context.Context, *ListWorkteamsInput, ...func(*Options)) (*ListWorkteamsOutput, error)
}

ListWorkteamsAPIClient is a client that implements the ListWorkteams operation.

type ListWorkteamsInput

type ListWorkteamsInput struct {

	// The maximum number of work teams to return in each page of the response.
	MaxResults *int32

	// A string in the work team's name. This filter returns only work teams whose
	// name contains the specified string.
	NameContains *string

	// If the result of the previous ListWorkteams request was truncated, the response
	// includes a NextToken . To retrieve the next set of labeling jobs, use the token
	// in the next request.
	NextToken *string

	// The field to sort results by. The default is CreationTime .
	SortBy types.ListWorkteamsSortByOptions

	// The sort order for results. The default is Ascending .
	SortOrder types.SortOrder
	// contains filtered or unexported fields
}

type ListWorkteamsOutput

type ListWorkteamsOutput struct {

	// An array of Workteam objects, each describing a work team.
	//
	// This member is required.
	Workteams []types.Workteam

	// If the response is truncated, Amazon SageMaker returns this token. To retrieve
	// the next set of work teams, use it in the subsequent request.
	NextToken *string

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

type ListWorkteamsPaginator added in v0.30.0

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

ListWorkteamsPaginator is a paginator for ListWorkteams

func NewListWorkteamsPaginator added in v0.30.0

func NewListWorkteamsPaginator(client ListWorkteamsAPIClient, params *ListWorkteamsInput, optFns ...func(*ListWorkteamsPaginatorOptions)) *ListWorkteamsPaginator

NewListWorkteamsPaginator returns a new ListWorkteamsPaginator

func (*ListWorkteamsPaginator) HasMorePages added in v0.30.0

func (p *ListWorkteamsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkteamsPaginator) NextPage added in v0.30.0

func (p *ListWorkteamsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkteamsOutput, error)

NextPage retrieves the next ListWorkteams page.

type ListWorkteamsPaginatorOptions added in v0.30.0

type ListWorkteamsPaginatorOptions struct {
	// The maximum number of work teams to return in each page of the response.
	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
}

ListWorkteamsPaginatorOptions is the paginator options for ListWorkteams

type NotebookInstanceDeletedWaiter added in v1.9.0

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

NotebookInstanceDeletedWaiter defines the waiters for NotebookInstanceDeleted

func NewNotebookInstanceDeletedWaiter added in v1.9.0

func NewNotebookInstanceDeletedWaiter(client DescribeNotebookInstanceAPIClient, optFns ...func(*NotebookInstanceDeletedWaiterOptions)) *NotebookInstanceDeletedWaiter

NewNotebookInstanceDeletedWaiter constructs a NotebookInstanceDeletedWaiter.

func (*NotebookInstanceDeletedWaiter) Wait added in v1.9.0

Wait calls the waiter function for NotebookInstanceDeleted waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*NotebookInstanceDeletedWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for NotebookInstanceDeleted waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type NotebookInstanceDeletedWaiterOptions added in v1.9.0

type NotebookInstanceDeletedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// NotebookInstanceDeletedWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, NotebookInstanceDeletedWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeNotebookInstanceInput, *DescribeNotebookInstanceOutput, error) (bool, error)
}

NotebookInstanceDeletedWaiterOptions are waiter options for NotebookInstanceDeletedWaiter

type NotebookInstanceInServiceWaiter added in v0.31.0

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

NotebookInstanceInServiceWaiter defines the waiters for NotebookInstanceInService

func NewNotebookInstanceInServiceWaiter added in v0.31.0

func NewNotebookInstanceInServiceWaiter(client DescribeNotebookInstanceAPIClient, optFns ...func(*NotebookInstanceInServiceWaiterOptions)) *NotebookInstanceInServiceWaiter

NewNotebookInstanceInServiceWaiter constructs a NotebookInstanceInServiceWaiter.

func (*NotebookInstanceInServiceWaiter) Wait added in v0.31.0

Wait calls the waiter function for NotebookInstanceInService waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*NotebookInstanceInServiceWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for NotebookInstanceInService waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type NotebookInstanceInServiceWaiterOptions added in v0.31.0

type NotebookInstanceInServiceWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// NotebookInstanceInServiceWaiter will use default minimum delay of 30 seconds.
	// Note that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, NotebookInstanceInServiceWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeNotebookInstanceInput, *DescribeNotebookInstanceOutput, error) (bool, error)
}

NotebookInstanceInServiceWaiterOptions are waiter options for NotebookInstanceInServiceWaiter

type NotebookInstanceStoppedWaiter added in v0.31.0

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

NotebookInstanceStoppedWaiter defines the waiters for NotebookInstanceStopped

func NewNotebookInstanceStoppedWaiter added in v0.31.0

func NewNotebookInstanceStoppedWaiter(client DescribeNotebookInstanceAPIClient, optFns ...func(*NotebookInstanceStoppedWaiterOptions)) *NotebookInstanceStoppedWaiter

NewNotebookInstanceStoppedWaiter constructs a NotebookInstanceStoppedWaiter.

func (*NotebookInstanceStoppedWaiter) Wait added in v0.31.0

Wait calls the waiter function for NotebookInstanceStopped waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*NotebookInstanceStoppedWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for NotebookInstanceStopped waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type NotebookInstanceStoppedWaiterOptions added in v0.31.0

type NotebookInstanceStoppedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// NotebookInstanceStoppedWaiter will use default minimum delay of 30 seconds. Note
	// that MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, NotebookInstanceStoppedWaiter will use default max delay of 120
	// seconds. Note that MaxDelay must resolve to value greater than or equal to the
	// MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeNotebookInstanceInput, *DescribeNotebookInstanceOutput, error) (bool, error)
}

NotebookInstanceStoppedWaiterOptions are waiter options for NotebookInstanceStoppedWaiter

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

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// 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 added in v1.116.1

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

type ProcessingJobCompletedOrStoppedWaiter added in v1.9.0

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

ProcessingJobCompletedOrStoppedWaiter defines the waiters for ProcessingJobCompletedOrStopped

func NewProcessingJobCompletedOrStoppedWaiter added in v1.9.0

func NewProcessingJobCompletedOrStoppedWaiter(client DescribeProcessingJobAPIClient, optFns ...func(*ProcessingJobCompletedOrStoppedWaiterOptions)) *ProcessingJobCompletedOrStoppedWaiter

NewProcessingJobCompletedOrStoppedWaiter constructs a ProcessingJobCompletedOrStoppedWaiter.

func (*ProcessingJobCompletedOrStoppedWaiter) Wait added in v1.9.0

Wait calls the waiter function for ProcessingJobCompletedOrStopped waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ProcessingJobCompletedOrStoppedWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for ProcessingJobCompletedOrStopped waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ProcessingJobCompletedOrStoppedWaiterOptions added in v1.9.0

type ProcessingJobCompletedOrStoppedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ProcessingJobCompletedOrStoppedWaiter will use default minimum delay of 60
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ProcessingJobCompletedOrStoppedWaiter will use default max delay of
	// 120 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeProcessingJobInput, *DescribeProcessingJobOutput, error) (bool, error)
}

ProcessingJobCompletedOrStoppedWaiterOptions are waiter options for ProcessingJobCompletedOrStoppedWaiter

type PutModelPackageGroupPolicyInput added in v0.31.0

type PutModelPackageGroupPolicyInput struct {

	// The name of the model group to add a resource policy to.
	//
	// This member is required.
	ModelPackageGroupName *string

	// The resource policy for the model group.
	//
	// This member is required.
	ResourcePolicy *string
	// contains filtered or unexported fields
}

type PutModelPackageGroupPolicyOutput added in v0.31.0

type PutModelPackageGroupPolicyOutput struct {

	// The Amazon Resource Name (ARN) of the model package group.
	//
	// This member is required.
	ModelPackageGroupArn *string

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

type QueryLineageAPIClient added in v1.20.0

type QueryLineageAPIClient interface {
	QueryLineage(context.Context, *QueryLineageInput, ...func(*Options)) (*QueryLineageOutput, error)
}

QueryLineageAPIClient is a client that implements the QueryLineage operation.

type QueryLineageInput added in v1.20.0

type QueryLineageInput struct {

	// Associations between lineage entities have a direction. This parameter
	// determines the direction from the StartArn(s) that the query traverses.
	Direction types.Direction

	// A set of filtering parameters that allow you to specify which entities should
	// be returned.
	//   - Properties - Key-value pairs to match on the lineage entities' properties.
	//   - LineageTypes - A set of lineage entity types to match on. For example:
	//   TrialComponent , Artifact , or Context .
	//   - CreatedBefore - Filter entities created before this date.
	//   - ModifiedBefore - Filter entities modified before this date.
	//   - ModifiedAfter - Filter entities modified after this date.
	Filters *types.QueryFilters

	// Setting this value to True retrieves not only the entities of interest but also
	// the Associations (https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html)
	// and lineage entities on the path. Set to False to only return lineage entities
	// that match your query.
	IncludeEdges *bool

	// The maximum depth in lineage relationships from the StartArns that are
	// traversed. Depth is a measure of the number of Associations from the StartArn
	// entity to the matched results.
	MaxDepth *int32

	// Limits the number of vertices in the results. Use the NextToken in a response
	// to to retrieve the next page of results.
	MaxResults *int32

	// Limits the number of vertices in the request. Use the NextToken in a response
	// to to retrieve the next page of results.
	NextToken *string

	// A list of resource Amazon Resource Name (ARN) that represent the starting point
	// for your lineage query.
	StartArns []string
	// contains filtered or unexported fields
}

type QueryLineageOutput added in v1.20.0

type QueryLineageOutput struct {

	// A list of edges that connect vertices in the response.
	Edges []types.Edge

	// Limits the number of vertices in the response. Use the NextToken in a response
	// to to retrieve the next page of results.
	NextToken *string

	// A list of vertices connected to the start entity(ies) in the lineage graph.
	Vertices []types.Vertex

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

type QueryLineagePaginator added in v1.20.0

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

QueryLineagePaginator is a paginator for QueryLineage

func NewQueryLineagePaginator added in v1.20.0

func NewQueryLineagePaginator(client QueryLineageAPIClient, params *QueryLineageInput, optFns ...func(*QueryLineagePaginatorOptions)) *QueryLineagePaginator

NewQueryLineagePaginator returns a new QueryLineagePaginator

func (*QueryLineagePaginator) HasMorePages added in v1.20.0

func (p *QueryLineagePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*QueryLineagePaginator) NextPage added in v1.20.0

func (p *QueryLineagePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*QueryLineageOutput, error)

NextPage retrieves the next QueryLineage page.

type QueryLineagePaginatorOptions added in v1.20.0

type QueryLineagePaginatorOptions struct {
	// Limits the number of vertices in the results. Use the NextToken in a response
	// to to retrieve the next page of results.
	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
}

QueryLineagePaginatorOptions is the paginator options for QueryLineage

type RegisterDevicesInput added in v0.31.0

type RegisterDevicesInput struct {

	// The name of the fleet.
	//
	// This member is required.
	DeviceFleetName *string

	// A list of devices to register with SageMaker Edge Manager.
	//
	// This member is required.
	Devices []types.Device

	// The tags associated with devices.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type RegisterDevicesOutput added in v0.31.0

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

type RenderUiTemplateInput

type RenderUiTemplateInput struct {

	// The Amazon Resource Name (ARN) that has access to the S3 objects that are used
	// by the template.
	//
	// This member is required.
	RoleArn *string

	// A RenderableTask object containing a representative task to render.
	//
	// This member is required.
	Task *types.RenderableTask

	// The HumanTaskUiArn of the worker UI that you want to render. Do not provide a
	// HumanTaskUiArn if you use the UiTemplate parameter. See a list of available
	// Human Ui Amazon Resource Names (ARNs) in UiConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UiConfig.html)
	// .
	HumanTaskUiArn *string

	// A Template object containing the worker UI template to render.
	UiTemplate *types.UiTemplate
	// contains filtered or unexported fields
}

type RenderUiTemplateOutput

type RenderUiTemplateOutput struct {

	// A list of one or more RenderingError objects if any were encountered while
	// rendering the template. If there were no errors, the list is empty.
	//
	// This member is required.
	Errors []types.RenderingError

	// A Liquid template that renders the HTML for the worker UI.
	//
	// This member is required.
	RenderedContent *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 (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type RetryPipelineExecutionInput added in v1.15.0

type RetryPipelineExecutionInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than once.
	//
	// This member is required.
	ClientRequestToken *string

	// The Amazon Resource Name (ARN) of the pipeline execution.
	//
	// This member is required.
	PipelineExecutionArn *string

	// This configuration, if specified, overrides the parallelism configuration of
	// the parent pipeline.
	ParallelismConfiguration *types.ParallelismConfiguration
	// contains filtered or unexported fields
}

type RetryPipelineExecutionOutput added in v1.15.0

type RetryPipelineExecutionOutput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	PipelineExecutionArn *string

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

type SearchAPIClient added in v0.30.0

type SearchAPIClient interface {
	Search(context.Context, *SearchInput, ...func(*Options)) (*SearchOutput, error)
}

SearchAPIClient is a client that implements the Search operation.

type SearchInput

type SearchInput struct {

	// The name of the SageMaker resource to search for.
	//
	// This member is required.
	Resource types.ResourceType

	// A cross account filter option. When the value is "CrossAccount" the search
	// results will only include resources made discoverable to you from other
	// accounts. When the value is "SameAccount" or null the search results will only
	// include resources from your account. Default is null . For more information on
	// searching for resources made discoverable to your account, see Search
	// discoverable resources (https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html)
	// in the SageMaker Developer Guide. The maximum number of ResourceCatalog s
	// viewable is 1000.
	CrossAccountFilterOption types.CrossAccountFilterOption

	// The maximum number of results to return.
	MaxResults *int32

	// If more than MaxResults resources match the specified SearchExpression , the
	// response includes a NextToken . The NextToken can be passed to the next
	// SearchRequest to continue retrieving results.
	NextToken *string

	// A Boolean conditional statement. Resources must satisfy this condition to be
	// included in search results. You must provide at least one subexpression, filter,
	// or nested filter. The maximum number of recursive SubExpressions , NestedFilters
	// , and Filters that can be included in a SearchExpression object is 50.
	SearchExpression *types.SearchExpression

	// The name of the resource property used to sort the SearchResults . The default
	// is LastModifiedTime .
	SortBy *string

	// How SearchResults are ordered. Valid values are Ascending or Descending . The
	// default is Descending .
	SortOrder types.SearchSortOrder

	// Limits the results of your search request to the resources that you can access.
	VisibilityConditions []types.VisibilityConditions
	// contains filtered or unexported fields
}

type SearchOutput

type SearchOutput struct {

	// If the result of the previous Search request was truncated, the response
	// includes a NextToken. To retrieve the next set of results, use the token in the
	// next request.
	NextToken *string

	// A list of SearchRecord objects.
	Results []types.SearchRecord

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

type SearchPaginator added in v0.30.0

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

SearchPaginator is a paginator for Search

func NewSearchPaginator added in v0.30.0

func NewSearchPaginator(client SearchAPIClient, params *SearchInput, optFns ...func(*SearchPaginatorOptions)) *SearchPaginator

NewSearchPaginator returns a new SearchPaginator

func (*SearchPaginator) HasMorePages added in v0.30.0

func (p *SearchPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchPaginator) NextPage added in v0.30.0

func (p *SearchPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchOutput, error)

NextPage retrieves the next Search page.

type SearchPaginatorOptions added in v0.30.0

type SearchPaginatorOptions struct {
	// The maximum number of results to return.
	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
}

SearchPaginatorOptions is the paginator options for Search

type SendPipelineExecutionStepFailureInput added in v1.7.0

type SendPipelineExecutionStepFailureInput struct {

	// The pipeline generated token from the Amazon SQS queue.
	//
	// This member is required.
	CallbackToken *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time.
	ClientRequestToken *string

	// A message describing why the step failed.
	FailureReason *string
	// contains filtered or unexported fields
}

type SendPipelineExecutionStepFailureOutput added in v1.7.0

type SendPipelineExecutionStepFailureOutput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	PipelineExecutionArn *string

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

type SendPipelineExecutionStepSuccessInput added in v1.7.0

type SendPipelineExecutionStepSuccessInput struct {

	// The pipeline generated token from the Amazon SQS queue.
	//
	// This member is required.
	CallbackToken *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than one time.
	ClientRequestToken *string

	// A list of the output parameters of the callback step.
	OutputParameters []types.OutputParameter
	// contains filtered or unexported fields
}

type SendPipelineExecutionStepSuccessOutput added in v1.7.0

type SendPipelineExecutionStepSuccessOutput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	PipelineExecutionArn *string

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

type StartEdgeDeploymentStageInput added in v1.37.0

type StartEdgeDeploymentStageInput struct {

	// The name of the edge deployment plan to start.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// The name of the stage to start.
	//
	// This member is required.
	StageName *string
	// contains filtered or unexported fields
}

type StartEdgeDeploymentStageOutput added in v1.37.0

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

type StartInferenceExperimentInput added in v1.56.0

type StartInferenceExperimentInput struct {

	// The name of the inference experiment to start.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

type StartInferenceExperimentOutput added in v1.56.0

type StartInferenceExperimentOutput struct {

	// The ARN of the started inference experiment to start.
	//
	// This member is required.
	InferenceExperimentArn *string

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

type StartMonitoringScheduleInput

type StartMonitoringScheduleInput struct {

	// The name of the schedule to start.
	//
	// This member is required.
	MonitoringScheduleName *string
	// contains filtered or unexported fields
}

type StartMonitoringScheduleOutput

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

type StartNotebookInstanceInput

type StartNotebookInstanceInput struct {

	// The name of the notebook instance to start.
	//
	// This member is required.
	NotebookInstanceName *string
	// contains filtered or unexported fields
}

type StartNotebookInstanceOutput

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

type StartPipelineExecutionInput added in v0.31.0

type StartPipelineExecutionInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than once.
	//
	// This member is required.
	ClientRequestToken *string

	// The name or Amazon Resource Name (ARN) of the pipeline.
	//
	// This member is required.
	PipelineName *string

	// This configuration, if specified, overrides the parallelism configuration of
	// the parent pipeline for this specific run.
	ParallelismConfiguration *types.ParallelismConfiguration

	// The description of the pipeline execution.
	PipelineExecutionDescription *string

	// The display name of the pipeline execution.
	PipelineExecutionDisplayName *string

	// Contains a list of pipeline parameters. This list can be empty.
	PipelineParameters []types.Parameter

	// The selective execution configuration applied to the pipeline run.
	SelectiveExecutionConfig *types.SelectiveExecutionConfig
	// contains filtered or unexported fields
}

type StartPipelineExecutionOutput added in v0.31.0

type StartPipelineExecutionOutput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	PipelineExecutionArn *string

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

type StopAutoMLJobInput

type StopAutoMLJobInput struct {

	// The name of the object you are requesting.
	//
	// This member is required.
	AutoMLJobName *string
	// contains filtered or unexported fields
}

type StopAutoMLJobOutput

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

type StopCompilationJobInput

type StopCompilationJobInput struct {

	// The name of the model compilation job to stop.
	//
	// This member is required.
	CompilationJobName *string
	// contains filtered or unexported fields
}

type StopCompilationJobOutput

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

type StopEdgeDeploymentStageInput added in v1.37.0

type StopEdgeDeploymentStageInput struct {

	// The name of the edge deployment plan to stop.
	//
	// This member is required.
	EdgeDeploymentPlanName *string

	// The name of the stage to stop.
	//
	// This member is required.
	StageName *string
	// contains filtered or unexported fields
}

type StopEdgeDeploymentStageOutput added in v1.37.0

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

type StopEdgePackagingJobInput added in v0.31.0

type StopEdgePackagingJobInput struct {

	// The name of the edge packaging job.
	//
	// This member is required.
	EdgePackagingJobName *string
	// contains filtered or unexported fields
}

type StopEdgePackagingJobOutput added in v0.31.0

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

type StopHyperParameterTuningJobInput

type StopHyperParameterTuningJobInput struct {

	// The name of the tuning job to stop.
	//
	// This member is required.
	HyperParameterTuningJobName *string
	// contains filtered or unexported fields
}

type StopHyperParameterTuningJobOutput

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

type StopInferenceExperimentInput added in v1.56.0

type StopInferenceExperimentInput struct {

	// Array of key-value pairs, with names of variants mapped to actions. The
	// possible actions are the following:
	//   - Promote - Promote the shadow variant to a production variant
	//   - Remove - Delete the variant
	//   - Retain - Keep the variant as it is
	//
	// This member is required.
	ModelVariantActions map[string]types.ModelVariantAction

	// The name of the inference experiment to stop.
	//
	// This member is required.
	Name *string

	// An array of ModelVariantConfig objects. There is one for each variant that you
	// want to deploy after the inference experiment stops. Each ModelVariantConfig
	// describes the infrastructure configuration for deploying the corresponding
	// variant.
	DesiredModelVariants []types.ModelVariantConfig

	// The desired state of the experiment after stopping. The possible states are the
	// following:
	//   - Completed : The experiment completed successfully
	//   - Cancelled : The experiment was canceled
	DesiredState types.InferenceExperimentStopDesiredState

	// The reason for stopping the experiment.
	Reason *string
	// contains filtered or unexported fields
}

type StopInferenceExperimentOutput added in v1.56.0

type StopInferenceExperimentOutput struct {

	// The ARN of the stopped inference experiment.
	//
	// This member is required.
	InferenceExperimentArn *string

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

type StopInferenceRecommendationsJobInput added in v1.20.0

type StopInferenceRecommendationsJobInput struct {

	// The name of the job you want to stop.
	//
	// This member is required.
	JobName *string
	// contains filtered or unexported fields
}

type StopInferenceRecommendationsJobOutput added in v1.20.0

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

type StopLabelingJobInput

type StopLabelingJobInput struct {

	// The name of the labeling job to stop.
	//
	// This member is required.
	LabelingJobName *string
	// contains filtered or unexported fields
}

type StopLabelingJobOutput

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

type StopMonitoringScheduleInput

type StopMonitoringScheduleInput struct {

	// The name of the schedule to stop.
	//
	// This member is required.
	MonitoringScheduleName *string
	// contains filtered or unexported fields
}

type StopMonitoringScheduleOutput

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

type StopNotebookInstanceInput

type StopNotebookInstanceInput struct {

	// The name of the notebook instance to terminate.
	//
	// This member is required.
	NotebookInstanceName *string
	// contains filtered or unexported fields
}

type StopNotebookInstanceOutput

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

type StopPipelineExecutionInput added in v0.31.0

type StopPipelineExecutionInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the operation. An idempotent operation completes no more than once.
	//
	// This member is required.
	ClientRequestToken *string

	// The Amazon Resource Name (ARN) of the pipeline execution.
	//
	// This member is required.
	PipelineExecutionArn *string
	// contains filtered or unexported fields
}

type StopPipelineExecutionOutput added in v0.31.0

type StopPipelineExecutionOutput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	PipelineExecutionArn *string

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

type StopProcessingJobInput

type StopProcessingJobInput struct {

	// The name of the processing job to stop.
	//
	// This member is required.
	ProcessingJobName *string
	// contains filtered or unexported fields
}

type StopProcessingJobOutput

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

type StopTrainingJobInput

type StopTrainingJobInput struct {

	// The name of the training job to stop.
	//
	// This member is required.
	TrainingJobName *string
	// contains filtered or unexported fields
}

type StopTrainingJobOutput

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

type StopTransformJobInput

type StopTransformJobInput struct {

	// The name of the batch transform job to stop.
	//
	// This member is required.
	TransformJobName *string
	// contains filtered or unexported fields
}

type StopTransformJobOutput

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

type TrainingJobCompletedOrStoppedWaiter added in v1.9.0

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

TrainingJobCompletedOrStoppedWaiter defines the waiters for TrainingJobCompletedOrStopped

func NewTrainingJobCompletedOrStoppedWaiter added in v1.9.0

func NewTrainingJobCompletedOrStoppedWaiter(client DescribeTrainingJobAPIClient, optFns ...func(*TrainingJobCompletedOrStoppedWaiterOptions)) *TrainingJobCompletedOrStoppedWaiter

NewTrainingJobCompletedOrStoppedWaiter constructs a TrainingJobCompletedOrStoppedWaiter.

func (*TrainingJobCompletedOrStoppedWaiter) Wait added in v1.9.0

Wait calls the waiter function for TrainingJobCompletedOrStopped waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*TrainingJobCompletedOrStoppedWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for TrainingJobCompletedOrStopped waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type TrainingJobCompletedOrStoppedWaiterOptions added in v1.9.0

type TrainingJobCompletedOrStoppedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// TrainingJobCompletedOrStoppedWaiter will use default minimum delay of 120
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, TrainingJobCompletedOrStoppedWaiter will use default max delay of
	// 120 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeTrainingJobInput, *DescribeTrainingJobOutput, error) (bool, error)
}

TrainingJobCompletedOrStoppedWaiterOptions are waiter options for TrainingJobCompletedOrStoppedWaiter

type TransformJobCompletedOrStoppedWaiter added in v1.9.0

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

TransformJobCompletedOrStoppedWaiter defines the waiters for TransformJobCompletedOrStopped

func NewTransformJobCompletedOrStoppedWaiter added in v1.9.0

func NewTransformJobCompletedOrStoppedWaiter(client DescribeTransformJobAPIClient, optFns ...func(*TransformJobCompletedOrStoppedWaiterOptions)) *TransformJobCompletedOrStoppedWaiter

NewTransformJobCompletedOrStoppedWaiter constructs a TransformJobCompletedOrStoppedWaiter.

func (*TransformJobCompletedOrStoppedWaiter) Wait added in v1.9.0

Wait calls the waiter function for TransformJobCompletedOrStopped waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*TransformJobCompletedOrStoppedWaiter) WaitForOutput added in v1.19.0

WaitForOutput calls the waiter function for TransformJobCompletedOrStopped waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type TransformJobCompletedOrStoppedWaiterOptions added in v1.9.0

type TransformJobCompletedOrStoppedWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// TransformJobCompletedOrStoppedWaiter will use default minimum delay of 60
	// seconds. Note that MinDelay must resolve to a value lesser than or equal to the
	// MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, TransformJobCompletedOrStoppedWaiter will use default max delay of
	// 120 seconds. Note that MaxDelay must resolve to value greater than or equal to
	// the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state. By
	// default service-modeled logic will populate this option. This option can thus be
	// used to define a custom waiter state with fall-back to service-modeled waiter
	// state mutators.The function returns an error in case of a failure state. In case
	// of retry state, this function returns a bool value of true and nil error, while
	// in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *DescribeTransformJobInput, *DescribeTransformJobOutput, error) (bool, error)
}

TransformJobCompletedOrStoppedWaiterOptions are waiter options for TransformJobCompletedOrStoppedWaiter

type UpdateActionInput added in v0.31.0

type UpdateActionInput struct {

	// The name of the action to update.
	//
	// This member is required.
	ActionName *string

	// The new description for the action.
	Description *string

	// The new list of properties. Overwrites the current property list.
	Properties map[string]string

	// A list of properties to remove.
	PropertiesToRemove []string

	// The new status for the action.
	Status types.ActionStatus
	// contains filtered or unexported fields
}

type UpdateActionOutput added in v0.31.0

type UpdateActionOutput struct {

	// The Amazon Resource Name (ARN) of the action.
	ActionArn *string

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

type UpdateAppImageConfigInput added in v0.29.0

type UpdateAppImageConfigInput struct {

	// The name of the AppImageConfig to update.
	//
	// This member is required.
	AppImageConfigName *string

	// The Code Editor app running on the image.
	CodeEditorAppImageConfig *types.CodeEditorAppImageConfig

	// The JupyterLab app running on the image.
	JupyterLabAppImageConfig *types.JupyterLabAppImageConfig

	// The new KernelGateway app to run on the image.
	KernelGatewayImageConfig *types.KernelGatewayImageConfig
	// contains filtered or unexported fields
}

type UpdateAppImageConfigOutput added in v0.29.0

type UpdateAppImageConfigOutput struct {

	// The ARN for the AppImageConfig.
	AppImageConfigArn *string

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

type UpdateArtifactInput added in v0.31.0

type UpdateArtifactInput struct {

	// The Amazon Resource Name (ARN) of the artifact to update.
	//
	// This member is required.
	ArtifactArn *string

	// The new name for the artifact.
	ArtifactName *string

	// The new list of properties. Overwrites the current property list.
	Properties map[string]string

	// A list of properties to remove.
	PropertiesToRemove []string
	// contains filtered or unexported fields
}

type UpdateArtifactOutput added in v0.31.0

type UpdateArtifactOutput struct {

	// The Amazon Resource Name (ARN) of the artifact.
	ArtifactArn *string

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

type UpdateClusterInput added in v1.119.0

type UpdateClusterInput struct {

	// Specify the name of the SageMaker HyperPod cluster you want to update.
	//
	// This member is required.
	ClusterName *string

	// Specify the instance groups to update.
	//
	// This member is required.
	InstanceGroups []types.ClusterInstanceGroupSpecification
	// contains filtered or unexported fields
}

type UpdateClusterOutput added in v1.119.0

type UpdateClusterOutput struct {

	// The Amazon Resource Name (ARN) of the updated SageMaker HyperPod cluster.
	//
	// This member is required.
	ClusterArn *string

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

type UpdateClusterSoftwareInput added in v1.129.0

type UpdateClusterSoftwareInput struct {

	// Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod
	// cluster you want to update for security patching.
	//
	// This member is required.
	ClusterName *string
	// contains filtered or unexported fields
}

type UpdateClusterSoftwareOutput added in v1.129.0

type UpdateClusterSoftwareOutput struct {

	// The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster being updated
	// for security patching.
	//
	// This member is required.
	ClusterArn *string

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

type UpdateCodeRepositoryInput

type UpdateCodeRepositoryInput struct {

	// The name of the Git repository to update.
	//
	// This member is required.
	CodeRepositoryName *string

	// The configuration of the git repository, including the URL and the Amazon
	// Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that
	// contains the credentials used to access the repository. The secret must have a
	// staging label of AWSCURRENT and must be in the following format: {"username":
	// UserName, "password": Password}
	GitConfig *types.GitConfigForUpdate
	// contains filtered or unexported fields
}

type UpdateCodeRepositoryOutput

type UpdateCodeRepositoryOutput struct {

	// The ARN of the Git repository.
	//
	// This member is required.
	CodeRepositoryArn *string

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

type UpdateContextInput added in v0.31.0

type UpdateContextInput struct {

	// The name of the context to update.
	//
	// This member is required.
	ContextName *string

	// The new description for the context.
	Description *string

	// The new list of properties. Overwrites the current property list.
	Properties map[string]string

	// A list of properties to remove.
	PropertiesToRemove []string
	// contains filtered or unexported fields
}

type UpdateContextOutput added in v0.31.0

type UpdateContextOutput struct {

	// The Amazon Resource Name (ARN) of the context.
	ContextArn *string

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

type UpdateDeviceFleetInput added in v0.31.0

type UpdateDeviceFleetInput struct {

	// The name of the fleet.
	//
	// This member is required.
	DeviceFleetName *string

	// Output configuration for storing sample data collected by the fleet.
	//
	// This member is required.
	OutputConfig *types.EdgeOutputConfig

	// Description of the fleet.
	Description *string

	// Whether to create an Amazon Web Services IoT Role Alias during device fleet
	// creation. The name of the role alias generated will match this pattern:
	// "SageMakerEdge-{DeviceFleetName}". For example, if your device fleet is called
	// "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".
	EnableIotRoleAlias *bool

	// The Amazon Resource Name (ARN) of the device.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateDeviceFleetOutput added in v0.31.0

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

type UpdateDevicesInput added in v0.31.0

type UpdateDevicesInput struct {

	// The name of the fleet the devices belong to.
	//
	// This member is required.
	DeviceFleetName *string

	// List of devices to register with Edge Manager agent.
	//
	// This member is required.
	Devices []types.Device
	// contains filtered or unexported fields
}

type UpdateDevicesOutput added in v0.31.0

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

type UpdateDomainInput

type UpdateDomainInput struct {

	// The ID of the domain to be updated.
	//
	// This member is required.
	DomainId *string

	// Specifies the VPC used for non-EFS traffic.
	//   - PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon
	//   SageMaker, which allows direct internet access.
	//   - VpcOnly - All Studio traffic is through the specified VPC and subnets.
	// This configuration can only be modified if there are no apps in the InService ,
	// Pending , or Deleting state. The configuration cannot be updated if
	// DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is already
	// set or DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
	// provided as part of the same request.
	AppNetworkAccessType types.AppNetworkAccessType

	// The entity that creates and manages the required security groups for inter-app
	// communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType
	// is VPCOnly and
	// DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is
	// provided. If setting up the domain for use with RStudio, this value must be set
	// to Service .
	AppSecurityGroupManagement types.AppSecurityGroupManagement

	// The default settings used to create a space within the domain.
	DefaultSpaceSettings *types.DefaultSpaceSettings

	// A collection of settings.
	DefaultUserSettings *types.UserSettings

	// A collection of DomainSettings configuration values to update.
	DomainSettingsForUpdate *types.DomainSettingsForUpdate

	// The VPC subnets that Studio uses for communication. If removing subnets, ensure
	// there are no apps in the InService , Pending , or Deleting state.
	SubnetIds []string
	// contains filtered or unexported fields
}

type UpdateDomainOutput

type UpdateDomainOutput struct {

	// The Amazon Resource Name (ARN) of the domain.
	DomainArn *string

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

type UpdateEndpointInput

type UpdateEndpointInput struct {

	// The name of the new endpoint configuration.
	//
	// This member is required.
	EndpointConfigName *string

	// The name of the endpoint whose configuration you want to update.
	//
	// This member is required.
	EndpointName *string

	// The deployment configuration for an endpoint, which contains the desired
	// deployment strategy and rollback configurations.
	DeploymentConfig *types.DeploymentConfig

	// When you are updating endpoint resources with RetainAllVariantProperties , whose
	// value is set to true , ExcludeRetainedVariantProperties specifies the list of
	// type VariantProperty (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html)
	// to override with the values provided by EndpointConfig . If you don't specify a
	// value for ExcludeRetainedVariantProperties , no variant properties are
	// overridden.
	ExcludeRetainedVariantProperties []types.VariantProperty

	// When updating endpoint resources, enables or disables the retention of variant
	// properties (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html)
	// , such as the instance count or the variant weight. To retain the variant
	// properties of an endpoint when updating it, set RetainAllVariantProperties to
	// true . To use the variant properties specified in a new EndpointConfig call
	// when updating an endpoint, set RetainAllVariantProperties to false . The default
	// is false .
	RetainAllVariantProperties *bool

	// Specifies whether to reuse the last deployment configuration. The default value
	// is false (the configuration is not reused).
	RetainDeploymentConfig *bool
	// contains filtered or unexported fields
}

type UpdateEndpointOutput

type UpdateEndpointOutput struct {

	// The Amazon Resource Name (ARN) of the endpoint.
	//
	// This member is required.
	EndpointArn *string

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

type UpdateEndpointWeightsAndCapacitiesInput

type UpdateEndpointWeightsAndCapacitiesInput struct {

	// An object that provides new capacity and weight values for a variant.
	//
	// This member is required.
	DesiredWeightsAndCapacities []types.DesiredWeightAndCapacity

	// The name of an existing SageMaker endpoint.
	//
	// This member is required.
	EndpointName *string
	// contains filtered or unexported fields
}

type UpdateEndpointWeightsAndCapacitiesOutput

type UpdateEndpointWeightsAndCapacitiesOutput struct {

	// The Amazon Resource Name (ARN) of the updated endpoint.
	//
	// This member is required.
	EndpointArn *string

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

type UpdateExperimentInput

type UpdateExperimentInput struct {

	// The name of the experiment to update.
	//
	// This member is required.
	ExperimentName *string

	// The description of the experiment.
	Description *string

	// The name of the experiment as displayed. The name doesn't need to be unique. If
	// DisplayName isn't specified, ExperimentName is displayed.
	DisplayName *string
	// contains filtered or unexported fields
}

type UpdateExperimentOutput

type UpdateExperimentOutput struct {

	// The Amazon Resource Name (ARN) of the experiment.
	ExperimentArn *string

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

type UpdateFeatureGroupInput added in v1.34.0

type UpdateFeatureGroupInput struct {

	// The name or Amazon Resource Name (ARN) of the feature group that you're
	// updating.
	//
	// This member is required.
	FeatureGroupName *string

	// Updates the feature group. Updating a feature group is an asynchronous
	// operation. When you get an HTTP 200 response, you've made a valid request. It
	// takes some time after you've made a valid request for Feature Store to update
	// the feature group.
	FeatureAdditions []types.FeatureDefinition

	// Updates the feature group online store configuration.
	OnlineStoreConfig *types.OnlineStoreConfigUpdate

	// The new throughput configuration for the feature group. You can switch between
	// on-demand and provisioned modes or update the read / write capacity of
	// provisioned feature groups. You can switch a feature group to on-demand only
	// once in a 24 hour period.
	ThroughputConfig *types.ThroughputConfigUpdate
	// contains filtered or unexported fields
}

type UpdateFeatureGroupOutput added in v1.34.0

type UpdateFeatureGroupOutput struct {

	// The Amazon Resource Number (ARN) of the feature group that you're updating.
	//
	// This member is required.
	FeatureGroupArn *string

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

type UpdateFeatureMetadataInput added in v1.34.0

type UpdateFeatureMetadataInput struct {

	// The name or Amazon Resource Name (ARN) of the feature group containing the
	// feature that you're updating.
	//
	// This member is required.
	FeatureGroupName *string

	// The name of the feature that you're updating.
	//
	// This member is required.
	FeatureName *string

	// A description that you can write to better describe the feature.
	Description *string

	// A list of key-value pairs that you can add to better describe the feature.
	ParameterAdditions []types.FeatureParameter

	// A list of parameter keys that you can specify to remove parameters that
	// describe your feature.
	ParameterRemovals []string
	// contains filtered or unexported fields
}

type UpdateFeatureMetadataOutput added in v1.34.0

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

type UpdateHubInput added in v1.56.0

type UpdateHubInput struct {

	// The name of the hub to update.
	//
	// This member is required.
	HubName *string

	// A description of the updated hub.
	HubDescription *string

	// The display name of the hub.
	HubDisplayName *string

	// The searchable keywords for the hub.
	HubSearchKeywords []string
	// contains filtered or unexported fields
}

type UpdateHubOutput added in v1.56.0

type UpdateHubOutput struct {

	// The Amazon Resource Name (ARN) of the updated hub.
	//
	// This member is required.
	HubArn *string

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

type UpdateImageInput added in v0.29.0

type UpdateImageInput struct {

	// The name of the image to update.
	//
	// This member is required.
	ImageName *string

	// A list of properties to delete. Only the Description and DisplayName properties
	// can be deleted.
	DeleteProperties []string

	// The new description for the image.
	Description *string

	// The new display name for the image.
	DisplayName *string

	// The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on
	// your behalf.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdateImageOutput added in v0.29.0

type UpdateImageOutput struct {

	// The ARN of the image.
	ImageArn *string

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

type UpdateImageVersionInput added in v1.59.0

type UpdateImageVersionInput struct {

	// The name of the image.
	//
	// This member is required.
	ImageName *string

	// The alias of the image version.
	Alias *string

	// A list of aliases to add.
	AliasesToAdd []string

	// A list of aliases to delete.
	AliasesToDelete []string

	// Indicates Horovod compatibility.
	Horovod *bool

	// Indicates SageMaker job type compatibility.
	//   - TRAINING : The image version is compatible with SageMaker training jobs.
	//   - INFERENCE : The image version is compatible with SageMaker inference jobs.
	//   - NOTEBOOK_KERNEL : The image version is compatible with SageMaker notebook
	//   kernels.
	JobType types.JobType

	// The machine learning framework vended in the image version.
	MLFramework *string

	// Indicates CPU or GPU compatibility.
	//   - CPU : The image version is compatible with CPU.
	//   - GPU : The image version is compatible with GPU.
	Processor types.Processor

	// The supported programming language and its version.
	ProgrammingLang *string

	// The maintainer description of the image version.
	ReleaseNotes *string

	// The availability of the image version specified by the maintainer.
	//   - NOT_PROVIDED : The maintainers did not provide a status for image version
	//   stability.
	//   - STABLE : The image version is stable.
	//   - TO_BE_ARCHIVED : The image version is set to be archived. Custom image
	//   versions that are set to be archived are automatically archived after three
	//   months.
	//   - ARCHIVED : The image version is archived. Archived image versions are not
	//   searchable and are no longer actively supported.
	VendorGuidance types.VendorGuidance

	// The version of the image.
	Version *int32
	// contains filtered or unexported fields
}

type UpdateImageVersionOutput added in v1.59.0

type UpdateImageVersionOutput struct {

	// The ARN of the image version.
	ImageVersionArn *string

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

type UpdateInferenceComponentInput added in v1.119.0

type UpdateInferenceComponentInput struct {

	// The name of the inference component.
	//
	// This member is required.
	InferenceComponentName *string

	// Runtime settings for a model that is deployed with an inference component.
	RuntimeConfig *types.InferenceComponentRuntimeConfig

	// Details about the resources to deploy with this inference component, including
	// the model, container, and compute resources.
	Specification *types.InferenceComponentSpecification
	// contains filtered or unexported fields
}

type UpdateInferenceComponentOutput added in v1.119.0

type UpdateInferenceComponentOutput struct {

	// The Amazon Resource Name (ARN) of the inference component.
	//
	// This member is required.
	InferenceComponentArn *string

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

type UpdateInferenceComponentRuntimeConfigInput added in v1.119.0

type UpdateInferenceComponentRuntimeConfigInput struct {

	// Runtime settings for a model that is deployed with an inference component.
	//
	// This member is required.
	DesiredRuntimeConfig *types.InferenceComponentRuntimeConfig

	// The name of the inference component to update.
	//
	// This member is required.
	InferenceComponentName *string
	// contains filtered or unexported fields
}

type UpdateInferenceComponentRuntimeConfigOutput added in v1.119.0

type UpdateInferenceComponentRuntimeConfigOutput struct {

	// The Amazon Resource Name (ARN) of the inference component.
	//
	// This member is required.
	InferenceComponentArn *string

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

type UpdateInferenceExperimentInput added in v1.56.0

type UpdateInferenceExperimentInput struct {

	// The name of the inference experiment to be updated.
	//
	// This member is required.
	Name *string

	// The Amazon S3 location and configuration for storing inference request and
	// response data.
	DataStorageConfig *types.InferenceExperimentDataStorageConfig

	// The description of the inference experiment.
	Description *string

	// An array of ModelVariantConfig objects. There is one for each variant, whose
	// infrastructure configuration you want to update.
	ModelVariants []types.ModelVariantConfig

	// The duration for which the inference experiment will run. If the status of the
	// inference experiment is Created , then you can update both the start and end
	// dates. If the status of the inference experiment is Running , then you can
	// update only the end date.
	Schedule *types.InferenceExperimentSchedule

	// The configuration of ShadowMode inference experiment type. Use this field to
	// specify a production variant which takes all the inference requests, and a
	// shadow variant to which Amazon SageMaker replicates a percentage of the
	// inference requests. For the shadow variant also specify the percentage of
	// requests that Amazon SageMaker replicates.
	ShadowModeConfig *types.ShadowModeConfig
	// contains filtered or unexported fields
}

type UpdateInferenceExperimentOutput added in v1.56.0

type UpdateInferenceExperimentOutput struct {

	// The ARN of the updated inference experiment.
	//
	// This member is required.
	InferenceExperimentArn *string

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

type UpdateModelCardInput added in v1.56.0

type UpdateModelCardInput struct {

	// The name or Amazon Resource Name (ARN) of the model card to update.
	//
	// This member is required.
	ModelCardName *string

	// The updated model card content. Content must be in model card JSON schema (https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema)
	// and provided as a string. When updating model card content, be sure to include
	// the full content and not just updated content.
	Content *string

	// The approval status of the model card within your organization. Different
	// organizations might have different criteria for model card review and approval.
	//   - Draft : The model card is a work in progress.
	//   - PendingReview : The model card is pending review.
	//   - Approved : The model card is approved.
	//   - Archived : The model card is archived. No more updates should be made to the
	//   model card, but it can still be exported.
	ModelCardStatus types.ModelCardStatus
	// contains filtered or unexported fields
}

type UpdateModelCardOutput added in v1.56.0

type UpdateModelCardOutput struct {

	// The Amazon Resource Name (ARN) of the updated model card.
	//
	// This member is required.
	ModelCardArn *string

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

type UpdateModelPackageInput added in v0.31.0

type UpdateModelPackageInput struct {

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

	// An array of additional Inference Specification objects to be added to the
	// existing array additional Inference Specification. Total number of additional
	// Inference Specifications can not exceed 15. Each additional Inference
	// Specification specifies artifacts based on this model package that can be used
	// on inference endpoints. Generally used with SageMaker Neo to store the compiled
	// artifacts.
	AdditionalInferenceSpecificationsToAdd []types.AdditionalInferenceSpecificationDefinition

	// A description for the approval status of the model.
	ApprovalDescription *string

	// The metadata properties associated with the model package versions.
	CustomerMetadataProperties map[string]string

	// The metadata properties associated with the model package versions to remove.
	CustomerMetadataPropertiesToRemove []string

	// Specifies details about inference jobs that you can run with models based on
	// this model package, including the following information:
	//   - The Amazon ECR paths of containers that contain the inference code and
	//   model artifacts.
	//   - The instance types that the model package supports for transform jobs and
	//   real-time endpoints used for inference.
	//   - The input and output content formats that the model package supports for
	//   inference.
	InferenceSpecification *types.InferenceSpecification

	// The approval status of the model.
	ModelApprovalStatus types.ModelApprovalStatus

	// The URI of the source for the model package.
	SourceUri *string
	// contains filtered or unexported fields
}

type UpdateModelPackageOutput added in v0.31.0

type UpdateModelPackageOutput struct {

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

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

type UpdateMonitoringAlertInput added in v1.56.0

type UpdateMonitoringAlertInput struct {

	// Within EvaluationPeriod , how many execution failures will raise an alert.
	//
	// This member is required.
	DatapointsToAlert *int32

	// The number of most recent monitoring executions to consider when evaluating
	// alert status.
	//
	// This member is required.
	EvaluationPeriod *int32

	// The name of a monitoring alert.
	//
	// This member is required.
	MonitoringAlertName *string

	// The name of a monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleName *string
	// contains filtered or unexported fields
}

type UpdateMonitoringAlertOutput added in v1.56.0

type UpdateMonitoringAlertOutput struct {

	// The Amazon Resource Name (ARN) of the monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleArn *string

	// The name of a monitoring alert.
	MonitoringAlertName *string

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

type UpdateMonitoringScheduleInput

type UpdateMonitoringScheduleInput struct {

	// The configuration object that specifies the monitoring schedule and defines the
	// monitoring job.
	//
	// This member is required.
	MonitoringScheduleConfig *types.MonitoringScheduleConfig

	// The name of the monitoring schedule. The name must be unique within an Amazon
	// Web Services Region within an Amazon Web Services account.
	//
	// This member is required.
	MonitoringScheduleName *string
	// contains filtered or unexported fields
}

type UpdateMonitoringScheduleOutput

type UpdateMonitoringScheduleOutput struct {

	// The Amazon Resource Name (ARN) of the monitoring schedule.
	//
	// This member is required.
	MonitoringScheduleArn *string

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

type UpdateNotebookInstanceInput

type UpdateNotebookInstanceInput struct {

	// The name of the notebook instance to update.
	//
	// This member is required.
	NotebookInstanceName *string

	// A list of the Elastic Inference (EI) instance types to associate with this
	// notebook instance. Currently only one EI instance type can be associated with a
	// notebook instance. For more information, see Using Elastic Inference in Amazon
	// SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) .
	AcceleratorTypes []types.NotebookInstanceAcceleratorType

	// An array of up to three Git repositories to associate with the notebook
	// instance. These can be either the names of Git repositories stored as resources
	// in your account, or the URL of Git repositories in Amazon Web Services
	// CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. These repositories are cloned at the same level
	// as the default repository of your notebook instance. For more information, see
	// Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// .
	AdditionalCodeRepositories []string

	// The Git repository to associate with the notebook instance as its default code
	// repository. This can be either the name of a Git repository stored as a resource
	// in your account, or the URL of a Git repository in Amazon Web Services
	// CodeCommit (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html)
	// or in any other Git repository. When you open a notebook instance, it opens in
	// the directory that contains this repository. For more information, see
	// Associating Git Repositories with SageMaker Notebook Instances (https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html)
	// .
	DefaultCodeRepository *string

	// A list of the Elastic Inference (EI) instance types to remove from this
	// notebook instance. This operation is idempotent. If you specify an accelerator
	// type that is not associated with the notebook instance when you call this
	// method, it does not throw an error.
	DisassociateAcceleratorTypes *bool

	// A list of names or URLs of the default Git repositories to remove from this
	// notebook instance. This operation is idempotent. If you specify a Git repository
	// that is not associated with the notebook instance when you call this method, it
	// does not throw an error.
	DisassociateAdditionalCodeRepositories *bool

	// The name or URL of the default Git repository to remove from this notebook
	// instance. This operation is idempotent. If you specify a Git repository that is
	// not associated with the notebook instance when you call this method, it does not
	// throw an error.
	DisassociateDefaultCodeRepository *bool

	// Set to true to remove the notebook instance lifecycle configuration currently
	// associated with the notebook instance. This operation is idempotent. If you
	// specify a lifecycle configuration that is not associated with the notebook
	// instance when you call this method, it does not throw an error.
	DisassociateLifecycleConfig *bool

	// Information on the IMDS configuration of the notebook instance
	InstanceMetadataServiceConfiguration *types.InstanceMetadataServiceConfiguration

	// The Amazon ML compute instance type.
	InstanceType types.InstanceType

	// The name of a lifecycle configuration to associate with the notebook instance.
	// For information about lifestyle configurations, see Step 2.1: (Optional)
	// Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html)
	// .
	LifecycleConfigName *string

	// The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to
	// access the notebook instance. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html)
	// . To be able to pass this role to SageMaker, the caller of this API must have
	// the iam:PassRole permission.
	RoleArn *string

	// Whether root access is enabled or disabled for users of the notebook instance.
	// The default value is Enabled . If you set this to Disabled , users don't have
	// root access on the notebook instance, but lifecycle configuration scripts still
	// run with root permissions.
	RootAccess types.RootAccess

	// The size, in GB, of the ML storage volume to attach to the notebook instance.
	// The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't
	// determine the amount of available free space on the volume. Because of this, you
	// can increase the volume size when you update a notebook instance, but you can't
	// decrease the volume size. If you want to decrease the size of the ML storage
	// volume in use, create a new notebook instance with the desired size.
	VolumeSizeInGB *int32
	// contains filtered or unexported fields
}

type UpdateNotebookInstanceLifecycleConfigInput

type UpdateNotebookInstanceLifecycleConfigInput struct {

	// The name of the lifecycle configuration.
	//
	// This member is required.
	NotebookInstanceLifecycleConfigName *string

	// The shell script that runs only once, when you create a notebook instance. The
	// shell script must be a base64-encoded string.
	OnCreate []types.NotebookInstanceLifecycleHook

	// The shell script that runs every time you start a notebook instance, including
	// when you create the notebook instance. The shell script must be a base64-encoded
	// string.
	OnStart []types.NotebookInstanceLifecycleHook
	// contains filtered or unexported fields
}

type UpdateNotebookInstanceLifecycleConfigOutput

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

type UpdateNotebookInstanceOutput

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

type UpdatePipelineExecutionInput added in v0.31.0

type UpdatePipelineExecutionInput struct {

	// The Amazon Resource Name (ARN) of the pipeline execution.
	//
	// This member is required.
	PipelineExecutionArn *string

	// This configuration, if specified, overrides the parallelism configuration of
	// the parent pipeline for this specific run.
	ParallelismConfiguration *types.ParallelismConfiguration

	// The description of the pipeline execution.
	PipelineExecutionDescription *string

	// The display name of the pipeline execution.
	PipelineExecutionDisplayName *string
	// contains filtered or unexported fields
}

type UpdatePipelineExecutionOutput added in v0.31.0

type UpdatePipelineExecutionOutput struct {

	// The Amazon Resource Name (ARN) of the updated pipeline execution.
	PipelineExecutionArn *string

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

type UpdatePipelineInput added in v0.31.0

type UpdatePipelineInput struct {

	// The name of the pipeline to update.
	//
	// This member is required.
	PipelineName *string

	// If specified, it applies to all executions of this pipeline by default.
	ParallelismConfiguration *types.ParallelismConfiguration

	// The JSON pipeline definition.
	PipelineDefinition *string

	// The location of the pipeline definition stored in Amazon S3. If specified,
	// SageMaker will retrieve the pipeline definition from this location.
	PipelineDefinitionS3Location *types.PipelineDefinitionS3Location

	// The description of the pipeline.
	PipelineDescription *string

	// The display name of the pipeline.
	PipelineDisplayName *string

	// The Amazon Resource Name (ARN) that the pipeline uses to execute.
	RoleArn *string
	// contains filtered or unexported fields
}

type UpdatePipelineOutput added in v0.31.0

type UpdatePipelineOutput struct {

	// The Amazon Resource Name (ARN) of the updated pipeline.
	PipelineArn *string

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

type UpdateProjectInput added in v1.18.0

type UpdateProjectInput struct {

	// The name of the project.
	//
	// This member is required.
	ProjectName *string

	// The description for the project.
	ProjectDescription *string

	// The product ID and provisioning artifact ID to provision a service catalog. The
	// provisioning artifact ID will default to the latest provisioning artifact ID of
	// the product, if you don't provide the provisioning artifact ID. For more
	// information, see What is Amazon Web Services Service Catalog (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html)
	// .
	ServiceCatalogProvisioningUpdateDetails *types.ServiceCatalogProvisioningUpdateDetails

	// An array of key-value pairs. You can use tags to categorize your Amazon Web
	// Services resources in different ways, for example, by purpose, owner, or
	// environment. For more information, see Tagging Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
	// . In addition, the project must have tag update constraints set in order to
	// include this parameter in the request. For more information, see Amazon Web
	// Services Service Catalog Tag Update Constraints (https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints-resourceupdate.html)
	// .
	Tags []types.Tag
	// contains filtered or unexported fields
}

type UpdateProjectOutput added in v1.18.0

type UpdateProjectOutput struct {

	// The Amazon Resource Name (ARN) of the project.
	//
	// This member is required.
	ProjectArn *string

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

type UpdateSpaceInput added in v1.56.0

type UpdateSpaceInput struct {

	// The ID of the associated domain.
	//
	// This member is required.
	DomainId *string

	// The name of the space.
	//
	// This member is required.
	SpaceName *string

	// The name of the space that appears in the Amazon SageMaker Studio UI.
	SpaceDisplayName *string

	// A collection of space settings.
	SpaceSettings *types.SpaceSettings
	// contains filtered or unexported fields
}

type UpdateSpaceOutput added in v1.56.0

type UpdateSpaceOutput struct {

	// The space's Amazon Resource Name (ARN).
	SpaceArn *string

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

type UpdateTrainingJobInput added in v0.31.0

type UpdateTrainingJobInput struct {

	// The name of a training job to update the Debugger profiling configuration.
	//
	// This member is required.
	TrainingJobName *string

	// Configuration information for Amazon SageMaker Debugger system monitoring,
	// framework profiling, and storage paths.
	ProfilerConfig *types.ProfilerConfigForUpdate

	// Configuration information for Amazon SageMaker Debugger rules for profiling
	// system and framework metrics.
	ProfilerRuleConfigurations []types.ProfilerRuleConfiguration

	// Configuration for remote debugging while the training job is running. You can
	// update the remote debugging configuration when the SecondaryStatus of the job
	// is Downloading or Training .To learn more about the remote debugging
	// functionality of SageMaker, see Access a training container through Amazon Web
	// Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html)
	// .
	RemoteDebugConfig *types.RemoteDebugConfigForUpdate

	// The training job ResourceConfig to update warm pool retention length.
	ResourceConfig *types.ResourceConfigForUpdate
	// contains filtered or unexported fields
}

type UpdateTrainingJobOutput added in v0.31.0

type UpdateTrainingJobOutput struct {

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

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

type UpdateTrialComponentInput

type UpdateTrialComponentInput struct {

	// The name of the component to update.
	//
	// This member is required.
	TrialComponentName *string

	// The name of the component as displayed. The name doesn't need to be unique. If
	// DisplayName isn't specified, TrialComponentName is displayed.
	DisplayName *string

	// When the component ended.
	EndTime *time.Time

	// Replaces all of the component's input artifacts with the specified artifacts or
	// adds new input artifacts. Existing input artifacts are replaced if the trial
	// component is updated with an identical input artifact key.
	InputArtifacts map[string]types.TrialComponentArtifact

	// The input artifacts to remove from the component.
	InputArtifactsToRemove []string

	// Replaces all of the component's output artifacts with the specified artifacts
	// or adds new output artifacts. Existing output artifacts are replaced if the
	// trial component is updated with an identical output artifact key.
	OutputArtifacts map[string]types.TrialComponentArtifact

	// The output artifacts to remove from the component.
	OutputArtifactsToRemove []string

	// Replaces all of the component's hyperparameters with the specified
	// hyperparameters or add new hyperparameters. Existing hyperparameters are
	// replaced if the trial component is updated with an identical hyperparameter key.
	Parameters map[string]types.TrialComponentParameterValue

	// The hyperparameters to remove from the component.
	ParametersToRemove []string

	// When the component started.
	StartTime *time.Time

	// The new status of the component.
	Status *types.TrialComponentStatus
	// contains filtered or unexported fields
}

type UpdateTrialComponentOutput

type UpdateTrialComponentOutput struct {

	// The Amazon Resource Name (ARN) of the trial component.
	TrialComponentArn *string

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

type UpdateTrialInput

type UpdateTrialInput struct {

	// The name of the trial to update.
	//
	// This member is required.
	TrialName *string

	// The name of the trial as displayed. The name doesn't need to be unique. If
	// DisplayName isn't specified, TrialName is displayed.
	DisplayName *string
	// contains filtered or unexported fields
}

type UpdateTrialOutput

type UpdateTrialOutput struct {

	// The Amazon Resource Name (ARN) of the trial.
	TrialArn *string

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

type UpdateUserProfileInput

type UpdateUserProfileInput struct {

	// The domain ID.
	//
	// This member is required.
	DomainId *string

	// The user profile name.
	//
	// This member is required.
	UserProfileName *string

	// A collection of settings.
	UserSettings *types.UserSettings
	// contains filtered or unexported fields
}

type UpdateUserProfileOutput

type UpdateUserProfileOutput struct {

	// The user profile Amazon Resource Name (ARN).
	UserProfileArn *string

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

type UpdateWorkforceInput

type UpdateWorkforceInput struct {

	// The name of the private workforce that you want to update. You can find your
	// workforce name by using the ListWorkforces (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListWorkforces.html)
	// operation.
	//
	// This member is required.
	WorkforceName *string

	// Use this parameter to update your OIDC Identity Provider (IdP) configuration
	// for a workforce made using your own IdP.
	OidcConfig *types.OidcConfig

	// A list of one to ten worker IP address ranges ( CIDRs (https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)
	// ) that can be used to access tasks assigned to this workforce. Maximum: Ten CIDR
	// values
	SourceIpConfig *types.SourceIpConfig

	// Use this parameter to update your VPC configuration for a workforce.
	WorkforceVpcConfig *types.WorkforceVpcConfigRequest
	// contains filtered or unexported fields
}

type UpdateWorkforceOutput

type UpdateWorkforceOutput struct {

	// A single private workforce. You can create one private work force in each
	// Amazon Web Services Region. By default, any workforce-related API operation used
	// in a specific region will apply to the workforce created in that region. To
	// learn how to create a private workforce, see Create a Private Workforce (https://docs.aws.amazon.com/sagemaker/latest/dg/sms-workforce-create-private.html)
	// .
	//
	// This member is required.
	Workforce *types.Workforce

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

type UpdateWorkteamInput

type UpdateWorkteamInput struct {

	// The name of the work team to update.
	//
	// This member is required.
	WorkteamName *string

	// An updated description for the work team.
	Description *string

	// A list of MemberDefinition objects that contains objects that identify the
	// workers that make up the work team. Workforces can be created using Amazon
	// Cognito or your own OIDC Identity Provider (IdP). For private workforces created
	// using Amazon Cognito use CognitoMemberDefinition . For workforces created using
	// your own OIDC identity provider (IdP) use OidcMemberDefinition . You should not
	// provide input for both of these parameters in a single request. For workforces
	// created using Amazon Cognito, private work teams correspond to Amazon Cognito
	// user groups within the user pool used to create a workforce. All of the
	// CognitoMemberDefinition objects that make up the member definition must have the
	// same ClientId and UserPool values. To add a Amazon Cognito user group to an
	// existing worker pool, see Adding groups to a User Pool . For more information
	// about user pools, see Amazon Cognito User Pools (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html)
	// . For workforces created using your own OIDC IdP, specify the user groups that
	// you want to include in your private work team in OidcMemberDefinition by
	// listing those groups in Groups . Be aware that user groups that are already in
	// the work team must also be listed in Groups when you make this request to
	// remain on the work team. If you do not include these user groups, they will no
	// longer be associated with the work team you update.
	MemberDefinitions []types.MemberDefinition

	// Configures SNS topic notifications for available or expiring work items
	NotificationConfiguration *types.NotificationConfiguration
	// contains filtered or unexported fields
}

type UpdateWorkteamOutput

type UpdateWorkteamOutput struct {

	// A Workteam object that describes the updated work team.
	//
	// This member is required.
	Workteam *types.Workteam

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

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL