Information about a hub.
* @public */ export interface HubInfo { /** *The name of the hub.
* @public */ HubName: string | undefined; /** *The Amazon Resource Name (ARN) of the hub.
* @public */ HubArn: string | undefined; /** *The display name of the hub.
* @public */ HubDisplayName?: string | undefined; /** *A description of the hub.
* @public */ HubDescription?: string | undefined; /** *The searchable keywords for the hub.
* @public */ HubSearchKeywords?: string[] | undefined; /** *The status of the hub.
* @public */ HubStatus: HubStatus | undefined; /** *The date and time that the hub was created.
* @public */ CreationTime: Date | undefined; /** *The date and time that the hub was last modified.
* @public */ LastModifiedTime: Date | undefined; } /** * @public * @enum */ export declare const HubSortBy: { readonly ACCOUNT_ID_OWNER: "AccountIdOwner"; readonly CREATION_TIME: "CreationTime"; readonly HUB_NAME: "HubName"; readonly HUB_STATUS: "HubStatus"; }; /** * @public */ export type HubSortBy = (typeof HubSortBy)[keyof typeof HubSortBy]; /** *Container for human task user interface information.
* @public */ export interface HumanTaskUiSummary { /** *The name of the human task user interface.
* @public */ HumanTaskUiName: string | undefined; /** *The Amazon Resource Name (ARN) of the human task user interface.
* @public */ HumanTaskUiArn: string | undefined; /** *A timestamp when SageMaker created the human task user interface.
* @public */ CreationTime: Date | undefined; } /** *An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.
* @public */ export interface HyperParameterTuningJobSearchEntity { /** *The name of a hyperparameter tuning job.
* @public */ HyperParameterTuningJobName?: string | undefined; /** *The Amazon Resource Name (ARN) of a hyperparameter tuning job.
* @public */ HyperParameterTuningJobArn?: string | undefined; /** *Configures a hyperparameter tuning job.
* @public */ HyperParameterTuningJobConfig?: HyperParameterTuningJobConfig | undefined; /** *Defines the training jobs launched by a hyperparameter tuning job.
* @public */ TrainingJobDefinition?: HyperParameterTrainingJobDefinition | undefined; /** *The job definitions included in a hyperparameter tuning job.
* @public */ TrainingJobDefinitions?: HyperParameterTrainingJobDefinition[] | undefined; /** *The status of a hyperparameter tuning job.
* @public */ HyperParameterTuningJobStatus?: HyperParameterTuningJobStatus | undefined; /** *The time that a hyperparameter tuning job was created.
* @public */ CreationTime?: Date | undefined; /** *The time that a hyperparameter tuning job ended.
* @public */ HyperParameterTuningEndTime?: Date | undefined; /** *The time that a hyperparameter tuning job was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.
* @public */ TrainingJobStatusCounters?: TrainingJobStatusCounters | undefined; /** *Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.
* @public */ ObjectiveStatusCounters?: ObjectiveStatusCounters | undefined; /** *The container for the summary information about a training job.
* @public */ BestTrainingJob?: HyperParameterTrainingJobSummary | undefined; /** *The container for the summary information about a training job.
* @public */ OverallBestTrainingJob?: HyperParameterTrainingJobSummary | undefined; /** *Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter 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, and the training job that performs the best 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.
The error that was created when a hyperparameter tuning job failed.
* @public */ FailureReason?: string | undefined; /** *Information about either a current or completed hyperparameter tuning job.
* @public */ TuningJobCompletionDetails?: HyperParameterTuningJobCompletionDetails | undefined; /** *The total amount of resources consumed by a hyperparameter tuning job.
* @public */ ConsumedResources?: HyperParameterTuningJobConsumedResources | undefined; /** *The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.
* @public */ Tags?: Tag[] | undefined; } /** * @public * @enum */ export declare const HyperParameterTuningJobSortByOptions: { readonly CreationTime: "CreationTime"; readonly Name: "Name"; readonly Status: "Status"; }; /** * @public */ export type HyperParameterTuningJobSortByOptions = (typeof HyperParameterTuningJobSortByOptions)[keyof typeof HyperParameterTuningJobSortByOptions]; /** *Provides summary information about a hyperparameter tuning job.
* @public */ export interface HyperParameterTuningJobSummary { /** *The name of the tuning job.
* @public */ HyperParameterTuningJobName: string | undefined; /** *The Amazon Resource Name (ARN) of the tuning job.
* @public */ HyperParameterTuningJobArn: string | undefined; /** *The status of the tuning job.
* @public */ HyperParameterTuningJobStatus: HyperParameterTuningJobStatus | undefined; /** *Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.
* @public */ Strategy: HyperParameterTuningJobStrategyType | undefined; /** *The date and time that the tuning job was created.
* @public */ CreationTime: Date | undefined; /** *The date and time that the tuning job ended.
* @public */ HyperParameterTuningEndTime?: Date | undefined; /** *The date and time that the tuning job was modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.
* @public */ TrainingJobStatusCounters: TrainingJobStatusCounters | undefined; /** *The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.
* @public */ ObjectiveStatusCounters: ObjectiveStatusCounters | undefined; /** *The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.
* @public */ ResourceLimits?: ResourceLimits | undefined; } /** *A SageMaker AI image. A SageMaker AI image represents a set of container images that are derived from a common base container image. Each of these container images is represented by a SageMaker AI ImageVersion.
When the image was created.
* @public */ CreationTime: Date | undefined; /** *The description of the image.
* @public */ Description?: string | undefined; /** *The name of the image as displayed.
* @public */ DisplayName?: string | undefined; /** *When a create, update, or delete operation fails, the reason for the failure.
* @public */ FailureReason?: string | undefined; /** *The ARN of the image.
* @public */ ImageArn: string | undefined; /** *The name of the image.
* @public */ ImageName: string | undefined; /** *The status of the image.
* @public */ ImageStatus: ImageStatus | undefined; /** *When the image was last modified.
* @public */ LastModifiedTime: Date | undefined; } /** * @public * @enum */ export declare const ImageSortBy: { readonly CREATION_TIME: "CREATION_TIME"; readonly IMAGE_NAME: "IMAGE_NAME"; readonly LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME"; }; /** * @public */ export type ImageSortBy = (typeof ImageSortBy)[keyof typeof ImageSortBy]; /** * @public * @enum */ export declare const ImageSortOrder: { readonly ASCENDING: "ASCENDING"; readonly DESCENDING: "DESCENDING"; }; /** * @public */ export type ImageSortOrder = (typeof ImageSortOrder)[keyof typeof ImageSortOrder]; /** *A version of a SageMaker AI Image. A version represents an existing container image.
When the version was created.
* @public */ CreationTime: Date | undefined; /** *When a create or delete operation fails, the reason for the failure.
* @public */ FailureReason?: string | undefined; /** *The ARN of the image the version is based on.
* @public */ ImageArn: string | undefined; /** *The ARN of the version.
* @public */ ImageVersionArn: string | undefined; /** *The status of the version.
* @public */ ImageVersionStatus: ImageVersionStatus | undefined; /** *When the version was last modified.
* @public */ LastModifiedTime: Date | undefined; /** *The version number.
* @public */ Version: number | undefined; } /** * @public * @enum */ export declare const ImageVersionSortBy: { readonly CREATION_TIME: "CREATION_TIME"; readonly LAST_MODIFIED_TIME: "LAST_MODIFIED_TIME"; readonly VERSION: "VERSION"; }; /** * @public */ export type ImageVersionSortBy = (typeof ImageVersionSortBy)[keyof typeof ImageVersionSortBy]; /** * @public * @enum */ export declare const ImageVersionSortOrder: { readonly ASCENDING: "ASCENDING"; readonly DESCENDING: "DESCENDING"; }; /** * @public */ export type ImageVersionSortOrder = (typeof ImageVersionSortOrder)[keyof typeof ImageVersionSortOrder]; /** * @public */ export interface ImportHubContentRequest { /** *The name of the hub content to import.
* @public */ HubContentName: string | undefined; /** *The version of the hub content to import.
* @public */ HubContentVersion?: string | undefined; /** *The type of hub content to import.
* @public */ HubContentType: HubContentType | undefined; /** *The version of the hub content schema to import.
* @public */ DocumentSchemaVersion: string | undefined; /** *The name of the hub to import content into.
* @public */ HubName: string | undefined; /** *The display name of the hub content to import.
* @public */ HubContentDisplayName?: string | undefined; /** *A description of the hub content to import.
* @public */ HubContentDescription?: string | undefined; /** *A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
* @public */ HubContentMarkdown?: string | undefined; /** *The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
* @public */ HubContentDocument: string | undefined; /** *The status of the hub content resource.
* @public */ SupportStatus?: HubContentSupportStatus | undefined; /** *The searchable keywords of the hub content.
* @public */ HubContentSearchKeywords?: string[] | undefined; /** *Any tags associated with the hub content.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface ImportHubContentResponse { /** *The ARN of the hub that the content was imported into.
* @public */ HubArn: string | undefined; /** *The ARN of the hub content that was imported.
* @public */ HubContentArn: string | undefined; } /** * @public * @enum */ export declare const InferenceComponentSortKey: { readonly CreationTime: "CreationTime"; readonly Name: "Name"; readonly Status: "Status"; }; /** * @public */ export type InferenceComponentSortKey = (typeof InferenceComponentSortKey)[keyof typeof InferenceComponentSortKey]; /** *A summary of the properties of an inference component.
* @public */ export interface InferenceComponentSummary { /** *The time when the inference component was created.
* @public */ CreationTime: Date | undefined; /** *The Amazon Resource Name (ARN) of the inference component.
* @public */ InferenceComponentArn: string | undefined; /** *The name of the inference component.
* @public */ InferenceComponentName: string | undefined; /** *The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.
* @public */ EndpointArn: string | undefined; /** *The name of the endpoint that hosts the inference component.
* @public */ EndpointName: string | undefined; /** *The name of the production variant that hosts the inference component.
* @public */ VariantName: string | undefined; /** *The status of the inference component.
* @public */ InferenceComponentStatus?: InferenceComponentStatus | undefined; /** *The time when the inference component was last updated.
* @public */ LastModifiedTime: Date | undefined; } /** *Lists a summary of properties of an inference experiment.
* @public */ export interface InferenceExperimentSummary { /** *The name of the inference experiment.
* @public */ Name: string | undefined; /** *The type of the inference experiment.
* @public */ Type: InferenceExperimentType | undefined; /** *The duration for which the inference experiment ran or will run.
The maximum duration that you can set for an inference experiment is 30 days.
* @public */ Schedule?: InferenceExperimentSchedule | undefined; /** *The status of the inference experiment.
* @public */ Status: InferenceExperimentStatus | undefined; /** *The error message for the inference experiment status result.
* @public */ StatusReason?: string | undefined; /** *The description of the inference experiment.
* @public */ Description?: string | undefined; /** *The timestamp at which the inference experiment was created.
* @public */ CreationTime: Date | undefined; /** *The timestamp at which the inference experiment was completed.
* @public */ CompletionTime?: Date | undefined; /** *The timestamp when you last modified the inference experiment.
* @public */ LastModifiedTime: Date | undefined; /** *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.
* @public */ RoleArn?: string | undefined; } /** * @public * @enum */ export declare const InferenceExperimentStopDesiredState: { readonly CANCELLED: "Cancelled"; readonly COMPLETED: "Completed"; }; /** * @public */ export type InferenceExperimentStopDesiredState = (typeof InferenceExperimentStopDesiredState)[keyof typeof InferenceExperimentStopDesiredState]; /** *A structure that contains a list of recommendation jobs.
* @public */ export interface InferenceRecommendationsJob { /** *The name of the job.
* @public */ JobName: string | undefined; /** *The job description.
* @public */ JobDescription: string | undefined; /** *The recommendation job type.
* @public */ JobType: RecommendationJobType | undefined; /** *The Amazon Resource Name (ARN) of the recommendation job.
* @public */ JobArn: string | undefined; /** *The status of the job.
* @public */ Status: RecommendationJobStatus | undefined; /** *A timestamp that shows when the job was created.
* @public */ CreationTime: Date | undefined; /** *A timestamp that shows when the job completed.
* @public */ CompletionTime?: Date | undefined; /** *The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
* @public */ RoleArn: string | undefined; /** *A timestamp that shows when the job was last modified.
* @public */ LastModifiedTime: Date | undefined; /** *If the job fails, provides information why the job failed.
* @public */ FailureReason?: string | undefined; /** *The name of the created model.
* @public */ ModelName?: string | undefined; /** *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).
* @public */ SamplePayloadUrl?: string | undefined; /** *The Amazon Resource Name (ARN) of a versioned model package.
* @public */ ModelPackageVersionArn?: string | undefined; } /** *The details for a specific benchmark from an Inference Recommender job.
* @public */ export interface RecommendationJobInferenceBenchmark { /** *The metrics of recommendations.
* @public */ Metrics?: RecommendationMetrics | undefined; /** *The metrics for an existing endpoint compared in an Inference Recommender job.
* @public */ EndpointMetrics?: InferenceMetrics | undefined; /** *The endpoint configuration made by Inference Recommender during a recommendation job.
* @public */ EndpointConfiguration?: EndpointOutputConfiguration | undefined; /** *Defines the model configuration. Includes the specification name and environment parameters.
* @public */ ModelConfiguration: ModelConfiguration | undefined; /** *The reason why a benchmark failed.
* @public */ FailureReason?: string | undefined; /** *A timestamp that shows when the benchmark completed.
* @public */ InvocationEndTime?: Date | undefined; /** *A timestamp that shows when the benchmark started.
* @public */ InvocationStartTime?: Date | undefined; } /** * @public * @enum */ export declare const RecommendationStepType: { readonly BENCHMARK: "BENCHMARK"; }; /** * @public */ export type RecommendationStepType = (typeof RecommendationStepType)[keyof typeof RecommendationStepType]; /** *A returned array object for the Steps response field in the ListInferenceRecommendationsJobSteps API command.
The type of the subtask.
BENCHMARK: Evaluate the performance of your model on different instance types.
The name of the Inference Recommender job.
* @public */ JobName: string | undefined; /** *The current status of the benchmark.
* @public */ Status: RecommendationJobStatus | undefined; /** *The details for a specific benchmark.
* @public */ InferenceBenchmark?: RecommendationJobInferenceBenchmark | undefined; } /** *Provides counts for human-labeled tasks in the labeling job.
* @public */ export interface LabelCountersForWorkteam { /** *The total number of data objects labeled by a human worker.
* @public */ HumanLabeled?: number | undefined; /** *The total number of data objects that need to be labeled by a human worker.
* @public */ PendingHuman?: number | undefined; /** *The total number of tasks in the labeling job.
* @public */ Total?: number | undefined; } /** *Provides summary information for a work team.
* @public */ export interface LabelingJobForWorkteamSummary { /** *The name of the labeling job that the work team is assigned to.
* @public */ LabelingJobName?: string | undefined; /** *A unique identifier for a labeling job. You can use this to refer to a specific labeling job.
* @public */ JobReferenceCode: string | undefined; /** *The Amazon Web Services account ID of the account used to start the labeling job.
* @public */ WorkRequesterAccountId: string | undefined; /** *The date and time that the labeling job was created.
* @public */ CreationTime: Date | undefined; /** *Provides information about the progress of a labeling job.
* @public */ LabelCounters?: LabelCountersForWorkteam | undefined; /** *The configured number of workers per data object.
* @public */ NumberOfHumanWorkersPerDataObject?: number | undefined; } /** *Provides summary information about a labeling job.
* @public */ export interface LabelingJobSummary { /** *The name of the labeling job.
* @public */ LabelingJobName: string | undefined; /** *The Amazon Resource Name (ARN) assigned to the labeling job when it was created.
* @public */ LabelingJobArn: string | undefined; /** *The date and time that the job was created (timestamp).
* @public */ CreationTime: Date | undefined; /** *The date and time that the job was last modified (timestamp).
* @public */ LastModifiedTime: Date | undefined; /** *The current status of the labeling job.
* @public */ LabelingJobStatus: LabelingJobStatus | undefined; /** *Counts showing the progress of the labeling job.
* @public */ LabelCounters: LabelCounters | undefined; /** *The Amazon Resource Name (ARN) of the work team assigned to the job.
* @public */ WorkteamArn: string | undefined; /** *The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.
* @public */ PreHumanTaskLambdaArn?: string | undefined; /** *The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.
* @public */ AnnotationConsolidationLambdaArn?: string | undefined; /** *If the LabelingJobStatus field is Failed, this field contains a description of the error.
The location of the output produced by the labeling job.
* @public */ LabelingJobOutput?: LabelingJobOutput | undefined; /** *Input configuration for the labeling job.
* @public */ InputConfig?: LabelingJobInputConfig | undefined; } /** *Metadata for a Lambda step.
* @public */ export interface LambdaStepMetadata { /** *The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.
* @public */ Arn?: string | undefined; /** *A list of the output parameters of the Lambda step.
* @public */ OutputParameters?: OutputParameter[] | undefined; } /** *Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.
* @public */ export interface LineageGroupSummary { /** *The Amazon Resource Name (ARN) of the lineage group resource.
* @public */ LineageGroupArn?: string | undefined; /** *The name or Amazon Resource Name (ARN) of the lineage group.
* @public */ LineageGroupName?: string | undefined; /** *The display name of the lineage group summary.
* @public */ DisplayName?: string | undefined; /** *The creation time of the lineage group summary.
* @public */ CreationTime?: Date | undefined; /** *The last modified time of the lineage group summary.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public * @enum */ export declare const LineageType: { readonly ACTION: "Action"; readonly ARTIFACT: "Artifact"; readonly CONTEXT: "Context"; readonly TRIAL_COMPONENT: "TrialComponent"; }; /** * @public */ export type LineageType = (typeof LineageType)[keyof typeof LineageType]; /** * @public * @enum */ export declare const SortActionsBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type SortActionsBy = (typeof SortActionsBy)[keyof typeof SortActionsBy]; /** * @public * @enum */ export declare const SortOrder: { readonly ASCENDING: "Ascending"; readonly DESCENDING: "Descending"; }; /** * @public */ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; /** * @public */ export interface ListActionsRequest { /** *A filter that returns only actions with the specified source URI.
* @public */ SourceUri?: string | undefined; /** *A filter that returns only actions of the specified type.
* @public */ ActionType?: string | undefined; /** *A filter that returns only actions created on or after the specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns only actions created on or before the specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
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.
The maximum number of actions to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListActionsResponse { /** *A list of actions and their properties.
* @public */ ActionSummaries?: ActionSummary[] | undefined; /** *A token for getting the next set of actions, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAlgorithmsInput { /** *A filter that returns only algorithms created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only algorithms created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *The maximum number of algorithms to return in the response.
* @public */ MaxResults?: number | undefined; /** *A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *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.
The parameter by which to sort the results. The default is CreationTime.
The sort order for the results. The default is Ascending.
>An array of AlgorithmSummary objects, each of which lists an algorithm.
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAliasesRequest { /** *The name of the image.
* @public */ ImageName: string | undefined; /** *The alias of the image version.
* @public */ Alias?: string | undefined; /** *The version of the image. If image version is not specified, the aliases of all versions of the image are listed.
* @public */ Version?: number | undefined; /** *The maximum number of aliases to return.
* @public */ MaxResults?: number | undefined; /** *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.
A list of SageMaker AI image version aliases.
* @public */ SageMakerImageVersionAliases?: string[] | undefined; /** *A token for getting the next set of aliases, if more aliases exist.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAppImageConfigsRequest { /** *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.
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.
A filter that returns only AppImageConfigs whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only AppImageConfigs created on or before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only AppImageConfigs created on or after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only AppImageConfigs modified on or before the specified time.
* @public */ ModifiedTimeBefore?: Date | undefined; /** *A filter that returns only AppImageConfigs modified on or after the specified time.
* @public */ ModifiedTimeAfter?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
A token for getting the next set of AppImageConfigs, if there are any.
* @public */ NextToken?: string | undefined; /** *A list of AppImageConfigs and their properties.
* @public */ AppImageConfigs?: AppImageConfigDetails[] | undefined; } /** * @public */ export interface ListAppsRequest { /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
The sort order for the results. The default is Ascending.
* @public */ SortOrder?: SortOrder | undefined; /** *The parameter by which to sort the results. The default is CreationTime.
* @public */ SortBy?: AppSortKey | undefined; /** *A parameter to search for the domain ID.
* @public */ DomainIdEquals?: string | undefined; /** *A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.
A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.
The list of apps.
* @public */ Apps?: AppDetails[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortArtifactsBy: { readonly CREATION_TIME: "CreationTime"; }; /** * @public */ export type SortArtifactsBy = (typeof SortArtifactsBy)[keyof typeof SortArtifactsBy]; /** * @public */ export interface ListArtifactsRequest { /** *A filter that returns only artifacts with the specified source URI.
* @public */ SourceUri?: string | undefined; /** *A filter that returns only artifacts of the specified type.
* @public */ ArtifactType?: string | undefined; /** *A filter that returns only artifacts created on or after the specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns only artifacts created on or before the specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
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.
The maximum number of artifacts to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListArtifactsResponse { /** *A list of artifacts and their properties.
* @public */ ArtifactSummaries?: ArtifactSummary[] | undefined; /** *A token for getting the next set of artifacts, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortAssociationsBy: { readonly CREATION_TIME: "CreationTime"; readonly DESTINATION_ARN: "DestinationArn"; readonly DESTINATION_TYPE: "DestinationType"; readonly SOURCE_ARN: "SourceArn"; readonly SOURCE_TYPE: "SourceType"; }; /** * @public */ export type SortAssociationsBy = (typeof SortAssociationsBy)[keyof typeof SortAssociationsBy]; /** * @public */ export interface ListAssociationsRequest { /** *A filter that returns only associations with the specified source ARN.
* @public */ SourceArn?: string | undefined; /** *A filter that returns only associations with the specified destination Amazon Resource Name (ARN).
* @public */ DestinationArn?: string | undefined; /** *A filter that returns only associations with the specified source type.
* @public */ SourceType?: string | undefined; /** *A filter that returns only associations with the specified destination type.
* @public */ DestinationType?: string | undefined; /** *A filter that returns only associations of the specified type.
* @public */ AssociationType?: AssociationEdgeType | undefined; /** *A filter that returns only associations created on or after the specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns only associations created on or before the specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
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.
The maximum number of associations to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListAssociationsResponse { /** *A list of associations and their properties.
* @public */ AssociationSummaries?: AssociationSummary[] | undefined; /** *A token for getting the next set of associations, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAutoMLJobsRequest { /** *Request a list of jobs, using a filter for time.
* @public */ CreationTimeAfter?: Date | undefined; /** *Request a list of jobs, using a filter for time.
* @public */ CreationTimeBefore?: Date | undefined; /** *Request a list of jobs, using a filter for time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Request a list of jobs, using a filter for time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *Request a list of jobs, using a search filter for name.
* @public */ NameContains?: string | undefined; /** *Request a list of jobs, using a filter for status.
* @public */ StatusEquals?: AutoMLJobStatus | undefined; /** *The sort order for the results. The default is Descending.
The parameter by which to sort the results. The default is Name.
Request a list of jobs up to a specified limit.
* @public */ MaxResults?: number | undefined; /** *If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAutoMLJobsResponse { /** *Returns a summary list of jobs.
* @public */ AutoMLJobSummaries: AutoMLJobSummary[] | undefined; /** *If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListCandidatesForAutoMLJobRequest { /** *List the candidates created for the job by providing the job's name.
* @public */ AutoMLJobName: string | undefined; /** *List the candidates for the job and filter by status.
* @public */ StatusEquals?: CandidateStatus | undefined; /** *List the candidates for the job and filter by candidate name.
* @public */ CandidateNameEquals?: string | undefined; /** *The sort order for the results. The default is Ascending.
The parameter by which to sort the results. The default is Descending.
List the job's candidates up to a specified limit.
* @public */ MaxResults?: number | undefined; /** *If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListCandidatesForAutoMLJobResponse { /** *Summaries about the AutoMLCandidates.
If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListClusterEventsRequest { /** *The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.
* @public */ ClusterName: string | undefined; /** *The name of the instance group to filter events. If specified, only events related to this instance group are returned.
* @public */ InstanceGroupName?: string | undefined; /** *The EC2 instance ID to filter events. If specified, only events related to this instance are returned.
* @public */ NodeId?: string | undefined; /** *The start of the time range for filtering events. Only events that occurred after this time are included in the results.
* @public */ EventTimeAfter?: Date | undefined; /** *The end of the time range for filtering events. Only events that occurred before this time are included in the results.
* @public */ EventTimeBefore?: Date | undefined; /** *The field to use for sorting the event list. Currently, the only supported value is EventTime.
The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).
The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.
The maximum number of events to return in the response. Valid range is 1 to 100.
* @public */ MaxResults?: number | undefined; /** *A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterEvents call.
A token to retrieve the next set of results. Include this token in subsequent ListClusterEvents calls to fetch more events.
A list of event summaries matching the specified criteria.
* @public */ Events?: ClusterEventSummary[] | undefined; } /** * @public */ export interface ListClusterNodesRequest { /** *The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.
* @public */ ClusterName: string | undefined; /** *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 in the Amazon Web Services Command Line Interface User Guide.
* @public */ CreationTimeAfter?: Date | undefined; /** *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 in the Amazon Web Services Command Line Interface User Guide.
A filter that returns the instance groups whose name contain a specified string.
* @public */ InstanceGroupNameContains?: string | undefined; /** *The maximum number of nodes to return in the response.
* @public */ MaxResults?: number | undefined; /** *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.
The field by which to sort results. The default value is CREATION_TIME.
The sort order for results. The default value is Ascending.
Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to False (default), only nodes with assigned InstanceIds are returned.
The next token specified for listing instances in a SageMaker HyperPod cluster.
* @public */ NextToken?: string | undefined; /** *The summaries of listed instances in a SageMaker HyperPod cluster
* @public */ ClusterNodeSummaries: ClusterNodeSummary[] | undefined; } /** * @public */ export interface ListClustersRequest { /** *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 in the Amazon Web Services Command Line Interface User Guide.
* @public */ CreationTimeAfter?: Date | undefined; /** *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 in the Amazon Web Services Command Line Interface User Guide.
Specifies the maximum number of clusters to evaluate for the operation (not necessarily the number of matching items). After SageMaker processes the number of clusters up to MaxResults, it stops the operation and returns the matching clusters up to that point. If all the matching clusters are desired, SageMaker will go through all the clusters until NextToken is empty.
Set the maximum number of instances to print in the list.
* @public */ NameContains?: string | undefined; /** *Set the next token to retrieve the list of SageMaker HyperPod clusters.
* @public */ NextToken?: string | undefined; /** *The field by which to sort results. The default value is CREATION_TIME.
The sort order for results. The default value is Ascending.
The Amazon Resource Name (ARN); of the training plan to filter clusters by. For more information about reserving GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
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.
The summaries of listed SageMaker HyperPod clusters.
* @public */ ClusterSummaries: ClusterSummary[] | undefined; } /** * @public * @enum */ export declare const SortClusterSchedulerConfigBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; readonly STATUS: "Status"; }; /** * @public */ export type SortClusterSchedulerConfigBy = (typeof SortClusterSchedulerConfigBy)[keyof typeof SortClusterSchedulerConfigBy]; /** * @public */ export interface ListClusterSchedulerConfigsRequest { /** *Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ CreatedAfter?: Date | undefined; /** *Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ CreatedBefore?: Date | undefined; /** *Filter for name containing this string.
* @public */ NameContains?: string | undefined; /** *Filter for ARN of the cluster.
* @public */ ClusterArn?: string | undefined; /** *Filter for status.
* @public */ Status?: SchedulerResourceStatus | undefined; /** *Filter for sorting the list by a given value. For example, sort by name, creation time, or status.
* @public */ SortBy?: SortClusterSchedulerConfigBy | undefined; /** *The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of cluster policies to list.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListClusterSchedulerConfigsResponse { /** *Summaries of the cluster policies.
* @public */ ClusterSchedulerConfigSummaries?: ClusterSchedulerConfigSummary[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListCodeRepositoriesInput { /** *A filter that returns only Git repositories that were created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only Git repositories that were created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only Git repositories that were last modified after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only Git repositories that were last modified before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *The maximum number of Git repositories to return in the response.
* @public */ MaxResults?: number | undefined; /** *A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *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.
The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
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.
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.
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.
The maximum number of model compilation jobs to return in the response.
* @public */ MaxResults?: number | undefined; /** *A filter that returns the model compilation jobs that were created after a specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns the model compilation jobs that were created before a specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns the model compilation jobs that were modified after a specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns the model compilation jobs that were modified before a specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A filter that returns the model compilation jobs whose name contains a specified string.
* @public */ NameContains?: string | undefined; /** *A filter that retrieves model compilation jobs with a specific CompilationJobStatus status.
The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of CompilationJobSummary objects, each describing a model compilation job.
* @public */ CompilationJobSummaries: CompilationJobSummary[] | undefined; /** *If the response is truncated, Amazon SageMaker AI returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.
Filter for after this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ CreatedAfter?: Date | undefined; /** *Filter for before this creation time. The input for this parameter is a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
* @public */ CreatedBefore?: Date | undefined; /** *Filter for name containing this string.
* @public */ NameContains?: string | undefined; /** *Filter for status.
* @public */ Status?: SchedulerResourceStatus | undefined; /** *Filter for ARN of the cluster.
* @public */ ClusterArn?: string | undefined; /** *Filter for sorting the list by a given value. For example, sort by name, creation time, or status.
* @public */ SortBy?: SortQuotaBy | undefined; /** *The order of the list. By default, listed in Descending order according to by SortBy. To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of compute allocation definitions to list.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListComputeQuotasResponse { /** *Summaries of the compute allocation definitions.
* @public */ ComputeQuotaSummaries?: ComputeQuotaSummary[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortContextsBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type SortContextsBy = (typeof SortContextsBy)[keyof typeof SortContextsBy]; /** * @public */ export interface ListContextsRequest { /** *A filter that returns only contexts with the specified source URI.
* @public */ SourceUri?: string | undefined; /** *A filter that returns only contexts of the specified type.
* @public */ ContextType?: string | undefined; /** *A filter that returns only contexts created on or after the specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns only contexts created on or before the specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
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.
The maximum number of contexts to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListContextsResponse { /** *A list of contexts and their properties.
* @public */ ContextSummaries?: ContextSummary[] | undefined; /** *A token for getting the next set of contexts, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const MonitoringJobDefinitionSortKey: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type MonitoringJobDefinitionSortKey = (typeof MonitoringJobDefinitionSortKey)[keyof typeof MonitoringJobDefinitionSortKey]; /** * @public */ export interface ListDataQualityJobDefinitionsRequest { /** *A filter that lists the data quality job definitions associated with the specified endpoint.
* @public */ EndpointName?: string | undefined; /** *The field to sort results by. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
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.>
The maximum number of data quality monitoring job definitions to return in the response.
* @public */ MaxResults?: number | undefined; /** *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.
* @public */ NameContains?: string | undefined; /** *A filter that returns only data quality monitoring job definitions created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only data quality monitoring job definitions created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; } /** *Summary information about a monitoring job.
* @public */ export interface MonitoringJobDefinitionSummary { /** *The name of the monitoring job.
* @public */ MonitoringJobDefinitionName: string | undefined; /** *The Amazon Resource Name (ARN) of the monitoring job.
* @public */ MonitoringJobDefinitionArn: string | undefined; /** *The time that the monitoring job was created.
* @public */ CreationTime: Date | undefined; /** *The name of the endpoint that the job monitors.
* @public */ EndpointName: string | undefined; } /** * @public */ export interface ListDataQualityJobDefinitionsResponse { /** *A list of data quality monitoring job definitions.
* @public */ JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** *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.
The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to select.
* @public */ MaxResults?: number | undefined; /** *Filter fleets where packaging job was created after specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *Filter fleets where the edge packaging job was created before specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *Select fleets where the job was updated after X
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Select fleets where the job was updated before X
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *Filter for fleets containing this name in their fleet device name.
* @public */ NameContains?: string | undefined; /** *The column to sort by.
* @public */ SortBy?: ListDeviceFleetsSortBy | undefined; /** *What direction to sort in.
* @public */ SortOrder?: SortOrder | undefined; } /** * @public */ export interface ListDeviceFleetsResponse { /** *Summary of the device fleet.
* @public */ DeviceFleetSummaries: DeviceFleetSummary[] | undefined; /** *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListDevicesRequest { /** *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; /** *Maximum number of results to select.
* @public */ MaxResults?: number | undefined; /** *Select fleets where the job was updated after X
* @public */ LatestHeartbeatAfter?: Date | undefined; /** *A filter that searches devices that contains this name in any of their models.
* @public */ ModelName?: string | undefined; /** *Filter for fleets containing this name in their device fleet name.
* @public */ DeviceFleetName?: string | undefined; } /** * @public */ export interface ListDevicesResponse { /** *Summary of devices.
* @public */ DeviceSummaries: DeviceSummary[] | undefined; /** *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListDomainsRequest { /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
The list of domains.
* @public */ Domains?: DomainDetails[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ListEdgeDeploymentPlansSortBy: { readonly CreationTime: "CREATION_TIME"; readonly DeviceFleetName: "DEVICE_FLEET_NAME"; readonly LastModifiedTime: "LAST_MODIFIED_TIME"; readonly Name: "NAME"; }; /** * @public */ export type ListEdgeDeploymentPlansSortBy = (typeof ListEdgeDeploymentPlansSortBy)[keyof typeof ListEdgeDeploymentPlansSortBy]; /** * @public */ export interface ListEdgeDeploymentPlansRequest { /** *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to select (50 by default).
* @public */ MaxResults?: number | undefined; /** *Selects edge deployment plans created after this time.
* @public */ CreationTimeAfter?: Date | undefined; /** *Selects edge deployment plans created before this time.
* @public */ CreationTimeBefore?: Date | undefined; /** *Selects edge deployment plans that were last updated after this time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Selects edge deployment plans that were last updated before this time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *Selects edge deployment plans with names containing this name.
* @public */ NameContains?: string | undefined; /** *Selects edge deployment plans with a device fleet name containing this name.
* @public */ DeviceFleetNameContains?: string | undefined; /** *The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.
The direction of the sorting (ascending or descending).
* @public */ SortOrder?: SortOrder | undefined; } /** * @public */ export interface ListEdgeDeploymentPlansResponse { /** *List of summaries of edge deployment plans.
* @public */ EdgeDeploymentPlanSummaries: EdgeDeploymentPlanSummary[] | undefined; /** *The token to use when calling the next page of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ListEdgePackagingJobsSortBy: { readonly CreationTime: "CREATION_TIME"; readonly EdgePackagingJobStatus: "STATUS"; readonly LastModifiedTime: "LAST_MODIFIED_TIME"; readonly ModelName: "MODEL_NAME"; readonly Name: "NAME"; }; /** * @public */ export type ListEdgePackagingJobsSortBy = (typeof ListEdgePackagingJobsSortBy)[keyof typeof ListEdgePackagingJobsSortBy]; /** * @public */ export interface ListEdgePackagingJobsRequest { /** *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; /** *Maximum number of results to select.
* @public */ MaxResults?: number | undefined; /** *Select jobs where the job was created after specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *Select jobs where the job was created before specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *Select jobs where the job was updated after specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Select jobs where the job was updated before specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *Filter for jobs containing this name in their packaging job name.
* @public */ NameContains?: string | undefined; /** *Filter for jobs where the model name contains this string.
* @public */ ModelNameContains?: string | undefined; /** *The job status to filter for.
* @public */ StatusEquals?: EdgePackagingJobStatus | undefined; /** *Use to specify what column to sort by.
* @public */ SortBy?: ListEdgePackagingJobsSortBy | undefined; /** *What direction to sort by.
* @public */ SortOrder?: SortOrder | undefined; } /** * @public */ export interface ListEdgePackagingJobsResponse { /** *Summaries of edge packaging jobs.
* @public */ EdgePackagingJobSummaries: EdgePackagingJobSummary[] | undefined; /** *Token to use when calling the next page of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const OrderKey: { readonly Ascending: "Ascending"; readonly Descending: "Descending"; }; /** * @public */ export type OrderKey = (typeof OrderKey)[keyof typeof OrderKey]; /** * @public */ export interface ListEndpointConfigsInput { /** *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of training jobs to return in the response.
* @public */ MaxResults?: number | undefined; /** *A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only endpoint configurations created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; } /** * @public */ export interface ListEndpointConfigsOutput { /** *An array of endpoint configurations.
* @public */ EndpointConfigs: EndpointConfigSummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListEndpointsInput { /** *Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of endpoints to return in the response. This value defaults to 10.
* @public */ MaxResults?: number | undefined; /** *A string in endpoint names. This filter returns only endpoints whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only endpoints that were created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only endpoints that were modified before the specified timestamp.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A filter that returns only endpoints that were modified after the specified timestamp.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only endpoints with the specified status.
* @public */ StatusEquals?: EndpointStatus | undefined; } /** * @public */ export interface ListEndpointsOutput { /** *An array or endpoint objects.
* @public */ Endpoints: EndpointSummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortExperimentsBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type SortExperimentsBy = (typeof SortExperimentsBy)[keyof typeof SortExperimentsBy]; /** * @public */ export interface ListExperimentsRequest { /** *A filter that returns only experiments created after the specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns only experiments created before the specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
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.
The maximum number of experiments to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListExperimentsResponse { /** *A list of the summaries of your experiments.
* @public */ ExperimentSummaries?: ExperimentSummary[] | undefined; /** *A token for getting the next set of experiments, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListFeatureGroupsRequest { /** *A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.
A FeatureGroup status. Filters by FeatureGroup status.
An OfflineStore status. Filters by OfflineStore status.
Use this parameter to search for FeatureGroupss created after a specific date and time.
Use this parameter to search for FeatureGroupss created before a specific date and time.
The order in which feature groups are listed.
* @public */ SortOrder?: FeatureGroupSortOrder | undefined; /** *The value on which the feature group list is sorted.
* @public */ SortBy?: FeatureGroupSortBy | undefined; /** *The maximum number of results returned by ListFeatureGroups.
A token to resume pagination of ListFeatureGroups results.
A summary of feature groups.
* @public */ FeatureGroupSummaries: FeatureGroupSummary[] | undefined; /** *A token to resume pagination of ListFeatureGroups results.
A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only flow definitions that were created before the specified timestamp.
* @public */ CreationTimeBefore?: Date | undefined; /** *An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
* @public */ NextToken?: string | undefined; /** *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.
An array of objects describing the flow definitions.
* @public */ FlowDefinitionSummaries: FlowDefinitionSummary[] | undefined; /** *A token to resume pagination.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListHubContentsRequest { /** *The name of the hub to list the contents of.
* @public */ HubName: string | undefined; /** *The type of hub content to list.
* @public */ HubContentType: HubContentType | undefined; /** *Only list hub content if the name contains the specified string.
* @public */ NameContains?: string | undefined; /** *The upper bound of the hub content schema verion.
* @public */ MaxSchemaVersion?: string | undefined; /** *Only list hub content that was created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** *Only list hub content that was created after the time specified.
* @public */ CreationTimeAfter?: Date | undefined; /** *Sort hub content versions by either name or creation time.
* @public */ SortBy?: HubContentSortBy | undefined; /** *Sort hubs by ascending or descending order.
* @public */ SortOrder?: SortOrder | undefined; /** *The maximum amount of hub content to list.
* @public */ MaxResults?: number | undefined; /** *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.
The summaries of the listed hub content.
* @public */ HubContentSummaries: HubContentInfo[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListHubContentVersionsRequest { /** *The name of the hub to list the content versions of.
* @public */ HubName: string | undefined; /** *The type of hub content to list versions of.
* @public */ HubContentType: HubContentType | undefined; /** *The name of the hub content.
* @public */ HubContentName: string | undefined; /** *The lower bound of the hub content versions to list.
* @public */ MinVersion?: string | undefined; /** *The upper bound of the hub content schema version.
* @public */ MaxSchemaVersion?: string | undefined; /** *Only list hub content versions that were created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** *Only list hub content versions that were created after the time specified.
* @public */ CreationTimeAfter?: Date | undefined; /** *Sort hub content versions by either name or creation time.
* @public */ SortBy?: HubContentSortBy | undefined; /** *Sort hub content versions by ascending or descending order.
* @public */ SortOrder?: SortOrder | undefined; /** *The maximum number of hub content versions to list.
* @public */ MaxResults?: number | undefined; /** *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.
The summaries of the listed hub content versions.
* @public */ HubContentSummaries: HubContentInfo[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListHubsRequest { /** *Only list hubs with names that contain the specified string.
* @public */ NameContains?: string | undefined; /** *Only list hubs that were created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** *Only list hubs that were created after the time specified.
* @public */ CreationTimeAfter?: Date | undefined; /** *Only list hubs that were last modified before the time specified.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *Only list hubs that were last modified after the time specified.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Sort hubs by either name or creation time.
* @public */ SortBy?: HubSortBy | undefined; /** *Sort hubs by ascending or descending order.
* @public */ SortOrder?: SortOrder | undefined; /** *The maximum number of hubs to list.
* @public */ MaxResults?: number | undefined; /** *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.
The summaries of the listed hubs.
* @public */ HubSummaries: HubInfo[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListHumanTaskUisRequest { /** *A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only human task user interfaces that were created before the specified timestamp.
* @public */ CreationTimeBefore?: Date | undefined; /** *An optional value that specifies whether you want the results sorted in Ascending or Descending order.
A token to resume pagination.
* @public */ NextToken?: string | undefined; /** *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.
An array of objects describing the human task user interfaces.
* @public */ HumanTaskUiSummaries: HumanTaskUiSummary[] | undefined; /** *A token to resume pagination.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListHyperParameterTuningJobsRequest { /** *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.
The maximum number of tuning jobs to return. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *The field to sort results by. The default is Name.
The sort order for results. The default is Ascending.
A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only tuning jobs that were created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only tuning jobs that were created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only tuning jobs that were modified after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only tuning jobs that were modified before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A filter that returns only tuning jobs with the specified status.
* @public */ StatusEquals?: HyperParameterTuningJobStatus | undefined; } /** * @public */ export interface ListHyperParameterTuningJobsResponse { /** *A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.
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.
A filter that returns only images created on or after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only images created on or before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only images modified on or after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only images modified on or before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *The maximum number of images to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *A filter that returns only images whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *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.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of images and their properties.
* @public */ Images?: Image[] | undefined; /** *A token for getting the next set of images, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListImageVersionsRequest { /** *A filter that returns only versions created on or after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only versions created on or before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *The name of the image to list the versions of.
* @public */ ImageName: string | undefined; /** *A filter that returns only versions modified on or after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only versions modified on or before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *The maximum number of versions to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *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.
The property used to sort results. The default value is CREATION_TIME.
The sort order. The default value is DESCENDING.
A list of versions and their properties.
* @public */ ImageVersions?: ImageVersion[] | undefined; /** *A token for getting the next set of versions, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListInferenceComponentsInput { /** *The field by which to sort the inference components in the response. The default is CreationTime.
The sort order for results. The default is Descending.
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.
* @public */ NextToken?: string | undefined; /** *The maximum number of inference components to return in the response. This value defaults to 10.
* @public */ MaxResults?: number | undefined; /** *Filters the results to only those inference components with a name that contains the specified string.
* @public */ NameContains?: string | undefined; /** *Filters the results to only those inference components that were created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *Filters the results to only those inference components that were created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *Filters the results to only those inference components that were updated before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *Filters the results to only those inference components that were updated after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Filters the results to only those inference components with the specified status.
* @public */ StatusEquals?: InferenceComponentStatus | undefined; /** *An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.
* @public */ EndpointNameEquals?: string | undefined; /** *A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.
* @public */ VariantNameEquals?: string | undefined; } /** * @public */ export interface ListInferenceComponentsOutput { /** *A list of inference components and their properties that matches any of the filters you specified in the request.
* @public */ InferenceComponents: InferenceComponentSummary[] | undefined; /** *The token to use in a subsequent request to get the next set of results following a truncated response.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortInferenceExperimentsBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; readonly STATUS: "Status"; }; /** * @public */ export type SortInferenceExperimentsBy = (typeof SortInferenceExperimentsBy)[keyof typeof SortInferenceExperimentsBy]; /** * @public */ export interface ListInferenceExperimentsRequest { /** *Selects inference experiments whose names contain this name.
* @public */ NameContains?: string | undefined; /** *Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperiment.
* @public */ Type?: InferenceExperimentType | undefined; /** *Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperiment.
* @public */ StatusEquals?: InferenceExperimentStatus | undefined; /** *Selects inference experiments which were created after this timestamp.
* @public */ CreationTimeAfter?: Date | undefined; /** *Selects inference experiments which were created before this timestamp.
* @public */ CreationTimeBefore?: Date | undefined; /** *Selects inference experiments which were last modified after this timestamp.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Selects inference experiments which were last modified before this timestamp.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *The column by which to sort the listed inference experiments.
* @public */ SortBy?: SortInferenceExperimentsBy | undefined; /** *The direction of sorting (ascending or descending).
* @public */ SortOrder?: SortOrder | undefined; /** *The response from the last list when returning a list large enough to need tokening.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to select.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListInferenceExperimentsResponse { /** *List of inference experiments.
* @public */ InferenceExperiments?: InferenceExperimentSummary[] | undefined; /** *The token to use when calling the next page of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ListInferenceRecommendationsJobsSortBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; readonly STATUS: "Status"; }; /** * @public */ export type ListInferenceRecommendationsJobsSortBy = (typeof ListInferenceRecommendationsJobsSortBy)[keyof typeof ListInferenceRecommendationsJobsSortBy]; /** * @public */ export interface ListInferenceRecommendationsJobsRequest { /** *A filter that returns only jobs created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only jobs created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only jobs that were last modified after the specified time (timestamp).
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only jobs that were last modified before the specified time (timestamp).
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A string in the job name. This filter returns only recommendations whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that retrieves only inference recommendations jobs with a specific status.
* @public */ StatusEquals?: RecommendationJobStatus | undefined; /** *The parameter by which to sort the results.
* @public */ SortBy?: ListInferenceRecommendationsJobsSortBy | undefined; /** *The sort order for the results.
* @public */ SortOrder?: SortOrder | undefined; /** *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.
The maximum number of recommendations to return in the response.
* @public */ MaxResults?: number | undefined; /** *A filter that returns only jobs that were created for this model.
* @public */ ModelNameEquals?: string | undefined; /** *A filter that returns only jobs that were created for this versioned model package.
* @public */ ModelPackageVersionArnEquals?: string | undefined; } /** * @public */ export interface ListInferenceRecommendationsJobsResponse { /** *The recommendations created from the Amazon SageMaker Inference Recommender job.
* @public */ InferenceRecommendationsJobs: InferenceRecommendationsJob[] | undefined; /** *A token for getting the next set of recommendations, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListInferenceRecommendationsJobStepsRequest { /** *The name for the Inference Recommender job.
* @public */ JobName: string | undefined; /** *A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.
* @public */ Status?: RecommendationJobStatus | undefined; /** *A filter to return details about the specified type of subtask.
BENCHMARK: Evaluate the performance of your model on different instance types.
The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *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.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListInferenceRecommendationsJobStepsResponse { /** *A list of all subtask details in Inference Recommender.
* @public */ Steps?: InferenceRecommendationsJobStep[] | undefined; /** *A token that you can specify in your next request to return more results from the list.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; readonly STATUS: "Status"; }; /** * @public */ export type SortBy = (typeof SortBy)[keyof typeof SortBy]; /** * @public */ export interface ListLabelingJobsRequest { /** *A filter that returns only labeling jobs created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only labeling jobs created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only labeling jobs modified after the specified time (timestamp).
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only labeling jobs modified before the specified time (timestamp).
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *The maximum number of labeling jobs to return in each page of the response.
* @public */ MaxResults?: number | undefined; /** *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.
A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that retrieves only labeling jobs with a specific status.
* @public */ StatusEquals?: LabelingJobStatus | undefined; } /** * @public */ export interface ListLabelingJobsResponse { /** *An array of LabelingJobSummary objects, each describing a labeling job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ListLabelingJobsForWorkteamSortByOptions: { readonly CREATION_TIME: "CreationTime"; }; /** * @public */ export type ListLabelingJobsForWorkteamSortByOptions = (typeof ListLabelingJobsForWorkteamSortByOptions)[keyof typeof ListLabelingJobsForWorkteamSortByOptions]; /** * @public */ export interface ListLabelingJobsForWorkteamRequest { /** *The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
* @public */ WorkteamArn: string | undefined; /** *The maximum number of labeling jobs to return in each page of the response.
* @public */ MaxResults?: number | undefined; /** *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.
A filter that returns only labeling jobs created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only labeling jobs created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter the limits jobs to only the ones whose job reference code contains the specified string.
* @public */ JobReferenceCodeContains?: string | undefined; /** *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
An array of LabelingJobSummary objects, each describing a labeling job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortLineageGroupsBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type SortLineageGroupsBy = (typeof SortLineageGroupsBy)[keyof typeof SortLineageGroupsBy]; /** * @public */ export interface ListLineageGroupsRequest { /** *A timestamp to filter against lineage groups created after a certain point in time.
* @public */ CreatedAfter?: Date | undefined; /** *A timestamp to filter against lineage groups created before a certain point in time.
* @public */ CreatedBefore?: Date | undefined; /** *The parameter by which to sort the results. The default is CreationTime.
The sort order for the results. The default is Ascending.
If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of endpoints to return in the response. This value defaults to 10.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListLineageGroupsResponse { /** *A list of lineage groups and their properties.
* @public */ LineageGroupSummaries?: LineageGroupSummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortTrackingServerBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; readonly STATUS: "Status"; }; /** * @public */ export type SortTrackingServerBy = (typeof SortTrackingServerBy)[keyof typeof SortTrackingServerBy]; /** * @public */ export interface ListMlflowTrackingServersRequest { /** *Use the CreatedAfter filter to only list tracking servers created after a specific date and time. Listed tracking servers are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedAfter parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Use the CreatedBefore filter to only list tracking servers created before a specific date and time. Listed tracking servers are shown with a date and time such as "2024-03-16T01:46:56+00:00". The CreatedBefore parameter takes in a Unix timestamp. To convert a date and time into a Unix timestamp, see EpochConverter.
Filter for tracking servers with a specified creation status.
* @public */ TrackingServerStatus?: TrackingServerStatus | undefined; /** *Filter for tracking servers using the specified MLflow version.
* @public */ MlflowVersion?: string | undefined; /** *Filter for trackings servers sorting by name, creation time, or creation status.
* @public */ SortBy?: SortTrackingServerBy | undefined; /** *Change the order of the listed tracking servers. By default, tracking servers are listed in Descending order by creation time. To change the list order, you can specify SortOrder to be Ascending.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of tracking servers to list.
* @public */ MaxResults?: number | undefined; } /** *The summary of the tracking server to list.
* @public */ export interface TrackingServerSummary { /** *The ARN of a listed tracking server.
* @public */ TrackingServerArn?: string | undefined; /** *The name of a listed tracking server.
* @public */ TrackingServerName?: string | undefined; /** *The creation time of a listed tracking server.
* @public */ CreationTime?: Date | undefined; /** *The last modified time of a listed tracking server.
* @public */ LastModifiedTime?: Date | undefined; /** *The creation status of a listed tracking server.
* @public */ TrackingServerStatus?: TrackingServerStatus | undefined; /** *The activity status of a listed tracking server.
* @public */ IsActive?: IsTrackingServerActive | undefined; /** *The MLflow version used for a listed tracking server.
* @public */ MlflowVersion?: string | undefined; } /** * @public */ export interface ListMlflowTrackingServersResponse { /** *A list of tracking servers according to chosen filters.
* @public */ TrackingServerSummaries?: TrackingServerSummary[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListModelBiasJobDefinitionsRequest { /** *Name of the endpoint to monitor for model bias.
* @public */ EndpointName?: string | undefined; /** *Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; /** *The maximum number of model bias jobs to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *Filter for model bias jobs whose name contains a specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only model bias jobs created before a specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only model bias jobs created after a specified time.
* @public */ CreationTimeAfter?: Date | undefined; } /** * @public */ export interface ListModelBiasJobDefinitionsResponse { /** *A JSON array in which each element is a summary for a model bias jobs.
* @public */ JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** *The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ModelCardExportJobSortBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; readonly STATUS: "Status"; }; /** * @public */ export type ModelCardExportJobSortBy = (typeof ModelCardExportJobSortBy)[keyof typeof ModelCardExportJobSortBy]; /** * @public * @enum */ export declare const ModelCardExportJobSortOrder: { readonly ASCENDING: "Ascending"; readonly DESCENDING: "Descending"; }; /** * @public */ export type ModelCardExportJobSortOrder = (typeof ModelCardExportJobSortOrder)[keyof typeof ModelCardExportJobSortOrder]; /** * @public */ export interface ListModelCardExportJobsRequest { /** *List export jobs for the model card with the specified name.
* @public */ ModelCardName: string | undefined; /** *List export jobs for the model card with the specified version.
* @public */ ModelCardVersion?: number | undefined; /** *Only list model card export jobs that were created after the time specified.
* @public */ CreationTimeAfter?: Date | undefined; /** *Only list model card export jobs that were created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** *Only list model card export jobs with names that contain the specified string.
* @public */ ModelCardExportJobNameContains?: string | undefined; /** *Only list model card export jobs with the specified status.
* @public */ StatusEquals?: ModelCardExportJobStatus | undefined; /** *Sort model card export jobs by either name or creation time. Sorts by creation time by default.
* @public */ SortBy?: ModelCardExportJobSortBy | undefined; /** *Sort model card export jobs by ascending or descending order.
* @public */ SortOrder?: ModelCardExportJobSortOrder | undefined; /** *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.
The maximum number of model card export jobs to list.
* @public */ MaxResults?: number | undefined; } /** *The summary of the Amazon SageMaker Model Card export job.
* @public */ export interface ModelCardExportJobSummary { /** *The name of the model card export job.
* @public */ ModelCardExportJobName: string | undefined; /** *The Amazon Resource Name (ARN) of the model card export job.
* @public */ ModelCardExportJobArn: string | undefined; /** *The completion status of the model card export job.
* @public */ Status: ModelCardExportJobStatus | undefined; /** *The name of the model card that the export job exports.
* @public */ ModelCardName: string | undefined; /** *The version of the model card that the export job exports.
* @public */ ModelCardVersion: number | undefined; /** *The date and time that the model card export job was created.
* @public */ CreatedAt: Date | undefined; /** *The date and time that the model card export job was last modified..
* @public */ LastModifiedAt: Date | undefined; } /** * @public */ export interface ListModelCardExportJobsResponse { /** *The summaries of the listed model card export jobs.
* @public */ ModelCardExportJobSummaries: ModelCardExportJobSummary[] | undefined; /** *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.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ModelCardSortBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type ModelCardSortBy = (typeof ModelCardSortBy)[keyof typeof ModelCardSortBy]; /** * @public * @enum */ export declare const ModelCardSortOrder: { readonly ASCENDING: "Ascending"; readonly DESCENDING: "Descending"; }; /** * @public */ export type ModelCardSortOrder = (typeof ModelCardSortOrder)[keyof typeof ModelCardSortOrder]; /** * @public */ export interface ListModelCardsRequest { /** *Only list model cards that were created after the time specified.
* @public */ CreationTimeAfter?: Date | undefined; /** *Only list model cards that were created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** *The maximum number of model cards to list.
* @public */ MaxResults?: number | undefined; /** *Only list model cards with names that contain the specified string.
* @public */ NameContains?: string | undefined; /** *Only list model cards with the specified approval status.
* @public */ ModelCardStatus?: ModelCardStatus | undefined; /** *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.
Sort model cards by either name or creation time. Sorts by creation time by default.
* @public */ SortBy?: ModelCardSortBy | undefined; /** *Sort model cards by ascending or descending order.
* @public */ SortOrder?: ModelCardSortOrder | undefined; } /** *A summary of the model card.
* @public */ export interface ModelCardSummary { /** *The name of the model card.
* @public */ ModelCardName: string | undefined; /** *The Amazon Resource Name (ARN) of the model card.
* @public */ ModelCardArn: string | undefined; /** *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.
The date and time that the model card was created.
* @public */ CreationTime: Date | undefined; /** *The date and time that the model card was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface ListModelCardsResponse { /** *The summaries of the listed model cards.
* @public */ ModelCardSummaries: ModelCardSummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ModelCardVersionSortBy: { readonly VERSION: "Version"; }; /** * @public */ export type ModelCardVersionSortBy = (typeof ModelCardVersionSortBy)[keyof typeof ModelCardVersionSortBy]; /** * @public */ export interface ListModelCardVersionsRequest { /** *Only list model card versions that were created after the time specified.
* @public */ CreationTimeAfter?: Date | undefined; /** *Only list model card versions that were created before the time specified.
* @public */ CreationTimeBefore?: Date | undefined; /** *The maximum number of model card versions to list.
* @public */ MaxResults?: number | undefined; /** *List model card versions for the model card with the specified name or Amazon Resource Name (ARN).
* @public */ ModelCardName: string | undefined; /** *Only list model card versions with the specified approval status.
* @public */ ModelCardStatus?: ModelCardStatus | undefined; /** *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.
Sort listed model card versions by version. Sorts by version by default.
* @public */ SortBy?: ModelCardVersionSortBy | undefined; /** *Sort model card versions by ascending or descending order.
* @public */ SortOrder?: ModelCardSortOrder | undefined; } /** *A summary of a specific version of the model card.
* @public */ export interface ModelCardVersionSummary { /** *The name of the model card.
* @public */ ModelCardName: string | undefined; /** *The Amazon Resource Name (ARN) of the model card.
* @public */ ModelCardArn: string | undefined; /** *The approval status of the model card version 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.
A version of the model card.
* @public */ ModelCardVersion: number | undefined; /** *The date and time that the model card version was created.
* @public */ CreationTime: Date | undefined; /** *The time date and time that the model card version was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface ListModelCardVersionsResponse { /** *The summaries of the listed versions of the model card.
* @public */ ModelCardVersionSummaryList: ModelCardVersionSummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListModelExplainabilityJobDefinitionsRequest { /** *Name of the endpoint to monitor for model explainability.
* @public */ EndpointName?: string | undefined; /** *Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; /** *The maximum number of jobs to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *Filter for model explainability jobs whose name contains a specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only model explainability jobs created before a specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only model explainability jobs created after a specified time.
* @public */ CreationTimeAfter?: Date | undefined; } /** * @public */ export interface ListModelExplainabilityJobDefinitionsResponse { /** *A JSON array in which each element is a summary for a explainability bias jobs.
* @public */ JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** *The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ModelMetadataFilterType: { readonly DOMAIN: "Domain"; readonly FRAMEWORK: "Framework"; readonly FRAMEWORKVERSION: "FrameworkVersion"; readonly TASK: "Task"; }; /** * @public */ export type ModelMetadataFilterType = (typeof ModelMetadataFilterType)[keyof typeof ModelMetadataFilterType]; /** *Part of the search expression. You can specify the name and value (domain, task, framework, framework version, task, and model).
* @public */ export interface ModelMetadataFilter { /** *The name of the of the model to filter by.
* @public */ Name: ModelMetadataFilterType | undefined; /** *The value to filter the model metadata.
* @public */ Value: string | undefined; } /** *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
* @public */ export interface ModelMetadataSearchExpression { /** *A list of filter objects.
* @public */ Filters?: ModelMetadataFilter[] | undefined; } /** * @public */ export interface ListModelMetadataRequest { /** *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.
* @public */ SearchExpression?: ModelMetadataSearchExpression | undefined; /** *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.
The maximum number of models to return in the response.
* @public */ MaxResults?: number | undefined; } /** *A summary of the model metadata.
* @public */ export interface ModelMetadataSummary { /** *The machine learning domain of the model.
* @public */ Domain: string | undefined; /** *The machine learning framework of the model.
* @public */ Framework: string | undefined; /** *The machine learning task of the model.
* @public */ Task: string | undefined; /** *The name of the model.
* @public */ Model: string | undefined; /** *The framework version of the model.
* @public */ FrameworkVersion: string | undefined; } /** * @public */ export interface ListModelMetadataResponse { /** *A structure that holds model metadata.
* @public */ ModelMetadataSummaries: ModelMetadataSummary[] | undefined; /** *A token for getting the next set of recommendations, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ModelPackageGroupSortBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type ModelPackageGroupSortBy = (typeof ModelPackageGroupSortBy)[keyof typeof ModelPackageGroupSortBy]; /** * @public */ export interface ListModelPackageGroupsInput { /** *A filter that returns only model groups created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only model groups created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *The maximum number of results to return in the response.
* @public */ MaxResults?: number | undefined; /** *A string in the model group name. This filter returns only model groups whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *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.
The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.
Summary information about a model group.
* @public */ export interface ModelPackageGroupSummary { /** *The name of the model group.
* @public */ ModelPackageGroupName: string | undefined; /** *The Amazon Resource Name (ARN) of the model group.
* @public */ ModelPackageGroupArn: string | undefined; /** *A description of the model group.
* @public */ ModelPackageGroupDescription?: string | undefined; /** *The time that the model group was created.
* @public */ CreationTime: Date | undefined; /** *The status of the model group.
* @public */ ModelPackageGroupStatus: ModelPackageGroupStatus | undefined; } /** * @public */ export interface ListModelPackageGroupsOutput { /** *A list of summaries of the model groups in your Amazon Web Services account.
* @public */ ModelPackageGroupSummaryList: ModelPackageGroupSummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ModelPackageType: { readonly BOTH: "Both"; readonly UNVERSIONED: "Unversioned"; readonly VERSIONED: "Versioned"; }; /** * @public */ export type ModelPackageType = (typeof ModelPackageType)[keyof typeof ModelPackageType]; /** * @public * @enum */ export declare const ModelPackageSortBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type ModelPackageSortBy = (typeof ModelPackageSortBy)[keyof typeof ModelPackageSortBy]; /** * @public */ export interface ListModelPackagesInput { /** *A filter that returns only model packages created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only model packages created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *The maximum number of model packages to return in the response.
* @public */ MaxResults?: number | undefined; /** *A string in the model package name. This filter returns only model packages whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only the model packages with the specified approval status.
* @public */ ModelApprovalStatus?: ModelApprovalStatus | undefined; /** *A filter that returns only model versions that belong to the specified model group.
* @public */ ModelPackageGroupName?: string | undefined; /** *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.
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.
The parameter by which to sort the results. The default is CreationTime.
The sort order for the results. The default is Ascending.
Provides summary information about a model package.
* @public */ export interface ModelPackageSummary { /** *The name of the model package.
* @public */ ModelPackageName?: string | undefined; /** *If the model package is a versioned model, the model group that the versioned model belongs to.
* @public */ ModelPackageGroupName?: string | undefined; /** *If the model package is a versioned model, the version of the model.
* @public */ ModelPackageVersion?: number | undefined; /** *The Amazon Resource Name (ARN) of the model package.
* @public */ ModelPackageArn: string | undefined; /** *A brief description of the model package.
* @public */ ModelPackageDescription?: string | undefined; /** *A timestamp that shows when the model package was created.
* @public */ CreationTime: Date | undefined; /** *The overall status of the model package.
* @public */ ModelPackageStatus: ModelPackageStatus | undefined; /** *The approval status of the model. This can be one of the following values.
APPROVED - The model is approved
REJECTED - The model is rejected.
PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
A structure describing the current state of the model in its life cycle.
* @public */ ModelLifeCycle?: ModelLifeCycle | undefined; } /** * @public */ export interface ListModelPackagesOutput { /** *An array of ModelPackageSummary objects, each of which lists a model package.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListModelQualityJobDefinitionsRequest { /** *A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
* @public */ EndpointName?: string | undefined; /** *The field to sort results by. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
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.
The maximum number of results to return in a call to ListModelQualityJobDefinitions.
A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only model quality monitoring job definitions created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only model quality monitoring job definitions created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; } /** * @public */ export interface ListModelQualityJobDefinitionsResponse { /** *A list of summaries of model quality monitoring job definitions.
* @public */ JobDefinitionSummaries: MonitoringJobDefinitionSummary[] | undefined; /** *If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ModelSortKey: { readonly CreationTime: "CreationTime"; readonly Name: "Name"; }; /** * @public */ export type ModelSortKey = (typeof ModelSortKey)[keyof typeof ModelSortKey]; /** * @public */ export interface ListModelsInput { /** *Sorts the list of results. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of models to return in the response.
* @public */ MaxResults?: number | undefined; /** *A string in the model name. This filter returns only models whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only models created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; } /** *Provides summary information about a model.
* @public */ export interface ModelSummary { /** *The name of the model that you want a summary for.
* @public */ ModelName: string | undefined; /** *The Amazon Resource Name (ARN) of the model.
* @public */ ModelArn: string | undefined; /** *A timestamp that indicates when the model was created.
* @public */ CreationTime: Date | undefined; } /** * @public */ export interface ListModelsOutput { /** *An array of ModelSummary objects, each of which lists a model.
If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const MonitoringAlertHistorySortKey: { readonly CreationTime: "CreationTime"; readonly Status: "Status"; }; /** * @public */ export type MonitoringAlertHistorySortKey = (typeof MonitoringAlertHistorySortKey)[keyof typeof MonitoringAlertHistorySortKey]; /** * @public * @enum */ export declare const MonitoringAlertStatus: { readonly IN_ALERT: "InAlert"; readonly OK: "OK"; }; /** * @public */ export type MonitoringAlertStatus = (typeof MonitoringAlertStatus)[keyof typeof MonitoringAlertStatus]; /** * @public */ export interface ListMonitoringAlertHistoryRequest { /** *The name of a monitoring schedule.
* @public */ MonitoringScheduleName?: string | undefined; /** *The name of a monitoring alert.
* @public */ MonitoringAlertName?: string | undefined; /** *The field used to sort results. The default is CreationTime.
The sort order, whether Ascending or Descending, of the alert history. The default is Descending.
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.
The maximum number of results to display. The default is 100.
* @public */ MaxResults?: number | undefined; /** *A filter that returns only alerts created on or before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only alerts created on or after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that retrieves only alerts with a specific status.
* @public */ StatusEquals?: MonitoringAlertStatus | undefined; } /** *Provides summary information of an alert's history.
* @public */ export interface MonitoringAlertHistorySummary { /** *The name of a monitoring schedule.
* @public */ MonitoringScheduleName: string | undefined; /** *The name of a monitoring alert.
* @public */ MonitoringAlertName: string | undefined; /** *A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.
The current alert status of an alert.
* @public */ AlertStatus: MonitoringAlertStatus | undefined; } /** * @public */ export interface ListMonitoringAlertHistoryResponse { /** *An alert history for a model monitoring schedule.
* @public */ MonitoringAlertHistory?: MonitoringAlertHistorySummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListMonitoringAlertsRequest { /** *The name of a monitoring schedule.
* @public */ MonitoringScheduleName: string | undefined; /** *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.
The maximum number of results to display. The default is 100.
* @public */ MaxResults?: number | undefined; } /** *An alert action taken to light up an icon on the Amazon SageMaker Model Dashboard when an alert goes into InAlert status.
Indicates whether the alert action is turned on.
* @public */ Enabled?: boolean | undefined; } /** *A list of alert actions taken in response to an alert going into InAlert status.
An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.
Provides summary information about a monitor alert.
* @public */ export interface MonitoringAlertSummary { /** *The name of a monitoring alert.
* @public */ MonitoringAlertName: string | undefined; /** *A timestamp that indicates when a monitor alert was created.
* @public */ CreationTime: Date | undefined; /** *A timestamp that indicates when a monitor alert was last updated.
* @public */ LastModifiedTime: Date | undefined; /** *The current status of an alert.
* @public */ AlertStatus: MonitoringAlertStatus | undefined; /** *Within EvaluationPeriod, how many execution failures will raise an alert.
The number of most recent monitoring executions to consider when evaluating alert status.
* @public */ EvaluationPeriod: number | undefined; /** *A list of alert actions taken in response to an alert going into InAlert status.
A JSON array where each element is a summary for a monitoring alert.
* @public */ MonitoringAlertSummaries?: MonitoringAlertSummary[] | undefined; /** *If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const MonitoringExecutionSortKey: { readonly CREATION_TIME: "CreationTime"; readonly SCHEDULED_TIME: "ScheduledTime"; readonly STATUS: "Status"; }; /** * @public */ export type MonitoringExecutionSortKey = (typeof MonitoringExecutionSortKey)[keyof typeof MonitoringExecutionSortKey]; /** * @public */ export interface ListMonitoringExecutionsRequest { /** *Name of a specific schedule to fetch jobs for.
* @public */ MonitoringScheduleName?: string | undefined; /** *Name of a specific endpoint to fetch jobs for.
* @public */ EndpointName?: string | undefined; /** *Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; /** *The maximum number of jobs to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *Filter for jobs scheduled before a specified time.
* @public */ ScheduledTimeBefore?: Date | undefined; /** *Filter for jobs scheduled after a specified time.
* @public */ ScheduledTimeAfter?: Date | undefined; /** *A filter that returns only jobs created before a specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only jobs created after a specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only jobs modified after a specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A filter that returns only jobs modified before a specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that retrieves only jobs with a specific status.
* @public */ StatusEquals?: ExecutionStatus | undefined; /** *Gets a list of the monitoring job runs of the specified monitoring job definitions.
* @public */ MonitoringJobDefinitionName?: string | undefined; /** *A filter that returns only the monitoring job runs of the specified monitoring type.
* @public */ MonitoringTypeEquals?: MonitoringType | undefined; } /** * @public */ export interface ListMonitoringExecutionsResponse { /** *A JSON array in which each element is a summary for a monitoring execution.
* @public */ MonitoringExecutionSummaries: MonitoringExecutionSummary[] | undefined; /** *The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const MonitoringScheduleSortKey: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; readonly STATUS: "Status"; }; /** * @public */ export type MonitoringScheduleSortKey = (typeof MonitoringScheduleSortKey)[keyof typeof MonitoringScheduleSortKey]; /** * @public */ export interface ListMonitoringSchedulesRequest { /** *Name of a specific endpoint to fetch schedules for.
* @public */ EndpointName?: string | undefined; /** *Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; /** *The maximum number of jobs to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *Filter for monitoring schedules whose name contains a specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only monitoring schedules created before a specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only monitoring schedules created after a specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only monitoring schedules modified before a specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A filter that returns only monitoring schedules modified after a specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only monitoring schedules modified before a specified time.
* @public */ StatusEquals?: ScheduleStatus | undefined; /** *Gets a list of the monitoring schedules for the specified monitoring job definition.
* @public */ MonitoringJobDefinitionName?: string | undefined; /** *A filter that returns only the monitoring schedules for the specified monitoring type.
* @public */ MonitoringTypeEquals?: MonitoringType | undefined; } /** *Summarizes the monitoring schedule.
* @public */ export interface MonitoringScheduleSummary { /** *The name of the monitoring schedule.
* @public */ MonitoringScheduleName: string | undefined; /** *The Amazon Resource Name (ARN) of the monitoring schedule.
* @public */ MonitoringScheduleArn: string | undefined; /** *The creation time of the monitoring schedule.
* @public */ CreationTime: Date | undefined; /** *The last time the monitoring schedule was modified.
* @public */ LastModifiedTime: Date | undefined; /** *The status of the monitoring schedule.
* @public */ MonitoringScheduleStatus: ScheduleStatus | undefined; /** *The name of the endpoint using the monitoring schedule.
* @public */ EndpointName?: string | undefined; /** *The name of the monitoring job definition that the schedule is for.
* @public */ MonitoringJobDefinitionName?: string | undefined; /** *The type of the monitoring job definition that the schedule is for.
* @public */ MonitoringType?: MonitoringType | undefined; } /** * @public */ export interface ListMonitoringSchedulesResponse { /** *A JSON array in which each element is a summary for a monitoring schedule.
* @public */ MonitoringScheduleSummaries: MonitoringScheduleSummary[] | undefined; /** *The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const NotebookInstanceLifecycleConfigSortKey: { readonly CREATION_TIME: "CreationTime"; readonly LAST_MODIFIED_TIME: "LastModifiedTime"; readonly NAME: "Name"; }; /** * @public */ export type NotebookInstanceLifecycleConfigSortKey = (typeof NotebookInstanceLifecycleConfigSortKey)[keyof typeof NotebookInstanceLifecycleConfigSortKey]; /** * @public * @enum */ export declare const NotebookInstanceLifecycleConfigSortOrder: { readonly ASCENDING: "Ascending"; readonly DESCENDING: "Descending"; }; /** * @public */ export type NotebookInstanceLifecycleConfigSortOrder = (typeof NotebookInstanceLifecycleConfigSortOrder)[keyof typeof NotebookInstanceLifecycleConfigSortOrder]; /** * @public */ export interface ListNotebookInstanceLifecycleConfigsInput { /** *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.
The maximum number of lifecycle configurations to return in the response.
* @public */ MaxResults?: number | undefined; /** *Sorts the list of results. The default is CreationTime.
The sort order for results.
* @public */ SortOrder?: NotebookInstanceLifecycleConfigSortOrder | undefined; /** *A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only lifecycle configurations that were created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only lifecycle configurations that were created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).
* @public */ LastModifiedTimeAfter?: Date | undefined; } /** *Provides a summary of a notebook instance lifecycle configuration.
* @public */ export interface NotebookInstanceLifecycleConfigSummary { /** *The name of the lifecycle configuration.
* @public */ NotebookInstanceLifecycleConfigName: string | undefined; /** *The Amazon Resource Name (ARN) of the lifecycle configuration.
* @public */ NotebookInstanceLifecycleConfigArn: string | undefined; /** *A timestamp that tells when the lifecycle configuration was created.
* @public */ CreationTime?: Date | undefined; /** *A timestamp that tells when the lifecycle configuration was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface ListNotebookInstanceLifecycleConfigsOutput { /** *If the response is truncated, SageMaker AI returns this token. To get the next set of lifecycle configurations, use it in the next request.
* @public */ NextToken?: string | undefined; /** *An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.
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.
The maximum number of notebook instances to return.
* @public */ MaxResults?: number | undefined; /** *The field to sort results by. The default is Name.
The sort order for results.
* @public */ SortOrder?: NotebookInstanceSortOrder | undefined; /** *A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that returns only notebook instances that were created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only notebook instances that were created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only notebook instances that were modified before the specified time (timestamp).
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A filter that returns only notebook instances that were modified after the specified time (timestamp).
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only notebook instances with the specified status.
* @public */ StatusEquals?: NotebookInstanceStatus | undefined; /** *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.
* @public */ NotebookInstanceLifecycleConfigNameContains?: string | undefined; /** *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.
* @public */ DefaultCodeRepositoryContains?: string | undefined; /** *A filter that returns only notebook instances with associated with the specified git repository.
* @public */ AdditionalCodeRepositoryEquals?: string | undefined; } /** *Provides summary information for an SageMaker AI notebook instance.
* @public */ export interface NotebookInstanceSummary { /** *The name of the notebook instance that you want a summary for.
* @public */ NotebookInstanceName: string | undefined; /** *The Amazon Resource Name (ARN) of the notebook instance.
* @public */ NotebookInstanceArn: string | undefined; /** *The status of the notebook instance.
* @public */ NotebookInstanceStatus?: NotebookInstanceStatus | undefined; /** *The URL that you use to connect to the Jupyter notebook running in your notebook instance.
* @public */ Url?: string | undefined; /** *The type of ML compute instance that the notebook instance is running on.
* @public */ InstanceType?: _InstanceType | undefined; /** *A timestamp that shows when the notebook instance was created.
* @public */ CreationTime?: Date | undefined; /** *A timestamp that shows when the notebook instance was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The name of a notebook instance lifecycle configuration associated with this notebook instance.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
* @public */ NotebookInstanceLifecycleConfigName?: string | undefined; /** *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 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 AI Notebook Instances.
* @public */ DefaultCodeRepository?: string | undefined; /** *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 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 AI Notebook Instances.
* @public */ AdditionalCodeRepositories?: string[] | undefined; } /** * @public */ export interface ListNotebookInstancesOutput { /** *If the response to the previous ListNotebookInstances request was truncated, SageMaker AI returns this token. To retrieve the next set of notebook instances, use the token in the next request.
An array of NotebookInstanceSummary objects, one for each notebook instance.
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.
* @public */ NextToken?: string | undefined; /** *The maximum number of optimization jobs to return in the response. The default is 50.
* @public */ MaxResults?: number | undefined; /** *Filters the results to only those optimization jobs that were created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *Filters the results to only those optimization jobs that were created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *Filters the results to only those optimization jobs that were updated after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *Filters the results to only those optimization jobs that were updated before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either Quantization or Compilation.
Filters the results to only those optimization jobs with a name that contains the specified string.
* @public */ NameContains?: string | undefined; /** *Filters the results to only those optimization jobs with the specified status.
* @public */ StatusEquals?: OptimizationJobStatus | undefined; /** *The field by which to sort the optimization jobs in the response. The default is CreationTime
The sort order for results. The default is Ascending
Summarizes an optimization job by providing some of its key properties.
* @public */ export interface OptimizationJobSummary { /** *The name that you assigned to the optimization job.
* @public */ OptimizationJobName: string | undefined; /** *The Amazon Resource Name (ARN) of the optimization job.
* @public */ OptimizationJobArn: string | undefined; /** *The time when you created the optimization job.
* @public */ CreationTime: Date | undefined; /** *The current status of the optimization job.
* @public */ OptimizationJobStatus: OptimizationJobStatus | undefined; /** *The time when the optimization job started.
* @public */ OptimizationStartTime?: Date | undefined; /** *The time when the optimization job finished processing.
* @public */ OptimizationEndTime?: Date | undefined; /** *The time when the optimization job was last updated.
* @public */ LastModifiedTime?: Date | undefined; /** *The type of instance that hosts the optimized model that you create with the optimization job.
* @public */ DeploymentInstanceType: OptimizationJobDeploymentInstanceType | undefined; /** *The optimization techniques that are applied by the optimization job.
* @public */ OptimizationTypes: string[] | undefined; } /** * @public */ export interface ListOptimizationJobsResponse { /** *A list of optimization jobs and their properties that matches any of the filters you specified in the request.
* @public */ OptimizationJobSummaries: OptimizationJobSummary[] | undefined; /** *The token to use in a subsequent request to get the next set of results following a truncated response.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListPartnerAppsRequest { /** *This parameter defines the maximum number of results that can be returned in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** *A subset of information related to a SageMaker Partner AI App. This information is used as part of the ListPartnerApps API response.
The ARN of the SageMaker Partner AI App.
* @public */ Arn?: string | undefined; /** *The name of the SageMaker Partner AI App.
* @public */ Name?: string | undefined; /** *The type of SageMaker Partner AI App to create. Must be one of the following: lakera-guard, comet, deepchecks-llm-evaluation, or fiddler.
The status of the SageMaker Partner AI App.
* @public */ Status?: PartnerAppStatus | undefined; /** *The creation time of the SageMaker Partner AI App.
* @public */ CreationTime?: Date | undefined; } /** * @public */ export interface ListPartnerAppsResponse { /** *The information related to each of the SageMaker Partner AI Apps in an account.
* @public */ Summaries?: PartnerAppSummary[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortPipelineExecutionsBy: { readonly CREATION_TIME: "CreationTime"; readonly PIPELINE_EXECUTION_ARN: "PipelineExecutionArn"; }; /** * @public */ export type SortPipelineExecutionsBy = (typeof SortPipelineExecutionsBy)[keyof typeof SortPipelineExecutionsBy]; /** * @public */ export interface ListPipelineExecutionsRequest { /** *The name or Amazon Resource Name (ARN) of the pipeline.
* @public */ PipelineName: string | undefined; /** *A filter that returns the pipeline executions that were created after a specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns the pipeline executions that were created before a specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The field by which to sort results. The default is CreatedTime.
The sort order for results.
* @public */ SortOrder?: SortOrder | undefined; /** *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.
The maximum number of pipeline executions to return in the response.
* @public */ MaxResults?: number | undefined; } /** *A pipeline execution summary.
* @public */ export interface PipelineExecutionSummary { /** *The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ PipelineExecutionArn?: string | undefined; /** *The start time of the pipeline execution.
* @public */ StartTime?: Date | undefined; /** *The status of the pipeline execution.
* @public */ PipelineExecutionStatus?: PipelineExecutionStatus | undefined; /** *The description of the pipeline execution.
* @public */ PipelineExecutionDescription?: string | undefined; /** *The display name of the pipeline execution.
* @public */ PipelineExecutionDisplayName?: string | undefined; /** *A message generated by SageMaker Pipelines describing why the pipeline execution failed.
* @public */ PipelineExecutionFailureReason?: string | undefined; } /** * @public */ export interface ListPipelineExecutionsResponse { /** *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.
* @public */ PipelineExecutionSummaries?: PipelineExecutionSummary[] | undefined; /** *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.
The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ PipelineExecutionArn?: string | undefined; /** *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.
The maximum number of pipeline execution steps to return in the response.
* @public */ MaxResults?: number | undefined; /** *The field by which to sort results. The default is CreatedTime.
Metadata for Model steps.
* @public */ export interface ModelStepMetadata { /** *The Amazon Resource Name (ARN) of the created model.
* @public */ Arn?: string | undefined; } /** *Metadata for a processing job step.
* @public */ export interface ProcessingJobStepMetadata { /** *The Amazon Resource Name (ARN) of the processing job.
* @public */ Arn?: string | undefined; } /** *Container for the metadata for a Quality check step. For more information, see the topic on QualityCheck step in the Amazon SageMaker Developer Guide.
* @public */ export interface QualityCheckStepMetadata { /** *The type of the Quality check step.
* @public */ CheckType?: string | undefined; /** *The Amazon S3 URI of the baseline statistics file used for the drift check.
* @public */ BaselineUsedForDriftCheckStatistics?: string | undefined; /** *The Amazon S3 URI of the baseline constraints file used for the drift check.
* @public */ BaselineUsedForDriftCheckConstraints?: string | undefined; /** *The Amazon S3 URI of the newly calculated baseline statistics file.
* @public */ CalculatedBaselineStatistics?: string | undefined; /** *The Amazon S3 URI of the newly calculated baseline constraints file.
* @public */ CalculatedBaselineConstraints?: string | undefined; /** *The model package group name.
* @public */ ModelPackageGroupName?: string | undefined; /** *The Amazon S3 URI of violation report if violations are detected.
* @public */ ViolationReport?: string | undefined; /** *The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.
* @public */ CheckJobArn?: string | undefined; /** *This flag indicates if the drift check against the previous baseline will be skipped or not. If it is set to False, the previous baseline of the configured check type must be available.
This flag indicates if a newly calculated baseline can be accessed through step properties BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics. If it is set to False, the previous baseline of the configured check type must also be available. These can be accessed through the BaselineUsedForDriftCheckConstraints and BaselineUsedForDriftCheckStatistics properties.
Metadata for a register model job step.
* @public */ export interface RegisterModelStepMetadata { /** *The Amazon Resource Name (ARN) of the model package.
* @public */ Arn?: string | undefined; } /** *Metadata for a training job step.
* @public */ export interface TrainingJobStepMetadata { /** *The Amazon Resource Name (ARN) of the training job that was run by this step execution.
* @public */ Arn?: string | undefined; } /** *Metadata for a transform job step.
* @public */ export interface TransformJobStepMetadata { /** *The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
* @public */ Arn?: string | undefined; } /** *Metadata for a tuning step.
* @public */ export interface TuningJobStepMetaData { /** *The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
* @public */ Arn?: string | undefined; } /** *Metadata for a step execution.
* @public */ export interface PipelineExecutionStepMetadata { /** *The Amazon Resource Name (ARN) of the training job that was run by this step execution.
* @public */ TrainingJob?: TrainingJobStepMetadata | undefined; /** *The Amazon Resource Name (ARN) of the processing job that was run by this step execution.
* @public */ ProcessingJob?: ProcessingJobStepMetadata | undefined; /** *The Amazon Resource Name (ARN) of the transform job that was run by this step execution.
* @public */ TransformJob?: TransformJobStepMetadata | undefined; /** *The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.
* @public */ TuningJob?: TuningJobStepMetaData | undefined; /** *The Amazon Resource Name (ARN) of the model that was created by this step execution.
* @public */ Model?: ModelStepMetadata | undefined; /** *The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.
* @public */ RegisterModel?: RegisterModelStepMetadata | undefined; /** *The outcome of the condition evaluation that was run by this step execution.
* @public */ Condition?: ConditionStepMetadata | undefined; /** *The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.
* @public */ Callback?: CallbackStepMetadata | undefined; /** *The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.
* @public */ Lambda?: LambdaStepMetadata | undefined; /** *The configurations and outcomes of an Amazon EMR step execution.
* @public */ EMR?: EMRStepMetadata | undefined; /** *The configurations and outcomes of the check step execution. This includes:
The type of the check conducted.
The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
The Amazon S3 URIs of newly calculated baseline constraints and statistics.
The model package group name provided.
The Amazon S3 URI of the violation report if violations detected.
The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
The Boolean flags indicating if the drift check is skipped.
If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
Container for the metadata for a Clarify check step. The configurations and outcomes of the check step execution. This includes:
The type of the check conducted,
The Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
The Amazon S3 URIs of newly calculated baseline constraints and statistics.
The model package group name provided.
The Amazon S3 URI of the violation report if violations detected.
The Amazon Resource Name (ARN) of check processing job initiated by the step execution.
The boolean flags indicating if the drift check is skipped.
If step property BaselineUsedForDriftCheck is set the same as CalculatedBaseline.
The configurations and outcomes of a Fail step execution.
* @public */ Fail?: FailStepMetadata | undefined; /** *The Amazon Resource Name (ARN) of the AutoML job that was run by this step.
* @public */ AutoMLJob?: AutoMLJobStepMetadata | undefined; /** *The endpoint that was invoked during this step execution.
* @public */ Endpoint?: EndpointStepMetadata | undefined; /** *The endpoint configuration used to create an endpoint during this step execution.
* @public */ EndpointConfig?: EndpointConfigStepMetadata | undefined; } /** *The ARN from an execution of the current pipeline.
* @public */ export interface SelectiveExecutionResult { /** *The ARN from an execution of the current pipeline.
* @public */ SourcePipelineExecutionArn?: string | undefined; } /** * @public * @enum */ export declare const StepStatus: { readonly EXECUTING: "Executing"; readonly FAILED: "Failed"; readonly STARTING: "Starting"; readonly STOPPED: "Stopped"; readonly STOPPING: "Stopping"; readonly SUCCEEDED: "Succeeded"; }; /** * @public */ export type StepStatus = (typeof StepStatus)[keyof typeof StepStatus]; /** *An execution of a step in a pipeline.
* @public */ export interface PipelineExecutionStep { /** *The name of the step that is executed.
* @public */ StepName?: string | undefined; /** *The display name of the step.
* @public */ StepDisplayName?: string | undefined; /** *The description of the step.
* @public */ StepDescription?: string | undefined; /** *The time that the step started executing.
* @public */ StartTime?: Date | undefined; /** *The time that the step stopped executing.
* @public */ EndTime?: Date | undefined; /** *The status of the step execution.
* @public */ StepStatus?: StepStatus | undefined; /** *If this pipeline execution step was cached, details on the cache hit.
* @public */ CacheHitResult?: CacheHitResult | undefined; /** *The reason why the step failed execution. This is only returned if the step failed its execution.
* @public */ FailureReason?: string | undefined; /** *Metadata to run the pipeline step.
* @public */ Metadata?: PipelineExecutionStepMetadata | undefined; /** *The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.
* @public */ AttemptCount?: number | undefined; /** *The ARN from an execution of the current pipeline from which results are reused for this step.
* @public */ SelectiveExecutionResult?: SelectiveExecutionResult | undefined; } /** * @public */ export interface ListPipelineExecutionStepsResponse { /** *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.
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.
The Amazon Resource Name (ARN) of the pipeline execution.
* @public */ PipelineExecutionArn: string | undefined; /** *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.
The maximum number of parameters to return in the response.
* @public */ MaxResults?: number | undefined; } /** *Assigns a value to a named Pipeline parameter.
* @public */ export interface Parameter { /** *The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.
* @public */ Name: string | undefined; /** *The literal value for the parameter.
* @public */ Value: string | undefined; } /** * @public */ export interface ListPipelineParametersForExecutionResponse { /** *Contains a list of pipeline parameters. This list can be empty.
* @public */ PipelineParameters?: Parameter[] | undefined; /** *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.
The prefix of the pipeline name.
* @public */ PipelineNamePrefix?: string | undefined; /** *A filter that returns the pipelines that were created after a specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns the pipelines that were created before a specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The field by which to sort results. The default is CreatedTime.
The sort order for results.
* @public */ SortOrder?: SortOrder | undefined; /** *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.
The maximum number of pipelines to return in the response.
* @public */ MaxResults?: number | undefined; } /** *A summary of a pipeline.
* @public */ export interface PipelineSummary { /** *The Amazon Resource Name (ARN) of the pipeline.
* @public */ PipelineArn?: string | undefined; /** *The name of the pipeline.
* @public */ PipelineName?: string | undefined; /** *The display name of the pipeline.
* @public */ PipelineDisplayName?: string | undefined; /** *The description of the pipeline.
* @public */ PipelineDescription?: string | undefined; /** *The Amazon Resource Name (ARN) that the pipeline used to execute.
* @public */ RoleArn?: string | undefined; /** *The creation time of the pipeline.
* @public */ CreationTime?: Date | undefined; /** *The time that the pipeline was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The last time that a pipeline execution began.
* @public */ LastExecutionTime?: Date | undefined; } /** * @public */ export interface ListPipelinesResponse { /** *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.
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.
The Amazon Resource Name (ARN) of the pipeline.
* @public */ PipelineName: string | undefined; /** *A filter that returns the pipeline versions that were created after a specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns the pipeline versions that were created before a specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The sort order for the results.
* @public */ SortOrder?: SortOrder | undefined; /** *If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.
The maximum number of pipeline versions to return in the response.
* @public */ MaxResults?: number | undefined; } /** *The summary of the pipeline version.
* @public */ export interface PipelineVersionSummary { /** *The Amazon Resource Name (ARN) of the pipeline.
* @public */ PipelineArn?: string | undefined; /** *The ID of the pipeline version.
* @public */ PipelineVersionId?: number | undefined; /** *The creation time of the pipeline version.
* @public */ CreationTime?: Date | undefined; /** *The description of the pipeline version.
* @public */ PipelineVersionDescription?: string | undefined; /** *The display name of the pipeline version.
* @public */ PipelineVersionDisplayName?: string | undefined; /** *The Amazon Resource Name (ARN) of the most recent pipeline execution created from this pipeline version.
* @public */ LastExecutionPipelineExecutionArn?: string | undefined; } /** * @public */ export interface ListPipelineVersionsResponse { /** *Contains a sorted list of pipeline version summary objects matching the specified filters. Each version summary includes the pipeline version ID, the creation date, and the last pipeline execution created from that version. This list can be empty.
* @public */ PipelineVersionSummaries?: PipelineVersionSummary[] | undefined; /** *If the result of the previous ListPipelineVersions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline versions, use this token in your next request.
A filter that returns only processing jobs created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only processing jobs created after the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only processing jobs modified after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only processing jobs modified before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that retrieves only processing jobs with a specific status.
* @public */ StatusEquals?: ProcessingJobStatus | undefined; /** *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
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.
The maximum number of processing jobs to return in the response.
* @public */ MaxResults?: number | undefined; } /** *Summary of information about a processing job.
* @public */ export interface ProcessingJobSummary { /** *The name of the processing job.
* @public */ ProcessingJobName: string | undefined; /** *The Amazon Resource Name (ARN) of the processing job..
* @public */ ProcessingJobArn: string | undefined; /** *The time at which the processing job was created.
* @public */ CreationTime: Date | undefined; /** *The time at which the processing job completed.
* @public */ ProcessingEndTime?: Date | undefined; /** *A timestamp that indicates the last time the processing job was modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The status of the processing job.
* @public */ ProcessingJobStatus: ProcessingJobStatus | undefined; /** *A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
* @public */ FailureReason?: string | undefined; /** *An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
* @public */ ExitMessage?: string | undefined; } /** * @public */ export interface ListProcessingJobsResponse { /** *An array of ProcessingJobSummary objects, each listing a processing job.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ProjectSortBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type ProjectSortBy = (typeof ProjectSortBy)[keyof typeof ProjectSortBy]; /** * @public * @enum */ export declare const ProjectSortOrder: { readonly ASCENDING: "Ascending"; readonly DESCENDING: "Descending"; }; /** * @public */ export type ProjectSortOrder = (typeof ProjectSortOrder)[keyof typeof ProjectSortOrder]; /** * @public */ export interface ListProjectsInput { /** *A filter that returns the projects that were created after a specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns the projects that were created before a specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *The maximum number of projects to return in the response.
* @public */ MaxResults?: number | undefined; /** *A filter that returns the projects whose name contains a specified string.
* @public */ NameContains?: string | undefined; /** *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.
The field by which to sort results. The default is CreationTime.
The sort order for results. The default is Ascending.
Information about a project.
* @public */ export interface ProjectSummary { /** *The name of the project.
* @public */ ProjectName: string | undefined; /** *The description of the project.
* @public */ ProjectDescription?: string | undefined; /** *The Amazon Resource Name (ARN) of the project.
* @public */ ProjectArn: string | undefined; /** *The ID of the project.
* @public */ ProjectId: string | undefined; /** *The time that the project was created.
* @public */ CreationTime: Date | undefined; /** *The status of the project.
* @public */ ProjectStatus: ProjectStatus | undefined; } /** * @public */ export interface ListProjectsOutput { /** *A list of summaries of projects.
* @public */ ProjectSummaryList: ProjectSummary[] | undefined; /** *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.
A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.
Use this parameter to search for ResourceCatalogs created after a specific date and time.
Use this parameter to search for ResourceCatalogs created before a specific date and time.
The order in which the resource catalogs are listed.
* @public */ SortOrder?: ResourceCatalogSortOrder | undefined; /** *The value on which the resource catalog list is sorted.
* @public */ SortBy?: ResourceCatalogSortBy | undefined; /** * The maximum number of results returned by ListResourceCatalogs.
A token to resume pagination of ListResourceCatalogs results.
A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.
The Amazon Resource Name (ARN) of the ResourceCatalog.
The name of the ResourceCatalog.
A free form description of the ResourceCatalog.
The time the ResourceCatalog was created.
A list of the requested ResourceCatalogs.
A token to resume pagination of ListResourceCatalogs results.
If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
The sort order for the results. The default is Ascending.
The parameter by which to sort the results. The default is CreationTime.
A parameter to search for the domain ID.
* @public */ DomainIdEquals?: string | undefined; /** *A parameter by which to filter the results.
* @public */ SpaceNameContains?: string | undefined; } /** *Specifies summary information about the ownership settings.
* @public */ export interface OwnershipSettingsSummary { /** *The user profile who is the owner of the space.
* @public */ OwnerUserProfileName?: string | undefined; } /** *Specifies summary information about the space settings.
* @public */ export interface SpaceSettingsSummary { /** *The type of app created within the space.
* @public */ AppType?: AppType | undefined; /** *A setting that enables or disables remote access for a SageMaker space. When enabled, this allows you to connect to the remote space from your local IDE.
* @public */ RemoteAccess?: FeatureStatus | undefined; /** *The storage settings for a space.
* @public */ SpaceStorageSettings?: SpaceStorageSettings | undefined; } /** *Specifies summary information about the space sharing settings.
* @public */ export interface SpaceSharingSettingsSummary { /** *Specifies the sharing type of the space.
* @public */ SharingType?: SharingType | undefined; } /** *The space's details.
* @public */ export interface SpaceDetails { /** *The ID of the associated domain.
* @public */ DomainId?: string | undefined; /** *The name of the space.
* @public */ SpaceName?: string | undefined; /** *The status.
* @public */ Status?: SpaceStatus | undefined; /** *The creation time.
* @public */ CreationTime?: Date | undefined; /** *The last modified time.
* @public */ LastModifiedTime?: Date | undefined; /** *Specifies summary information about the space settings.
* @public */ SpaceSettingsSummary?: SpaceSettingsSummary | undefined; /** *Specifies summary information about the space sharing settings.
* @public */ SpaceSharingSettingsSummary?: SpaceSharingSettingsSummary | undefined; /** *Specifies summary information about the ownership settings.
* @public */ OwnershipSettingsSummary?: OwnershipSettingsSummary | undefined; /** *The name of the space that appears in the Studio UI.
* @public */ SpaceDisplayName?: string | undefined; } /** * @public */ export interface ListSpacesResponse { /** *The list of spaces.
* @public */ Spaces?: SpaceDetails[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListStageDevicesRequest { /** *The response from the last list when returning a list large enough to neeed tokening.
* @public */ NextToken?: string | undefined; /** *The maximum number of requests to select.
* @public */ MaxResults?: number | undefined; /** *The name of the edge deployment plan.
* @public */ EdgeDeploymentPlanName: string | undefined; /** *Toggle for excluding devices deployed in other stages.
* @public */ ExcludeDevicesDeployedInOtherStage?: boolean | undefined; /** *The name of the stage in the deployment.
* @public */ StageName: string | undefined; } /** * @public */ export interface ListStageDevicesResponse { /** *List of summaries of devices allocated to the stage.
* @public */ DeviceDeploymentSummaries: DeviceDeploymentSummary[] | undefined; /** *The token to use when calling the next page of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const StudioLifecycleConfigSortKey: { readonly CreationTime: "CreationTime"; readonly LastModifiedTime: "LastModifiedTime"; readonly Name: "Name"; }; /** * @public */ export type StudioLifecycleConfigSortKey = (typeof StudioLifecycleConfigSortKey)[keyof typeof StudioLifecycleConfigSortKey]; /** * @public */ export interface ListStudioLifecycleConfigsRequest { /** *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.
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.
* @public */ NextToken?: string | undefined; /** *A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A parameter to search for the App Type to which the Lifecycle Configuration is attached.
* @public */ AppTypeEquals?: StudioLifecycleConfigAppType | undefined; /** *A filter that returns only Lifecycle Configurations created on or before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only Lifecycle Configurations created on or after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only Lifecycle Configurations modified before the specified time.
* @public */ ModifiedTimeBefore?: Date | undefined; /** *A filter that returns only Lifecycle Configurations modified after the specified time.
* @public */ ModifiedTimeAfter?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
* @public */ SortBy?: StudioLifecycleConfigSortKey | undefined; /** *The sort order. The default value is Descending.
* @public */ SortOrder?: SortOrder | undefined; } /** *Details of the Amazon SageMaker AI Studio Lifecycle Configuration.
* @public */ export interface StudioLifecycleConfigDetails { /** *The Amazon Resource Name (ARN) of the Lifecycle Configuration.
* @public */ StudioLifecycleConfigArn?: string | undefined; /** *The name of the Amazon SageMaker AI Studio Lifecycle Configuration.
* @public */ StudioLifecycleConfigName?: string | undefined; /** *The creation time of the Amazon SageMaker AI Studio Lifecycle Configuration.
* @public */ CreationTime?: Date | undefined; /** *This value is equivalent to CreationTime because Amazon SageMaker AI Studio Lifecycle Configurations are immutable.
* @public */ LastModifiedTime?: Date | undefined; /** *The App type to which the Lifecycle Configuration is attached.
* @public */ StudioLifecycleConfigAppType?: StudioLifecycleConfigAppType | undefined; } /** * @public */ export interface ListStudioLifecycleConfigsResponse { /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of Lifecycle Configurations and their properties.
* @public */ StudioLifecycleConfigs?: StudioLifecycleConfigDetails[] | undefined; } /** * @public */ export interface ListSubscribedWorkteamsRequest { /** *A string in the work team name. This filter returns only work teams whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *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.
The maximum number of work teams to return in each page of the response.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListSubscribedWorkteamsResponse { /** *An array of Workteam objects, each describing a work team.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTagsInput { /** *The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
* @public */ ResourceArn: string | undefined; /** * 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.
Maximum number of tags to return.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListTagsOutput { /** *An array of Tag objects, each with a tag key and a value.
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.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTrainingJobsRequest { /** *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.
The maximum number of training jobs to return in the response.
* @public */ MaxResults?: number | undefined; /** *A filter that returns only training jobs created after the specified time (timestamp).
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only training jobs created before the specified time (timestamp).
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only training jobs modified after the specified time (timestamp).
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only training jobs modified before the specified time (timestamp).
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A string in the training job name. This filter returns only training jobs whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that retrieves only training jobs with a specific status.
* @public */ StatusEquals?: TrainingJobStatus | undefined; /** *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Ascending.
A filter that retrieves only training jobs with a specific warm pool status.
* @public */ WarmPoolStatusEquals?: WarmPoolResourceStatus | undefined; /** *The Amazon Resource Name (ARN); of the training plan to filter training jobs by. For more information about reserving GPU capacity for your SageMaker training jobs using Amazon SageMaker Training Plan, see CreateTrainingPlan .
Provides summary information about a training job.
* @public */ export interface TrainingJobSummary { /** *The name of the training job that you want a summary for.
* @public */ TrainingJobName: string | undefined; /** *The Amazon Resource Name (ARN) of the training job.
* @public */ TrainingJobArn: string | undefined; /** *A timestamp that shows when the training job was created.
* @public */ CreationTime: Date | undefined; /** *A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).
Timestamp when the training job was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The status of the training job.
* @public */ TrainingJobStatus: TrainingJobStatus | undefined; /** *The secondary status of the training job.
* @public */ SecondaryStatus?: SecondaryStatus | undefined; /** *The status of the warm pool associated with the training job.
* @public */ WarmPoolStatus?: WarmPoolStatus | undefined; /** *The Amazon Resource Name (ARN); of the training plan associated with this training job.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
An array of TrainingJobSummary objects, each listing a training job.
If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const TrainingJobSortByOptions: { readonly CreationTime: "CreationTime"; readonly FinalObjectiveMetricValue: "FinalObjectiveMetricValue"; readonly Name: "Name"; readonly Status: "Status"; }; /** * @public */ export type TrainingJobSortByOptions = (typeof TrainingJobSortByOptions)[keyof typeof TrainingJobSortByOptions]; /** * @public */ export interface ListTrainingJobsForHyperParameterTuningJobRequest { /** *The name of the tuning job whose training jobs you want to list.
* @public */ HyperParameterTuningJobName: string | undefined; /** *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.
The maximum number of training jobs to return. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *A filter that returns only training jobs with the specified status.
* @public */ StatusEquals?: TrainingJobStatus | undefined; /** *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.
The sort order for results. The default is Ascending.
A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
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.
A filter to apply when listing or searching for training plans.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The name of the filter field (e.g., Status, InstanceType).
* @public */ Name: TrainingPlanFilterName | undefined; /** *The value to filter by for the specified field.
* @public */ Value: string | undefined; } /** * @public * @enum */ export declare const TrainingPlanSortBy: { readonly NAME: "TrainingPlanName"; readonly START_TIME: "StartTime"; readonly STATUS: "Status"; }; /** * @public */ export type TrainingPlanSortBy = (typeof TrainingPlanSortBy)[keyof typeof TrainingPlanSortBy]; /** * @public * @enum */ export declare const TrainingPlanSortOrder: { readonly ASCENDING: "Ascending"; readonly DESCENDING: "Descending"; }; /** * @public */ export type TrainingPlanSortOrder = (typeof TrainingPlanSortOrder)[keyof typeof TrainingPlanSortOrder]; /** * @public */ export interface ListTrainingPlansRequest { /** *A token to continue pagination if more results are available.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return in the response.
* @public */ MaxResults?: number | undefined; /** *Filter to list only training plans with an actual start time after this date.
* @public */ StartTimeAfter?: Date | undefined; /** *Filter to list only training plans with an actual start time before this date.
* @public */ StartTimeBefore?: Date | undefined; /** *The training plan field to sort the results by (e.g., StartTime, Status).
* @public */ SortBy?: TrainingPlanSortBy | undefined; /** *The order to sort the results (Ascending or Descending).
* @public */ SortOrder?: TrainingPlanSortOrder | undefined; /** *Additional filters to apply to the list of training plans.
* @public */ Filters?: TrainingPlanFilter[] | undefined; } /** *Details of the training plan.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
The Amazon Resource Name (ARN); of the training plan.
* @public */ TrainingPlanArn: string | undefined; /** *The name of the training plan.
* @public */ TrainingPlanName: string | undefined; /** *The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the Status attribute within the TrainingPlanSummary object.
A message providing additional information about the current status of the training plan.
* @public */ StatusMessage?: string | undefined; /** *The number of whole hours in the total duration for this training plan.
* @public */ DurationHours?: number | undefined; /** *The additional minutes beyond whole hours in the total duration for this training plan.
* @public */ DurationMinutes?: number | undefined; /** *The start time of the training plan.
* @public */ StartTime?: Date | undefined; /** *The end time of the training plan.
* @public */ EndTime?: Date | undefined; /** *The upfront fee for the training plan.
* @public */ UpfrontFee?: string | undefined; /** *The currency code for the upfront fee (e.g., USD).
* @public */ CurrencyCode?: string | undefined; /** *The total number of instances reserved in this training plan.
* @public */ TotalInstanceCount?: number | undefined; /** *The number of instances currently available for use in this training plan.
* @public */ AvailableInstanceCount?: number | undefined; /** *The number of instances currently in use from this training plan.
* @public */ InUseInstanceCount?: number | undefined; /** *The total number of UltraServers allocated to this training plan.
* @public */ TotalUltraServerCount?: number | undefined; /** *The target resources (e.g., training jobs, HyperPod clusters) that can use this training plan.
Training plans are specific to their target resource.
A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.
* @public */ ReservedCapacitySummaries?: ReservedCapacitySummary[] | undefined; } /** * @public */ export interface ListTrainingPlansResponse { /** *A token to continue pagination if more results are available.
* @public */ NextToken?: string | undefined; /** *A list of summary information for the training plans.
* @public */ TrainingPlanSummaries: TrainingPlanSummary[] | undefined; } /** * @public */ export interface ListTransformJobsRequest { /** *A filter that returns only transform jobs created after the specified time.
* @public */ CreationTimeAfter?: Date | undefined; /** *A filter that returns only transform jobs created before the specified time.
* @public */ CreationTimeBefore?: Date | undefined; /** *A filter that returns only transform jobs modified after the specified time.
* @public */ LastModifiedTimeAfter?: Date | undefined; /** *A filter that returns only transform jobs modified before the specified time.
* @public */ LastModifiedTimeBefore?: Date | undefined; /** *A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
* @public */ NameContains?: string | undefined; /** *A filter that retrieves only transform jobs with a specific status.
* @public */ StatusEquals?: TransformJobStatus | undefined; /** *The field to sort results by. The default is CreationTime.
The sort order for results. The default is Descending.
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.
The maximum number of transform jobs to return in the response. The default value is 10.
Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.
The name of the transform job.
* @public */ TransformJobName: string | undefined; /** *The Amazon Resource Name (ARN) of the transform job.
* @public */ TransformJobArn: string | undefined; /** *A timestamp that shows when the transform Job was created.
* @public */ CreationTime: Date | undefined; /** *Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.
* @public */ TransformEndTime?: Date | undefined; /** *Indicates when the transform job was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The status of the transform job.
* @public */ TransformJobStatus: TransformJobStatus | undefined; /** *If the transform job failed, the reason it failed.
* @public */ FailureReason?: string | undefined; } /** * @public */ export interface ListTransformJobsResponse { /** *An array of TransformJobSummary objects.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortTrialComponentsBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type SortTrialComponentsBy = (typeof SortTrialComponentsBy)[keyof typeof SortTrialComponentsBy]; /** * @public */ export interface ListTrialComponentsRequest { /** *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.
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.
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.
A filter that returns only components created after the specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns only components created before the specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of components to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *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.
A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName.
The name of the trial component.
* @public */ TrialComponentName?: string | undefined; /** *The Amazon Resource Name (ARN) of the trial component.
* @public */ TrialComponentArn?: string | undefined; /** *The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
The Amazon Resource Name (ARN) and job type of the source of a trial component.
* @public */ TrialComponentSource?: TrialComponentSource | undefined; /** *The status of the component. States include:
InProgress
Completed
Failed
When the component started.
* @public */ StartTime?: Date | undefined; /** *When the component ended.
* @public */ EndTime?: Date | undefined; /** *When the component was created.
* @public */ CreationTime?: Date | undefined; /** *Who created the trial component.
* @public */ CreatedBy?: UserContext | undefined; /** *When the component was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *Who last modified the component.
* @public */ LastModifiedBy?: UserContext | undefined; } /** * @public */ export interface ListTrialComponentsResponse { /** *A list of the summaries of your trial components.
* @public */ TrialComponentSummaries?: TrialComponentSummary[] | undefined; /** *A token for getting the next set of components, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const SortTrialsBy: { readonly CREATION_TIME: "CreationTime"; readonly NAME: "Name"; }; /** * @public */ export type SortTrialsBy = (typeof SortTrialsBy)[keyof typeof SortTrialsBy]; /** * @public */ export interface ListTrialsRequest { /** *A filter that returns only trials that are part of the specified experiment.
* @public */ ExperimentName?: string | undefined; /** *A filter that returns only trials that are associated with the specified trial component.
* @public */ TrialComponentName?: string | undefined; /** *A filter that returns only trials created after the specified time.
* @public */ CreatedAfter?: Date | undefined; /** *A filter that returns only trials created before the specified time.
* @public */ CreatedBefore?: Date | undefined; /** *The property used to sort results. The default value is CreationTime.
The sort order. The default value is Descending.
The maximum number of trials to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *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.
A summary of the properties of a trial. To get the complete set of properties, call the DescribeTrial API and provide the TrialName.
The Amazon Resource Name (ARN) of the trial.
* @public */ TrialArn?: string | undefined; /** *The name of the trial.
* @public */ TrialName?: string | undefined; /** *The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.
The source of the trial.
* @public */ TrialSource?: TrialSource | undefined; /** *When the trial was created.
* @public */ CreationTime?: Date | undefined; /** *When the trial was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface ListTrialsResponse { /** *A list of the summaries of your trials.
* @public */ TrialSummaries?: TrialSummary[] | undefined; /** *A token for getting the next set of trials, if there are any.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListUltraServersByReservedCapacityRequest { /** *The ARN of the reserved capacity to list UltraServers for.
* @public */ ReservedCapacityArn: string | undefined; /** *The maximum number of UltraServers to return in the response. The default value is 10.
* @public */ MaxResults?: number | undefined; /** *If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const UltraServerHealthStatus: { readonly IMPAIRED: "Impaired"; readonly INSUFFICIENT_DATA: "Insufficient-Data"; readonly OK: "OK"; }; /** * @public */ export type UltraServerHealthStatus = (typeof UltraServerHealthStatus)[keyof typeof UltraServerHealthStatus]; /** *Represents a high-performance compute server used for distributed training in SageMaker AI. An UltraServer consists of multiple instances within a shared NVLink interconnect domain.
* @public */ export interface UltraServer { /** *The unique identifier for the UltraServer.
* @public */ UltraServerId: string | undefined; /** *The type of UltraServer, such as ml.u-p6e-gb200x72.
* @public */ UltraServerType: string | undefined; /** *The name of the Availability Zone where the UltraServer is provisioned.
* @public */ AvailabilityZone: string | undefined; /** *The Amazon EC2 instance type used in the UltraServer.
* @public */ InstanceType: ReservedCapacityInstanceType | undefined; /** *The total number of instances in this UltraServer.
* @public */ TotalInstanceCount: number | undefined; /** *The number of spare instances configured for this UltraServer to provide enhanced resiliency.
* @public */ ConfiguredSpareInstanceCount?: number | undefined; /** *The number of instances currently available for use in this UltraServer.
* @public */ AvailableInstanceCount?: number | undefined; /** *The number of instances currently in use in this UltraServer.
* @public */ InUseInstanceCount?: number | undefined; /** *The number of available spare instances in the UltraServer.
* @public */ AvailableSpareInstanceCount?: number | undefined; /** *The number of instances in this UltraServer that are currently in an unhealthy state.
* @public */ UnhealthyInstanceCount?: number | undefined; /** *The overall health status of the UltraServer.
* @public */ HealthStatus?: UltraServerHealthStatus | undefined; } /** * @public */ export interface ListUltraServersByReservedCapacityResponse { /** *If the response is truncated, SageMaker returns this token. Use it in the next request to retrieve the next set of UltraServers.
* @public */ NextToken?: string | undefined; /** *A list of UltraServers that are part of the specified reserved capacity.
* @public */ UltraServers: UltraServer[] | undefined; } /** * @public * @enum */ export declare const UserProfileSortKey: { readonly CreationTime: "CreationTime"; readonly LastModifiedTime: "LastModifiedTime"; }; /** * @public */ export type UserProfileSortKey = (typeof UserProfileSortKey)[keyof typeof UserProfileSortKey]; /** * @public */ export interface ListUserProfilesRequest { /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; /** *This parameter defines the maximum number of results that can be return in a single response. The MaxResults parameter is an upper bound, not a target. If there are more results available than the value specified, a NextToken is provided in the response. The NextToken indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for MaxResults is 10.
The sort order for the results. The default is Ascending.
* @public */ SortOrder?: SortOrder | undefined; /** *The parameter by which to sort the results. The default is CreationTime.
* @public */ SortBy?: UserProfileSortKey | undefined; /** *A parameter by which to filter the results.
* @public */ DomainIdEquals?: string | undefined; /** *A parameter by which to filter the results.
* @public */ UserProfileNameContains?: string | undefined; } /** *The user profile details.
* @public */ export interface UserProfileDetails { /** *The domain ID.
* @public */ DomainId?: string | undefined; /** *The user profile name.
* @public */ UserProfileName?: string | undefined; /** *The status.
* @public */ Status?: UserProfileStatus | undefined; /** *The creation time.
* @public */ CreationTime?: Date | undefined; /** *The last modified time.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface ListUserProfilesResponse { /** *The list of user profiles.
* @public */ UserProfiles?: UserProfileDetails[] | undefined; /** *If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public * @enum */ export declare const ListWorkforcesSortByOptions: { readonly CreateDate: "CreateDate"; readonly Name: "Name"; }; /** * @public */ export type ListWorkforcesSortByOptions = (typeof ListWorkforcesSortByOptions)[keyof typeof ListWorkforcesSortByOptions]; /** * @public */ export interface ListWorkforcesRequest { /** *Sort workforces using the workforce name or creation date.
* @public */ SortBy?: ListWorkforcesSortByOptions | undefined; /** *Sort workforces in ascending or descending order.
* @public */ SortOrder?: SortOrder | undefined; /** *A filter you can use to search for workforces using part of the workforce name.
* @public */ NameContains?: string | undefined; /** *A token to resume pagination.
* @public */ NextToken?: string | undefined; /** *The maximum number of workforces returned in the response.
* @public */ MaxResults?: number | undefined; }